Seguridad de Bitbucket: Escáner de secretos

Escanea tus archivos en busca de secretos, claves y contraseñas codificados de forma rígida. Crea un informe de Code Insights de seguridad si los encuentra.

Este Pipe compatible con Bitbucket Cloud aprovecha el registro de patrones de secretos de gitleaks para proporcionar a los clientes de Bitbucket capacidades líderes en la industria de escaneo de secretos de seguridad. Consulta la sección Detalles y Ejemplos para obtener más información.

Nota: Se introdujeron cambios importantes en la versión 2.0.0. Revisa la versión actual del Pipe y actualiza tu configuración en consecuencia antes de actualizar.

Nota: Se introdujeron cambios importantes en la versión 3.0.0. Revisa la versión actual del Pipe y actualiza tu configuración en consecuencia antes de actualizar.

Definición de YAML

Añade el siguiente fragmento a la sección script de tu archivo bitbucket-pipelines.yml:

- pipe: atlassian/git-secrets-scan:3.2.0
  variables:
    # GITLEAKS_COMMAND: '<string>' # Optional. Default: `git`
    # GITLEAKS_EXTRA_ARGS: '<array>' # Optional.
    # CREATE_REPORT: "<boolean>" # Optional. Default: `true`
    # DEBUG: "<boolean>" # Optional. Default: `false`

Variables

Variable	Uso
GITLEAKS_COMMAND	Comando a usar con gitleaks. Disponible: git, dir, stdin. Predeterminado: git.
GITLEAKS_EXTRA_ARGS	Flags adicionales para pasar a gitleaks gitleaks extra args.
CREATE_REPORT	Controla si el pipe creará informes de Bitbucket CodeInsights usando los resultados de la ejecución de gitleaks. Predeterminado: true.
DEBUG	Activa información de depuración adicional. Predeterminado: false.

Detalles

Por defecto, el pipe escaneará tus archivos en busca de credenciales secretas codificadas con el comando gitleaks git y creará un informe de seguridad con anotaciones para cada credencial encontrada.

Uso avanzado

Echa un vistazo a esta entrada de blog para una configuración avanzada de gitleaks: gitleaks advanced configuration setup.

Cómo ignorar secretos de prueba: gitleaks additional-configuration.

Ejemplos

Ejemplo básico:

Ejecuta un escaneo de credenciales secretas con el comando git predeterminado:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0

El comando dir te permite escanear directorios y archivos:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      GITLEAKS_COMMAND: "dir"
      GITLEAKS_EXTRA_ARGS: "./path_to_directory_or_file"

No cree un informe de CodeInsights:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      CREATE_REPORT: "false"

Ejemplo avanzado:

Escanear directorios y archivos, proporcionar una configuración personalizada de gitleaks y activar el modo de depuración:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      DEBUG: "true"
      GITLEAKS_COMMAND: "dir"
      GITLEAKS_EXTRA_ARGS: 
        - "./path_to_directory_or_file"
        - "--config=my-gitleaks-config.toml"

Soporte

Si necesitas ayuda con este pipe, o tienes un problema o una solicitud de funcionalidad, avísanos en la Comunidad.

Si vas a reportar un problema, incluye:

• la versión del pipe
• los registros y mensajes de error relevantes
• los pasos para reproducirlo

Licencia

Copyright (c) 2020 Atlassian y otros. Licencia Apache 2.0, consulta el archivo LICENSE.txt.