From 8420fc247e607cd47d9ce1027446d77c09e424b4 Mon Sep 17 00:00:00 2001 From: Vanessa Date: Fri, 3 Nov 2023 02:42:21 +1000 Subject: [PATCH] [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> --- .../managing-alerts-from-secret-scanning.md | 10 ++++++++-- .../validity-check-partner-patterns-enabled.md | 1 + .../secret-scanning/validity-check-table.md | 13 ++++++------- 3 files changed, 15 insertions(+), 9 deletions(-) create mode 100644 data/reusables/secret-scanning/validity-check-partner-patterns-enabled.md diff --git a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md b/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md index 7e94097dba80..87ea89bb416e 100644 --- a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md +++ b/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md @@ -35,9 +35,15 @@ shortTitle: Manage secret alerts {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} 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. 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)."

- {% note %} + {% note %} **Note:** You can only perform on-demand validity checks for patterns detected in the repository if automatic validity checks have been enabled for the repository. For more information, see "[Allowing validity checks for partner patterns in a repository](/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)." @@ -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. -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 %} diff --git a/data/reusables/secret-scanning/validity-check-partner-patterns-enabled.md b/data/reusables/secret-scanning/validity-check-partner-patterns-enabled.md new file mode 100644 index 000000000000..8a0e52773450 --- /dev/null +++ b/data/reusables/secret-scanning/validity-check-partner-patterns-enabled.md @@ -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)." diff --git a/data/reusables/secret-scanning/validity-check-table.md b/data/reusables/secret-scanning/validity-check-table.md index fb7789601a77..a04663e1046d 100644 --- a/data/reusables/secret-scanning/validity-check-table.md +++ b/data/reusables/secret-scanning/validity-check-table.md @@ -1,7 +1,6 @@ - | Validity | Result | - |-------------------------|--------------------------------------------------------------------------------| - | Active secret | {% data variables.product.company_short %} confirmed this 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 | {% data variables.product.company_short %} does not support validation checks for this token type yet | - | Possibly active secret | {% data variables.product.company_short %} could not verify this secret | - | Secret appears inactive | You should make sure no unauthorized access has already occurred | + | Validity | Status | Result | + |-------------|------------|--------------------------------------------------------------------------------| + | Active secret | `active` | {% 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 | `unknown` | {% data variables.product.company_short %} could not verify this secret | + | Secret inactive | `inactive` | You should make sure no unauthorized access has already occurred |