Skip to content

h3xitsec/h3xrecon

Repository files navigation

H3XRecon

PyPI - Version PyPI - Python Version


H3XRecon is a powerful bug bounty reconnaissance automation tool designed to streamline and automate the reconnaissance phase of security assessments. It provides a distributed architecture for efficient scanning and data processing, with advanced scope management and real-time monitoring capabilities.

🚀 Features

  • Distributed reconnaissance architecture supporting both Docker Swarm and Docker Compose
  • Real-time log aggregation and visualization with Grafana
  • Advanced modular plugin system with hot-reloading support
  • Centralized data processing with MongoDB and Redis
  • Intelligent scope management with regex and CIDR support
  • Bug Bounty program management with multi-program support
  • REST API for programmatic access and integration
  • Automated asset discovery and classification
  • Real-time notifications via Slack and Discord
  • Export capabilities in multiple formats (JSON, CSV, XML)

📋 Prerequisites

  • Docker Engine 20.10+ or Kubernetes 1.19+
  • Docker Compose v2 (docker compose)
  • Python 3.11+
  • Ansible 2.9+ (for remote deployment)

Recon Workflow

H3XRecon Workflow

Credits

The client part of the project is inspired from the BBRF client by @honoki. This is what I was using before I started this project, so I made it work in the same way,

Getting Started

💻 Local Docker Compose

Please refer to the Docker Compose Deployment for more information on how to setup the project using Docker Compose.

OR

🚀 Deployment Options

  1. Docker Compose Deployment - For single-node setups
  2. Docker Swarm Deployment - For distributed deployments

📦 Install the h3xrecon client

Refer to the Client Documentation for more information on how to install the h3xrecon client.

🚀 Start using it !

Setup your first program

# Create a new program
h3xrecon program add program_name
# Add a scope to the program
h3xrecon -p program_name config add scope ".*example.com"
# Add a cidr to the program
h3xrecon -p program_name config add cidr "1.2.3.4/24"
# Send a job to the program
h3xrecon -p program_name sendjob resolve_domain example.com
# View data
h3xrecon -p program_name list domains/urls/ips/services

For more information on the commands, please refer to the Client Documentation.

📊 Monitoring Dashboards

Grafana

  • URL: http://<processor host>:3000
  • Features:
    • Real-time log aggregation
    • Service performance metrics
    • Custom reconnaissance dashboards

License

h3xrecon is distributed under the terms of the MIT license.