
स्रोत कोड और git इतिहास के लिए निर्भरता-मुक्त secrets स्कैनर जो लीक हुई API कुंजियों, टोकन और निजी कुंजियों का पता लगाता है, redacted आउटपुट और एक drop-in GitLab CI जॉब के साथ।
स्रोत कोड और git इतिहास के लिए एक छोटा, निर्भरता-रहित secrets स्कैनर, जिसमें एक ड्रॉप-इन GitLab CI जॉब शामिल है।
यह उत्पादन तक पहुँचने से पहले लीक हुए API कुंजियों, टोकन, निजी कुंजियों और पासवर्ड का पता लगाता है, जिनमें वे secrets भी शामिल हैं जो एक बार कमिट किए गए थे और बाद में "हटा" दिए गए थे लेकिन अभी भी इतिहास में मौजूद हैं।
$ 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.
उस डेमो में AWS कुंजी को बाद के कमिट में settings.py से हटा दिया गया था। एक साधारण फ़ाइल स्कैन कहता है कि रेपो
साफ़ है, लेकिन कुंजी अभी भी git log -p से पुनर्प्राप्त की जा सकती है, इसलिए यह अभी भी लीक है।
password = "..." नियम।changeme, ${API_KEY}, {{ vault_token }} और <your-password> जैसे मानों के लिए एक प्लेसहोल्डर फ़िल्टर।--rev-range base..HEAD केवल नए कमिट स्कैन करता है।.secretscanignore (gitignore-शैली globs) और इनलाइन # secretscan:ignore।--fail-on गंभीरता थ्रेशोल्ड के साथ CI-अनुकूल एग्ज़िट कोड।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 | अर्थ |
|---|---|
| 0 | --fail-on पर या उससे ऊपर कोई निष्कर्ष नहीं |
| 1 | --fail-on पर या उससे ऊपर निष्कर्ष |
| 2 | उपयोग त्रुटि (गलत पथ, git रेपो नहीं, ...) |
एक इनलाइन मार्कर जोड़ें:
EXAMPLE_KEY = "..." # secretscan:ignore
या रेपो रूट पर .secretscanignore बनाएं:
# test fixtures
tests/fixtures/
*.lock
किसी भी प्रोजेक्ट में पुनः उपयोग योग्य जॉब जोड़ें:
include:
- remote: "https://gitlab.com/DaveyD347/secrets-scanner/-/raw/main/templates/secretscan.gitlab-ci.yml"
The job पूरा इतिहास क्लोन करता है (GIT_DEPTH: 0), merge request pipelines पर केवल नए commits स्कैन करता है और अन्यथा
पूरा इतिहास स्कैन करता है, findings पर pipeline को विफल करता है, और gl-secret-detection-report.json को
secret_detection report के रूप में अपलोड करता है। GitLab Ultimate पर वे findings merge request security widget और
vulnerability report में दिखाई देते हैं; अन्य tiers पर report फिर भी डाउनलोड करने योग्य artifact के रूप में रखी जाती है। थ्रेशोल्ड को ट्यून करने के लिए
SECRETSCAN_FAIL_ON सेट करें।
इस repository की अपनी .gitlab-ci.yml lint करती है, coverage के साथ Python 3.10 से 3.13 पर परीक्षण करती है,
और scanner को इसके अपने इतिहास के विरुद्ध चलाती है।
src/secretscan/rules.py) regular expressions हैं। पहला capture group secret है।
Generic rules एक न्यूनतम entropy भी सेट करते हैं ताकि password = "aaaaaaaaaaaa" fire न हो।.git, node_modules, virtualenvs, binaries (NUL byte sniff),
2 MB से बड़ी फ़ाइलें और .secretscanignore में मौजूद किसी भी चीज़ को छोड़ता है।git log --all --reverse -p --unified=0 चलाता है और diff stream को parse करता है, प्रत्येक @@ hunk header से
वर्तमान commit, file और new-side line number को track करता है। केवल + lines की जाँच की जाती है, इसलिए
एक secret की रिपोर्ट एक बार की जाती है, उस commit पर जिसने इसे पेश किया, न कि हर बाद के commit के लिए एक बार।pip install -e ".[dev]"
pytest
ruff check . && ruff format --check .
टेस्ट फ़िक्स्चर में कभी भी असली क्रेडेंशियल नहीं होते। tests/fakes.py में मौजूद नकली टोकन रनटाइम पर टुकड़ों से जोड़े जाते हैं ताकि रिपॉज़िटरी में कोई भी पूर्ण टोकन-आकार वाली स्ट्रिंग न हो। इससे CI सेल्फ-स्कैन साफ़ रहता है और GitLab पुश प्रोटेक्शन ट्रिगर होने से बचा जाता है।
MIT