About secret scanning

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

Las Escaneo de secretos están disponibles para los repositorios que pertenezcan a organizaciones en donde esté habilitada la GitHub Advanced Security. Para obtener más información, consulta la sección "Acerca de GitHub Advanced Security".

Nota: El Escaneo de secretos estaba en beta en GitHub Enterprise Server 3.0. Para encontrar el lanzamiento del escaneo de secretos que está generalmente disponible, mejora al último lanzamiento de GitHub Enterprise Server.

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

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 any secrets. Service providers can partner with GitHub to provide their secret formats for scanning.

Si alguien registra un secreto con un patrón conocido en un repositorio en GitHub Enterprise Server, el escaneo de secretos atrapa el secreto tan pronto se registra y te ayuda a mitigar el impacto de la fuga. Se notifica a los administradores de repositorio sobre cualquier confirmación que contenga un secreto y pueden ver rápidamente todos los secretos en la pestaña de seguridad de éste.

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.

If you're a repository administrator or an organization owner, you can enable escaneo de secretos for repositories that are owned by organizations. You can enable escaneo de secretos for all your repositories, or for all new repositories within your organization. For more information, see "Managing security and analysis settings for your repository" and "Managing security and analysis settings for your organization."

When you push commits to a repository with escaneo de secretos enabled, GitHub scans the contents of the commits for secrets.

When escaneo de secretos detects a secret in a repository, 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 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."

To monitor results from escaneo de secretos across your private repositories or your organization, you can use the escaneo de secretos API. For more information about API endpoints, see "Escaneo de secretos."

List of supported secrets

GitHub currently scans repositories for secrets issued by the following service providers.

ProveedorSecreto compatibleSlug de la API
Adafruit IOClave de IO de Adafruitadafruit_io_key
AzureAzure SQL Connection Stringazure_sql_connection_string Azure
DopplerToken Personal de Dopplerdoppler_personal_token
DopplerToken de Servicio de Dopplerdoppler_service_token
DopplerToken del CLI de Dopplerdoppler_cli_token
DopplerToken de SCIM de Dopplerdoppler_scim_token Dropbox
DynatraceDynatrace Access Tokendynatrace_access_token Dynatrace
StripeLlave Secreta en Vivo de la API de Stripestripe_live_secret_key
StripeLlave Secreta de la API de Prueba de Stripestripe_test_secret_key
StripeLlave Restringida de la API en Vivo de Stripestripe_live_restricted_key
StripeLlave Restringida de la API de Prueba de Stripestripe_test_restricted_key Tencent Cloud

Note: Escaneo de secretos does not currently allow you to define your own patterns for detecting secrets.

Further reading

¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.