Skip to main content

14-phase automated reconnaissance framework for security researchers

Project description

ReconNinja

14-phase automated reconnaissance framework for authorized security testing.

Version Python Tests License Author Docs

⚠ Use only against targets you own or have explicit written permission to test.

📄 Documentation available at doc.emonpersonal.xyz


What it does

ReconNinja automates every phase of a reconnaissance engagement into a single command. Point it at a domain or IP and it drives the full pipeline — passive OSINT, port scanning, web discovery, vulnerability scanning, credential intelligence, and AI-powered threat analysis — then generates HTML, JSON, and Markdown reports.


Install

# From GitHub (always latest)
pip install git+https://github.com/ExploitCraft/ReconNinja.git

# From PIP
pip install ReconNinja

# From install file (RECOMMENDED)
git clone https://github.com/ExploitCraft/ReconNinja.git
cd ReconNinja && chmod +x install.sh && ./install.sh

Quick start

# Interactive mode — guided setup
reconninja

# Standard scan
reconninja -t example.com

# Full 14-phase pipeline
reconninja -t example.com --profile full_suite -y

# v5: WHOIS + Wayback + SSL — no keys needed
reconninja -t example.com --whois --wayback --ssl -y

# v5: Full intelligence
reconninja -t example.com --profile full_suite \
  --whois --wayback --ssl \
  --shodan --shodan-key YOUR_KEY \
  --vt --vt-key YOUR_KEY \
  --ai --ai-provider groq --ai-key YOUR_KEY \
  -y

Scan profiles

Profile What runs
fast Top 100 ports, no scripts
standard Top 1000 ports, scripts + versions (default)
thorough All ports, OS detection, aggressive scripts
stealth SYN scan, low timing, no banners
web_only httpx + dir scan + nuclei
port_only RustScan + Masscan + Nmap
full_suite All 14 phases
custom Interactive builder

Pipeline

Phase 1   Passive Recon      subdomain enum (amass, subfinder, crt.sh)
Phase 2   RustScan           ultra-fast port discovery (all 65535 ports)
Phase 2b  Async TCP          asyncio fallback, no root required
Phase 3   Masscan            optional SYN sweep (root required)
Phase 4   Nmap               deep service / version / script analysis
Phase 4b  CVE Lookup         NVD API CVE matching on detected services
Phase 5   httpx              live web detection + tech fingerprint
Phase 6   Dir Scan           feroxbuster → ffuf → dirsearch fallback chain
Phase 7   WhatWeb            technology fingerprinting
Phase 8   Nikto              classic web vulnerability scanner
Phase 9   Nuclei             template-based vulnerability detection
Phase 10  Screenshots        aquatone → gowitness fallback
Phase 12  v5 Integrations    WHOIS · Wayback · SSL · VirusTotal · Shodan
Phase 14  AI Analysis        Groq / Ollama / Gemini / OpenAI threat summary

What's new in v5.2.1

Bugfix release — 9 bugs fixed, 597/597 tests passing.

# Fix
1 --exclude flag now actually skips phases
2 VirusTotal correctly uses IP endpoint for IP targets
3 Screenshots work even with no subdomains (uses live web targets)
4 Version string updated to 5.2.1 everywhere
5 Dead imports removed from orchestrator
6 subprocess.run timeout added to updater (prevents hung processes)
7–9 Test fixes, Async TCP exclude guard, resume version string

What's new in v5.0.0

5 new intelligence modules — 3 need zero API keys:

Module Flag API Key
WHOIS lookup --whois None
Wayback Machine URL discovery --wayback None
SSL/TLS certificate analysis --ssl None
VirusTotal reputation --vt --vt-key KEY Free tier
Shodan host intelligence --shodan --shodan-key KEY Free tier

Output control (new flags):

--output-format html      # html | json | md | txt | all
--exclude passive,vuln    # skip specific phases
--timeout 60              # global per-operation timeout
--rate-limit 1.0          # seconds between requests

All flags

Target
  -t, --target          Domain, IP, CIDR, or path to list file
  -p, --profile         Scan profile (see above)
  -y, --yes             Skip confirmation prompt (CI/automation)

Port scanning
  --all-ports           Scan all 65535 ports
  --top-ports N         Scan top N ports (default: 1000)
  --timing T1-T5        Nmap timing template (default: T4)
  --rustscan            Enable RustScan pre-scan
  --masscan             Enable Masscan sweep (root required)
  --masscan-rate N      Masscan packets/sec (default: 5000)
  --async-concurrency   Async TCP concurrency (default: 1000)
  --async-timeout       Async TCP timeout seconds (default: 1.5)

Web & discovery
  --httpx               httpx live service detection
  --whatweb             WhatWeb fingerprinting
  --ferox               Feroxbuster directory scan
  --nikto               Nikto scanner
  --nuclei              Nuclei vulnerability templates
  --aquatone            Screenshots
  --subdomains          Subdomain enumeration
  --wordlist-size       small | medium | large

