Skip to content

Commit 7848681

Browse files
trmxvibstrmxvibs
authored
Update README.md
1 parent a920690 commit 7848681

1 file changed

Lines changed: 191 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 191 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,191 @@
1-
# NetSentry-Framework
2-
Ultimate Automated Reconnaissance & Vulnerability Assessment Framework. Multi-threaded Scanning Engines.
1+
# NET-SENTRY
2+
> **The Ultimate Automated Reconnaissance & Vulnerability Assessment System**
3+
4+
![Version](https://img.shields.io/badge/version-29.0_God_Mode-red) ![Python](https://img.shields.io/badge/python-3.x-blue) ![License](https://img.shields.io/badge/license-MIT-green) ![Status](https://img.shields.io/badge/status-Operational-orange)
5+
6+
**Net-Sentry** is a military-grade offensive security framework designed to automate the reconnaissance and vulnerability assessment phase. It combines the power of multiple scanning engines into a single **Unified Command Console**.
7+
8+
It replaces manual grunt work with automation, allowing security researchers to focus on strategy. Net-Sentry delivers deep intelligence, vulnerability analysis, and actionable reports.
9+
10+
---
11+
## Key Features
12+
13+
Net-Sentry operates on a modular architecture, deploying specialized engines for every stage of the kill chain.
14+
15+
### 1. Active Intelligence & AI
16+
* **The Oracle:** Queries **Shodan/InternetDB** for cached open ports and CVEs without sending active packets to the target.
17+
* **Tech Stack Detective:** Identifies server technologies (CMS, Frameworks, WAFs) to tailor attacks.
18+
19+
### 2. Deep Reconnaissance
20+
* **Multi-Threaded Scanning:** Runs Nmap, SSL, and Spider modules simultaneously for hyper-speed results.
21+
* **Geo-Tactical Tracking:** Live **Satellite Geolocation** of the target server visualized on a world map.
22+
* **Topology Mapper:** Visualizes network nodes, ports, and attack vectors in an interactive graph.
23+
* **Subdomain Spy:** Passive subdomain enumeration via Certificate Transparency logs.
24+
25+
### 3. Offensive Capabilities
26+
* **The Key Reaper:** Scrapes HTML & JavaScript files to harvest leaked **API Keys** (Google, AWS, Stripe) and hidden endpoints.
27+
* **WAF Detector & Bypass:** Identifies Firewalls (Cloudflare/AWS) and attempts 403 bypass using header poisoning techniques.
28+
* **Directory Buster:** Brute-forces hidden paths (`/admin`, `/.env`, `/backup`) to find exposed panels.
29+
30+
### 4. Analysis & Interface
31+
* **Live Terminal:** A fully functional command-line interface within the browser.
32+
* **Executive Reporting:** Generates professional PDF reports separated by modules for client delivery.
33+
* **System Bridge:** Execute host OS commands directly from the dashboard.
34+
35+
---
36+
## Visual Gallery
37+
38+
<img width="1911" height="930" alt="image" src="https://github.com/user-attachments/assets/14deb141-ed8a-496c-8cf4-19dc90df9532" />
39+
40+
---
41+
## Prerequisites
42+
43+
Before deploying Net-Sentry, ensure your system meets the following requirements.
44+
45+
### 1. Core Engine
46+
* **Python 3.8+**: The backbone of the framework.
47+
* **Nmap**: Essential for port scanning and service detection.
48+
* *Windows:* [Download Installer](https://nmap.org/download.html)
49+
* *Linux:* `sudo apt install nmap`
50+
* *MacOS:* `brew install nmap`
51+
52+
### 2. Offensive Tools (Optional but Recommended)
53+
* **Metasploit Framework**: Required to execute the auto-generated `.rc` attack scripts.
54+
* *Kali Linux:* Pre-installed.
55+
* *Windows:* [Download Metasploit](https://windows.metasploit.com/)
56+
57+
### 3. Browser Support
58+
* **Modern Web Browser**: Chrome, Firefox, or Edge (Required for the visual topology map and live terminal).
59+
60+
> **Note:** For the best experience, running Net-Sentry on **Kali Linux** or a specialized pentesting distro is recommended.
61+
62+
---
63+
64+
## Installation
65+
66+
Follow these steps to deploy the framework on your local machine or VPS.
67+
68+
### 1. Clone the Repository
69+
Get the latest source code from GitHub.
70+
```bash
71+
git clone https://github.com/trmxvibs/NetSentry-Framework
72+
cd Net-Sentry
73+
```
74+
### 2. Install Dependencies
75+
Install the required Python libraries (Flask, Requests, Vis.js support, etc.).
76+
```
77+
pip install -r requirements.txt
78+
```
79+
### 3. Initialize the Neural Core (Database)
80+
Run the setup script to create the SQLite database and the default admin user.
81+
```
82+
python database_setup.py
83+
```
84+
85+
### **Success Check:** You should see the message: [+] Default User Created: admin / password
86+
87+
---
88+
89+
## Usage: Web Command Console (GUI)
90+
91+
92+
### 1. Launch the System
93+
Start the web server:
94+
```bash
95+
python app.py
96+
```
97+
### Console Output: [+] Net-Sentry v29.0 Online. Access: http://127.0.0.1:5000
98+
99+
### 2. Access & Login
100+
Open your browser and navigate to http://127.0.0.1:5000.
101+
102+
Default Username: `admin`
103+
104+
Default Password: `password`
105+
106+
**Security Note: Change your password immediately using the ⚙️ SETTINGS button in the dashboard header.**
107+
---
108+
### 3. Dashboard Operations
109+
Live Terminal: Type commands directly into the browser console.
110+
111+
scan google.com advance (Initiates full spectrum scan)
112+
113+
man nmap (View cheat sheets)
114+
115+
ping 8.8.8.8 (Execute system commands)
116+
117+
`Tactical Maps: Toggle between [TOPO] (Network Graph) and [WORLD] (Geo-Map) using the buttons in the top-right panel.`
118+
119+
Intelligence: View real-time WAF status, CVE alerts, and harvested keys in the "Active Intel" box.
120+
121+
`Reports: Click the PDF button in the Mission Logs table to download a professional client report.`
122+
123+
---
124+
## Usage: CLI Tool (Terminal)
125+
126+
For security researchers who prefer a headless environment or need to integrate Net-Sentry into automated pipelines, the CLI tool offers full capabilities.
127+
128+
### 1. Basic Scan (Fast)
129+
Performs a quick port scan and basic intel gathering.
130+
```bash
131+
python cli_tool.py -t example.com
132+
```
133+
### 2. Advance Mode (Full Power)
134+
Activates all engines including Fuzzing, Spidering, Zone Transfer, and Vulnerability Checks.
135+
```
136+
python cli_tool.py -t example.com -m advance
137+
```
138+
### 3. Custom Operations
139+
Define your own Nmap flags for specific targeting.
140+
```
141+
python cli_tool.py -t example.com -m custom --flags "-p 80,443,8080 -sV --script=vuln"
142+
```
143+
### 4. Save Output
144+
Save the scan results to a text file for documentation.
145+
```
146+
python cli_tool.py -t example.com -m medium -o
147+
```
148+
##**Tip: The CLI tool uses the exact same engine as the web dashboard, ensuring consistent results across interfaces.**
149+
---
150+
151+
152+
## ⚠️ Legal Disclaimer
153+
154+
> **FOR EDUCATIONAL & AUTHORIZED USE ONLY.**
155+
>
156+
> Net-Sentry is a powerful security research tool. Scanning targets without prior mutual consent is illegal and punishable by law. The developers assume **no liability** and are not responsible for any misuse or damage caused by this program.
157+
>
158+
> * **Do not scan** government, military, or unauthorized corporate networks.
159+
> * **Do not use** for malicious purposes or black-hat hacking.
160+
> * **Always verify** findings manually before reporting to bug bounty programs.
161+
162+
---
163+
164+
## 👨‍💻 Credits
165+
166+
**Developed by:** Lokesh kumar
167+
**Version:** 29.0
168+
**License:** MIT License
169+
170+
---
171+
172+
173+
174+
175+
176+
177+
178+
179+
180+
181+
182+
183+
184+
185+
186+
187+
188+
189+
190+
191+

0 commit comments

Comments
 (0)