1. Project Overview & Quickstart (six2dez/reconftw) Copy Chapter

File: README.md Copy Chapter

reconFTW

reconFTW is a powerful automated reconnaissance tool designed for security researchers and penetration testers. It streamlines the process of gathering intelligence on a target by performing subdomain enumeration, vulnerability scanning, OSINT and more. With a modular design, extensive configuration options, and support for distributed scanning via AX Framework, reconFTW is built to deliver comprehensive results efficiently.

reconFTW leverages a wide range of techniques, including passive and active subdomain discovery, web vulnerability checks (e.g., XSS, SSRF, SQLi), OSINT, directory fuzzing, port scanning and screenshotting. It integrates with cutting-edge tools and APIs to maximize coverage and accuracy, ensuring you stay ahead in your reconnaissance efforts.

Key Features:

• Comprehensive subdomain enumeration (passive, bruteforce, permutations, certificate transparency, etc.)
• Vulnerability scanning for XSS, SSRF, SQLi, LFI, SSTI, and more
• OSINT for emails, metadata, API leaks, and third-party misconfigurations
• Distributed scanning with AX Framework for faster execution
• Customizable workflows with a detailed configuration file
• Integration with Faraday for reporting and visualization
• Support for Docker, Terraform and Ansible deployments

Disclaimer: Usage of reconFTW for attacking targets without prior consent is illegal. It is the user's responsibility to obey all applicable laws. The developers assume no liability for misuse or damage caused by this tool. Use responsibly.

📔 Table of Contents Copy Chapter

• 📔 Table of Contents
• ✨ Features
  • OSINT
  • Subdomains
  • Hosts
  • Web Analysis
  • Vulnerability Checks
  • Extras
• 🏗️ Architecture
• 💿 Installation
  • Local Installation (PC/VPS/VM)
  • Docker
  • Terraform + Ansible
• ⚙️ Configuration
• 🚀 Usage
  • Target Options
  • Mode Options
  • General Options
  • Example Usage
• ☁️ Ax Framework Support (previously Axiom)
• 💻 Faraday Support
• 🧠 AI Integration
• 🗂️ Data Management
  • Makefile
  • Manual
• 🧪 Testing
• Mindmap/Workflow
• Sample video
• 🤝 How to Contribute
• 🔒 Security
• ❓ Need Help?
• 💖 Support This Project
• 🙏 Thanks
• 📝 Changelog
• 🛠️ Development
• 📜 License
• ⭐ Star History

✨ Features Copy Chapter

reconFTW is packed with features to make reconnaissance thorough and efficient. Below is a detailed breakdown of its capabilities, updated to reflect the latest functionality in the script and configuration.

OSINT Copy Section

• Domain Information: WHOIS lookup for domain registration details (whois).
• Email and Password Leaks: Searches for leaked emails and credentials (emailfinder and LeakSearch).
• Microsoft 365/Azure Mapping: Identifies Microsoft 365 and Azure tenants (msftrecon).
• Metadata Extraction: Extracts metadata from indexed office documents (metagoofil).
• API Leaks: Detects exposed APIs in public sources (porch-pirate, SwaggerSpy and postleaksNg).
• Google Dorking: Automated Google dork queries for sensitive information (dorks_hunter and xnldorker).
• GitHub Analysis: Scans GitHub organizations for repositories and secrets with selectable engines (enumerepo, trufflehog, gitleaks, titus, noseyparker).
• GitHub Actions Audit (Optional): Audits workflow artifacts and CI/CD exposure with gato.
• Third-Party Misconfigurations: Identifies misconfigured third-party services (misconfig-mapper).
• Mail Hygiene: Reviews SPF/DMARC configuration to flag spoofing or deliverability issues.
• Cloud Storage Enumeration: Surveys buckets across major providers for exposure (cloud_enum).
• Spoofable Domains: Checks for domains vulnerable to spoofing (spoofcheck).

Subdomains Copy Section

• Passive Enumeration: Uses APIs and public sources for subdomain discovery (subfinder and github-subdomains).
• Certificate Transparency: Queries certificate transparency logs (crt).
• NOERROR Discovery: Identifies subdomains with DNS NOERROR responses (dnsx, more info here).
• Bruteforce: Performs DNS bruteforcing with customizable wordlists (puredns and custom wordlists).
• Permutations: Generates subdomain permutations using AI, regex and tools (Gotator as the single permutation engine, plus regulator and subwiz).
• Web Scraping: Extracts subdomains from passive URL sources and live web metadata (urlfinder, waymore, httpx, csprecon).
• DNS Records: Resolves DNS records for subdomains (dnsx).
• Google Analytics: Identifies subdomains via Analytics IDs (AnalyticsRelationships).
• TLS Handshake: Discovers subdomains via TLS ports (tlsx).
• Recursive Search: Performs recursive passive or bruteforce enumeration combined (dsieve).
• Subdomain Takeover: Detects vulnerable subdomains (nuclei and dnstake).
• DNS Zone Transfer: Checks for misconfigured DNS zone transfers (dig).
• Cloud Buckets: Identifies misconfigured cloud buckets and exposed storage assets (S3Scanner and cloud_enum).
• Cloud Coverage Note: Cloud bucket checks no longer include Alibaba OSS coverage after replacing CloudHunter with cloud_enum.
• Cloud Output Migration: Legacy cloudhunter_* bucket artifacts were removed; use subdomains/cloud_enum_buckets_trufflehog.txt instead.
• Reverse IP Lookup: Discovers subdomains via IP ranges (hakip2host).

Hosts Copy Section

