Quickstart · Eerste scan in 2 minuten

Krijg vandaag je eerste WAFPass-scanresultaat.

Installeer de open-source WAFPass CLI, download de WAF++-controls en scan een voorbeeld-Terraform-bestand. Geen cloud-credentials, geen black box — alleen statische analyse op je Infrastructure-as-Code.

v1.1.0
WAFPass CLI
8
Pijlers
83+
Controls
Docker
Compose-klaar
Apache 2.0
Codelicentie

Liever een one-liner? Het installatiescript installeert de CLI en controls voor je.

macOS / Linux curl -fsSL https://waf2p.dev/install.sh | sh
Windows irm https://waf2p.dev/install.ps1 | iex
KIES JE PAD

Eén duidelijk pad voor elke use case.

Begin met de 2-minuten CLI-quickstart. Wissel van tabblad wanneer je klaar bent voor het dashboard, CI of handmatige setup.

Krijg je eerste resultaat in 2 minuten

Volg de vier stappen hieronder. Elk commando is ontworpen om je gegarandeerd een leesbaar resultaat te geven bij je eerste poging.

1

Installeer de CLI

WAFPass wordt gepubliceerd op PyPI als wafpass-core. Python 3.11+ wordt aanbevolen.

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

Download de controls

De WAF++ controls-catalogus bevat de 83+ regels die WAFPass gebruikt om je code te evalueren.

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

Aanbevolen: clone de controls-repository. Alternatief: download de controls-zip van de WAFPass-pagina en pak deze uit in controls/.

3

Bewaar een voorbeeld-Terraform-bestand

Maak een minimaal main.tf. Dit voorbeeld laat expres een publieke S3-bucket staan, zodat WAFPass iets heeft om te markeren.

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

Voer je eerste check uit

Richt WAFPass op de huidige map en print de JSON-samenvatting.

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

Je ziet output zoals deze:

{
  "total_controls": 83,
  "passed": 81,
  "failed": 2,
  "pillars": {
    "security": { "passed": 18, "failed": 2 }
  }
}
81 passed — resources voldeden aan de control
2 failed — resources schenden een control (hier, de publieke S3-bucket)
83 controls — totaal aantal regels geëvalueerd over 8 WAF++-pijlers

Draai het volledige dashboard lokaal

De WAF2p/pass-monorepo levert een unified docker-compose.yml. Het start de CLI, server, dashboard, PostgreSQL en Keycloak in één commando.

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
ServiceURLBeschrijving
wafpass-dashboardhttp://localhost:3000React-dashboard
wafpass-serverhttp://localhost:8000FastAPI REST API
Keycloak (SSO)http://localhost:8080Identiteitsprovider (admin / admin)
postgreslocalhost:5432PostgreSQL-database

Zodra de containers healthy zijn, seed je eerste dashboard-view met de demo-opdracht of door een scanresultaat te pushen:

bash
$ wafpass demo # creates sample data and opens the dashboard
$ open http://localhost:3000
Bekijk volledige docker-compose.yml
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:

Voeg toe aan CI / pre-commit

Blokkeer niet-conforme infrastructuur voordat deze je main branch bereikt. WAFPass draait volledig op de bestanden in de repo, dus CI-checks zijn snel en hebben geen cloud-secrets nodig.

1

Installeer de pre-commit hook

Voer het installatiescript van de WAFPass-repository één keer per clone uit. Daarna wordt elke git commit automatisch gecontroleerd.

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

Voeg WAFPass toe aan GitHub Actions

Gebruik de officiële WAFPass GitHub Action om pull requests die misconfiguraties introduceren te laten falen. Werkt met publieke en private repositories.

WAFPass Action instellen →

Geavanceerde / handmatige setup

Installeer alleen de componenten die je nodig hebt. Begin met de CLI voor CI/CD, voeg daarna de server en het dashboard toe wanneer je persistentie en visuele exploratie nodig hebt.

1
Installeer wafpass CLI

Core evaluation engine — parse IaC, evalueer controls, genereer rapporten

Van PyPI (aanbevolen)

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

Van bron

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
Installeer wafpass-server

FastAPI persistence layer — slaat runs, ontheffingen, secrets-bevindingen en audit-events op

Van PyPI (aanbevolen)

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

Configureer & start

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

API-docs beschikbaar op http://localhost:8000/api/docs

3
Installeer wafpass-dashboard

React web dashboard — 22+ compliance-views, evidence-export, 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
PROBLEMEN

Veelvoorkomende problemen & oplossingen.

Snelle antwoorden als iets niet meteen werkt.

Controls niet gevonden

Als wafpass check "controls directory not found" rapporteert, toont de CLI automatisch download-instructies. Zorg dat de controls/-map naast de plek staat waar je scans uitvoert.

Poort al in gebruik

Gebruik een andere poort voor de server of het dashboard:

$ uvicorn wafpass_server.main:app --port 8001
$ npm run dev -- --port 5174
Database-verbindingsfouten

Controleer dat PostgreSQL draait en dat je DATABASE_URL klopt:

$ psql $DATABASE_URL -c "SELECT 1"
Docker-build mislukt

Zorg dat alle drie de repositories naast elkaar in dezelfde parent-directory zijn gekloond wanneer je vanuit bron bouwt:

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