Skip to main content

Управление оповещениями о проверке секретов

Можно просматривать и закрывать оповещения о секретах, записанных в ваш репозиторий.

Кто эту функцию можно использовать?

People with admin access to a repository can view and dismiss secret scanning alerts for the repository.

Secret scanning alerts for partners runs automatically on public repositories and public npm packages to notify service providers about leaked secrets on GitHub.com.

Secret scanning alerts for users are available for free on all public repositories. Organizations using GitHub Enterprise Cloud with a license for GitHub Advanced Security can also enable secret scanning alerts for users on their private and internal repositories. Additionally, secret scanning alerts for users are available and in beta on user-owned repositories for GitHub Enterprise Cloud with Enterprise Managed Users. For more information, see "About secret scanning" and "About GitHub Advanced Security."

For information about how you can try GitHub Advanced Security for free, see "Setting up a trial of GitHub Advanced Security."

Managing alerts from high confidence patterns

Note: Alerts are created only for repositories with secret scanning alerts for users enabled. Secrets found in public repositories and public npm packages using the free secret scanning alerts for partners service are reported directly to the partner, without creating an alert. For more information, see "Secret scanning patterns."

  1. On GitHub.com, navigate to the main page of the repository.

  2. Under the repository name, click Security. If you cannot see the "Security" tab, select the dropdown menu, and then click Security. Screenshot of a repository header showing the tabs. The "Security" tab is highlighted by a dark orange outline.

  3. In the left sidebar, under "Vulnerability alerts", click Secret scanning.

  4. Optionally, to filter by alert validity status, under "Secret scanning" 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" below.

    Note: Validity checks for partner patterns is currently in beta and subject to change.

    To be able to filter by validity status, you need to have validity checks for partner patterns enabled at the repository, organization, or enterprise level. For more information, see "Managing security and analysis settings for your repository," "Managing security and analysis settings for your organization," and "Managing GitHub Advanced Security features for your enterprise."

  5. Optionally, to see which alerts are the result of a user bypassing push protection, select the "Bypassed" dropdown menu, then click True.

  6. Under "Secret scanning", click the alert you want to view. Only people with admin permissions to the repository containing a leaked secret can view security alert details and token metadata for an alert. Enterprise owners can request temporary access to the repository for this purpose.

    Note: The High confidence view is the default view for the list of secret scanning alerts. If the detection of non-provider patterns is enabled for your repository or organization, you'll need to use a different view to be able to see non-provider alerts. For more information, see "Managing alerts from non-provider patterns" below.

  7. Optionally, to perform a validity check on the token, on the top right-hand side of the alert, click Verify secret. For more information, see "Validating partner patterns."

    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."

  8. Optionally, if the leaked secret is a GitHub token, you can also review the token metadata. For more information on reviewing token metadata, see "Reviewing GitHub token metadata."

  9. To dismiss an alert, select the "Close as" dropdown menu and click a reason for resolving an alert.

    Screenshot of a secret scanning alert. A dropdown menu, titled "Close as", is expanded and highlighted in a dark orange outline.

  10. Optionally, in the "Comment" field, add a dismissal comment. The dismissal comment will be added to the alert timeline and can be used as justification during auditing and reporting. You can view the history of all dismissed alerts and dismissal comments in the alert timeline. You can also retrieve or set a comment by using the Secret scanning API. The comment is contained in the resolution_comment field. For more information, see "Secret scanning" in the REST API documentation.

  11. Click Close alert.

Managing alerts from non-provider patterns

Note: The detection of non-provider patterns is currently in beta and subject to change.

Non-provider patterns are patterns such as private keys, and have a higher rate of false positive than high confidence patterns.

As an organization owner, or repository administrator, you need to enable the detection of non-provider patterns in your organization or repository for secret scanning to scan for non-provider patterns. For more information, see "Configuring secret scanning for your repositories."

