Defining custom patterns for secret scanning

You can define custom patterns for escaneo de secretos in organizations and private repositories.

El Escaneo de secretos se encuentra disponible para todos los repositorios públicos y para los privados que pertenecen a organizaciones en donde se habilitó la GitHub Advanced Security. Para obtener más información, consulta la sección "Acerca de GitHub Advanced Security".

About custom patterns for escaneo de secretos

GitHub performs escaneo de secretos on public and private repositories for secret patterns provided by GitHub and GitHub partners. For more information on the escaneo de secretos partner program, see "Secret scanning partner program."

However, there can be situations where you want to scan for other secret patterns in your private repositories. For example, you might have a secret pattern that is internal to your organization. For these situations, you can define custom escaneo de secretos patterns in your enterprise, organization, or private repository on GitHub. You can define up to 500 custom patterns for each organization or enterprise account, and up to 100 custom patterns per private repository.

Regular expression syntax for custom patterns

Custom patterns for escaneo de secretos are specified as regular expressions. Escaneo de secretos uses the Hyperscan library and only supports Hyperscan regex constructs, which are a subset of PCRE syntax. Hyperscan option modifiers are not supported. For more information on Hyperscan pattern constructs, see "Pattern support" in the Hyperscan documentation.

Defining a custom pattern for a repository

Before defining a custom pattern, you must ensure that escaneo de secretos is enabled on your repository. For more information, see "Configuring escaneo de secretos for your repositories."

  1. En GitHub.com, visita la página principal del repositorio.

  2. Debajo de tu nombre de repositorio, da clic en Configuración. Botón de configuración del repositorio

  3. En la barra lateral izquierda, da clic en Seguridad & análisis. pestaña de "Seguridad & análisis" en la configuración de repositorio

  4. Debajo de "Configurar las características de seguridad y análisis", encuentra "GitHub Advanced Security".

  5. Debajo de "Escaneo de secretos", debajo de "Patrones personalizados", haz clic en Patrón nuevo.

  6. Ingresa los detalles de tu patrón personalizado nuevo:

    1. Debes proporcionar por lo menos el nombre de tu patrón y una expresión regular para el formato de tu patrón secreto.
    2. Puedes hacer clic en Más opciones para proporcionar otro tipo de contenido circundante o requisitos de coincidencia adicionales para el formato de secreto.
    3. Proporciona una secuencia de pruebas de muestra para asegurarte de que tu configuración empate con los patrones que esperas.

    Crear un formato de patrón personalizado del escaneo de secretos

  7. Cuando estés satisfecho con tu patrón personalizado nuevo, haz clic en Crear patrón.

After your pattern is created, El escaneo de secretos escanea cualquier secreto en el total de tu historial de Git en todas las ramas presentes de tu repositorio de GitHub. For more information on viewing escaneo de secretos alerts, see "Managing alerts from escaneo de secretos."

Defining a custom pattern for an organization

Before defining a custom pattern, you must ensure that you enable escaneo de secretos for the private repositories that you want to scan in your organization. To enable escaneo de secretos on all private repositories in your organization, see "Managing security and analysis settings for your organization."

Note: As there is no dry-run functionality, we recommend that you test your custom patterns in a repository before defining them for your entire organization. That way, you can avoid creating excess false-positive escaneo de secretos alerts.

  1. In the top right corner of GitHub.com, click your profile photo, then click Your organizations. Tus organizaciones en el menú de perfil

  2. Junto a la organización, haz clic en Configuración. El botón de configuración

  3. En la barra lateral izquierda, da clic en Seguridad & análisis. Pestaña de "Seguridad & análisis"

  4. Debajo de "Configurar las características de seguridad y análisis", encuentra "GitHub Advanced Security".

  5. Debajo de "Escaneo de secretos", debajo de "Patrones personalizados", haz clic en Patrón nuevo.

  6. Ingresa los detalles de tu patrón personalizado nuevo:

    1. Debes proporcionar por lo menos el nombre de tu patrón y una expresión regular para el formato de tu patrón secreto.
    2. Puedes hacer clic en Más opciones para proporcionar otro tipo de contenido circundante o requisitos de coincidencia adicionales para el formato de secreto.
    3. Proporciona una secuencia de pruebas de muestra para asegurarte de que tu configuración empate con los patrones que esperas.

    Crear un formato de patrón personalizado del escaneo de secretos

  7. Cuando estés satisfecho con tu patrón personalizado nuevo, haz clic en Crear patrón.

After your pattern is created, escaneo de secretos scans for any secrets in private repositories in your organization, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing escaneo de secretos alerts, see "Managing alerts from escaneo de secretos."

Defining a custom pattern for an enterprise account

Before defining a custom pattern, you must ensure that you enable secret scanning for your enterprise account. For more information, see "Enabling GitHub Advanced Security for your enterprise."

Note: As there is no dry-run functionality, we recommend that you test your custom patterns in a repository before defining them for your entire enterprise. That way, you can avoid creating excess false-positive escaneo de secretos alerts.

  1. En la barra lateral de la cuenta de empresa, haz clic en Policies (Políticas). Pestaña Policies (Políticas) en la barra lateral de la cuenta de empresa

  2. Debajo de Políticas, haz clic en "Seguridad Avanzada". Políticas de "Seguridad Avanzada" en la barra lateral

  3. Debajo de "GitHub Advanced Security", haz clic en la pestaña de Características de Seguridad.

  4. Under "Secret scanning custom patterns", click New pattern.

  5. Ingresa los detalles de tu patrón personalizado nuevo:

    1. Debes proporcionar por lo menos el nombre de tu patrón y una expresión regular para el formato de tu patrón secreto.
    2. Puedes hacer clic en Más opciones para proporcionar otro tipo de contenido circundante o requisitos de coincidencia adicionales para el formato de secreto.
    3. Proporciona una secuencia de pruebas de muestra para asegurarte de que tu configuración empate con los patrones que esperas.

    Crear un formato de patrón personalizado del escaneo de secretos

  6. Cuando estés satisfecho con tu patrón personalizado nuevo, haz clic en Crear patrón.

After your pattern is created, escaneo de secretos scans for any secrets in private repositories within your enterprise's organizations with GitHub Advanced Security enabled, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing escaneo de secretos alerts, see "Managing alerts from escaneo de secretos."

Editing a custom pattern

When you save a change to a custom pattern, this closes all the escaneo de secretos alerts that were created using the previous version of the pattern.

  1. Navigate to where the custom pattern was created. A custom pattern can be created in a repository, organization, or enterprise account.
  2. Under "Escaneo de secretos", to the right of the custom pattern you want to edit, click .
  3. When you have reviewed and tested your changes, click Save changes.

Removing a custom pattern

  1. Navigate to where the custom pattern was created. A custom pattern can be created in a repository, organization, or enterprise account.

  2. To the right of the custom pattern you want to remove, click .

  3. Review the confirmation, and select a method for dealing with any open alerts relating to the custom pattern.

  4. Click Yes, delete this pattern.

    Confirming deletion of a custom escaneo de secretos pattern

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