A lightweight, modular cybersecurity scanner
Project description
OpenRecon
Extensible CLI Reconnaissance & Vulnerability Assessment Tool
Note: This tool is currently in active development. While functional, it may contain bugs as we continue to improve it,Your feedback helps make OpenRecon better! Please report any issues.
Overview
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
nmapintegration 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/R0salman/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:
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 |
Requirements
- Python 3.7+
- Nmap (must be in system PATH) - Download Nmap
- playwright
Contributing
We welcome contributions! Here's how to help:
- Fork the repository
- Create your feature branch
- Commit your changes
- Push to the branch
- 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openrecon-0.1.5.tar.gz.
File metadata
- Download URL: openrecon-0.1.5.tar.gz
- Upload date:
- Size: 62.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
78ad93ae1d36b25a3239e402fe16598295c329a0e5fb0eb02c16d16a95a65db9
|
|
| MD5 |
21d817279940da1fe434cd2fe340aaac
|
|
| BLAKE2b-256 |
d9a675ca66e5b5b7b73901df7dbd57f4906a9b5bfdbc83947554804c4c3e0520
|
File details
Details for the file openrecon-0.1.5-py3-none-any.whl.
File metadata
- Download URL: openrecon-0.1.5-py3-none-any.whl
- Upload date:
- Size: 68.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
14774ede95ceda7893e0ddedcd12958788b9e3eae6d71e48b84bfe98c948fecc
|
|
| MD5 |
1a80e946bee833feeb2fdf633dc608f4
|
|
| BLAKE2b-256 |
056e729c980c009f61cb37ccf8aca1703c793af8a0720730a82c36abafced191
|