ماسح واجهات برمجة التطبيقات - نشر ذاتي الاستضافة

ماسح واجهات برمجة التطبيقات هو أداة اختبار أمان آلية لواجهات برمجة التطبيقات تقوم بمسح واجهات REST و SOAP بحثًا عن الثغرات باستخدام مواصفات OpenAPI/Swagger وملفات WSDL.

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

• محرك Docker 20.10+
• Docker Compose v2
• Python 3.6+ (لنص الإعداد)
• 8 جيجابايت رام كحد أدنى (16 جيجابايت موصى به)
• 20 جيجابايت مساحة تخزين

بدء سريع

1. استنساخ هذا المستودع

git clone https://github.com/CSPF-Founder/api-scanner-docker.git
cd api-scanner-docker

2. تشغيل الإعداد

python3 setup.py

سينفذ البرنامج النصي ما يلي:

• توليد كلمات مرور عشوائية آمنة لجميع الخدمات
• الكشف التلقائي عن منطقتك الزمنية
• توليد شهادة TLS موقعة ذاتيًا (أو استخدام شهادتك الخاصة إذا كانت موجودة بالفعل في ./certs/)
• كتابة ملف التكوين .env
• عرض بدء تشغيل مجموعة Docker Compose

3. الوصول إلى اللوحة

افتح https://localhost:4455 في متصفحك.

إذا كنت تستخدم شهادة موقعة ذاتيًا، فسيظهر تحذير أمني في متصفحك - تابع لقبولها.

إعداد يدوي

إذا كنت تفضل التهيئة يدويًا بدلاً من استخدام نص الإعداد:

1. انسخ ملف البيئة النموذجي:

cp .env.example .env

2. قم بتحرير .env وتحديث:

   • جميع كلمات المرور change_me_* بقيم عشوائية قوية
   • CSRF_KEY بسلسلة عشوائية مكونة من 32 حرفًا أو أكثر
   • ZAP_API_KEY بسلسلة عشوائية
   • TRUSTED_ORIGINS مع نطاقك (مثل: https://scanner.yourcompany.com)
   • تأكد من تطابق كلمات المرور في DATABASE_URI و MONGO_DATABASE_URI مع متغيرات كلمة المرور الفردية

3. ابدأ تشغيل المجموعة:

docker compose up -d

البنية

التهيئة

جميع التهيئة تتم من خلال ملف .env. راجع .env.example لجميع الخيارات المتاحة.

الإعدادات الرئيسية

استمرارية البيانات

جميع البيانات مخزنة في وحدات تخزين مسماة Docker:

• mariadb_data - حسابات المستخدمين والأدوار والجلسات
• mongodb_data - سجلات المسح والنتائج والتقارير
• scanner_data - ملفات العمل والمواصفات المرفوعة والتقارير المنشأة

التحديث

docker compose pull
docker compose up -d

الإيقاف

docker compose down

لإزالة جميع البيانات (تدميري):

docker compose down -v

استكشاف الأخطاء وإصلاحها

التحقق من السجلات:

docker compose logs api-scanner
docker compose logs zap

التحقق من صحة الخدمة:

docker compose ps

ZAP لا يبدأ: تأكد من توفر 4 جيجابايت على الأقل من ذاكرة الوصول العشوائي الحرة. يحتاج ZAP إلى حوالي 3 جيجابايت.

اللوحة غير قابلة للوصول: تحقق من وجود شهادات TLS في ./certs/ وأن TRUSTED_ORIGINS يتطابق مع عنوان URL الخاص بك بما في ذلك المنفذ (مثل: https://localhost:4455).

أخطاء اتصال قاعدة البيانات: انتظر من 30 إلى 60 ثانية بعد البدء الأول لقواعد البيانات للتهيئة.

التوثيق

دليل المستخدم الكامل: https://cspf-founder.github.io/api-scanner-docker/