Recon-Scan

ReconScan एक ओपन-सोर्स पैसिव रीकॉन स्कैनर है जिसमें FastAPI बैकएंड, एसिंक वर्कर पाइपलाइन और एक सिंगल-पेज फ्रंटएंड है। आप तैनात साइट को https://recon-scan.vercel.app/ पर देख सकते हैं।

इसका उद्देश्य तेज़ सिग्नल है: एक स्कैन चलाएं, मॉड्यूल-दर-मॉड्यूल निष्कर्ष प्राप्त करें, और एक AI सारांश प्राप्त करें जिसे अब एक पॉलिश की गई PDF रिपोर्ट के रूप में निर्यात किया जा सकता है।

यह प्रोजेक्ट क्या है (और क्या नहीं है)

• यह पैसिव रीकॉन है। यह एंडपॉइंट्स को ब्रूट फोर्स नहीं करता, फज़ नहीं करता, या सक्रिय एक्सप्लॉइट लॉजिक नहीं चलाता।
• यह पोस्चर स्नैपशॉट, ट्राइएज और रिपोर्टिंग के लिए अच्छा है।
• यह पूर्ण पेनिट्रेशन टेस्टिंग का विकल्प नहीं है।

विशेषताएं

• 13 पैसिव मॉड्यूल:
  • सुरक्षा हेडर
  • SSL/TLS
  • DNS + ईमेल प्रमाणीकरण (SPF/DMARC/MX)
  • WHOIS
  • रोबोट/साइटमैप
  • उपडोमेन गणना
  • टेक फिंगरप्रिंटिंग
  • WAF पहचान
  • CORS जाँच
  • कुकी सुरक्षा जाँच
  • JS एक्सपोज़र जाँच
  • डायरेक्टरी एक्सपोज़र जाँच
  • प्रतिष्ठा जाँच
• Redis + ARQ वर्कर के साथ एसिंक निष्पादन।
• यदि क्यू एनक्यू विफल होता है तो इन-प्रोसेस बैकग्राउंड निष्पादन पर फॉलबैक।
• OpenRouter / Anthropic / OpenAI के माध्यम से वैकल्पिक AI सारांश।
• स्कैन + AI सारांश से PDF रिपोर्ट जनरेशन।
• फ्रंटएंड सीधे FastAPI द्वारा परोसा जाता है (एक URL, एक ऐप)।

एक-कमांड स्टार्ट (लोकल डेव)

यदि आप इसे जल्दी से चलाना चाहते हैं:

./start.sh

यह क्या करता है:

• यदि गायब है तो .env.example से .env बनाता है।
• यदि आवश्यक हो तो .venv बनाता है।
• requirements.txt से निर्भरताएँ स्थापित करता है।
• http://localhost:8000 पर हॉट रीलोड के साथ FastAPI शुरू करता है।
• आसान नो-रेडिस लोकल स्टार्टअप के लिए USE_ARQ_QUEUE=false लागू करता है।

Ctrl+C से रोकें।

एक-कमांड स्टार्ट (डॉकर)

./start-docker.sh

यह क्या करता है:

• यदि गायब है तो .env.example से .env बनाता है।
• Docker Compose के साथ API + वर्कर + Redis शुरू करता है।

डॉकर स्टार्ट (मैन्युअल)

cp .env.example .env
docker compose up --build

लोकल डेवलपमेंट (डॉकर के बिना)

1. निर्भरताएँ स्थापित करें:

pip install -r requirements.txt

2. एनवी फ़ाइल बनाएँ:

cp .env.example .env

3. API शुरू करें:

uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload

4. दूसरे टर्मिनल में वर्कर शुरू करें (अनुशंसित):

arq app.worker.WorkerSettings

5. खोलें:

http://localhost:8000

टेस्ट चलाना

टेस्ट निर्भरताएँ स्थापित करें:

pip install -r requirements-dev.txt

पूरा सूट चलाएँ:

pytest -q

PDF रिपोर्ट

स्कैन पूरा होने के बाद, UI में Download PDF पर क्लिक करें।

बैकएंड एंडपॉइंट:

• GET /scans/{scan_id}/report.pdf

रिपोर्ट में शामिल है:

• लक्ष्य और स्कैन मेटाडेटा
• AI कार्यकारी सारांश (उपलब्ध होने पर छोटा + पूर्ण कथा)
• गंभीरता स्नैपशॉट तालिका
• विस्तृत मॉड्यूल-दर-मॉड्यूल निष्कर्ष

API

• GET /health
• POST /scans
  • बॉडी उदाहरण:
    • { "target": "example.com" }
    • { "target": "example.com", "byoapi_key": "...", "byoapi_provider": "your_provider" }
  • नोट:
    • byoapi_key अस्वीकार किया जाता है जब तक ALLOW_BYO_API_KEY=true न हो
    • निजी / लूपबैक / आरक्षित लक्ष्य अवरुद्ध हैं
    • user_id वैकल्पिक है और अनुकूलता के लिए रखा गया है
• GET /scans/{scan_id}
• GET /scans/{scan_id}/report.pdf

कॉन्फ़िगरेशन

.env.example से:

• DATABASE_URL (डिफ़ॉल्ट: sqlite:///./reconscan.db)
• REDIS_URL (डिफ़ॉल्ट: redis://localhost:6379)
• USE_ARQ_QUEUE (डिफ़ॉल्ट: true)
• RATE_LIMIT_PER_MINUTE (डिफ़ॉल्ट: 10)
• RATE_LIMIT_PER_DAY (डिफ़ॉल्ट: 200)
• ALLOWED_HOSTS (डिफ़ॉल्ट: localhost,127.0.0.1)
• CORS_ALLOWED_ORIGINS (डिफ़ॉल्ट: स्थानीय विकास उत्पत्ति)
• ALLOW_BYO_API_KEY (डिफ़ॉल्ट: )

योगदान

योगदान का स्वागत है, विशेष रूप से पैसिव रीकॉन मॉड्यूल, रिपोर्टिंग, फ्रंटएंड UX और टेस्ट कवरेज के आसपास।

कृपया पुल अनुरोध खोलने से पहले पूर्ण योगदान दिशानिर्देश पढ़ें:

योगदान दिशानिर्देश

नोट

• यदि कोई बाहरी AI कुंजी कॉन्फ़िगर नहीं की गई है, तो ReconScan एक स्थानीय फॉलबैक सारांश संग्रहीत करता है।
• आसान स्थानीय उपयोग के लिए SQLite डिफ़ॉल्ट स्टोरेज इंजन है।
• यह रेपो जानबूझकर हल्का और सेल्फ-होस्ट अनुकूल है।

लाइसेंस

MIT. देखें लाइसेंस।