Bandjacks

Sistema de Modelado Mundial de Defensa contra Amenazas Cibernéticas

Resumen

Bandjacks es un sistema integral de inteligencia de amenazas cibernéticas (CTI) que:

• Extrae técnicas MITRE ATT&CK de informes de amenazas en 12-40 segundos
• Construye un grafo de conocimiento de actores de amenazas, técnicas y defensas
• Genera paquetes compatibles con STIX 2.1 con seguimiento completo de procedencia
• Integra la ontología D3FEND para recomendaciones defensivas
• Proporciona capacidades de búsqueda vectorial y análisis de grafos
• Calcula análisis de co-ocurrencia para identificar patrones de técnicas
• Ofrece una extracción 94% más rápida que versiones anteriores con almacenamiento en caché de respuestas LLM
• Incluye un frontend en Next.js para revisión de informes y visualización de análisis

📚 Documentación

Guía	Descripción
Inicio Rápido	Póngase en marcha en 5 minutos
Configuración Completa	Configuración completa del entorno
Uso de CLI	Guía de interfaz de línea de comandos
Referencia de API	Documentación de la API REST
Análisis de Co-ocurrencia	Documentación de análisis
Generación de AttackFlow	Guía de generación de flujo
Sistema de Revisión	Revisión con intervención humana

Aspectos Destacados de la Arquitectura

TechniqueCache

• Caché en memoria de todas las técnicas MITRE ATT&CK cargadas al iniciar
• Búsquedas O(1) por external_id (ej., T1557) para resolución instantánea de nombres
• 1376 técnicas almacenadas en caché con metadatos completos (nombre, descripción, tácticas, plataformas)
• Nomenclatura consistente asegura que la interfaz de revisión siempre muestre nombres de técnicas legibles por humanos

ActorCache

• Caché en memoria de todos los conjuntos de intrusiones y actores de amenazas
• Búsquedas rápidas para resolución de nombres de actores y búsqueda
• Soporta coincidencia de alias y búsqueda difusa

Inicio Rápido

Requisitos Previos

• Python 3.11+
• Neo4j 5.x (base de datos de grafos)
• OpenSearch 2.x (almacén vectorial)
• Redis (opcional, para almacenamiento en caché)
• Node.js 18+ (para el frontend)
• Acceso a LLM: claves de API en la nube (Gemini u OpenAI) o un servidor local compatible con OpenAI

Instalación```bash

Clone the repository

git clone https://github.com/yourusername/bandjacks.git cd bandjacks

Install Python dependencies with uv (recommended)

uv sync

Or with pip

pip install -e .

Install frontend dependencies

cd ui && npm install && cd ..

### Configuración del Entorno

**IMPORTANTE:** Debes configurar las variables de entorno antes de iniciar la aplicación. La aplicación requiere que `NEO4J_PASSWORD` esté configurada.

Crea un archivo `.env` en la raíz del proyecto:```bash
# Copy the sample file
cp infra/env.sample .env

# Edit .env and set your actual passwords
nano .env