• IP Information: Retrieves geolocation and WHOIS data (ipinfo).
• CDN Detection: Identifies IPs behind CDNs (cdncheck).
• WAF Detection: Detects Web Application Firewalls (wafw00f).
• Port Scanning: Active scanning with nmap (optionally preceded by naabu) and passive scanning with smap.
• Service Fingerprinting: Fingerprints exposed services on discovered host:port pairs with nerva.
• Service Vulnerabilities (Optional): Deep portscan profile can enrich results with CVE matching via vulners.
• Password Spraying: Attempts password spraying on identified services with engine selection (brutespray or brutus).
• Geolocation: Maps IP addresses to geographic locations (ipinfo).
• IPv6 Discovery: Optionally enumerates and scans discovered IPv6 targets when IPV6_SCAN is enabled.

Web Analysis Copy Section

• Web Probing: Detects live web servers on standard and uncommon ports ((httpx)).
• Screenshots: Captures screenshots of web pages (nuclei).
• Virtual Host Fuzzing: Identifies virtual hosts by fuzzing HTTP headers (VhostFinder).
• CMS Detection: Identifies content management systems (CMSeeK).
• URL Extraction: Collects URLs passively and actively (urlfinder, waymore, katana, github-endpoints and JSA).
• URL Pattern Analysis: Classifies URLs using patterns (urless, gf and gf-patterns).
• Favicon Tech Recon: Identifies technologies from favicon hashes (favirecon).
• JavaScript Analysis: Extracts secrets and endpoints from JS files (subjs, JSA, xnLinkFinder, getjswords, mantra, jsluice).
• Source Map Extraction: Retrieves sensitive data from JavaScript source maps (sourcemapper).
• GraphQL Detection: Discovers GraphQL endpoints with nuclei and optionally performs in-depth introspection (GQLSpection).
• Parameter Discovery: Bruteforces hidden parameters on endpoints (arjun).
• WebSocket Auditing: Validates upgrade handshakes and origin handling on ws:// and wss:// endpoints.
• gRPC Reflection: Probes common gRPC ports for exposed service reflection (grpcurl).
• LLM Service Fingerprinting (Optional): Probes discovered web/API endpoints for exposed LLM services with julius.
• Fuzzing: Performs directory and parameter fuzzing (ffuf).
• File Extension Sorting: Organizes URLs by file extensions.
• Wordlist Generation: Creates custom wordlists for fuzzing.
• Password Dictionary: Generates password dictionaries from live content (cewler).
• IIS Shortname Scanning: Detects IIS shortname vulnerabilities (shortscan).

Vulnerability Checks Copy Section

• CVEs: Checks for CVE and common vulnerabilites nuclei
• Nuclei DAST: Runs nuclei -dast templates over collected URLs and GF candidates for additional DAST coverage.
• XSS: Tests for cross-site scripting vulnerabilities (dalfox).
• SSL/TLS: Checks for SSL/TLS misconfigurations (testssl).
• SSRF: Tests for server-side request forgery (interactsh, parameter values with ffuf, and optional alternate protocol payloads).
• CRLF: Checks for CRLF injection vulnerabilities (crlfuzz).
• LFI: Tests for local file inclusion via fuzzing (ffuf).
• SSTI: Detects server-side template injection (TInjA).
• SQLi: Tests for SQL injection (SQLMap and ghauri).
• Broken Links: Identifies broken links and external references likely to be takeover-prone (second-order).
• Command Injection: Tests for command injection vulnerabilities (commix).
• HTTP Request Smuggling: Checks for request smuggling vulnerabilities (smugglex).
• Web Cache: Identifies web cache vulnerabilities (Web-Cache-Vulnerability-Scanner and toxicache).
• 4XX Bypassing: Attempts to bypass 4XX responses (nomore403).
• Parameter Fuzzing: Fuzzes URL parameters for vulnerabilities (nuclei).

Extras Copy Section

• Multithreading: Optimizes performance (Interlace).
• Custom Resolvers: Generates DNS resolvers (dnsvalidator).
• Docker Support: Official Docker image on DockerHub.
• AWS Deployment: Deploys via Terraform and Ansible.
• IP/CIDR Support: Scans IP ranges and CIDR blocks.
• Scan Resumption: Resumes scans from the last completed step.
• Custom Output: Saves results to a user-defined directory.
• Diff Mode: Highlights new findings in subsequent scans.
• Scope Filtering: Supports in-scope and out-of-scope lists (inscope).
• Notifications: Sends alerts via Slack, Discord, or Telegram (notify).
• Result Zipping: Compresses and sends results.
• Faraday Integration: Exports results to Faraday for reporting .
• AI Report Generation: Generates reports using local AI models (reconftw_ai).
• Quick Rescan Mode: Skips heavy stages automatically when no new assets are discovered (--quick-rescan / QUICK_RESCAN).
• Hotlist Builder: Scores and highlights the riskiest assets (hotlist.txt) based on new findings.
• Command Tracing: Toggle SHOW_COMMANDS to log every executed command into target logs for debugging.
• Asset Store: Appends findings to assets.jsonl for downstream automation when ASSET_STORE is enabled.
• Consolidated Report: Auto-generates report/report.json and report/index.html at end of scan.
• ARM Support: Compatible with Raspberry Pi and ARM architectures (including MacOS MX).
• Health Check: Built-in system health check via --health-check (also used by Docker HEALTHCHECK).
• Incremental Mode: Only scan new findings since last run (--incremental).
• Adaptive Rate Limiting: Automatically back off on 429/503 errors (--adaptive-rate).
• Structured Logging: Optional JSON log output for advanced analysis (STRUCTURED_LOGGING).
• Input Sanitization: All user input is sanitized to prevent command injection.
• Dry-Run Mode: Preview what would be executed without running commands (--dry-run).
• Parallel Mode: Run independent functions in parallel for faster scans (--parallel, disable with --no-parallel).
• Modular Architecture: Codebase split into 8 focused modules for maintainability.
• Secrets Management: Environment variables, secrets.cfg, and Docker runtime secrets (see SECURITY.md).
• Circuit Breaker: Automatically skips tools after repeated failures to avoid scan hangs.
• Checkpoint System: Resume interrupted scans from the last successful phase.
• macOS Native Support: Full compatibility with macOS (BSD coreutils, Homebrew Bash 4+).

