Primeira varredura, em 2 minutos.
Instale a CLI open source do WOMBATpass, baixe os controles do Wombat e analise um arquivo Terraform de exemplo. Sem credenciais de nuvem, sem caixa-preta: apenas análise estática do seu Infrastructure as Code.
Prefere uma linha só? O instalador configura a CLI e os controles para você.
$curl -fsSL https://wombat-cli.dev/install.sh | sh
$irm https://wombat-cli.dev/install.ps1 | iex
Um caminho claro para cada caso de uso.
Comece com o quickstart da CLI de 2 minutos. Troque de aba quando estiver pronto para o painel, a CI ou a configuração manual.
Obtenha seu primeiro resultado em 2 minutos.
Siga os quatro passos abaixo. Cada comando foi pensado para dar um resultado garantido e legível já na primeira tentativa.
Instalar a CLI
O WOMBATpass está publicado no PyPI como wafpass-core. Recomenda-se Python 3.11+.
$pip install wafpass-core
$wombat --version
Baixar os controles
O catálogo de controles do Wombat contém as mais de 100 regras que o WOMBATpass usa para avaliar seu código.
$git clone https://github.com/WAF2p/framework.git controls-src
$cp -r controls-src/modules/controls/controls ./controls
Recomendado: clone o repositório de controles. Alternativa: baixe o zip de controles na página do WOMBATpass e extraia-o em controls/.
Salvar um arquivo Terraform de exemplo
Crie um main.tfmínimo. Este exemplo deixa de propósito um bucket S3 público para que o WOMBATpass tenha algo a apontar.
provider "aws" {
region = "eu-central-1"
}
resource "aws_s3_bucket" "public" {
bucket = "wafpp-first-check-demo"
}
resource "aws_s3_bucket_public_access_block" "public" {
bucket = aws_s3_bucket.public.id
block_public_acls = false
block_public_policy = false
ignore_public_acls = false
restrict_public_buckets = false
}
Executar sua primeira verificação
Aponte o WOMBATpass para o diretório atual e imprima o resumo em JSON.
$wombat check . --output json | jq '.summary'
Você deve ver uma saída como esta:
{
"total_controls": 100,
"passed": 98,
"failed": 2,
"pillars": {
"security": { "passed": 18, "failed": 2 }
}
}
O mesmo resultado, visualizado, se você adicionar o painel depois:
Rode o painel completo localmente.
O monorepo WAF2p/pass traz um docker-compose.ymlunificado. Ele sobe a CLI, o servidor, o painel, o PostgreSQL e o Keycloak com um único comando.
$git clone https://github.com/WAF2p/pass.git
$cd pass
$cp .env.example .env
$# Edit .env, set POSTGRES_PASSWORD, WAFPASS_JWT_SECRET, etc.
$docker compose up -d
| Serviço | URL | Descrição |
|---|---|---|
| wafpass-dashboard | http://localhost:3000 | Painel em React |
| wafpass-server | http://localhost:8000 | FastAPI REST API |
| Keycloak (SSO) | http://localhost:8080 | Provedor de identidade (admin / admin) |
| postgres | localhost:5432 | Banco de dados PostgreSQL |
Quando os contêineres estiverem saudáveis, preencha sua primeira visão do painel com o comando demo ou enviando um resultado de varredura:
$wombat demo # creates sample data and opens the dashboard
$open http://localhost:3000
Ver o docker-compose.yml completo
services:
# ── PostgreSQL ────────────────────────────────────────────
postgres:
image: postgres:16-alpine
restart: unless-stopped
environment:
POSTGRES_USER: ${POSTGRES_USER:-wafpass}
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-wafpass}
POSTGRES_DB: ${POSTGRES_DB:-wafpass}
volumes:
- postgres_data:/var/lib/postgresql/data
- ./keycloak/init.sql:/docker-entrypoint-initdb.d/01-keycloak-db.sql:ro
ports:
- "${POSTGRES_PORT:-5432}:5432"
healthcheck:
test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER:-wafpass} -d ${POSTGRES_DB:-wafpass}"]
interval: 5s
timeout: 5s
retries: 10
# ── wafpass-server ────────────────────────────────────────
wafpass-server:
build:
context: .
dockerfile: wafpass-server/Dockerfile
restart: unless-stopped
depends_on:
postgres:
condition: service_healthy
environment:
DATABASE_URL: postgresql+asyncpg://${POSTGRES_USER:-wafpass}:${POSTGRES_PASSWORD:-wafpass}@postgres:5432/${POSTGRES_DB:-wafpass}
WAFPASS_ENV: ${WAFPASS_ENV:-local}
CORS_ORIGINS: ${API_URL:-http://localhost:3000},http://wafpass-dashboard,http://cloud.waf2p
WAFPASS_CONTROLS_DIR: ${WAFPASS_CONTROLS_DIR:-/app/controls}
WAFPASS_JWT_SECRET: ${WAFPASS_JWT_SECRET:-change-me-in-production}
WAFPASS_JWT_EXPIRE_MINUTES: ${WAFPASS_JWT_EXPIRE_MINUTES:-60}
WAFPASS_JWT_REFRESH_DAYS: ${WAFPASS_JWT_REFRESH_DAYS:-7}
WAFPASS_ADMIN_USERNAME: ${WAFPASS_ADMIN_USERNAME:-admin}
WAFPASS_ADMIN_PASSWORD: ${WAFPASS_ADMIN_PASSWORD:-admin}
WAFPASS_ADMIN_ROLE: ${WAFPASS_ADMIN_ROLE:-admin}
WAFPASS_API_KEY: ${WAFPASS_API_KEY:-key}
ports:
- "8000:8000"
# ── Keycloak (SSO / IdP — dev mode) ──────────────────────
keycloak:
image: quay.io/keycloak/keycloak:26.1
command: start-dev
restart: unless-stopped
depends_on:
postgres:
condition: service_healthy
environment:
KC_DB: postgres
KC_DB_URL: jdbc:postgresql://postgres:5432/${KEYCLOAK_DB:-keycloak}
KC_DB_USERNAME: ${KEYCLOAK_DB_USER:-keycloak}
KC_DB_PASSWORD: ${KEYCLOAK_DB_PASSWORD:-keycloak}
KEYCLOAK_ADMIN: ${KEYCLOAK_ADMIN_USER:-admin}
KEYCLOAK_ADMIN_PASSWORD: ${KEYCLOAK_ADMIN_PASSWORD:-admin}
KC_HTTP_ENABLED: "true"
KC_HOSTNAME_STRICT: "false"
KC_HEALTH_ENABLED: "true"
ports:
- "${KEYCLOAK_PORT:-8080}:8080"
healthcheck:
test: ["CMD-SHELL", "curl -sf http://localhost:8080/health/ready || exit 1"]
interval: 15s
timeout: 5s
retries: 20
start_period: 60s
# ── wafpass-dashboard ─────────────────────────────────────
wafpass-dashboard:
build:
context: ./wafpass-dashboard
dockerfile: Dockerfile
restart: unless-stopped
depends_on:
- wafpass-server
ports:
- "3000:80"
volumes:
postgres_data:
Adicionar à CI / pre-commit.
Bloqueie infraestrutura não conforme antes que ela chegue à sua branch principal. O WOMBATpass trabalha só com os arquivos do repositório, então as verificações de CI são rápidas e não exigem segredos de nuvem.
Instalar o hook de pre-commit
Execute o script de instalação do repositório do WOMBATpass uma vez por clone. Depois disso, cada git commit é verificado automaticamente.
$bash hooks/install.sh # macOS / Linux / Git Bash
$.\hooks\install.ps1 # Windows PowerShell
Adicionar o WOMBATpass ao GitHub Actions
Use a GitHub Action oficial do WOMBATpass para reprovar pull requests que introduzam erros de configuração. Funciona com repositórios públicos e privados.
Configurar o WOMBATpass ActionConfiguração avançada / manual.
Instale só os componentes de que precisa. Comece pela CLI para CI/CD e adicione servidor e painel quando precisar de persistência e exploração visual.
Instalar a CLI wafpass
Motor de avaliação principal: analisa IaC, avalia controles e gera relatórios.
Pelo PyPI (recomendado)
$pip install wafpass-core
$uv add wafpass-core # recommended for Python projects
A partir do código-fonte
$git clone https://github.com/WAF2p/pass.git
$cd pass
$uv pip install -e . # recommended
$pip install -e ".[pdf]" # with PDF report support
macOS (Apple M-series)
$brew install git python uv
$git clone https://github.com/WAF2p/pass.git && cd pass
$uv pip install -e .
$wombat --version # verify installation
Instalar o wafpass-server
Camada de persistência com FastAPI: armazena execuções, exceções, segredos encontrados e eventos de auditoria.
Pelo PyPI (recomendado)
$pip install wafpass-server
$uv add wafpass-server # recommended for Python projects
Configurar e iniciar
$cp .env.example .env # set DATABASE_URL and JWT secret
$alembic upgrade head # apply database migrations
$uvicorn wafpass_server.main:app --reload --port 8000
Documentação da API disponível em http://localhost:8000/api/docs
Instalar o wafpass-dashboard
Painel web em React: mais de 22 visões de conformidade, exportação de evidências, RBAC.
$git clone https://github.com/WAF2p/wafpass-dashboard.git
$cd wafpass-dashboard
$npm install
$cp .env.example .env.local # set VITE_API_URL
$npm run dev # dev server at http://localhost:5173
Problemas comuns e soluções.
Respostas rápidas se algo não funcionar na primeira tentativa.
Controles não encontrados
Se wombat check informar "controls directory not found", a CLI exibe automaticamente as instruções de download. Verifique se a pasta controls/ está ao lado do local onde você executa as varreduras.
Porta já em uso
Use outra porta para o servidor ou o painel:
$uvicorn wafpass_server.main:app --port 8001
$npm run dev -- --port 5174
Erros de conexão com o banco de dados
Verifique se o PostgreSQL está rodando e se sua DATABASE_URL está correta:
$psql $DATABASE_URL -c "SELECT 1"
Falha no build do Docker
Ao compilar a partir do código-fonte, os três repositórios devem estar clonados lado a lado no mesmo diretório pai:
$ls -1
pass/
wafpass-server/
wafpass-dashboard/
Você fez sua primeira verificação. E agora?
Escolha o próximo passo de acordo com seu papel: aprofundar o framework, integrar o WOMBATpass à CI/CD ou explorar o painel visual completo.
Explorar os 8 pilares
Entenda o framework Wombat e os controles por trás de cada pilar.
Saiba mais →Adicionar ao GitHub Actions
Bloqueie merges não conformes antes que cheguem à sua branch principal.
Configurar a action →Ler a documentação
Referência da CLI, API do servidor, configuração e uso avançado.
Abrir a documentação →