theghostcmd commited on
Commit
63b6797
·
verified ·
1 Parent(s): 5765e13

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +38 -38
README.md CHANGED
@@ -1,39 +1,39 @@
1
- # MayOne Security Framework
2
-
3
- **AI‑powered Intrusion Detection & Response for Windows**
4
-
5
- ![Dashboard Preview](docs/dashboard.png)
6
-
7
- ## Features
8
-
9
- - Real‑time packet capture (Scapy)
10
- - Rule‑based threat detection (port scan, brute force, DDoS, bursts)
11
- - AI anomaly detection (Isolation Forest) – learns normal traffic
12
- - Risk scoring (0–100) with threat levels: LOW, MEDIUM, HIGH, CRITICAL
13
- - Automatic IP blocking via Windows Firewall (inbound+outbound)
14
- - SQLite database for events, threats, blocked IPs, reports
15
- - Live Flask dashboard with:
16
- - Traffic statistics
17
- - Protocol distribution & top ports charts
18
- - Recent threats table
19
- - Manual IP block/unblock
20
- - Geo‑IP blocking (optional, MaxMind GeoLite2)
21
- - Scheduled & emergency PDF reports (with logo watermark)
22
- - PCAP export (full buffer)
23
- - Multithreaded, thread‑safe, low CPU usage
24
-
25
- ## Requirements
26
-
27
- - Windows 10/11 (or Windows Server)
28
- - Python 3.10 or higher
29
- - Npcap (with WinPcap API compatibility) – [Download](https://npcap.com)
30
- - Administrator privileges (for sniffing and firewall changes)
31
-
32
- ## Installation
33
-
34
- 1. Clone the repository:
35
- ```bash
36
- git clone https://github.com/yourusername/MayOne-Security-Framework.git
37
- cd MayOne-Security-Framework
38
- pip install -r requirements.txt
39
  python main.py
 
1
+ # MayOne Security Framework
2
+
3
+ **AI‑powered Intrusion Detection & Response for Windows**
4
+
5
+ ![Dashboard Preview](doc/dashboard.png)
6
+
7
+ ## Features
8
+
9
+ - Real‑time packet capture (Scapy)
10
+ - Rule‑based threat detection (port scan, brute force, DDoS, bursts)
11
+ - AI anomaly detection (Isolation Forest) – learns normal traffic
12
+ - Risk scoring (0–100) with threat levels: LOW, MEDIUM, HIGH, CRITICAL
13
+ - Automatic IP blocking via Windows Firewall (inbound+outbound)
14
+ - SQLite database for events, threats, blocked IPs, reports
15
+ - Live Flask dashboard with:
16
+ - Traffic statistics
17
+ - Protocol distribution & top ports charts
18
+ - Recent threats table
19
+ - Manual IP block/unblock
20
+ - Geo‑IP blocking (optional, MaxMind GeoLite2)
21
+ - Scheduled & emergency PDF reports (with logo watermark)
22
+ - PCAP export (full buffer)
23
+ - Multithreaded, thread‑safe, low CPU usage
24
+
25
+ ## Requirements
26
+
27
+ - Windows 10/11 (or Windows Server)
28
+ - Python 3.10 or higher
29
+ - Npcap (with WinPcap API compatibility) – [Download](https://npcap.com)
30
+ - Administrator privileges (for sniffing and firewall changes)
31
+
32
+ ## Installation
33
+
34
+ 1. Clone the repository:
35
+ ```bash
36
+ git clone https://github.com/yourusername/MayOne-Security-Framework.git
37
+ cd MayOne-Security-Framework
38
+ pip install -r requirements.txt
39
  python main.py