Recon-Scan

ReconScanは、FastAPIバックエンド、非同期ワーカーパイプライン、シングルページフロントエンドを備えたオープンソースのパッシブリコンスキャナです。デプロイ済みサイトはhttps://recon-scan.vercel.app/で確認できます。

ポイントは高速なシグナルです。スキャンを実行すると、モジュールごとの検出結果が得られ、洗練されたPDFレポートとしてエクスポートできるAIサマリーも取得できます。

このプロジェクトの内容（そして内容でないもの）

• これはパッシブリコンです。エンドポイントのブルートフォース、ファジング、アクティブなエクスプロイトロジックの実行は行いません。
• セキュリティ態勢のスナップショット、トリアージ、レポート作成に適しています。
• 完全なペネトレーションテストの代わりになるものではありません。

特徴

• 13のパッシブモジュール:
  • セキュリティヘッダー
  • SSL/TLS
  • DNS + メール認証（SPF/DMARC/MX）
  • WHOIS
  • Robots/sitemap
  • サブドメイン列挙
  • テクノロジーフィンガープリンティング
  • WAF検出
  • CORSチェック
  • Cookieセキュリティチェック
  • JS露出チェック
  • ディレクトリ露出チェック
  • レピュテーションチェック
• Redis + ARQワーカーによる非同期実行。
• キューへの投入に失敗した場合、プロセス内バックグラウンド実行にフォールバック。
• OpenRouter / Anthropic / OpenAIによるオプションのAIサマリー。
• スキャン + AIサマリーからのPDFレポート生成。
• フロントエンドはFastAPIが直接配信（1つのURL、1つのアプリ）。

ワンコマンド起動（ローカル開発）

手早く起動したい場合は次のとおりです:

./start.sh

これが行うこと:

• .env.example がなければ .env を作成。
• 必要に応じて .venv を作成。
• requirements.txt から依存関係をインストール。
• ホットリロード付きでFastAPIを http://localhost:8000 で起動。
• ローカルでRedisなしでも起動しやすいよう 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. 環境ファイルを作成:

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。 LICENSE を参照。