Files
crowdsec-manager/docs/ADMIN.md
2026-03-16 10:15:10 +01:00

5.9 KiB
Raw Permalink Blame History

Interaktive Administration

Dokumentation der interaktiven CrowdSec-Administrationsfunktionen im CrowdSec Manager v0.1.0.


Übersicht

Ab Version 0.1.0 startet das Script standardmäßig ein interaktives Menü, über das CrowdSec-Funktionen direkt verwaltet werden können ohne manuell cscli-Befehle absetzen zu müssen.

# Interaktives Menü starten (Standard)
./crowdsec-manager.sh

# Oder explizit:
./crowdsec-manager.sh --interactive

Menü-Struktur

╔═══════════════════════════════════════════════════════╗
║                    CrowdSec Manager                   ║
╚═══════════════════════════════════════════════════════╝

── ALLOWLIST MANAGEMENT ──────────────────────────────
  1)  Allowlist synchronisieren (DNS auflösen & updaten)
  2)  Allowlist synchronisieren (Dry-Run)
  3)  Aktuelle Allowlist anzeigen
  4)  Konfiguration testen
  5)  Alle verwalteten Einträge entfernen (Flush)

── DECISIONS ─────────────────────────────────────────
 10)  Alle Decisions anzeigen
 11)  Decision suchen (nach IP)
 12)  Decision manuell hinzufügen
 13)  Decision entfernen

── ALERTS ────────────────────────────────────────────
 20)  Alle Alerts anzeigen
 21)  Alert inspizieren (Detail-Ansicht)
 22)  Alerts löschen

── INFORMATIONEN ─────────────────────────────────────
 30)  IP-Informationen (Komplett-Check)
 31)  CrowdSec Metriken
 32)  CrowdSec Status & Version
 33)  Bouncers anzeigen
 34)  Machines anzeigen
 35)  Parsers anzeigen
 36)  Scenarios anzeigen
 37)  Collections anzeigen

── ERWEITERT ─────────────────────────────────────────
 40)  Eigenen cscli-Befehl ausführen

  0)  Beenden

Funktionen im Detail

Allowlist Management (1-5)

Nr. Funktion Beschreibung
1 Sync Führt die komplette Allowlist-Synchronisation aus (DNS auflösen, Vergleich, Update)
2 Dry-Run Wie 1, aber ohne tatsächliche Änderungen an CrowdSec
3 Anzeigen Zeigt alle aktuellen Allowlist-Einträge
4 Test Prüft Config, DNS-Auflösung und CrowdSec-Verbindung
5 Flush Entfernt alle vom Script verwalteten Einträge (mit Bestätigung)

Decisions (10-13)

10) Alle Decisions anzeigen

Zeigt alle aktiven CrowdSec Decisions an (Ban, Allow, Captcha, Throttle).

Entspricht: cscli decisions list

11) Decision suchen

Sucht alle Decisions für eine bestimmte IP-Adresse.

Entspricht: cscli decisions list -i <IP>

12) Decision manuell hinzufügen

Interaktiver Assistent zum Hinzufügen einer Decision:

  1. IP/CIDR eingeben Die zu behandelnde IP-Adresse oder CIDR-Range
  2. Typ wählen:
    • ban IP sperren
    • allow IP erlauben (Allowlist)
    • captcha Captcha anzeigen
    • throttle Traffic drosseln
  3. Dauer z.B. 10m, 1h, 24h, 7d (Standard: 4h)
  4. Grund Optionaler Kommentar
  5. Bestätigung Zusammenfassung mit Ja/Nein-Abfrage

13) Decision entfernen

Entfernt eine Decision entweder nach:

  • IP-Adresse Alle Decisions für diese IP
  • Decision-ID Spezifische Decision

Alerts (20-22)

20) Alle Alerts anzeigen

Zeigt alle aktuellen Alerts an.

Entspricht: cscli alerts list

21) Alert inspizieren

Zeigt Detail-Informationen zu einem spezifischen Alert (nach Alert-ID).

Entspricht: cscli alerts inspect <ID> -d

22) Alerts löschen

Löscht Alerts nach:

  • Einzelne Alert-ID Spezifischen Alert löschen
  • IP-Adresse Alle Alerts für eine IP
  • Zeitraum Alle Alerts älter als z.B. 24h, 7d

Jede Löschung erfordert eine Bestätigung.


Informationen (30-37)

30) IP-Informationen (Komplett-Check)

Sammelt umfassende Informationen zu einer IP-Adresse in 4 Schritten:

[1/4] Reverse-DNS:        PTR-Record Lookup
[2/4] Aktive Decisions:   Alle Decisions für diese IP
[3/4] Alerts:             Alle Alerts für diese IP
[4/4] Alert-Details:      Detail-Inspektion der letzten 5 Alerts

Nützlich für schnelle Untersuchung verdächtiger IPs.

31) CrowdSec Metriken

Zeigt aktuelle CrowdSec-Metriken (Acquisition, Parser, Scenarios, etc.).

Entspricht: cscli metrics

32) CrowdSec Status & Version

Zeigt die CrowdSec-Version und den Hub-Status.

33-37) Hub-Komponenten

Nr. Komponente cscli-Befehl
33 Bouncers cscli bouncers list
34 Machines cscli machines list
35 Parsers cscli parsers list
36 Scenarios cscli scenarios list
37 Collections cscli collections list

Erweitert (40)

40) Eigener cscli-Befehl

Ermöglicht die Ausführung beliebiger cscli-Befehle über den konfigurierten CSCLI_CMD.

Basis: docker exec crowdsec cscli
Gib nur die Argumente nach 'cscli' ein.
Beispiel: decisions list -o json

cscli> decisions list -o json

Der eingegebene Befehl wird an den konfigurierten Basisbefehl angehängt und ausgeführt.


Tipps

  • Das Menü merkt sich den Kontext nicht zwischen Aufrufen. Jede Funktion ist eigenständig.
  • Bei allen destruktiven Aktionen (Flush, Decisions/Alerts löschen) wird eine Bestätigung abgefragt.
  • Die Navigation erfolgt rein über Nummern-Eingabe.
  • Nach jeder Funktion wird auf Enter gewartet, bevor das Menü neu angezeigt wird.
  • Mit 0, q oder exit wird das Programm beendet.