Skip to main content

About secret scanning

GitHub Enterprise Cloud scans repositories for known types of secrets, to prevent fraudulent use of secrets that were committed accidentally.

秘密扫描合作伙伴模式 is automatically run on all public repositories. If you have a license for GitHub Advanced Security, you can enable and configure > - 秘密扫描,用于高级安全 for any repository owned by an organization. 更多信息请参阅“GitHub 的产品”。

About 秘密扫描

If your project communicates with an external service, you might use a token or private key for authentication. Tokens and private keys are examples of secrets that a service provider can issue. If you check a secret into a repository, anyone who has read access to the repository can use the secret to access the external service with your privileges. We recommend that you store secrets in a dedicated, secure location outside of the repository for your project.

秘密扫描 will scan your entire Git history on all branches present in your GitHub repository for secrets, even if the repository is archived.

秘密扫描 is available on in two forms:

  1. 秘密扫描合作伙伴模式. Runs automatically on all public repositories. Any strings that match patterns that were provided by secret scanning partners are reported directly to the relevant partner.

  2. 秘密扫描,用于高级安全. You can enable and configure additional scanning for repositories owned by organizations that use GitHub Enterprise Cloud and have a license for GitHub Advanced Security. Any strings that match patterns provided by secret scanning partners, by other service providers, or defined by your organization, are reported as alerts in the "Security" tab of repositories. If a string in a public repository matches a partner pattern, it is also reported to the partner.

Service providers can partner with GitHub to provide their secret formats for scanning. To find out about our partner program, see "秘密扫描 partner program."

You can also enable 秘密扫描 as a push protection for a repository or an organization. When you enable this feature, 秘密扫描 prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. For more information, see "Protecting pushes with 秘密扫描."

About 秘密扫描合作伙伴模式

When you make a repository public, or push changes to a public repository, GitHub Enterprise Cloud always scans the code for secrets that match partner patterns. If 秘密扫描 detects a potential secret, we notify the service provider who issued the secret. The service provider validates the string and then decides whether they should revoke the secret, issue a new secret, or contact you directly. Their action will depend on the associated risks to you or them. For more information, see "Supported secrets for partner patterns."

You cannot change the configuration of 秘密扫描 on public repositories.

About > - 秘密扫描,用于高级安全

秘密扫描,用于高级安全 is available on all organization-owned repositories as part of GitHub Advanced Security. It is not available on user-owned repositories. When you enable 秘密扫描 for a repository, GitHub scans the code for patterns that match secrets used by many service providers. For more information, see "Supported secrets for advanced security."

If you're a repository administrator you can enable > - 秘密扫描,用于高级安全 for any repository, including archived repositories. Organization owners can also enable > - 秘密扫描,用于高级安全 for all repositories or for all new repositories within an organization. For more information, see "Managing security and analysis settings for your repository" and "Managing security and analysis settings for your organization."

You can also define custom 秘密扫描 patterns for a repository, organization, or enterprise. For more information, see "Defining custom patterns for 秘密扫描."

About 秘密扫描 alerts

When you push commits to a repository with 秘密扫描 enabled, GitHub scans the contents of those commits for secrets that match patterns defined by service providers and any custom patterns defined in your enterprise, organization, or repository.

If 秘密扫描 detects a secret, GitHub generates an alert.

  • GitHub sends an email alert to the repository administrators and organization owners.

  • GitHub sends an email alert to the contributor who committed the secret to the repository, with a link to the related 秘密扫描 alert. The commit author can then view the alert in the repository, and resolve the alert.

  • GitHub displays an alert in the "Security" tab of the repository.

For more information about viewing and resolving 秘密扫描 alerts, see "Managing alerts from 秘密扫描."

Repository administrators and organization owners can grant users and teams access to 秘密扫描 alerts. For more information, see "Managing security and analysis settings for your repository."

You can use the security overview to see an organization-level view of which repositories have enabled 秘密扫描 and the alerts found. For more information, see "Viewing the security overview." You can also use the REST API to monitor results from 秘密扫描 across your private repositories. For more information about API endpoints, see "秘密扫描."

Further reading