
Scanner di segreti senza dipendenze per codice sorgente e cronologia git che rileva chiavi API, token e chiavi private trapelati, con output oscurato e un job GitLab CI pronto all'uso.
Un piccolo scanner di segreti senza dipendenze per il codice sorgente e la cronologia git, con un job GitLab CI pronto all'uso.
Trova chiavi API, token, chiavi private e password trapelate prima che raggiungano la produzione, inclusi i segreti che sono stati committati una volta e "rimossi" in seguito ma che risiedono ancora nella cronologia.
$ 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.
In quella demo la chiave AWS è stata eliminata da settings.py in un commit successivo. Una semplice scansione dei file dice che il repository è
pulito, ma la chiave è ancora recuperabile con git log -p, quindi è ancora esposta.
password = "...".changeme, ${API_KEY}, {{ vault_token }} e <your-password>.--rev-range base..HEAD analizza solo i nuovi commit..secretscanignore (glob in stile 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
| Codice di uscita | Significato |
|---|---|
| 0 | Nessun risultato pari o superiore a --fail-on |
| 1 | Risultati pari o superiori a --fail-on |
| 2 | Errore di utilizzo (percorso errato, non un repository git, ...) |
Aggiungi un marcatore inline:
EXAMPLE_KEY = "..." # secretscan:ignore
Oppure crea .secretscanignore nella radice del repository:
# test fixtures
tests/fixtures/
*.lock
Aggiungi il job riutilizzabile a qualsiasi progetto:
include:
- remote: "https://gitlab.com/DaveyD347/secrets-scanner/-/raw/main/templates/secretscan.gitlab-ci.yml"
Il job clona la cronologia completa (GIT_DEPTH: 0), analizza solo i nuovi commit nelle pipeline di merge request e
l'intera cronologia altrimenti, fa fallire la pipeline in caso di rilevamenti e carica gl-secret-detection-report.json come
report secret_detection. Su GitLab Ultimate tali rilevamenti compaiono nel widget di sicurezza della merge request e
nel vulnerability report; sugli altri tier il report viene comunque conservato come artifact scaricabile. Imposta
SECRETSCAN_FAIL_ON per regolare la soglia.
Il .gitlab-ci.yml di questo stesso repository esegue lint, test su Python da 3.10 a 3.13 con coverage,
e avvia lo scanner sulla propria cronologia.
src/secretscan/rules.py) sono espressioni regolari. Il primo gruppo di cattura è il segreto.
Le regole generiche impostano anche un'entropia minima così che password = "aaaaaaaaaaaa" non scatti..git, node_modules, gli ambienti virtuali, i binari (rilevamento del byte NUL),
i file oltre 2 MB e qualsiasi cosa presente in .secretscanignore.git log --all --reverse -p --unified=0 e analizza il flusso del diff, tenendo traccia del
commit corrente, del file e del numero di riga lato nuovo da ciascuna intestazione di hunk @@. Vengono controllate solo le righe +, quindi
un segreto viene segnalato una sola volta, al commit che lo ha introdotto, anziché una volta per ogni commit successivo.pip install -e ".[dev]"
pytest
ruff check . && ruff format --check .
I fixture di test non contengono mai credenziali reali. I token fittizi in tests/fakes.py sono assemblati da parti a
runtime, così che il repository stesso non contenga stringhe complete a forma di token. Questo mantiene pulita la self-scan
della CI ed evita di attivare la protezione push di GitLab.
MIT