
Abhängigkeitsfreier Secrets-Scanner für Quellcode und Git-Historie, der geleakte API-Schlüssel, Tokens und private Schlüssel erkennt, mit redigierter Ausgabe und einem direkt einsetzbaren GitLab-CI-Job.
Ein kleiner, abhängigkeitsfreier Secrets-Scanner für Quellcode und Git-Historie, mit einem Drop-in-GitLab-CI-Job.
Er findet geleakte API-Schlüssel, Tokens, private Schlüssel und Passwörter, bevor sie die Produktion erreichen, einschließlich Secrets, die einmal committet und später „entfernt“ wurden, aber noch immer in der Historie stecken.
$ 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 dieser Demo wurde der AWS-Schlüssel in einem späteren Commit aus settings.py gelöscht. Ein einfacher Dateiscan meldet, dass das Repository sauber ist, aber der Schlüssel ist mit git log -p weiterhin wiederherstellbar, also ist er weiterhin geleakt.
password = "..."-Regel.changeme, ${API_KEY}, {{ vault_token }} und <your-password>.--rev-range base..HEAD scannt nur neue Commits..secretscanignore (Globs im gitignore-Stil) und inline # secretscan:ignore.--fail-on-Schweregrad-Schwellenwert.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
| Exit-Code | Bedeutung |
|---|---|
| 0 | Keine Befunde auf oder über --fail-on |
| 1 | Befunde auf oder über --fail-on |
| 2 | Nutzungsfehler (ungültiger Pfad, kein Git-Repo, ...) |
Fügen Sie einen Inline-Marker hinzu:
EXAMPLE_KEY = "..." # secretscan:ignore
Oder erstelle .secretscanignore im Repo-Stammverzeichnis:
# test fixtures
tests/fixtures/
*.lock
Fügen Sie den wiederverwendbaren Job zu jedem Projekt hinzu:
include:
- remote: "https://gitlab.com/DaveyD347/secrets-scanner/-/raw/main/templates/secretscan.gitlab-ci.yml"
Der Job klont die vollständige Historie (GIT_DEPTH: 0), scannt in Merge-Request-Pipelines nur die neuen Commits und ansonsten
die gesamte Historie, lässt die Pipeline bei Funden fehlschlagen und lädt gl-secret-detection-report.json als
secret_detection-Report hoch. Auf GitLab Ultimate erscheinen diese Funde im Sicherheits-Widget des Merge Requests und
im Schwachstellenbericht; auf anderen Tarifen wird der Report weiterhin als herunterladbares Artefakt aufbewahrt. Setze
SECRETSCAN_FAIL_ON, um den Schwellenwert anzupassen.
Die eigene .gitlab-ci.yml dieses Repositorys führt Linting durch, testet auf Python 3.10 bis 3.13 mit Coverage
und führt den Scanner gegen die eigene Historie aus.
src/secretscan/rules.py) sind reguläre Ausdrücke. Die erste Capture-Gruppe ist das Secret.
Generische Regeln legen zusätzlich eine Mindestentropie fest, damit password = "aaaaaaaaaaaa" nicht auslöst..git, node_modules, virtualenvs, Binärdateien (NUL-Byte-Erkennung),
Dateien über 2 MB und alles in .secretscanignore.git log --all --reverse -p --unified=0 aus und parst den Diff-Stream, wobei der
aktuelle Commit, die Datei und die Zeilennummer auf der neuen Seite aus jedem @@-Hunk-Header verfolgt werden. Nur +-Zeilen werden geprüft, sodass
ein Secret einmal gemeldet wird, und zwar bei dem Commit, der es eingeführt hat, statt einmal für jeden späteren Commit.pip install -e ".[dev]"
pytest
ruff check . && ruff format --check .
Test-Fixtures enthalten niemals echte Anmeldedaten. Die Fake-Tokens in tests/fakes.py werden zur Laufzeit aus Einzelteilen zusammengesetzt, sodass das Repository selbst keine vollständigen tokenförmigen Zeichenketten enthält. Das hält den CI-Selbstscan sauber und vermeidet, den GitLab-Push-Schutz auszulösen.
MIT