1
0
mirror of synced 2025-12-19 18:10:59 -05:00

[2023-11-10]: Secret scanning: sort by alert validity on the index view [GA] (#45295)

Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com>
This commit is contained in:
Vanessa
2023-11-03 02:42:21 +10:00
committed by GitHub
parent 342f065b87
commit 8420fc247e
3 changed files with 15 additions and 9 deletions

View File

@@ -35,6 +35,12 @@ shortTitle: Manage secret alerts
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-security %}
1. In the left sidebar, under "Vulnerability alerts", click **{% data variables.product.prodname_secret_scanning_caps %}**. 1. In the left sidebar, under "Vulnerability alerts", click **{% data variables.product.prodname_secret_scanning_caps %}**.
{% ifversion secret-scanning-validity-check-partner-patterns %}
1. Optionally, to filter by alert validity status, under "{% data variables.product.prodname_secret_scanning_caps %}" select a status in the "Validity" dropdown menu and then click the filter that you would like to apply. Alternatively, filter using the `validity` key in the search field. You can filter alerts by specifying multiple validity statuses as a comma-separated string, for example `validity:active,unknown`. For more information about validity statuses, see "[Validating partner patterns](#validating-partner-patterns)" below.
{% data reusables.secret-scanning.validity-check-partner-patterns-beta %}
{% data reusables.secret-scanning.validity-check-partner-patterns-enabled %}
{% endif %}
1. Under "{% data variables.product.prodname_secret_scanning_caps %}" click the alert you want to view. {% ifversion secret-scanning-validity-check-partner-patterns %} 1. Under "{% data variables.product.prodname_secret_scanning_caps %}" click the alert you want to view. {% ifversion secret-scanning-validity-check-partner-patterns %}
1. Optionally, to perform a validity check on the token, on the top right-hand side of the alert, click {% octicon "sync" aria-hidden="true" %} **Verify secret**. For more information, see "[Validating partner patterns](#validating-partner-patterns)." <br><br> 1. Optionally, to perform a validity check on the token, on the top right-hand side of the alert, click {% octicon "sync" aria-hidden="true" %} **Verify secret**. For more information, see "[Validating partner patterns](#validating-partner-patterns)." <br><br>
{% note %} {% note %}
@@ -81,7 +87,7 @@ You can enable automatic validity checks for supported partner patterns in the c
If your repository has validity checks enabled, you can also perform an on-demand validity check for a secret by clicking {% octicon "sync" aria-hidden="true" %} **Verify secret** in the alert view. {% data variables.product.company_short %} will send the pattern to the relevant partner and display the validation status of the secret in the alert view. If your repository has validity checks enabled, you can also perform an on-demand validity check for a secret by clicking {% octicon "sync" aria-hidden="true" %} **Verify secret** in the alert view. {% data variables.product.company_short %} will send the pattern to the relevant partner and display the validation status of the secret in the alert view.
You can use the validation status of a leaked secret to help prioritize the secrets needing remediation steps. You can filter alerts for supported partner patterns by their validation status, and use the status of a leaked secret to help prioritize the secrets needing remediation steps.
{% data reusables.secret-scanning.validity-check-table %} {% data reusables.secret-scanning.validity-check-table %}

View File

@@ -0,0 +1 @@
To be able to filter by validity status, you need to have enabled validity checks for partner patterns in a repository, or have organization owners and enterprise administrators enable the feature for all repositories in the organization or enterprise settings. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository)," "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization)," and "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise#managing-advanced-security-features)."

View File

@@ -1,7 +1,6 @@
| Validity | Result | | Validity | Status | Result |
|-------------------------|--------------------------------------------------------------------------------| |-------------|------------|--------------------------------------------------------------------------------|
| Active secret | {% data variables.product.company_short %} confirmed this secret is active | | Active secret | `active` | {% data variables.product.company_short %} checked with this secret's provider and found that the secret is active |
| Active secret | {% data variables.product.company_short %} checked with this secret's provider and found that the secret is active | | Possibly active secret | `unknown` | {% data variables.product.company_short %} does not support validation checks for this token type yet |
| Possibly active secret | {% data variables.product.company_short %} does not support validation checks for this token type yet | | Possibly active secret | `unknown` | {% data variables.product.company_short %} could not verify this secret |
| Possibly active secret | {% data variables.product.company_short %} could not verify this secret | | Secret inactive | `inactive` | You should make sure no unauthorized access has already occurred |
| Secret appears inactive | You should make sure no unauthorized access has already occurred |