Definición de patrones personalizados para el examen de secretos

Definición de un patrón personalizado con Copilot

Puede usar Escaneo secreto de Copilot para generar expresiones regulares basadas en una descripción textual del tipo de patrón que le gustaría detectar, incluidas las cadenas de ejemplo opcionales que se deben detectar. Consulta Generación de expresiones regulares para patrones personalizados con el análisis de secretos de Copilot.

Definir un patrón común para un repositorio

Antes de definir un patrón personalizado, debes asegurarte de que Secret Protection está habilitado en el repositorio. Para más información, consulta Habilitación del examen de secretos para el repositorio.

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 Advanced Security.

4. En "Secret Protection", a la derecha de "Patrones personalizados", haz clic en Nuevo patrón. 1. 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.
   

5. Cuando esté listo para probar el nuevo patrón personalizado, a fin de identificar las coincidencias en el repositorio sin crear alertas, haga clic en Guardar y simular.

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

   

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

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

9. Opcionalmente, para habilitar la protección de inserción para el patrón personalizado, haz clic en Habilitar. Para más información, consulta Acerca de la protección de inserción.

   Nota:

   El botón "Habilitar" no está disponible hasta que la simulación se realice correctamente y publique el patrón.

Después de que se cree el patrón, El secret scanning escanea cualquier secreto en el total de tu historial de Git en todas las ramas presentes de tu repositorio de GitHub.. Para más información sobre cómo visualizar alertas alertas de detección de secretos, consulta Administración de alertas de examen de secretos.

Definir un patrón común para una organización

Antes de definir un patrón personalizado, debes asegurarte de que hayas habilitado el secret scanning para los repositorios que quieras escanear en tu organización. Puede usar security configurations para habilitar el secret scanning en todos los repositorios de la organización. Para obtener más información, consulte Habilitación de características de seguridad a gran escala.

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

2. Junto a la organización, haga clic en Settings.

3. En la sección "Seguridad" de la barra lateral, seleccione el menú desplegable Advanced Security y haga clic en Global settings.

4. En «Patrones personalizados», haz clic en Nuevo patrón.

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

6. Cuando estés listo para probar el nuevo patrón personalizado para identificar coincidencias en repositorios seleccionados sin crear alertas, haz clic en Guardar y realizar ensayo.

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

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

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

   

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

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

12. Opcionalmente, para habilitar la protección de inserción para el patrón personalizado, haz clic en Habilitar. Para más información, consulta Acerca de la protección de inserción.

    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.

Después de crear tu patrón, el secret scanning escaneará en búsqueda de cualquier secreto en los repositorios de tu organización, incluyendo el historial completo de Git en todas las ramas. Se le alertará a los propietarios de las organizaciones y los administradores de los repositorios sobre cualquier secreto que se haya encontrado y podrán revisar la alerta en el repositorio en cuestión. Para obtener más información sobre la visualización de alertas de detección de secretos, consulte Administración de alertas de examen de secretos.

Definir un patrón común para una cuenta empresarial

1. Vaya a su empresa. Por ejemplo, desde la página Empresas en GitHub.com.

2. En la parte superior de la página, haz clic en Policies.

3. En "Directivas", haz clic en Advanced Security.

4. En "Advanced Security", haga clic en Características de seguridad.

5. En "Patrones personalizados de examen de secretos", haz 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. Cuando estés a punto para probar el nuevo patrón personalizado, a fin de identificar las coincidencias en la empresa sin crear alertas, haz clic en Guardar y simular.

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. Opcionalmente, para habilitar la protección de inserción para el patrón personalizado, haz clic en Habilitar. Para más información, consulta Acerca de la protección de inserción.

    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.

Después de que se haya creado tu patrón, el secret scanning buscará cualquier secreto en los repositorios de las organizaciones que tengan habilitada GitHub Secret Protection, incluyendo en todo el historial de Git de todas las ramas. Se alertará a los propietarios de organizaciones y administradores de repositorios de cualquier secreto que se encuentre y estos podrán revisar la alerta en el repositorio en donde se encontró el secreto. Para obtener más información sobre la visualización de alertas de detección de secretos, consulte Administración de alertas de examen de secretos.

Lectura adicional

•         [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns)
  

•         [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/metrics-for-custom-patterns)