niclas-zone/ci/gitleaksمكون CI لأداة Gitleaks SAST التي تقوم بمسح مستودعات git بحثاً عن الأسرار المشفرة، ومفاتيح API، والرموز المميزة مع دعم التكوين المخصص والبُعدي.
مكون GitLab CI لـ Gitleaks - أداة SAST للكشف عن ومنع الأسرار المشفرة مثل كلمات المرور ومفاتيح API والرموز في مستودعات git.
include:
- component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
stages:
- test
include:
- component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
inputs:
GITLEAKS_CONFIG: ".gitleaks.toml"
GITLEAKS_EXTRA_ARGS: "--verbose --report-format sarif"
stages:
- test
include:
- component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
inputs:
GITLEAKS_REMOTE_CONFIG: "https://gitlab.com/niclas-zone/ci/gitleaks/-/raw/main/configs/gitleaks.toml"
stages:
- test
ضع ملف .gitleaks.toml في جذر المستودع الخاص بك أو حدد المسار باستخدام GITLEAKS_CONFIG.
اضبط GITLEAKS_REMOTE_CONFIG لتنزيل ملف تكوين من رابط. هذا مفيد لمشاركة التكوينات عبر مشاريع متعددة.
إذا لم يتم تحديد تكوين محلي أو عن بُعد، سيستخدم المكون القواعد الافتراضية المضمنة في Gitleaks.
يقوم المكون بإنشاء القطع الأثرية التالية:
gitleaks-report.json: نتائج الفحص بتنسيق JSON (أو تنسيق آخر بناءً على وسيطة --report-format)لمزيد من المعلومات حول تكوين Gitleaks وخياراته، انظر:
| المدخل | الوصف | الافتراضي |
|---|
job_name | اسم وظيفة CI | "secret scanning" |
stage | مرحلة خط الأنابيب | "test" |
image | صورة Docker لـ Gitleaks | "registry.gitlab.com/niclas-zone/ctr/gitleaks:8.28.0" |
GITLEAKS_EXTRA_ARGS | وسائط إضافية لـ Gitleaks | "--verbose --redact --report-format json" |
GITLEAKS_CONFIG | مسار ملف تكوين Gitleaks المحلي | "" |
GITLEAKS_REMOTE_CONFIG | رابط تنزيل ملف تكوين Gitleaks | "" |