🏗️ Architecture Copy Chapter

reconFTW uses a modular architecture. The main entry point (reconftw.sh) handles argument parsing and sources 8 specialized modules from the modules/ directory.

Directory Layout Copy Section

reconftw/
├── reconftw.sh          # Entry point — arg parsing, module loading, dispatch
├── reconftw.cfg         # Default configuration
├── install.sh           # Installer
├── Makefile             # Data management, lint, fmt, test targets
├── modules/
│   ├── core.sh          # Lifecycle, logging, notifications, cleanup (1024 lines)
│   ├── modes.sh         # Scan modes, argument parsing, help (902 lines)
│   ├── subdomains.sh    # Subdomain enumeration (1938 lines)
│   ├── web.sh           # Web analysis, fuzzing, JS checks (1712 lines)
│   ├── vulns.sh         # Vulnerability scanning (926 lines)
│   ├── osint.sh         # OSINT functions (500 lines)
│   ├── axiom.sh         # Ax/Axiom fleet helpers (143 lines)
│   └── utils.sh         # Utilities, sanitization, validation (508 lines)
├── tests/
│   ├── run_tests.sh     # Test runner
│   ├── unit/            # bats-core unit tests
│   ├── integration/     # Integration tests
│   └── fixtures/        # Test data
├── Docker/
│   └── Dockerfile       # Official Docker image
└── Terraform/           # AWS deployment

Module Reference Copy Section

The --source-only flag allows sourcing reconftw.sh without executing the main logic, enabling unit testing of individual functions.

💿 Installation Copy Chapter

reconFTW supports multiple installation methods to suit different environments. Ensure you have sufficient disk space (at least 10 GB recommended) and a stable internet connection.

Quickstart Copy Section

1. Clone and install

git clone https://github.com/six2dez/reconftw
cd reconftw
./install.sh --verbose

2. Run a scan (full + resume)

./reconftw.sh -d example.com -r

3. Minimal run (passive-only footprint)

./reconftw.sh -d example.com -p

Tip: re-run ./install.sh --tools later to refresh the toolchain without reinstalling system packages.

Local Installation (PC/VPS/VM) Copy Section

1. Prerequisites:

   • Golang: Latest version (install_golang enabled by default in reconftw.cfg).
   • System Permissions: If not running as root, configure sudo to avoid prompts:
     bash Copy

     sudo echo "${USERNAME} ALL=(ALL:ALL) NOPASSWD: ALL" | sudo tee -a /etc/sudoers.d/reconFTW

2. Steps:

   bash Copy

   git clone https://github.com/six2dez/reconftw
   cd reconftw
   ./install.sh
   ./reconftw.sh -d target.com -r

3. Notes:

• The install.sh script installs dependencies, tools, and configures paths (GOROOT, GOPATH, PATH).
• Set install_golang=false in reconftw.cfg if Golang is already configured.
• For existing setups, run ./install.sh --tools to refresh Go binaries, pipx packages, and repositories without touching system packages.
• Check the Installation Guide for detailed instructions.

Docker Copy Section

1. Pull the Image:

   bash Copy

   docker pull six2dez/reconftw:main

2. Run the Container:

   bash Copy

   docker run -it --rm \
     -v "${PWD}/OutputFolder/:/reconftw/Recon/" \
     six2dez/reconftw:main -d example.com -r

   For a list of targets, bind the list file into the container and reference the in-container path:

   bash Copy

   docker run -it --rm \
     -v "${PWD}/domains.txt:/reconftw/domains.txt:ro" \
     -v "${PWD}/OutputFolder/:/reconftw/Recon/" \
     six2dez/reconftw:main -l /reconftw/domains.txt -r

3. View Results:

   • Results are saved in the OutputFolder directory on the host (not inside the container).

4. Customization:

   • Modify the Docker image or build your own; see the Docker Guide.
   • To skip Ax tooling in custom builds, pass --build-arg INSTALL_AXIOM=false.
   • Mount your notify config at ~/.config/notify/provider-config.yaml inside the container if you use notifications.

5. Secrets at Runtime:

   Pass API keys and secrets via environment variables — never bake them into the image:

   bash Copy

   docker run -it --rm \
     -e SHODAN_API_KEY="your-key" \
     -e PDCP_API_KEY="your-projectdiscovery-key" \
     -e COLLAB_SERVER="your-server" \
     -e XSS_SERVER="your-server" \
     -v "${PWD}/OutputFolder/:/reconftw/Recon/" \
     six2dez/reconftw:main -d example.com -r

   See SECURITY.md for full secrets management guidance.

6. Health Check:

   The Docker image includes a built-in HEALTHCHECK that runs ./reconftw.sh --health-check every 60 seconds. You can also run it manually:

   bash Copy

   docker exec <container-id> ./reconftw.sh --health-check

Terraform + Ansible Copy Section

• Deploy reconFTW on AWS using Terraform and Ansible.
• Follow the guide in Terraform/README.md for setup instructions.

🛠️ Troubleshooting Copy Chapter

• Bash 4+ on macOS: The scripts auto-relaunch under Homebrew Bash. If you see a message about Bash < 4, run brew install bash, open a new terminal, and re-run ./install.sh.
• timeout on macOS: macOS provides gtimeout via brew install coreutils. The scripts now detect and use it automatically.
• Network hiccups: Installers hide most command output. If something fails, re-run with upgrade_tools=true in reconftw.cfg, execute ./install.sh --tools, or install the missing tool manually (the error will name it).
• GOPATH binaries: Binaries are copied to /usr/local/bin. If you prefer not to, ensure ~/go/bin is in your PATH.
• Nuclei templates: If templates weren’t cloned, remove ~/nuclei-templates and re-run ./install.sh.

