
Una plataforma de monitoreo de red basada en eventos que realiza captura de paquetes en vivo (Npcap), análisis de tráfico de baja latencia y detección de amenazas no supervisada mediante un Autoencoder de PyTorch, respaldada por un motor de alertas asíncrono multicanal.
# NetSentryx PRO 🛡️
**Motor de Detección de Amenazas y Observabilidad de Red en Tiempo Real de Alto Rendimiento Impulsado por IA**
[](https://fastapi.tiangolo.com)
[](https://pytorch.org)
[](https://python.org)
[](https://opensource.org/licenses/MIT)
[](#)
NetSentryx PRO es una plataforma de inteligencia de amenazas y monitoreo de red basada en eventos de próxima generación. Combinando firmas basadas en reglas con un Autoencoder Profundo de PyTorch, proporciona detección de anomalías en paquetes y netflow en menos de 10 ms, alertas automatizadas multicanal (Slack, Discord, Email) y un panel SOC interactivo en tiempo real.
---
## 🏗️ Arquitectura del Sistema
El siguiente diagrama de flujo ilustra la ingesta de datos, la inferencia de aprendizaje profundo en tiempo real, el pipeline de alertas y la capa de visualización WebSocket:
```mermaid
flowchart TD
subgraph Capture & Ingestion
A[Network Interface / Packet Simulator] -->|Raw Traffic Events| B(Lightweight Event Bus)
B -->|Packet Stream| C[Flow Aggregation Engine]
end
subgraph Deep Learning Inference
C -->|Aggregated Telemetry Vectors| D[PyTorch TrafficAutoencoder]
D -->|MSE Reconstruction Loss| E{Threshold Evaluation}
end
subgraph Alert Dispatch
E -->|No Anomaly| F[Status: Optimal]
E -->|Anomaly Detected| G[FastAPI BackgroundTasks]
G -->|Save Event| H[(SQLite Datastore)]
G -->|Broadcast WebSocket| I[HTML Live Dashboard]
G -->|Dispatch Webhooks| J[Slack / Discord / Custom Webhook]
G -->|Dispatch SMTP| K[Email Alerting]
end
style D fill:#EE4C2C,stroke:#fff,stroke-width:2px,color:#fff
style I fill:#005571,stroke:#fff,stroke-width:2px,color:#fff
style G fill:#00bf8f,stroke:#fff,stroke-width:2px,color:#fff
```
---
## 🚀 Características Principales
* ⚡ **Ingesta de Tráfico en Tiempo Real:** Agrega tramas de paquetes en resúmenes de netflow enriquecidos sobre la marcha con latencia mínima.
* 🧠 **Detección de Anomalías con Autoencoder Profundo de PyTorch:** Utiliza una red neuronal ligera de PyTorch (`TrafficAutoencoder`) para detectar exploits zero-day sofisticados, escaneos o ataques DDoS basándose en el error de reconstrucción de características multivariadas.
* 📈 **Inicio Sin Entrenamiento Manual:** Incluye ajuste sintético automatizado y calibración estadística de umbrales (`Mean + 3 * Std`) durante el arranque del servidor, lo que lo hace totalmente funcional desde el primer uso.
* ⏱️ **Latencia de Inferencia Inferior a 10 ms:** El pipeline de inferencia optimizado garantiza la evaluación en tiempo real de flujos de paquetes de alto rendimiento.
* 📣 **Despacho de Alertas Multicanal:** Envía asíncronamente alertas detalladas de intrusión a **webhooks de Slack**, **webhooks de Discord**, **APIs HTTP personalizadas** y **correos SMTP** utilizando `BackgroundTasks` de FastAPI.
* 📊 **Panel SOC Interactivo:** Elegante panel en modo oscuro impulsado por Tailwind CSS, Chart.js y WebSockets para la visualización en tiempo real de métricas de rendimiento y feeds de amenazas en vivo.
---
## 📁 Estructura del Proyecto
```bash
NetSentryx/
├── config/
│ ├── config.yaml # System, dashboard, and alerting channel configurations
│ └── rules.yaml # Threat detection thresholds and rule properties
├── src/
│ ├── alerts/
│ │ ├── ml_detection.py # PyTorch TrafficAutoencoder & feature scaling
│ │ ├── manager.py # Async alert dispatcher (Discord, Slack, Email)
│ │ └── detection.py # Rule-based packet signature detection engine
│ ├── core/
│ │ ├── config_loader.py # Configuration loader utilities
│ │ ├── logger.py # Database-integrated system logger
│ │ └── time_utils.py # Timezone-aware timestamp utilities
│ ├── dashboard/
│ │ ├── templates/
│ │ │ └── index.html # Live HTML5 Dashboard template
│ │ └── server.py # FastAPI API Router and WebSocket broadcast controller
│ ├── database/
│ │ ├── manager.py # SQLite connection & database actions
│ │ └── models.py # SQLAlchemy schema definitions (Alerts, Logs, Flows)
│ ├── flows/
│ │ ├── capture.py # Scapy packet sniffer thread
│ │ └── processor.py # Flow aggregation and metric extractor
│ └── main.py # Application entrypoint
└── main.py # Root script runner
```
---
## 🛠️ Guía de Inicio Rápido y Configuración
### 1. Requisitos Previos
Asegúrate de tener **Python 3.10+** instalado. Si vas a capturar interfaces de red en vivo:
* **Windows:** Instala [Npcap](https://npcap.com/) (selecciona "Install Npcap in WinPcap API-compatible Mode").
* **Linux:** Instala `libpcap-dev` mediante `sudo apt-get install libpcap-dev`.
### 2. Instalación
Clona el repositorio e instala las dependencias (se recomienda encarecidamente usar `uv` para una instalación más rápida):
```bash
# Clone the repository
git clone https://github.com/yourusername/netsentryx.git
cd netsentryx
# Create virtual environment
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install requirements
pip install -r requirements.txt
```
### 3. Configuración del Entorno (`.env`)
Crea un archivo `.env` en la raíz del proyecto para configurar las credenciales de notificación:
```ini
# Discord Configuration
DISCORD_ENABLED=true
DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/your-webhook-id/your-webhook-token"
# Slack Configuration
SLACK_ENABLED=true
SLACK_WEBHOOK_URL="https://hooks.slack.com/services/YOUR_WORKSPACE_ID/YOUR_CHANNEL_ID/YOUR_SECRET_TOKEN"
# SMTP Email Configuration
SMTP_ENABLED=true
SMTP_SERVER="smtp.gmail.com"
SMTP_PORT=587
SMTP_USERNAME="[email protected]"
SMTP_PASSWORD="your-app-password"
SMTP_FROM_EMAIL="[email protected]"
SMTP_TO_EMAIL="[email protected]"
```
### 4. Ejecución de la Plataforma
#### 🧪 Modo Simulación (Incluye simulador de tráfico sintético)
```bash
python main.py --simulate
```
#### 🌐 Modo Sniffing en Vivo (Requiere privilegios de administrador/sudo)
```bash
python main.py
```
Abre tu navegador y navega a `http://localhost:8000` para ver el panel en vivo.
---
## 📖 Documentación de la API
### Endpoint de Telemetría e Inferencia
* **URL:** `/api/v1/telemetry/analyze`
* **Método:** `POST`
* **Content-Type:** `application/json`
#### Payload de la Solicitud
```json
{
"packet_count": 550,
"byte_count": 850000,
"flow_duration": 4.5,
"syn_flag_ratio": 0.85,
"port_entropy": 3.2,
"byte_rate": 188888.8,
"source_ip": "192.168.1.120",
"dest_ip": "10.0.0.5",
"protocol": "TCP"
}
```
#### Respuesta (Tráfico Normal)
```json
{
"status": "NORMAL",
"threat_level": "low",
"anomaly_score": 0.3083,
"threshold": 2.1319
}
```
#### Respuesta (Tráfico Anómalo)
```json
{
"status": "ANOMALOUS",
"threat_level": "critical",
"anomaly_score": 117999.03,
"threshold": 2.1319,
"alert": {
"id": 12,
"timestamp": "2026-08-05T14:13:31.373Z",
"rule_id": "ml_autoencoder_anomaly",
"rule_name": "ML Autoencoder Anomaly",
"source_ip": "192.168.1.120",
"severity": "critical",
"description": "Deep autoencoder reconstruction error exceeded anomaly threshold (score: 117999.0300, threshold: 2.1320).",
"metrics": { ... }
}
}
```
### Consultas Históricas
| Endpoint | Método | Descripción | Respuesta de Ejemplo |
| :--- | :--- | :--- | :--- |
| `/api/alerts` | `GET` | Obtiene las alertas de amenazas recientes guardadas en la BD | `[{"id": 1, "rule_name": "Port Scanning", ...}]` |
| `/api/flows` | `GET` | Obtiene los registros recientes de telemetría de flujos de red | `[{"source_ip": "192.168.1.10", "packet_count": 45, ...}]` |
| `/api/logs` | `GET` | Obtiene los registros de auditoría del sistema backend | `[{"level": "INFO", "message": "ML engine trained...", ...}]` |
---
## 🛡️ Licencia
Este proyecto está licenciado bajo la Licencia MIT - consulta el archivo [LICENSE](https://github.com/aman-sharma-dev/netsentryx/blob/main/LICENSE) para más detalles.