Skip to main content

Managing alerts from secret scanning

You can view and close alerts for secrets checked in to your repository.

Secret scanning for advanced security is available for organization-owned repositories in GitHub Enterprise Cloud if your enterprise has a license for GitHub Advanced Security. 有关详细信息,请参阅“关于 GitHub Advanced Security”。

Managing secret scanning alerts

Note: Alerts are created only for repositories with secret scanning for advanced security enabled. Secrets found in public repositories using the free secret scanning for partner patterns service are reported directly to the partner, without creating an alert.

  1. 在 GitHub.com 上,导航到存储库的主页。

  2. 在存储库名称下,单击“安全性”。 “安全”选项卡

  3. In the left sidebar, click Secret scanning alerts.

    "Secret scanning alerts" tab

  4. Under "Secret scanning" click the alert you want to view.

    List of alerts from secret scanning

  5. To dismiss an alert, select the "Dismiss alert" dropdown menu and click a reason for resolving an alert.

    Screenshot of the dropdown menu for dismissing an alert from secret scanning

  6. Optionally, 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.

    Screenshot showing how to dismiss an alert via the "Dismiss alert" dropdown, with the option to add a dismissal comment

  7. Click Dismiss alert.

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 "Creating a personal access token for the command line."
  • 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 "Supported secrets for partner patterns."

Configuring notifications for secret scanning alerts

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. You will receive an email notification if you are watching the repository, have enabled notifications for security alerts or for all the activity on the repository, or are the author of the commit that contains the secret and are not ignoring the repository.

For more information, see "Managing security and analysis settings for your repository" and "Configuring notifications."