Bandjacks

Sistema de Modelagem Mundial de Defesa contra Ameaças Cibernéticas

Visão Geral

Bandjacks é um sistema abrangente de inteligência de ameaças cibernéticas (CTI) que:

• Extrai técnicas MITRE ATT&CK de relatórios de ameaças em 12 a 40 segundos
• Constrói um grafo de conhecimento de atores de ameaças, técnicas e defesas
• Gera pacotes compatíveis com STIX 2.1 com rastreamento completo de proveniência
• Integra a ontologia D3FEND para recomendações defensivas
• Fornece recursos de busca vetorial e análise de grafos
• Calcula análises de co-ocorrência para identificar padrões de técnicas
• Apresenta extração 94% mais rápida que versões anteriores com caching de respostas LLM
• Inclui um frontend Next.js para revisão de relatórios e visualização de análises

📚 Documentação

Guia	Descrição
Início Rápido	Comece a usar em 5 minutos
Configuração Completa	Configuração completa do ambiente
Uso da CLI	Guia da interface de linha de comando
Referência da API	Documentação da API REST
Análises de Co-ocorrência	Documentação de análises
Geração de AttackFlow	Guia de geração de fluxos
Sistema de Revisão	Revisão com supervisão humana

Destaques da Arquitetura

TechniqueCache

• Cache em memória de todas as técnicas MITRE ATT&CK carregadas na inicialização
• Consultas O(1) por external_id (ex.: T1557) para resolução instantânea de nomes
• 1376 técnicas armazenadas em cache com metadados completos (nome, descrição, táticas, plataformas)
• Nomenclatura consistente garante que a interface de revisão sempre mostre nomes de técnicas legíveis por humanos

ActorCache

• Cache em memória de todos os conjuntos de intrusão e atores de ameaças
• Consultas rápidas para resolução de nomes de atores e pesquisa
• Suporta correspondência de alias e pesquisa difusa

Início Rápido

Pré-requisitos

• Python 3.11+
• Neo4j 5.x (banco de dados de grafo)
• OpenSearch 2.x (armazenamento vetorial)
• Redis (opcional, para cache)
• Node.js 18+ (para frontend)
• Acesso LLM: chaves de API em nuvem (Gemini ou OpenAI) ou um servidor local compatível com OpenAI

Instalação```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 ..

### Configuração do Ambiente

**IMPORTANTE:** Você deve configurar as variáveis de ambiente antes de iniciar a aplicação. A aplicação requer que `NEO4J_PASSWORD` seja definida.

Crie um arquivo `.env` na raiz do projeto:```bash
# Copy the sample file
cp infra/env.sample .env

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

Configuração necessária no .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:** O aplicativo falhará ao iniciar se `NEO4J_PASSWORD` não estiver definida. Consulte [Correção de Variáveis de Ambiente](https://github.com/blevene/bandjacks/blob/main/ENV_VARIABLES_FIX.md) para mais detalhes.

### Iniciando os Serviços```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 de Linha de Comando (CLI)

Bandjacks inclui uma CLI abrangente para operações de inteligência de ameaças:```bash

Show all available commands

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

> **Nota:** A CLI requer que variáveis de ambiente sejam definidas (NEO4J_PASSWORD, etc.). Execute a partir da raiz do projeto onde o `.env` está localizado.

### 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

Gerenciamento de Fila de Revisão```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"

### Extração 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álise

Nota: Comandos de análise requerem dados AttackEpisode no Neo4j para retornar 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 Fluxo de Trabalho```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 Administrador```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

## Interface do Frontend

O frontend Next.js fornece uma interface moderna para trabalhar com o sistema.