🔑 API Checklist (Optional) Copy Chapter

• subfinder: ~/.config/subfinder/provider-config.yaml
• GitHub tokens: ~/Tools/.github_tokens (one per line)
• GitLab tokens: ~/Tools/.gitlab_tokens (one per line)
• WHOISXML: set WHOISXML_API in reconftw.cfg or env var
• ASN enumeration (asnmap): set PDCP_API_KEY in env/config (ASN_ENUM skips if unset)
• Slack/Discord/Telegram: configure notify in ~/.config/notify/provider-config.yaml
• SSRF server: set COLLAB_SERVER env/cfg if used
• Blind XSS server: set XSS_SERVER env/cfg if used

💾 Requirements Copy Chapter

• Disk: 10–20 GB free recommended (toolchain + data)
• Network: stable connection during installation and updates
• OS: Linux/macOS with Bash ≥ 4
• Extras: shellcheck and shfmt (optional) for make lint/make fmt

⚙️ Configuration Copy Chapter

The reconftw.cfg file controls the entire execution of reconFTW. It allows fine-grained customization of:

• Tool Paths: Set paths for tools, resolvers, and wordlists (tools, resolvers, fuzz_wordlist).
• API Keys: Configure keys for Shodan, WHOISXML, etc. via environment variables or secrets.cfg (see SECURITY.md).
• Scanning Modes: Enable/disable modules (e.g., OSINT, SUBDOMAINS_GENERAL, VULNS_GENERAL).
• Performance: Adjust threads, rate limits, and timeouts (e.g., FFUF_THREADS, HTTPX_RATELIMIT).
• Adaptive Rate Limiting: Automatically back off on 429/503 errors (ADAPTIVE_RATE_LIMIT, MIN_RATE_LIMIT, MAX_RATE_LIMIT).
• Incremental Scanning: Only scan new findings since last run (INCREMENTAL_MODE).
• Notifications: Set up Slack, Discord, or Telegram notifications (NOTIFY_CONFIG).
• Ax (formerly Axiom): Configure distributed scanning and resolver paths (AXIOM_FLEET_NAME, AXIOM_FLEET_COUNT, AXIOM_RESOLVERS_PATH).
• AI Reporting: Configure model/profile/format and context controls (AI_MODEL, AI_REPORT_PROFILE, AI_REPORT_TYPE, AI_MAX_CHARS_PER_FILE).
• Advanced Web Checks: Toggle GraphQL introspection, parameter discovery, WebSocket testing, gRPC probing, and IPv6 scanning.
• Automation & Data: Control quick rescan heuristics, asset logging, chunk sizes, hotlists, and debug tracing (QUICK_RESCAN, ASSET_STORE, CHUNK_LIMIT, HOTLIST_TOP, SHOW_COMMANDS).
• Disk & Logging: Pre-flight disk check (MIN_DISK_SPACE_GB), log rotation (MAX_LOG_FILES, MAX_LOG_AGE_DAYS), structured JSON logging (STRUCTURED_LOGGING).
• Caching: Configure cache expiry for wordlists and resolvers (CACHE_MAX_AGE_DAYS).
• DNS Resolver Safety: Missing resolver files fail fast, resolver downloads use configurable retry/timeout knobs (RESOLVER_DOWNLOAD_*), and DNS brute/resolve timeout defaults to disabled (DNS_*_TIMEOUT=0) with heartbeat progress.
• Secrets: Use secrets.cfg for local overrides or environment variables for CI/Docker (see SECURITY.md).

Example Configuration:

/* Detailed source-code truncated for AI context efficiency. */

DNS resolver guardrails:

• Missing/empty resolver files now fail fast before DNS brute/resolve starts.
• Resolver downloads are configurable with RESOLVER_DOWNLOAD_CONNECT_TIMEOUT, RESOLVER_DOWNLOAD_MAX_TIME, RESOLVER_DOWNLOAD_RETRY, and RESOLVER_DOWNLOAD_RETRY_DELAY.
• DNS_BRUTE_TIMEOUT=0 and DNS_RESOLVE_TIMEOUT=0 disable hard-timeout by default (recommended for very large target sets). Heartbeat progress still prints every DNS_HEARTBEAT_INTERVAL_SECONDS.

DNS_BRUTE_TIMEOUT=4h
DNS_RESOLVE_TIMEOUT=6h
DNS_HEARTBEAT_INTERVAL_SECONDS=20

Full Details: See the Configuration Guide.

🚀 Usage Copy Chapter

reconFTW supports multiple modes and options for flexible reconnaissance. Use the -h flag to view the help menu.

Target Options Copy Section

Mode Options Copy Section

General Options Copy Section

Example Usage Copy Section

1. Full Recon on a Single Target:

   bash Copy

   ./reconftw.sh -d target.com -r

2. Recon on Multiple Targets:

   bash Copy

   ./reconftw.sh -l targets.txt -r -o /path/to/output/

3. Deep Recon (VPS Recommended):

   bash Copy

   ./reconftw.sh -d target.com -r --deep

4. Parallel Mode (Faster, requires more RAM):

   bash Copy

   ./reconftw.sh -d target.com -r --parallel

5. Force Sequential Mode:

   bash Copy

   ./reconftw.sh -d target.com -r --no-parallel

6. Multi-Domain Recon:

   bash Copy

   ./reconftw.sh -m company -l domains.txt -r

7. Ax Integration:

   bash Copy

   ./reconftw.sh -d target.com -r -v

