Importante. Varra apenas redes que você possui ou para as quais tenha autorização por escrito para varrer. O UltraViolet realiza reconhecimento passivo de serviços — ele não explora vulnerabilidades.

Por que UltraViolet

Locatário único, um único stack Docker Compose, controle total sobre seus dados.

✨ Recursos

Descoberta

• Scanner TCP connect com masscan ou zmap como motor de descoberta
• Sondas UDP em portas configuráveis
• Escopado por SCAN_ALLOWED_CIDRS com limites de host e porta

Sondas profundas (~100 protocolos)

• Web: HTTP/HTTPS, HTTP/3, GraphQL, hash de favicon, robots.txt, security.txt, stack de tecnologia
• TLS: cadeias de certificados, JARM, JA3S/JA4S, avaliação de configuração
• E-mail e diretórios: SMTP, POP3/IMAP, LDAP, IPMI
• Bancos de dados e filas: MySQL, PostgreSQL, MongoDB, Redis, Kafka, MQTT, NATS, AMQP…
• ICS/SCADA: Modbus, BACnet, DNP3, IEC 104, S7Comm, ENIP, OPC UA…
• IoT e mídia: ONVIF, RTSP, Chromecast, AirPlay, UPnP…
• Lista completa na documentação de protocolos

Enriquecimento

• DNS reverso, GeoIP (MMDB), ASN
• Descoberta opcional de DNS direto e logs de CT

CVE e risco

• Espelho local do NVD com sincronização em segundo plano e correspondência baseada em impressões digitais
• CISA KEV e FIRST EPSS

Operações

• RBAC (viewer / operator / admin), JWT + tokens de atualização
• Agendamentos de varredura, pausar/retomar, recuperação de órfãos após reinício do worker
• Prometheus /metrics, perfil opcional de Grafana
• Log de auditoria, limite de taxa, políticas de retenção

🏗 Arquitetura

flowchart TB
  Browser["Browser"]
  FE["service-frontend<br/>React + nginx"]
  API["uv-api<br/>REST · WS · metrics"]
  PG[("PostgreSQL 16")]
  SCAN["uv-scanner<br/>probe pipeline"]

  Browser --> FE
  FE -->|"/api"| API
  FE -->|"/realtime"| API
  API <--> PG
  SCAN <--> PG
  API -.->|LISTEN/NOTIFY| API

A imagem de UI do release faz proxy de /api/ e /realtime para uv-api — origem única, sem reconstrução do frontend por URL de API.

Regras de desenvolvimento do backend: CLAUDE.md.

🚀 Início rápido

Requisitos: Go 1.25+, Docker Engine ≥ 24, ~4 GB de RAM. As imagens de produção são voltadas para Linux amd64.

Executar pelo Docker Hub (sem compilar o código-fonte)

Caminho para iniciantes — baixe as imagens publicadas com service-env/docker-compose.registry.yml:

cd service-env
cp env.registry.example .env
# set POSTGRES_PASSWORD, AUTH_JWT_SECRET, AUTH_BOOTSTRAP_PASSWORD
mkdir -p geoip catalog-seed
docker compose -f docker-compose.registry.yml pull
docker compose -f docker-compose.registry.yml up -d
# UI → http://localhost:3000

Veja Docker Registry no site de documentação.

Desenvolver a partir do código-fonte

As imagens da API/scanner copiam binários pré-compilados de service-api/bin/ (eles não são compilados dentro do Docker). O make dev executa make -C service-api build-linux antes de docker compose … --build.

git clone https://github.com/yakushstanislav/UltraViolet.git
cd UltraViolet/service-env

cp .env.example .env
mkdir -p secrets
openssl rand -hex 32 > secrets/postgres_password
openssl rand -hex 32 > secrets/auth_jwt_secret

cd ..
make dev

Bootstrap de desenvolvimento: admin / admin (somente quando APP_ENV≠production).

📖 Documentação

Guia completo — VitePress em service-documentation-frontend/docs/:

make docs-dev    # → http://localhost:5173

Em produção, habilite o perfil docs:

cd service-env && docker compose --profile docs up -d
# → http://localhost:${UV_DOCUMENTATION_PORT:-3002}

Seções principais: instalação · varredura · API · implantação · instalação offline.

🛠 Desenvolvimento

Docker completo

make dev    # build-linux → compose prod + dev override --build

Recompile os binários Go após alterações no backend (make -C service-api build-linux) e reinicie ou execute novamente o make dev.

Modo híbrido (iteração mais rápida no backend)

make dev-db   # PostgreSQL only on :5432

