Skip to main content

Configuración del examen de secretos para los repositorios

Puedes configurar la forma en la que GitHub escanea tus repositorios en búsqueda de secretos que coincidan con los patrones de seguridad avanzada.

Who can use this feature

People with admin permissions to a repository can enable secret scanning for the repository.

Secret scanning is available for organization-owned repositories in GitHub Enterprise Server if your enterprise has a license for GitHub Advanced Security. Para más información, consulte "Acerca de GitHub Advanced Security".

Nota: El administrador del sitio debe habilitar secret scanning para your GitHub Enterprise Server instance antes de que puedas utilizar esta característica. Para más información, consulta "Configuración de secret scanning para el dispositivo".

Habilitación de secret scanning

Puedes habilitar secret scanning para cualquier repositorio que sea propiedad de una organización. Una vez que se habilite, El secret scanning escanea cualquier secreto en el total de tu historial de Git en todas las ramas presentes de tu repositorio de GitHub.

  1. En your GitHub Enterprise Server instance, vaya a la página principal del repositorio. 1. Debajo del nombre del repositorio, haz clic en Configuración. Botón de configuración del repositorio

  2. In the "Security" section of the sidebar, click Code security and analysis.

  3. Si Advanced Security todavía no está habilitado para el repositorio, a la derecha de "GitHub Advanced Security", haz clic en Habilitar. Habilitación de GitHub Advanced Security para el repositorio

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

  5. Cuando habilitas la Advanced Security, puede que el secret scanning se habilite en el repositorio debido a la configuración de la organización. Si "Secret scanning" se muestra con un botón Habilitar, debes habilitar secret scanning haciendo clic en Habilitar. Si ves un botón Deshabilitar, secret scanning ya está habilitado. Habilitación de secret scanning para el repositorio

  6. Opcionalmente, si quieres habilitar la protección de los envíos de cambios, haz clic en Habilitar a la derecha de "Protección de envíos de cambios". Al habilitar la protección de inserción, secret scanning también comprueba si hay secretos de alta confianza (los identificados con una tasa de falsos positivos baja). Secret scanning enumera los secretos que detecta para que el creador pueda revisarlos y quitarlos, o si es necesario, permitir que se inserten. Para obtener más información, consulta "Protección de envíos de cambios con secret scanning". Habilitar la protección de envíos de cambios para el repositorio

Excluir directorios de la secret scanning

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

  1. En your GitHub Enterprise Server instance, vaya a la página principal del repositorio. 1. Encima de la lista de archivos, haga clic en Create new file (Crear archivo) mediante la lista desplegable Add file (Agregar archivo). "Crear archivo" en la lista desplegable "Agregar archivo"

  2. En el campo nombre de archivo, escribe .github/secret_scanning.yml.

  3. En Editar nuevo archivo, escribe paths-ignore: seguido por las rutas de acceso que quieras excluir de secret scanning.

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

    Puede usar caracteres especiales, como * para filtrar las rutas. Para obtener más información sobre los patrones de filtro, consulta "Sintaxis de flujo de trabajo para Acciones de GitHub".

    Notas:

    • Si hay más de 1000 entradas en paths-ignore, secret scanning solo excluirá los primeros 1000 directorios de los análisis.
    • Si secret_scanning.yml es mayor que 1 MB, secret scanning ignorará todo el archivo.

También puedes ignorar alertas individuales de secret scanning. Para obtener más información, consulta "Administración de alertas de secret scanning".

Información adicional