
Scanner de secrets sans dépendances pour le code source et l'historique git qui détecte les clés API, jetons et clés privées divulgués, avec une sortie expurgée et une tâche GitLab CI prête à l'emploi.
Un petit scanner de secrets sans dépendances pour le code source et l'historique git, avec une tâche GitLab CI prête à l'emploi.
Il détecte les clés d'API, jetons, clés privées et mots de passe divulgués avant qu'ils n'atteignent la production, y compris les secrets qui ont été commités une fois puis « supprimés » plus tard mais qui restent présents dans l'historique.
$ 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.
Dans cette démo, la clé AWS a été supprimée de settings.py dans un commit ultérieur. Une simple analyse de fichiers indique que le dépôt est
propre, mais la clé reste récupérable avec git log -p, elle est donc toujours exposée.
password = "...".changeme, ${API_KEY}, {{ vault_token }} et <your-password>.--rev-range base..HEAD n'analyse que les nouveaux commits..secretscanignore (globs de style gitignore) et # secretscan:ignore en ligne.--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
| Code de sortie | Signification |
|---|---|
| 0 | Aucune détection au niveau ou au-dessus de --fail-on |
| 1 | Détections au niveau ou au-dessus de --fail-on |
| 2 | Erreur d'utilisation (chemin invalide, pas un dépôt git, ...) |
Ajoutez un marqueur en ligne :
EXAMPLE_KEY = "..." # secretscan:ignore
Ou créez .secretscanignore à la racine du dépôt :
# test fixtures
tests/fixtures/
*.lock
Ajoutez la tâche réutilisable à n'importe quel projet :
include:
- remote: "https://gitlab.com/DaveyD347/secrets-scanner/-/raw/main/templates/secretscan.gitlab-ci.yml"
La tâche clone l'historique complet (GIT_DEPTH: 0), analyse uniquement les nouveaux commits sur les pipelines de merge request et
l'historique complet dans les autres cas, fait échouer le pipeline en cas de détection, et téléverse gl-secret-detection-report.json en tant que
rapport secret_detection. Sur GitLab Ultimate, ces détections apparaissent dans le widget de sécurité de la merge request et
dans le rapport de vulnérabilités ; sur les autres niveaux, le rapport est tout de même conservé comme artefact téléchargeable. Définissez
SECRETSCAN_FAIL_ON pour ajuster le seuil.
Le fichier .gitlab-ci.yml de ce dépôt effectue le lint, les tests sur Python 3.10 à 3.13 avec couverture,
et exécute le scanner sur son propre historique.
src/secretscan/rules.py) sont des expressions régulières. Le premier groupe de capture est le secret.
Les règles génériques définissent également une entropie minimale afin que password = "aaaaaaaaaaaa" ne déclenche pas d'alerte..git, node_modules, les virtualenvs, les binaires (détection d'octet NUL),
les fichiers de plus de 2 Mo et tout ce qui figure dans .secretscanignore.git log --all --reverse -p --unified=0 et analyse le flux de diff, en suivant le
commit courant, le fichier et le numéro de ligne côté nouveau à partir de chaque en-tête de hunk @@. Seules les lignes + sont vérifiées, ainsi
un secret est signalé une seule fois, au commit qui l'a introduit, plutôt qu'une fois pour chaque commit ultérieur.pip install -e ".[dev]"
pytest
ruff check . && ruff format --check .
Les fixtures de test ne contiennent jamais de vrais identifiants. Les faux jetons dans tests/fakes.py sont assemblés à partir de morceaux à l'exécution afin que le dépôt lui-même ne contienne aucune chaîne complète ayant la forme d'un jeton. Cela permet de garder l'auto-analyse de la CI propre et d'éviter de déclencher la protection contre les push de GitLab.
MIT