
Escáner de secretos sin dependencias para código fuente e historial de git que detecta claves de API, tokens y claves privadas filtradas, con salida redactada y un job de GitLab CI listo para usar.
Un pequeño escáner de secretos sin dependencias para código fuente y el historial de git, con un job de GitLab CI listo para usar.
Encuentra claves de API, tokens, claves privadas y contraseñas filtradas antes de que lleguen a producción, incluidos secretos que se commitearon una vez y se "eliminaron" después pero que siguen presentes en el historial.
$ secretscan scan . --history
[HIGH ] url-credentials deploy.sh:1 (commit 79831acaf3, Dev <[email protected]>)
Credentials embedded in a URL: Fake********
[HIGH ] aws-access-key-id settings.py:1 (commit 79831acaf3, Dev <[email protected]>)
AWS access key ID: AKIA************
2 potential secret(s) found.
En esa demo, la clave de AWS se eliminó de settings.py en un commit posterior. Un escaneo simple del archivo indica que el repositorio está limpio, pero la clave aún se puede recuperar con git log -p, por lo que sigue estando filtrada.
password = "...".changeme, ${API_KEY}, {{ vault_token }} y <your-password>.--rev-range base..HEAD escanea solo los commits nuevos..secretscanignore (globs estilo gitignore) e inline # secretscan:ignore.--fail-on.pip install git+https://gitlab.com/DaveyD347/secrets-scanner.git
# or, from a clone
pip install -e ".[dev]"
secretscan scan # scan the current directory's files
secretscan scan path/to/repo --history # files + entire git history
secretscan scan . --history-only # history only
secretscan scan . --rev-range origin/main..HEAD # only commits not yet on main
secretscan scan . --format json -o findings.json
secretscan scan . --fail-on high # only fail on high/critical
secretscan rules # list rules
| Código de salida | Significado |
|---|---|
| 0 | Sin hallazgos en o por encima de --fail-on |
| 1 | Hallazgos en o por encima de --fail-on |
| 2 | Error de uso (ruta incorrecta, no es un repositorio git, ...) |
Añade un marcador en línea:
EXAMPLE_KEY = "..." # secretscan:ignore
O crea .secretscanignore en la raíz del repositorio:
# test fixtures
tests/fixtures/
*.lock
Añade el job reutilizable a cualquier proyecto:
include:
- remote: "https://gitlab.com/DaveyD347/secrets-scanner/-/raw/main/templates/secretscan.gitlab-ci.yml"
El job clona el historial completo (GIT_DEPTH: 0), escanea solo los commits nuevos en las canalizaciones de merge request y el
historial completo en caso contrario, hace fallar la canalización si encuentra hallazgos y sube gl-secret-detection-report.json como un
informe secret_detection. En GitLab Ultimate esos hallazgos aparecen en el widget de seguridad del merge request y
en el informe de vulnerabilidades; en otros niveles el informe se conserva igualmente como artefacto descargable. Configura
SECRETSCAN_FAIL_ON para ajustar el umbral.
El propio .gitlab-ci.yml de este repositorio ejecuta lint, pruebas en Python 3.10 a 3.13 con cobertura,
y ejecuta el escáner contra su propio historial.
src/secretscan/rules.py) son expresiones regulares. El primer grupo de captura es el secreto.
Las reglas genéricas también establecen una entropía mínima para que password = "aaaaaaaaaaaa" no se active..git, node_modules, virtualenvs, binarios (detección de byte NUL),
archivos de más de 2 MB y cualquier cosa en .secretscanignore.git log --all --reverse -p --unified=0 y analiza el flujo de diff, rastreando el
commit actual, el archivo y el número de línea del lado nuevo a partir de cada encabezado de hunk @@. Solo se comprueban las líneas +, por lo que
un secreto se reporta una vez, en el commit que lo introdujo, en lugar de una vez por cada commit posterior.pip install -e ".[dev]"
pytest
ruff check . && ruff format --check .
Los fixtures de prueba nunca contienen credenciales reales. Los tokens falsos en tests/fakes.py se ensamblan a partir de piezas en tiempo de ejecución para que el repositorio en sí no contenga cadenas completas con forma de token. Eso mantiene limpio el autoescaneo de CI y evita activar la protección de push de GitLab.
MIT