Bandjacks

Système de modélisation mondiale de la défense contre les cybermenaces

Aperçu

Bandjacks est un système complet de renseignement sur les cybermenaces (CTI) qui :

• Extrait les techniques MITRE ATT&CK des rapports de menaces en 12 à 40 secondes
• Construit un graphe de connaissances des acteurs de menace, techniques et défenses
• Génère des bundles conformes STIX 2.1 avec suivi complet de la provenance
• Intègre l'ontologie D3FEND pour des recommandations défensives
• Fournit des capacités de recherche vectorielle et d'analyse de graphes
• Calcule les analytiques de co-occurrence pour identifier les modèles de techniques
• Offre une extraction 94% plus rapide que les versions antérieures avec mise en cache des réponses LLM
• Inclut un frontend Next.js pour la révision des rapports et la visualisation des analytiques

📚 Documentation

Guide	Description
Démarrage rapide	Lancez-vous en 5 minutes
Configuration complète	Configuration complète de l'environnement
Utilisation CLI	Guide de l'interface en ligne de commande
Référence API	Documentation de l'API REST
Analytiques de co-occurrence	Documentation des analytiques
Génération AttackFlow	Guide de génération de flux
Système de révision	Révision avec intervention humaine

Points forts de l'architecture

TechniqueCache

• Cache en mémoire de toutes les techniques MITRE ATT&CK chargées au démarrage
• Recherches O(1) par external_id (ex. T1557) pour une résolution instantanée du nom
• 1376 techniques mises en cache avec métadonnées complètes (nom, description, tactiques, plateformes)
• Nommage cohérent garantit que l'interface de révision affiche toujours des noms de techniques lisibles

ActorCache

• Cache en mémoire de tous les ensembles d'intrusion et acteurs de menace
• Recherches rapides pour la résolution et la recherche de noms d'acteurs
• Prend en charge la correspondance d'alias et la recherche floue

Démarrage rapide

Prérequis

• Python 3.11+
• Neo4j 5.x (base de données graphe)
• OpenSearch 2.x (stockage vectoriel)
• Redis (optionnel, pour la mise en cache)
• Node.js 18+ (pour le frontend)
• Accès LLM : clés API cloud (Gemini ou OpenAI) ou un serveur local compatible OpenAI

Installation```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 ..

### Configuration de l'environnement

**IMPORTANT :** Vous devez configurer les variables d'environnement avant de démarrer l'application. L'application nécessite que `NEO4J_PASSWORD` soit défini.

Créez un fichier `.env` à la racine du projet :```bash
# Copy the sample file
cp infra/env.sample .env

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

Configuration requise dans .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

**Note:** L'application ne démarrera pas si `NEO4J_PASSWORD` n'est pas défini. Consultez [Environment Variables Fix](https://github.com/blevene/bandjacks/blob/main/ENV_VARIABLES_FIX.md) pour plus de détails.

### Démarrage des services```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

Interface en ligne de commande (CLI)

Bandjacks comprend une CLI complète pour les opérations de renseignement sur les menaces :```bash

Show all available commands

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

> **Note :** La CLI nécessite que les variables d'environnement soient définies (NEO4J_PASSWORD, etc.). Exécutez depuis la racine du projet où se trouve `.env`.

### Commandes de requête```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

Gestion de la file d'attente de révision```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"

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

Commandes d'analyse

Note : Les commandes d'analyse nécessitent des données AttackEpisode dans Neo4j pour renvoyer des résultats.```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

### Commandes de workflow```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/

Commandes d'administration```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:*"