cd service-api && make build
export LOGGER_NAME=uv-api LOGGER_DEBUG=true
export SERVER_ADDR=0.0.0.0 SERVER_PORT=8080
export METRICS_ADDR=0.0.0.0 METRICS_PORT=9090
export REALTIME_ADDR=0.0.0.0 REALTIME_PORT=8081
export POSTGRES_ADDR=localhost POSTGRES_PORT=5432
export POSTGRES_USERNAME=ultraviolet
export POSTGRES_PASSWORD="$(cat ../service-env/secrets/postgres_password)"
export POSTGRES_DATABASE=ultraviolet
export POSTGRES_SCHEMA_PATH="$(pwd)/deploy/migrations"
export AUTH_JWT_SECRET="$(cat ../service-env/secrets/auth_jwt_secret)"
./bin/uv-api

Frontend: cd service-frontend && npm run dev (o Vite faz proxy de /api → :8080 e /realtime → :8081).

GeoIP e CVE

cd service-env && make geoip-download      # IPLocate MMDB → geoip/
make -C service-env cve-catalog-dump       # CVE dump (requires running postgres)

Compilar sem Docker

make build && make lint && make frontend-build && make docs-build

📦 Release e instalação

Plataforma alvo: linux/amd64. No Apple Silicon, defina DOCKER_PLATFORM=linux/amd64 para arquivos offline.

git tag v0.1.0
make release VERSION=v0.1.0
make release-promote VERSION=v0.1.0   # :latest — required for local releases; GitHub Actions does this automatically

Online: extraia → cp .env.example .env → ./install.sh (baixar do registry).

Offline: ./install.sh (docker load, sem pull). Atualização: mantenha .env, secrets/ e o volume do Postgres → ./upgrade.sh.

Variáveis: UV_REGISTRY (padrão docker.io/styakush), DRY_RUN=1 — build de teste local sem push.

# from the build machine
scp dist/ultraviolet-v0.1.0-offline.tar.gz user@host:~/

# on the server (Docker ≥ 24, amd64)
tar xzf ultraviolet-v0.1.0-offline.tar.gz && cd ultraviolet-v0.1.0
cp .env.example .env
./install.sh

docker compose -f docker-compose.yml down
# back up .env + secrets/, extract the new archive, run ./upgrade.sh

✅ Checklist de produção

1. Guarde os segredos em secrets/, nunca no git.
2. Defina CORS_ALLOWED_ORIGINS apenas para as origens reais da UI.
3. Configure SCAN_ALLOWED_CIDRS e os limites de host/porta.
4. Altere a senha de bootstrap e o AUTH_JWT_SECRET (o install.sh rejeita placeholders).
5. Defina APP_ENV=production — o uv-api recusa admin/admin e senhas com menos de 8 caracteres.
6. Encerre o TLS em um proxy reverso — exemplo: service-env/examples/nginx-tls.conf.
7. Atrás de um proxy: defina AUDIT_TRUST_PROXY_HEADERS=true.
8. Faça backup do PostgreSQL: service-env/scripts/backup.sh + cron; o upgrade.sh também cria um dump.
9. Métricas em :9090/metrics; Grafana via perfil observability.
10. Atualize o GeoIP: service-env/scripts/geoip-refresh.sh em um cron mensal.

# docker-compose.override.yml
services:
  service-frontend:
    ports:
      - "127.0.0.1:3000:8080"

CORS_ALLOWED_ORIGINS=https://ultraviolet.example.com
AUDIT_TRUST_PROXY_HEADERS=true

VITE_BASE_PATH=/ultraviolet/ make frontend-build
# UV_BASE_PATH=/ultraviolet/ in compose — must match VITE_BASE_PATH

0 3 * * * cd /opt/ultraviolet/service-env && ./scripts/backup.sh && find backups -name 'uv-*.dump' -mtime +14 -delete

0 4 1 * * cd /opt/ultraviolet/service-env && ./scripts/geoip-refresh.sh >> /var/log/uv-geoip.log 2>&1

🔐 API e RBAC

Após POST /v1/auth/login, você recebe um access_token (Bearer) e um refresh_token (/v1/auth/refresh).

GET /v1/me · GET /v1/version · GET /readyz (health + versão + commit).

🤝 Contribuição

Veja CONTRIBUTING.md. Relatos de segurança: SECURITY.md. Padrões da comunidade: CODE_OF_CONDUCT.md.

📄 Licença

O UltraViolet é distribuído sob a Licença MIT.

_{UltraViolet — descubra o que você possui, entenda o que mudou, mantenha-o na sua rede.}