Configuración requerida en .env:```bash

Neo4j Configuration (REQUIRED)

NEO4J_URI=bolt://localhost:7687 NEO4J_USER=neo4j NEO4J_PASSWORD=your-actual-neo4j-password # MUST BE SET - no default provided

OpenSearch Configuration

OPENSEARCH_URL=http://localhost:9200 OPENSEARCH_USER=admin OPENSEARCH_PASSWORD=your-opensearch-password # Optional if security is disabled

LLM Configuration — pick ONE of the options below:

Option A: Local OpenAI-compatible API (vLLM, llama.cpp, Ollama, LocalAI, LM Studio, etc.)

LOCAL_LLM_API_BASE=http://192.168.1.100:8080/v1 # Base URL of your local server LOCAL_LLM_MODEL=mistral-nemo # Model name as the server reports it LOCAL_LLM_API_KEY=no-key # Most local servers accept any value

Option B: Cloud LLM providers

PRIMARY_LLM=gemini GOOGLE_API_KEY=your-gemini-api-key

Optional: OpenAI as fallback (or primary if PRIMARY_LLM=openai)

OPENAI_API_KEY=your-openai-api-key

ATT&CK Configuration

ATTACK_INDEX_URL=https://raw.githubusercontent.com/mitre-attack/attack-stix-data/master/index.json ATTACK_COLLECTION=enterprise-attack ATTACK_VERSION=latest

Redis (optional, for caching)

REDIS_URL=redis://localhost:6379

**Nota:** La aplicación fallará al iniciar si `NEO4J_PASSWORD` no está configurada. Consulte [Solución de variables de entorno](https://github.com/blevene/bandjacks/blob/main/ENV_VARIABLES_FIX.md) para más detalles.

### Iniciando los Servicios```bash
# Start the FastAPI backend server
uv run uvicorn bandjacks.services.api.main:app --reload --port 8000

# In another terminal, start the Next.js frontend
cd ui && npm run dev

# Access the applications
open http://localhost:8000/docs    # API documentation
open http://localhost:3000         # Frontend UI

Interfaz de Línea de Comandos (CLI)

Bandjacks incluye una CLI completa para operaciones de inteligencia de amenazas:```bash

Show all available commands

uv run python -m bandjacks.cli.main --help

> **Nota:** The CLI requiere que se configuren variables de entorno (NEO4J_PASSWORD, etc.). Ejecútalo desde la raíz del proyecto donde se encuentra `.env`.

### Comandos de Consulta```bash
# Search for threat intelligence
uv run python -m bandjacks.cli.main query search "ransomware encryption techniques" --top-k 10

# Explore graph relationships
uv run python -m bandjacks.cli.main query graph "attack-pattern--abc123" --depth 2

Gestión de la cola de revisión```bash

Show review queue

uv run python -m bandjacks.cli.main review queue --status pending --limit 20

Approve a candidate

uv run python -m bandjacks.cli.main review approve "candidate-123" --reviewer analyst-1

Reject with reason

uv run python -m bandjacks.cli.main review reject "candidate-456" --reviewer analyst-1 --reason "False positive"

### Extracción de Documentos```bash
# Extract CTI from a document
uv run python -m bandjacks.cli.main extract document ./report.pdf --confidence-threshold 80 --show-evidence

Comandos de análisis

Nota: Los comandos de análisis requieren datos de AttackEpisode en Neo4j para devolver resultados.```bash

Show top co-occurring technique pairs

uv run python -m bandjacks.cli.main analytics top-cooccurrence --limit 25 --min-episode-size 2

Compute conditional co-occurrence P(B|A) for a technique

uv run python -m bandjacks.cli.main analytics conditional "attack-pattern--abc123" --limit 25

Analyze a specific threat actor

uv run python -m bandjacks.cli.main analytics actor "intrusion-set--xyz789" --metric npmi

Extract technique bundles

uv run python -m bandjacks.cli.main analytics bundles --min-support 3 --min-size 3 --max-size 5 --format json --output bundles.json

Global co-occurrence metrics

uv run python -m bandjacks.cli.main analytics global --min-support 2 --limit 50 --format csv --output pairs.csv

### Comandos de flujo de trabajo```bash
# Process a directory of reports with analytics
uv run python -m bandjacks.cli.main workflow process-reports ./reports/ --workers 3 --analyze --export-dir ./results/

# Bulk export all analytics data
uv run python -m bandjacks.cli.main workflow bulk-export --export-dir ./analytics_export/

Comandos de administración```bash

Check system health

uv run python -m bandjacks.cli.main admin health

View cache statistics

uv run python -m bandjacks.cli.main admin cache-stats

Clear cache

uv run python -m bandjacks.cli.main admin cache-clear --pattern "search:*"

Optimize database

uv run python -m bandjacks.cli.main admin optimize

## Frontend UI