Skip to content

Commit 84d4e07

Browse files
committed
docs(README): enhance content and structure for clarity and feature overview
1 parent 281608a commit 84d4e07

File tree

1 file changed

+302
-44
lines changed

1 file changed

+302
-44
lines changed

README.md

Lines changed: 302 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,333 @@
1-
21
<div align="center">
32
<img src="https://raw.githubusercontent.com/Ayanrajpoot10/bugscanx/refs/heads/main/assets/logo.png" width="128" height="128"/>
43
<h1>BugScanX</h1>
5-
<p>All-in-one tool for SNI discovery</p>
4+
<p><b>All-in-One Tool for Finding SNI Bug Hosts</b></p>
5+
<p>🔍 Bug Host Discovery • 🌐 SNI Host Scanning • 🛡️ HTTP Analysis • 📊 Host Intelligence</p>
66
</div>
77

88
<p align="center">
99
<img src="https://img.shields.io/github/stars/Ayanrajpoot10/bugscanx?color=e57474&labelColor=1e2528&style=for-the-badge"/>
1010
<img src="https://img.shields.io/pypi/dm/bugscan-x?color=67b0e8&labelColor=1e2528&style=for-the-badge"/>
1111
<img src="https://img.shields.io/pypi/v/bugscan-x?color=8ccf7e&labelColor=1e2528&style=for-the-badge"/>
12+
<img src="https://img.shields.io/github/license/Ayanrajpoot10/bugscanx?color=f39c12&labelColor=1e2528&style=for-the-badge"/>
13+
<img src="https://img.shields.io/github/last-commit/Ayanrajpoot10/bugscanx?color=9b59b6&labelColor=1e2528&style=for-the-badge"/>
1214
</p>
1315

14-
---
16+
<p align="center">
17+
<img src="https://img.shields.io/badge/Python-3.7+-3776ab?style=for-the-badge&logo=python&logoColor=white"/>
18+
<img src="https://img.shields.io/badge/Platform-Windows%20%7C%20Linux%20%7C%20macOS%20%7C%20Android-lightgrey?style=for-the-badge"/>
19+
</p>
1520

16-
## 🚀 Features
17-
18-
### 🔧 Core Tools
19-
- **Host Checker Pro**
20-
- Multiple scanning modes
21-
- Advanced payload handling
22-
- Supports various HTTP methods
23-
- **Subfinder**
24-
- Active subdomain enumeration
25-
- Support for multiple API providers
26-
- Fast concurrent enumeration
27-
- **IP Lookup**
28-
- Discover domains on the same IP
29-
- Aggregates data from multiple sources
30-
31-
### 🧰 Additional Tools
32-
- **CIDR Scanner**
33-
- **TXT Toolkit**
34-
- **Port Scanner**
35-
- **DNS Record Viewer**
36-
- **OSINT Utilities**
37-
38-
### ✨ Highlights
39-
- Clean and modern interactive UI
40-
- Input autocompletion and validation
41-
- Cross-platform support (Windows, Linux, macOS, Android(Termux))
42-
- Actively maintained with regular updates
4321

