Skip to main content

About secret scanning

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

El Escaneo de secretos se encuentra disponible para los repositorios que pertenecen a organizaciones de GitHub Enterprise Server si tu empresa tiene una licencia de GitHub Advanced Security. Para obtener más información, consulta la sección "Productos de GitHub".

Nota: Tu administrador de sitio debe habilitar el escaneo de secretos para tu instancia de GitHub Enterprise Server antes de que puedas utilizar esta característica. Para obtener más información, consulta "Configurar el escaneo de secretos en tu aplicativo."

About escaneo de secretos

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.

Escaneo de secretos will scan your entire Git history on all branches present in your GitHub repository for secrets, even if the repository is archived.

Service providers can partner with GitHub to provide their secret formats for scanning. Para saber más sobre nuestro programa asociado, consulta el "Programa asociado de Escaneo de secretos" en la documentación de Nube de GitHub Enterprise.

You can also enable escaneo de secretos as a push protection for a repository or an organization. When you enable this feature, escaneo de secretos 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 escaneo de secretos."

About escaneo de secretos on GitHub Enterprise Server

Escaneo de secretos is available on all organization-owned repositories as part of GitHub Advanced Security. It is not available on user-owned repositories. When you enable escaneo de secretos for a repository, GitHub scans the code for patterns that match secrets used by many service providers. For more information, see "Escaneo de secretos patterns."

If you're a repository administrator you can enable >- escaneo de secretos for any repository, including archived repositories. Organization owners can also enable >- escaneo de secretos 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 escaneo de secretos patterns for a repository, organization, or enterprise. For more information, see "Defining custom patterns for escaneo de secretos."

About escaneo de secretos alerts

When you push commits to a repository with escaneo de secretos 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 escaneo de secretos 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 escaneo de secretos 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 escaneo de secretos alerts, see "Managing alerts from escaneo de secretos."

Repository administrators and organization owners can grant users and teams access to escaneo de secretos 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 escaneo de secretos and the alerts found. For more information, see "Viewing the security overview." You can also use the REST API to monitor results from escaneo de secretos across your repositories or your organization. For more information about API endpoints, see "Escaneo de secretos."

Further reading