8. Ax Integration with fleet override:

   bash Copy

   ./reconftw.sh -d target.com -r -v 30

9. Full Recon with Attacks (YOLO Mode):

   bash Copy

   ./reconftw.sh -d target.com -a

10. Show Help:

./reconftw.sh -h

11. Force cache refresh:

./reconftw.sh -d target.com -r --refresh-cache

12. Export all report artifacts:

./reconftw.sh -d target.com -r --export all

13. Continuous monitoring (every 30m, 48 cycles):

./reconftw.sh -d target.com -r --monitor --monitor-interval 30 --monitor-cycles 48

14. Rebuild reports only (no scan):

./reconftw.sh -d target.com --report-only --export all

Full Guide: See the Usage Guide.

☁️ Ax Framework Support (previously Axiom) Copy Chapter

reconFTW integrates with Ax for distributed scanning, reducing execution time by distributing tasks across multiple cloud instances.

• Setup: Select reconftw as the provisioner during Ax configuration (axiom-configure).
• Fleet Management: Automatically create and destroy fleets (AXIOM_FLEET_LAUNCH, AXIOM_FLEET_SHUTDOWN) or use an existing fleet.
• Configuration: Set fleet size, region, and name in reconftw.cfg (AXIOM_FLEET_COUNT, AXIOM_FLEET_REGIONS, AXIOM_FLEET_NAME).

Example:

./reconftw.sh -d target.com -r -v

Details: See the official Ax Docs and the attacksurge/ax repo.

💻 Faraday Support Copy Chapter

reconFTW integrates with Faraday for web-based reporting and vulnerability management.

• Setup: Install Faraday, authenticate via faraday-cli, and configure the workspace in reconftw.cfg (FARADAY_WORKSPACE).
• Usage: Enable with FARADAY=true in reconftw.cfg.

🧠 AI Integration Copy Chapter

reconFTW uses AI to generate detailed reports from scan results with the tool reconftw_ai.

• Model: Configurable AI model (e.g., llama3:8b via AI_MODEL).
• Report Types: Markdown or plain text (AI_REPORT_TYPE).
• Profiles: Executive, brief, or bug hunter (AI_REPORT_PROFILE).
• Structured Output: reconftw stores a machine-readable report in ai_result/reconftw_analysis.json.
• Context Controls: Bound input size using AI_MAX_CHARS_PER_FILE and AI_MAX_FILES_PER_CATEGORY.
• Safety Controls: Toggle redaction and strict mode with AI_REDACT and AI_STRICT.

Example:

AI_EXECUTABLE="python3"
AI_MODEL="llama3:8b"
AI_REPORT_TYPE="md"
AI_REPORT_PROFILE="bughunter"
AI_MAX_CHARS_PER_FILE=50000
AI_MAX_FILES_PER_CATEGORY=200
AI_REDACT=true
AI_ALLOW_MODEL_PULL=false
AI_STRICT=false

🗂️ Data Management Copy Chapter

Manage scan data and API keys securely using a private repository.

When ASSET_STORE=true, reconFTW aggregates key findings into assets.jsonl during each run, making it easy to sync only actionable deltas to your private repo.

Makefile Copy Section

Use the provided Makefile for easy repository management (requires GitHub CLI).

1. Bootstrap:

   bash Copy

   export PRIV_REPO="$HOME/reconftw-data"
   make bootstrap

2. Sync with Upstream:

   bash Copy

   make sync

3. Upload Data:

   bash Copy

   make upload

4. Lint / Format Scripts:

   bash Copy

   make lint   # shellcheck for reconftw.sh, modules/*.sh & install.sh
   make fmt    # shfmt with project defaults

5. Run Tests:

   bash Copy

   make test       # unit tests (bats-core)
   make test-all   # unit + integration tests

Manual Copy Section

1. Create a private repository on GitHub/GitLab.

2. Clone and configure:

   bash Copy

   git clone https://github.com/yourusername/reconftw-data
   cd reconftw-data
   git commit --allow-empty -m "Initial commit"
   git remote add upstream https://github.com/six2dez/reconftw
   git fetch upstream
   git rebase upstream/main master

3. Upload Changes:

   bash Copy

   git add .
   git commit -m "Data upload"
   git push origin master

4. Update Tool:

   bash Copy

   git fetch upstream
   git rebase upstream/main master

🧪 Testing Copy Chapter

reconFTW uses bats-core for automated testing.

Install bats-core Copy Section

# macOS
brew install bats-core

# Debian/Ubuntu
apt install bats

# From source
git clone https://github.com/bats-core/bats-core.git /tmp/bats
sudo /tmp/bats/install.sh /usr/local

Running Tests Copy Section

# Unit tests only
make test

# Unit + integration tests
make test-all

# Via the runner script
./tests/run_tests.sh         # unit only
./tests/run_tests.sh --all   # unit + integration

Test Directory Structure Copy Section

tests/
├── run_tests.sh        # Test runner script
├── unit/               # Unit tests (fast, no network)
│   ├── test_sanitize.bats
│   ├── test_utils.bats
│   └── test_validation.bats
├── integration/        # Integration tests (require installed tools)
│   └── test_smoke.bats
├── security/           # Security tests (injection, etc.)
│   └── test_injection.bats
├── mocks/              # Mock tools for offline testing
└── fixtures/           # Shared test data files

Running Security Tests Copy Section

# Test command injection prevention
make test-security

# Or directly
bats tests/security/

Writing Tests Copy Section

Tests use the --source-only pattern to load functions without executing the main script:

#!/usr/bin/env bats

setup() {
    source ./reconftw.sh --source-only
}

@test "sanitize_domain strips invalid chars" {
    result="$(sanitize_domain 'exam;ple.com')"
    [ "$result" = "example.com" ]
}

CI Pipeline Copy Section

