SecretScrub

سيتولى SecretScrub تنظيف جميع أسرارك الثابتة المكتوبة في الكود. يعالج هذا البرنامج النصي الملفات بصيغة SARIF التي تولّدها أدوات تحليل ثابتة مختلفة. تمسح الأداة دليلًا داخل نظام الملفات، وتنقّي جميع حالات الأسرار المكتشفة داخل ملفات SARIF في نسخة جديدة من الدليل. ولأن الأسرار غالبًا ما تكون موجودة في سجلات Git، فإن دليل .git يُستبعد من النسخة الناتجة.

على الرغم من أن SARIF صيغة معيارية في الصناعة، إلا أن هناك اختلافات في مخرجات SARIF التي تنتجها الأدوات المختلفة. ونتيجة لذلك، فإن الأدوات الوحيدة المدعومة حاليًا هي كما يلي.

بسبب الاختلافات في مخرجات SARIF، من الممكن أن مخرجات الإصدارات المستقبلية من الأداة لن تعمل بشكل صحيح.

Dependencies

التبعيات مذكورة في ملف requirements.txt. باختصار، الحزم التالية مطلوبة:

Usage

Command Line Usage

استخدام مخرجات الأداة المولّدة مسبقًا

$ python secretscrub.py --input <path> --srcdir <path> --outdir <path> [--report <path>]

استدعاء الأدوات

$ python secretscrub.py --analyse-with <analysis-tool-list> --srcdir <path> --outdir <path> [--report <path>]

ملاحظة: لكي تعمل الأداة، يجب أن تكون الأدوات موجودة ومثبتة على النظام الحالي:

حاوية Docker

صورة Docker المبنية من شجرة المصدر هذه تتضمن أداة SecretScrub ونسخًا من أدوات Trivy وGitLeaks وccs وcq.

إذا تم بناؤها بوسم secretscrub:latest، فإن الأمر التالي سيبدأ تشغيل عملية تحليل وتنقية كاملة مع تقرير مصاحب.

sudo docker run -it -v <source-path>:/src:ro -v <output-path>:/out secretscrub:latest --analyse-with trivy,gitleaks,bindetect

لاحظ أن هذا يتضمن ربط مجلدين داخل الحاوية. الأول -- <source-path> -- يجب أن يحتوي على الكود المصدري الأصلي غير المنقّى. الثاني -- <output-path> -- سيتلقى المخرجات والتقرير المنقّيين.

سير العمل المقترح

تفترض الأمثلة التالية أن المصدر مخزَّن داخل دليل فرعي باسم src، وأن SecretScrub مثبّت داخل دليل فرعي باسم tools.

استخدام سطر الأوامر

$ python tools/secretscrub.py --analse-with trivy,gitleaks,bindetect --srcdir src --outdir src-redacted

استخدام حاوية Docker

sudo docker run -it -v <source-path>:/src:ro -v <output-path>:/out secretscrub:latest --analyse-with trivy,gitleaks,bindetect