Configurar el escaneo de secretos para tus repositorios

Puedes configurar la forma en que GitHub escanea tus repositorios para encontrar secretos.

People with admin permissions to a repository can enable escaneo de secretos for the repository.

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

Habilitar el escaneo de secretos para los repositorios

Puedes habilitar el escaneo de secretos para cualquier repositorio que pertenezca a una organización. Una vez habilitado, 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.

  1. En tu instancia de GitHub Enterprise Server, 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. Si aún no se ha habilitado la Advanced Security para el repositorio, haz clic en Habilitar a la derecha de "GitHub Advanced Security". Enable GitHub Advanced Security for your repository

  5. Revisa el impacto de habilitar la Advanced Security y luego haz clic en Habilitar la GitHub Advanced Security para este repositorio.

  6. Cuando habilitas la Advanced Security, puede que el escaneo de secretos se habilite en el repositorio debido a la configuración de la organización. Si se muestra "Escaneo de secretos" con un botón de Habilitar, aún necesitarás habilitar el escaneo de secretos si das clic en Habilitar. Si ves un botón de Inhabilitar, entonces el escaneo de secretos ya se encuentra habilitado. Habilitar el escaneo de secretos para tu repositorio

Excluir alertas del escaneo de secretos en los repositorios

Puedes utilizar un archivo secret_scanning.yml para excluir los directorios de escaneo de secretos. Por ejemplo, puedes excluir directorios que contengan pruebas o contenido generado aleatoriamente.

  1. En tu instancia de GitHub Enterprise Server, visita la página principal del repositorio.

  2. En la parte superior de la lista de archivos, utilizando el menú desplegable de Agregar archivo, da clic en Crear archivo nuevo. "Crear archivo nuevo" en el menú desplegable de "Agregar archivo"

  3. En el campo de nombre del archivo, teclea .github/secret_scanning.yml.

  4. Debajo de Editar nuevo archivo, teclea paths-ignore: seguido por las rutas que quieras excluir de escaneo de secretos.

    paths-ignore:
      - "foo/bar/*.js"
    

    Puedes utilizar caracteres especiales, tales como * para filtrar las rutas. Para obtener más información acerca de filtrar las rutas, consulta la sección "Sintaxis de flujo de trabajo para GitHub Actions".

    Notas:

    • Si hay más de 1,000 entradas en paths-ignore, escaneo de secretos solo excluirá de los escaneos a los primeros 1,000 directorios.
    • Si secret_scanning.yml es mayor a 1 MB, escaneo de secretos ignorará todo el archivo.

También puedes ignorar alertas individuales de escaneo de secretos. Para obtener más información, consulta la sección "Administrar las alertas de escaneo de secretos".

Leer más

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