The GitHub Actions workflow (.github/workflows/tests.yml) runs on every push and pull request:

1. ShellCheck — lints reconftw.sh, modules/*.sh, and install.sh
2. Unit Tests — runs all tests/unit/*.bats files
3. Integration Tests — installs reconFTW and validates tool availability

Mindmap/Workflow Copy Chapter

Sample video Copy Chapter

🤝 How to Contribute Copy Chapter

See CONTRIBUTING.md for the full contributing guide, including development setup, code style, testing, and PR process.

Quick links:

• Report a Bug
• Submit a Pull Request (target the dev branch)
• Code of Conduct

🔒 Security Copy Chapter

For security policy, secrets management, and vulnerability reporting, see SECURITY.md.

❓ Need Help? Copy Chapter

• Wiki: Explore the reconFTW Wiki.
• FAQ: Check the FAQ.
• Community: Join the Discord server or Telegram group.

💖 Support This Project Copy Chapter

Support reconFTW’s development through:

• Buy Me a Coffee: buymeacoffee.com/six2dez

• DigitalOcean Referral: Referral Link

• GitHub Sponsorship: github.com/sponsors/six2dez

🙏 Thanks Copy Chapter

Special thanks to the following services for supporting reconFTW:

• C99
• CIRCL
• NetworksDB
• ipinfo
• hackertarget
• Censys
• Fofa
• intelx
• Whoxy

📝 Changelog Copy Chapter

See CHANGELOG.md for a detailed list of changes in each release.

🛠️ Development Copy Chapter

Project Structure Copy Section

reconftw/
├── reconftw.sh          # Main entry point (~500 lines)
├── reconftw.cfg         # Configuration file
├── modules/             # Phase modules
│   ├── utils.sh         # Utilities, sanitization, caching, circuit breaker
│   ├── core.sh          # Framework core, logging, lifecycle, health check
│   ├── modes.sh         # Scan modes, argument parsing
│   ├── subdomains.sh    # Subdomain enumeration
│   ├── web.sh           # Web analysis, nuclei scans
│   ├── vulns.sh         # Vulnerability scanning
│   ├── osint.sh         # OSINT functions
│   └── axiom.sh         # Ax/Axiom fleet helpers
├── lib/                 # Pure utility libraries
│   └── validation.sh    # Input validation functions
├── tests/               # Test suite (100+ tests)
│   ├── unit/            # Unit tests (bats)
│   ├── integration/     # Integration/smoke tests
│   └── security/        # Injection prevention tests
├── docs/                # Documentation
│   └── ARCHITECTURE.md  # Detailed architecture guide
└── secrets.cfg.example  # Template for API keys

Running Tests Copy Section

make test          # Unit tests
make test-security # Security tests
make test-all      # All tests
make lint          # Shellcheck
make lint-fix      # Auto-fix with shfmt

Development Workflow Copy Section

# 1. Source without executing (for testing)
source ./reconftw.sh --source-only

# 2. Test individual functions
sanitize_domain "test;domain.com"

# 3. Run health check
./reconftw.sh --health-check

# 4. Dry run to preview
./reconftw.sh -d example.com -r --dry-run

Contributing Copy Section

See CONTRIBUTING.md for development guidelines and docs/ARCHITECTURE.md for technical details.

📜 License Copy Chapter

reconFTW is licensed under the MIT License.

⭐ Star History Copy Chapter

File: Proxmox/README.md Copy Chapter

ReconFTW Proxmox LXC Deployment Script

This script automates the deployment of ReconFTW in a Linux Container (LXC) on a Proxmox server. It simplifies the process of setting up a dedicated environment for reconnaissance activities.

Prerequisites Copy Chapter

• A Proxmox VE server (version 6.x or later)
• Root access to the Proxmox server
• Sufficient storage space on the Proxmox server

Usage Copy Chapter

1. Copy the script bash -c "$(curl -fsSL https://raw.githubusercontent.com/six2dez/reconftw/master/Proxmox/reconftw_prox_deploy.sh)" to your Proxmox server.

2. Follow the prompts to configure your LXC container. You'll be asked for:

• Container ID
• Storage location
• Root filesystem size
• RAM allocation
• Number of CPU cores
• Hostname
• Password

5. The script will then:

• Download the Debian template if not already present
• Create and configure the LXC container
• Install ReconFTW and its dependencies

6. Once completed, the script will display the container information, including ID, hostname, and password.

Logging Copy Chapter

The script generates a log file in /var/log/ with the format reconftw_deploy_YYYYMMDD_HHMMSS.log. Refer to this log for detailed information about the deployment process.

Post-Installation Copy Chapter

After the script completes:

1. You can access the container using:

pct enter <CONTAINER_ID>

2. ReconFTW will be installed in /opt/reconftw/. Navigate to this directory to use ReconFTW.

3. Refer to the ReconFTW documentation for usage instructions.

Troubleshooting Copy Chapter

• If the script fails, check the log file for error messages.
• Ensure you have sufficient storage space and resources on your Proxmox server.
• Verify that your Proxmox server has internet access to download necessary packages.

Security Note Copy Chapter

Remember to change the default password after accessing the container for the first time.

Support Copy Chapter

For issues related to this deployment script, please open an issue in the GitHub repository. For ReconFTW-specific questions, refer to the ReconFTW GitHub page.

File: Terraform/README.md Copy Chapter

reconFTW loves Ansible+Terraform <3

This is an automated script created to work under AWS by using Terraform and Ansible. It allows you to easily deploy it or to easily adapt it into your IaaC strategy.

Note (best-effort): This Terraform/Ansible setup is provided as a reference. Cloud images, SSH usernames, and
package repos change over time, so you may need to adjust it for your environment. It is not covered by reconFTW CI.

Requirements Copy Chapter

You would need to have installed:

• AWS CLI (https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
• Terraform (https://learn.hashicorp.com/tutorials/terraform/install-cli)
• Ansible (https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)

And AWS credentials configured via the standard AWS provider chain (e.g., AWS_PROFILE, env vars, or an IAM role).

Deploying reconFTW on the AWS Cloud using Terraform and Ansible Copy Chapter

Note: this will charge costs (unless you are in the Free Tier)

1. Move to the Terraform folder (optional but recommended): cd Terraform
   • Put your own Subfinder config file and reconFTW config file on the files/ folder
2. Create a key pair to be used, e.g: ssh-keygen -f terraform-keys -t ecdsa -b 521
3. Run terraform init
4. Run terraform apply
   • You will be prompted for allowed_ssh_cidr (recommended: your public IP + /32)
5. Type "yes" and hit enter
6. Wait, because it can take up to 15 min.
7. Once the process has finished, you can now login, using ssh admin@ip -i terraform-keys
8. ???
9. If you have finished playing with reconFTW and hacking the world, remember to destroy the instance using terraform destroy

2. Official Technical Reference & Guides (six2dez/reconftw-docs) Copy Chapter

File: README.md Copy Chapter

reconFTW Documentation

Welcome to reconFTW Copy Chapter

reconFTW is a modular reconnaissance automation framework designed for security researchers, penetration testers, and bug bounty hunters. It orchestrates 80+ security tools to perform full reconnaissance on your targets, from subdomain enumeration to vulnerability scanning.

Why reconFTW? Copy Section

What Can reconFTW Do? Copy Section

/* Detailed source-code truncated for AI context efficiency. */

