If one of your Tap Inspect API authentication tokens is found in public, we revoke it right away and email you. You only need to make a new token and give it to the service that used the old one.
API authentication tokens let third-party services use your Tap Inspect account without your email address and password. They start with tap_pat_. Tap Inspect works with GitHub secret scanning, which looks for our tokens in public code and reports them to us.
What happens when a token is found
- The token is revoked at once. It stops working within seconds of GitHub reporting it, and it can't be turned back on.
- We email you and notify you in the Tap Inspect app. The email is titled "An API authentication token was found in public and revoked". It names the token and links to where GitHub found it.
- Nothing else changes. Your password, your other tokens, your signed-in devices and connected apps keep working.
Any service that used the revoked token will start getting errors until you give it a new one.
Replace the token
- Sign in to Tap Inspect on the web and open Settings → Integrations.
- On the API Authentication Tokens card, click Change Settings. The revoked token is listed with the date it was revoked.
- Click Generate a New Token. Enter your current password and a name for the service.
- Choose only the access the service needs, and an expiry: 30, 90 or 365 days, or never.
- Click Generate Token and copy it. It is shown only once.
- Paste the new token into the service that used the old one, in its settings or secret store, not in its code.
- Remove the token from wherever it was exposed. If it was committed to a repository, delete it from the code and from the repository's history.
If you exposed a token and haven't heard from us
Revoke it yourself straight away. GitHub only scans public places on GitHub, so a token in a chat, a ticket, a screenshot or another code host won't be caught.
- Open Settings → Integrations and click Change Settings on the API Authentication Tokens card.
- Click the delete icon beside the token and confirm. It stops working immediately.
- Follow the steps above to make a replacement.
Keep tokens out of sight
- Never put a token in code. Load it from an environment variable or a secrets manager, and keep .env files out of version control.
- One token per service. If one leaks, you replace only that one.
- Give the least access. Choose only the kinds of data the service needs, and read-only where it doesn't make changes.
- Let tokens expire. A 90-day token limits how long a leak can be used.
- Delete tokens you no longer use.
Questions
Can I un-revoke the token? No. A revoked token can never be used again, so make a new one.
Do I need to change my password? No. A token doesn't reveal your password. Change it only if you think your password was exposed too.
I don't recognise the token in the email. Check the token list on the Integrations page. If you didn't make it, change your password and contact Tap Inspect support.
Someone else saw the token before it was revoked. What could they have done? Only what the token allowed when you made it, until it was revoked. Look over your recent jobs, reports and contacts, and contact support if anything looks wrong.
Comments
0 comments
Article is closed for comments.