# OpenRecon

[![PyPI version](https://img.shields.io/pypi/v/openrecon.svg)](https://pypi.org/project/openrecon/)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

## Overview

OpenRecon is a comprehensive network reconnaissance tool designed for security professionals, network administrators, and cybersecurity enthusiasts. Originally developed as an educational project to explore network security concepts, it provides powerful scanning and discovery capabilities for authorized security assessments.

## Installation

### Via pip (Recommended)
```bash
pip install openrecon
```

### From Source
```bash
git clone https://github.com/v7upSln/OpenRecon.git
cd OpenRecon
pip install -r requirements.txt
```

### Optional: Install Nmap (for enhanced version detection)

**Ubuntu/Debian:**
```bash
sudo apt install nmap
```

**CentOS/RHEL:**
```bash
sudo yum install nmap
```

**macOS:**
```bash
brew install nmap
```

**Windows:**
Download from [nmap.org](https://nmap.org/download.html)

## Usage

### Basic Command Structure
```bash
openrecon [command] [options]
```

### Display System Information
```bash
openrecon
```
Shows system and network configuration.

### Common Examples
```bash
# Basic network scan
openrecon scan --target 192.168.1.0/24

# Port scanning
openrecon ports --target 192.168.1.1 --ports 1-1000

# Service detection
openrecon services --target 192.168.1.1
```

## Features

- Network discovery and host enumeration
- Port scanning with service detection
- Operating system fingerprinting
- Vulnerability assessment templates
- Comprehensive reporting capabilities
- Educational mode with detailed explanations

## Legal Disclaimer

This tool is intended for:
- Security professionals conducting authorized assessments
- Network administrators monitoring their own networks
- Educational and research purposes

### Important:
- Only use on networks you own or have explicit permission to test
- Unauthorized scanning may be illegal in your jurisdiction
- The developers are not responsible for misuse of this tool
- Always comply with local laws and regulations

## Support

- **Documentation:** [GitHub Wiki](https://github.com/v7upSln/OpenRecon/wiki)
- **Issues:** [GitHub Issues](https://github.com/v7upSln/OpenRecon/issues)

## Contributing

Contributions are welcome! Please feel free to submit pull requests, report bugs, or suggest new features.

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/v7upSln/OpenRecon/blob/main/LICENSE) file for details.