Quick Start Copy Chapter

# Install reconFTW
git clone https://github.com/six2dez/reconftw.git
cd reconftw
./install.sh

# Run your first scan
./reconftw.sh -d example.com -r

# Full scan with vulnerabilities
./reconftw.sh -d example.com -a

Documentation Overview Copy Chapter

This documentation is organized to help you get the most out of reconFTW:

📚 For Beginners Copy Section

1. First 30 Minutes - Quick start guide to get scanning
2. Getting Started - Installation and setup
3. Concepts - Understanding how reconFTW works
4. Usage Guide - All command-line options explained

🔧 For Configuration Copy Section

5. Configuration - Deep dive into reconftw.cfg
6. Modules - Detailed documentation for each module
7. Tools Reference - All 80+ integrated tools

📊 For Results Copy Section

8. Output Interpretation - Understanding your results
9. Data Model & I/O - Complete input/output reference
10. Integrations - Axiom and Faraday setup

For Advanced Users Copy Section

11. Deployment - Docker, Terraform, VPS, CI/CD
12. Performance Tuning - Optimize for speed and target size
13. Case Studies - Real-world usage examples
14. Advanced Usage - Custom functions and optimization
15. Troubleshooting - Common issues and solutions
16. Release Gate - Required checks before publishing updates

⚖️ Legal & Security Copy Section

17. OPSEC & Legal - Stay safe and authorized

Scan Modes at a Glance Copy Chapter

Additional workflow flags:

• --monitor, --monitor-interval, --monitor-cycles
• --report-only, --no-report
• --export json|html|csv|all
• --refresh-cache, --gen-resolvers
• --incremental, --adaptive-rate, --quick-rescan
• --quiet, --verbose, --no-color
• --log-format plain|jsonl|jsonl-strict
• --parallel-log summary|tail|full

Bundled config profiles:

• config/reconftw_quick.cfg
• config/reconftw_full.cfg
• config/reconftw_stealth.cfg

⚠️ Legal & OPSEC Copy Chapter

IMPORTANT: reconFTW is designed for authorized security testing only.

Authorization Checklist Copy Section

Before running any scan, verify:

• Written permission from target owner
• Defined scope (in-scope and out-of-scope assets)
• Rate limits agreed upon
• Testing window defined (if applicable)
• Emergency contact available
• NDA signed (if required)

OPSEC Considerations Copy Section

Legal Disclaimer Copy Section

By using this tool, you confirm that:

• You have explicit written permission to test the target
• You will comply with all applicable laws and regulations
• You understand that unauthorized testing is illegal

The developers assume no liability for misuse of this tool. Use responsibly.

➡️ Full OPSEC Guide

Community & Support Copy Chapter

• GitHub Issues: Report bugs or request features
• Discord: Join our community
• Telegram: Discussion group
• Twitter: @Six2dez1

Contributing Copy Chapter

reconFTW is open source and welcomes contributions! See our Contributing Guide for details.

File: assets/README.md Copy Chapter

Assets Directory

This directory contains images and other media files for the reconFTW documentation.

Directory Structure Copy Chapter

assets/
├── images/           # Screenshots, diagrams, and illustrations
│   ├── architecture/ # Architecture diagrams
│   ├── screenshots/  # UI screenshots
│   ├── diagrams/     # Flow diagrams
│   └── icons/        # Icons and logos
└── README.md         # This file

Required Images Copy Chapter

The following images are referenced in the documentation and need to be created:

Architecture Diagrams Copy Section

Screenshot Examples Copy Section

Module Diagrams Copy Section

Image Guidelines Copy Chapter

Dimensions Copy Section

• Architecture diagrams: 1200x800px (landscape)
• Screenshots: 1400x900px or native resolution
• Flow diagrams: 800x1200px (portrait) or 1200x800px (landscape)
• Icons: 64x64px or 128x128px

Format Copy Section

• Diagrams: PNG with transparent background preferred
• Screenshots: PNG
• Icons: SVG preferred, PNG acceptable

Style Guidelines Copy Section

• Use consistent color scheme matching reconFTW branding
• Primary color: #2D3748 (dark blue-gray)
• Accent color: #48BB78 (green)
• Use clean, readable fonts (Inter, Roboto, or system fonts)
• Include proper contrast for accessibility

