Defining custom patterns for secret scanning

Defining a custom pattern for a repository

Before defining a custom pattern, you must ensure that secret scanning is enabled on your repository. For more information, see Enabling secret scanning for your repository.

1. En GitHub, navegue hasta la página principal del repositorio.

2. Debajo del nombre del repositorio, haz clic en Settings. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

   

3. En la sección "Security" de la barra lateral, haz clic en Code security and analysis.

1. En "Code security and analysis", busca "GitHub Advanced Security."

2. En "Secret scanning", en "Patrones personalizados", haz clic en Nuevo patrón.

3. Escribe los detalles del nuevo patrón personalizado. Debes proporcionar por lo menos el nombre de tu patrón y una expresión regular para el formato de tu patrón secreto.

   1. En el campo "Nombre de patrón", escribe un nombre para el patrón.
   2. En el campo "Formato secreto", escriba una expresión regular para el formato del patrón secreto.
   3. Puedes hacer clic en More options para proporcionar otro tipo de contenido circundante o requisitos de coincidencia adicionales para el formato del secreto. Consulta Referencia de patrones personalizados.
   4. Proporciona una secuencia de pruebas de muestra para asegurarte de que tu configuración empate con los patrones que esperas.
   

4. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click Save and dry run.

5. Cuando termine el simulacro verás un ejemplo de los resultados (hasta 1000). Revisa los resultados e identifica cualquier falso positivo.

   

6. Edita el nuevo patrón personalizado para corregir cualquier problema con los resultados y, después, haz clic en Guardar y realizar simulacro para probar los cambios.

7. Cuando el nuevo patrón personalizado sea satisfactorio, haz clic en Publicar patrón.

8. Optionally, to enable push protection for your custom pattern, click Enable. For more information, see Push protection.

   Nota:

   The "Enable" button isn't available until after the dry run succeeds and you publish the pattern.

After your pattern is created, El secret scanning 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 alertas de detección de secretos, see Administración de alertas de examen de secretos.

Defining a custom pattern for an organization

Before defining a custom pattern, you must ensure that you enable secret scanning for the repositories that you want to scan in your organization. You can use security configurations to enable secret scanning on all repositories in your organization. For more information, see Enabling security features at scale.

1. En la esquina superior derecha de GitHub, haz clic en la foto del perfil y luego en Your organizations.

2. Seleccione una organización haciendo clic en ella.

3. Debajo del nombre de la organización, haz clic en Settings. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

   

4. In the "Security" section of the sidebar, select the Code security and analysis dropdown menu, then click Global settings.

5. En "Patrones personalizados", haga clic en Nuevo patrón.

6. Escribe los detalles del nuevo patrón personalizado. Debes proporcionar por lo menos el nombre de tu patrón y una expresión regular para el formato de tu patrón secreto.

   1. En el campo "Nombre de patrón", escribe un nombre para el patrón.
   2. En el campo "Formato secreto", escriba una expresión regular para el formato del patrón secreto.
   3. Puedes hacer clic en More options para proporcionar otro tipo de contenido circundante o requisitos de coincidencia adicionales para el formato del secreto. Consulta Referencia de patrones personalizados.
   4. Proporciona una secuencia de pruebas de muestra para asegurarte de que tu configuración empate con los patrones que esperas.
   

7. When you're ready to test your new custom pattern, to identify matches in select repositories without creating alerts, click Save and dry run.

8. Seleccione los repositorios en los que desea realizar el simulacro.

   • Para realizar la ejecución en seco en toda la organización, seleccione Todos los repositorios de la organización.
   • Para especificar los repositorios en los que desea realizar el simulacro, seleccione Repositorios seleccionados, busque y seleccione hasta 10 repositorios.

9. Cuando tenga todo listo para probar el nuevo patrón personalizado, haga clic en Ejecutar.

10. Cuando termine el simulacro verás un ejemplo de los resultados (hasta 1000). Revisa los resultados e identifica cualquier falso positivo.

    

11. Edita el nuevo patrón personalizado para corregir cualquier problema con los resultados y, después, haz clic en Guardar y realizar simulacro para probar los cambios.

12. Cuando el nuevo patrón personalizado sea satisfactorio, haz clic en Publicar patrón.

13. Optionally, to enable push protection for your custom pattern, click Enable. For more information, see Push protection.

    Nota:

    • La opción para habilitar la protección de empuje solo es visible para los patrones publicados.
    • La protección de inserción para patrones personalizados solo se aplicará a los repositorios de tu organización que tengan secret scanning como protección de inserción habilitada.
    • La habilitación de la protección de inserción para patrones personalizados que se encuentran habitualmente puede ser perjudicial para los colaboradores.

After your pattern is created, secret scanning scans for any secrets in 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 alertas de detección de secretos, see Administración de alertas de examen 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 Habilitación de GitHub Advanced Securitypara su empresa.

1. En la esquina superior derecha de GitHub Enterprise Server, haz clic en la foto de perfil y luego en Enterprise settings.

2. En el lado izquierdo de la página, en la barra lateral de la cuenta de empresa, haz clic en Policies.

3. En "Directivas", haz clic en Code security and analysis.

4. Under "Code security and analysis", click Security features.

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

6. Escribe los detalles del nuevo patrón personalizado. Debes proporcionar por lo menos el nombre de tu patrón y una expresión regular para el formato de tu patrón secreto.

   1. En el campo "Nombre de patrón", escribe un nombre para el patrón.
   2. En el campo "Formato secreto", escriba una expresión regular para el formato del patrón secreto.
   3. Puedes hacer clic en More options para proporcionar otro tipo de contenido circundante o requisitos de coincidencia adicionales para el formato del secreto. Consulta Referencia de patrones personalizados.
   4. Proporciona una secuencia de pruebas de muestra para asegurarte de que tu configuración empate con los patrones que esperas.
   

7. When you're ready to test your new custom pattern, to identify matches in the enterprise without creating alerts, click Save and dry run.

8. Busca y selecciona hasta 10 repositorios en los que quieras realizar el simulacro.

9. Cuando tenga todo listo para probar el nuevo patrón personalizado, haga clic en Ejecutar.

10. Cuando termine el simulacro verás un ejemplo de los resultados (hasta 1000). Revisa los resultados e identifica cualquier falso positivo.

    

11. Edita el nuevo patrón personalizado para corregir cualquier problema con los resultados y, después, haz clic en Guardar y realizar simulacro para probar los cambios.

12. Cuando el nuevo patrón personalizado sea satisfactorio, haz clic en Publicar patrón.

13. Optionally, to enable push protection for your custom pattern, click Enable. For more information, see Push protection.

    Nota:

    • Para habilitar la protección de inserción para patrones personalizados, secret scanning porque la protección de inserción debe habilitarse en el nivel empresarial.
    • La habilitación de la protección de inserción para patrones personalizados que se encuentran habitualmente puede ser perjudicial para los colaboradores.

After your pattern is created, secret scanning scans for any secrets in repositories within your 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 alertas de detección de secretos, see Administración de alertas de examen de secretos.