Início rápido · Primeira análise em 2 minutos

Obtenha o seu primeiro resultado WAFPass hoje.

Instale a WAFPass CLI de código aberto, transfira os controlos WAF++ e analise um ficheiro Terraform de exemplo. Sem credenciais de nuvem, sem caixa preta — apenas análise estática na sua Infraestrutura-como-Código.

v1.1.0
WAFPass CLI
8
Pilares
83+
Controlos
Docker
Pronto para Compose
Apache 2.0
Licença de código

Prefere um comando único? O instalador configura a CLI e os controlos por si.

macOS / Linux curl -fsSL https://waf2p.dev/install.sh | sh
Windows irm https://waf2p.dev/install.ps1 | iex
ESCOLHA O SEU CAMINHO

Um caminho claro para cada caso de uso.

Comece pelo início rápido de 2 minutos da CLI. Mude de separador quando estiver pronto para o painel, CI ou configuração manual.

Obtenha o seu primeiro resultado em 2 minutos

Siga os quatro passos abaixo. Cada comando foi concebido para lhe dar um resultado garantido e legível à primeira tentativa.

1

Instale a CLI

O WAFPass é publicado no PyPI como wafpass-core. Recomenda-se Python 3.11+.

bash
$ pip install wafpass-core
$ wafpass --version
2

Transfira os controlos

O catálogo de controlos WAF++ contém as 83+ regras que o WAFPass usa para avaliar o seu código.

bash
$ git clone https://github.com/WAF2p/framework.git controls-src
$ cp -r controls-src/modules/controls/controls ./controls

Recomendado: clonar o repositório de controlos. Alternativa: transferir o zip dos controlos a partir da página WAFPass e extraí-lo para controls/.

3

Guarde um ficheiro Terraform de exemplo

Crie um main.tf mínimo. Este exemplo deixa deliberadamente um bucket S3 público para que o WAFPass tenha algo para assinalar.

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
}
4

Execute a sua primeira verificação

Aponte o WAFPass para o diretório actual e imprima o resumo JSON.

bash
$ wafpass check . --output json | jq '.summary'

Deverá ver um resultado como este:

{
  "total_controls": 83,
  "passed": 81,
  "failed": 2,
  "pillars": {
    "security": { "passed": 18, "failed": 2 }
  }
}
81 passed — recursos que cumprem o controlo
2 failed — recursos que violaram um controlo (aqui, o bucket S3 público)
83 controls — regras totais avaliadas nos 8 pilares WAF++

Execute o painel completo localmente

O monorepo WAF2p/pass inclui um docker-compose.yml unificado. Levanta a CLI, o servidor, o painel, o PostgreSQL e o Keycloak num único comando.

bash
$ 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çoURLDescrição
wafpass-dashboardhttp://localhost:3000Painel React
wafpass-serverhttp://localhost:8000API REST FastAPI
Keycloak (SSO)http://localhost:8080Fornecedor de identidade (admin / admin)
postgreslocalhost:5432Base de dados PostgreSQL

Assim que os contentores estiverem saudáveis, preencha a primeira vista do painel com o comando de demonstração ou enviando um resultado de análise:

bash
$ wafpass demo # creates sample data and opens the dashboard
$ open http://localhost:3000
Ver 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 a CI / pré-commit

Bloqueie infraestrutura não conforme antes de chegar ao branch principal. O WAFPass executa inteiramente sobre os ficheiros no repositório, por isso as verificações de CI são rápidas e não precisam de segredos de nuvem.

1

Instale o gancho pré-commit

Execute o script de instalação do repositório WAFPass uma vez por clone. Depois disso, cada git commit é verificado automaticamente.

bash
$ bash hooks/install.sh # macOS / Linux / Git Bash
$ .\hooks\install.ps1 # Windows PowerShell
2

Adicione o WAFPass às GitHub Actions

Use a GitHub Action oficial do WAFPass para falhar pulls que introduzam más configurações. Funciona com repositórios públicos e privados.

Configurar a WAFPass Action →

Configuração avançada / manual

Instale apenas os componentes de que precisa. Comece pela CLI para CI/CD e adicione o servidor e o painel quando precisar de persistência e exploração visual.

1
Instalar a wafpass CLI

Motor de avaliação principal — analisar IaC, avaliar controlos, gerar relatórios

A partir do PyPI (recomendado)

bash
$ pip install wafpass-core
$ uv add wafpass-core # recommended for Python projects

A partir do código fonte

bash
$ 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)

bash
$ brew install git python uv
$ git clone https://github.com/WAF2p/pass.git && cd pass
$ uv pip install -e .
$ wafpass --version # verify installation
2
Instalar o wafpass-server

Camada de persistência FastAPI — guarda execuções, renúncias, achados de segredos e eventos de auditoria

A partir do PyPI (recomendado)

bash
$ pip install wafpass-server
$ uv add wafpass-server # recommended for Python projects

Configurar e iniciar

bash
$ 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

3
Instalar o wafpass-dashboard

Painel web React — 22+ vistas de conformidade, exportação de evidências, RBAC

bash
$ 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
RESOLUÇÃO DE PROBLEMAS

Problemas comuns e correções.

Respostas rápidas se algo não funcionar à primeira tentativa.

Controlos não encontrados

Se wafpass check reportar "controls directory not found", a CLI mostrará instruções de transferência automaticamente. Certifique-se de que a pasta controls/ fica junto de onde executa as análises.

Porta já em uso

Use uma porta diferente para o servidor ou painel:

$ uvicorn wafpass_server.main:app --port 8001
$ npm run dev -- --port 5174
Erros de ligação à base de dados

Verifique se o PostgreSQL está a correr e se o seu DATABASE_URL está correcto:

$ psql $DATABASE_URL -c "SELECT 1"
Falha na compilação Docker

Certifique-se de que os três repositórios são clonados lado a lado no mesmo diretório pai ao compilar a partir do código fonte:

$ ls -1
pass/
wafpass-server/
wafpass-dashboard/