Non-provider alerts are different from high confidence alerts. Non-provider alerts:

  • Are not shown in the summary views for security overview, only in the "Secret scanning" view.
  • Are listed in a different view from high-confidence alerts. That view is called "Other".
  • Only have the first five detected locations shown on GitHub.
  • Are limited in quantity to 5000 alerts per repository (this includes open and closed alerts).
  1. On GitHub.com, navigate to the main page of the repository.

  2. Under the repository name, click Security. If you cannot see the "Security" tab, select the dropdown menu, and then click Security. Screenshot of a repository header showing the tabs. The "Security" tab is highlighted by a dark orange outline.

  3. In the left sidebar, under "Vulnerability alerts", click Secret scanning.

  4. On the top right corner of the list of secret scanning alerts, click Other.

    Screenshot of the list of secret scanning alerts. A button, titled "Other", is highlighted in a dark orange outline.

  5. Click the alert you want to view.

  6. To dismiss an alert, select the "Close as" dropdown menu and click a reason for resolving an alert.

  7. Optionally, in the "Comment" field, add a dismissal comment. The dismissal comment will be added to the alert timeline and can be used as justification during auditing and reporting. You can view the history of all dismissed alerts and dismissal comments in the alert timeline.

  8. Click Close alert.

Validating partner patterns

Note: Validity checks for partner patterns is currently in beta and subject to change.

Validity checks for partner patterns is available on all types of repositories on GitHub.com. To use this feature, you must have a license for GitHub Advanced Security.

You can allow secret scanning to check the validity of a secret found in your repository by sending it to the relevant partner.

You can enable automatic validity checks for supported partner patterns in the code security settings for your repository, organization, or enterprise. GitHub will periodically send the pattern to the relevant partner to check the secret's validity and display the validation status of the secret in the alert view.

For more information on enabling automatic validation checks for partner patterns in your repository, organization, or enterprise, see "Allowing validity checks for partner patterns in a repository," "Allowing validity checks for partner patterns in an organization," and "Managing Advanced Security features."

If your repository has validity checks enabled, you can also perform an on-demand validity check for a secret by clicking Verify secret in the alert view. GitHub will send the pattern to the relevant partner and display the validation status of the secret in the alert view.

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.

You can use the REST API to retrieve a list of the most recent validation status for each of your tokens. For more information, see "Secret scanning" in the REST API documentation.

ValidityStatusResult
Active secretactiveGitHub checked with this secret's provider and found that the secret is active
Possibly active secretunknownGitHub does not support validation checks for this token type yet
Possibly active secretunknownGitHub could not verify this secret
Secret inactiveinactiveYou should make sure no unauthorized access has already occurred

For more information on which partners support validity checks, see "Supported secrets."

Reviewing GitHub token metadata

Note: Metadata for GitHub tokens is currently in public beta and subject to change.

In the view for an active GitHub 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 secret scanning alerts."

Tokens, like personal access token and other credentials, are considered personal information. For more information about using GitHub tokens, see GitHub's Privacy Statement and Acceptable Use Policies.

Screenshot of the UI for a GitHub token, showing the token metadata.

Metadata for GitHub 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. GitHub auto-revokes GitHub tokens in public repositories, so metadata for GitHub tokens in public repositories is unlikely to be available. The following metadata is available for active GitHub tokens:

MetadataDescription
Secret nameThe name given to the GitHub token by its creator
Secret ownerThe GitHub handle of the token's owner
Created onDate the token was created
Expired onDate the token expired
Last used onDate the token was last used
AccessWhether the token has organization access

Only people with admin permissions to the repository containing a leaked secret can view security alert details and token metadata for an alert. Enterprise owners can request temporary access to the repository for this purpose. If access is granted, GitHub will notify the owner of the repository containing the leaked secret, report the action in the repository owner and enterprise audit logs, and enable access for 2 hours. For more information, see "Accessing user-owned repositories in your enterprise."

Viewing alerts for generic secrets detected using AI

Note: Generic secret detection for secret scanning is in beta. Functionality and documentation are subject to change. If you have an enterprise account and use GitHub Advanced Security, you can join the waitlist for GitHub Advanced Security AI features.

During this phase, generic secret detection is limited to looking for passwords in source code.

