Skip to content

R0salman/OpenRecon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo

OpenRecon

Extensible CLI Reconnaissance & Vulnerability Assessment Tool

Python Version License PyPI Version

Overview

Screenshot-2025-05-27-123149

OpenRecon is an extensible, CLI-based reconnaissance and vulnerability assessment tool designed for:

  • Security researchers
  • Bug bounty hunters
  • Penetration testers
  • IT security students

This project consolidates multiple scanning techniques into a unified interface to efficiently identify vulnerabilities and surface-level threats.

Project Background: This is my final college project and also my first large-scale security tool — built from scratch with passion, learning, and extensive trial and error. Feedback and contributions are highly appreciated!

Key Features

Reconnaissance

  • Port Scanning: Comprehensive nmap integration for service detection
  • Host Discovery:
    • ARP-based scanning for local networks
    • ICMP ping sweep for wide-range detection
  • Subdomain Enumeration: Uses crt.sh, DNS resolution with local caching

Vulnerability Detection

  • XSS Scanner: Detects reflected, stored, and DOM-based XSS
  • SQL Injection: Identifies potential SQLi vulnerabilities
  • CSRF Scanner: Checks for Cross-Site Request Forgery issues
  • GraphQL Scanner: Finds exposed GraphQL endpoints
  • CMS Detection: Fingerprints WordPress, Joomla, and other CMS platforms

Installation

Option 1: PyPI Installation

pip install openrecon

Troubleshooting PATH Issues

If you get a "command not found" error after installation, it may be because the executable isn’t in your system PATH (especially if using Microsoft Store Python or pip install --user). You may see a warning like:

WARNING: The script openrecon.exe is installed in 'C:\Users\...\Scripts' which is not on PATH.

Quick Fix (works immediately):

python -m openrecon --help

Permanent Fix — Add to PATH:

  • Copy the Scripts directory path shown in the warning message
  • Press Win + R, type sysdm.cpl, and press Enter
  • Go to the Advanced tab, and click Environment Variables
  • Under User variables, select Path and click Edit
  • Click New and paste the Scripts directory path -Click OK on all dialogs and restart your terminal

Option 2: Manual Installation

Linux

git clone https://github.com/yourusername/openrecon
cd openrecon
chmod +x setup.sh
./setup.sh

Windows

git clone https://github.com/R0salman/OpenRecon
cd OpenRecon
setup.bat

Basic Usage

openrecon --help
openrecon scan --target example.com --flags "-T4 -F"

For full documentation, usage examples, module configurations, and troubleshooting, please visit:

OpenRecon Documentation

Available Modules

Module Description
portscan Nmap-based port scanning and service detection
livediscovery ARP-based active host detection for local networks
pingsweep ICMP ping sweep to identify online hosts
subenum Subdomain enumeration with crt.sh and DNS resolution (caches in ~/.openrecon)
xss Comprehensive XSS vulnerability scanning
sql SQL Injection detection
cms CMS fingerprinting (WordPress, Joomla, etc.)
csrf CSRF vulnerability scanning
graphql GraphQL endpoint detection
payloads Curated collection of security testing payloads (sourced from Payload Box)

Requirements

  • Python 3.8+
  • Nmap (must be in system PATH) - Download Nmap
  • playwright

Contributing

We welcome contributions! Here's how to help:

  1. Fork the repository
  2. Create your feature branch: git checkout -b feature/your-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature/your-feature
  5. Submit a pull request

License

This project is licensed under the MIT License.

Disclaimer

Important: This tool is intended for:

  • Authorized security testing
  • Educational purposes
  • Research and development

Unauthorized use against systems without explicit permission is illegal and unethical. The developers assume no liability and are not responsible for any misuse or damage caused by this tool.

About

All-in-one vulnerability assessment tool.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages