Skip to content

Commit 2929966

Browse files
jules-psophiethekingmyarb
authored
Secret scanning shows metadata for GitHub tokens - [Public Beta] (github#35351)
Co-authored-by: Sophie <[email protected]> Co-authored-by: Melanie Yarbrough <[email protected]>
1 parent 72a9b6f commit 2929966

File tree

3 files changed

+36
-2
lines changed

3 files changed

+36
-2
lines changed
Loading

content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md

+30-2
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ shortTitle: Manage secret alerts
3535
{% data reusables.repositories.navigate-to-repo %}
3636
{% data reusables.repositories.sidebar-security %}
3737
1. In the left sidebar, under "Vulnerability alerts", click **{% data variables.product.prodname_secret_scanning_caps %}**.
38-
2. Under "{% data variables.product.prodname_secret_scanning_caps %}" click the alert you want to view.{% ifversion secret-scanning-validity-check %}
39-
3. Optionally, if the leaked secret is a {% data variables.product.company_short %} token, check the validity of the secret and follow the remediation steps.
38+
1. Under "{% data variables.product.prodname_secret_scanning_caps %}" click the alert you want to view.{% ifversion secret-scanning-validity-check %}
39+
1. Optionally, if the leaked secret is a {% data variables.product.company_short %} token, check the validity of the secret and follow the remediation steps. {% ifversion secret-scanning-github-token-metadata %}If the {% data variables.product.company_short %} token is currently active, you can also review the token metadata. For more information on reviewing token metadata, see "[Reviewing {% data variables.product.company_short %} token metadata](#reviewing-github-token-metadata)."{% endif %}
4040

4141
![Screenshot of the UI for a {% data variables.product.company_short %} token, showing the validity check and suggested remediation steps.](/assets/images/help/repository/secret-scanning-validity-check.png)
4242

@@ -68,6 +68,34 @@ shortTitle: Manage secret alerts
6868
1. Click **Close alert**.
6969
{% endif %}
7070

71+
{% ifversion secret-scanning-github-token-metadata %}
72+
## Reviewing {% data variables.product.company_short %} token metadata
73+
74+
{% note %}
75+
76+
**Note:** Metadata for {% data variables.product.company_short %} tokens is currently in public beta and subject to change.
77+
78+
{% endnote %}
79+
80+
In the view for an active {% data variables.product.company_short %} token alert, you can review certain metadata about the token. This metadata may help you identify the token and decide what remediation steps to take. For more information on viewing individual alerts, see "[Managing {% data variables.product.prodname_secret_scanning %} alerts](#managing-secret-scanning-alerts)."
81+
82+
Tokens, like {% data variables.product.pat_generic %} and other credentials, are considered personal information. For more information about using {% data variables.product.company_short %} tokens, see [GitHub's Privacy Statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement) and [Acceptable Use Policies](/free-pro-team@latest/site-policy/acceptable-use-policies/github-acceptable-use-policies).
83+
84+
![Screenshot of the UI for a {% data variables.product.company_short %} token, showing the token metadata.](/assets/images/help/repository/secret-scanning-github-token-metadata.png)
85+
86+
Metadata for {% data variables.product.company_short %} tokens is available for active tokens in any repository with secret scanning enabled. If a token has been revoked or its status cannot be validated, metadata will not be available. {% data variables.product.company_short %} auto-revokes {% data variables.product.company_short %} tokens in public repositories, so metadata for {% data variables.product.company_short %} tokens in public repositories is unlikely to be available. The following metadata is available for active {% data variables.product.company_short %} tokens:
87+
88+
|Metadata|Description|
89+
|-------------------------|--------------------------------------------------------------------------------|
90+
|Secret name| The name given to the {% data variables.product.company_short %} token by its creator|
91+
|Secret owner| The {% data variables.product.company_short %} handle of the token's owner|
92+
|Created on| Date the token was created|
93+
|Expired on| Date the token expired|
94+
|Last used on| Date the token was last used|
95+
|Access| Whether the token has organization access|
96+
97+
{% endif %}
98+
7199
## Securing compromised secrets
72100

73101
Once a secret has been committed to a repository, you should consider the secret compromised. {% data variables.product.prodname_dotcom %} recommends the following actions for compromised secrets:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Reference: #9142.
2+
# Secret scanning: GitHub token metadata
3+
versions:
4+
fpt: '*'
5+
ghec: '*'
6+
ghes: '>=3.10'

0 commit comments

Comments
 (0)