API स्कैनर - स्व-होस्टेड डिप्लॉयमेंट

API स्कैनर एक स्वचालित API सुरक्षा परीक्षण उपकरण है जो OpenAPI/Swagger विनिर्देशों और WSDL फ़ाइलों का उपयोग करके REST और SOAP APIs में कमजोरियों को स्कैन करता है।

पूर्वापेक्षाएँ

• Docker Engine 20.10+
• Docker Compose v2
• Python 3.6+ (सेटअप स्क्रिप्ट के लिए)
• न्यूनतम 8 GB RAM (16 GB अनुशंसित)
• 20 GB डिस्क स्थान

त्वरित आरंभ

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 GB खाली RAM है। ZAP को ~3 GB की आवश्यकता है।

पैनल सुलभ नहीं: सत्यापित करें कि TLS प्रमाणपत्र ./certs/ में हैं और TRUSTED_ORIGINS आपके URL से मेल खाता है जिसमें पोर्ट शामिल है (जैसे, https://localhost:4455)।

डेटाबेस कनेक्शन त्रुटियाँ: डेटाबेस को प्रारंभ होने के लिए पहले स्टार्ट के बाद 30-60 सेकंड प्रतीक्षा करें।

दस्तावेज़ीकरण

पूर्ण उपयोगकर्ता मैनुअल: https://cspf-founder.github.io/api-scanner-docker/