When you enable AI-powered generic secret detection for your repository, secret scanning will scan for unstructured secrets, such as passwords, in your source code and generate alerts.

Once a potential password is identified, an alert is displayed in a separate list on the secret scanning alerts page (under the Security tab of the repository). The separate view makes it easier for you to triage and verify the validity of the findings.

To see the separate list of alerts for generic secrets, you must to toggle to "Other" on the alerts page. Each alert notes that it was detected using AI.

  1. On GitHub.com, navigate to the main page of the repository.

  2. Under the repository name, click Security. If you cannot see the "Security" tab, select the dropdown menu, and then click Security. Screenshot of a repository header showing the tabs. The "Security" tab is highlighted by a dark orange outline.

  3. In the left sidebar, under "Vulnerability alerts", click Secret scanning.

  4. On the top right corner of the list of secret scanning alerts, toggle to "Other".

    Screenshot of the secret scanning alert index view for a repository. A toggle, titled "Other", is highlighted in a dark orange outline.

For more information about the feature and its limitations, see "About the detection of generic secrets with secret scanning." For information on how to enable the feature for your repository, see "Enabling AI-powered generic secret detection."

Securing compromised secrets

Once a secret has been committed to a repository, you should consider the secret compromised. GitHub recommends the following actions for compromised secrets:

  • For a compromised GitHub personal access token, delete the compromised token, create a new token, and update any services that use the old token. For more information, see "Managing your personal access tokens."
  • For all other secrets, first verify that the secret committed to GitHub Enterprise Cloud is valid. If so, create a new secret, update any services that use the old secret, and then delete the old secret.

Note: If a secret is detected in a public repository on GitHub.com and the secret also matches a partner pattern, an alert is generated and the potential secret is reported to the service provider. For details of partner patterns, see "Secret scanning patterns."

Configuring notifications for secret scanning alerts

Notifications are different for incremental scans and historical scans.

Incremental scans

When a new secret is detected, GitHub Enterprise Cloud notifies all users with access to security alerts for the repository according to their notification preferences. These users include:

  • Repository administrators
  • Security managers
  • Users with custom roles with read/write access
  • Organization owners and enterprise owners, if they are administrators of repositories where secrets were leaked

Note: Commit authors who've accidentally committed secrets will be notified, regardless of their notification preferences.

You will receive an email notification if:

  • You are watching the repository.
  • You have enabled notifications for "All Activity", or for custom "Security alerts" on the repository.
  • In your notification settings, under "Subscriptions", then under "Watching", you have selected to receive notifications by email.
  1. On GitHub.com, navigate to the main page of the repository.

  2. To start watching the repository, select Watch.

    Screenshot of the repository's main page. A dropdown menu, titled "Watch", is highlighted with an orange outline.

  3. In the dropdown menu, click All Activity. Alternatively, to only subscribe to security alerts, click Custom, then click Security alerts.

  4. Navigate to the notification settings for your personal account. These are available at https://github.com/settings/notifications.

  5. On your notification settings page, under "Subscriptions", then under "Watching", select the Notify me dropdown.

  6. Select "Email" as a notification option, then click Save.

    Screenshot of the notification settings for a user account. An element header, titled "Subscriptions", and a sub-header, titled "Watching", are shown. A checkbox, titled "Email", is highlighted with an orange outline.

For more information about setting up notification preferences, see "Managing security and analysis settings for your repository" and "Configuring your watch settings for an individual repository."

Historical scans

For historical scans, GitHub Enterprise Cloud notifies the following users:

  • Organization owners, enterprise owners, and security managers—whenever a historical scan is complete, even if no secrets are found.
  • Repository administrators, security managers, and users with custom roles with read/write access—whenever a historical scan detects a secret, and according to their notification preferences.

We do not notify commit authors.

For more information about setting up notification preferences, see "Managing security and analysis settings for your repository" and "Configuring your watch settings for an individual repository."

Auditing responses to secret scanning alerts

You can audit the actions taken in response to secret scanning alerts using GitHub tools. For more information, see "Auditing security alerts."