Vulnerability intelligence
  --cve                 NVD CVE lookup for detected services
  --nvd-key KEY         NVD API key (raises rate limit 5→50 req/30s)

v5 integrations
  --shodan              Shodan host intelligence
  --shodan-key KEY      Shodan API key
  --vt                  VirusTotal reputation
  --vt-key KEY          VirusTotal API key
  --whois               WHOIS lookup (no key needed)
  --wayback             Wayback Machine URL discovery (no key needed)
  --ssl                 SSL/TLS certificate analysis (no key needed)

AI analysis
  --ai                  Enable AI threat analysis
  --ai-provider         groq | ollama | gemini | openai (default: groq)
  --ai-key KEY          API key for AI provider
  --ai-model MODEL      Override default model

Output
  --output DIR          Output directory (default: reports/)
  --output-format FMT   all | html | json | md | txt (default: all)
  --exclude PHASES      Comma-separated phases to skip
  --timeout N           Global per-operation timeout seconds (default: 30)
  --rate-limit N        Seconds between requests (default: 0)

Scan management
  --resume FILE         Resume interrupted scan from state.json
  --update              Check GitHub for updates
  --force-update        Update even if already on latest
  --check-tools         Show tool availability

Output

Each scan creates a timestamped folder:

reports/
└── example.com_20260307_120000/
    ├── report.html         ← dark-mode dashboard
    ├── report.json         ← full machine-readable results (includes v5 intelligence data)
    ├── report.md           ← markdown summary
    ├── scan_config.json    ← exact config used
    ├── scan.log            ← full execution log
    ├── state.json          ← resume checkpoint
    ├── subdomains/
    ├── nmap/
    └── nuclei/

Resume interrupted scans

# Scan crashes after Phase 8 — resume from last checkpoint
reconninja --resume reports/example.com_20260307_120000/state.json

All v5 results (WHOIS, Wayback, SSL, VT, Shodan) are preserved in state.json and restored on resume.


Plugin system

Drop a .py file into plugins/ to extend the pipeline. It receives the full ReconResult and ScanConfig after all phases complete.

# plugins/custom.py
def run(target, out_folder, result, cfg):
    print(f"Custom: {len(result.hosts)} hosts, {len(result.shodan_results)} Shodan entries")

Tool dependencies

Only rich is required. All external tools are optional — ReconNinja detects what's available and falls back gracefully.

reconninja --check-tools    # show availability

Optional tools: nmap, rustscan, masscan, amass, subfinder, httpx, feroxbuster, ffuf, dirsearch, whatweb, nikto, nuclei, aquatone, gowitness


Development

git clone https://github.com/ExploitCraft/ReconNinja.git
cd ReconNinja
chmod +x install.sh
./install.sh
python3 -m unittest discover -s tests -v    # run all tests
python3 -m unittest tests.test_v4_modules -v
python3 -m unittest tests.test_orchestrator -v

License

MIT — see LICENSE


ExploitCraft · Bangladesh · Building tools that matter

📄 Full documentation at doc.emonpersonal.xyz

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reconninja-5.2.1.tar.gz (85.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reconninja-5.2.1-py3-none-any.whl (70.0 kB view details)

Uploaded Python 3

File details

Details for the file reconninja-5.2.1.tar.gz.

File metadata

  • Download URL: reconninja-5.2.1.tar.gz
  • Upload date:
  • Size: 85.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for reconninja-5.2.1.tar.gz
Algorithm Hash digest
SHA256 63b370e0d9d707801a911441149d9084d0a63c118d1f17948aec7d49d0e88a80
MD5 e8c9d169873f9c8993cddfe9ee4c6fe7
BLAKE2b-256 05d5a081fe941bc5ba5171a00ac9dce3e26c5a65a33531dc50d95fdbae7f009b

See more details on using hashes here.

Provenance

The following attestation bundles were made for reconninja-5.2.1.tar.gz:

Publisher: release.yml on ExploitCraft/ReconNinja

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file reconninja-5.2.1-py3-none-any.whl.

File metadata

  • Download URL: reconninja-5.2.1-py3-none-any.whl
  • Upload date:
  • Size: 70.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for reconninja-5.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 437bef077f48ea02edb31fe3af83bfdc615f433274c97ffee82043eff369948f
MD5 371685ea211f665c0230ca2839b226a2
BLAKE2b-256 6152dbae2229ccffae0ec019ceaadec258b3aa285e1fe618c333448d6dc92a2e

See more details on using hashes here.

Provenance

The following attestation bundles were made for reconninja-5.2.1-py3-none-any.whl:

Publisher: release.yml on ExploitCraft/ReconNinja

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page