إشعار الإهمال

أعزاء مستخدمي Leaktopus،

نود إعلامكم بأن مشروع Leaktopus سيُهمَل رسميًا. بعد تقييم دقيق، قررنا إيقاف التطوير النشط والصيانة لهذه المكتبة.

ماذا يعني هذا لك؟

• لا ميزات أو تحديثات جديدة: لن نضيف أي ميزات أو تحديثات جديدة إلى Leaktopus.
• التصحيحات الأمنية: لن نقدم بعد الآن تصحيحات أمنية أو إصلاحات لأي ثغرات.
• حالة المستودع: سيتم أرشفة المستودع، وسيصبح المشروع للقراءة فقط على GitHub، اعتبارًا من اليوم.

---

الميزات الرئيسية

• Plug&Play - تثبيت بسطر واحد باستخدام Docker.

• مسح مصادر متنوعة تحتوي على مجموعة من الكلمات المفتاحية، مثل ORGANIZATION-NAME.com.

  يدعم حاليًا:

  • GitHub
    • المستودعات
    • Gists (قريبًا)
  • مواقع Paste (مثل PasteBin) (قريبًا)

• تصفية النتائج باستخدام محرك استدلالي مدمج.

• تحسين النتائج باستخدام IOLs (مؤشرات التسريب):

  • الأسرار في المصادر المكتشفة (بما في ذلك تاريخ ارتكابات مستودعات Git):
    • باستخدام Shhgit (باستخدام قائمة قواعد مخصصة).
    • باستخدام TruffleHog.
  • URIs (بما في ذلك الإشارة إلى نطاقات مؤسستك)
  • عناوين البريد الإلكتروني (بما في ذلك الإشارة إلى عناوين البريد الإلكتروني لمؤسستك)
  • المساهمون
  • كلمات مفتاحية حساسة (مثل: canary token، النطاقات الداخلية)

• يسمح بتجاهل المصادر العامة، (مثل: المستودعات "غير المرغوب فيها" من برامج زحف الويب).

• قائمة تجاهل جاهزة للاستخدام للمصادر "غير المرغوب فيها" الشائعة.

• الإقرار بالتسريب، وإشعارك فقط إذا تم تعديل المصدر منذ المسح السابق.

• ELK مدمج للبحث عن البيانات في التسريبات (بما في ذلك فهرس كامل لمستودعات Git مع IOLs).

• الإشعار بالتسريبات الجديدة

  • Webhook لـ MS Teams.
  • بوت Slack.
  • تكامل مع Cortex XSOAR® (من Palo Alto Networks) (قيد التطوير).

تقنية المكدس

• معزز بالكامل باستخدام Docker.
• خلفية API-first بلغة Python Flask.
• واجهة أمامية مفصولة باستخدام Vue.js (3.x).
• قاعدة بيانات SQLite.
• مهام غير متزامنة باستخدام Celery + طوابير Redis.

المتطلبات الأساسية

• Docker-Compose

التثبيت

• استنساخ المستودع
• إنشاء ملف .env محلي
  root@kitploit:~

  cd Leaktopus
  cp .env.example .env
  

• تعديل ملف .env وفقًا لإعداداتك المحلية (راجع التعليقات الداخلية).
• تشغيل Leaktopus
  root@kitploit:~

  docker-compose up -d
  

• بدء تسلسل التثبيت عن طريق الوصول إلى API التثبيت. فقط افتح http://{LEAKTOPUS_HOST}:8000/api/install في متصفحك.
• تحقق من أن API يعمل عن طريق http://{LEAKTOPUS_HOST}:8000/up
• يجب أن تكون الواجهة متاحة على http://{LEAKTOPUS_HOST}:8080

استخدام تطبيق GitHub

بالإضافة إلى خيار رمز الوصول الشخصي الأساسي، يدعم Leaktopus مصادقة تطبيق GitHub. يوصى باستخدام مصادقة تطبيق GitHub بسبب حدود المعدل الأعلى.

1. لاستخدام مصادقة تطبيق GitHub، يجب إنشاء تطبيق GitHub وتثبيته على مؤسستك/حسابك. راجع وثائق GitHub لمزيد من التفاصيل.

2. بعد إنشاء التطبيق، تحتاج إلى تعيين متغيرات البيئة التالية:

   • GITHUB_USE_APP=True
   • GITHUB_APP_ID
   • GITHUB_INSTALLATION_ID - يمكن العثور على معرف التثبيت في تثبيت تطبيقك.
   • GITHUB_APP_PRIVATE_KEY_PATH (الإعداد الافتراضي هو /app/private-key.pem)

3. قم بتحميل ملف المفتاح الخاص إلى الحاوية (انظر docker-compose.yml للحصول على مثال). ./leaktopus_backend/private-key.pem:/app/private-key.pem

* لاحظ أنه سيتم تجاهل GITHUB_ACCESS_TOKEN إذا تم تعيين GITHUB_USE_APP على True.

تحديث Leaktopus

إذا كنت ترغب في تحديث إصدار Leaktopus الخاص بك (سحب إصدار أحدث)، فقط اتبع الخطوات التالية.

• سحب أحدث إصدار.
  root@kitploit:~

  git pull
  

• إعادة بناء صور Docker (لن يتم حذف البيانات).
  root@kitploit:~

  # إجبار إعادة إنشاء الصورة
  docker-compose up --force-recreate --build
  

• تشغيل تحديث قاعدة البيانات عن طريق استدعاء API الخاص بها (قد يكون مطلوبًا بعد بعض التحديثات). http://{LEAKTOPUS_HOST}/api/updatedb

محرك تصفية النتائج الاستدلالي

يقوم المحرك الاستدلالي المدمج بتصفية نتائج البحث لتقليل الإيجابيات الخاطئة عن طريق:

• المحتوى:
  • أكثر من X من عناوين البريد الإلكتروني التي تحتوي على نطاقات غير تابعة للمؤسسة.
  • أكثر من X من URIs التي تحتوي على نطاقات غير تابعة للمؤسسة.
• البيانات الوصفية:
  • أكثر من X نجمة.
  • أكثر من X شوكة (fork).
• قائمة تجاهل المصادر.

توثيق API

وثائق OpenAPI متاحة على http://{LEAKTOPUS_HOST}:8000/apidocs.

خدمات Leaktopus

يمكن تخصيص ما سبق باستخدام ملف docker-compose.yml مخصص.

ملاحظات أمنية

حاليًا، لا يوفر Leaktopus أي آلية مصادقة. تأكد من عدم تعريضه للعالم، وبذل قصارى جهدك لتقييد الوصول إلى مثيلات Leaktopus الخاصة بك.

المساهمة

المساهمات مرحب بها جدًا.

يرجى اتباع إرشادات المساهمة والتوثيق.