44-
---
22+
## 📋 Table of Contents
23+
24+
- [🎯 Overview](#-overview)
25+
- [✨ Features](#-features)
26+
- [⚡ Quick Start](#-quick-start)
27+
- [🔧 Installation](#-installation)
28+
- [🛠️ Tools Documentation](#️-tools-documentation)
29+
- [🏗️ Architecture](#️-architecture)
30+
- [🤝 Contributing](#-contributing)
31+
- [⚠️ Disclaimer](#️-disclaimer)
32+
- [📞 Support](#-support)
33+
34+
35+
## 🎯 Overview
36+
37+
**BugScanX** is a specialized bug host discovery tool designed for finding working SNI/HTTP hosts that are suitable for tunneling applications. This tool helps users discover bug hosts that can be used to create configurations for various tunneling and VPN applications to enable unrestricted internet access.
38+
39+
## ✨ Features
40+
41+
### 🎯 Host Scanner Pro
42+
Advanced multi-mode bug host scanning with specialized capabilities:
43+
- **Direct Scanning**: HTTP/HTTPS bug host discovery with custom methods
44+
- **DirectNon302**: Specialized scanning that excludes redirect responses (essential for bug hosts)
45+
- **SSL/SNI Analysis**: TLS/SSL configuration analysis for SNI bug hosts
46+
- **Proxy Testing**: Comprehensive proxy validation for tunneling compatibility
47+
- **Ping Scanning**: Connectivity testing for discovered hosts
48+
- Support for all HTTP methods and custom payload injection
49+
- Multi-threaded concurrent processing
50+
51+
### 🔍 Subdomain Enumeration
52+
Professional subdomain discovery for expanding bug host lists:
53+
- **Passive Discovery**: Leverages multiple API providers and search engines
54+
- **Active Enumeration**: DNS brute-force for comprehensive coverage
55+
- **Batch Processing**: Mass domain enumeration from target lists
56+
57+
### 🌐 IP Lookup & Reverse DNS
58+
Comprehensive IP intelligence for bug host clustering:
59+
- **Reverse IP Lookup**: Discover all domains hosted on target IPs
60+
- **CIDR Range Processing**: Bulk analysis of IP ranges
61+
- **Multi-Source Aggregation**: Combines data from multiple sources
62+
63+
### 📡 CIDR Scanner
64+
Efficient IP range analysis for bug host discovery with port enumeration and custom HTTP methods.
65+
66+
### 🚪 Port Scanner
67+
Advanced port scanning for service discovery with common tunneling ports (80, 443, 8080, 8443).
68+
69+
### 🔎 DNS & SSL Analysis
70+
Comprehensive analysis for SNI bug hosts including DNS records and SSL certificate validation.
71+
72+
### 📁 File Management & Processing
73+
Professional-grade file processing with smart splitting, merging, deduplication, and filtering tools.
74+
4575

4676
## ⚡ Quick Start
4777

78+
### 🚀 Installation
79+
4880
```bash
49-
# Install the package
81+
# Install from PyPI
5082
pip install bugscan-x
83+
```
84+
85+
### 🎮 Launch BugScanX
5186

52-
# Run the tool
87+
```bash
88+
# Primary command
5389
bugscanx
90+
91+
# Alternative commands
92+
bugscan-x
93+
bx
5494
```
5595

56-
> **NOTE:** The package on PyPI is published as `bugscan-x` (not `BugScanX`).
57-
> The original name `BugScanX` was banned and is no longer available.
58-
> Please use `bugscan-x` when installing the tool.
96+
### 🎯 Interactive Menu
97+
98+
```
99+
╔╗ ╦ ╦╔═╗╔═╗╔═╗╔═╗╔╗╔═╗ ╦
100+
╠╩╗║ ║║ ╦╚═╗║ ╠═╣║║║╔╩╦╝
101+
╚═╝╚═╝╚═╝╚═╝╚═╝╩ ╩╝╚╝╩ ╚═
102+
103+
[1] HOST SCANNER PRO # Advanced bug host scanner with multiple modes
104+
[2] HOST SCANNER # Simplified bug host scanner
105+
[3] CIDR SCANNER # CIDR/IP scanner for bug host
106+
[4] SUBFINDER # Subdomain enumeration with active and passive modes
107+
[5] IP LOOKUP # Reverse IP lookup
108+
[6] FILE TOOLKIT # Bug host list management
109+
[7] PORT SCANNER # Port scanner to discover open ports
110+
[8] DNS RECORD # DNS record gathering
111+
[9] HOST INFO # Detailed bug host analysis
112+
[10] HELP # Documentation and usage examples
113+
[11] UPDATE # Self-update tool
114+
[12] EXIT # Quit application
115+
```
116+
117+
### 📱 Using Discovered Bug Hosts
118+
119+
Once you discover working bug hosts using BugScanX, you can use them to create configurations for various tunneling and VPN applications to bypass network restrictions.
120+
121+
122+
## 🔧 Installation
123+
124+
### 📋 System Requirements
125+
126+
- **Python**: 3.7 or higher
127+
- **Operating System**: Windows, Linux, macOS, Android (Termux)
128+
- **Network**: Internet connection
129+
130+
### 🔨 Installation Methods
131+
132+
#### PyPI Installation (Recommended)
133+
134+
```bash
135+
# Install latest stable version
136+
pip install bugscan-x
137+
138+
# Install beta version
139+
pip install --pre bugscan-x
140+
```
141+
142+
#### Development Installation
143+
144+
```bash
145+
# Clone repository
146+
git clone https://github.com/Ayanrajpoot10/bugscanx.git
147+
cd bugscanx
148+
149+
# Install in development mode
150+
pip install -e .
151+
```
152+
153+
### 🔗 Dependencies
154+
155+
BugScanX automatically installs the following dependencies:
156+
157+
```text
158+
beautifulsoup4 # HTML parsing and web scraping
159+
dnspython # DNS resolution and analysis
160+
InquirerPy # Interactive CLI prompts
161+
packaging # Version management
162+
pyfiglet # ASCII art generation
163+
requests # HTTP client library
164+
rich # Rich console output
165+
tqdm # Progress bars
166+
```
167+
168+
## 🛠️ Tools Documentation
169+
170+
### 1️⃣ Host Scanner Pro
171+
172+
Advanced bug host discovery with multiple scanning modes:
173+
174+
- **Direct Mode**: Standard HTTP/HTTPS bug host scanning
175+
- **DirectNon302 Mode**: Excludes redirect responses (essential for clean bug hosts)
176+
- **SSL/SNI Mode**: SNI hostname verification and TLS analysis
177+
- **Proxy Mode**: Websocket upgrade testing and proxy validation
178+
179+
### 2️⃣ Subfinder
180+
181+
Professional subdomain enumeration using multiple sources:
182+
- Certificate Transparency logs
183+
- Search engines and APIs
184+
- DNS records analysis
185+
- Batch processing for multiple domains
186+
187+
### 3️⃣ IP Lookup
188+
189+
Reverse IP analysis for related bug host discovery:
190+
- Multi-source domain lookup
191+
- CIDR range processing
192+
- Historical hosting data
193+
194+
### 4️⃣ File Toolkit
195+
196+
Advanced file processing operations:
197+
```bash
198+
[1] SPLIT FILE # Divide large bug host lists
199+
[2] MERGE FILES # Combine multiple discoveries
200+
[3] CLEAN FILE # Extract clean domains
201+
[4] DEDUPLICATE # Remove duplicates
202+
[5] FILTER BY TLD # Filter by domain extension
203+
[6] FILTER BY KEYWORD # Filter by criteria
204+
[7] CIDR TO IP # Expand network ranges
205+
[8] DOMAIN TO IP # Resolve to IP addresses
206+
```
207+
208+
### 5️⃣ Port Scanner
209+
210+
High-performance port enumeration:
211+
- Common tunneling ports (80, 443, 8080, 8443, 8888)
212+
- Full range scanning
213+
- Service detection and connection testing
214+
215+
### 6️⃣ DNS Record Analyzer
216+
217+
Comprehensive DNS intelligence:
218+
- A, AAAA, CNAME, MX, NS, TXT records
219+
- IPv4/IPv6 address resolution
220+
- Name server analysis
221+
222+
223+
## ⚙️ Configuration
224+
225+
### 🛠️ Scanning Parameters
226+
- **Thread Count**: Adjust concurrent threads (default: 50)
227+
- **Timeout Settings**: Configure connection timeouts
228+
- **Port Lists**: Customize target ports
229+
- **HTTP Methods**: Select specific methods for discovery
230+
231+
### 📂 Output Configuration
232+
- **File Formats**: TXT, JSON, CSV output options
233+
- **Result Filtering**: Filter by response codes and content types
234+
- **Logging Levels**: Adjust verbosity for debugging
235+
236+
### 🌐 Network Settings
237+
- **Proxy Configuration**: Use proxy servers for scanning
238+
- **DNS Settings**: Configure custom DNS servers
239+
- **User Agent**: Customize HTTP user agent strings
240+
241+
### 🎯 Advanced Settings
242+
- **DirectNon302 Mode**: Exclude redirect responses for clean bug hosts
243+
- **SSL/SNI Configuration**: TLS version preferences and certificate validation
244+
- **Timeout Settings**: SSL handshake and connection timeouts
245+
246+
247+
## 🏗️ Architecture
248+
249+
BugScanX is built with a modular architecture for extensibility and performance:
250+
251+
### 🔧 Core Components
252+
253+
- **Module Handler**: Dynamic module loading and execution
254+
- **Concurrency Engine**: Multi-threaded processing with ThreadPoolExecutor
255+
- **Rich Console Interface**: Advanced console output with progress tracking
256+
- **File Management**: Smart file operations and processing
257+
- **Network Layer**: HTTP/HTTPS requests with proxy support
59258

60-
---
61259

62260
## 🤝 Contributing
63261

64-
We welcome contributions from the community!
65-
Here’s how you can help:
262+
We welcome contributions from the security community!
263+
264+
### 🐛 Bug Reports
265+
266+
Create an issue with:
267+
- Clear description of the issue
268+
- Steps to reproduce
269+
- Environment details (OS, Python version, BugScanX version)
270+
- Expected vs actual behavior
271+
272+
### 💡 Feature Requests
273+
274+
Include:
275+
- Feature description and use case
276+
- Implementation ideas
277+
278+
279+
## ⚠️ Disclaimer
280+
281+
### 🚨 Important Notice
282+
283+
BugScanX is designed for **educational purposes** and **legitimate testing** only:
284+
285+
-**Learning**: Understanding tunneling and bypass techniques
286+
-**Personal Use**: Testing your own networks and systems
287+
-**Research**: Academic and educational research
288+
-**Legal Testing**: Authorized penetration testing
289+
290+
### ⚠️ Responsible Usage
291+
292+
- **🔒 Legal Compliance**: Always comply with local laws
293+
- **📋 Permission Required**: Only test systems you own or have permission to test
294+
- **🤝 Respect Networks**: Avoid overwhelming target servers
295+
- **🛡️ Ethical Use**: Use discovered bug hosts responsibly
296+
- **❌ No Unauthorized Testing**: Never scan without proper authorization
297+
298+
### 📝 Usage Agreement
299+
300+
By using BugScanX, you agree to use the tool only for legitimate purposes and take full responsibility for your actions.
301+
302+
### 🚨 Legal Warning
303+
304+
**The developers are not responsible for any misuse of this tool. Users must ensure compliance with all applicable laws.**
305+
306+
307+
## 📞 Support
308+
309+
### 💬 Community Support
310+
311+
- **Telegram**: [@BugScanX](https://t.me/BugScanX) - Community discussions
312+
- **GitHub Issues**: [Report bugs and request features](https://github.com/Ayanrajpoot10/bugscanx/issues)
313+
- **GitHub Discussions**: [Community Q&A](https://github.com/Ayanrajpoot10/bugscanx/discussions)
314+
315+
### 📚 Documentation
316+
317+
- **Built-in Help**: Use option `[10] HELP` in the application
318+
- **Wiki**: [Comprehensive documentation](https://github.com/Ayanrajpoot10/bugscanx/wiki)
66319

67-
- 💬 [Open an issue](https://github.com/Ayanrajpoot10/bugscan-x/issues) to report bugs or suggest features
68-
- 🛠️ Submit a pull request to contribute code
69-
- 📢 Join our [Telegram community](https://t.me/BugScanX) for discussion and updates
70320

71321
---
72322

73-
## 📄 License
74323

75-
This project is licensed under the [MIT License](LICENSE).
324+
<div align="center">
325+
<h3>Built with ❤️ for the Free Internet Community</h3>
326+
<p>
327+
<a href="https://github.com/Ayanrajpoot10">👨‍💻 Developer</a> •
328+
<a href="https://t.me/BugScanX">💬 Telegram</a> •
329+
<a href="https://github.com/Ayanrajpoot10/bugscanx/issues">🐛 Issues</a> •
330+
<a href="https://pypi.org/project/bugscan-x/">📦 PyPI</a>
331+
</p>
332+
<p><sub>⚠️ This tool is intended for educational and authorized testing purposes only. Use responsibly and legally.</sub></p>
333+
</div>

0 commit comments

Comments
 (0)