Recon-Scan

ReconScan — это пассивный сканер с открытым исходным кодом: бэкенд на FastAPI, асинхронный конвейер задач и одностраничный фронтенд. Вы можете посмотреть развёрнутый сайт по адресу https://recon-scan.vercel.app/

Смысл в быстром результате: запустите сканирование, получите результаты по каждому модулю и резюме на основе ИИ, которое теперь можно экспортировать в аккуратный PDF-отчёт.

Что это за проект (и чем он не является)

• Это пассивная разведка. Он не подбирает конечные точки перебором, не фаззит и не запускает активную эксплуатацию уязвимостей.
• Он подходит для снимков состояния безопасности, триажа и отчётности.
• Он не заменяет полноценное пентестирование.

Возможности

• 13 пассивных модулей:
  • Заголовки безопасности
  • SSL/TLS
  • DNS + аутентификация email (SPF/DMARC/MX)
  • WHOIS
  • Robots/sitemap
  • Перечисление поддоменов
  • Определение технологий
  • Обнаружение WAF
  • Проверки CORS
  • Проверки безопасности cookie
  • Проверки раскрытия JS
  • Проверки раскрытия директорий
  • Проверки репутации
• Асинхронное выполнение с Redis + ARQ worker.
• Откат к фоновому выполнению внутри процесса, если постановка в очередь не удалась.
• Опциональное резюме на основе ИИ через OpenRouter / Anthropic / OpenAI.
• Генерация PDF-отчёта из сканирования + резюме ИИ.
• Фронтенд обслуживается напрямую через FastAPI (один URL, одно приложение).

Запуск одной командой (локальная разработка)

Если нужно просто быстро запустить:

./start.sh

Что это делает:

• Создаёт .env из .env.example, если он отсутствует.
• Создаёт .venv при необходимости.
• Устанавливает зависимости из requirements.txt.
• Запускает FastAPI с автоматической перезагрузкой на http://localhost:8000.
• Принудительно задаёт USE_ARQ_QUEUE=false для более простого локального запуска без Redis.

Остановка с помощью Ctrl+C.

Запуск одной командой (Docker)

./start-docker.sh

Что это делает:

• Создаёт .env из .env.example, если он отсутствует.
• Запускает API + worker + Redis с помощью Docker Compose.

Запуск Docker (вручную)

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

Локальная разработка (без Docker)

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. Запустите worker в другом терминале (рекомендуется):

arq app.worker.WorkerSettings

5. Откройте:

http://localhost:8000

Запуск тестов

Установите тестовые зависимости:

pip install -r requirements-dev.txt

Запустите полный набор тестов:

pytest -q

PDF-отчёты

После завершения сканирования нажмите Download PDF в интерфейсе.

Эндпоинт бэкенда:

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

Отчёт включает:

• Цель и метаданные сканирования
• Краткое резюме ИИ (короткая + полная версия, когда доступно)
• Таблица сводки по уровням критичности
• Детальные результаты по каждому модулю

API

• GET /health
• POST /scans
  • пример тела запроса:
    • { "target": "example.com" }
    • { "target": "example.com", "byoapi_key": "...", "byoapi_provider": "your_provider" }
  • примечания:
    • byoapi_key отклоняется, если ALLOW_BYO_API_KEY=true не задан
    • приватные / loopback / зарезервированные цели блокируются
    • 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 (по умолчанию: origins локальной разработки)
• ALLOW_BYO_API_KEY (по умолчанию: )

Внесение вклада

Вклад приветствуется, особенно в области пассивных модулей recon, отчётности, UX фронтенда и покрытия тестами.

Пожалуйста, прочитайте полные правила внесения вклада перед открытием pull request:

Contributing Guide

Примечания

• Если внешний ключ ИИ не настроен, ReconScan сохраняет локальное резюме-запасной вариант.
• SQLite — движок хранения по умолчанию для простого локального использования.
• Этот репозиторий намеренно лёгкий и удобен для самостоятельного размещения.

Лицензия

MIT. См. LICENSE.