Recon-Scan

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

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

नोट: डेमो लाइव नहीं है क्योंकि मेरे AI टोकन खत्म हो गए। आप अभी भी स्वयं होस्ट कर सकते हैं।

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

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

विशेषताएँ

• 13 पैसिव मॉड्यूल:
  • सिक्योरिटी हेडर्स
  • SSL/TLS
  • DNS + ईमेल ऑथ (SPF/DMARC/MX)
  • WHOIS
  • Robots/sitemap
  • सबडोमेन एन्यूमरेशन
  • टेक फिंगरप्रिंटिंग
  • WAF डिटेक्शन
  • CORS जाँच
  • कुकी सिक्योरिटी जाँच
  • JS एक्सपोज़र जाँच
  • डायरेक्टरी एक्सपोज़र जाँच
  • रेपुटेशन जाँच
• Redis + ARQ वर्कर के साथ async निष्पादन।
• क्यू एनक्यू विफल होने पर इन-प्रोसेस बैकग्राउंड निष्पादन पर फ़ॉलबैक।
• 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 से रोकें।

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

./start-docker.sh

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

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

Docker स्टार्ट (मैनुअल)

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

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

1. निर्भरताएँ इंस्टॉल करें:

pip install -r requirements.txt

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

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
  • body उदाहरण:
    • { "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 (डिफ़ॉल्ट: false)
• OPENROUTER_API_KEY, ANTHROPIC_API_KEY, OPENAI_API_KEY (वैकल्पिक)
• VIRUSTOTAL_API_KEY, GOOGLE_SAFE_BROWSING_API_KEY (वैकल्पिक)

योगदान

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

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

Contributing Guide

नोट्स

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

लाइसेंस

MIT। देखें LICENSE।