Skip to main content

Configuración del examen de secretos para los repositorios

Puedes configurar la forma en que GitHub escanea tus repositorios en busca de secretos filtrados y genera alertas.

Quién puede usar esta característica

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

Secret scanning está disponible para repositorios que son propiedad de una organización en GitHub Enterprise Server si la empresa tiene una licencia de GitHub Advanced Security. Para más información, consulta "Acerca del examen de secretos" y "Acerca de GitHub Advanced Security".

Nota: El administrador del sitio debe habilitar secret scanning para tu instancia de GitHub Enterprise Server para que puedas utilizar esta característica. Para obtener más información, vea «Configurar el escaneo de secretos para tu aplicativo».

Es posible que no puedas habilitar o deshabilitar secret scanning si un propietario de empresa ha establecido una directiva GitHub Advanced Security (GHAS) en el nivel empresarial. Para obtener más información, vea «Aplicación de directivas de seguridad y análisis de código de la empresa».

Enabling examen de secretos

Puedes habilitar examen de secretos para cualquier público gratuito que pertenezca a una organización. Una vez habilitado, El secret scanning escanea cualquier secreto en el total de tu historial de Git en todas las ramas presentes de tu repositorio de GitHub.

También puedes habilitar secret scanning para varios repositorios de una organización al mismo tiempo. Para obtener más información, vea «Protección de la organización».

Nota: Si tu organización es propiedad de una cuenta de empresa, un propietario de la empresa también puede habilitar secret scanning en el nivel empresarial. Para obtener más información, vea «Administración de las características de GitHub Advanced Security para la empresa».

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

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

    Captura de pantalla de un encabezado de repositorio en el que se muestran las pestañas. La pestaña "Configuración" está resaltada con un contorno naranja oscuro.

  3. En la sección "Seguridad" de la barra lateral, haga clic en Análisis y seguridad del código.

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

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

    Captura de pantalla de la sección "Secret scanning" de la página "Seguridad y análisis del código", con el botón "Habilitar" resaltado en naranja oscuro.

  7. 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 para la organización o el repositorio, 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 contra el envío de cambios para repositorios y organizaciones". Captura de pantalla de la sección "Secret scanning". Junto a un elemento con sangría marcado como "Protección de envío de cambios", el botón "Habilitar" aparece resaltado en un contorno naranja oscuro.

Excluir directorios de examen de secretos

Puedes configurar un archivo secret_scanning.yml para excluir directorios de secret scanning, incluidos los casos en los que usas protección de inserción. Por ejemplo, puedes excluir directorios que contengan pruebas o contenido generado aleatoriamente.

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

  2. Encima de la lista de archivos, haga clic en Create new file (Crear archivo) mediante la lista desplegable Add file (Agregar archivo).

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

  4. 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, vea «Administración de alertas del examen de secretos».

Información adicional