
ماسح أسرار بدون اعتماديات لشيفرة المصدر وسجل git يكتشف مفاتيح API والرموز والمفاتيح الخاصة المسرّبة، مع مخرجات محجوبة ومهمة GitLab CI جاهزة للاستخدام.
ماسح أسرار صغير عديم الاعتماديات للشيفرة المصدرية وسجل git، مع مهمة GitLab CI جاهزة للاستخدام المباشر.
يكتشف مفاتيح API المسربة والرموز المميزة والمفاتيح الخاصة وكلمات المرور قبل أن تصل إلى الإنتاج، بما في ذلك الأسرار التي أُودعت مرة واحدة ثم "أُزيلت" لاحقًا لكنها لا تزال موجودة في السجل.
$ 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 في commit لاحق. تقول عملية فحص الملفات العادية إن المستودع
نظيف، لكن المفتاح لا يزال قابلاً للاسترداد باستخدام git log -p، لذا فهو لا يزال مسربًا.
password = "...".changeme و${API_KEY} و{{ vault_token }} و<your-password>.--rev-range base..HEAD يفحص الـ commits الجديدة فقط..secretscanignore (أنماط glob بنمط gitignore) و# 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
| رمز الخروج | المعنى |
|---|---|
| 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"
تستنسخ المهمة السجل الكامل (GIT_DEPTH: 0)، وتفحص فقط الـ commits الجديدة في خطوط أنابيب merge request،
أما في الحالات الأخرى فتفحص السجل بأكمله، وتُفشل خط الأنابيب عند العثور على نتائج، وترفع gl-secret-detection-report.json كتقرير
secret_detection. في GitLab Ultimate تظهر تلك النتائج في أداة أمان merge request
وفي تقرير الثغرات؛ أما في الطبقات الأخرى فيُحتفظ بالتقرير كأثر قابل للتنزيل. اضبط
SECRETSCAN_FAIL_ON لضبط الحد.
يقوم ملف .gitlab-ci.yml الخاص بهذا المستودع بفحص الشيفرة، واختبارها على Python 3.10 حتى 3.13 مع قياس التغطية،
وتشغيل الماسح على سجله الخاص.
src/secretscan/rules.py) هي تعبيرات نمطية. مجموعة الالتقاط الأولى هي السر.
كما تضبط القواعد العامة حدًا أدنى من الإنتروبيا حتى لا يُطلق password = "aaaaaaaaaaaa"..git وnode_modules والبيئات الافتراضية والملفات الثنائية (كشف بايت NUL)،
والملفات التي تتجاوز 2 ميغابايت وأي شيء في .secretscanignore.git log --all --reverse -p --unified=0 ويحلل تدفق الفروقات، متتبعًا
الـ commit الحالي والملف ورقم السطر في الجانب الجديد من كل ترويسة مقطع @@. تُفحص أسطر + فقط، لذا
يُبلَّغ عن السر مرة واحدة، عند الـ commit الذي أدخله، بدلًا من مرة واحدة لكل commit لاحق.pip install -e ".[dev]"
pytest
ruff check . && ruff format --check .
لا تحتوي ملفات الاختبار أبدًا على بيانات اعتماد حقيقية. يتم تجميع الرموز المزيفة في tests/fakes.py من أجزاء في وقت التشغيل بحيث لا يحتوي المستودع نفسه على أي سلاسل كاملة تشبه الرموز. يحافظ ذلك على نظافة الفحص الذاتي في CI ويتجنب تفعيل حماية الدفع في GitLab.
MIT