Update README.md
Browse files
README.md
CHANGED
|
@@ -1,39 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# MayOne Security Framework
|
| 2 |
|
| 3 |
-
**AI
|
|
|
|
|
|
|
| 4 |
|
| 5 |
-
|
| 6 |
|
| 7 |
## Features
|
| 8 |
|
| 9 |
-
- Real‑time packet capture
|
| 10 |
-
-
|
| 11 |
-
-
|
| 12 |
-
-
|
| 13 |
-
-
|
| 14 |
-
-
|
| 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 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language: en
|
| 3 |
+
license: mit
|
| 4 |
+
tags:
|
| 5 |
+
- network-security
|
| 6 |
+
- intrusion-detection
|
| 7 |
+
- windows
|
| 8 |
+
- cybersecurity
|
| 9 |
+
- ai
|
| 10 |
+
- anomaly-detection
|
| 11 |
+
library_name: custom
|
| 12 |
+
pipeline_tag: text-classification
|
| 13 |
+
---
|
| 14 |
+
|
| 15 |
# MayOne Security Framework
|
| 16 |
|
| 17 |
+
**AI-powered network intrusion detection and response framework for Windows**
|
| 18 |
+
|
| 19 |
+
## Overview
|
| 20 |
|
| 21 |
+
MayOne Security Framework is a lightweight, AI‑driven solution for real‑time network traffic analysis, anomaly detection, and automated response on Windows systems. It combines machine learning models with rule‑based heuristics to identify and mitigate intrusions (e.g., port scans, brute force attempts, malware C2 traffic) with minimal false positives.
|
| 22 |
|
| 23 |
## Features
|
| 24 |
|
| 25 |
+
- **Real‑time packet capture** – uses WinPcap/Npcap to monitor live traffic.
|
| 26 |
+
- **AI detection engine** – pre‑trained model (isolation forest / autoencoder) for anomaly scoring.
|
| 27 |
+
- **Signature‑based rules** – complementary Snort‑compatible rule set.
|
| 28 |
+
- **Automated response** – block IPs via Windows Firewall, kill malicious processes, or trigger custom scripts.
|
| 29 |
+
- **Dashboard** (optional) – simple CLI or GUI to view alerts.
|
| 30 |
+
- **Low resource usage** – designed to run on endpoints or small servers.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 31 |
|
| 32 |
## Installation
|
| 33 |
|
| 34 |
+
### Prerequisites
|
| 35 |
+
- Windows 10 / 11 / Server 2019+
|
| 36 |
+
- [Npcap](https://npcap.com/) (loopback capture is optional)
|
| 37 |
+
- Python 3.9+ (if running from source)
|
| 38 |
+
|
| 39 |
+
### Download the model / framework
|
| 40 |
+
```bash
|
| 41 |
+
git lfs install
|
| 42 |
+
git clone https://huggingface.co/theghostcmd/MayOne-Security-Framework
|
| 43 |
+
cd MayOne-Security-Framework
|
| 44 |
+
pip install -r requirements.txt
|
| 45 |
+
python main.py
|