Creating Images Copy Chapter

Recommended Tools Copy Section

• Diagrams: draw.io, Excalidraw, Mermaid
• Screenshots: macOS Screenshot, Flameshot, ShareX
• Image editing: GIMP, Figma, Canva

Using Mermaid (for GitBook) Copy Section

GitBook supports Mermaid diagrams. Example:

graph TD
    A[Target Domain] --> B[OSINT]
    B --> C[Subdomains]
    C --> D[Host Analysis]
    D --> E[Web Analysis]
    E --> F[Vulnerabilities]

ASCII Diagrams Copy Section

The documentation includes ASCII diagrams as fallbacks. These work in all environments and don't require images.

Placeholder Convention Copy Chapter

In the documentation, image placeholders are marked with HTML comments:

Contributing Images Copy Chapter

1. Create image following guidelines above
2. Place in appropriate subdirectory
3. Use descriptive filename (kebab-case)
4. Update documentation to reference image:
   markdown Copy

5. Submit PR with image and documentation update

License Copy Chapter

All images in this directory should be:

• Original creations, OR
• Properly licensed for open source use (CC0, CC-BY, MIT, etc.)

Do not include copyrighted images without permission.

File: 05-modules/README.md Copy Chapter

Modules Overview

reconFTW is organized into specialized modules, each handling a specific phase of reconnaissance. This page provides an overview and quick navigation to each module's detailed documentation.

Module Architecture Copy Chapter

flowchart TD
    T[Target Input] --> O[OSINT]
    O --> S[Subdomains]
    S --> H[Hosts]
    H --> W[Web Analysis]
    W --> V[Vulnerabilities]

    O -.-> O1[Dorks, emails, metadata, leaks]
    S -.-> S1[Passive, brute, permutations, takeover]
    H -.-> H1[Ports, CDN, WAF, geolocation]
    W -.-> W1[Probing, screenshots, JS analysis, fuzzing]
    V -.-> V1[Nuclei, XSS, SQLi, SSRF, etc.]

Module Summary Copy Chapter

OSINT Module Copy Chapter

Purpose: Gather intelligence about the target organization without direct interaction.

Key Capabilities:

• Google dorking for sensitive files
• GitHub secret scanning
• Email harvesting
• Document metadata extraction
• Cloud storage enumeration
• API leak detection

When to use: At the beginning of an engagement for initial intelligence gathering.

➡️ Full OSINT Documentation

Subdomains Module Copy Chapter

Purpose: Discover all subdomains associated with the target domain.

Key Capabilities:

• Passive enumeration (40+ sources)
• Certificate Transparency logs
• DNS brute-forcing
• Permutation generation
• Recursive enumeration
• Subdomain takeover detection

When to use: After OSINT, to map the attack surface.

➡️ Full Subdomains Documentation

Hosts Module Copy Chapter

Purpose: Analyze infrastructure behind discovered assets.

Key Capabilities:

• Port scanning (passive + active)
• Service fingerprinting on discovered ports
• CDN detection and filtering
• WAF identification
• IP geolocation

When to use: After subdomain enumeration, to understand infrastructure.

➡️ Full Hosts Documentation

Web Analysis Module Copy Chapter

Purpose: Analyze web applications and discover endpoints.

Key Capabilities:

• HTTP probing and status detection
• Screenshot capture
• URL extraction from archives
• JavaScript analysis for secrets
• Directory/file fuzzing
• Technology detection

When to use: After identifying live web servers.

➡️ Full Web Analysis Documentation

Vulnerabilities Module Copy Chapter

Purpose: Identify security vulnerabilities in discovered assets.

Key Capabilities:

• Template-based scanning (Nuclei)
• XSS testing
• SQL injection detection
• SSRF testing
• CORS misconfiguration
• SSL/TLS analysis
• And many more...

When to use: Final phase, after mapping all assets.

➡️ Full Vulnerabilities Documentation

Module Execution Order Copy Chapter

In a full scan (-a flag), modules execute in this order:

1. OSINT          → Intelligence gathering
2. Subdomains     → Asset discovery  
3. Hosts          → Infrastructure analysis
4. Web Analysis   → Application mapping
5. Vulnerabilities → Security testing

Each module builds on the previous one's output, creating a full reconnaissance pipeline.

Enabling/Disabling Modules Copy Chapter

Via Configuration Copy Section

# In reconftw.cfg
OSINT=true
SUBDOMAINS_GENERAL=true
PORTSCANNER=true
WEBPROBEFULL=true       # Unified web probing over 80/443 + uncommon ports
NUCLEICHECK=true
# Use VULNS_GENERAL=true if you want to enable the full vulnerability module by config

Via Command Line Copy Section

# Run only specific modules
./reconftw.sh -d example.com -s          # Subdomains only
./reconftw.sh -d example.com -n          # OSINT only
./reconftw.sh -d example.com -w          # Web analysis only

# Custom function selection
./reconftw.sh -d example.com -c sub_passive
./reconftw.sh -d example.com -c webprobe_full

Module Dependencies Copy Chapter

Some modules depend on outputs from others:

OSINT ─────────────────────────────────────┐
                                           │
Subdomains ───────┬────────────────────────┤
                  │                        │
                  ▼                        │
              Hosts ───────────────────────┤
                  │                        │
                  ▼                        │
           Web Analysis ───────────────────┤
                  │                        │
                  ▼                        │
          Vulnerabilities ◄────────────────┘

Next Steps Copy Chapter

Choose a module to explore in detail:

• OSINT Module - Start with intelligence gathering
• Subdomains Module - Discover your attack surface
• Hosts Module - Understand the infrastructure
• Web Analysis Module - Map web applications
• Vulnerabilities Module - Find security issues