niclas-zone/ci/gitleaksComponente de CI para la herramienta SAST Gitleaks que escanea repositorios git en busca de secretos codificados, claves API y tokens, con soporte de configuración personalizada y remota.
Un componente de GitLab CI para Gitleaks - una herramienta SAST para detectar y prevenir secretos hardcodeados como contraseñas, claves de API y tokens en repositorios git.
include:
- component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
stages:
- test
include:
- component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
inputs:
GITLEAKS_CONFIG: ".gitleaks.toml"
GITLEAKS_EXTRA_ARGS: "--verbose --report-format sarif"
stages:
- test
include:
- component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
inputs:
GITLEAKS_REMOTE_CONFIG: "https://gitlab.com/niclas-zone/ci/gitleaks/-/raw/main/configs/gitleaks.toml"
stages:
- test
| Entrada | Descripción | Por defecto |
|---|---|---|
job_name | Nombre del trabajo de CI | "secret scanning" |
stage | Etapa del pipeline | "test" |
image | Imagen Docker para Gitleaks | "registry.gitlab.com/niclas-zone/ctr/gitleaks:8.28.0" |
GITLEAKS_EXTRA_ARGS | Argumentos extra para Gitleaks | "--verbose --redact --report-format json" |
GITLEAKS_CONFIG | Ruta al archivo de configuración local | "" |
GITLEAKS_REMOTE_CONFIG | URL para descargar archivo de config. | "" |
Coloca un archivo .gitleaks.toml en la raíz de tu repositorio o especifica la ruta usando GITLEAKS_CONFIG.
Establece GITLEAKS_REMOTE_CONFIG para descargar un archivo de configuración desde una URL. Esto es útil para compartir configuraciones entre múltiples proyectos.
Si no se especifica una configuración local o remota, el componente utilizará las reglas predeterminadas integradas de Gitleaks.
El componente genera los siguientes artefactos:
gitleaks-report.json: Resultados del escaneo en formato JSON (u otro formato según el argumento --report-format)Para más información sobre la configuración y opciones de Gitleaks, consulta: