Skip to content
Diese Seite wurde mit KI-Unterstützung erstellt und übersetzt. Falls Ihnen Ungenauigkeiten auffallen, helfen Sie gerne bei der Verbesserung. Auf GitHub bearbeiten

CLI-Befehlsreferenz

Die prx-waf-Kommandozeilenschnittstelle bietet Befehle für Server-Verwaltung, Regeloperationen, CrowdSec-Integration und Bot-Erkennung.

Globale Optionen

FlagStandardBeschreibung
-c, --config <FILE>configs/default.tomlPfad zur TOML-Konfigurationsdatei
bash
prx-waf -c /etc/prx-waf/config.toml <COMMAND>

Server-Befehle

BefehlBeschreibung
prx-waf runReverse-Proxy + Management-API starten (blockiert dauerhaft)
prx-waf migrateNur Datenbankmigrationen ausführen
prx-waf seed-adminStandard-Admin-Benutzer erstellen (admin/admin)
bash
# Server starten
prx-waf -c configs/default.toml run

# Migrationen vor dem ersten Start ausführen
prx-waf -c configs/default.toml migrate

# Admin-Benutzer erstellen
prx-waf -c configs/default.toml seed-admin

TIP

Bei der Ersteinrichtung migrate und seed-admin vor run ausführen. Nachfolgende Starts benötigen nur run -- Migrationen werden automatisch überprüft.

Regelverwaltung

Befehle zur Verwaltung von Erkennungsregeln. Alle Regelbefehle operieren auf dem konfigurierten Regelverzeichnis.

BefehlBeschreibung
prx-waf rules listAlle geladenen Regeln auflisten
prx-waf rules list --category <CAT>Regeln nach Kategorie filtern
prx-waf rules list --source <SRC>Regeln nach Quelle filtern
prx-waf rules info <RULE-ID>Detaillierte Informationen über eine Regel anzeigen
prx-waf rules enable <RULE-ID>Eine deaktivierte Regel aktivieren
prx-waf rules disable <RULE-ID>Eine Regel deaktivieren
prx-waf rules reloadAlle Regeln von der Festplatte hot-reloaden
prx-waf rules validate <PATH>Eine Regeldatei auf Korrektheit validieren
prx-waf rules import <PATH|URL>Regeln aus einer Datei oder URL importieren
prx-waf rules export [--format yaml]Aktuellen Regelsatz exportieren
prx-waf rules updateNeueste Regeln aus Remote-Quellen abrufen
prx-waf rules search <QUERY>Regeln nach Name oder Beschreibung suchen
prx-waf rules statsRegelstatistiken anzeigen

Beispiele

bash
# Alle SQL-Injection-Regeln auflisten
prx-waf rules list --category sqli

# OWASP CRS-Regeln auflisten
prx-waf rules list --source owasp

# Details für eine bestimmte Regel anzeigen
prx-waf rules info CRS-942100

# Eine Regel deaktivieren, die Falsch-Positive verursacht
prx-waf rules disable CRS-942100

# Nach Regelbearbeitung hot-reloaden
prx-waf rules reload

# Benutzerdefinierte Regeln vor der Bereitstellung validieren
prx-waf rules validate rules/custom/myapp.yaml

# Regeln aus einer URL importieren
prx-waf rules import https://example.com/rules/custom.yaml

# Alle Regeln als YAML exportieren
prx-waf rules export --format yaml > all-rules.yaml

# Statistiken anzeigen
prx-waf rules stats

Regelquellen-Verwaltung

Befehle zur Verwaltung von Remote-Regelquellen.

BefehlBeschreibung
prx-waf sources listKonfigurierte Regelquellen auflisten
prx-waf sources add <NAME> <URL>Eine Remote-Regelquelle hinzufügen
prx-waf sources remove <NAME>Eine Regelquelle entfernen
prx-waf sources update [NAME]Neuestes von einer bestimmten Quelle abrufen (oder allen)
prx-waf sources syncAlle Remote-Quellen synchronisieren

Beispiele

bash
# Alle Quellen auflisten
prx-waf sources list

# Eine benutzerdefinierte Quelle hinzufügen
prx-waf sources add my-rules https://example.com/rules/latest.yaml

# Alle Quellen synchronisieren
prx-waf sources sync

# Eine bestimmte Quelle aktualisieren
prx-waf sources update owasp-crs

CrowdSec-Integration

Befehle zur Verwaltung der CrowdSec-Bedrohungsgeheimdienst-Integration.

BefehlBeschreibung
prx-waf crowdsec statusCrowdSec-Integrationsstatus anzeigen
prx-waf crowdsec decisionsAktive Entscheidungen von LAPI auflisten
prx-waf crowdsec testLAPI-Konnektivität testen
prx-waf crowdsec setupInteraktiver CrowdSec-Einrichtungsassistent

Beispiele

bash
# Integrationsstatus prüfen
prx-waf crowdsec status

# Aktive Block/Captcha-Entscheidungen auflisten
prx-waf crowdsec decisions

# Konnektivität zu CrowdSec LAPI testen
prx-waf crowdsec test

# Einrichtungsassistenten starten
prx-waf crowdsec setup

Bot-Erkennung

Befehle zur Verwaltung von Bot-Erkennungsregeln.

BefehlBeschreibung
prx-waf bot listBekannte Bot-Signaturen auflisten
prx-waf bot add <PATTERN> [--action ACTION]Ein Bot-Erkennungsmuster hinzufügen
prx-waf bot remove <PATTERN>Ein Bot-Erkennungsmuster entfernen
prx-waf bot test <USER-AGENT>Einen User-Agent gegen Bot-Regeln testen

Beispiele

bash
# Alle Bot-Signaturen auflisten
prx-waf bot list

# Ein neues Bot-Muster hinzufügen
prx-waf bot add "(?i)my-bad-bot" --action block

# Ein Bot-Muster im Log-only-Modus hinzufügen
prx-waf bot add "(?i)suspicious-crawler" --action log

# Einen User-Agent-String testen
prx-waf bot test "Mozilla/5.0 (compatible; Googlebot/2.1)"

# Ein Bot-Muster entfernen
prx-waf bot remove "(?i)my-bad-bot"

Nutzungsmuster

Ersteinrichtung

bash
# 1. Migrationen ausführen
prx-waf -c configs/default.toml migrate

# 2. Admin-Benutzer erstellen
prx-waf -c configs/default.toml seed-admin

# 3. Server starten
prx-waf -c configs/default.toml run

Regel-Wartungs-Workflow

bash
# 1. Auf Upstream-Regelupdates prüfen
prx-waf rules update

# 2. Nach Update validieren
prx-waf rules validate rules/

# 3. Änderungen überprüfen
prx-waf rules stats

# 4. Hot-Reload
prx-waf rules reload

CrowdSec-Integrationseinrichtung

bash
# 1. Einrichtungsassistenten starten
prx-waf crowdsec setup

# 2. Konnektivität testen
prx-waf crowdsec test

# 3. Verifikation, dass Entscheidungen fließen
prx-waf crowdsec decisions

Nächste Schritte

Released under the Apache-2.0 License.