Compare commits

..
18 Commits
Author SHA1 Message Date
Julian Boldt ad17dcad25 Release v1.27.1
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Fix (1.27.1): Proxy startete mit der neuen Compose-Datei nicht.** Mit der `docker-compose.yml` aus 1.27.0 gab Compose die Variable
  `OPNEXUS_GUI_SITES` als leeren Text an den Proxy weiter; Caddy nutzt seinen Standardwert aber nur bei *nicht gesetzter* Variable und
  brach mit „server block without any key“ ab, OPNexus war dann nicht mehr erreichbar. Die Compose-Datei setzt jetzt einen gültigen
  Platzhalter als Standard. Betroffen waren nur Installationen, die die neue Compose-Datei aus 1.27.0 übernommen hatten (ohne
  `OPNEXUS_GUI_SITES` in der `.env`); wer nur die Images aktualisiert hatte, war nicht betroffen. Sofort-Abhilfe ohne Update:
  `OPNEXUS_GUI_SITES=https://localhost:9441` in die `.env` eintragen und `docker compose up -d proxy` ausführen.
2026-10-21 20:44:14 +02:00
Julian Boldt 5cb2ebe1c6 Release v1.27.0
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
Vorgesehen als MINOR-Release **1.27.0** „Firewall-Oberfläche über OPNexus“.

- **Firewall-Oberfläche über OPNexus:** Auf der Host-Seite öffnet **Oberfläche öffnen** die Weboberfläche der Firewall
  in einem neuen Tab, auch bei Firewalls hinter NAT im Management-Tunnel. Nur für Admins; jede Firewall läuft in einer
  eigenen Browser-Origin (Platz = Port), Cookies bleiben auf dem Server, das Ticket gilt einmalig 30 Sekunden,
  Inaktivitäts- und Gesamtlimit sind einstellbar, Ticket, Start und Ende stehen im Audit (Art „GUI-Zugriff“).
  Standardmäßig **aus**: braucht das Compose-Profil `gui`, `OPNEXUS_GUI_SITES`, `GUI_PORTS`, `GUI_GATEWAY_TOKEN`,
  `COOKIE_SECURE=true` und den Schalter unter Einstellungen (Handbuch, „Firewall-Oberfläche über OPNexus“).
  Live getestet auf OPNsense 26.7.
- **Einschränkungen:** kein WebSocket, keine automatische Anmeldung, höchstens 4 Plätze gleichzeitig. OPNexus-Adresse
  vorher in die Whitelist des Anmeldeschutzes (sshguard) der Firewall eintragen, sonst können Fehlanmeldungen die
  API-Zugriffe von OPNexus aussperren. Nach einem Neustart des wg-hub braucht der Tunnel 2 bis 4 Minuten.
- **Hinweis für Betreiber mit eigenen Skripten:** Bei HTTPS heißt das Sitzungs-Cookie jetzt `__Host-opnexus-session`
  (bestehende Sitzungen werden ohne Abmelden übernommen), und Cookie-Anfragen an `/api` mit `Sec-Fetch-Site: same-site/cross-site`
  werden abgelehnt. Zugriffe mit API-Token sind nicht betroffen.
2026-10-21 20:14:06 +02:00
Julian Boldt 18d489693d Release v1.26.0
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
Geplant als MINOR-Release **1.26.0** (Regel-Analyse). Backend, MCP und Oberfläche.

- **Regel-Analyse „Welche Regel greift?“ (API):** `GET /api/hosts/{id}/rule-analysis/match` und
  `GET /api/rule-analysis/match` (ganze Flotte, Auswahl oder Gerätegruppe) beantworten für Quelle, Ziel, Protokoll
  und Port, ob eine Firewall das erste Paket einer neuen Verbindung durchlässt oder blockiert, welche Regel das
  entscheidet und warum (Prüfprotokoll Regel für Regel). Grundlage ist der tatsächlich geladene pf-Regelsatz
  inklusive automatischer Regeln, Floating- und Gruppenregeln, `quick`/letzter Treffer, Negation, verschachtelter
  Aliase (pf-Tabellentest der Firewall), Port-Aliase und Adressfamilien. Jede Antwort trägt eine ehrliche
  Konfidenz **sicher / vermutlich / unbekannt** mit Begründungscodes; was nicht belegbar ist (z. B. `tagged`,
  nicht auflösbare Aliase, geratenes Interface, NAT in der Nähe), wird nie als „sicher“ gemeldet. Nur lesend,
  auch mit `read`-Token nutzbar; es wird nichts gespeichert und nichts an der Firewall geändert.
- **MCP:** neues Werkzeug `rule_match` für KI-Assistenten (gleiche Abfrage, ohne Prüfprotokoll).
- **Seite „Regel-Analyse“ (Regelwerk):** Formular für Hosts oder Gerätegruppe, Quell-/Ziel-IP, Protokoll, Ports,
  Eingangs-Interface („automatisch“ oder Liste) und optional die Ausgangsseite. Die Abfrage steht in der Adresszeile
  (teilbar, wird beim Öffnen sofort ausgeführt). Je Firewall eine Karte mit Erlaubt/Blockiert/Abgewiesen, Sicherheit
  des Urteils, entscheidender Regel und Hinweisen; ein „unbekannt“-Ergebnis erscheint bewusst nicht als Urteil.
  Aufklappbares „Warum?“ zeigt jede geprüfte Regel mit ✓/✗/? je Feld, überstimmte Regeln durchgestrichen. Auch mit
  Nur-Lesen-Rolle nutzbar.
2026-10-21 13:12:11 +02:00
Julian Boldt a9f562eec6 Release v1.25.0
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
Geplant als MINOR-Release **1.25.0** (Flotten-Rollout).

- **Rollouts in Wellen (System › Rollouts):** Firmware-Updates für die ganze Flotte in Ringen, z. B. erst
  `ring-canary`, dann `ring-pilot`, dann `ring-prod` (Wellen aus Gerätegruppen). Jeder Host läuft über die
  bestehende geplante Wartung (Backup vor dem Update, CARP-Übergabe für den MASTER, Audit), immer nur ein Host
  gleichzeitig und nur ein Rollout zur selben Zeit; im Cluster zuerst der BACKUP, dann der MASTER. Nach jeder Welle
  folgen eine Beobachtungszeit und eine **Gesundheitsprüfung** (erreichbar, Zielversion installiert, CARP je VHID,
  Gateways und Dienste wie vorher, keine offenen Sperren, optional Sicherheits-Score). Rot hält den Rollout an
  (nach einer Nachprüfung zwei Minuten später) und meldet sich. Anhalten, Fortsetzen (prüft zuerst alles bisher
  Aktualisierte erneut), Welle freigeben, Host überspringen und Abbrechen auf der Lauf-Seite; die Seite zeigt
  Wellen, Hosts (Version vorher → nachher, aktueller Schritt) und die Prüfmatrix.
- **Sicherheitsnetz:** Weicht die angebotene Version in einem späteren Ring von der des ersten Rings ab, hält der
  Rollout an (OPNsense installiert immer die neueste). Ein Host ohne Update wird übersprungen, ein fehlgeschlagener
  nie von selbst wiederholt. Angehalten wird auch, wenn die verantwortliche Person das Recht zum Ausrollen verliert,
  eine fremde Wartung im Cluster länger als 15 Minuten offen ist, der MASTER ohne Übergabe dran wäre oder ein Lauf
  älter als 14 Tage ist. Höchstens 10 Wellen und 100 Hosts je Plan.
- **Wiederkehrende Wartungsfenster:** wöchentlich oder monatlich (n-ter Wochentag, letzter, fester Tag) in einer
  Zeitzone, mit Sommerzeit-Regel, Abschneidezeit („neue Hosts nur in den ersten N Minuten“) und einzelnen Terminen
  zum Auslassen oder Verschieben. Ein Plan mit Fenster startet neue Hosts nur darin; mit **automatischem Start**
  (nur stabile Updates) beginnt er zu jedem Termin von selbst, aber nur, solange Plan, Gruppen und Fenster seit
  der Aktivierung unverändert sind. Jede Änderung deaktiviert ihn.
- **Geplante Wartung prüft sich selbst:** Neue Option „Ergebnis automatisch prüfen und abschließen“ (im Dialog
  vorausgewählt, bei Rollouts immer an). Nach dem Auftrag prüft OPNexus, ob die Firmware wieder bereit ist, der
  erwartete Neustart stattfand und die Version lesbar ist, und schließt die Wartung dann selbst ab. Bisher blieb
  sie auf „übergeben“ und sperrte Host und Cluster, bis jemand sie von Hand abschloss.
- **Benachrichtigungen:** „Rollout angehalten“ und „Rollout nicht automatisch gestartet“ (ein Schalter, standardmäßig an).
- **Rechte:** Rollout starten/aktivieren/fortsetzen/freigeben/überspringen/abbrechen und Wartungsfenster ändern
  gelten als Ausrollen (Aufgabentrennung); **Anhalten** darf jeder mit Schreibrecht. Update Center: Hosts im
  laufenden Rollout sind für manuelle Firmware-Aktionen gesperrt. Ein OPNexus-Update während eines Rollouts ist
  sicher, wird aber angekündigt.
- **Getestet:** live auf den Test-Firewalls (OPNsense 26.7): automatischer Start im Fenster, Canary-Update
  26.7.1_1 → 26.7.7, absichtlich gestoppter Dienst → Gate rot → angehalten (zweiter Ring unberührt,
  Benachrichtigung), Fortsetzen, Pilot-Update 26.7.6 → 26.7.7 auf dem damaligen MASTER mit CARP-Übergabe und einem
  Neustart des OPNexus-Backends mitten im Auftrag (genau ein Update-Auftrag), Freigabe, Host ohne Update
  übersprungen, Anhalten/Fortsetzen/Abbrechen von Hand, Termin auslassen. **Nur gemockt:** Major-Upgrade als
  Rollout, ein Cluster in *einer* Welle, Cluster-Prüfung vor dem zweiten Knoten, abweichende Zielversion,
  Zeitüberschreitungen, Rechteverlust, Fenster schließt mitten im Lauf; die Sommerzeit-Regeln sind Rechentests.
2026-10-21 11:59:41 +02:00
Julian Boldt a3274f64ae Release v1.24.0
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Alarme für Gateways, Ressourcen und Dienste:** Neue Ereignisse in Einstellungen › Benachrichtigungen.
  **Gateway gestört** (standardmäßig **an**) meldet ein Gateway, das OPNsense als „down“ führt oder dessen Paketverlust (ab 20 %) bzw.
  Latenz (ab 500 ms) über der Schwelle liegt; bewusst abgeschaltete und nicht überwachte Gateways bleiben still. **Ressourcen-Schwelle**
  (standardmäßig aus) prüft Festplatte (ab 90 %), Arbeitsspeicher (ab 95 %), Swap (ab 50 %) und CPU-Last (ab 2 pro Thread), **Dienst ausgefallen**
  (standardmäßig aus) eine einstellbare Liste (Unbound, Dnsmasq, DHCP, NTP, OpenVPN, WireGuard, IPsec …) und meldet nur Dienste, die zuvor
  liefen. Alle drei stützen sich auf die Minutenmessung und lösen erst aus, wenn die letzten 3 (Ressourcen: 5) Messungen übereinstimmen, und
  enden erst, wenn alle wieder in Ordnung sind: Einzelspitzen und flackernde Verbindungen schicken nichts. Der Gateway-Status (Verlust, Latenz,
  Abweichung) steht außerdem auf der Host-Seite, als Kachel auf dem Dashboard und als Prometheus-Metriken (`opnexus_host_gateway_*`,
  `opnexus_host_swap_used_percent`, `opnexus_host_service_running`). Die Messung speichert dafür zusätzlich Swap, CPU-Threads, Gateways
  und Dienste in der vorhandenen Messreihe (keine neue Tabelle).
- **Weitere Benachrichtigungskanäle:** ntfy, Gotify, Telegram, Microsoft Teams (Workflows-/Incoming-Webhook) und Matrix, beliebig viele
  je Typ, mit „Testen“-Knopf pro Kanal. Zugangsdaten (Tokens, die Teams-Adresse) liegen wie das SMTP-Passwort in der Geheimnis-Ablage, nie
  in der Datenbank oder in Antworten, und tauchen nicht in Fehlermeldungen oder Logs auf. Webhook und neue Kanäle prüfen die Zieladresse:
  nur http(s), keine Zugangsdaten in der Adresse, keine lokalen/Link-Local-/Metadaten-Adressen; Weiterleitungen werden nicht verfolgt.
  Betrifft die bestehende Webhook-Adresse: `localhost`, Loopback, 169.254.x.x und Zugangsdaten in der Adresse (`https://user:pass@…`)
  werden jetzt abgelehnt. Eine solche gespeicherte Adresse wird nicht mehr beliefert (nur ein Log-Eintrag), und die
  Benachrichtigungs-Einstellungen lassen sich erst wieder speichern, wenn sie korrigiert oder geleert ist (die Meldung nennt den Grund).
  Neue Einstellungen kommen mit Migration 0020.

- **Bestand übernehmen für Aliase und NAT:** Auf den Seiten Aliase und NAT (Port Forward, 1:1, Outbound) gibt es jetzt **Von Firewall übernehmen**
  wie bei den Regeln. Der Dialog zeigt, was von Hand in OPNsense angelegt wurde, einzeln zum Übernehmen oder mit „Alle übernehmbaren“ in einem Schritt;
  verschachtelte Aliase werden in der richtigen Reihenfolge übernommen. Die Übernahme schreibt nichts auf die Firewall: Die Vorschau zeigt direkt
  danach „keine Änderung“, der nächste Rollout aktualisiert dasselbe Objekt (kein Duplikat). Nicht übernommen werden OPNsense-eigene Aliase,
  Typen, die OPNexus nicht kennt (z. B. URL, GeoIP), Aliase mit Verweis auf nicht übernommene Aliase sowie NAT-Regeln, die das Modell verfälschen würden
  (z. B. „Kein Redirect“, verknüpfte Filterregel, mehrere Schnittstellen, „Kein NAT“); die Oberfläche nennt den Grund je Objekt.
  Outbound-NAT lässt sich nur übernehmen, wenn der Modus der Firewall Hybrid oder Manuell ist. Einstellungen, die OPNexus nicht verwaltet (Protokollierung,
  Pool-Optionen, Tags, Kategorien), bleiben unverändert und werden angezeigt.

- **Images für ARM:** Alle Release-Images (backend, frontend, proxy, updater) gibt es jetzt für `linux/amd64` und `linux/arm64`
  (Raspberry Pi 4/5, ARM-Server, Apple-Silicon-Docker).
2026-10-21 01:57:30 +02:00
Julian Boldt 9ba6357193 Release v1.23.11
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Updates per Klick prüfen jetzt ebenfalls die Signatur:** Der Updater-Container enthält `cosign` (feste Version, Prüfsumme beim Bau
  geprüft) und verifiziert die neuen Images vor dem Wechsel, wenn `cosign.pub` im Projektverzeichnis liegt. Das Image wird dadurch größer
  (rund 266 statt 123 MB).
2026-10-20 15:46:34 +02:00
Julian Boldt 23d3a00ae1 Release v1.23.10
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Signierte Release-Images:** Die Images (backend, frontend, proxy, updater) werden mit cosign signiert, beginnend mit 1.23.9. Der öffentliche
  Schlüssel liegt als `cosign.pub` im Repository und im Release-Bundle. `opnexus update` prüft die Signaturen vor dem Wechsel, wenn `cosign`
  installiert ist. Anleitung: Handbuch, „Images prüfen“.
2026-10-20 15:38:35 +02:00
Julian Boldt 4379a17b15 Release v1.23.9
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- Update-Karte: Der Hinweis für Installationen ohne Release-Images nennt jetzt die tatsächliche Ursache („OPNEXUS_IMAGE_REPO ist nicht gesetzt“)
  statt „baut aus dem Quellcode“.
- `cosign.pub`: öffentlicher Schlüssel für die Signaturen der Release-Images (das Release-Skript kann Images jetzt signieren).
2026-10-20 15:16:51 +02:00
Julian Boldt 983e05a816 Release v1.23.8
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Einstellungen › OPNexus aktualisieren:** Auf einer Installation, die aus dem Quellcode gebaut wird (kein `OPNEXUS_IMAGE_REPO`), erscheint nicht mehr
  die Anleitung zum Aktivieren des Updaters – Updates per Klick gibt es dort ohnehin nicht –, sondern nur der Hinweis auf `git pull` und
  `docker compose up -d --build`. Das Backend erkennt den Modus jetzt selbst (neue Umgebungsvariable im Compose-File).
2026-10-20 14:52:10 +02:00
Julian Boldt dd6a64d953 Release v1.23.7
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- Hinweistext der Versionsprüfung verweist auf den Schalter „oben“ statt „unten“.
2026-10-20 14:43:39 +02:00
Julian Boldt 6964ec6537 Release v1.23.6
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Versionsprüfung im Webinterface:** Unter Einstellungen › OPNexus aktualisieren lässt sich die Prüfung auf neue Versionen jetzt per Schalter
  und Feed-Adresse einstellen – kein Eingriff in die `.env` mehr nötig (Migration `0019`). Standardmäßig bleibt sie aus. Ein gesetztes
  `UPDATE_CHECK_URL` in der `.env` hat weiter Vorrang und sperrt den Schalter (mit Hinweis).
2026-10-20 14:38:19 +02:00
Julian Boldt 5e5d51b57f Release v1.23.5
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Fix (Ursache des Vorfalls vom 20.10. in 1.23.4):** OPNsense merkt ein CARP-VIP zum Löschen vor, wenn eine Änderung kein `interface` mitschickt,
  und der anschließende „Anwenden“-Schritt entfernt es dann live, ohne es wieder anzulegen. OPNexus schickt bei jeder VIP-Änderung jetzt die
  bisherige Schnittstelle mit (wie schon die Adresse). Auf dem Test-Cluster mit echten Firewalls nachgestellt und bestätigt.
- **Einstellungen › OPNexus aktualisieren:** Die Anleitung zum Aktivieren nennt jetzt alles Nötige in einem Block (auch `UPDATE_CHECK_URL`) und weist
  darauf hin, dass Updates per Klick Release-Images brauchen; wer aus dem Quellcode baut, aktualisiert mit `git pull` und `docker compose up -d --build`.
2026-10-20 14:22:12 +02:00
Julian Boldt 1aba618ad5 Release v1.23.4
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Fix (Produktiv-Vorfall 2026-10-20):** Das Ändern der Beschreibung eines CARP-VIP wendete das VIP neu an und ließ es auf beiden Firewalls
  im Zustand INIT hängen – OPNexus zeigte trotzdem „alles in Ordnung“. Nur die Beschreibung zu ändern, wendet jetzt nichts mehr an. Nach jeder
  anderen CARP-VIP-Änderung prüft OPNexus den Live-Zustand (MASTER/BACKUP), wendet bei Bedarf einmal erneut an und meldet sonst „Angewendet,
  Prüfung weicht ab“.
- **CARP-Überwachung je VHID:** Neue Warnungen `vip_down` (ein VIP ist auf einem Node nicht aktiv) und `role_mismatch` (ein Node ist nur für
  einen Teil der VIPs MASTER). Bisher zählte der Host schon als MASTER, sobald ein einziges VIP MASTER war.
2026-10-20 13:56:25 +02:00
Julian Boldt ba954c05bf Release v1.23.3
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **SSO:** Liefert der Anbieter `preferred_username`/`email` nicht im ID-Token (Authelia), fragt OPNexus sie beim Userinfo-Endpunkt ab; der neue
  Benutzer heißt dann `alice` statt wie die kryptische Benutzerkennung des Anbieters. Geprüft gegen Keycloak 26 und Authelia 4.39; S3-Offsite gegen
  Garage, MinIO, RustFS und Versity S3 Gateway.
2026-10-20 12:56:39 +02:00
Julian Boldt 63d014b14c Release v1.23.2
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **SSO-Fix (gefunden beim Test gegen ein echtes Keycloak):** Die Standard-Scopes enthalten nicht mehr `groups` – Keycloak und Entra ID
  lehnten die Anmeldung damit mit `invalid_scope` ab. Bestehende Einstellungen mit dem alten Standardwert werden umgestellt (Migration
  `0018`); Anbieter wie Okta tragen `groups` bei Bedarf selbst ein (Hinweis in den Einstellungen).
2026-10-20 09:17:31 +02:00
Julian Boldt 4838dad588 Release v1.23.1
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Sicherheit (Ergebnis eines unabhängigen Reviews der Versionen 1.18–1.23):**
  - Aufgabentrennung: Mit „nur Admins rollen aus“ ist jetzt auch das Löschen verwalteter Objekte (entfernt sie von den Firewalls), Zertifikat-/ACME-Push, Dienste starten/stoppen und „Reihenfolge erneut durchsetzen“ den Admins vorbehalten, nicht nur `/deploy`.
  - Backup-Änderungsansicht: weitere Geheimnis-Felder (`otp_seed`, `pass`, `pwd`, …) werden ausgeblendet, die Platzhalter sind pro Abruf gesalzen (kein Wörterbuchabgleich, kein Vergleich über Abrufe/Firewalls).
  - SSO: der Anmeldeversuch ist per Cookie an den Browser gebunden (kein Login-CSRF, abgefangene Code/State-Paare sind nutzlos); SSO-Sitzungen dauern 12 Stunden statt 30 Tage; Gruppen-Strings werden nur an Komma/Zeilenumbruch getrennt (Gruppen mit Leerzeichen); Fehlertext des Anbieters wird für das Log bereinigt.
  - Das Ändern des eigenen Passworts widerruft jetzt auch die eigenen API-Tokens.
  - Management-Tunnel: der Hub routet nicht mehr zwischen Firewalls oder ins Compose-Netz (`FORWARD` verworfen, `ip_forward=0`); loopback-/link-local-Netze sind als Tunnel-Netz nicht erlaubt.
  - Sicherheitslage: eine defekte `config.xml` stoppt die Prüfung der übrigen Firewalls nicht mehr; die Auswertung läuft außerhalb der Ereignisschleife.
  - Behoben: S3-Offsite mit Port 443 im Endpunkt (Signatur passte nicht); Variablenwerte mit angehängtem Zeilenumbruch werden abgelehnt.
- Fertiges **Grafana-Dashboard** (`docs/grafana-opnexus.json`) für die Prometheus-Metriken von OPNexus.
2026-10-20 02:24:15 +02:00
Julian Boldt c4c8c4ff3a Release v1.23.0
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Sicherheitslage im Alltag**: Dashboard-Karte mit den Firewalls mit dem niedrigsten Wert; Benachrichtigung bei kritischen und hohen
  Befunden (je Firewall und Prüfung, mit „behoben“-Meldung; standardmäßig aus; Migration `0017`); druckbarer **Sicherheitsbericht**
  (Knopf „Bericht“, Drucken/PDF über den Browser).
2026-10-20 02:02:04 +02:00
Julian Boldt 295555cfd6 Release v1.22.0
Release / verify (push) Canceled after 0s
CI / checks (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CI / backend (push) Canceled after 0s
Release / test (push) Canceled after 0s
Release / publish (backend) (push) Canceled after 0s
Release / publish (frontend) (push) Canceled after 0s
Release / publish (proxy) (push) Canceled after 0s
Release / publish (updater) (push) Canceled after 0s
- **Standort-Variablen**: `{{NAME}}`-Platzhalter in Regeln, Aliasen, Portweiterleitungen, 1:1- und Outbound-NAT, je Host mit eigenem Wert
  (Host-Seite › Standort-Variablen, listet die verwendeten Platzhalter automatisch). Je Host aufgelöst in Vorschau, Ausrollen, Zählern und
  Audit; fehlt ein Wert, wird nichts gesendet (Vorschau „Variable fehlt“, Ausrollen wird vor jedem Schreiben abgelehnt, zusätzlich eine
  Sperre im API-Client). Neue Tabelle `host_variables` (Migration `0016`).
2026-10-20 01:42:30 +02:00
182 changed files with 20538 additions and 312 deletions

No files matched your search

+26 -1
View File
@@ -73,6 +73,8 @@ TRUST_PROXY_HEADERS=false
# User-Agent "OPNexus/<Version>". Admins sehen bei einer neueren Version einen
# Hinweis; aktualisiert wird nie automatisch, sondern mit `opnexus update` oder
# (optional, siehe unten) per Klick im Webinterface.
# Einfacher: im Webinterface unter Einstellungen › OPNexus aktualisieren einschalten.
# Ein Wert hier hat Vorrang und sperrt den Schalter dort.
# UPDATE_CHECK_URL=https://updates.opnexus.dev/latest.json
# UPDATE_CHECK_INTERVAL_HOURS=12
@@ -80,7 +82,7 @@ TRUST_PROXY_HEADERS=false
# Startet den Updater-Container, mit dem Admins unter Einstellungen › „OPNexus
# aktualisieren“ ein Update auslösen können. Er ist der einzige Container mit
# Docker-Socket-Zugriff (= root-gleiche Rechte auf diesem Host) und standardmäßig
# AUS. Benötigt außerdem UPDATE_CHECK_URL (oben). Siehe Handbuch, "Updates per Klick".
# AUS. Braucht außerdem die Versionsprüfung (Webinterface oder UPDATE_CHECK_URL, oben). Siehe Handbuch, "Updates per Klick".
# COMPOSE_PROFILES=updater
# ── Transportsicherheit (nur ändern, wenn nötig) ──────────────────────
@@ -98,3 +100,26 @@ TRUST_PROXY_HEADERS=false
# Zum Aktivieren (Handbuch „Firewalls hinter NAT“): COMPOSE_PROFILES=overlay
# und den UDP-Port aus dem Internet erreichbar machen.
#OVERLAY_PORT=51820
# ── GUI-Fernzugriff auf verwaltete Firewalls (optional, Standard AUS) ──
# Öffnet die Weboberfläche einer Firewall über OPNexus, auch hinter NAT
# (Management-Tunnel), jeweils in einem eigenen Browser-Ursprung (Slot-Port).
# Dreifach aus, bis alles hier gesetzt ist UND ein Admin den Schalter unter
# Einstellungen einschaltet. Voraussetzungen: HTTPS über den Proxy und
# COOKIE_SECURE=true. Siehe Handbuch, „Firewall-Oberfläche über OPNexus“.
# 1. Profil aktivieren (mit anderen Profilen kommagetrennt, z. B. overlay,gui):
# COMPOSE_PROFILES=gui
# 2. Slot-Ursprünge: dieselbe Adresse wie in OPNEXUS_SITES, je Slot ein Port
# aus GUI_PORTS. Darf NICHT in FRONTEND_ORIGIN stehen (Start wird sonst verweigert).
# OPNEXUS_GUI_SITES=https://10.0.0.5:9441, https://10.0.0.5:9442, https://10.0.0.5:9443, https://10.0.0.5:9444
# 3. Gemeinsames Geheimnis Backend <-> Gateway, mind. 32 Zeichen, z. B.
# `openssl rand -hex 32`:
# GUI_GATEWAY_TOKEN=
# 4. Wo die Slot-Ports lauschen. Standard nur lokal (127.0.0.1); für den
# Zugriff aus dem Netz die Adresse dieses Hosts eintragen (wie bei
# PROXY_BIND_ADDRESS). GUI_PORTS ist ein Bereich, Host- und Container-Port
# sind gleich. GUI_PORTS zum Einschalten SETZEN: ohne den Eintrag nimmt
# Docker zufällige freie Ports (damit ein Update nie an belegten Ports wie
# 9443 scheitert), und die Slot-Adressen oben wären nicht erreichbar.
# GUI_BIND_ADDRESS=127.0.0.1
# GUI_PORTS=9441-9444
+209
View File
@@ -31,6 +31,215 @@ den Einstellungen.
Nächste Codenamen (der Reihe nach, wenn die jeweils nächste MINOR-Version
ansteht): Merlin …
## [1.27.1] "Buzzard" — 2026-10-21
- **Fix (1.27.1): Proxy startete mit der neuen Compose-Datei nicht.** Mit der `docker-compose.yml` aus 1.27.0 gab Compose die Variable
`OPNEXUS_GUI_SITES` als leeren Text an den Proxy weiter; Caddy nutzt seinen Standardwert aber nur bei *nicht gesetzter* Variable und
brach mit „server block without any key“ ab, OPNexus war dann nicht mehr erreichbar. Die Compose-Datei setzt jetzt einen gültigen
Platzhalter als Standard. Betroffen waren nur Installationen, die die neue Compose-Datei aus 1.27.0 übernommen hatten (ohne
`OPNEXUS_GUI_SITES` in der `.env`); wer nur die Images aktualisiert hatte, war nicht betroffen. Sofort-Abhilfe ohne Update:
`OPNEXUS_GUI_SITES=https://localhost:9441` in die `.env` eintragen und `docker compose up -d proxy` ausführen.
## [1.27.0] "Buzzard" — 2026-10-21
Vorgesehen als MINOR-Release **1.27.0** „Firewall-Oberfläche über OPNexus“.
- **Firewall-Oberfläche über OPNexus:** Auf der Host-Seite öffnet **Oberfläche öffnen** die Weboberfläche der Firewall
in einem neuen Tab, auch bei Firewalls hinter NAT im Management-Tunnel. Nur für Admins; jede Firewall läuft in einer
eigenen Browser-Origin (Platz = Port), Cookies bleiben auf dem Server, das Ticket gilt einmalig 30 Sekunden,
Inaktivitäts- und Gesamtlimit sind einstellbar, Ticket, Start und Ende stehen im Audit (Art „GUI-Zugriff“).
Standardmäßig **aus**: braucht das Compose-Profil `gui`, `OPNEXUS_GUI_SITES`, `GUI_PORTS`, `GUI_GATEWAY_TOKEN`,
`COOKIE_SECURE=true` und den Schalter unter Einstellungen (Handbuch, „Firewall-Oberfläche über OPNexus“).
Live getestet auf OPNsense 26.7.
- **Einschränkungen:** kein WebSocket, keine automatische Anmeldung, höchstens 4 Plätze gleichzeitig. OPNexus-Adresse
vorher in die Whitelist des Anmeldeschutzes (sshguard) der Firewall eintragen, sonst können Fehlanmeldungen die
API-Zugriffe von OPNexus aussperren. Nach einem Neustart des wg-hub braucht der Tunnel 2 bis 4 Minuten.
- **Hinweis für Betreiber mit eigenen Skripten:** Bei HTTPS heißt das Sitzungs-Cookie jetzt `__Host-opnexus-session`
(bestehende Sitzungen werden ohne Abmelden übernommen), und Cookie-Anfragen an `/api` mit `Sec-Fetch-Site: same-site/cross-site`
werden abgelehnt. Zugriffe mit API-Token sind nicht betroffen.
## [1.26.0] "Kite" — 2026-10-21
Geplant als MINOR-Release **1.26.0** (Regel-Analyse). Backend, MCP und Oberfläche.
- **Regel-Analyse „Welche Regel greift?“ (API):** `GET /api/hosts/{id}/rule-analysis/match` und
`GET /api/rule-analysis/match` (ganze Flotte, Auswahl oder Gerätegruppe) beantworten für Quelle, Ziel, Protokoll
und Port, ob eine Firewall das erste Paket einer neuen Verbindung durchlässt oder blockiert, welche Regel das
entscheidet und warum (Prüfprotokoll Regel für Regel). Grundlage ist der tatsächlich geladene pf-Regelsatz
inklusive automatischer Regeln, Floating- und Gruppenregeln, `quick`/letzter Treffer, Negation, verschachtelter
Aliase (pf-Tabellentest der Firewall), Port-Aliase und Adressfamilien. Jede Antwort trägt eine ehrliche
Konfidenz **sicher / vermutlich / unbekannt** mit Begründungscodes; was nicht belegbar ist (z. B. `tagged`,
nicht auflösbare Aliase, geratenes Interface, NAT in der Nähe), wird nie als „sicher“ gemeldet. Nur lesend,
auch mit `read`-Token nutzbar; es wird nichts gespeichert und nichts an der Firewall geändert.
- **MCP:** neues Werkzeug `rule_match` für KI-Assistenten (gleiche Abfrage, ohne Prüfprotokoll).
- **Seite „Regel-Analyse“ (Regelwerk):** Formular für Hosts oder Gerätegruppe, Quell-/Ziel-IP, Protokoll, Ports,
Eingangs-Interface („automatisch“ oder Liste) und optional die Ausgangsseite. Die Abfrage steht in der Adresszeile
(teilbar, wird beim Öffnen sofort ausgeführt). Je Firewall eine Karte mit Erlaubt/Blockiert/Abgewiesen, Sicherheit
des Urteils, entscheidender Regel und Hinweisen; ein „unbekannt“-Ergebnis erscheint bewusst nicht als Urteil.
Aufklappbares „Warum?“ zeigt jede geprüfte Regel mit ✓/✗/? je Feld, überstimmte Regeln durchgestrichen. Auch mit
Nur-Lesen-Rolle nutzbar.
## [1.25.0] "Goshawk" — 2026-10-21
Geplant als MINOR-Release **1.25.0** (Flotten-Rollout).
- **Rollouts in Wellen (System › Rollouts):** Firmware-Updates für die ganze Flotte in Ringen, z. B. erst
`ring-canary`, dann `ring-pilot`, dann `ring-prod` (Wellen aus Gerätegruppen). Jeder Host läuft über die
bestehende geplante Wartung (Backup vor dem Update, CARP-Übergabe für den MASTER, Audit), immer nur ein Host
gleichzeitig und nur ein Rollout zur selben Zeit; im Cluster zuerst der BACKUP, dann der MASTER. Nach jeder Welle
folgen eine Beobachtungszeit und eine **Gesundheitsprüfung** (erreichbar, Zielversion installiert, CARP je VHID,
Gateways und Dienste wie vorher, keine offenen Sperren, optional Sicherheits-Score). Rot hält den Rollout an
(nach einer Nachprüfung zwei Minuten später) und meldet sich. Anhalten, Fortsetzen (prüft zuerst alles bisher
Aktualisierte erneut), Welle freigeben, Host überspringen und Abbrechen auf der Lauf-Seite; die Seite zeigt
Wellen, Hosts (Version vorher → nachher, aktueller Schritt) und die Prüfmatrix.
- **Sicherheitsnetz:** Weicht die angebotene Version in einem späteren Ring von der des ersten Rings ab, hält der
Rollout an (OPNsense installiert immer die neueste). Ein Host ohne Update wird übersprungen, ein fehlgeschlagener
nie von selbst wiederholt. Angehalten wird auch, wenn die verantwortliche Person das Recht zum Ausrollen verliert,
eine fremde Wartung im Cluster länger als 15 Minuten offen ist, der MASTER ohne Übergabe dran wäre oder ein Lauf
älter als 14 Tage ist. Höchstens 10 Wellen und 100 Hosts je Plan.
- **Wiederkehrende Wartungsfenster:** wöchentlich oder monatlich (n-ter Wochentag, letzter, fester Tag) in einer
Zeitzone, mit Sommerzeit-Regel, Abschneidezeit („neue Hosts nur in den ersten N Minuten“) und einzelnen Terminen
zum Auslassen oder Verschieben. Ein Plan mit Fenster startet neue Hosts nur darin; mit **automatischem Start**
(nur stabile Updates) beginnt er zu jedem Termin von selbst, aber nur, solange Plan, Gruppen und Fenster seit
der Aktivierung unverändert sind. Jede Änderung deaktiviert ihn.
- **Geplante Wartung prüft sich selbst:** Neue Option „Ergebnis automatisch prüfen und abschließen“ (im Dialog
vorausgewählt, bei Rollouts immer an). Nach dem Auftrag prüft OPNexus, ob die Firmware wieder bereit ist, der
erwartete Neustart stattfand und die Version lesbar ist, und schließt die Wartung dann selbst ab. Bisher blieb
sie auf „übergeben“ und sperrte Host und Cluster, bis jemand sie von Hand abschloss.
- **Benachrichtigungen:** „Rollout angehalten“ und „Rollout nicht automatisch gestartet“ (ein Schalter, standardmäßig an).
- **Rechte:** Rollout starten/aktivieren/fortsetzen/freigeben/überspringen/abbrechen und Wartungsfenster ändern
gelten als Ausrollen (Aufgabentrennung); **Anhalten** darf jeder mit Schreibrecht. Update Center: Hosts im
laufenden Rollout sind für manuelle Firmware-Aktionen gesperrt. Ein OPNexus-Update während eines Rollouts ist
sicher, wird aber angekündigt.
- **Getestet:** live auf den Test-Firewalls (OPNsense 26.7): automatischer Start im Fenster, Canary-Update
26.7.1_1 → 26.7.7, absichtlich gestoppter Dienst → Gate rot → angehalten (zweiter Ring unberührt,
Benachrichtigung), Fortsetzen, Pilot-Update 26.7.6 → 26.7.7 auf dem damaligen MASTER mit CARP-Übergabe und einem
Neustart des OPNexus-Backends mitten im Auftrag (genau ein Update-Auftrag), Freigabe, Host ohne Update
übersprungen, Anhalten/Fortsetzen/Abbrechen von Hand, Termin auslassen. **Nur gemockt:** Major-Upgrade als
Rollout, ein Cluster in *einer* Welle, Cluster-Prüfung vor dem zweiten Knoten, abweichende Zielversion,
Zeitüberschreitungen, Rechteverlust, Fenster schließt mitten im Lauf; die Sommerzeit-Regeln sind Rechentests.
## [1.24.0] "Merlin" — 2026-10-21
- **Alarme für Gateways, Ressourcen und Dienste:** Neue Ereignisse in Einstellungen › Benachrichtigungen.
**Gateway gestört** (standardmäßig **an**) meldet ein Gateway, das OPNsense als „down“ führt oder dessen Paketverlust (ab 20 %) bzw.
Latenz (ab 500 ms) über der Schwelle liegt; bewusst abgeschaltete und nicht überwachte Gateways bleiben still. **Ressourcen-Schwelle**
(standardmäßig aus) prüft Festplatte (ab 90 %), Arbeitsspeicher (ab 95 %), Swap (ab 50 %) und CPU-Last (ab 2 pro Thread), **Dienst ausgefallen**
(standardmäßig aus) eine einstellbare Liste (Unbound, Dnsmasq, DHCP, NTP, OpenVPN, WireGuard, IPsec …) und meldet nur Dienste, die zuvor
liefen. Alle drei stützen sich auf die Minutenmessung und lösen erst aus, wenn die letzten 3 (Ressourcen: 5) Messungen übereinstimmen, und
enden erst, wenn alle wieder in Ordnung sind: Einzelspitzen und flackernde Verbindungen schicken nichts. Der Gateway-Status (Verlust, Latenz,
Abweichung) steht außerdem auf der Host-Seite, als Kachel auf dem Dashboard und als Prometheus-Metriken (`opnexus_host_gateway_*`,
`opnexus_host_swap_used_percent`, `opnexus_host_service_running`). Die Messung speichert dafür zusätzlich Swap, CPU-Threads, Gateways
und Dienste in der vorhandenen Messreihe (keine neue Tabelle).
- **Weitere Benachrichtigungskanäle:** ntfy, Gotify, Telegram, Microsoft Teams (Workflows-/Incoming-Webhook) und Matrix, beliebig viele
je Typ, mit „Testen“-Knopf pro Kanal. Zugangsdaten (Tokens, die Teams-Adresse) liegen wie das SMTP-Passwort in der Geheimnis-Ablage, nie
in der Datenbank oder in Antworten, und tauchen nicht in Fehlermeldungen oder Logs auf. Webhook und neue Kanäle prüfen die Zieladresse:
nur http(s), keine Zugangsdaten in der Adresse, keine lokalen/Link-Local-/Metadaten-Adressen; Weiterleitungen werden nicht verfolgt.
Betrifft die bestehende Webhook-Adresse: `localhost`, Loopback, 169.254.x.x und Zugangsdaten in der Adresse (`https://user:pass@…`)
werden jetzt abgelehnt. Eine solche gespeicherte Adresse wird nicht mehr beliefert (nur ein Log-Eintrag), und die
Benachrichtigungs-Einstellungen lassen sich erst wieder speichern, wenn sie korrigiert oder geleert ist (die Meldung nennt den Grund).
Neue Einstellungen kommen mit Migration 0020.
- **Bestand übernehmen für Aliase und NAT:** Auf den Seiten Aliase und NAT (Port Forward, 1:1, Outbound) gibt es jetzt **Von Firewall übernehmen**
wie bei den Regeln. Der Dialog zeigt, was von Hand in OPNsense angelegt wurde, einzeln zum Übernehmen oder mit „Alle übernehmbaren“ in einem Schritt;
verschachtelte Aliase werden in der richtigen Reihenfolge übernommen. Die Übernahme schreibt nichts auf die Firewall: Die Vorschau zeigt direkt
danach „keine Änderung“, der nächste Rollout aktualisiert dasselbe Objekt (kein Duplikat). Nicht übernommen werden OPNsense-eigene Aliase,
Typen, die OPNexus nicht kennt (z. B. URL, GeoIP), Aliase mit Verweis auf nicht übernommene Aliase sowie NAT-Regeln, die das Modell verfälschen würden
(z. B. „Kein Redirect“, verknüpfte Filterregel, mehrere Schnittstellen, „Kein NAT“); die Oberfläche nennt den Grund je Objekt.
Outbound-NAT lässt sich nur übernehmen, wenn der Modus der Firewall Hybrid oder Manuell ist. Einstellungen, die OPNexus nicht verwaltet (Protokollierung,
Pool-Optionen, Tags, Kategorien), bleiben unverändert und werden angezeigt.
- **Images für ARM:** Alle Release-Images (backend, frontend, proxy, updater) gibt es jetzt für `linux/amd64` und `linux/arm64`
(Raspberry Pi 4/5, ARM-Server, Apple-Silicon-Docker).
## [1.23.11] "Harrier" — 2026-10-20
- **Updates per Klick prüfen jetzt ebenfalls die Signatur:** Der Updater-Container enthält `cosign` (feste Version, Prüfsumme beim Bau
geprüft) und verifiziert die neuen Images vor dem Wechsel, wenn `cosign.pub` im Projektverzeichnis liegt. Das Image wird dadurch größer
(rund 266 statt 123 MB).
## [1.23.10] "Harrier" — 2026-10-20
- **Signierte Release-Images:** Die Images (backend, frontend, proxy, updater) werden mit cosign signiert, beginnend mit 1.23.9. Der öffentliche
Schlüssel liegt als `cosign.pub` im Repository und im Release-Bundle. `opnexus update` prüft die Signaturen vor dem Wechsel, wenn `cosign`
installiert ist. Anleitung: Handbuch, „Images prüfen“.
## [1.23.9] "Harrier" — 2026-10-20
- Update-Karte: Der Hinweis für Installationen ohne Release-Images nennt jetzt die tatsächliche Ursache („OPNEXUS_IMAGE_REPO ist nicht gesetzt“)
statt „baut aus dem Quellcode“.
- `cosign.pub`: öffentlicher Schlüssel für die Signaturen der Release-Images (das Release-Skript kann Images jetzt signieren).
## [1.23.8] "Harrier" — 2026-10-20
- **Einstellungen › OPNexus aktualisieren:** Auf einer Installation, die aus dem Quellcode gebaut wird (kein `OPNEXUS_IMAGE_REPO`), erscheint nicht mehr
die Anleitung zum Aktivieren des Updaters – Updates per Klick gibt es dort ohnehin nicht –, sondern nur der Hinweis auf `git pull` und
`docker compose up -d --build`. Das Backend erkennt den Modus jetzt selbst (neue Umgebungsvariable im Compose-File).
## [1.23.7] "Harrier" — 2026-10-20
- Hinweistext der Versionsprüfung verweist auf den Schalter „oben“ statt „unten“.
## [1.23.6] "Harrier" — 2026-10-20
- **Versionsprüfung im Webinterface:** Unter Einstellungen › OPNexus aktualisieren lässt sich die Prüfung auf neue Versionen jetzt per Schalter
und Feed-Adresse einstellen – kein Eingriff in die `.env` mehr nötig (Migration `0019`). Standardmäßig bleibt sie aus. Ein gesetztes
`UPDATE_CHECK_URL` in der `.env` hat weiter Vorrang und sperrt den Schalter (mit Hinweis).
## [1.23.5] "Harrier" — 2026-10-20
- **Fix (Ursache des Vorfalls vom 20.10. in 1.23.4):** OPNsense merkt ein CARP-VIP zum Löschen vor, wenn eine Änderung kein `interface` mitschickt,
und der anschließende „Anwenden“-Schritt entfernt es dann live, ohne es wieder anzulegen. OPNexus schickt bei jeder VIP-Änderung jetzt die
bisherige Schnittstelle mit (wie schon die Adresse). Auf dem Test-Cluster mit echten Firewalls nachgestellt und bestätigt.
- **Einstellungen › OPNexus aktualisieren:** Die Anleitung zum Aktivieren nennt jetzt alles Nötige in einem Block (auch `UPDATE_CHECK_URL`) und weist
darauf hin, dass Updates per Klick Release-Images brauchen; wer aus dem Quellcode baut, aktualisiert mit `git pull` und `docker compose up -d --build`.
## [1.23.4] "Harrier" — 2026-10-20
- **Fix (Produktiv-Vorfall 2026-10-20):** Das Ändern der Beschreibung eines CARP-VIP wendete das VIP neu an und ließ es auf beiden Firewalls
im Zustand INIT hängen – OPNexus zeigte trotzdem „alles in Ordnung“. Nur die Beschreibung zu ändern, wendet jetzt nichts mehr an. Nach jeder
anderen CARP-VIP-Änderung prüft OPNexus den Live-Zustand (MASTER/BACKUP), wendet bei Bedarf einmal erneut an und meldet sonst „Angewendet,
Prüfung weicht ab“.
- **CARP-Überwachung je VHID:** Neue Warnungen `vip_down` (ein VIP ist auf einem Node nicht aktiv) und `role_mismatch` (ein Node ist nur für
einen Teil der VIPs MASTER). Bisher zählte der Host schon als MASTER, sobald ein einziges VIP MASTER war.
## [1.23.3] "Harrier" — 2026-10-20
- **SSO:** Liefert der Anbieter `preferred_username`/`email` nicht im ID-Token (Authelia), fragt OPNexus sie beim Userinfo-Endpunkt ab; der neue
Benutzer heißt dann `alice` statt wie die kryptische Benutzerkennung des Anbieters. Geprüft gegen Keycloak 26 und Authelia 4.39; S3-Offsite gegen
Garage, MinIO, RustFS und Versity S3 Gateway.
## [1.23.2] "Harrier" — 2026-10-20
- **SSO-Fix (gefunden beim Test gegen ein echtes Keycloak):** Die Standard-Scopes enthalten nicht mehr `groups` – Keycloak und Entra ID
lehnten die Anmeldung damit mit `invalid_scope` ab. Bestehende Einstellungen mit dem alten Standardwert werden umgestellt (Migration
`0018`); Anbieter wie Okta tragen `groups` bei Bedarf selbst ein (Hinweis in den Einstellungen).
## [1.23.1] "Harrier" — 2026-10-20
- **Sicherheit (Ergebnis eines unabhängigen Reviews der Versionen 1.18–1.23):**
- Aufgabentrennung: Mit „nur Admins rollen aus“ ist jetzt auch das Löschen verwalteter Objekte (entfernt sie von den Firewalls), Zertifikat-/ACME-Push, Dienste starten/stoppen und „Reihenfolge erneut durchsetzen“ den Admins vorbehalten, nicht nur `/deploy`.
- Backup-Änderungsansicht: weitere Geheimnis-Felder (`otp_seed`, `pass`, `pwd`, …) werden ausgeblendet, die Platzhalter sind pro Abruf gesalzen (kein Wörterbuchabgleich, kein Vergleich über Abrufe/Firewalls).
- SSO: der Anmeldeversuch ist per Cookie an den Browser gebunden (kein Login-CSRF, abgefangene Code/State-Paare sind nutzlos); SSO-Sitzungen dauern 12 Stunden statt 30 Tage; Gruppen-Strings werden nur an Komma/Zeilenumbruch getrennt (Gruppen mit Leerzeichen); Fehlertext des Anbieters wird für das Log bereinigt.
- Das Ändern des eigenen Passworts widerruft jetzt auch die eigenen API-Tokens.
- Management-Tunnel: der Hub routet nicht mehr zwischen Firewalls oder ins Compose-Netz (`FORWARD` verworfen, `ip_forward=0`); loopback-/link-local-Netze sind als Tunnel-Netz nicht erlaubt.
- Sicherheitslage: eine defekte `config.xml` stoppt die Prüfung der übrigen Firewalls nicht mehr; die Auswertung läuft außerhalb der Ereignisschleife.
- Behoben: S3-Offsite mit Port 443 im Endpunkt (Signatur passte nicht); Variablenwerte mit angehängtem Zeilenumbruch werden abgelehnt.
- Fertiges **Grafana-Dashboard** (`docs/grafana-opnexus.json`) für die Prometheus-Metriken von OPNexus.
## [1.23.0] "Harrier" — 2026-10-20
- **Sicherheitslage im Alltag**: Dashboard-Karte mit den Firewalls mit dem niedrigsten Wert; Benachrichtigung bei kritischen und hohen
Befunden (je Firewall und Prüfung, mit „behoben“-Meldung; standardmäßig aus; Migration `0017`); druckbarer **Sicherheitsbericht**
(Knopf „Bericht“, Drucken/PDF über den Browser).
## [1.22.0] "Peregrine" — 2026-10-20
- **Standort-Variablen**: `{{NAME}}`-Platzhalter in Regeln, Aliasen, Portweiterleitungen, 1:1- und Outbound-NAT, je Host mit eigenem Wert
(Host-Seite › Standort-Variablen, listet die verwendeten Platzhalter automatisch). Je Host aufgelöst in Vorschau, Ausrollen, Zählern und
Audit; fehlt ein Wert, wird nichts gesendet (Vorschau „Variable fehlt“, Ausrollen wird vor jedem Schreiben abgelehnt, zusätzlich eine
Sperre im API-Client). Neue Tabelle `host_variables` (Migration `0016`).
## [1.21.0] "Osprey" — 2026-10-20
- **Management-Tunnel** (System › Management-Tunnel): Firewalls hinter NAT/CGNAT verwalten. Ein optionaler WireGuard-Hub auf dem
+9 -6
View File
@@ -7,7 +7,7 @@ Zentrale Verwaltung mehrerer [OPNsense](https://opnsense.org)-Firewalls: Regeln,
![Zentrale Firewall-Regeln](docs/screenshots/readme-rules-de.webp)
> **Stand:** `1.21.0` ist die aktuelle stabile Version. Entwickelt und getestet wurde gegen echte OPNsense-Instanzen; eine frische Installation aus dem Release-Bundle sowie Updates und Rollbacks sind durchgängig geprüft. Ecken und Kanten bitte melden.
> **Stand:** `1.27.1` ist die aktuelle stabile Version. Entwickelt und getestet wurde gegen echte OPNsense-Instanzen; eine frische Installation aus dem Release-Bundle sowie Updates und Rollbacks sind durchgängig geprüft. Ecken und Kanten bitte melden.
## Funktionen
@@ -16,14 +16,17 @@ Zentrale Verwaltung mehrerer [OPNsense](https://opnsense.org)-Firewalls: Regeln,
- **Sichere Änderungen** — jede Änderung läuft *Prüfen → Ausrollen → Bestätigen*; bleibt die Bestätigung im Zeitfenster aus, rollt OPNexus zurück.
- **Hierarchische Policies** — Pre-/Post-Rulebases mit Vererbung über Gruppenbäume.
- **VPN** — IPsec-Site-to-Site, OpenVPN und WireGuard, einmal definiert und ausgerollt.
- **Netzwerk** — Schnittstellen, VLANs, virtuelle IPs, Gateways, Routen, LAGG/Bridge/GRE, DNS und DHCP je Firewall, dazu Tunables, Cron, Syslog, Snapshots und Diagnose (Ping, Traceroute, Port-Prüfung, DNS), ein Abgleich der Cluster-Knoten, mit Diff-Vorschau, Backup vor jeder Änderung und Schutz davor, die eigene Verbindung zu kappen; von Hand angelegte Regeln lassen sich übernehmen.
- **Netzwerk** — Schnittstellen, VLANs, virtuelle IPs, Gateways, Routen, LAGG/Bridge/GRE, DNS und DHCP je Firewall, dazu Tunables, Cron, Syslog, Snapshots und Diagnose (Ping, Traceroute, Port-Prüfung, DNS), ein Abgleich der Cluster-Knoten, mit Diff-Vorschau, Backup vor jeder Änderung und Schutz davor, die eigene Verbindung zu kappen; von Hand angelegte Regeln, Aliase und NAT-Regeln lassen sich übernehmen.
- **Zertifikate** — Trust-Store für alle Firewalls und Ausstellung per ACME / Let's Encrypt.
- **Alarme** — Gateway-/WAN-Ausfall (down, Paketverlust, Latenz), Schwellen für Platte, Speicher, Swap und CPU sowie ausgefallene Dienste; über mehrere Messungen entprellt, damit Einzelspitzen und flackernde Verbindungen schweigen. Zustellung per E-Mail, Webhook, ntfy, Gotify, Telegram, Microsoft Teams oder Matrix, jedes Ereignis einzeln schaltbar.
- **Firewall-Oberfläche über OPNexus** — die Weboberfläche einer Firewall in einem eigenen Browser-Tab über OPNexus öffnen, auch hinter NAT; nur für Admins, Einmal-Ticket, eigene Origin, Zeitlimits und Audit (standardmäßig aus).
- **Logs & Audit** — zentrale Log-Suche mit Korrelation, Dashboards und lückenloser Deploy-Verlauf.
- **Update-Center** — Firmware-Updates für die Flotte, mit Blick auf HA-Reihenfolge und Wartungsmodus.
- **Update-Center und Rollouts** — Firmware-Updates für die Flotte, mit Blick auf HA-Reihenfolge und Wartungsmodus; Rollouts in Wellen (Canary → Pilot → Prod) mit wiederkehrenden Wartungsfenstern, Gesundheitsprüfung zwischen den Wellen und automatischem Halt bei jeder Auffälligkeit.
- **Einrichtungsassistent** — geführter Erststart nach der Installation: eigenes Passwort, Zwei-Faktor und die erste Firewall verbinden.
- **Selbst-Update** — OPNexus aktualisiert sich auf Wunsch aus der eigenen Oberfläche, mit Fortschritt und automatischem Rollback (optional).
- **Automatisierung** — persönliche API-Tokens (Lesen / Ausrollen / Admin), Prometheus-Metriken, ein nur lesender MCP-Endpunkt für KI-Assistenten und ein OpenAPI-Schema.
- **Sicherheitslage** — ein Wert von 0 bis 100 je Firewall aus Härtungs- und Regel-Hygiene-Prüfungen (offene WAN-Regeln, schwaches SSH/SNMP, verdeckte Regeln, alte Backups …), nur lesend.
- **Regel-Analyse** — „Welche Regel trifft?“ für Quelle, Ziel, Protokoll und Port: die entscheidende Regel je Firewall (oder Flotte/Gruppe) mit ehrlicher Sicherheit (sicher / vermutlich / unbekannt) und Prüfprotokoll Regel für Regel, nur lesend.
- **Backups & Wiederherstellung** — geplante Konfigurationssicherungen mit Aufbewahrung, verschlüsselte Offsite-Kopie auf S3-kompatiblen Speicher, Änderungsansicht zwischen Sicherungen und eine vollständige verschlüsselte Sicherung von OPNexus selbst (`opnexus backup --full`).
- **Single Sign-on** — Anmeldung über deinen Identitätsanbieter (OIDC); die Rolle kommt bei jeder Anmeldung aus dessen Gruppen.
- **Zugang** — HTTPS mit gepinnten Firewall-Zertifikaten, optionale Zwei-Faktor-Anmeldung, Rollen (Admin / Operator / Nur-Lesen), Tastaturbedienung, Dark Mode, Oberfläche auf Deutsch und Englisch.
@@ -58,11 +61,11 @@ Nach der ersten Anmeldung öffnet sich von selbst ein kurzer **Einrichtungsassis
Für den Zugriff von anderen Rechnern und den Produktivbetrieb mit TLS (mitgelieferter Caddy-Proxy) siehe das [Handbuch](docs/HANDBUCH.md#zugriff-aus-dem-netz-und-tls).
**Fertige Images** (amd64) liegen in der Registry dieses Gitea. In der `.env`:
**Fertige Images** (amd64 und arm64) liegen in der Registry dieses Gitea. In der `.env`:
```bash
OPNEXUS_IMAGE_REPO=git.opnexus.dev/opnexus
OPNEXUS_VERSION=1.21.0
OPNEXUS_VERSION=1.27.1
```
```bash
@@ -73,7 +76,7 @@ Aktualisiert wird danach mit `scripts/opnexus update` / `rollback` (erst ziehen,
## Datenschutz
OPNexus wird selbst betrieben und hat keine Telemetrie. Es verbindet sich nur mit deinen Firewalls und mit Benachrichtigungszielen, die du selbst einrichtest. Der optionale Hinweis auf neue Versionen (`UPDATE_CHECK_URL=https://updates.opnexus.dev/latest.json`) ist **aus**, solange du ihn nicht setzt; eingeschaltet geht höchstens alle 12 Stunden ein einfaches `GET` mit dem User-Agent `OPNexus/<Version>` hinaus — ohne Instanz- oder Nutzerdaten.
OPNexus wird selbst betrieben und hat keine Telemetrie. Es verbindet sich nur mit deinen Firewalls und mit Benachrichtigungszielen, die du selbst einrichtest. Der optionale Hinweis auf neue Versionen (Schalter unter Einstellungen › OPNexus aktualisieren, oder `UPDATE_CHECK_URL` in der `.env`) ist **aus**, solange du ihn nicht einschaltest; eingeschaltet geht höchstens alle 12 Stunden ein einfaches `GET` mit dem User-Agent `OPNexus/<Version>` hinaus — ohne Instanz- oder Nutzerdaten.
## Lizenz
+9 -6
View File
@@ -7,7 +7,7 @@ Central management for multiple [OPNsense](https://opnsense.org) firewalls: rule
![Central firewall rules](docs/screenshots/readme-rules-en.webp)
> **Status:** `1.21.0` is the current stable release. It has been developed and tested against real OPNsense instances; a clean install from the release bundle, updates and rollbacks have been verified end to end. Please report rough edges.
> **Status:** `1.27.1` is the current stable release. It has been developed and tested against real OPNsense instances; a clean install from the release bundle, updates and rollbacks have been verified end to end. Please report rough edges.
## What it does
@@ -16,14 +16,17 @@ Central management for multiple [OPNsense](https://opnsense.org) firewalls: rule
- **Safe changes** — every change goes *preview → deploy → confirm*; without your confirmation inside the time window OPNexus rolls it back.
- **Hierarchical policies** — pre/post rulebases with inheritance across group trees.
- **VPN** — IPsec site-to-site, OpenVPN and WireGuard, defined once and rolled out.
- **Network** — interfaces, VLANs, virtual IPs, gateways, routes, LAGG/bridge/GRE, DNS and DHCP per firewall, plus tunables, cron, syslog, snapshots and diagnostics (ping, traceroute, port check, DNS), a comparison of cluster nodes, with a diff preview, a backup before every change and a guard against cutting your own connection; rules created by hand on a firewall can be adopted.
- **Network** — interfaces, VLANs, virtual IPs, gateways, routes, LAGG/bridge/GRE, DNS and DHCP per firewall, plus tunables, cron, syslog, snapshots and diagnostics (ping, traceroute, port check, DNS), a comparison of cluster nodes, with a diff preview, a backup before every change and a guard against cutting your own connection; rules, aliases and NAT rules created by hand on a firewall can be adopted.
- **Certificates** — trust store for all firewalls and ACME / Let's Encrypt issuance.
- **Alerts** — gateway/WAN outage (down, packet loss, latency), disk/memory/swap/CPU thresholds and stopped services, debounced over several measurements so spikes and flapping links stay quiet; delivered by email, webhook, ntfy, Gotify, Telegram, Microsoft Teams or Matrix, all switchable per event.
- **Firewall interface through OPNexus** — open a firewall's own web interface in a separate browser tab through OPNexus, even behind NAT; admins only, one-time ticket, isolated origin, time limits and audit (off by default).
- **Logs & audit** — central log search with correlation, dashboards and a complete deploy audit trail.
- **Update center** — firmware updates for the fleet, aware of HA order and maintenance mode.
- **Update center & rollouts** — firmware updates for the fleet, aware of HA order and maintenance mode; rollouts in waves (canary → pilot → prod) with recurring maintenance windows, a health gate between the waves and an automatic stop on anything unusual.
- **Setup assistant** — a guided first run after installation: your own password, two-factor, and connecting the first firewall.
- **Self-update** — OPNexus can update itself from its web interface, with progress and automatic rollback (opt-in).
- **Automation** — personal API tokens (read / deploy / admin), Prometheus metrics, a read-only MCP endpoint for AI assistants and an OpenAPI schema.
- **Security posture** — a 0–100 score per firewall from hardening and rule-hygiene checks (open WAN rules, weak SSH/SNMP, shadowed rules, stale backups …), read-only.
- **Rule analysis** — "Which rule matches?" for a source, destination, protocol and port: the deciding rule per firewall (or fleet/group) with an honest confidence (sure / probable / unknown) and a rule-by-rule trace, read-only.
- **Backups & recovery** — scheduled config backups with retention, an encrypted offsite copy to S3-compatible storage, a redacted change view between backups, and a full encrypted backup/restore of OPNexus itself (`opnexus backup --full`).
- **Single sign-on** — sign in with your identity provider (OIDC); roles come from its groups at every login.
- **Access** — HTTPS with pinned firewall certificates, optional two-factor sign-in, roles (admin / operator / read-only), keyboard operation, dark mode, German and English UI.
@@ -60,11 +63,11 @@ After the first sign-in a short **setup assistant** opens on its own: set your o
For access from other machines and for production use with TLS (bundled Caddy proxy), see the [handbook](docs/HANDBUCH.md#zugriff-aus-dem-netz-und-tls) (German).
**Prebuilt images** (amd64) are published to this Gitea's registry. In `.env`:
**Prebuilt images** (amd64 and arm64) are published to this Gitea's registry. In `.env`:
```bash
OPNEXUS_IMAGE_REPO=git.opnexus.dev/opnexus
OPNEXUS_VERSION=1.21.0
OPNEXUS_VERSION=1.27.1
```
```bash
@@ -77,7 +80,7 @@ docker compose pull && docker compose up -d --no-build
## Privacy
OPNexus is self-hosted and has no telemetry. It only connects to your firewalls and to notification targets you configure yourself. The optional new-version notice (`UPDATE_CHECK_URL=https://updates.opnexus.dev/latest.json`) is **off** unless you set it; when on, it makes one plain `GET` at most every 12 hours with the user agent `OPNexus/<version>` — no instance or user data.
OPNexus is self-hosted and has no telemetry. It only connects to your firewalls and to notification targets you configure yourself. The optional new-version notice (switch under Settings › Update OPNexus, or `UPDATE_CHECK_URL` in the `.env`) is **off** unless you turn it on; when on, it makes one plain `GET` at most every 12 hours with the user agent `OPNexus/<version>` — no instance or user data.
## License
+9 -5
View File
@@ -7,7 +7,7 @@ from starlette.responses import JSONResponse
from app.database import SessionLocal
from app.errors import ErrorCode
from app.routers.auth import COOKIE_NAME
from app.routers.auth import session_token
from app.routers import governance
from app.routers.auth import client_ip
from app.services import api_token_service, auth_service
@@ -56,9 +56,9 @@ _READ_ONLY_ALLOWED_WRITES = {
_SECURITY_KINDS = {
"ipsec": "ipsec_tunnel", "openvpn": "openvpn_instance", "wireguard": "wireguard_tunnel",
"certificates": "certificate", "acme": "acme", "notifications": "notification", "auth": "auth",
"tokens": "api_token",
"tokens": "api_token", "rollouts": "rollout",
}
_COLLECTIONS = {"tunnels", "instances", "managed", "accounts", "certificates", "settings"}
_COLLECTIONS = {"tunnels", "instances", "managed", "accounts", "certificates", "settings", "plans", "runs"}
def _is_uuid(value: str) -> bool:
@@ -94,10 +94,14 @@ class AuthMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
if request.url.path in _PUBLIC_PATHS:
return await call_next(request)
if request.url.path.startswith("/internal/gui/"):
# GUI gateway only: never routed by the proxy, authenticated by the
# shared gateway token inside routers/gui_access.py.
return await call_next(request)
api_token = None
bearer = api_token_service.bearer_from_header(request.headers.get("authorization", ""))
token = request.cookies.get(COOKIE_NAME, "")
token = session_token(request)
if bearer is not None:
# An API token wins over a cookie; a bad one never falls back to it.
async with SessionLocal() as db:
@@ -117,7 +121,7 @@ class AuthMiddleware(BaseHTTPMiddleware):
)
if user is not None:
parts = request.url.path.strip("/").split("/")
kinds = {"rules": "rule", "aliases": "alias", "port-forward": "port_forward", "one-to-one": "one_to_one", "outbound-nat": "outbound_nat", "hosts": "host", "users": "user", "system": "system", "backups": "backup"}
kinds = {"rules": "rule", "aliases": "alias", "port-forward": "port_forward", "one-to-one": "one_to_one", "outbound-nat": "outbound_nat", "hosts": "host", "users": "user", "system": "system", "backups": "backup", "maintenance-windows": "maintenance_window"}
writing = request.method in ("POST", "PUT", "PATCH", "DELETE")
if len(parts) > 1 and parts[1] in _SECURITY_KINDS:
event = {**_security_event(parts, request.method), "details": {"method": request.method, "path": request.url.path}}
+22
View File
@@ -6,6 +6,17 @@ class Settings(BaseSettings):
def allowed_origins(self) -> list[str]:
return [o.strip().rstrip("/") for o in self.frontend_origin.split(",") if o.strip()]
@property
def gui_site_origins(self) -> list[str]:
return [o.strip().rstrip("/") for o in self.opnexus_gui_sites.split(",") if o.strip()]
def gui_origin_conflicts(self) -> list[str]:
"""Slot origins of the GUI gateway that are also listed in FRONTEND_ORIGIN.
Such an origin would get CORS with credentials and pass the Sec-Fetch-Site
exception — a firewall GUI could then read OPNexus' API. Startup is refused."""
allowed = {o.lower() for o in self.allowed_origins}
return [o for o in self.gui_site_origins if o.lower() in allowed]
database_url: str = (
"postgresql+asyncpg://opnexus:opnexus@postgres:5432/opnexus"
)
@@ -27,6 +38,9 @@ class Settings(BaseSettings):
# keine Instanz- oder Nutzerdaten.
update_check_url: str = ""
update_check_interval_hours: int = 12
# Registry der Release-Images (OPNEXUS_IMAGE_REPO). Leer = OPNexus wird lokal aus dem
# Quellcode gebaut; dann gibt es keine Updates per Klick (nur der Hinweis in den Einstellungen).
opnexus_image_repo: str = ""
# ── Updates aus dem Webinterface (app/services/updater_client.py) ─────
# Optionaler Updater-Container (Compose-Profil "updater"). Das Backend hat
@@ -89,6 +103,14 @@ class Settings(BaseSettings):
# per-IP lockout entirely.
trust_proxy_headers: bool = False
# ── GUI gateway (1.27, optional container "gui-gateway") ─────────
# Slot origins the gateway is served on, comma-separated, e.g.
# "https://192.0.2.10:9441,https://192.0.2.10:9442". Empty = feature unavailable.
opnexus_gui_sites: str = ""
# Shared secret between backend and gateway for /internal/gui/* (at least
# 32 characters). Empty = the internal endpoints answer 404.
gui_gateway_token: str = ""
# ── Deploy lockout protection ────────────────────────────────────
deploy_confirm_window_seconds: int = 180
+45
View File
@@ -11,6 +11,8 @@ class ErrorCode(str, Enum):
UPDATER_REJECTED = "UPDATER_REJECTED"
UPDATE_NOT_OFFERED = "UPDATE_NOT_OFFERED"
UPDATE_MAJOR_CHANGE = "UPDATE_MAJOR_CHANGE"
UPDATE_CHECK_MANAGED_BY_SERVER = "UPDATE_CHECK_MANAGED_BY_SERVER"
UPDATE_CHECK_URL_INVALID = "UPDATE_CHECK_URL_INVALID"
ADMIN_REQUIRED = "ADMIN_REQUIRED"
BACKUP_EMPTY = "BACKUP_EMPTY"
BACKUP_INVALID_XML = "BACKUP_INVALID_XML"
@@ -85,6 +87,13 @@ class ErrorCode(str, Enum):
MINDESTENS_EIN_ADMIN_ACCOUNT_MUSS_BESTEHEN_BLEIBEN = "MINDESTENS_EIN_ADMIN_ACCOUNT_MUSS_BESTEHEN_BLEIBEN"
NICHT_AUTHENTIFIZIERT = "NICHT_AUTHENTIFIZIERT"
CROSS_ORIGIN_BLOCKED = "CROSS_ORIGIN_BLOCKED"
CROSS_SITE_REQUEST_BLOCKED = "CROSS_SITE_REQUEST_BLOCKED"
GUI_SESSION_REQUIRED = "GUI_SESSION_REQUIRED"
GUI_GATEWAY_NOT_CONFIGURED = "GUI_GATEWAY_NOT_CONFIGURED"
GUI_REQUIRES_HTTPS = "GUI_REQUIRES_HTTPS"
GUI_ACCESS_DISABLED = "GUI_ACCESS_DISABLED"
GUI_HOST_NOT_ELIGIBLE = "GUI_HOST_NOT_ELIGIBLE"
GUI_NO_FREE_SLOT = "GUI_NO_FREE_SLOT"
TLS_PROBE_FAILED = "TLS_PROBE_FAILED"
TLS_PEM_INVALID = "TLS_PEM_INVALID"
TLS_PIN_MISMATCH = "TLS_PIN_MISMATCH"
@@ -114,6 +123,9 @@ class ErrorCode(str, Enum):
NETWORK_FIELD_INVALID = "NETWORK_FIELD_INVALID"
NETWORK_ITEM_NOT_FOUND = "NETWORK_ITEM_NOT_FOUND"
RULE_NOT_ADOPTABLE = "RULE_NOT_ADOPTABLE"
OBJECT_NOT_ADOPTABLE = "OBJECT_NOT_ADOPTABLE"
ADOPT_OBJECT_NOT_FOUND = "ADOPT_OBJECT_NOT_FOUND"
OUTBOUND_MODE_BLOCKS_ADOPT = "OUTBOUND_MODE_BLOCKS_ADOPT"
REGEL_WURDE_INZWISCHEN_GEAENDERT_NEU_LADEN_UND_AENDERUNGEN_BF51B6B0 = "REGEL_WURDE_INZWISCHEN_GEAENDERT_NEU_LADEN_UND_AENDERUNGEN_BF51B6B0"
RESTORE_VORGANG_NICHT_GEFUNDEN = "RESTORE_VORGANG_NICHT_GEFUNDEN"
ROLLBACK_ERNEUT_FEHLGESCHLAGEN_PRUEFE_DIE_ERREICHBARKEIT_DER_FIREWALL = "ROLLBACK_ERNEUT_FEHLGESCHLAGEN_PRUEFE_DIE_ERREICHBARKEIT_DER_FIREWALL"
@@ -157,7 +169,14 @@ class ErrorCode(str, Enum):
API_TOKEN_LIMIT_REACHED = "API_TOKEN_LIMIT_REACHED"
OFFSITE_TEST_FAILED = "OFFSITE_TEST_FAILED"
OIDC_TEST_FAILED = "OIDC_TEST_FAILED"
VARIABLES_MISSING = "VARIABLES_MISSING"
VARIABLE_INVALID = "VARIABLE_INVALID"
OVERLAY_INVALID = "OVERLAY_INVALID"
NOTIFICATION_CHANNEL_INVALID = "NOTIFICATION_CHANNEL_INVALID"
NOTIFICATION_CHANNEL_NOT_FOUND = "NOTIFICATION_CHANNEL_NOT_FOUND"
NOTIFICATION_CHANNEL_NAME_TAKEN = "NOTIFICATION_CHANNEL_NAME_TAKEN"
NOTIFICATION_CHANNEL_TEST_FAILED = "NOTIFICATION_CHANNEL_TEST_FAILED"
NOTIFICATION_WEBHOOK_URL_INVALID = "NOTIFICATION_WEBHOOK_URL_INVALID"
OVERLAY_SUBNET_LOCKED = "OVERLAY_SUBNET_LOCKED"
OVERLAY_NAME_TAKEN = "OVERLAY_NAME_TAKEN"
OVERLAY_PEER_NOT_FOUND = "OVERLAY_PEER_NOT_FOUND"
@@ -167,6 +186,32 @@ class ErrorCode(str, Enum):
API_TOKEN_NOT_FOUND = "API_TOKEN_NOT_FOUND"
API_TOKEN_SCOPE_FORBIDDEN = "API_TOKEN_SCOPE_FORBIDDEN"
API_TOKEN_SCOPE_TOO_HIGH = "API_TOKEN_SCOPE_TOO_HIGH"
WINDOW_NOT_FOUND = "WINDOW_NOT_FOUND"
WINDOW_INVALID = "WINDOW_INVALID"
WINDOW_NAME_TAKEN = "WINDOW_NAME_TAKEN"
WINDOW_IN_USE = "WINDOW_IN_USE"
WINDOW_EXCEPTION_INVALID = "WINDOW_EXCEPTION_INVALID"
WINDOW_EXCEPTION_EXISTS = "WINDOW_EXCEPTION_EXISTS"
WINDOW_EXCEPTION_NOT_FOUND = "WINDOW_EXCEPTION_NOT_FOUND"
ROLLOUT_PLAN_NOT_FOUND = "ROLLOUT_PLAN_NOT_FOUND"
ROLLOUT_INVALID = "ROLLOUT_INVALID"
ROLLOUT_NAME_TAKEN = "ROLLOUT_NAME_TAKEN"
ROLLOUT_PLAN_INVALID = "ROLLOUT_PLAN_INVALID"
ROLLOUT_PREVIEW_STALE = "ROLLOUT_PREVIEW_STALE"
ROLLOUT_PLAN_BUSY = "ROLLOUT_PLAN_BUSY"
ROLLOUT_GROUP_IN_USE = "ROLLOUT_GROUP_IN_USE"
ROLLOUT_RUN_NOT_FOUND = "ROLLOUT_RUN_NOT_FOUND"
ROLLOUT_ALREADY_ACTIVE = "ROLLOUT_ALREADY_ACTIVE"
ROLLOUT_CONFIRM_NAME = "ROLLOUT_CONFIRM_NAME"
ROLLOUT_ACTION_NOT_ALLOWED = "ROLLOUT_ACTION_NOT_ALLOWED"
ROLLOUT_HOST_NOT_IN_RUN = "ROLLOUT_HOST_NOT_IN_RUN"
ROLLOUT_HOST_RUNNING = "ROLLOUT_HOST_RUNNING"
ROLLOUT_HOST_FAILED = "ROLLOUT_HOST_FAILED"
ANALYSE_ADRESSE_UNGUELTIG = "ANALYSE_ADRESSE_UNGUELTIG"
ANALYSE_FAMILIEN_MISCHUNG = "ANALYSE_FAMILIEN_MISCHUNG"
ANALYSE_INTERFACE_UNBEKANNT = "ANALYSE_INTERFACE_UNBEKANNT"
ANALYSE_PARAMETER_UNGUELTIG = "ANALYSE_PARAMETER_UNGUELTIG"
ANALYSE_FIREWALL_NICHT_LESBAR = "ANALYSE_FIREWALL_NICHT_LESBAR"
def api_error(status_code: int, code: ErrorCode, **params: Any) -> HTTPException:
+587
View File
@@ -0,0 +1,587 @@
"""The ``gui-gateway`` container: firewall web interfaces in their own browser origin (1.27).
Runs from the backend image (``python -m app.gui_gateway``) behind the proxy, which terminates TLS for the
slot ports and sets ``X-Onx-Slot`` (overwriting any client value). It never touches the database or the
secret stores; it only talks to the backend's internal API (``/internal/gui/*``, shared GUI_GATEWAY_TOKEN)
and, per gateway session, to exactly one firewall.
Security model (see the 1.27 design):
* Every slot port is its own origin. The firewall GUI therefore never runs in the OPNexus origin.
* Cookies never cross: the browser's ``Cookie`` header is not forwarded (it carries the OPNexus session),
and the firewall's ``Set-Cookie`` never reaches the browser — a server-side jar per gateway session
(memory only) holds them. The browser only gets ``__Host-onx-gw-<slot>``.
* Each upstream request is built from scratch: method, path and query from the browser, a small header
allow-list, the jar's cookies; target origin, pinned certificate and overlay proxy from the backend.
Absolute-form targets, CONNECT/TRACE, ``Upgrade`` and service-worker script requests are refused.
* ``Sec-Fetch-Site`` must be same-origin/none (same-site only for the redeem step), fail-closed;
non-GET/HEAD requests also need the slot's own ``Origin``.
* ``Location`` pointing anywhere but the firewall is dropped; responses get CSP, X-Frame-Options DENY,
``Cache-Control: no-store``.
* At most 3 failed GUI logins per firewall in 5 minutes (protects OPNexus' API access from the firewall's
login lockout, which would see all attempts coming from OPNexus).
* Idle and absolute limits; every 20 s the backend re-checks the session (OPNexus session, admin role,
switch, host). Logs carry method, path (no query), status and duration only.
OPNsense behaviour this relies on (opnsense/core, src/www/authgui.inc, master as of 2026-10-21):
* session_auth(): a login is ``isset($_POST['login']) && !empty($_POST['usernamefld']) &&
!empty($_POST['passwordfld'])`` posted to the current URL (login form has no action). Success sends a
``Location:`` header and exits (302); a failure re-renders the login form (200) with "Wrong username or
password." and an auth_log entry.
* check_security_http_referer_enforcement() only runs when HTTP_REFERER is set, and wants the firewall's
own host name/IP — so the gateway sends no Referer (and no Origin) upstream at all.
* check_security_dns_rebind() accepts an IP address or the configured host name as Host — the gateway
sends the Host of the host record's base URL (httpx derives it from the URL).
"""
import asyncio
import hashlib
import logging
import os
import secrets
import ssl
import time
from collections import deque
from dataclasses import dataclass, field
from http.cookies import CookieError, SimpleCookie
from typing import Awaitable, Callable
from urllib.parse import parse_qs, urlsplit
import httpx
logger = logging.getLogger("gui_gateway")
# httpx/httpcore log full request URLs (query strings) at INFO/DEBUG: never in this process.
for _noisy in ("httpx", "httpcore"):
logging.getLogger(_noisy).setLevel(logging.WARNING)
LISTEN_PORT = 8080
COOKIE_PREFIX = "__Host-onx-gw-"
OPNEXUS_SESSION_COOKIE = "__Host-opnexus-session"
BODY_LIMIT = 64 * 1024 * 1024 # config restore uploads
LOGIN_FAILURE_LIMIT = 3
LOGIN_FAILURE_WINDOW = 300.0
UPSTREAM_TIMEOUT = 60.0
MAX_SESSIONS = 64
# Request headers copied from the browser; everything else (Cookie, Authorization, Origin, Referer,
# X-Forwarded-*, hop-by-hop, Sec-*, ...) is dropped.
_FORWARD_REQUEST_HEADERS = {
"accept", "accept-language", "content-type", "user-agent", "x-requested-with", "x-csrftoken", "range",
}
# Response headers copied from the firewall. Set-Cookie goes to the jar, Location is rewritten.
_FORWARD_RESPONSE_HEADERS = {
"content-type", "content-length", "content-encoding", "content-disposition", "content-language",
"content-range", "accept-ranges", "content-security-policy",
}
_GATEWAY_CSP = ("connect-src 'self'; form-action 'self'; frame-ancestors 'none'; base-uri 'self'; "
"object-src 'none'; worker-src 'none'")
_SECURITY_HEADERS = [
(b"content-security-policy", _GATEWAY_CSP.encode()),
(b"x-frame-options", b"DENY"),
(b"x-content-type-options", b"nosniff"),
(b"cache-control", b"no-store"),
(b"pragma", b"no-cache"),
(b"referrer-policy", b"same-origin"),
(b"cross-origin-opener-policy", b"same-origin"),
(b"cross-origin-resource-policy", b"same-origin"),
(b"permissions-policy", b"camera=(), microphone=(), geolocation=(), payment=(), usb=()"),
]
def _sha(value: str) -> str:
return hashlib.sha256(value.encode()).hexdigest()
def _origin_of(url: str) -> str | None:
try:
parts = urlsplit(url)
port = parts.port
except ValueError:
return None
if parts.scheme not in ("http", "https") or not parts.hostname:
return None
default = 443 if parts.scheme == "https" else 80
host = parts.hostname.lower()
if ":" in host:
host = f"[{host}]"
return f"{parts.scheme}://{host}" + (f":{port}" if port and port != default else "")
def slot_origins_from(sites: str) -> dict[int, set[str]]:
"""OPNEXUS_GUI_SITES -> {port: {normalised origins}} (https only, explicit port)."""
slots: dict[int, set[str]] = {}
for raw in sites.split(","):
raw = raw.strip().rstrip("/")
try:
parts = urlsplit(raw)
port = parts.port
except ValueError:
continue
if parts.scheme == "https" and parts.hostname and port:
slots.setdefault(port, set()).add(_origin_of(raw))
return slots
@dataclass
class GatewaySession:
gui_session_id: str
session_hash: str
slot: int
upstream_origin: str
ca_pem: str | None
proxy_url: str | None
idle_timeout: float
absolute_deadline: float
revalidate_every: float
last_activity: float = field(default_factory=time.monotonic)
next_check: float = 0.0
jar: dict[str, str] = field(default_factory=dict)
client: httpx.AsyncClient | None = None
class BackendClient:
"""The backend's internal GUI API. Raises httpx.HTTPError when the backend is unreachable."""
def __init__(self, base_url: str, token: str, transport: httpx.AsyncBaseTransport | None = None):
self._client = httpx.AsyncClient(base_url=base_url, headers={"X-Onx-Gateway-Token": token},
timeout=10.0, transport=transport)
async def redeem(self, ticket_hash: str, session_hash: str, slot: int, client_ip: str | None) -> dict:
resp = await self._client.post("/internal/gui/redeem", json={
"ticket_hash": ticket_hash, "session_hash": session_hash, "slot": slot, "client_ip": client_ip})
if resp.status_code == 200:
return resp.json()
if resp.status_code == 403:
return {"ok": False, "reason": (resp.json().get("detail") or {}).get("reason", "denied")}
resp.raise_for_status()
return {"ok": False, "reason": f"http_{resp.status_code}"}
async def revalidate(self, gs: GatewaySession) -> dict:
resp = await self._client.post("/internal/gui/revalidate",
json={"gui_session_id": gs.gui_session_id, "session_hash": gs.session_hash})
resp.raise_for_status()
return resp.json()
async def end(self, gs: GatewaySession, reason: str) -> None:
try:
await self._client.post("/internal/gui/end", json={
"gui_session_id": gs.gui_session_id, "session_hash": gs.session_hash, "reason": reason})
except httpx.HTTPError as exc:
logger.warning("Could not report the end of a GUI session (%s)", type(exc).__name__)
async def aclose(self) -> None:
await self._client.aclose()
def build_upstream_client(gs: GatewaySession) -> httpx.AsyncClient:
"""Same transport rules as opnsense_client._client: pinned certificate (or system CAs), overlay proxy."""
verify: ssl.SSLContext | bool
if gs.ca_pem:
from app.services.tls_pin_service import pinned_context # no database layer behind this import
verify = pinned_context(gs.ca_pem)
else:
verify = True
return httpx.AsyncClient(verify=verify, proxy=gs.proxy_url, timeout=UPSTREAM_TIMEOUT,
follow_redirects=False, trust_env=False)
class LoginLimiter:
"""At most LOGIN_FAILURE_LIMIT failed GUI logins per firewall within LOGIN_FAILURE_WINDOW seconds."""
def __init__(self, clock: Callable[[], float] = time.monotonic):
self._failures: dict[str, deque] = {}
self._clock = clock
def _recent(self, key: str) -> deque:
now = self._clock()
q = self._failures.setdefault(key, deque())
while q and now - q[0] > LOGIN_FAILURE_WINDOW:
q.popleft()
return q
def blocked(self, key: str) -> bool:
return len(self._recent(key)) >= LOGIN_FAILURE_LIMIT
def record_failure(self, key: str) -> None:
self._recent(key).append(self._clock())
def is_login_attempt(method: str, content_type: str, body: bytes) -> bool:
if method != "POST":
return False
if content_type.lower().startswith("multipart/form-data"):
# PHP fills $_POST from multipart bodies too, so authgui.inc accepts a login posted this way.
return all(f'name="{field}"'.encode() in body for field in ("login", "usernamefld", "passwordfld"))
if not content_type.lower().startswith("application/x-www-form-urlencoded"):
return False
try:
form = parse_qs(body.decode("latin-1"), keep_blank_values=True)
except ValueError:
return False
return "login" in form and bool(form.get("usernamefld", [""])[0]) and bool(form.get("passwordfld", [""])[0])
def rewrite_location(location: str, upstream_origin: str) -> str | None:
"""Relative target for the browser, or None when the redirect leaves the firewall."""
location = location.strip()
if not location or "\\" in location or any(ord(c) < 0x20 for c in location):
return None
if location.startswith("//"):
location = "https:" + location
parts = urlsplit(location)
if parts.scheme or parts.netloc:
if _origin_of(location) != _origin_of(upstream_origin):
return None
path = parts.path or "/"
return path + (f"?{parts.query}" if parts.query else "") + (f"#{parts.fragment}" if parts.fragment else "")
return location
def _page(title: str, text_de: str, text_en: str) -> bytes:
return (f"<!doctype html><html lang=\"de\"><head><meta charset=\"utf-8\"><title>{title}</title></head>"
f"<body style=\"font-family:sans-serif;max-width:40rem;margin:3rem auto\"><h1>{title}</h1>"
f"<p>{text_de}</p><p lang=\"en\">{text_en}</p></body></html>").encode()
_SESSION_GONE = _page("OPNexus", "Diese Sitzung ist abgelaufen oder ungültig. Öffne die Oberfläche erneut aus OPNexus.",
"This session has expired or is invalid. Open the interface again from OPNexus.")
_FORBIDDEN = _page("OPNexus", "Diese Anfrage wurde vom GUI-Gateway abgelehnt.", "This request was refused by the GUI gateway.")
_BAD_REDIRECT = _page("OPNexus", "Die Firewall wollte auf eine fremde Adresse umleiten; die Umleitung wurde verworfen.",
"The firewall tried to redirect to a foreign address; the redirect was dropped.")
_LOGIN_LOCKED = _page("OPNexus", "Zu viele fehlgeschlagene Anmeldungen an dieser Firewall. Bitte warte 5 Minuten.",
"Too many failed sign-ins at this firewall. Please wait 5 minutes.")
_UNAVAILABLE = _page("OPNexus", "Die Firewall oder OPNexus ist gerade nicht erreichbar.",
"The firewall or OPNexus is not reachable right now.")
_REDEEMED = (b"<!doctype html><html><head><meta charset=\"utf-8\"><meta http-equiv=\"refresh\" content=\"0;url=/\">"
b"<title>OPNexus</title></head><body><a href=\"/\">&rarr;</a></body></html>")
class GuiGateway:
def __init__(self, *, backend: BackendClient, slot_origins: dict[int, set[str]],
upstream_factory: Callable[[GatewaySession], httpx.AsyncClient] = build_upstream_client,
clock: Callable[[], float] = time.monotonic, wall_clock: Callable[[], float] = time.time):
self.backend = backend
self.slot_origins = slot_origins
self.upstream_factory = upstream_factory
self.clock = clock
self.wall_clock = wall_clock
self.sessions: dict[str, GatewaySession] = {} # sha256(gateway cookie) -> session
self.limiter = LoginLimiter(clock)
self._loop_task: asyncio.Task | None = None
# ── ASGI ──────────────────────────────────────────────────────────────
async def __call__(self, scope, receive, send):
if scope["type"] == "lifespan":
await self._lifespan(receive, send)
return
if scope["type"] != "http":
# WebSocket and anything else: not supported (design: no WebSocket).
if scope["type"] == "websocket":
await send({"type": "websocket.close", "code": 1008})
return
started = time.monotonic()
status = await self._handle(scope, receive, send)
# Method, path and status only: never the query string, headers or bodies.
logger.info("%s %s %d %.0fms", scope.get("method", "?"), scope.get("path", "?")[:200], status,
(time.monotonic() - started) * 1000)
async def _lifespan(self, receive, send):
while True:
message = await receive()
if message["type"] == "lifespan.startup":
self._loop_task = asyncio.create_task(self._revalidate_loop())
await send({"type": "lifespan.startup.complete"})
elif message["type"] == "lifespan.shutdown":
if self._loop_task:
self._loop_task.cancel()
for key in list(self.sessions):
await self._drop(key, "shutdown")
await self.backend.aclose()
await send({"type": "lifespan.shutdown.complete"})
return
async def _revalidate_loop(self):
while True:
await asyncio.sleep(10)
try:
await self.sweep()
except Exception: # never let the loop die
logger.exception("GUI session sweep failed")
async def sweep(self) -> None:
"""Idle/absolute limits and the periodic backend re-check for every gateway session."""
for key, gs in list(self.sessions.items()):
reason = self._expired(gs)
if reason:
await self._drop(key, reason)
elif self.clock() >= gs.next_check:
await self._recheck(key, gs)
# ── helpers ───────────────────────────────────────────────────────────
@staticmethod
def _headers(scope) -> dict[str, str]:
result: dict[str, str] = {}
for k, v in scope.get("headers", []):
name = k.decode("latin-1").lower()
value = v.decode("latin-1")
if name in result:
value = f"{result[name]}{'; ' if name == 'cookie' else ', '}{value}"
result[name] = value
return result
@staticmethod
def _cookies(header: str) -> dict[str, str]:
cookies: dict[str, str] = {}
for part in header.split(";"):
name, sep, value = part.strip().partition("=")
if sep and name and name not in cookies:
cookies[name] = value
return cookies
async def _respond(self, send, status: int, body: bytes = b"", headers: list | None = None,
content_type: bytes = b"text/html; charset=utf-8") -> int:
out = [(b"content-type", content_type), (b"content-length", str(len(body)).encode())]
out += list(headers or []) + _SECURITY_HEADERS
await send({"type": "http.response.start", "status": status, "headers": out})
await send({"type": "http.response.body", "body": body})
return status
def _expired(self, gs: GatewaySession) -> str | None:
if self.wall_clock() >= gs.absolute_deadline:
return "absolute"
if self.clock() - gs.last_activity >= gs.idle_timeout:
return "idle"
return None
async def _drop(self, key: str, reason: str, *, report: bool = True) -> None:
gs = self.sessions.pop(key, None)
if gs is None:
return
gs.jar.clear()
if gs.client is not None:
await gs.client.aclose()
if report:
await self.backend.end(gs, reason)
async def _recheck(self, key: str, gs: GatewaySession) -> bool | None:
"""True = still valid, False = ended (dropped), None = backend unreachable (fail closed, keep for retry)."""
try:
result = await self.backend.revalidate(gs)
except httpx.HTTPError as exc:
logger.warning("GUI session re-check failed (%s)", type(exc).__name__)
return None
if not result.get("ok"):
await self._drop(key, str(result.get("reason", "revoked")), report=False) # backend already ended it
return False
gs.absolute_deadline = min(gs.absolute_deadline, float(result.get("absolute_deadline", gs.absolute_deadline)))
gs.idle_timeout = float(result.get("idle_timeout_seconds", gs.idle_timeout))
gs.next_check = self.clock() + gs.revalidate_every
return True
# ── request handling ──────────────────────────────────────────────────
async def _handle(self, scope, receive, send) -> int:
method = scope.get("method", "")
path = scope.get("path", "")
raw_path = scope.get("raw_path") or path.encode()
headers = self._headers(scope)
if method in ("CONNECT", "TRACE"):
return await self._respond(send, 501, _FORBIDDEN)
# Origin-form only: "GET http://elsewhere/ HTTP/1.1" (absolute-form) or "//host" never reach upstream.
if not path.startswith("/") or path.startswith("//") or not raw_path.startswith(b"/") \
or raw_path.startswith(b"//") or "\\" in path:
return await self._respond(send, 400, _FORBIDDEN)
if "upgrade" in headers or "upgrade" in headers.get("connection", "").lower():
return await self._respond(send, 400, _FORBIDDEN)
if headers.get("service-worker", "").lower() == "script":
return await self._respond(send, 403, _FORBIDDEN)
try:
slot = int(headers.get("x-onx-slot", ""))
except ValueError:
slot = 0
own_origins = self.slot_origins.get(slot)
if not own_origins:
return await self._respond(send, 400, _FORBIDDEN) # not coming through the proxy's slot block
site = headers.get("sec-fetch-site", "").strip().lower()
if path == "/__onx/redeem":
if method != "GET" or site not in ("same-site", "same-origin", "none"):
return await self._respond(send, 403, _FORBIDDEN)
return await self._redeem(scope, headers, slot, send)
if site not in ("same-origin", "none"):
return await self._respond(send, 403, _FORBIDDEN) # missing header = old/odd client: fail closed
if method not in ("GET", "HEAD"):
origin = headers.get("origin", "")
if _origin_of(origin) not in own_origins:
return await self._respond(send, 403, _FORBIDDEN)
if path.startswith("/__onx/"):
return await self._respond(send, 404, _FORBIDDEN)
cookies = self._cookies(headers.get("cookie", ""))
token = cookies.get(f"{COOKIE_PREFIX}{slot}", "")
key = _sha(token) if token else ""
gs = self.sessions.get(key) if key else None
if gs is None or gs.slot != slot:
return await self._respond(send, 401, _SESSION_GONE)
reason = self._expired(gs)
if reason:
await self._drop(key, reason)
return await self._respond(send, 401, _SESSION_GONE)
if self.clock() >= gs.next_check:
state = await self._recheck(key, gs)
if state is False:
return await self._respond(send, 401, _SESSION_GONE)
if state is None:
return await self._respond(send, 503, _UNAVAILABLE)
gs.last_activity = self.clock()
return await self._proxy(scope, receive, send, headers, gs)
async def _redeem(self, scope, headers, slot: int, send) -> int:
query = parse_qs(scope.get("query_string", b"").decode("latin-1"))
ticket = (query.get("t") or [""])[0]
browser_session = self._cookies(headers.get("cookie", "")).get(OPNEXUS_SESSION_COOKIE, "")
if not ticket or len(ticket) > 128 or not browser_session:
return await self._respond(send, 403, _SESSION_GONE)
client_ip = (headers.get("x-forwarded-for", "").split(",")[0].strip() or None)
try:
result = await self.backend.redeem(_sha(ticket), _sha(browser_session), slot, client_ip and client_ip[:45])
except httpx.HTTPError as exc:
logger.warning("Ticket redeem failed (%s)", type(exc).__name__)
return await self._respond(send, 503, _UNAVAILABLE)
if not result.get("ok"):
return await self._respond(send, 403, _SESSION_GONE)
# One browser session, one gateway session per slot: an older one in this slot is replaced.
for old_key, old in list(self.sessions.items()):
if old.slot == slot and old.session_hash == _sha(browser_session):
await self._drop(old_key, "superseded", report=False)
if len(self.sessions) >= MAX_SESSIONS:
oldest = min(self.sessions, key=lambda k: self.sessions[k].last_activity)
await self._drop(oldest, "superseded")
value = secrets.token_urlsafe(32)
gs = GatewaySession(
gui_session_id=result["gui_session_id"], session_hash=_sha(browser_session), slot=slot,
upstream_origin=result["upstream_origin"], ca_pem=result.get("ca_pem"), proxy_url=result.get("proxy_url"),
idle_timeout=float(result["idle_timeout_seconds"]), absolute_deadline=float(result["absolute_deadline"]),
revalidate_every=float(result.get("revalidate_seconds", 20)),
)
gs.last_activity = self.clock()
gs.next_check = gs.last_activity + gs.revalidate_every
self.sessions[_sha(value)] = gs
cookie = f"{COOKIE_PREFIX}{slot}={value}; Path=/; Secure; HttpOnly; SameSite=Strict"
# 200 + meta refresh instead of a 303: the follow-up request then starts in this origin
# (Sec-Fetch-Site: same-origin) and the ticket leaves the address bar.
return await self._respond(send, 200, _REDEEMED, headers=[
(b"set-cookie", cookie.encode()), (b"clear-site-data", b'"cache", "storage"'),
])
async def _read_body(self, receive) -> bytes | None:
chunks, size = [], 0
while True:
message = await receive()
if message["type"] == "http.disconnect":
return None
chunk = message.get("body", b"")
size += len(chunk)
if size > BODY_LIMIT:
return None
chunks.append(chunk)
if not message.get("more_body"):
return b"".join(chunks)
def _store_cookies(self, gs: GatewaySession, response: httpx.Response) -> None:
for header in response.headers.get_list("set-cookie"):
jar = SimpleCookie()
try:
jar.load(header)
except CookieError:
continue
for name, morsel in jar.items():
expired = morsel["max-age"] in ("0",) or morsel.value in ("", "deleted")
if not expired and morsel["expires"]:
try:
from email.utils import parsedate_to_datetime
expired = parsedate_to_datetime(morsel["expires"]).timestamp() <= self.wall_clock()
except (TypeError, ValueError):
pass
if expired:
gs.jar.pop(name, None)
else:
gs.jar[name] = morsel.value
async def _proxy(self, scope, receive, send, headers: dict, gs: GatewaySession) -> int:
length = headers.get("content-length", "")
if length.isdigit() and int(length) > BODY_LIMIT:
return await self._respond(send, 413, _FORBIDDEN)
body = await self._read_body(receive)
if body is None:
return await self._respond(send, 413, _FORBIDDEN)
method = scope["method"]
login = is_login_attempt(method, headers.get("content-type", ""), body)
if login and self.limiter.blocked(gs.upstream_origin):
return await self._respond(send, 429, _LOGIN_LOCKED)
out_headers = {k: v for k, v in headers.items() if k in _FORWARD_REQUEST_HEADERS}
out_headers["accept-encoding"] = "identity"
if gs.jar:
out_headers["cookie"] = "; ".join(f"{k}={v}" for k, v in gs.jar.items())
query = scope.get("query_string", b"").decode("latin-1")
# The path exactly as the browser sent it (still percent-encoded): the decoded scope["path"] would
# turn %3F/%23 into query/fragment, %2F into a separator and decode %25xx a second time upstream.
raw_path = (scope.get("raw_path") or scope["path"].encode()).split(b"?", 1)[0].decode("latin-1")
url = gs.upstream_origin + raw_path + (f"?{query}" if query else "")
if gs.client is None:
gs.client = self.upstream_factory(gs)
try:
request = gs.client.build_request(method, url, headers=out_headers, content=body)
except httpx.InvalidURL:
return await self._respond(send, 400, _FORBIDDEN) # e.g. control characters in the path
try:
response = await gs.client.send(request, stream=True)
except (httpx.HTTPError, ssl.SSLError, OSError) as exc:
logger.warning("Upstream request failed (%s)", type(exc).__name__)
return await self._respond(send, 502, _UNAVAILABLE)
try:
self._store_cookies(gs, response)
if login and not (300 <= response.status_code < 400):
self.limiter.record_failure(gs.upstream_origin)
out = []
for name, value in response.headers.multi_items():
lname = name.lower()
if lname in _FORWARD_RESPONSE_HEADERS:
out.append((lname.encode("latin-1"), value.encode("latin-1")))
if "location" in response.headers:
target = rewrite_location(response.headers["location"], gs.upstream_origin)
if target is None:
await response.aclose()
return await self._respond(send, 502, _BAD_REDIRECT)
out.append((b"location", target.encode("latin-1")))
await send({"type": "http.response.start", "status": response.status_code, "headers": out + _SECURITY_HEADERS})
async for chunk in response.aiter_raw():
await send({"type": "http.response.body", "body": chunk, "more_body": True})
await send({"type": "http.response.body", "body": b""})
return response.status_code
finally:
await response.aclose()
def create_app(transport: httpx.AsyncBaseTransport | None = None) -> GuiGateway:
token = os.environ.get("GUI_GATEWAY_TOKEN", "")
if len(token) < 32:
raise SystemExit("GUI_GATEWAY_TOKEN (at least 32 characters) is required")
slots = slot_origins_from(os.environ.get("OPNEXUS_GUI_SITES", ""))
if not slots:
raise SystemExit("OPNEXUS_GUI_SITES must list the https slot origins")
backend = BackendClient(os.environ.get("GUI_BACKEND_URL", "http://backend:8000"), token, transport)
return GuiGateway(backend=backend, slot_origins=slots)
def main() -> None:
import uvicorn
logging.basicConfig(level=logging.INFO, format="%(asctime)s %(name)s %(levelname)s %(message)s")
# h11: an absolute-form target stays visible in scope["path"] (and is refused); access_log off because
# uvicorn's access log would contain query strings (the redeem ticket).
uvicorn.run(create_app(), host="0.0.0.0", port=LISTEN_PORT, http="h11", ws="none", access_log=False,
server_header=False, date_header=False, proxy_headers=False, lifespan="on", log_config=None)
if __name__ == "__main__":
main()
+31 -2
View File
@@ -18,7 +18,7 @@ from app.security_middleware import OriginCheckMiddleware, SecurityHeadersMiddle
from app.config import settings
from app.database import SessionLocal
from app import migrate
from app.routers import auth, hosts, logs, rules, groups, aliases, port_forward, search as search_router, users as users_router, tokens as tokens_router, metrics as metrics_router, mcp as mcp_router, compliance as compliance_router, audit_export as audit_export_router, backups as backups_router, oidc as oidc_router, governance as governance_router, overlay as overlay_router
from app.routers import auth, hosts, logs, rules, groups, aliases, port_forward, search as search_router, users as users_router, tokens as tokens_router, metrics as metrics_router, mcp as mcp_router, compliance as compliance_router, audit_export as audit_export_router, backups as backups_router, oidc as oidc_router, governance as governance_router, overlay as overlay_router, variables as variables_router
from app.routers import one_to_one
from app.services.one_to_one_deploy_service import sweep_expired_one_to_one_deployments
from app.routers import outbound_nat
@@ -46,13 +46,19 @@ from app.version import APP_VERSION
from app.routers import dashboard as dashboard_router
from app.routers import cluster as cluster_router
from app.routers import services as services_router
from app.routers import gateways as gateways_router
from app.routers import resource_samples as resource_samples_router
from app.services import resource_monitor_service
from app.routers import scheduled_maintenance as scheduled_maintenance_router
from app.routers import maintenance_windows as maintenance_windows_router
from app.routers import rollouts as rollouts_router
from app.routers import rule_analysis as rule_analysis_router
from app.routers import gui_access as gui_access_router
from app.services import scheduled_maintenance_service
from app.services import rollout_engine
from app.services import compliance_service
from app.services import audit_export_service
from app.services import overlay_service
from app.services import overlay_service, variables_service
from app.services import backup_schedule_service
from app.services import carp_event_service, carp_maintenance_window_service
@@ -254,6 +260,12 @@ async def _scheduled_maintenance_poll_loop():
except Exception:
logger.exception("Geplante-Wartung-Poll fehlgeschlagen")
in_progress = 0
# Firmware rollouts (1.25) only ever create schedules; the next tick of the lines above fires them.
try:
async with SessionLocal() as db:
in_progress += await rollout_engine.advance_runs(db)
except Exception:
logger.exception("Rollout-Poll fehlgeschlagen")
# A handover run is stepped quickly (the partner should take over within a minute or two);
# otherwise the relaxed cadence is plenty.
await asyncio.sleep(_RUNNING_MAINTENANCE_POLL_SECONDS if in_progress else _SCHEDULED_MAINTENANCE_POLL_SECONDS)
@@ -312,6 +324,10 @@ async def _backup_poll_loop():
@asynccontextmanager
async def lifespan(app: FastAPI):
conflicts = settings.gui_origin_conflicts()
if conflicts:
# A GUI-gateway slot must never be a trusted OPNexus origin (CORS with credentials).
raise RuntimeError(f"OPNEXUS_GUI_SITES overlaps FRONTEND_ORIGIN: {', '.join(conflicts)} — refusing to start")
await migrate.run()
async with SessionLocal() as db:
await auth_service.bootstrap_admin(db)
@@ -396,6 +412,12 @@ async def _safe_validation_error(request: Request, exc: RequestValidationError):
)
@app.exception_handler(variables_service.MissingVariables)
async def _missing_variables(request: Request, exc: variables_service.MissingVariables):
"""A deploy that needs a value no target host has defined is refused before anything is written."""
return JSONResponse(status_code=422, content={"detail": {"code": ErrorCode.VARIABLES_MISSING.value, "params": {"details": str(exc)}}})
@app.exception_handler(DBAPIError)
async def _database_text_errors(request: Request, exc: DBAPIError):
"""A NUL byte in any text field cannot be stored by Postgres and used to
@@ -451,6 +473,7 @@ app.include_router(backups_router.router, prefix="/api")
app.include_router(oidc_router.router, prefix="/api")
app.include_router(governance_router.router, prefix="/api")
app.include_router(overlay_router.router, prefix="/api")
app.include_router(variables_router.router, prefix="/api")
app.include_router(logs.router, prefix="/api")
app.include_router(groups.router, prefix="/api")
app.include_router(aliases.router, prefix="/api")
@@ -503,9 +526,15 @@ app.include_router(restore_router.router, prefix="/api")
app.include_router(dashboard_router.router, prefix="/api")
app.include_router(cluster_router.router, prefix="/api")
app.include_router(services_router.router, prefix="/api")
app.include_router(gateways_router.router, prefix="/api")
app.include_router(network_router.router, prefix="/api")
app.include_router(snapshots_router.router, prefix="/api")
app.include_router(network_drift_router.router, prefix="/api")
app.include_router(diagnostics_router.router, prefix="/api")
app.include_router(resource_samples_router.router, prefix="/api")
app.include_router(scheduled_maintenance_router.router, prefix="/api")
app.include_router(maintenance_windows_router.router, prefix="/api")
app.include_router(rollouts_router.router, prefix="/api")
app.include_router(rule_analysis_router.router, prefix="/api")
app.include_router(gui_access_router.router, prefix="/api")
app.include_router(gui_access_router.internal_router)
+9
View File
@@ -93,3 +93,12 @@ __all__ += ["HostResourceSample"]
from app.models.scheduled_maintenance import ScheduledMaintenance
__all__ += ["ScheduledMaintenance"]
from app.models.maintenance_window import MaintenanceWindow, MaintenanceWindowException
__all__ += ["MaintenanceWindow", "MaintenanceWindowException"]
from app.models.rollout import RolloutPlan, RolloutPlanWave, RolloutRun, RolloutRunHost, RolloutRunWave, rollout_wave_groups
__all__ += ["RolloutPlan", "RolloutPlanWave", "RolloutRun", "RolloutRunHost", "RolloutRunWave", "rollout_wave_groups"]
from app.models.gui_access import GuiAccessSettings, GuiSession, GuiTicket
__all__ += ["GuiAccessSettings", "GuiSession", "GuiTicket"]
+65
View File
@@ -0,0 +1,65 @@
"""GUI access to managed firewalls through the separate gui-gateway container (1.27).
Settings are a singleton row (id fixed at 1), off by default. Tickets and gateway
sessions only ever store hashes: the raw ticket travels once through the browser,
the OPNexus session is referenced by the same SHA-256 that `sessions.token_hash` holds.
"""
import uuid
from datetime import datetime
from sqlalchemy import Boolean, DateTime, ForeignKey, Integer, String
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column
from app.database import Base
class GuiAccessSettings(Base):
__tablename__ = "gui_access_settings"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
idle_timeout_minutes: Mapped[int] = mapped_column(Integer, nullable=False, default=15, server_default="15")
absolute_timeout_minutes: Mapped[int] = mapped_column(Integer, nullable=False, default=60, server_default="60")
slot_count: Mapped[int] = mapped_column(Integer, nullable=False, default=4, server_default="4")
updated_by: Mapped[str | None] = mapped_column(String(150), nullable=True)
updated_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
class GuiTicket(Base):
"""One-time, 30-second ticket, bound to the OPNexus session, host and slot."""
__tablename__ = "gui_tickets"
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
ticket_hash: Mapped[str] = mapped_column(String(64), nullable=False, unique=True)
session_hash: Mapped[str] = mapped_column(String(64), nullable=False, index=True)
user_id: Mapped[uuid.UUID] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("admin_users.id", ondelete="CASCADE"), nullable=False, index=True
)
host_id: Mapped[uuid.UUID] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("opnsense_hosts.id", ondelete="CASCADE"), nullable=False, index=True
)
slot: Mapped[int] = mapped_column(Integer, nullable=False)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
expires_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
redeemed_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
class GuiSession(Base):
"""A redeemed ticket: one firewall GUI open in one slot of one browser session."""
__tablename__ = "gui_sessions"
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
session_hash: Mapped[str] = mapped_column(String(64), nullable=False, index=True)
user_id: Mapped[uuid.UUID] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("admin_users.id", ondelete="CASCADE"), nullable=False, index=True
)
host_id: Mapped[uuid.UUID] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("opnsense_hosts.id", ondelete="CASCADE"), nullable=False, index=True
)
slot: Mapped[int] = mapped_column(Integer, nullable=False)
client_ip: Mapped[str | None] = mapped_column(String(45), nullable=True)
started_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
last_checked_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
ended_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
end_reason: Mapped[str | None] = mapped_column(String(32), nullable=True)
+4
View File
@@ -44,3 +44,7 @@ class OpnsenseHost(Base):
policy_hierarchy_group: Mapped["PolicyHierarchyGroup | None"] = relationship(
"PolicyHierarchyGroup", back_populates="hosts"
)
# Values for {{NAME}} placeholders (services/variables_service.py); always loaded with the host.
variables: Mapped[list["HostVariable"]] = relationship(
"HostVariable", lazy="selectin", cascade="all, delete-orphan", order_by="HostVariable.name"
)
+18
View File
@@ -0,0 +1,18 @@
"""Per-host values for ``{{NAME}}`` placeholders in centrally authored objects (see services/variables_service.py)."""
import uuid
from sqlalchemy import ForeignKey, String, UniqueConstraint
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column
from app.database import Base
class HostVariable(Base):
__tablename__ = "host_variables"
__table_args__ = (UniqueConstraint("host_id", "name", name="uq_host_variable"),)
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
host_id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), ForeignKey("opnsense_hosts.id", ondelete="CASCADE"), index=True)
name: Mapped[str] = mapped_column(String(41), nullable=False)
value: Mapped[str] = mapped_column(String(255), nullable=False)
+65
View File
@@ -0,0 +1,65 @@
"""Recurring maintenance windows (1.25): "every Sunday 02:00-05:00 Europe/Berlin",
"first Tuesday of the month 22:00 for 3 h". A window on its own changes nothing on any
firewall; rollout plans (models/rollout.py) use it to decide WHEN they may start work on a host.
Times are wall-clock times in the window's own IANA time zone, so a window stays at 02:00
local time across daylight-saving changes (see services/window_service.py for the rules).
"""
import uuid
from datetime import date, datetime, time, timezone
from sqlalchemy import JSON, Boolean, Date, DateTime, ForeignKey, Integer, String, Time, UniqueConstraint
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column, relationship
from app.database import Base
def _now() -> datetime:
return datetime.now(timezone.utc)
class MaintenanceWindow(Base):
__tablename__ = "maintenance_windows"
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
name: Mapped[str] = mapped_column(String(120), unique=True)
timezone: Mapped[str] = mapped_column(String(64))
recurrence: Mapped[str] = mapped_column(String(16)) # weekly | monthly
# weekly: weekdays 0 (Monday) .. 6 (Sunday). JSON columns get a Python default only (Alembic gotcha, see 0007).
weekdays: Mapped[list] = mapped_column(JSON, nullable=False, default=list)
# monthly: "nth_weekday" (month_nth 1-4 or -1 = last, month_weekday 0-6) or "day" (month_day 1-28)
month_mode: Mapped[str | None] = mapped_column(String(16), nullable=True)
month_nth: Mapped[int | None] = mapped_column(Integer, nullable=True)
month_weekday: Mapped[int | None] = mapped_column(Integer, nullable=True)
month_day: Mapped[int | None] = mapped_column(Integer, nullable=True)
start_time: Mapped[time] = mapped_column(Time)
duration_minutes: Mapped[int] = mapped_column(Integer)
# After this many minutes into the window no NEW host action starts (running ones finish).
start_cutoff_minutes: Mapped[int] = mapped_column(Integer, nullable=False, default=60, server_default="60")
enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True, server_default="true")
created_by: Mapped[str] = mapped_column(String(150))
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
exceptions: Mapped[list["MaintenanceWindowException"]] = relationship(
"MaintenanceWindowException", cascade="all, delete-orphan", passive_deletes=True, lazy="selectin",
order_by="MaintenanceWindowException.occurrence_date",
)
class MaintenanceWindowException(Base):
"""One occurrence skipped or moved. Keyed by the occurrence's LOCAL date."""
__tablename__ = "maintenance_window_exceptions"
__table_args__ = (UniqueConstraint("window_id", "occurrence_date", name="uq_window_exception_date"),)
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
window_id: Mapped[uuid.UUID] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("maintenance_windows.id", ondelete="CASCADE"), index=True
)
occurrence_date: Mapped[date] = mapped_column(Date)
kind: Mapped[str] = mapped_column(String(8)) # skip | move
moved_start: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
reason: Mapped[str] = mapped_column(String(300), default="")
actor: Mapped[str] = mapped_column(String(150))
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
+52 -1
View File
@@ -6,7 +6,7 @@ OPNsense API secrets stay off the database entirely.
import uuid
from datetime import datetime, timezone
from sqlalchemy import JSON, Boolean, DateTime, Integer, String, UniqueConstraint
from sqlalchemy import JSON, Boolean, DateTime, Float, Integer, String, UniqueConstraint
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column
@@ -17,6 +17,13 @@ def _now() -> datetime:
return datetime.now(timezone.utc)
DEFAULT_SERVICE_WATCHLIST = (
"unbound", "dnsmasq", "dhcpd", "dhcpd6", "kea-dhcp4", "kea-dhcp6", "ntpd", "openvpn", "wireguard", "strongswan",
)
CHANNEL_TYPES = ("ntfy", "gotify", "telegram", "teams", "matrix")
class NotificationSettings(Base):
"""Single row, id fixed at 1 — see notification_settings_service.get_settings
for the get-or-create helper. The only admin-editable operational config
@@ -52,6 +59,32 @@ class NotificationSettings(Base):
carp_auto_revert_failed_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True, server_default="true")
scheduled_maintenance_failed_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True, server_default="true")
backup_failed_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True, server_default="true")
# Off by default: switching it on for an existing fleet reports every long-standing finding at once.
compliance_alerts_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
# Monitoring alerts (1.24). The gateway alert is on by default (a WAN outage is the one thing every
# operator wants to hear about); resource thresholds and service checks are off, like compliance alerts:
# switching them on for an existing fleet may report long-standing conditions all at once.
gateway_down_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True, server_default="true")
resource_threshold_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
service_down_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
# Rollouts (1.25): a run paused (gate, failure, window...) or an automatic start did not happen.
rollout_problems_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True, server_default="true")
# Gateway: OPNsense' own verdict (down / loss / delay) decides "offline"; these two add an
# OPNexus threshold on the measured values (0 = off).
gateway_loss_threshold_pct: Mapped[int] = mapped_column(Integer, nullable=False, default=20, server_default="20")
gateway_delay_threshold_ms: Mapped[int] = mapped_column(Integer, nullable=False, default=500, server_default="500")
# Resources (0 = that threshold is off). Load is per CPU thread.
disk_threshold_pct: Mapped[int] = mapped_column(Integer, nullable=False, default=90, server_default="90")
memory_threshold_pct: Mapped[int] = mapped_column(Integer, nullable=False, default=95, server_default="95")
swap_threshold_pct: Mapped[int] = mapped_column(Integer, nullable=False, default=50, server_default="50")
load_per_cpu_threshold: Mapped[float] = mapped_column(Float, nullable=False, default=2.0, server_default="2.0")
# Debouncing: consecutive 60 s resource samples that must agree before a problem opens or closes.
alert_confirm_samples: Mapped[int] = mapped_column(Integer, nullable=False, default=3, server_default="3")
resource_confirm_samples: Mapped[int] = mapped_column(Integer, nullable=False, default=5, server_default="5")
# OPNsense service names that are reported when they stop (the API cannot tell a crash from a stop on purpose).
# NULL = the default list (an old row never got one).
service_watchlist: Mapped[list | None] = mapped_column(JSON, nullable=True, default=lambda: list(DEFAULT_SERVICE_WATCHLIST))
poll_interval_seconds: Mapped[int] = mapped_column(Integer, default=300)
updated_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now, onupdate=_now)
@@ -83,3 +116,21 @@ class NotificationProblem(Base):
resolved_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
last_notified_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
resolved_notified_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
class NotificationChannel(Base):
"""An additional delivery channel (ntfy, Gotify, Telegram, Microsoft Teams, Matrix) next to the SMTP
and generic-webhook settings above. Several channels of one type are allowed. ``config`` holds only
non-secret parameters (server URL, topic, chat id, room id); the credential — token, or the whole
webhook URL for Teams — lives in notification_secret_store under ``channel_<id>``, never here."""
__tablename__ = "notification_channels"
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
name: Mapped[str] = mapped_column(String(100), unique=True)
channel_type: Mapped[str] = mapped_column(String(16))
enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True, server_default="true")
config: Mapped[dict] = mapped_column(JSON, nullable=False, default=dict)
secret_set: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
updated_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now, onupdate=_now)
+1 -1
View File
@@ -22,7 +22,7 @@ class OidcSettings(Base):
issuer: Mapped[Optional[str]] = mapped_column(String(500), nullable=True)
client_id: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
client_secret_set: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
scopes: Mapped[str] = mapped_column(String(255), nullable=False, default="openid profile email groups")
scopes: Mapped[str] = mapped_column(String(255), nullable=False, default="openid profile email")
groups_claim: Mapped[str] = mapped_column(String(64), nullable=False, default="groups")
admin_group: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
operator_group: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
+149
View File
@@ -0,0 +1,149 @@
"""Firmware rollouts in waves (1.25): plans (what, in which order, when) and runs (what happened).
A plan's waves point at device groups ("rings": canary -> pilot -> prod). A run freezes the plan
(``plan_snapshot``) and the resolved hosts (``RolloutRunHost``) when it starts, so later edits of
the plan or of a group never change a run that is under way. The run never fires firmware actions
itself: every host step is an ordinary ScheduledMaintenance row (origin="rollout",
auto_verify=True) linked from ``RolloutRunHost.scheduled_maintenance_id`` — see
services/rollout_service.py.
"""
import uuid
from datetime import datetime, timezone
from sqlalchemy import (JSON, Boolean, Column, DateTime, ForeignKey, Integer, String, Table, Text,
UniqueConstraint)
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column, relationship
from app.database import Base
def _now() -> datetime:
return datetime.now(timezone.utc)
rollout_wave_groups = Table(
"rollout_wave_groups", Base.metadata,
Column("wave_id", PGUUID(as_uuid=True), ForeignKey("rollout_plan_waves.id", ondelete="CASCADE"), primary_key=True),
Column("group_id", PGUUID(as_uuid=True), ForeignKey("device_groups.id", ondelete="CASCADE"), primary_key=True),
)
class RolloutPlan(Base):
__tablename__ = "rollout_plans"
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
name: Mapped[str] = mapped_column(String(120), unique=True)
description: Mapped[str] = mapped_column(Text, default="")
action: Mapped[str] = mapped_column(String(16)) # update | major_update
window_id: Mapped[uuid.UUID | None] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("maintenance_windows.id", ondelete="SET NULL"), nullable=True, index=True)
# Start a run by itself at every occurrence of the window. Only for "update" and only while the plan
# is activated AND unchanged since (activated_fingerprint).
auto_start: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
gate_checks: Mapped[dict] = mapped_column(JSON, nullable=False, default=dict)
compliance_mode: Mapped[str] = mapped_column(String(8), nullable=False, default="warn", server_default="warn")
activated_by: Mapped[str | None] = mapped_column(String(150), nullable=True)
activated_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
activated_fingerprint: Mapped[str | None] = mapped_column(String(64), nullable=True)
# Why the last automatic start did not happen: {"occurrence", "code", "params", "at"} (notification source).
auto_start_error: Mapped[dict | None] = mapped_column(JSON, nullable=True)
created_by: Mapped[str] = mapped_column(String(150))
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
updated_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now, onupdate=_now)
waves: Mapped[list["RolloutPlanWave"]] = relationship(
"RolloutPlanWave", cascade="all, delete-orphan", passive_deletes=True, lazy="selectin",
order_by="RolloutPlanWave.position")
class RolloutPlanWave(Base):
__tablename__ = "rollout_plan_waves"
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
plan_id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), ForeignKey("rollout_plans.id", ondelete="CASCADE"), index=True)
position: Mapped[int] = mapped_column(Integer)
label: Mapped[str] = mapped_column(String(60))
soak_minutes: Mapped[int] = mapped_column(Integer, default=30)
carp_handover: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
# Wait for a human "release" before this wave starts (not used for the first wave: starting is the release).
require_approval: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
groups: Mapped[list["DeviceGroup"]] = relationship("DeviceGroup", secondary=rollout_wave_groups, lazy="selectin") # noqa: F821
class RolloutRun(Base):
__tablename__ = "rollout_runs"
__table_args__ = (UniqueConstraint("plan_id", "window_occurrence", name="uq_rollout_run_occurrence"),)
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
plan_id: Mapped[uuid.UUID | None] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("rollout_plans.id", ondelete="SET NULL"), nullable=True, index=True)
plan_name: Mapped[str] = mapped_column(String(120))
plan_snapshot: Mapped[dict] = mapped_column(JSON, nullable=False, default=dict)
action: Mapped[str] = mapped_column(String(16))
# waiting_window | preflight | wave_running | soaking | gate | awaiting_approval | resuming | paused
# | succeeded | cancelled
status: Mapped[str] = mapped_column(String(20), index=True)
paused_from: Mapped[str | None] = mapped_column(String(20), nullable=True)
current_wave: Mapped[int] = mapped_column(Integer, default=0)
target_version: Mapped[str | None] = mapped_column(String(40), nullable=True)
pause_reason: Mapped[str | None] = mapped_column(String(40), nullable=True)
pause_detail: Mapped[dict | None] = mapped_column(JSON, nullable=True)
started_by: Mapped[str] = mapped_column(String(150))
trigger: Mapped[str] = mapped_column(String(8)) # manual | window
window_occurrence: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
# Optimistic lock: every state change bumps it; an engine step computed on an older revision is dropped.
revision: Mapped[int] = mapped_column(Integer, nullable=False, default=0, server_default="0")
progress: Mapped[dict] = mapped_column(JSON, nullable=False, default=dict)
step_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
finished_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
waves: Mapped[list["RolloutRunWave"]] = relationship(
"RolloutRunWave", cascade="all, delete-orphan", passive_deletes=True, lazy="selectin", order_by="RolloutRunWave.index")
hosts: Mapped[list["RolloutRunHost"]] = relationship(
"RolloutRunHost", cascade="all, delete-orphan", passive_deletes=True, lazy="selectin",
order_by=lambda: [RolloutRunHost.wave_index, RolloutRunHost.order])
class RolloutRunWave(Base):
__tablename__ = "rollout_run_waves"
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
run_id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), ForeignKey("rollout_runs.id", ondelete="CASCADE"), index=True)
index: Mapped[int] = mapped_column(Integer)
label: Mapped[str] = mapped_column(String(60))
# pending | awaiting_approval | preflight | running | soaking | gate | passed | skipped | cancelled
status: Mapped[str] = mapped_column(String(20), default="pending")
baseline: Mapped[dict | None] = mapped_column(JSON, nullable=True)
gate_result: Mapped[dict | None] = mapped_column(JSON, nullable=True)
soak_until: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
gate_attempts: Mapped[int] = mapped_column(Integer, nullable=False, default=0, server_default="0")
approved_by: Mapped[str | None] = mapped_column(String(150), nullable=True)
started_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
finished_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
class RolloutRunHost(Base):
__tablename__ = "rollout_run_hosts"
__table_args__ = (UniqueConstraint("run_id", "host_id", name="uq_rollout_run_host"),)
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
run_id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), ForeignKey("rollout_runs.id", ondelete="CASCADE"), index=True)
wave_index: Mapped[int] = mapped_column(Integer)
host_id: Mapped[uuid.UUID | None] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("opnsense_hosts.id", ondelete="SET NULL"), nullable=True, index=True)
host_name: Mapped[str] = mapped_column(String(120))
cluster_name: Mapped[str | None] = mapped_column(String(120), nullable=True)
order: Mapped[int] = mapped_column(Integer, default=0)
# queued | running | verifying | succeeded | skipped | failed | blocked | cancelled
status: Mapped[str] = mapped_column(String(16), default="queued")
scheduled_maintenance_id: Mapped[uuid.UUID | None] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("scheduled_maintenance.id", ondelete="SET NULL"), nullable=True, index=True)
version_before: Mapped[str | None] = mapped_column(String(40), nullable=True)
version_after: Mapped[str | None] = mapped_column(String(40), nullable=True)
# {"code": ..., "params": {...}} — translated in the UI (rollouts.hostNote.*)
detail: Mapped[dict | None] = mapped_column(JSON, nullable=True)
started_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
finished_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
+6 -1
View File
@@ -42,7 +42,12 @@ class ScheduledMaintenance(Base):
host_operation_id: Mapped[uuid.UUID | None] = mapped_column(PGUUID(as_uuid=True), nullable=True)
# Opt-in: hand the traffic over to the CARP partner first, run the action, then switch back.
carp_handover: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
# Only while status == "running" with a handover: handover_wait | job_wait | leave | leave_wait.
# 1.25: check the result automatically (job_wait -> verify) and close the operation, instead of
# leaving it "submitted" for a human. Every rollout step sets it; off for existing plans.
auto_verify: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
# manual | rollout (created by a rollout run, see models/rollout.py RolloutRunHost.scheduled_maintenance_id)
origin: Mapped[str] = mapped_column(String(16), nullable=False, default="manual", server_default="manual")
# Only while status == "running" with a handover or auto_verify: handover_wait | job_wait | verify | leave | leave_wait.
# State lives here, not in memory, so a backend restart in the middle of a run resumes cleanly.
phase: Mapped[str | None] = mapped_column(String(16), nullable=True)
phase_since: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
@@ -0,0 +1,18 @@
"""Version check configured in the web UI (singleton row, id fixed at 1).
Off by default: OPNexus makes no outgoing request until an admin switches it on. An
UPDATE_CHECK_URL in the server's .env still wins over this row (server-managed)."""
from sqlalchemy import Boolean, Integer, String
from sqlalchemy.orm import Mapped, mapped_column
from app.database import Base
DEFAULT_FEED_URL = "https://updates.opnexus.dev/latest.json"
class UpdateCheckSettings(Base):
__tablename__ = "update_check_settings"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
feed_url: Mapped[str] = mapped_column(String(500), nullable=False, default=DEFAULT_FEED_URL, server_default=DEFAULT_FEED_URL)
+6
View File
@@ -99,6 +99,12 @@ class Hub:
code, out = self.run("iptables", "-I", *rule)
if code != 0:
return f"iptables: {out}"[:300]
# The hub only needs its own proxy: never route between peers or into the compose network.
fwd = ("FORWARD", "-j", "DROP")
if self.run("iptables", "-C", *fwd)[0] != 0:
code, out = self.run("iptables", "-I", *fwd)
if code != 0:
return f"iptables: {out}"[:300]
return None
def status(self, error: str | None) -> dict:
+72
View File
@@ -0,0 +1,72 @@
"""The three "take over what exists on the firewall" endpoints that aliases, port forwards, 1:1 NAT and
outbound NAT share (services/object_adopt_service.py has the logic and the evidence):
GET <prefix>/unmanaged?host_id=… candidates found live on the host, with reasons for the refused ones
POST <prefix>/adopt take over one object {host_id, uuid}; returns the new central object
POST <prefix>/adopt-all take over everything adoptable {host_id}; returns adopted + skipped
Like rule adoption this only creates central records; nothing is written to the firewall."""
import uuid
from typing import Callable
from fastapi import APIRouter, Depends
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.database import get_db
from app.errors import ErrorCode, api_error
from app.models.host import OpnsenseHost
from app.schemas.adopt import AdoptAllRequest, AdoptAllResult, AdoptObjectRequest, UnmanagedObject
from app.services import object_adopt_service
from app.services.opnsense_client import OpnsenseAPIError
from app.services.policy_hierarchy_target_service import hydrate_hierarchy_targets
from app.services.policy_service import policy_lock
async def _host(db: AsyncSession, host_id: uuid.UUID) -> OpnsenseHost:
host = await db.get(OpnsenseHost, host_id)
if not host:
raise api_error(404, ErrorCode.HOST_NICHT_GEFUNDEN)
return host
def add_adopt_routes(router: APIRouter, *, kind: str, model, load_options: Callable, to_read: Callable, read_model) -> None:
@router.get("/unmanaged", response_model=list[UnmanagedObject])
async def list_unmanaged(host_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
host = await _host(db, host_id)
try:
return await object_adopt_service.list_unmanaged(db, kind, host)
except OpnsenseAPIError as exc:
raise api_error(502, ErrorCode.HOST_REQUEST_FAILED, host=host.name) from exc
@router.post("/adopt", response_model=read_model, status_code=201)
async def adopt(payload: AdoptObjectRequest, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
host = await _host(db, payload.host_id)
try:
created = await object_adopt_service.adopt(db, kind, host, payload.uuid)
except object_adopt_service.NotFoundOnHost as exc:
raise api_error(404, ErrorCode.ADOPT_OBJECT_NOT_FOUND) from exc
except object_adopt_service.NotAdoptable as exc:
raise api_error(409, ErrorCode.OBJECT_NOT_ADOPTABLE, reasons=", ".join(exc.reasons)) from exc
except OpnsenseAPIError as exc:
raise api_error(502, ErrorCode.HOST_REQUEST_FAILED, host=host.name) from exc
await db.commit()
# The new object sits in the session without its relationships loaded; db.get() would return it as-is.
created = (await db.execute(
select(model).where(model.id == created.id).options(*load_options())
.execution_options(populate_existing=True)
)).scalar_one()
await hydrate_hierarchy_targets(db, [created])
return to_read(created, created.targets, created.deployments)
@router.post("/adopt-all", response_model=AdoptAllResult)
async def adopt_all(payload: AdoptAllRequest, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
host = await _host(db, payload.host_id)
try:
result = await object_adopt_service.adopt_all(db, kind, host)
except OpnsenseAPIError as exc:
raise api_error(502, ErrorCode.HOST_REQUEST_FAILED, host=host.name) from exc
await db.commit()
return result
+4
View File
@@ -17,6 +17,7 @@ from app.schemas.alias import DeploymentResult, AliasCreate, AliasRead, AliasEdi
from app.services.alias_deploy_service import confirm_alias, deploy_alias, undeploy_alias, revert_alias_deployment
from app.services.opnsense_client import OpnsenseAPIError
from app.services.policy_hierarchy_target_service import hydrate_hierarchy_targets, validate_hierarchy_group
from app.routers.adopt_routes import add_adopt_routes
router = APIRouter(prefix="/aliases", tags=["aliases"])
@@ -70,6 +71,9 @@ def _to_read(alias: FirewallAlias, hosts: list[OpnsenseHost], deployments: list[
)
add_adopt_routes(router, kind="alias", model=FirewallAlias, load_options=_load_options, to_read=_to_read, read_model=AliasRead)
@router.get("", response_model=list[AliasRead])
async def list_aliases(db: AsyncSession = Depends(get_db)):
result = await db.execute(select(FirewallAlias).options(*_load_options()))
+49 -10
View File
@@ -15,7 +15,36 @@ logger = logging.getLogger(__name__)
router = APIRouter(prefix="/api/auth", tags=["auth"])
# Plain name: used on HTTP-only (lab) deployments and accepted for a while on
# HTTPS deployments so that sessions issued before 1.27 survive the upgrade.
COOKIE_NAME = "opnexus-session"
# HTTPS deployments: the __Host- prefix makes the browser refuse any cookie of
# this name that is not Secure, has a Domain attribute or a Path other than
# "/". A page on another port of the same host (the GUI gateway slots, any
# other service on that machine) therefore cannot toss a narrower-path cookie
# that shadows the real session, and cannot overwrite it from script (HttpOnly).
SECURE_COOKIE_NAME = "__Host-opnexus-session"
def session_cookie_name() -> str:
return SECURE_COOKIE_NAME if settings.cookie_secure else COOKIE_NAME
def session_token(request: Request) -> str:
"""The session token the browser sent. On HTTPS the __Host- cookie always
wins; the plain name is only a migration fallback when the browser has no
__Host- cookie yet (it is replaced on the next /api/auth/me)."""
if settings.cookie_secure:
return request.cookies.get(SECURE_COOKIE_NAME) or request.cookies.get(COOKIE_NAME, "")
return request.cookies.get(COOKIE_NAME, "")
def uses_legacy_cookie(request: Request) -> bool:
return settings.cookie_secure and not request.cookies.get(SECURE_COOKIE_NAME) and bool(request.cookies.get(COOKIE_NAME))
def has_session_cookie(request: Request) -> bool:
return bool(request.cookies.get(SECURE_COOKIE_NAME) or request.cookies.get(COOKIE_NAME))
def client_ip(request: Request) -> str:
@@ -30,20 +59,25 @@ def client_ip(request: Request) -> str:
return request.client.host if request.client else "unknown"
def _set_session_cookie(response: Response, token: str) -> None:
def _set_session_cookie(response: Response, token: str, max_age: int | None = None) -> None:
response.set_cookie(
key=COOKIE_NAME,
key=session_cookie_name(),
value=token,
max_age=settings.session_lifetime,
max_age=max_age or settings.session_lifetime,
httponly=True,
samesite="lax",
secure=settings.cookie_secure,
path="/",
)
if settings.cookie_secure:
# Migration: a pre-1.27 plain-name cookie must not linger next to the new one.
response.delete_cookie(key=COOKIE_NAME, path="/", secure=True, httponly=True, samesite="lax")
def _clear_session_cookie(response: Response) -> None:
response.delete_cookie(key=COOKIE_NAME, path="/")
response.delete_cookie(key=COOKIE_NAME, path="/", secure=settings.cookie_secure, httponly=True, samesite="lax")
if settings.cookie_secure:
response.delete_cookie(key=SECURE_COOKIE_NAME, path="/", secure=True, httponly=True, samesite="lax")
def _check_account_budget(user: AdminUser, action: str) -> None:
@@ -71,7 +105,7 @@ async def resolve_user(request: Request, db: AsyncSession) -> AdminUser:
user = await db.get(AdminUser, resolved.id)
if user is not None:
return user
token = request.cookies.get(COOKIE_NAME, "")
token = session_token(request)
user = await auth_service.resolve_session(db, token)
if user is None:
raise api_error(status.HTTP_401_UNAUTHORIZED, ErrorCode.NICHT_AUTHENTIFIZIERT)
@@ -229,7 +263,7 @@ async def totp_enable(
user.totp_last_step = step
user.totp_recovery_hashes = hashes
# Other sessions were established without the second factor — end them.
await auth_service.revoke_sessions(db, user.id, keep_token=request.cookies.get(COOKIE_NAME, ""), commit=False)
await auth_service.revoke_sessions(db, user.id, keep_token=session_token(request), commit=False)
await db.commit()
logger.info("Two-factor enabled for '%s'", user.username)
return {"enabled": True, "recovery_codes": plain}
@@ -254,7 +288,7 @@ async def totp_disable(
user.totp_enabled = False
user.totp_recovery_hashes = None
user.totp_last_step = 0
await auth_service.revoke_sessions(db, user.id, keep_token=request.cookies.get(COOKIE_NAME, ""), commit=False)
await auth_service.revoke_sessions(db, user.id, keep_token=session_token(request), commit=False)
await db.commit()
logger.info("Two-factor disabled for '%s'", user.username)
return {"enabled": False}
@@ -262,14 +296,14 @@ async def totp_disable(
@router.post("/logout")
async def logout(request: Request, response: Response, db: AsyncSession = Depends(get_db)):
token = request.cookies.get(COOKIE_NAME, "")
token = session_token(request)
await auth_service.revoke_session(db, token)
_clear_session_cookie(response)
return {"authenticated": False}
@router.get("/me")
async def me(request: Request, db: AsyncSession = Depends(get_db)):
async def me(request: Request, response: Response, db: AsyncSession = Depends(get_db)):
raw = api_token_service.bearer_from_header(request.headers.get("authorization", ""))
if raw is not None:
resolved = await api_token_service.resolve(db, raw, client_ip(request))
@@ -278,10 +312,14 @@ async def me(request: Request, db: AsyncSession = Depends(get_db)):
user, api_token = resolved
return {"authenticated": True, "username": user.username, "role": user.role,
"via": "token", "scope": api_token.scope, "token_name": api_token.name}
token = request.cookies.get(COOKIE_NAME, "")
token = session_token(request)
user = await auth_service.resolve_session(db, token)
if user is None:
return {"authenticated": False}
if uses_legacy_cookie(request):
# Soft migration (1.27): the same server-side session moves to the
# __Host- cookie and the plain-name cookie is deleted — nobody is logged out.
_set_session_cookie(response, token)
return {"authenticated": True, "username": user.username, "role": user.role}
@@ -305,6 +343,7 @@ async def change_password(
# an attacker may hold) and the replacement session commit as one unit.
user.password_hash = await auth_service.hash_password_async(payload.new_password)
await auth_service.revoke_sessions(db, user.id, commit=False)
await api_token_service.revoke_all(db, user.id, commit=False) # a changed password answers a suspected leak: tokens too
token, _ = await auth_service.create_session(
db, user, user_agent=request.headers.get("User-Agent"), ip_address=client_ip(request)
)
+25
View File
@@ -18,6 +18,8 @@ locks are deliberately NOT included here (no fleet-wide list endpoint
exists for those, only per-host, and it's a rarely-triggered flow) —
a documented v1 gap, not an oversight.
"""
from datetime import datetime, timezone
from fastapi import APIRouter, Depends
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
@@ -46,7 +48,10 @@ from app.models.rule_deployment import RuleDeployment
from app.models.wireguard_tunnel import WireguardTunnel
from app.models.wireguard_tunnel_deployment import WireguardTunnelDeployment
from app.schemas.dashboard import ActivityItem, DashboardHost, DashboardSummary, PendingAction
from app.models.resource_sample import HostResourceSample
from app.services import gateway_health_service
from app.services.host_status_service import get_statuses
from app.services.monitor_checks import STALE_AFTER
router = APIRouter(prefix="/dashboard", tags=["dashboard"])
@@ -202,14 +207,34 @@ async def collect_pending_actions(db: AsyncSession) -> list[PendingAction]:
return pending_actions
async def _gateways_by_host(db: AsyncSession, hosts) -> dict:
"""Gateway state from each host's newest resource sample; hosts without a fresh sample are left out."""
result: dict = {}
now = datetime.now(timezone.utc)
for host in hosts:
row = (
await db.execute(
select(HostResourceSample.sampled_at, HostResourceSample.raw["gateways"].as_json())
.where(HostResourceSample.host_id == host.id)
.order_by(HostResourceSample.sampled_at.desc())
.limit(1)
)
).first()
if row is not None and row[1] is not None and now - row[0] <= STALE_AFTER:
result[host.id] = gateway_health_service.from_compact(row[1])
return result
@router.get("", response_model=DashboardSummary)
async def summary(db: AsyncSession = Depends(get_db)):
hosts = (await db.scalars(select(OpnsenseHost).order_by(OpnsenseHost.name))).all()
statuses = await get_statuses(hosts)
gateways = await _gateways_by_host(db, hosts)
host_summaries = [
DashboardHost(
id=host.id, name=host.name, status=statuses.get(host.id, {}).get("status", "offline"),
carp_status=statuses.get(host.id, {}).get("carp_status"), cluster_name=host.cluster_name,
gateways=gateways.get(host.id),
)
for host in hosts
]
+25
View File
@@ -0,0 +1,25 @@
import uuid
from fastapi import APIRouter, Depends
from sqlalchemy.ext.asyncio import AsyncSession
from app.database import get_db
from app.errors import ErrorCode, api_error
from app.models.host import OpnsenseHost
from app.schemas.gateway import GatewayHealth
from app.services import gateway_health_service
from app.services.opnsense_client import OpnsenseAPIError
router = APIRouter(prefix="/hosts/{host_id}/gateways", tags=["host-gateways"])
@router.get("", response_model=list[GatewayHealth])
async def list_gateways(host_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
"""Live gateway state (loss, delay, deviation, OPNsense' verdict) of one firewall."""
host = await db.get(OpnsenseHost, host_id)
if host is None:
raise api_error(404, ErrorCode.HOST_NICHT_GEFUNDEN)
try:
return await gateway_health_service.get_gateway_health(host)
except OpnsenseAPIError as exc:
raise api_error(502, ErrorCode.UPSTREAM_REQUEST_FAILED) from exc
+3
View File
@@ -99,6 +99,9 @@ async def delete_group(group_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
for assignment in (port_forward_groups, one_to_one_groups, outbound_nat_groups):
if await db.scalar(select(assignment.c.group_id).where(assignment.c.group_id == group_id).limit(1)):
raise api_error(409, ErrorCode.GRUPPE_WIRD_NOCH_VON_NAT_REGELN_VERWENDET)
from app.models.rollout import rollout_wave_groups
if await db.scalar(select(rollout_wave_groups.c.group_id).where(rollout_wave_groups.c.group_id == group_id).limit(1)):
raise api_error(409, ErrorCode.ROLLOUT_GROUP_IN_USE)
await db.delete(group)
await db.commit()
+185
View File
@@ -0,0 +1,185 @@
"""Firewall GUI access through the gui-gateway container (1.27).
Public API (session cookie, admin only, never API tokens):
* POST /api/hosts/{id}/gui-ticket — one-time ticket + the slot URL the browser opens (noopener).
* GET/PUT /api/settings/gui-access — switch, idle/absolute timeout, number of slots.
Internal API for the gateway only (NOT under /api, so the proxy never forwards it; shared secret
GUI_GATEWAY_TOKEN in the X-Onx-Gateway-Token header, compared in constant time):
* POST /internal/gui/redeem, /internal/gui/revalidate, /internal/gui/end.
The answers never contain firewall credentials: only the firewall origin, its pinned (public) CA
certificate, the overlay proxy address and the timeouts.
"""
import hashlib
import hmac
import uuid
from datetime import datetime, timezone
from typing import Literal
from fastapi import APIRouter, Depends, Header, HTTPException, Request, status
from pydantic import BaseModel, Field, model_validator
from sqlalchemy.ext.asyncio import AsyncSession
from app.config import settings
from app.database import get_db
from app.errors import ErrorCode, api_error
from app.models.host import OpnsenseHost
from app.models.user import AdminUser
from app.routers.auth import SECURE_COOKIE_NAME, current_user
from app.services import api_token_service, gui_ticket_service as svc
router = APIRouter(tags=["gui-access"])
internal_router = APIRouter(prefix="/internal/gui", include_in_schema=False)
def _require_admin_session(request: Request, user: AdminUser) -> None:
if getattr(request.state, "api_token", None) is not None or api_token_service.bearer_from_header(
request.headers.get("authorization", "")
) is not None:
raise api_error(status.HTTP_403_FORBIDDEN, ErrorCode.GUI_SESSION_REQUIRED)
if user.role != "admin":
raise api_error(status.HTTP_403_FORBIDDEN, ErrorCode.ADMIN_REQUIRED)
class GuiTicketRead(BaseModel):
url: str
slot: int
expires_in: int
@router.post("/hosts/{host_id}/gui-ticket", response_model=GuiTicketRead)
async def create_ticket(host_id: uuid.UUID, request: Request, db: AsyncSession = Depends(get_db),
user: AdminUser = Depends(current_user)):
_require_admin_session(request, user)
if not svc.gateway_configured():
raise api_error(status.HTTP_409_CONFLICT, ErrorCode.GUI_GATEWAY_NOT_CONFIGURED)
session_cookie = request.cookies.get(SECURE_COOKIE_NAME, "")
if not settings.cookie_secure or not session_cookie:
raise api_error(status.HTTP_409_CONFLICT, ErrorCode.GUI_REQUIRES_HTTPS)
row = await svc.get_settings(db)
if not row.enabled:
raise api_error(status.HTTP_409_CONFLICT, ErrorCode.GUI_ACCESS_DISABLED)
host = await db.get(OpnsenseHost, host_id)
if host is None:
raise api_error(status.HTTP_404_NOT_FOUND, ErrorCode.HOST_NICHT_GEFUNDEN)
refusal = svc.host_refusal(host)
if refusal:
raise api_error(status.HTTP_409_CONFLICT, ErrorCode.GUI_HOST_NOT_ELIGIBLE, reason=refusal)
try:
return await svc.issue_ticket(db, user=user, session_token=session_cookie, host=host,
request_host=request.headers.get("host", ""))
except svc.GuiAccessError as exc:
raise api_error(exc.status, exc.code, **exc.params)
class GuiAccessSettingsRead(BaseModel):
enabled: bool
idle_timeout_minutes: int
absolute_timeout_minutes: int
slot_count: int
available: bool
unavailable_reasons: list[str]
slots: list[int]
updated_by: str | None
updated_at: datetime | None
class GuiAccessSettingsUpdate(BaseModel):
enabled: bool
idle_timeout_minutes: int = Field(ge=1, le=240)
absolute_timeout_minutes: int = Field(ge=5, le=720)
slot_count: int = Field(ge=1, le=svc.MAX_SLOTS)
@model_validator(mode="after")
def _idle_within_absolute(self):
if self.idle_timeout_minutes > self.absolute_timeout_minutes:
raise ValueError("idle_timeout_minutes must not exceed absolute_timeout_minutes")
return self
def _settings_read(row) -> dict:
reasons = svc.unavailable_reasons()
return {"enabled": row.enabled, "idle_timeout_minutes": row.idle_timeout_minutes,
"absolute_timeout_minutes": row.absolute_timeout_minutes, "slot_count": row.slot_count,
"available": not reasons, "unavailable_reasons": reasons, "slots": svc.active_slots(row),
"updated_by": row.updated_by, "updated_at": row.updated_at}
@router.get("/settings/gui-access", response_model=GuiAccessSettingsRead)
async def read_settings(request: Request, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin_session(request, user)
row = await svc.get_settings(db)
await db.commit()
return _settings_read(row)
@router.put("/settings/gui-access", response_model=GuiAccessSettingsRead)
async def update_settings(payload: GuiAccessSettingsUpdate, request: Request, db: AsyncSession = Depends(get_db),
user: AdminUser = Depends(current_user)):
_require_admin_session(request, user)
if payload.enabled and svc.unavailable_reasons():
# Never switchable on without HTTPS cookies and a configured gateway.
raise api_error(status.HTTP_409_CONFLICT, ErrorCode.GUI_GATEWAY_NOT_CONFIGURED,
reasons=", ".join(svc.unavailable_reasons()))
row = await svc.get_settings(db)
row.enabled = payload.enabled
row.idle_timeout_minutes = payload.idle_timeout_minutes
row.absolute_timeout_minutes = payload.absolute_timeout_minutes
row.slot_count = payload.slot_count
row.updated_by = user.username
row.updated_at = datetime.now(timezone.utc)
if not payload.enabled:
await svc.end_all(db, "disabled")
await db.commit()
return _settings_read(row)
# ── internal: gateway only ────────────────────────────────────────────────
def _gateway_auth(x_onx_gateway_token: str = Header(default="")) -> None:
expected = settings.gui_gateway_token
if len(expected) < svc.MIN_GATEWAY_TOKEN_LENGTH:
raise HTTPException(status_code=404)
# Fixed-length digests: the comparison time does not depend on the presented value.
if not hmac.compare_digest(hashlib.sha256(x_onx_gateway_token.encode()).digest(),
hashlib.sha256(expected.encode()).digest()):
raise HTTPException(status_code=401)
_HEX64 = r"^[0-9a-f]{64}$"
class RedeemRequest(BaseModel):
ticket_hash: str = Field(pattern=_HEX64)
session_hash: str = Field(pattern=_HEX64)
slot: int = Field(ge=1, le=65535)
client_ip: str | None = Field(default=None, max_length=45)
class RevalidateRequest(BaseModel):
gui_session_id: uuid.UUID
session_hash: str = Field(pattern=_HEX64)
class EndRequest(RevalidateRequest):
reason: Literal["idle", "absolute", "logout", "revoked", "superseded", "shutdown"]
@internal_router.post("/redeem", dependencies=[Depends(_gateway_auth)])
async def internal_redeem(payload: RedeemRequest, db: AsyncSession = Depends(get_db)):
result = await svc.redeem(db, ticket_hash=payload.ticket_hash, session_hash=payload.session_hash,
slot=payload.slot, client_ip=payload.client_ip)
if not result["ok"]:
raise HTTPException(status_code=403, detail={"ok": False, "reason": result["reason"]})
return result
@internal_router.post("/revalidate", dependencies=[Depends(_gateway_auth)])
async def internal_revalidate(payload: RevalidateRequest, db: AsyncSession = Depends(get_db)):
return await svc.revalidate(db, gui_session_id=payload.gui_session_id, session_hash=payload.session_hash)
@internal_router.post("/end", dependencies=[Depends(_gateway_auth)])
async def internal_end(payload: EndRequest, db: AsyncSession = Depends(get_db)):
return {"ok": await svc.end(db, gui_session_id=payload.gui_session_id, session_hash=payload.session_hash,
reason=payload.reason)}
+244
View File
@@ -0,0 +1,244 @@
"""Recurring maintenance windows and their exceptions (1.25).
Every write here counts as a rollout action (api_token_service.is_rollout): a window decides WHEN
unattended firmware actions may run, so an operator needs the same right as for deploying.
"""
import re
import uuid
from datetime import date, datetime, time, timedelta, timezone
from typing import Literal
from fastapi import APIRouter, Depends, Query, Request
from pydantic import BaseModel, Field
from sqlalchemy import select
from sqlalchemy.exc import IntegrityError
from sqlalchemy.ext.asyncio import AsyncSession
from app.database import get_db
from app.errors import ErrorCode, api_error
from app.models.maintenance_window import MaintenanceWindow, MaintenanceWindowException
from app.services import audit_service, window_service
from app.services.policy_service import policy_lock
router = APIRouter(prefix="/maintenance-windows", tags=["maintenance-windows"])
_TIME = re.compile(r"^([01]\d|2[0-3]):([0-5]\d)$")
class WindowIn(BaseModel):
name: str = Field(min_length=1, max_length=120)
timezone: str = Field(min_length=1, max_length=64)
recurrence: Literal["weekly", "monthly"]
weekdays: list[int] = Field(default_factory=list, max_length=7)
month_mode: Literal["nth_weekday", "day"] | None = None
month_nth: int | None = None
month_weekday: int | None = None
month_day: int | None = None
start_time: str
duration_minutes: int = Field(ge=15, le=window_service.MAX_DURATION_MINUTES)
start_cutoff_minutes: int = Field(default=60, ge=5, le=window_service.MAX_DURATION_MINUTES)
enabled: bool = True
class ExceptionIn(BaseModel):
occurrence_date: date
kind: Literal["skip", "move"]
moved_start: datetime | None = None
reason: str = Field(default="", max_length=300)
def _invalid(field: str):
return api_error(422, ErrorCode.WINDOW_INVALID, field=field)
def _validated(payload: WindowIn) -> dict:
name = payload.name.strip()
if not name:
raise _invalid("name")
if not window_service.valid_timezone(payload.timezone):
raise _invalid("timezone")
match = _TIME.match(payload.start_time)
if not match:
raise _invalid("start_time")
values = {
"name": name, "timezone": payload.timezone, "recurrence": payload.recurrence,
"weekdays": [], "month_mode": None, "month_nth": None, "month_weekday": None, "month_day": None,
"start_time": time(int(match.group(1)), int(match.group(2))),
"duration_minutes": payload.duration_minutes,
"start_cutoff_minutes": min(payload.start_cutoff_minutes, payload.duration_minutes),
"enabled": payload.enabled,
}
if payload.recurrence == "weekly":
days = sorted(set(payload.weekdays))
if not days or any(d < 0 or d > 6 for d in days):
raise _invalid("weekdays")
values["weekdays"] = days
elif payload.month_mode == "day":
if payload.month_day is None or not 1 <= payload.month_day <= 28:
raise _invalid("month_day")
values.update(month_mode="day", month_day=payload.month_day)
elif payload.month_mode == "nth_weekday":
if payload.month_nth not in (1, 2, 3, 4, -1):
raise _invalid("month_nth")
if payload.month_weekday is None or not 0 <= payload.month_weekday <= 6:
raise _invalid("month_weekday")
values.update(month_mode="nth_weekday", month_nth=payload.month_nth, month_weekday=payload.month_weekday)
else:
raise _invalid("month_mode")
return values
async def _plans_using(db: AsyncSession, window_id) -> list[dict]:
from app.models.rollout import RolloutPlan
rows = (await db.scalars(select(RolloutPlan).where(RolloutPlan.window_id == window_id).order_by(RolloutPlan.name))).all()
return [{"id": str(p.id), "name": p.name, "auto_start": p.auto_start, "active": p.activated_at is not None} for p in rows]
def read_window(window: MaintenanceWindow, *, now: datetime | None = None, count: int = 5) -> dict:
now = now or datetime.now(timezone.utc)
return {
"id": str(window.id), "name": window.name, "timezone": window.timezone, "recurrence": window.recurrence,
"weekdays": window.weekdays or [], "month_mode": window.month_mode, "month_nth": window.month_nth,
"month_weekday": window.month_weekday, "month_day": window.month_day,
"start_time": window.start_time.strftime("%H:%M"), "duration_minutes": window.duration_minutes,
"start_cutoff_minutes": window.start_cutoff_minutes, "enabled": window.enabled,
"created_by": window.created_by, "created_at": window.created_at,
"open_now": window_service.current(window, now) is not None,
"next": [o.as_dict() for o in window_service.occurrences(window, now, count, with_skipped=True)] if window.enabled else [],
"exceptions": [
{"id": str(e.id), "occurrence_date": e.occurrence_date.isoformat(), "kind": e.kind,
"moved_start": e.moved_start, "reason": e.reason, "actor": e.actor, "created_at": e.created_at}
for e in window.exceptions
],
}
async def _window_or_404(db: AsyncSession, window_id: uuid.UUID) -> MaintenanceWindow:
window = await db.get(MaintenanceWindow, window_id)
if window is None:
raise api_error(404, ErrorCode.WINDOW_NOT_FOUND)
return window
async def _name_taken(db: AsyncSession, name: str, own_id=None) -> bool:
other = await db.scalar(select(MaintenanceWindow.id).where(MaintenanceWindow.name == name))
return other is not None and other != own_id
@router.get("")
async def list_windows(db: AsyncSession = Depends(get_db)):
rows = (await db.scalars(select(MaintenanceWindow).order_by(MaintenanceWindow.name))).all()
result = []
for w in rows:
item = read_window(w)
item["used_by"] = await _plans_using(db, w.id)
result.append(item)
return result
@router.post("", status_code=201)
async def create_window(payload: WindowIn, request: Request, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
values = _validated(payload)
if await _name_taken(db, values["name"]):
raise api_error(409, ErrorCode.WINDOW_NAME_TAKEN)
window = MaintenanceWindow(**values, created_by=request.state.user.username, created_at=datetime.now(timezone.utc))
window.exceptions = []
db.add(window)
await db.commit()
item = read_window(await _window_or_404(db, window.id))
item["used_by"] = []
return item
@router.get("/{window_id}")
async def get_window(window_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
item = read_window(await _window_or_404(db, window_id))
item["used_by"] = await _plans_using(db, window_id)
return item
@router.put("/{window_id}")
async def update_window(window_id: uuid.UUID, payload: WindowIn, db: AsyncSession = Depends(get_db)):
"""Changing a window changes the fingerprint of every plan that uses it, so an activated
automatic start stops until the plan is activated again (see rollout_service.fingerprint)."""
await policy_lock(db)
window = await _window_or_404(db, window_id)
values = _validated(payload)
if await _name_taken(db, values["name"], window.id):
raise api_error(409, ErrorCode.WINDOW_NAME_TAKEN)
for key, value in values.items():
setattr(window, key, value)
await db.commit()
item = read_window(await _window_or_404(db, window_id))
item["used_by"] = await _plans_using(db, window_id)
return item
@router.delete("/{window_id}", status_code=204)
async def delete_window(window_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
window = await _window_or_404(db, window_id)
# A plan without a window means "no time limit": deleting its window must never turn it into one.
if await _plans_using(db, window_id):
raise api_error(409, ErrorCode.WINDOW_IN_USE)
await db.delete(window)
await db.commit()
@router.get("/{window_id}/occurrences")
async def window_occurrences(window_id: uuid.UUID, count: int = Query(10, ge=1, le=50), db: AsyncSession = Depends(get_db)):
window = await _window_or_404(db, window_id)
return [o.as_dict() for o in window_service.occurrences(window, datetime.now(timezone.utc), count, with_skipped=True)]
@router.post("/{window_id}/exceptions", status_code=201)
async def add_exception(window_id: uuid.UUID, payload: ExceptionIn, request: Request, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
window = await _window_or_404(db, window_id)
now = datetime.now(timezone.utc)
if not window_service.is_occurrence_date(window, payload.occurrence_date):
raise api_error(422, ErrorCode.WINDOW_EXCEPTION_INVALID, field="occurrence_date")
# Only future occurrences (or the one open now) can be changed; history stays as it was.
if window_service.local_start(window, payload.occurrence_date) + timedelta(minutes=window.duration_minutes) <= now:
raise api_error(422, ErrorCode.WINDOW_EXCEPTION_INVALID, field="occurrence_date")
moved = None
if payload.kind == "move":
if payload.moved_start is None:
raise api_error(422, ErrorCode.WINDOW_EXCEPTION_INVALID, field="moved_start")
moved = payload.moved_start if payload.moved_start.tzinfo else payload.moved_start.replace(tzinfo=timezone.utc)
if moved <= now:
raise api_error(422, ErrorCode.WINDOW_EXCEPTION_INVALID, field="moved_start")
if any(e.occurrence_date == payload.occurrence_date for e in window.exceptions):
raise api_error(409, ErrorCode.WINDOW_EXCEPTION_EXISTS)
exc = MaintenanceWindowException(
window_id=window.id, occurrence_date=payload.occurrence_date, kind=payload.kind, moved_start=moved,
reason=payload.reason.strip(), actor=request.state.user.username, created_at=now,
)
db.add(exc)
try:
await db.commit()
except IntegrityError:
await db.rollback()
raise api_error(409, ErrorCode.WINDOW_EXCEPTION_EXISTS)
await audit_service.persist(
kind="maintenance_window", action=f"exception_{payload.kind}", status="saved", entity_id=str(window.id),
entity_name=window.name, details={"occurrence_date": payload.occurrence_date.isoformat(),
"moved_start": moved.isoformat() if moved else None, "reason": exc.reason},
)
db.expire_all()
return read_window(await _window_or_404(db, window_id))
@router.delete("/{window_id}/exceptions/{exception_id}")
async def delete_exception(window_id: uuid.UUID, exception_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
window = await _window_or_404(db, window_id)
exc = await db.get(MaintenanceWindowException, exception_id)
if exc is None or exc.window_id != window.id:
raise api_error(404, ErrorCode.WINDOW_EXCEPTION_NOT_FOUND)
await db.delete(exc)
await db.commit()
db.expire_all()
return read_window(await _window_or_404(db, window_id))
+25
View File
@@ -88,6 +88,31 @@ TOOLS = [
"path": "/api/search",
"query": ("q",),
},
{
"name": "rule_match",
"description": "Which firewall rule decides a packet (first packet of a new connection), per firewall, "
"with the verdict (pass/block/reject), the deciding rule and an honest confidence "
"(sure/probable/unknown plus reason codes). Reads only; nothing is changed.",
"inputSchema": {
"type": "object", "required": ["src", "dst"],
"properties": {
"src": {"type": "string", "description": "source IP address"},
"dst": {"type": "string", "description": "destination IP address"},
"proto": {"type": "string", "description": "tcp, udp, icmp, ipv6-icmp or a protocol number", "default": "tcp"},
"dport": {"type": "integer", "minimum": 0, "maximum": 65535},
"sport": {"type": "integer", "minimum": 0, "maximum": 65535, "description": "default: any ephemeral port"},
"icmptype": {"type": "string", "description": "e.g. echoreq or 8"},
"iface": {"type": "string", "description": "ingress interface identifier (e.g. lan); default: guessed per firewall"},
"egress": {"type": "string", "description": "also check the outgoing side: auto or an interface identifier"},
"host_ids": {"type": "string", "description": "comma separated firewall ids (default: all)"},
"group_id": {"type": "string", "description": "device group id instead of host_ids"},
},
},
"path": "/api/rule-analysis/match",
"query": ("src", "dst", "proto", "dport", "sport", "icmptype", "iface", "egress", "host_ids", "group_id"),
# The per-rule trace is for the UI; the verdict, deciding rule and reasons are what matters here.
"drop": ("trace",),
},
{
"name": "api_get",
"description": "Read any other OPNexus API endpoint (GET only), e.g. /api/rules, /api/aliases, /api/logs. "
+112 -2
View File
@@ -1,21 +1,26 @@
import uuid
from urllib.parse import urlsplit
from fastapi import APIRouter, Depends, Query
from sqlalchemy import select
from sqlalchemy.exc import IntegrityError
from sqlalchemy.ext.asyncio import AsyncSession
from app.errors import ErrorCode, api_error
from app.database import get_db
from app.models.user import AdminUser
from app.routers.auth import current_user
from app.models.notification import NotificationProblem
from app.models.notification import NotificationChannel, NotificationProblem
from app.schemas.notification import (
NotificationChannelCreate,
NotificationChannelRead,
NotificationChannelUpdate,
NotificationProblemRead,
NotificationSettingsRead,
NotificationSettingsUpdate,
TestNotificationRequest,
)
from app.services import notification_delivery, notification_settings_service
from app.services import notification_channels, notification_delivery, notification_secret_store, notification_settings_service, url_guard
router = APIRouter(prefix="/notifications", tags=["notifications"])
@@ -43,6 +48,11 @@ async def read_settings(db: AsyncSession = Depends(get_db), user: AdminUser = De
@router.put("/settings", response_model=NotificationSettingsRead)
async def update_settings(payload: NotificationSettingsUpdate, db: AsyncSession = Depends(get_db)):
if payload.webhook_url:
try:
payload.webhook_url = url_guard.validate_url(payload.webhook_url)
except ValueError as exc:
raise api_error(422, ErrorCode.NOTIFICATION_WEBHOOK_URL_INVALID, reason=str(exc)) from None
return await notification_settings_service.update_settings(db, payload)
@@ -79,3 +89,103 @@ async def test_notification(payload: TestNotificationRequest, db: AsyncSession =
except notification_delivery.NotificationDeliveryError as exc:
raise api_error(502, ErrorCode.UPSTREAM_REQUEST_FAILED) from exc
return {"success": True}
# ── Additional channels (ntfy, Gotify, Telegram, Teams, Matrix) ────────────────
def _channel_read(row: NotificationChannel, user: AdminUser) -> NotificationChannelRead:
read = NotificationChannelRead.model_validate(row)
# An ntfy topic or a chat id is as good as a password for whoever knows it: only admins see the settings.
return read if user.role == "admin" else read.model_copy(update={"config": {}})
async def _get_channel(db: AsyncSession, channel_id: uuid.UUID) -> NotificationChannel:
row = await db.get(NotificationChannel, channel_id)
if row is None:
raise api_error(404, ErrorCode.NOTIFICATION_CHANNEL_NOT_FOUND)
return row
def _invalid(exc: ValueError):
return api_error(422, ErrorCode.NOTIFICATION_CHANNEL_INVALID, reason=str(exc))
@router.get("/channels", response_model=list[NotificationChannelRead])
async def list_channels(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
rows = await db.scalars(select(NotificationChannel).order_by(NotificationChannel.name))
return [_channel_read(r, user) for r in rows.all()]
@router.post("/channels", response_model=NotificationChannelRead, status_code=201)
async def create_channel(payload: NotificationChannelCreate, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
try:
config = notification_channels.clean_config(payload.channel_type, payload.config)
secret = notification_channels.clean_secret(payload.channel_type, payload.secret) if payload.secret else None
except ValueError as exc:
raise _invalid(exc) from None
row = NotificationChannel(
name=payload.name.strip(), channel_type=payload.channel_type, enabled=payload.enabled, config=config,
secret_set=secret is not None,
)
row.id = uuid.uuid4()
if secret is None and notification_channels.missing_requirements(row) == "Zugangsdaten fehlen":
raise _invalid(ValueError("Zugangsdaten fehlen"))
db.add(row)
try:
await db.flush()
except IntegrityError:
await db.rollback()
raise api_error(409, ErrorCode.NOTIFICATION_CHANNEL_NAME_TAKEN) from None
if secret is not None:
notification_secret_store.save_secret(notification_channels.secret_name(row.id), secret)
await db.commit()
return _channel_read(row, user)
@router.put("/channels/{channel_id}", response_model=NotificationChannelRead)
async def update_channel(
channel_id: uuid.UUID, payload: NotificationChannelUpdate,
db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user),
):
row = await _get_channel(db, channel_id)
try:
if payload.config is not None:
row.config = notification_channels.clean_config(row.channel_type, payload.config)
new_secret = notification_channels.clean_secret(row.channel_type, payload.secret) if payload.secret else None
except ValueError as exc:
raise _invalid(exc) from None
if payload.name is not None:
row.name = payload.name.strip()
if payload.enabled is not None:
row.enabled = payload.enabled
if payload.clear_secret:
notification_secret_store.delete_secret(notification_channels.secret_name(row.id))
row.secret_set = False
elif new_secret is not None:
notification_secret_store.save_secret(notification_channels.secret_name(row.id), new_secret)
row.secret_set = True
try:
await db.commit()
except IntegrityError:
await db.rollback()
raise api_error(409, ErrorCode.NOTIFICATION_CHANNEL_NAME_TAKEN) from None
return _channel_read(row, user)
@router.delete("/channels/{channel_id}", status_code=204)
async def delete_channel(channel_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
row = await _get_channel(db, channel_id)
notification_secret_store.delete_secret(notification_channels.secret_name(row.id))
await db.delete(row)
await db.commit()
@router.post("/channels/{channel_id}/test")
async def test_channel(channel_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
row = await _get_channel(db, channel_id)
try:
await notification_channels.send_test(row)
except notification_delivery.NotificationDeliveryError as exc:
# The text names the channel and the HTTP status; it never contains a URL or a token.
raise api_error(502, ErrorCode.NOTIFICATION_CHANNEL_TEST_FAILED, reason=str(exc)) from None
return {"success": True}
+29 -6
View File
@@ -1,5 +1,7 @@
"""OIDC single sign-on: public login endpoints and admin-only settings (see services/oidc_service.py)."""
import logging
import re
import secrets
from urllib.parse import urlsplit
from fastapi import APIRouter, Depends, Request
@@ -10,6 +12,7 @@ from app.database import get_db
from app.errors import ErrorCode, api_error
from app.models.user import AdminUser
from app.routers.auth import _set_session_cookie, client_ip, current_user
from app.config import settings
from app.schemas.oidc import OidcSettingsRead, OidcSettingsUpdate
from app.security_middleware import _origin_allowed
from app.services import auth_service, notification_secret_store, oidc_service
@@ -18,10 +21,21 @@ logger = logging.getLogger(__name__)
router = APIRouter(tags=["oidc"])
CALLBACK_PATH = "/api/auth/oidc/callback"
STATE_COOKIE = "opnexus-oidc-state"
# SSO sessions are short: the provider's group membership is only re-checked at login, so a removed person
# must not keep a 30-day session.
SSO_SESSION_SECONDS = 12 * 3600
def _login_error(code: str) -> RedirectResponse:
return RedirectResponse(f"/login?sso_error={code}", status_code=302)
response = RedirectResponse(f"/login?sso_error={code}", status_code=302)
response.delete_cookie(STATE_COOKIE, path="/api/auth/oidc")
return response
def _printable(value: str) -> str:
"""Query text from an unauthenticated caller, made safe for a log line (no CR/LF or other control chars)."""
return re.sub(r"[^\x20-\x7e]", "?", value)[:60]
@router.get("/auth/oidc/config")
@@ -42,11 +56,15 @@ async def start(request: Request, origin: str, db: AsyncSession = Depends(get_db
or not _origin_allowed(f"{parts.scheme}://{parts.netloc}", request.headers.get("host", ""))):
return _login_error("disabled")
try:
url = await oidc_service.start(db, cfg, f"{parts.scheme}://{parts.netloc}{CALLBACK_PATH}")
url, state = await oidc_service.start(db, cfg, f"{parts.scheme}://{parts.netloc}{CALLBACK_PATH}")
except oidc_service.OidcError as exc:
logger.warning("OIDC start fehlgeschlagen: %s", exc)
return _login_error(exc.code)
return RedirectResponse(url, status_code=302)
response = RedirectResponse(url, status_code=302)
# Binds the attempt to THIS browser: a callback URL handed to somebody else (login CSRF) or a captured
# code+state pair is useless without the cookie.
response.set_cookie(STATE_COOKIE, state, max_age=600, httponly=True, samesite="lax", secure=settings.cookie_secure, path="/api/auth/oidc")
return response
@router.get("/auth/oidc/callback")
@@ -59,7 +77,9 @@ async def callback(request: Request, code: str = "", state: str = "", error: str
return _login_error("disabled")
try:
if error or not code or not state:
raise oidc_service.OidcError("provider", f"Anbieter meldet {error or 'keinen Code'}")
raise oidc_service.OidcError("provider", "Anbieter meldet " + (_printable(error) if error else "keinen Code"))
if not secrets.compare_digest(request.cookies.get(STATE_COOKIE, ""), state):
raise oidc_service.OidcError("state", "Der Anmeldeversuch gehört nicht zu diesem Browser")
user = await oidc_service.complete(db, cfg, code, state)
except oidc_service.OidcError as exc:
auth_service.throttle.record_failure(ip, "oidc")
@@ -67,9 +87,12 @@ async def callback(request: Request, code: str = "", state: str = "", error: str
return _login_error(exc.code)
auth_service.throttle.reset(ip, "oidc")
await auth_service.finalize_login(db, user, ip)
token, _ = await auth_service.create_session(db, user, user_agent=request.headers.get("User-Agent"), ip_address=ip)
token, _ = await auth_service.create_session(
db, user, user_agent=request.headers.get("User-Agent"), ip_address=ip, lifetime_seconds=SSO_SESSION_SECONDS
)
response = RedirectResponse("/dashboard", status_code=302)
_set_session_cookie(response, token)
_set_session_cookie(response, token, max_age=SSO_SESSION_SECONDS)
response.delete_cookie(STATE_COOKIE, path="/api/auth/oidc")
logger.info("SSO-Anmeldung von '%s' (%s) aus %s", user.username, user.role, ip)
return response
+4
View File
@@ -20,6 +20,7 @@ from app.services.interface_service import check_interface_consistency
from app.services.opnsense_client import OpnsenseAPIError
from app.services.one_to_one_deploy_service import confirm_one_to_one, deploy_one_to_one, undeploy_one_to_one, revert_deployment
from app.services.policy_hierarchy_target_service import hydrate_hierarchy_targets, validate_hierarchy_group
from app.routers.adopt_routes import add_adopt_routes
router = APIRouter(prefix="/one-to-one", tags=["one-to-one"])
@@ -79,6 +80,9 @@ def _to_read(rule: OneToOneRule, hosts: list[OpnsenseHost], deployments: list[On
)
add_adopt_routes(router, kind="one_to_one", model=OneToOneRule, load_options=_load_options, to_read=_to_read, read_model=OneToOneRead)
@router.get("", response_model=list[OneToOneRead])
async def list_one_to_one_rules(db: AsyncSession = Depends(get_db)):
result = await db.execute(select(OneToOneRule).options(*_load_options()))
+4
View File
@@ -21,6 +21,7 @@ from app.services.interface_service import check_interface_consistency
from app.services.opnsense_client import OpnsenseAPIError
from app.services.outbound_nat_deploy_service import confirm_outbound_nat, deploy_outbound_nat, undeploy_outbound_nat, revert_deployment
from app.services.policy_hierarchy_target_service import hydrate_hierarchy_targets, validate_hierarchy_group
from app.routers.adopt_routes import add_adopt_routes
router = APIRouter(prefix="/outbound-nat", tags=["outbound-nat"])
@@ -82,6 +83,9 @@ def _to_read(rule: OutboundNatRule, hosts: list[OpnsenseHost], deployments: list
)
add_adopt_routes(router, kind="outbound_nat", model=OutboundNatRule, load_options=_load_options, to_read=_to_read, read_model=OutboundNatRead)
@router.get("", response_model=list[OutboundNatRead])
async def list_outbound_nat_rules(db: AsyncSession = Depends(get_db)):
result = await db.execute(select(OutboundNatRule).options(*_load_options()))
+4
View File
@@ -20,6 +20,7 @@ from app.services.interface_service import check_interface_consistency
from app.services.opnsense_client import OpnsenseAPIError
from app.services.port_forward_deploy_service import confirm_port_forward, deploy_port_forward, undeploy_port_forward, revert_deployment
from app.services.policy_hierarchy_target_service import hydrate_hierarchy_targets, validate_hierarchy_group
from app.routers.adopt_routes import add_adopt_routes
router = APIRouter(prefix="/port-forward", tags=["port-forward"])
@@ -80,6 +81,9 @@ def _to_read(rule: PortForwardRule, hosts: list[OpnsenseHost], deployments: list
)
add_adopt_routes(router, kind="port_forward", model=PortForwardRule, load_options=_load_options, to_read=_to_read, read_model=PortForwardRead)
@router.get("", response_model=list[PortForwardRead])
async def list_port_forward_rules(db: AsyncSession = Depends(get_db)):
result = await db.execute(select(PortForwardRule).options(*_load_options()))
+432
View File
@@ -0,0 +1,432 @@
"""Firmware rollouts in waves (1.25): plans and runs.
Roles (enforced in AuthMiddleware, see api_token_service.is_rollout): everybody signed in reads;
operators prepare plans; starting/activating a plan and resuming/approving/skipping/aborting a run
need the deploy right (admin, or operator while operators may deploy). Pausing is deliberately NOT
a rollout action: anybody who may write at all may always brake.
"""
import uuid
from datetime import datetime, timezone
from typing import Literal
from fastapi import APIRouter, Depends, Request
from pydantic import BaseModel, Field
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.database import get_db
from app.errors import ErrorCode, api_error
from app.models.maintenance_window import MaintenanceWindow
from app.models.policy import DeviceGroup
from app.models.rollout import RolloutPlan, RolloutPlanWave, RolloutRun
from app.models.scheduled_maintenance import ScheduledMaintenance
from app.services import audit_service, rollout_engine, rollout_health, rollout_service
from app.services.policy_service import policy_lock
router = APIRouter(prefix="/rollouts", tags=["rollouts"])
ACTIVE_RUN = rollout_engine.ACTIVE
class WaveIn(BaseModel):
label: str = Field(min_length=1, max_length=60)
group_ids: list[uuid.UUID] = Field(min_length=1, max_length=20)
soak_minutes: int = Field(default=30, ge=0, le=rollout_service.MAX_SOAK_MINUTES)
carp_handover: bool = False
require_approval: bool = False
class PlanIn(BaseModel):
name: str = Field(min_length=1, max_length=120)
description: str = Field(default="", max_length=2000)
action: Literal["update", "major_update"] = "update"
window_id: uuid.UUID | None = None
auto_start: bool = False
gate_checks: dict[str, bool] = Field(default_factory=dict)
compliance_mode: Literal["warn", "fail"] = "warn"
waves: list[WaveIn] = Field(min_length=1, max_length=rollout_service.MAX_WAVES)
class TokenIn(BaseModel):
preview_token: str = Field(min_length=64, max_length=64)
async def _plan_or_404(db: AsyncSession, plan_id: uuid.UUID) -> RolloutPlan:
plan = await rollout_service.load_plan(db, plan_id)
if plan is None:
raise api_error(404, ErrorCode.ROLLOUT_PLAN_NOT_FOUND)
return plan
async def read_plan(db: AsyncSession, plan: RolloutPlan, resolved: dict | None = None) -> dict:
resolved = resolved or await rollout_service.resolve(db, plan)
active = plan.activated_at is not None
last_run = await db.scalar(select(RolloutRun).where(RolloutRun.plan_id == plan.id).order_by(RolloutRun.created_at.desc()).limit(1))
return {
**rollout_service.definition(plan),
"description": plan.description,
"waves": [{"id": str(w.id), "position": w.position, "label": w.label, "soak_minutes": w.soak_minutes,
"carp_handover": w.carp_handover, "require_approval": w.require_approval,
"group_ids": [str(g.id) for g in w.groups], "groups": [g.name for g in w.groups],
"host_count": len(resolved["waves"][i]["hosts"]) if i < len(resolved["waves"]) else 0}
for i, w in enumerate(plan.waves)],
"active": active, "activated_by": plan.activated_by, "activated_at": plan.activated_at,
# Activated but the plan, its groups or its window changed since: the automatic start is held back.
"fingerprint_ok": (not active) or plan.activated_fingerprint == rollout_service.fingerprint(plan, resolved),
"auto_start_error": plan.auto_start_error,
"window": resolved["window"], "errors": resolved["errors"], "warnings": resolved["warnings"],
"host_count": sum(len(w["hosts"]) for w in resolved["waves"]),
"last_run": {"id": str(last_run.id), "status": last_run.status, "created_at": last_run.created_at} if last_run else None,
"created_by": plan.created_by, "created_at": plan.created_at, "updated_at": plan.updated_at,
}
async def _apply(db: AsyncSession, plan: RolloutPlan, payload: PlanIn) -> None:
name = payload.name.strip()
if not name:
raise api_error(422, ErrorCode.ROLLOUT_INVALID, field="name")
other = await db.scalar(select(RolloutPlan.id).where(RolloutPlan.name == name))
if other is not None and other != plan.id:
raise api_error(409, ErrorCode.ROLLOUT_NAME_TAKEN)
if payload.window_id is not None and await db.get(MaintenanceWindow, payload.window_id) is None:
raise api_error(422, ErrorCode.ROLLOUT_INVALID, field="window_id")
if any(k not in rollout_health.CHECKS for k in payload.gate_checks):
raise api_error(422, ErrorCode.ROLLOUT_INVALID, field="gate_checks")
wanted = {g for w in payload.waves for g in w.group_ids}
groups = {g.id: g for g in (await db.scalars(select(DeviceGroup).where(DeviceGroup.id.in_(wanted)))).all()}
if len(groups) != len(wanted):
raise api_error(422, ErrorCode.ROLLOUT_INVALID, field="group_ids")
plan.name, plan.description, plan.action = name, payload.description.strip(), payload.action
plan.window_id, plan.auto_start = payload.window_id, payload.auto_start
plan.gate_checks = {k: bool(v) for k, v in payload.gate_checks.items()}
plan.compliance_mode = payload.compliance_mode
plan.waves = [
RolloutPlanWave(position=i, label=w.label.strip() or f"{i + 1}", soak_minutes=w.soak_minutes, carp_handover=w.carp_handover,
require_approval=w.require_approval, groups=[groups[g] for g in dict.fromkeys(w.group_ids)])
for i, w in enumerate(payload.waves)
]
# Any edit disarms the automatic start: an operator cannot quietly change what an admin activated.
plan.activated_at = plan.activated_by = plan.activated_fingerprint = None
plan.auto_start_error = None
@router.get("/plans")
async def list_plans(db: AsyncSession = Depends(get_db)):
plans = (await db.scalars(select(RolloutPlan).order_by(RolloutPlan.name))).all()
return [await read_plan(db, p) for p in plans]
@router.post("/plans", status_code=201)
async def create_plan(payload: PlanIn, request: Request, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
plan = RolloutPlan(created_by=request.state.user.username, created_at=datetime.now(timezone.utc), waves=[])
await _apply(db, plan, payload)
db.add(plan)
await db.commit()
return await read_plan(db, await _plan_or_404(db, plan.id))
@router.get("/plans/{plan_id}")
async def get_plan(plan_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
return await read_plan(db, await _plan_or_404(db, plan_id))
@router.put("/plans/{plan_id}")
async def update_plan(plan_id: uuid.UUID, payload: PlanIn, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
plan = await _plan_or_404(db, plan_id)
was_active = plan.activated_at is not None
await _apply(db, plan, payload)
await db.commit()
if was_active:
await audit_service.persist(kind="rollout", action="deactivate", status="completed", entity_id=str(plan.id),
entity_name=plan.name, message="Plan geändert: automatischer Start deaktiviert")
return await read_plan(db, await _plan_or_404(db, plan_id))
@router.delete("/plans/{plan_id}", status_code=204)
async def delete_plan(plan_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
plan = await _plan_or_404(db, plan_id)
if await db.scalar(select(RolloutRun.id).where(RolloutRun.plan_id == plan.id, RolloutRun.status.in_(ACTIVE_RUN)).limit(1)):
raise api_error(409, ErrorCode.ROLLOUT_PLAN_BUSY)
await db.delete(plan)
await db.commit()
@router.post("/plans/{plan_id}/preview")
async def preview_plan(plan_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
plan = await _plan_or_404(db, plan_id)
resolved = await rollout_service.resolve(db, plan)
return {**resolved, "preview_token": rollout_service.fingerprint(plan, resolved),
"can_start": not resolved["errors"], "plan": await read_plan(db, plan, resolved)}
async def _checked_token(db: AsyncSession, plan: RolloutPlan, token: str) -> tuple[dict, str]:
resolved = await rollout_service.resolve(db, plan)
current = rollout_service.fingerprint(plan, resolved)
if token != current:
raise api_error(409, ErrorCode.ROLLOUT_PREVIEW_STALE)
if resolved["errors"]:
raise api_error(422, ErrorCode.ROLLOUT_PLAN_INVALID, reason=resolved["errors"][0]["code"])
return resolved, current
@router.post("/plans/{plan_id}/activate")
async def activate_plan(plan_id: uuid.UUID, payload: TokenIn, request: Request, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
plan = await _plan_or_404(db, plan_id)
if not plan.auto_start:
raise api_error(422, ErrorCode.ROLLOUT_INVALID, field="auto_start")
_resolved, current = await _checked_token(db, plan, payload.preview_token)
plan.activated_by, plan.activated_at, plan.activated_fingerprint = request.state.user.username, datetime.now(timezone.utc), current
plan.auto_start_error = None
await db.commit()
await audit_service.persist(kind="rollout", action="activate", status="completed", entity_id=str(plan.id),
entity_name=plan.name, details={"fingerprint": current})
return await read_plan(db, await _plan_or_404(db, plan_id))
@router.post("/plans/{plan_id}/deactivate")
async def deactivate_plan(plan_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
plan = await _plan_or_404(db, plan_id)
plan.activated_by = plan.activated_at = plan.activated_fingerprint = None
await db.commit()
await audit_service.persist(kind="rollout", action="deactivate", status="completed", entity_id=str(plan.id), entity_name=plan.name)
return await read_plan(db, await _plan_or_404(db, plan_id))
# ── runs ─────────────────────────────────────────────────────────────────────
class StartIn(TokenIn):
confirm_name: str = Field(min_length=1, max_length=120)
acknowledge_unattended: Literal[True]
class ReasonIn(BaseModel):
reason: str = Field(default="", max_length=500)
class SkipIn(BaseModel):
host_id: uuid.UUID
reason: str = Field(min_length=3, max_length=500)
class AbortIn(BaseModel):
reason: str = Field(min_length=3, max_length=500)
confirm_name: str = Field(min_length=1, max_length=120)
def _read_run_summary(run: RolloutRun) -> dict:
counts: dict[str, int] = {}
for h in run.hosts:
counts[h.status] = counts.get(h.status, 0) + 1
return {
"id": str(run.id), "plan_id": str(run.plan_id) if run.plan_id else None, "plan_name": run.plan_name,
"action": run.action, "status": run.status, "paused_from": run.paused_from, "current_wave": run.current_wave,
"wave_count": len(run.waves), "current_wave_label": next((w.label for w in run.waves if w.index == run.current_wave), None),
"target_version": run.target_version, "pause_reason": run.pause_reason, "pause_detail": run.pause_detail,
"started_by": run.started_by, "trigger": run.trigger, "window_occurrence": run.window_occurrence,
"created_at": run.created_at, "finished_at": run.finished_at, "step_at": run.step_at, "host_counts": counts,
"active": run.status in rollout_engine.ACTIVE,
}
async def read_run(db: AsyncSession, run: RolloutRun) -> dict:
scheds = {}
ids = [h.scheduled_maintenance_id for h in run.hosts if h.scheduled_maintenance_id]
if ids:
scheds = {s.id: s for s in (await db.scalars(select(ScheduledMaintenance).where(ScheduledMaintenance.id.in_(ids)))).all()}
soak_until = next((w.soak_until for w in run.waves if w.index == run.current_wave), None)
return {
**_read_run_summary(run),
"soak_until": soak_until, "progress": {k: v for k, v in (run.progress or {}).items()
if k in ("gate_recheck_at", "cluster_recheck_at", "blocked_since", "resume_gate",
"cluster_gate", "preflight_started", "resume_recheck_at")},
"snapshot": run.plan_snapshot,
"waves": [{"index": w.index, "label": w.label, "status": w.status, "gate_result": w.gate_result,
"gate_attempts": w.gate_attempts, "soak_until": w.soak_until, "approved_by": w.approved_by,
"started_at": w.started_at, "finished_at": w.finished_at,
"spec": run.plan_snapshot["waves"][w.index] if w.index < len(run.plan_snapshot.get("waves", [])) else None}
for w in run.waves],
"hosts": [{"id": str(h.id), "host_id": str(h.host_id) if h.host_id else None, "host_name": h.host_name,
"cluster_name": h.cluster_name, "wave_index": h.wave_index, "order": h.order, "status": h.status,
"version_before": h.version_before, "version_after": h.version_after, "detail": h.detail,
"started_at": h.started_at, "finished_at": h.finished_at,
"schedule": ({"id": str(s.id), "status": s.status, "phase": s.phase, "carp_handover": s.carp_handover,
"host_operation_id": str(s.host_operation_id) if s.host_operation_id else None}
if (s := scheds.get(h.scheduled_maintenance_id)) else None)}
for h in sorted(run.hosts, key=lambda h: (h.wave_index, h.order, h.host_name))],
}
async def _cancel_if_pending(db: AsyncSession, sched_id) -> bool:
"""Cancel a host's schedule only if it has not fired. Locked: the poll loop may be firing it right now
(fire_due holds the row), and a blind write would turn a running action into "cancelled"."""
if sched_id is None:
return False
sched = await db.scalar(select(ScheduledMaintenance).where(ScheduledMaintenance.id == sched_id)
.with_for_update().execution_options(populate_existing=True))
if sched is not None and sched.status == "pending":
sched.status = "cancelled"
return True
return False
async def _run_or_404(db: AsyncSession, run_id: uuid.UUID, *, lock: bool = False) -> RolloutRun:
stmt = select(RolloutRun).where(RolloutRun.id == run_id).execution_options(populate_existing=True)
if lock:
stmt = stmt.with_for_update()
run = await db.scalar(stmt)
if run is None:
raise api_error(404, ErrorCode.ROLLOUT_RUN_NOT_FOUND)
return run
def _not_now(run: RolloutRun):
return api_error(409, ErrorCode.ROLLOUT_ACTION_NOT_ALLOWED, status=run.status)
async def _done(db: AsyncSession, run: RolloutRun, action: str, status: str, request: Request, **details) -> dict:
run.revision += 1
await db.commit()
await audit_service.persist(kind="rollout", action=action, status=status, entity_id=str(run.id), entity_name=run.plan_name,
details={"wave": run.current_wave, **details})
return await read_run(db, await _run_or_404(db, run.id))
@router.post("/plans/{plan_id}/start", status_code=201)
async def start_plan(plan_id: uuid.UUID, payload: StartIn, request: Request, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
plan = await _plan_or_404(db, plan_id)
if payload.confirm_name != plan.name:
raise api_error(409, ErrorCode.ROLLOUT_CONFIRM_NAME)
resolved, _token = await _checked_token(db, plan, payload.preview_token)
if (other := await rollout_engine.active_run(db)) is not None:
# One run at a time: two runs could otherwise touch the same cluster at once.
raise api_error(409, ErrorCode.ROLLOUT_ALREADY_ACTIVE, plan=other.plan_name)
run = await rollout_engine.create_run(db, plan, resolved, started_by=request.state.user.username, trigger="manual")
await db.commit()
await audit_service.persist(kind="rollout", action="start", status="started", entity_id=str(run.id), entity_name=plan.name,
details={"trigger": "manual", "hosts": sum(len(w["hosts"]) for w in resolved["waves"]),
"waves": [w["label"] for w in resolved["waves"]]})
return await read_run(db, await _run_or_404(db, run.id))
@router.get("/runs")
async def list_runs(db: AsyncSession = Depends(get_db)):
runs = (await db.scalars(select(RolloutRun).order_by(RolloutRun.created_at.desc()).limit(50))).all()
return [_read_run_summary(r) for r in runs]
@router.get("/status")
async def rollout_status(db: AsyncSession = Depends(get_db)):
"""For /updates and the host pages: the active run and the hosts it still owns."""
run = await rollout_engine.active_run(db)
if run is None:
return {"active": None, "host_ids": [], "current_host_ids": []}
return {
"active": _read_run_summary(run),
"host_ids": [str(h.host_id) for h in run.hosts if h.host_id and h.status in ("queued", "blocked", "running", "verifying", "failed")],
"current_host_ids": [str(h.host_id) for h in run.hosts if h.host_id and h.wave_index == run.current_wave
and h.status in ("queued", "blocked", "running", "verifying", "failed")],
}
@router.get("/runs/{run_id}")
async def get_run(run_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
return await read_run(db, await _run_or_404(db, run_id))
@router.post("/runs/{run_id}/pause")
async def pause_run(run_id: uuid.UUID, payload: ReasonIn, request: Request, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
run = await _run_or_404(db, run_id, lock=True)
if run.status not in rollout_engine.ACTIVE or run.status == "paused":
raise _not_now(run)
# A brake that lets the next host fire anyway is no brake: a step not fired yet goes back to the queue.
requeued = [h.host_name for h in run.hosts if await rollout_engine.requeue_if_pending(db, h)]
rollout_engine.pause(run, "manual", by=request.state.user.username, text=payload.reason.strip()[:300])
return await _done(db, run, "pause", "paused", request, reason="manual", text=payload.reason.strip()[:300], requeued=requeued)
@router.post("/runs/{run_id}/resume")
async def resume_run(run_id: uuid.UUID, request: Request, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
run = await _run_or_404(db, run_id, lock=True)
if run.status != "paused":
raise _not_now(run)
failed = [h.host_name for h in run.hosts if h.status == "failed"]
if failed:
# A failed host is never retried by itself: check it, then skip it explicitly.
raise api_error(409, ErrorCode.ROLLOUT_HOST_FAILED, hosts=", ".join(failed))
previous = run.started_by
# Whoever resumes takes over the responsibility (and the permission check) from here on.
run.started_by = request.state.user.username
run.status = "resuming"
run.pause_reason = run.pause_detail = None
run.progress = {**(run.progress or {}), "resume_attempts": 0, "resume_recheck_at": None, "paused_at": None}
return await _done(db, run, "resume", "resuming", request, previous_owner=previous)
@router.post("/runs/{run_id}/approve")
async def approve_wave(run_id: uuid.UUID, request: Request, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
run = await _run_or_404(db, run_id, lock=True)
if run.status != "awaiting_approval":
raise _not_now(run)
wave = rollout_engine.wave_row(run, run.current_wave)
wave.approved_by, wave.status = request.state.user.username, "preflight"
run.started_by = request.state.user.username
run.status = "preflight"
run.progress = {**(run.progress or {}), "preflight_started": None, "preflight_requested_at": None}
return await _done(db, run, "approve", "approved", request, wave_label=wave.label)
@router.post("/runs/{run_id}/skip-host")
async def skip_host(run_id: uuid.UUID, payload: SkipIn, request: Request, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
run = await _run_or_404(db, run_id, lock=True)
if run.status not in rollout_engine.ACTIVE:
raise _not_now(run)
host = next((h for h in run.hosts if h.host_id == payload.host_id), None)
if host is None:
raise api_error(404, ErrorCode.ROLLOUT_HOST_NOT_IN_RUN)
if host.status in ("running", "verifying"):
if not await _cancel_if_pending(db, host.scheduled_maintenance_id):
raise api_error(409, ErrorCode.ROLLOUT_HOST_RUNNING, host=host.host_name)
# not fired yet: nothing happened on the firewall
elif host.status not in ("queued", "blocked", "failed"):
raise api_error(409, ErrorCode.ROLLOUT_HOST_RUNNING, host=host.host_name)
host.status = "skipped"
host.detail = {"code": "skipped_by", "params": {"user": request.state.user.username, "reason": payload.reason.strip()[:300]}}
host.finished_at = datetime.now(timezone.utc)
return await _done(db, run, "skip_host", "skipped", request, host=host.host_name, reason=payload.reason.strip()[:300])
@router.post("/runs/{run_id}/abort")
async def abort_run(run_id: uuid.UUID, payload: AbortIn, request: Request, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
run = await _run_or_404(db, run_id, lock=True)
if run.status not in rollout_engine.ACTIVE:
raise _not_now(run)
if payload.confirm_name != run.plan_name:
raise api_error(409, ErrorCode.ROLLOUT_CONFIRM_NAME)
now = datetime.now(timezone.utc)
still_running = []
for host in run.hosts:
if host.status in ("running", "verifying") and host.scheduled_maintenance_id:
if await _cancel_if_pending(db, host.scheduled_maintenance_id):
host.status, host.finished_at = "cancelled", now
else:
still_running.append(host.host_name) # an action already on the firewall is finished in a controlled way
elif host.status in ("queued", "blocked"):
host.status, host.finished_at = "cancelled", now
for wave in run.waves:
if wave.status not in ("passed", "skipped"):
wave.status = "cancelled"
run.status, run.finished_at = "cancelled", now
run.pause_reason, run.pause_detail = "aborted", {"by": request.state.user.username, "reason": payload.reason.strip()[:300],
"still_running": still_running}
return await _done(db, run, "abort", "cancelled", request, reason=payload.reason.strip()[:300], still_running=still_running)
+91
View File
@@ -0,0 +1,91 @@
"""Rule analysis: which rule decides a packet (read-only, GET so ``read`` tokens and MCP can use it).
Nothing is stored and nothing is written to a firewall; every request reads the rules, the
loaded pf ruleset and the interfaces (cached for 60 s per firewall, ``refresh=true`` skips
the cache) and evaluates them with services/rule_analysis/engine.py.
"""
import asyncio
import logging
import uuid
from fastapi import APIRouter, Depends, HTTPException, Query
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.orm import selectinload
from app.database import get_db
from app.errors import ErrorCode, api_error
from app.models.host import OpnsenseHost
from app.models.policy import DeviceGroup
from app.services.rule_analysis import service
logger = logging.getLogger(__name__)
router = APIRouter(tags=["rule-analysis"])
_PARALLEL = 5
def _query(src: str, dst: str, proto: str, sport: str | None, dport: str | None, icmptype: str | None,
iface: str | None, direction: str, egress: str | None):
return service.build_query(src=src, dst=dst, proto=proto, sport=sport, dport=dport, icmptype=icmptype,
iface=iface, direction=direction, egress=egress)
async def _run(host: OpnsenseHost, q, refresh: bool) -> dict:
head = {"host_id": str(host.id), "host_name": host.name, "cluster_name": host.cluster_name}
try:
return {**head, **await service.analyze_host(host, q, refresh=refresh), "error": None}
except HTTPException as exc:
return {**head, "error": exc.detail}
except Exception as exc: # noqa: BLE001 - one unreachable firewall must not fail the fleet answer
logger.info("rule analysis failed for %s: %s", host.name, exc)
return {**head, "error": {"code": ErrorCode.ANALYSE_FIREWALL_NICHT_LESBAR.value, "params": {}}}
@router.get("/hosts/{host_id}/rule-analysis/match")
async def host_match(
host_id: uuid.UUID, src: str, dst: str, proto: str = "tcp", sport: str | None = None, dport: str | None = None,
icmptype: str | None = None, iface: str | None = None, direction: str = "in", egress: str | None = None,
refresh: bool = False, db: AsyncSession = Depends(get_db),
):
host = await db.get(OpnsenseHost, host_id)
if host is None:
raise api_error(404, ErrorCode.HOST_NICHT_GEFUNDEN)
q = _query(src, dst, proto, sport, dport, icmptype, iface, direction, egress)
result = await _run(host, q, refresh)
error = result.get("error")
if error:
status = 422 if error.get("code") == ErrorCode.ANALYSE_INTERFACE_UNBEKANNT.value else 502
raise HTTPException(status_code=status, detail=error)
return result
@router.get("/rule-analysis/match")
async def fleet_match(
src: str, dst: str, proto: str = "tcp", sport: str | None = None, dport: str | None = None,
icmptype: str | None = None, iface: str | None = None, direction: str = "in", egress: str | None = None,
host_ids: str | None = Query(None, description="comma separated host ids; default: all enabled hosts"),
group_id: uuid.UUID | None = None, refresh: bool = False, db: AsyncSession = Depends(get_db),
):
q = _query(src, dst, proto, sport, dport, icmptype, iface, direction, egress)
if group_id is not None:
group = await db.scalar(select(DeviceGroup).options(selectinload(DeviceGroup.hosts)).where(DeviceGroup.id == group_id))
if group is None:
raise api_error(404, ErrorCode.GRUPPE_NICHT_GEFUNDEN)
hosts = sorted(group.hosts, key=lambda h: h.name)
elif host_ids:
try:
ids = [uuid.UUID(part.strip()) for part in host_ids.split(",") if part.strip()]
except ValueError:
raise api_error(422, ErrorCode.ANALYSE_PARAMETER_UNGUELTIG, field="host_ids", value=host_ids[:64]) from None
hosts = list((await db.scalars(select(OpnsenseHost).where(OpnsenseHost.id.in_(ids)).order_by(OpnsenseHost.name))).all())
if len(hosts) != len(set(ids)):
raise api_error(404, ErrorCode.HOST_NICHT_GEFUNDEN)
else:
hosts = list((await db.scalars(select(OpnsenseHost).where(OpnsenseHost.enabled.is_(True)).order_by(OpnsenseHost.name))).all())
gate = asyncio.Semaphore(_PARALLEL)
async def one(host):
async with gate:
return await _run(host, q, refresh)
return list(await asyncio.gather(*(one(h) for h in hosts)))
+8 -1
View File
@@ -24,6 +24,8 @@ class Schedule(BaseModel):
acknowledge_unattended: Literal[True]
# Hand the traffic over to the CARP partner first and switch back afterwards (cluster nodes only).
carp_handover: bool = False
# Check the result automatically afterwards and close the operation (no manual "Wartung abschließen").
auto_verify: bool = False
def _read(sched: ScheduledMaintenance) -> dict:
@@ -32,6 +34,8 @@ def _read(sched: ScheduledMaintenance) -> dict:
"status": sched.status, "actor": sched.actor, "created_at": sched.created_at,
"result": sched.result, "host_operation_id": sched.host_operation_id,
"carp_handover": sched.carp_handover, "phase": sched.phase,
"auto_verify": sched.auto_verify, "origin": sched.origin,
"rollout_run_id": ((sched.progress or {}).get("rollout") or {}).get("run_id"),
}
@@ -80,6 +84,7 @@ async def create_scheduled(host_id: uuid.UUID, payload: Schedule, request: Reque
sched = ScheduledMaintenance(
host_id=host.id, host_name=host.name, action=payload.action, run_at=run_at,
actor=request.state.user.username, created_at=now, carp_handover=payload.carp_handover,
auto_verify=payload.auto_verify,
)
db.add(sched)
await db.commit()
@@ -90,7 +95,9 @@ async def create_scheduled(host_id: uuid.UUID, payload: Schedule, request: Reque
async def cancel_scheduled(host_id: uuid.UUID, schedule_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
await policy_lock(db)
await _host_or_404(db, host_id)
sched = await db.get(ScheduledMaintenance, schedule_id)
# Locked and re-read: the poll loop may be firing this very row right now (it holds the lock meanwhile).
sched = await db.scalar(select(ScheduledMaintenance).where(ScheduledMaintenance.id == schedule_id)
.with_for_update().execution_options(populate_existing=True))
if not sched or sched.host_id != host_id:
raise api_error(404, ErrorCode.GEPLANTE_WARTUNG_NICHT_GEFUNDEN)
if sched.status != "pending":
+64 -6
View File
@@ -1,19 +1,23 @@
from fastapi import APIRouter, Depends
from pydantic import BaseModel, Field
from sqlalchemy.ext.asyncio import AsyncSession
from app.config import settings
from app.database import get_db
from app.errors import ErrorCode, api_error
from app.models.user import AdminUser
from app.routers.auth import current_user
from app.services import rollout_engine
from app.services import update_check_service, updater_client
router = APIRouter(prefix="/system", tags=["system"])
@router.get("/version-check")
async def version_check() -> dict:
async def version_check(db: AsyncSession = Depends(get_db)) -> dict:
"""Ist eine neuere OPNexus-Version veröffentlicht? Aus, solange
UPDATE_CHECK_URL nicht gesetzt ist (dann ohne ausgehende Anfrage)."""
return await update_check_service.check()
return await update_check_service.check(db)
def _admin(user: AdminUser) -> AdminUser:
@@ -31,16 +35,63 @@ def _major(version: str | None) -> int | None:
return None
class UpdateCheckRead(BaseModel):
enabled: bool
feed_url: str
managed_by_server: bool
class UpdateCheckUpdate(BaseModel):
enabled: bool | None = None
feed_url: str | None = Field(default=None, max_length=500)
async def _update_check_settings(db: AsyncSession) -> UpdateCheckRead:
row = await update_check_service.get_settings(db)
managed = update_check_service.managed_by_server()
return UpdateCheckRead(
enabled=True if managed else row.enabled,
feed_url=settings.update_check_url.strip() if managed else row.feed_url,
managed_by_server=managed,
)
@router.get("/update-check", response_model=UpdateCheckRead)
async def read_update_check(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
"""Versionsprüfung für „Einstellungen › OPNexus aktualisieren“ (nur Admins)."""
_admin(user)
return await _update_check_settings(db)
@router.put("/update-check", response_model=UpdateCheckRead)
async def update_update_check(payload: UpdateCheckUpdate, db: AsyncSession = Depends(get_db),
user: AdminUser = Depends(current_user)):
_admin(user)
if update_check_service.managed_by_server():
raise api_error(409, ErrorCode.UPDATE_CHECK_MANAGED_BY_SERVER)
row = await update_check_service.get_settings(db)
if payload.feed_url is not None:
url = payload.feed_url.strip()
if not update_check_service.valid_feed_url(url):
raise api_error(422, ErrorCode.UPDATE_CHECK_URL_INVALID)
row.feed_url = url
if payload.enabled is not None:
row.enabled = payload.enabled
await db.commit()
update_check_service.reset_cache()
return await _update_check_settings(db)
class UpdateRequest(BaseModel):
version: str = Field(min_length=5, max_length=20)
@router.get("/updater")
async def updater_status(user: AdminUser = Depends(current_user)) -> dict:
async def updater_status(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)) -> dict:
"""Zustand für den Abschnitt "OPNexus aktualisieren" in den Einstellungen:
Versionshinweis des Release-Feeds plus (falls aktiviert) der Updater."""
_admin(user)
check = await update_check_service.check()
check = await update_check_service.check(db)
result: dict = {
"available": False, "reason": None, "mode": None,
"current": check["current"], "latest": check["latest"], "update_available": check["update_available"],
@@ -49,11 +100,17 @@ async def updater_status(user: AdminUser = Depends(current_user)) -> dict:
"can_update": False, "major_change": False,
"job": None, "phases": [], "log": [], "services": {},
"rollback_available": False, "rollback_loses_data": False, "rollback_version": None,
# A restart in the middle of a firmware rollout is safe (its state is in the database), but the
# UI warns: the run pauses its 15-second steps for as long as OPNexus is down.
"active_rollouts": await rollout_engine.count_active(db),
}
try:
updater = await updater_client.status()
except updater_client.UpdaterUnavailable as exc:
result["reason"] = str(exc)
# Without the updater the install mode is still known from the image registry setting; the UI uses it
# to not offer enabling the updater on an install that builds from source (it could not update anyway).
result["mode"] = "release" if settings.opnexus_image_repo.strip() else "local"
return result
except updater_client.UpdaterRejected:
result["reason"] = "unreachable"
@@ -77,11 +134,12 @@ async def updater_status(user: AdminUser = Depends(current_user)) -> dict:
@router.post("/updater/update", status_code=202)
async def updater_update(payload: UpdateRequest, user: AdminUser = Depends(current_user)) -> dict:
async def updater_update(payload: UpdateRequest, db: AsyncSession = Depends(get_db),
user: AdminUser = Depends(current_user)) -> dict:
"""Aktualisiert OPNexus auf die vom Release-Feed gemeldete neueste stabile
Version. Beliebige Versionen werden bewusst nicht angenommen."""
_admin(user)
check = await update_check_service.check()
check = await update_check_service.check(db)
if not check["update_available"] or payload.version.lstrip("v") != check["latest"]:
raise api_error(409, ErrorCode.UPDATE_NOT_OFFERED)
if _major(check["latest"]) != _major(check["current"]):
+98
View File
@@ -0,0 +1,98 @@
"""Site variables of one host: the values for {{NAME}} placeholders, and which placeholders its objects use."""
import uuid
from fastapi import APIRouter, Depends
from pydantic import BaseModel, Field
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.orm import selectinload
from app.database import get_db
from app.errors import ErrorCode, api_error
from app.models.alias import FirewallAlias
from app.models.host import OpnsenseHost
from app.models.host_variable import HostVariable
from app.models.one_to_one import OneToOneRule
from app.models.outbound_nat import OutboundNatRule
from app.models.policy import DeviceGroup
from app.models.port_forward import PortForwardRule
from app.models.rule import FirewallRule
from app.services import alias_deploy_service, one_to_one_deploy_service, outbound_nat_deploy_service
from app.services import port_forward_deploy_service, rule_deploy_service, variables_service
from app.services.policy_hierarchy_target_service import hydrate_hierarchy_targets
from app.services.policy_service import effective_hosts
router = APIRouter(prefix="/hosts/{host_id}/variables", tags=["variables"])
_KINDS = (
("rule", FirewallRule, rule_deploy_service),
("alias", FirewallAlias, alias_deploy_service),
("port_forward", PortForwardRule, port_forward_deploy_service),
("one_to_one", OneToOneRule, one_to_one_deploy_service),
("outbound_nat", OutboundNatRule, outbound_nat_deploy_service),
)
class VariablesUpdate(BaseModel):
variables: dict[str, str] = Field(default_factory=dict, max_length=200)
async def _host(db: AsyncSession, host_id: uuid.UUID) -> OpnsenseHost:
host = await db.get(OpnsenseHost, host_id)
if host is None:
raise api_error(404, ErrorCode.HOST_NICHT_GEFUNDEN)
return host
async def _usage(db: AsyncSession, host: OpnsenseHost) -> dict[str, list[dict]]:
"""name -> objects (that are deployed to this host) which use it."""
used: dict[str, list[dict]] = {}
for kind, model, service in _KINDS:
entities = (await db.execute(
select(model).options(selectinload(model.targets), selectinload(model.groups).selectinload(DeviceGroup.hosts))
)).scalars().unique().all()
await hydrate_hierarchy_targets(db, entities)
for entity in entities:
if host.id not in {h.id for h in effective_hosts(entity)}:
continue
label = getattr(entity, "description", None) or getattr(entity, "name", None) or str(entity.id)
for name in variables_service.names_in_payload(service._base_payload(entity)):
used.setdefault(name, []).append({"kind": kind, "id": str(entity.id), "label": label})
return used
async def _read(db: AsyncSession, host: OpnsenseHost) -> dict:
values = variables_service.host_values(host)
used = await _usage(db, host)
names = sorted(set(values) | set(used))
return {"variables": [
{"name": n, "value": values.get(n), "used_by": used.get(n, []), "missing": n in used and n not in values}
for n in names
]}
@router.get("")
async def read(host_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
return await _read(db, await _host(db, host_id))
@router.put("")
async def replace(host_id: uuid.UUID, payload: VariablesUpdate, db: AsyncSession = Depends(get_db)):
"""Replace this host's variables with exactly the given set."""
host = await _host(db, host_id)
for name, value in payload.variables.items():
if not variables_service.NAME_RE.fullmatch(name):
raise api_error(422, ErrorCode.VARIABLE_INVALID, reason=f"Name „{name}“: Großbuchstaben, Ziffern und _, beginnend mit einem Buchstaben")
if not variables_service.VALUE_RE.fullmatch(value):
raise api_error(422, ErrorCode.VARIABLE_INVALID, reason=f"Wert von {name}: 1–255 Zeichen aus Buchstaben, Ziffern und . : / , @ + - _ Leerzeichen")
existing = {v.name: v for v in host.variables}
for name in set(existing) - set(payload.variables):
host.variables.remove(existing[name])
for name, value in payload.variables.items():
if name in existing:
existing[name].value = value
else:
host.variables.append(HostVariable(name=name, value=value))
await db.commit()
await db.refresh(host)
return await _read(db, host)
+48
View File
@@ -0,0 +1,48 @@
import uuid
from pydantic import BaseModel, Field
class AdoptObjectRequest(BaseModel):
host_id: uuid.UUID
uuid: str = Field(min_length=1, max_length=64) # the object's UUID on the firewall
class AdoptAllRequest(BaseModel):
host_id: uuid.UUID
class UnmanagedObject(BaseModel):
"""An alias / NAT rule found on a host that OPNexus does not manage yet (see object_adopt_service.py)."""
uuid: str
title: str
enabled: bool
adoptable: bool # can be adopted on its own right now
# Adoptable in the same "adopt all" run although not on its own (an alias whose referenced aliases come first).
bulk_adoptable: bool
# Codes such as "unsupported_type" or "no_target"; the UI turns them into text.
reasons: list[str]
reason_details: dict[str, str] = Field(default_factory=dict) # code -> extra text (alias names, type, ...)
# Settings OPNexus does not manage that stay untouched on the firewall (log, pool options, tags, ...).
kept: list[str] = Field(default_factory=list)
# Facts for display, depend on the object type.
info: dict[str, str] = Field(default_factory=dict)
class AdoptedObject(BaseModel):
uuid: str
title: str
id: uuid.UUID
class SkippedObject(BaseModel):
uuid: str
title: str
reasons: list[str]
reason_details: dict[str, str] = Field(default_factory=dict)
class AdoptAllResult(BaseModel):
adopted: list[AdoptedObject]
skipped: list[SkippedObject]
+4
View File
@@ -3,6 +3,8 @@ from datetime import datetime
from pydantic import BaseModel
from app.schemas.gateway import GatewayHealth
class DashboardHost(BaseModel):
id: uuid.UUID
@@ -10,6 +12,8 @@ class DashboardHost(BaseModel):
status: str
carp_status: str | None
cluster_name: str | None
# From the last resource sample (no live call); None when there is no sample from the last 3 minutes.
gateways: list[GatewayHealth] | None = None
class PendingAction(BaseModel):
+19
View File
@@ -0,0 +1,19 @@
from typing import Literal
from pydantic import BaseModel
# online: all fine · degraded: OPNsense flags loss and/or latency above the gateway's own limits ·
# offline: down · forced_down: switched off by the admin on purpose · unknown: nothing measured
# (monitoring disabled) or the verdict is still pending.
GatewayState = Literal["online", "degraded", "offline", "forced_down", "unknown"]
class GatewayHealth(BaseModel):
name: str
address: str | None = None
status: str # OPNsense' raw verdict: none | down | force_down | delay | loss | delay+loss | …
state: GatewayState
loss: float | None = None # percent
delay: float | None = None # milliseconds
stddev: float | None = None # milliseconds
monitor: str | None = None # the monitored address
+107 -1
View File
@@ -1,10 +1,12 @@
import re
import uuid
from datetime import datetime
from typing import Literal
from pydantic import BaseModel, ConfigDict, Field
from pydantic import BaseModel, ConfigDict, Field, field_validator
from app.config import settings
from app.models.notification import DEFAULT_SERVICE_WATCHLIST
SmtpSecurity = Literal["none", "starttls", "ssl"]
ProblemType = Literal[
@@ -13,7 +15,11 @@ ProblemType = Literal[
"scheduled_maintenance_failed",
"backup_stale",
"backup_offsite_failed",
"compliance_finding",
"gateway_down", "resource_threshold", "service_down",
"rollout_paused", "rollout_start_failed",
]
ChannelType = Literal["ntfy", "gotify", "telegram", "teams", "matrix"]
class NotificationSettingsRead(BaseModel):
@@ -43,10 +49,29 @@ class NotificationSettingsRead(BaseModel):
carp_auto_revert_failed_enabled: bool
scheduled_maintenance_failed_enabled: bool = True
backup_failed_enabled: bool = True
compliance_alerts_enabled: bool = False
gateway_down_enabled: bool = True
resource_threshold_enabled: bool = False
service_down_enabled: bool = False
rollout_problems_enabled: bool = True
gateway_loss_threshold_pct: int = 20
gateway_delay_threshold_ms: int = 500
disk_threshold_pct: int = 90
memory_threshold_pct: int = 95
swap_threshold_pct: int = 50
load_per_cpu_threshold: float = 2.0
alert_confirm_samples: int = 3
resource_confirm_samples: int = 5
service_watchlist: list[str] = Field(default_factory=lambda: list(DEFAULT_SERVICE_WATCHLIST))
poll_interval_seconds: int
updated_at: datetime
@field_validator("service_watchlist", mode="before")
@classmethod
def _default_watchlist(cls, value):
return list(DEFAULT_SERVICE_WATCHLIST) if value is None else value
class NotificationSettingsUpdate(BaseModel):
"""Partial update — everything optional, only provided fields change.
@@ -81,6 +106,35 @@ class NotificationSettingsUpdate(BaseModel):
carp_auto_revert_failed_enabled: bool | None = None
scheduled_maintenance_failed_enabled: bool | None = None
backup_failed_enabled: bool | None = None
compliance_alerts_enabled: bool | None = None
gateway_down_enabled: bool | None = None
resource_threshold_enabled: bool | None = None
service_down_enabled: bool | None = None
rollout_problems_enabled: bool | None = None
# 0 switches that single threshold off.
gateway_loss_threshold_pct: int | None = Field(default=None, ge=0, le=100)
gateway_delay_threshold_ms: int | None = Field(default=None, ge=0, le=60000)
disk_threshold_pct: int | None = Field(default=None, ge=0, le=100)
memory_threshold_pct: int | None = Field(default=None, ge=0, le=100)
swap_threshold_pct: int | None = Field(default=None, ge=0, le=100)
load_per_cpu_threshold: float | None = Field(default=None, ge=0, le=1000)
alert_confirm_samples: int | None = Field(default=None, ge=1, le=60)
resource_confirm_samples: int | None = Field(default=None, ge=1, le=60)
service_watchlist: list[str] | None = Field(default=None, max_length=100)
@field_validator("service_watchlist")
@classmethod
def _clean_watchlist(cls, value):
if value is None:
return None
names = []
for raw in value:
name = str(raw).strip()
if not re.fullmatch(r"[A-Za-z0-9._+-]{1,64}", name):
raise ValueError("Dienstnamen bestehen aus Buchstaben, Ziffern und . _ + -")
if name not in names:
names.append(name)
return names
poll_interval_seconds: int | None = Field(
default=None, ge=settings.notification_poll_min_interval_seconds
@@ -103,3 +157,55 @@ class NotificationProblemRead(BaseModel):
class TestNotificationRequest(BaseModel):
channel: Literal["webhook", "email"]
class NotificationChannelRead(BaseModel):
"""Never carries the credential; ``config`` is withheld from non-admins (an ntfy topic is a password)."""
model_config = ConfigDict(from_attributes=True)
id: uuid.UUID
name: str
channel_type: ChannelType
enabled: bool
config: dict
secret_set: bool
created_at: datetime
updated_at: datetime
def _channel_name(value: str | None) -> str | None:
if value is None:
return None
if not value.strip():
raise ValueError("Name darf nicht leer sein")
return value.strip()
class NotificationChannelCreate(BaseModel):
name: str = Field(min_length=1, max_length=100)
channel_type: ChannelType
enabled: bool = True
config: dict = Field(default_factory=dict)
# Token, or for Teams the webhook address. Write-only.
secret: str | None = Field(default=None, max_length=2100)
@field_validator("name")
@classmethod
def _clean_name(cls, value):
return _channel_name(value)
class NotificationChannelUpdate(BaseModel):
"""Partial: omitted fields stay. ``secret`` replaces the credential, ``clear_secret`` removes it."""
name: str | None = Field(default=None, min_length=1, max_length=100)
enabled: bool | None = None
config: dict | None = None
secret: str | None = Field(default=None, max_length=2100)
clear_secret: bool = False
@field_validator("name")
@classmethod
def _clean_name(cls, value):
return _channel_name(value)
+44
View File
@@ -7,9 +7,19 @@ how the proxy setup works for IP *and* name access) nor an explicitly allowed
origin. Requests without either header (curl, scripts) are not browsers, so
they cannot be riding on a victim's cookie and pass through to normal auth.
Sec-Fetch-Site (1.27): a page on another port of the same host (e.g. a
firewall GUI behind the GUI gateway) is *same-site* to OPNexus, so the
browser attaches the session cookie to its requests and SameSite=Lax does
not help. Cookie-carrying /api requests that the browser itself marks as
same-site or cross-site are therefore refused — unless the Origin is an
explicitly configured frontend origin (development setup with the frontend
on its own port). Clients that send no Sec-Fetch-Site header (curl,
scripts, API tokens) are not browsers and stay unaffected.
SecurityHeadersMiddleware: API responses must never be cached by browsers or
proxies and must not be sniffed or framed.
"""
import re
from urllib.parse import urlparse
from starlette.middleware.base import BaseHTTPMiddleware
@@ -18,6 +28,7 @@ from starlette.responses import JSONResponse
from app.config import settings
from app.errors import ErrorCode
from app.routers.auth import has_session_cookie
_SAFE_METHODS = {"GET", "HEAD", "OPTIONS"}
@@ -35,8 +46,41 @@ def _origin_allowed(origin: str, host_header: str) -> bool:
return f"{parsed.scheme}://{parsed.netloc}".lower() in {o.lower() for o in settings.allowed_origins}
# The SSO provider sends the browser back here by a cross-site navigation;
# the endpoint authenticates by its own state cookie and creates the session.
_SEC_FETCH_EXEMPT = {"/api/auth/oidc/callback"}
def _explicit_frontend_origin(origin: str) -> bool:
origin = origin.rstrip("/").lower()
if not origin or origin == "null":
return False
if settings.allowed_origins:
return origin in {o.lower() for o in settings.allowed_origins}
return re.fullmatch(settings.cors_origin_regex, origin) is not None
def sec_fetch_blocked(request: Request) -> bool:
path = request.url.path
if not (path == "/api" or path.startswith("/api/")) or path in _SEC_FETCH_EXEMPT:
return False
if not has_session_cookie(request):
return False
site = request.headers.get("sec-fetch-site", "").strip().lower()
if site == "cross-site":
return True
if site == "same-site":
return not _explicit_frontend_origin(request.headers.get("origin", ""))
return False # same-origin, none (typed URL/bookmark) or no header (not a browser)
class OriginCheckMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
if sec_fetch_blocked(request):
return JSONResponse(
status_code=403,
content={"detail": {"code": ErrorCode.CROSS_SITE_REQUEST_BLOCKED.value, "params": {}}},
)
if request.method not in _SAFE_METHODS:
source = request.headers.get("origin") or request.headers.get("referer")
if source and source != "null" and not _origin_allowed(source, request.headers.get("host", "")):
+27
View File
@@ -0,0 +1,27 @@
"""Small pieces shared by every "take over what was made by hand on a firewall" feature
(rule_adopt_service.py for filter rules, object_adopt_service.py for aliases and NAT)."""
class NotAdoptable(Exception):
"""The object exists on the host but cannot be described without distortion.
`reasons` are machine-readable codes (the UI translates them); `details` maps a code to
extra text the translation can show (e.g. the alias names a reference points to)."""
def __init__(self, reasons: list[str], details: dict[str, str] | None = None):
super().__init__(", ".join(reasons))
self.reasons = reasons
self.details = details or {}
class NotFoundOnHost(Exception):
"""The UUID is not (or no longer) present in the host's live configuration."""
def on(value) -> bool:
"""OPNsense booleans arrive as "1"/"0" strings, sometimes as real booleans."""
return value in ("1", 1, True)
def clean(value) -> str:
return "" if value is None else str(value).strip()
+9 -3
View File
@@ -18,7 +18,7 @@ from app.models.host import OpnsenseHost
from app.models.alias import FirewallAlias
from app.models.alias_deployment import AliasDeployment
from app.services.audit_service import tracked_rollback
from app.services import opnsense_client
from app.services import opnsense_client, variables_service
from app.services.deploy_flow import push_to_host
from app.services.opnsense_client import OpnsenseAmbiguousError, OpnsenseAPIError
@@ -27,7 +27,12 @@ def _now() -> datetime:
return datetime.now(timezone.utc)
def _build_payload(alias: FirewallAlias) -> dict:
def _build_payload(alias: FirewallAlias, host: OpnsenseHost | None = None) -> dict:
payload = _base_payload(alias)
return variables_service.resolve(payload, host) if host is not None else payload
def _base_payload(alias: FirewallAlias) -> dict:
return {
"enabled": "1" if alias.enabled else "0",
"name": alias.name,
@@ -38,7 +43,7 @@ def _build_payload(alias: FirewallAlias) -> dict:
async def _deploy_to_host(db: AsyncSession, alias: FirewallAlias, host: OpnsenseHost) -> AliasDeployment:
payload = _build_payload(alias)
payload = _build_payload(alias, host)
existing = await db.scalar(
select(AliasDeployment).where(AliasDeployment.alias_id == alias.id, AliasDeployment.host_id == host.id)
)
@@ -79,6 +84,7 @@ async def deploy_alias(db: AsyncSession, alias: FirewallAlias, hosts: list[Opnse
from app.services.host_maintenance_service import ensure_no_maintenance
from app.services.policy_hierarchy_deploy_service import reassert_after_managed_change
await ensure_no_maintenance(db, hosts)
variables_service.ensure_resolvable(_build_payload, alias, hosts) # before anything is written
deployments = [await _deploy_to_host(db, alias, host) for host in hosts]
await db.flush()
for host, deployment in zip(hosts, deployments):
+10 -4
View File
@@ -9,6 +9,7 @@ import json
from app.models.policy import AliasRevision
from app.services.alias_deploy_service import _build_payload
from app.services import variables_service
from app.services.policy_service import effective_hosts
ALIAS_FIELDS = ("name", "type", "content", "description", "enabled")
@@ -28,13 +29,17 @@ def revision(db, alias, note):
def preview(alias):
payload = _build_payload(alias)
deployments = {d.host_id: d for d in alias.deployments}
hosts = effective_hosts(alias)
blocked = any(d.status in ("pending", "revert_failed") for d in alias.deployments)
rows = []
for host in hosts:
dep = deployments.get(host.id)
try:
payload = _build_payload(alias, host)
except variables_service.MissingVariables as exc:
rows.append(variables_service.preview_row_missing(host, exc.missing[host.name], dep))
continue
before = dep.last_payload if dep else None
action = "create" if not dep or not dep.opnsense_alias_uuid else "update"
if before == payload and dep and dep.status in ("success", "reverted"):
@@ -61,6 +66,8 @@ def preview(alias):
warnings.append("Offene Bestätigung oder fehlgeschlagener Rollback: Push gesperrt.")
if any(r["action"] == "retained" for r in rows):
warnings.append("Frühere Ziele behalten diesen Alias, bis du sie hier gezielt entfernst. Diese Löschung hat keinen automatischen Rollback.")
if any(r["action"] == "missing_variable" for r in rows):
warnings.append("Für mindestens einen Ziel-Host fehlt der Wert einer Variable ({{NAME}}). Erst auf der Host-Seite unter „Variablen“ eintragen.")
if any(r["action"] == "disabled" for r in rows):
warnings.append("Deaktivierte Hosts werden übersprungen.")
if any(d.status == "error" for d in alias.deployments):
@@ -71,7 +78,7 @@ def preview(alias):
d.host.base_url, d.host.enabled, d.host.verify_tls) for d in alias.deployments], key=lambda row: row[0])}
token = hashlib.sha256(json.dumps(state, sort_keys=True, default=str).encode()).hexdigest()
return {"token": token, "hosts": rows, "warnings": warnings,
"can_deploy": not blocked and any(r["action"] in ("create", "update") for r in rows),
"can_deploy": not blocked and not any(r["action"] == "missing_variable" for r in rows) and any(r["action"] in ("create", "update") for r in rows),
"basis": "Zuletzt von OPNexus gespeicherter Deploy-Stand; kein Live-Abgleich."}
@@ -79,12 +86,11 @@ def workflow(alias, deployments):
hosts = effective_hosts(alias)
active = [h for h in hosts if h.enabled]
by_host = {d.host_id: d for d in deployments}
payload = _build_payload(alias)
target_ids = {h.id for h in hosts}
counts = {
"targets": len(hosts),
"active_targets": len(active),
"changes": sum(1 for h in active if h.id not in by_host or by_host[h.id].last_payload != payload),
"changes": sum(1 for h in active if h.id not in by_host or by_host[h.id].last_payload != variables_service.payload_or_none(_build_payload, alias, h)),
"pending": sum(d.status == "pending" for d in deployments),
"errors": sum(d.status in ("error", "revert_failed") for d in deployments),
"retained": sum(d.host_id not in target_ids for d in deployments),
+29 -5
View File
@@ -38,7 +38,8 @@ MAX_TOKENS_PER_USER = 50
_LAST_USED_GRANULARITY = timedelta(minutes=1)
_SAFE_METHODS = ("GET", "HEAD", "OPTIONS")
_SESSION_ONLY = re.compile(r"^/api/(tokens|auth)(/|$)")
# GUI tickets open a firewall's web interface in the browser: an interactive admin session only.
_SESSION_ONLY = re.compile(r"^/api/(tokens|auth)(/|$)|^/api/hosts/[^/]+/gui-ticket$")
# Reads that expose secrets (config.xml holds password hashes and VPN keys, the
# notification settings the webhook URL/SMTP data): admin scope only.
_ADMIN_SCOPE_READS = re.compile(r"^/api/hosts/[^/]+/backups/[^/]+$|^/api/notifications(/|$)|^/api/settings/|^/api/overlay/peers/[^/]+/instructions$")
@@ -48,6 +49,7 @@ _ADMIN_ONLY_WRITES = re.compile(
r"^/api/(users|settings|system|notifications|overlay)(/|$)"
r"|^/api/logs/settings$"
r"|^/api/hosts(/tls-probe|/[^/]+)?$"
r"|^/api/hosts/[^/]+/gui-ticket$"
)
@@ -82,14 +84,36 @@ def operator_denies(method: str, path: str) -> bool:
# Writes that put a change onto the fleet (as opposed to preparing one): deploy, remove/rollback a deployment,
# maintenance (reboot/update/CARP switch), scheduling it, and applying network changes.
_ROLLOUT = re.compile(
r"/(deploy|deployments/[^/]+/(remove|retry-rollback)|maintenance/(execute|carp-execute|schedule)|network/changes)$"
# maintenance (reboot/update/CARP switch), scheduling it, applying network changes, pushing certificates and
# ACME accounts, re-asserting the hierarchy order, controlling services, and DELETING a centrally managed object
# or snapshot (deleting a rule removes it from every firewall it was deployed to).
_ROLLOUT_POST = re.compile(
r"/(deploy|push|sign|poll|register|reassert-ordering"
r"|deployments/[^/]+/(remove|retry-rollback)"
r"|maintenance/(execute|carp-execute|schedule)"
r"|network/changes"
r"|services/[^/]+/(start|stop|restart)"
# Firmware rollouts (1.25): starting/arming a plan and moving a run forward. Pausing is deliberately absent.
r"|rollouts/plans/[^/]+/(start|activate)"
r"|rollouts/runs/[^/]+/(resume|approve|skip-host|abort))$"
)
_ROLLOUT_DELETE = re.compile(
r"^/api/(rules|aliases|port-forward|one-to-one|outbound-nat|policy-hierarchy/rules|ipsec/tunnels|openvpn/instances"
r"|wireguard/tunnels|certificates/managed|acme/accounts|acme/certificates)/[^/]+$"
r"|^/api/hosts/[^/]+/(snapshots|maintenance/schedule)/[^/]+$"
)
# Recurring maintenance windows decide WHEN unattended firmware actions run (1.25): every write counts.
_ROLLOUT_ANY_WRITE = re.compile(r"^/api/maintenance-windows(/|$)")
def is_rollout(method: str, path: str) -> bool:
return method == "POST" and bool(_ROLLOUT.search(path))
if method in ("POST", "PUT", "PATCH", "DELETE") and _ROLLOUT_ANY_WRITE.match(path):
return True
if method == "POST":
return bool(_ROLLOUT_POST.search(path))
return method == "DELETE" and bool(_ROLLOUT_DELETE.match(path))
def bearer_from_header(header: str) -> str | None:
+4 -1
View File
@@ -88,7 +88,10 @@ def deployment_history(session, flush_context, instances):
if entity is not None and action == "deploy":
from importlib import import_module
builder = import_module(f"app.services.{kind}_deploy_service")._build_payload
details["requested_payload"] = builder(entity)
try:
details["requested_payload"] = builder(entity, host) if host is not None else builder(entity)
except Exception: # a missing variable must not break the audit write; record the unresolved intent instead
details["requested_payload"] = builder(entity)
session.add(make_event(kind=kind, action=action, status="removed" if deleted else dep.status,
entity_id=str(entity_id), entity_name=(getattr(entity, "name", None) or getattr(entity, "description", None)),
host_id=str(dep.host_id), host_name=host.name if host else None,
+2 -1
View File
@@ -236,6 +236,7 @@ async def create_session(
user_agent: str | None = None,
ip_address: str | None = None,
verified_hash: str | None = None,
lifetime_seconds: int | None = None,
) -> tuple[str, datetime]:
"""Create a session, returning the raw token (to be set as a cookie) and its expiry.
@@ -253,7 +254,7 @@ async def create_session(
await db.rollback()
raise api_error(401, ErrorCode.UNGUELTIGER_BENUTZERNAME_ODER_PASSWORT)
token = secrets.token_urlsafe(SESSION_TOKEN_BYTES)
expires_at = _now() + timedelta(seconds=settings.session_lifetime)
expires_at = _now() + timedelta(seconds=lifetime_seconds or settings.session_lifetime)
session = Session(
user_id=user_id,
token_hash=_hash_token(token),
+11 -6
View File
@@ -7,6 +7,8 @@ but its value never leaves the server. Output is a unified diff, capped in size.
"""
import difflib
import hashlib
import hmac
import os
import re
from xml.etree.ElementTree import Element, indent, tostring
@@ -14,7 +16,7 @@ import defusedxml.ElementTree as safe_ET
MAX_LINES = 3000
MAX_BYTES = 32 * 1024 * 1024
_SECRET = re.compile(r"password|passwd|psk|secret|key|passphrase|token|prv|hash|community|bindpw|privpass", re.I)
_SECRET = re.compile(r"pass|pwd|psk|secret|key|token|prv|hash|community|bindpw|privpass|otp|seed|cred", re.I)
_HARMLESS_SUFFIX = re.compile(r"(len|length|type|size|bits|file|name)$", re.I)
_BLOB = 120
@@ -23,15 +25,17 @@ class InvalidConfig(ValueError):
pass
def _redact(root: Element) -> None:
def _redact(root: Element, salt: bytes) -> None:
for el in root.iter():
if len(el) == 0 and el.text and el.text.strip():
text = el.text.strip()
if (_SECRET.search(el.tag) and not _HARMLESS_SUFFIX.search(el.tag)) or len(text) > _BLOB:
el.text = "‹sha256:" + hashlib.sha256(text.encode()).hexdigest()[:12] + "›"
# Salted per diff: both sides of one diff share the salt (so a change shows), but the value cannot be
# looked up in a dictionary or compared across hosts/requests.
el.text = "‹" + hmac.new(salt, text.encode(), hashlib.sha256).hexdigest()[:12] + "›"
def normalise(xml_bytes: bytes) -> list[str]:
def normalise(xml_bytes: bytes, salt: bytes) -> list[str]:
if not xml_bytes.strip() or len(xml_bytes) > MAX_BYTES:
raise InvalidConfig("leer oder zu groß")
try:
@@ -42,13 +46,14 @@ def normalise(xml_bytes: bytes) -> list[str]:
raise InvalidConfig("keine OPNsense-Konfiguration")
for volatile in root.findall("revision"):
root.remove(volatile)
_redact(root)
_redact(root, salt)
indent(root, space=" ")
return tostring(root, encoding="unicode").splitlines()
def diff(old: bytes, new: bytes) -> dict:
a, b = normalise(old), normalise(new)
salt = os.urandom(16)
a, b = normalise(old, salt), normalise(new, salt)
lines = list(difflib.unified_diff(a, b, "älter", "neuer", lineterm="", n=2))
added = sum(1 for l in lines if l.startswith("+") and not l.startswith("+++"))
removed = sum(1 for l in lines if l.startswith("-") and not l.startswith("---"))
+17 -4
View File
@@ -12,6 +12,7 @@ in ``filter/rule`` (legacy). Both are normalised to the same shape below.
decided. The score starts at 100 and loses a penalty per failed check, so one
critical finding (an any-any pass rule on the WAN) already turns the host red.
"""
import asyncio
import re
from datetime import datetime, timezone
from xml.etree.ElementTree import Element
@@ -31,6 +32,15 @@ BACKUP_MAX_AGE_DAYS = 7
PENALTY = {"critical": 30, "high": 15, "medium": 8, "low": 3, "info": 0}
SEVERITY_ORDER = ("critical", "high", "medium", "low", "info")
MAX_EXAMPLES = 5
# German titles for notifications (the UI translates the check ids itself).
TITLES_DE = {
"webgui_https": "Web-Oberfläche nur über HTTPS", "ssh_hardened": "SSH abgesichert", "snmp_community": "SNMP-Community nicht „public“",
"wan_any_any": "Keine Allow-all-Regel am WAN", "internal_any_any": "Keine Allow-all-Regel mit beliebiger Quelle (intern)",
"rules_shadowed": "Keine verdeckten Regeln", "rules_duplicate": "Keine doppelten Regeln", "rules_documented": "Regeln sind beschriftet",
"rules_unused": "Regeln in Benutzung", "ntp_configured": "Zeitserver gesetzt", "remote_logging": "Logs liegen auch woanders",
"ids_enabled": "Einbruchserkennung aktiv", "firmware_current": "Firmware aktuell", "backup_recent": "Aktuelles Backup",
}
SEVERITIES_DE = {"critical": "kritisch", "high": "hoch", "medium": "mittel", "low": "niedrig", "info": "Hinweis"}
def grade(score: int) -> str:
@@ -267,15 +277,18 @@ async def check_host(db: AsyncSession, host: OpnsenseHost) -> ComplianceResult:
await rule_hit_service.sample_host(db, host)
except OpnsenseAPIError:
pass # usage data is a bonus; the check does not depend on it
findings = evaluate(xml, firmware_status=firmware_status, newest_backup_age_s=age,
unused_rules=await rule_hit_service.unused_summary(db, host.id))
# Untrusted XML, O(n^2) rule analysis: keep it off the event loop, and treat ANY parse failure as 'invalid'.
findings = await asyncio.to_thread(
evaluate, xml, firmware_status=firmware_status, newest_backup_age_s=age,
unused_rules=await rule_hit_service.unused_summary(db, host.id),
)
row.findings, row.score, row.error = findings, score(findings), None
except OpnsenseAPIError as exc:
row.findings, row.score, row.error = [], None, "unreachable"
row.error_detail = str(exc)[:300]
except ValueError as exc:
except Exception as exc: # ParseError is a SyntaxError, not a ValueError; one bad config must not stop the other hosts
row.findings, row.score, row.error = [], None, "invalid_config"
row.error_detail = str(exc)[:300]
row.error_detail = f"{type(exc).__name__}: {exc}"[:300]
await db.commit()
return row
@@ -0,0 +1,97 @@
"""Gateway health of a firewall (dpinger numbers, as OPNsense reports them).
``get_gateway_health(host)`` is the one reusable entry point: a live read of
/routes/gateway/status, one :class:`GatewayHealth` per gateway. The notification
engine, the host page and the metrics read the SAME numbers from the periodic
resource sample (``compact`` / ``from_compact``), so a scrape or a page view never
fans out to the firewalls; the 1.25 health gate can call ``get_gateway_health``
directly. Parsing is lenient on purpose: "~" means "nothing measured", never zero.
"""
import re
from app.models.host import OpnsenseHost
from app.schemas.gateway import GatewayHealth, GatewayState
from app.services import opnsense_client as client
_NUMBER = re.compile(r"-?\d+(?:\.\d+)?")
_DEGRADED = {"delay", "loss", "delay+loss"}
def _number(value) -> float | None:
if value is None:
return None
match = _NUMBER.search(str(value))
return float(match.group()) if match else None
def _state(status: str, measured: bool) -> GatewayState:
if status == "down":
return "offline"
if status == "force_down":
return "forced_down"
if status in _DEGRADED:
return "degraded"
if status == "none":
# "none" is also what a gateway without monitoring reports; only numbers make it "online".
return "online" if measured else "unknown"
return "unknown"
def parse_gateway_status(payload) -> list[GatewayHealth]:
items = payload.get("items") if isinstance(payload, dict) else None
result: list[GatewayHealth] = []
for item in items or []:
if not isinstance(item, dict) or not item.get("name"):
continue
status = str(item.get("status") or "").lower()
loss, delay, stddev = _number(item.get("loss")), _number(item.get("delay")), _number(item.get("stddev"))
if loss is not None and loss >= 100:
delay = stddev = None # dpinger prints 0.0 ms when nothing answers: no round trip, not a fast one
measured = loss is not None or delay is not None
address = item.get("address")
monitor = item.get("monitor")
result.append(GatewayHealth(
name=str(item["name"]),
address=None if address in (None, "", "~") else str(address),
status=status or "unknown",
state=_state(status, measured),
loss=loss, delay=delay, stddev=stddev,
monitor=None if monitor in (None, "", "~") else str(monitor),
))
return result
async def get_gateway_health(host: OpnsenseHost) -> list[GatewayHealth]:
"""Live gateway state of ``host``. Raises OpnsenseAPIError if the firewall cannot be asked."""
return parse_gateway_status(await client.get_gateway_status(host))
def compact(gateways: list[GatewayHealth]) -> list[dict]:
"""What the resource sampler stores per sample (small, no addresses)."""
return [
{"name": g.name, "status": g.status, "state": g.state, "loss": g.loss, "delay": g.delay, "stddev": g.stddev}
for g in gateways
]
def from_compact(rows) -> list[GatewayHealth]:
return [
GatewayHealth(
name=r["name"], status=r.get("status") or "unknown", state=r.get("state") or "unknown",
loss=r.get("loss"), delay=r.get("delay"), stddev=r.get("stddev"),
)
for r in rows or [] if isinstance(r, dict) and r.get("name")
]
def is_bad(gateway: GatewayHealth, loss_threshold_pct: float = 0, delay_threshold_ms: float = 0) -> bool:
"""Alarm-worthy: down, or (when the thresholds are on) measured loss / latency beyond them.
A gateway forced down by the admin and one that is not measured are not alarms."""
if gateway.state == "offline":
return True
if loss_threshold_pct and gateway.loss is not None and gateway.loss >= loss_threshold_pct:
return True
if delay_threshold_ms and gateway.delay is not None and gateway.delay >= delay_threshold_ms:
return True
return False
+320
View File
@@ -0,0 +1,320 @@
"""Tickets and gateway sessions for the firewall GUI access (1.27, gui-gateway container).
Flow (see docs in routers/gui_access.py):
* An admin asks for a ticket (POST /api/hosts/{id}/gui-ticket). 32 random bytes, valid 30 s, single use;
only its SHA-256 is stored, bound to the OPNexus session (same hash as sessions.token_hash), the user,
the host and a slot (gateway port = its own browser origin).
* The gateway redeems it through /internal/gui/redeem and gets what it needs to reach the firewall —
base URL, pinned CA, overlay proxy, timeouts. Never the API key or secret.
* Every 20 s the gateway re-checks the gateway session (/internal/gui/revalidate): OPNexus session still
valid, user still admin, switch still on, host still eligible, absolute limit not reached.
A slot stays assigned to one firewall for as long as that browser session has the firewall open; another
firewall gets another slot (another origin), so two firewall GUIs never share an origin at the same time.
"""
import hashlib
import secrets
import uuid
from dataclasses import dataclass
from datetime import datetime, timedelta, timezone
from urllib.parse import urlsplit
from sqlalchemy import delete, func, select, update
from sqlalchemy.ext.asyncio import AsyncSession
from app.config import settings
from app.errors import ErrorCode
from app.models.gui_access import GuiAccessSettings, GuiSession, GuiTicket
from app.models.host import OpnsenseHost
from app.models.user import AdminUser, Session
from app.services import audit_service, firewall_url, overlay_service
TICKET_TTL = timedelta(seconds=30)
# 20 s: a switch-off, logout or role change must end a gateway session within 30 s of the change, and
# the last re-check can lie up to one interval before it (live test 2026-10-21: 30 s gave 31 s).
REVALIDATE_SECONDS = 20
MAX_SLOTS = 4
MIN_GATEWAY_TOKEN_LENGTH = 32
AUDIT_KIND = "gui_access"
@dataclass
class GuiAccessError(Exception):
status: int
code: ErrorCode
params: dict
def hash_value(raw: str) -> str:
return hashlib.sha256(raw.encode()).hexdigest()
def _now() -> datetime:
return datetime.now(timezone.utc)
# ── configuration ─────────────────────────────────────────────────────────
def slot_sites() -> dict[int, list[str]]:
"""Slot port -> configured https origins with that port (OPNEXUS_GUI_SITES)."""
sites: dict[int, list[str]] = {}
for origin in settings.gui_site_origins:
try:
parts = urlsplit(origin)
port = parts.port
except ValueError:
continue
if parts.scheme != "https" or not parts.hostname or not port or parts.path not in ("", "/"):
continue
sites.setdefault(port, []).append(f"https://{parts.netloc}")
return sites
def gateway_configured() -> bool:
return len(settings.gui_gateway_token) >= MIN_GATEWAY_TOKEN_LENGTH and bool(slot_sites())
def unavailable_reasons() -> list[str]:
reasons = []
if not settings.cookie_secure:
reasons.append("cookie_secure")
if len(settings.gui_gateway_token) < MIN_GATEWAY_TOKEN_LENGTH:
reasons.append("gateway_token")
if not slot_sites():
reasons.append("gui_sites")
return reasons
def active_slots(row: GuiAccessSettings) -> list[int]:
return sorted(slot_sites())[: max(1, min(row.slot_count, MAX_SLOTS))]
async def get_settings(db: AsyncSession) -> GuiAccessSettings:
row = await db.get(GuiAccessSettings, 1)
if row is None:
row = GuiAccessSettings(id=1, enabled=False, idle_timeout_minutes=15, absolute_timeout_minutes=60, slot_count=MAX_SLOTS)
db.add(row)
await db.flush()
return row
def host_refusal(host: OpnsenseHost) -> str | None:
"""Why this firewall must not be opened through the gateway (None = eligible)."""
if not host.enabled:
return "disabled"
if urlsplit(host.base_url.strip()).scheme != "https" or firewall_url.check_base_url(host.base_url):
return "https"
if not host.verify_tls:
return "tls"
return None
def firewall_origin(base_url: str) -> str:
parts = urlsplit(base_url.strip())
return f"https://{parts.netloc.rsplit('@', 1)[-1]}"
# ── audit ─────────────────────────────────────────────────────────────────
async def _audit(actor: str, *, action: str, status: str, host: OpnsenseHost | None = None,
host_id=None, entity_id=None, message: str | None = None, details: dict | None = None) -> None:
token = audit_service.context.set({"actor": actor, "id": str(uuid.uuid4()), "action": action})
try:
await audit_service.persist(
kind=AUDIT_KIND, action=action, status=status, entity_id=str(entity_id) if entity_id else None,
host_id=str(host.id) if host is not None else (str(host_id) if host_id else None),
host_name=host.name if host is not None else None, message=message, details=details or {},
)
finally:
audit_service.context.reset(token)
# ── tickets ───────────────────────────────────────────────────────────────
def _redeem_origin(slot: int, request_host: str) -> str:
candidates = slot_sites().get(slot, [])
wanted = (urlsplit(f"//{request_host}").hostname or "").lower()
for origin in candidates:
if (urlsplit(origin).hostname or "").lower() == wanted:
return origin
return candidates[0]
async def _pick_slot(db: AsyncSession, row: GuiAccessSettings, session_hash: str, user_id, host_id) -> int:
now = _now()
slots = active_slots(row)
absolute = timedelta(minutes=row.absolute_timeout_minutes)
in_use: dict[int, uuid.UUID] = {}
open_sessions = await db.scalars(select(GuiSession).where(
GuiSession.session_hash == session_hash, GuiSession.ended_at.is_(None), GuiSession.started_at > now - absolute))
for gs in open_sessions:
in_use[gs.slot] = gs.host_id
pending = await db.scalars(select(GuiTicket).where(
GuiTicket.session_hash == session_hash, GuiTicket.redeemed_at.is_(None), GuiTicket.expires_at > now))
for ticket in pending:
in_use.setdefault(ticket.slot, ticket.host_id)
for slot in slots:
if in_use.get(slot) == host_id:
return slot # this firewall is already open in this browser session: same origin again
free = [s for s in slots if s not in in_use]
if not free:
raise GuiAccessError(409, ErrorCode.GUI_NO_FREE_SLOT, {"slots": str(len(slots))})
# Prefer the slot this user had this firewall on before, then the slot the user used least recently
# (an old tab of another firewall on a reused origin is the documented residual risk).
history = (await db.execute(
select(GuiSession.slot, GuiSession.host_id, func.max(GuiSession.started_at))
.where(GuiSession.user_id == user_id).group_by(GuiSession.slot, GuiSession.host_id)
)).all()
for slot, h_id, _ in sorted(history, key=lambda r: r[2], reverse=True):
if h_id == host_id and slot in free:
return slot
last_used = {}
for slot, _, started in history:
last_used[slot] = max(last_used.get(slot, started), started)
epoch = datetime.min.replace(tzinfo=timezone.utc)
return min(free, key=lambda s: (last_used.get(s, epoch), s))
async def issue_ticket(db: AsyncSession, *, user: AdminUser, session_token: str, host: OpnsenseHost,
request_host: str) -> dict:
row = await get_settings(db)
now = _now()
await db.execute(delete(GuiTicket).where(GuiTicket.expires_at < now - timedelta(hours=1)))
session_hash = hash_value(session_token)
slot = await _pick_slot(db, row, session_hash, user.id, host.id)
raw = secrets.token_urlsafe(32)
db.add(GuiTicket(ticket_hash=hash_value(raw), session_hash=session_hash, user_id=user.id, host_id=host.id,
slot=slot, created_at=now, expires_at=now + TICKET_TTL))
await db.commit()
await _audit(user.username, action="ticket", status="accepted", host=host, details={"slot": slot})
return {"url": f"{_redeem_origin(slot, request_host)}/__onx/redeem?t={raw}", "slot": slot,
"expires_in": int(TICKET_TTL.total_seconds())}
# ── gateway side (internal endpoints) ─────────────────────────────────────
async def _live_check(db: AsyncSession, row: GuiAccessSettings, session_hash: str, user_id, host_id,
slot: int) -> tuple[str | None, AdminUser | None, OpnsenseHost | None]:
session = await db.scalar(select(Session).where(Session.token_hash == session_hash))
if session is None or session.expires_at <= _now() or session.user_id != user_id:
return "session", None, None
user = await db.get(AdminUser, user_id)
if user is None or user.role != "admin":
return "role", user, None
if not row.enabled:
return "disabled", user, None
if not settings.cookie_secure or not gateway_configured():
return "config", user, None
host = await db.get(OpnsenseHost, host_id)
if host is None or host_refusal(host):
return "host", user, host
if slot not in active_slots(row):
return "slot", user, host
return None, user, host
def _timing(row: GuiAccessSettings, started_at: datetime) -> dict:
deadline = started_at + timedelta(minutes=row.absolute_timeout_minutes)
return {"idle_timeout_seconds": row.idle_timeout_minutes * 60,
"absolute_deadline": int(deadline.timestamp()),
"revalidate_seconds": REVALIDATE_SECONDS}
async def redeem(db: AsyncSession, *, ticket_hash: str, session_hash: str, slot: int, client_ip: str | None) -> dict:
"""{'ok': True, ...upstream data...} or {'ok': False, 'reason': ...}. Any attempt burns the ticket."""
now = _now()
ticket = await db.scalar(select(GuiTicket).where(GuiTicket.ticket_hash == ticket_hash).with_for_update())
if ticket is None:
await db.rollback()
return {"ok": False, "reason": "unknown"}
replayed = ticket.redeemed_at is not None
ticket.redeemed_at = ticket.redeemed_at or now
row = await get_settings(db)
reason = None
if replayed:
reason = "replayed"
elif ticket.expires_at <= now:
reason = "expired"
elif not secrets.compare_digest(ticket.session_hash, session_hash):
reason = "session"
elif ticket.slot != slot:
reason = "slot"
user = host = None
if reason is None:
reason, user, host = await _live_check(db, row, ticket.session_hash, ticket.user_id, ticket.host_id, slot)
if user is None:
user = await db.get(AdminUser, ticket.user_id)
if host is None:
host = await db.get(OpnsenseHost, ticket.host_id)
actor = user.username if user is not None else "unknown"
if reason is not None:
await db.commit()
await _audit(actor, action="redeem", status="denied", host=host, host_id=ticket.host_id,
message=reason, details={"slot": slot, "client_ip": client_ip, "reason": reason})
return {"ok": False, "reason": reason}
# The same browser session reopening this slot replaces the earlier gateway session there.
superseded = (await db.scalars(select(GuiSession).where(
GuiSession.session_hash == session_hash, GuiSession.slot == slot, GuiSession.ended_at.is_(None)))).all()
for old in superseded:
old.ended_at, old.end_reason = now, "superseded"
gs = GuiSession(session_hash=session_hash, user_id=user.id, host_id=host.id, slot=slot,
client_ip=(client_ip or None) and client_ip[:45], started_at=now, last_checked_at=now)
db.add(gs)
await db.commit()
await _audit(actor, action="redeem", status="accepted", host=host, entity_id=gs.id,
details={"slot": slot, "client_ip": client_ip})
return {
"ok": True, "gui_session_id": str(gs.id), "host_id": str(host.id), "host_name": host.name,
"upstream_origin": firewall_origin(host.base_url),
"ca_pem": host.tls_ca_pem or None, # public certificate (pin); None = system trust store
"proxy_url": overlay_service.proxy_for(host.base_url),
**_timing(row, now),
}
async def _finish(db: AsyncSession, gs: GuiSession, reason: str) -> None:
now = _now()
if gs.ended_at is None:
gs.ended_at, gs.end_reason = now, reason[:32]
await db.commit()
user = await db.get(AdminUser, gs.user_id)
host = await db.get(OpnsenseHost, gs.host_id)
await _audit(user.username if user else "unknown", action="end", status="accepted", host=host,
host_id=gs.host_id, entity_id=gs.id, message=reason,
details={"slot": gs.slot, "client_ip": gs.client_ip, "reason": reason,
"duration_seconds": int((gs.ended_at - gs.started_at).total_seconds())})
async def revalidate(db: AsyncSession, *, gui_session_id: uuid.UUID, session_hash: str) -> dict:
gs = await db.get(GuiSession, gui_session_id)
if gs is None or not secrets.compare_digest(gs.session_hash, session_hash):
return {"ok": False, "reason": "unknown"}
if gs.ended_at is not None:
return {"ok": False, "reason": gs.end_reason or "ended"}
row = await get_settings(db)
if _now() >= gs.started_at + timedelta(minutes=row.absolute_timeout_minutes):
await _finish(db, gs, "absolute")
return {"ok": False, "reason": "absolute"}
reason, _, _ = await _live_check(db, row, gs.session_hash, gs.user_id, gs.host_id, gs.slot)
if reason is not None:
await _finish(db, gs, reason)
return {"ok": False, "reason": reason}
gs.last_checked_at = _now()
await db.commit()
return {"ok": True, **_timing(row, gs.started_at)}
async def end(db: AsyncSession, *, gui_session_id: uuid.UUID, session_hash: str, reason: str) -> bool:
gs = await db.get(GuiSession, gui_session_id)
if gs is None or not secrets.compare_digest(gs.session_hash, session_hash):
return False
if gs.ended_at is None:
await _finish(db, gs, reason)
return True
async def end_all(db: AsyncSession, reason: str) -> int:
"""Switch turned off: mark every open gateway session ended (the gateway drops them on its next check)."""
result = await db.execute(update(GuiSession).where(GuiSession.ended_at.is_(None))
.values(ended_at=_now(), end_reason=reason[:32]))
return result.rowcount or 0
@@ -32,6 +32,14 @@ def _extract_carp_status(data: dict | None) -> str | None:
return None
def _vip_states(data: dict | None) -> dict[str, str]:
"""Per-VHID CARP state ("MASTER", "BACKUP", "DISABLED", "INIT", ...). The host-level carp_status above
collapses these, so one VHID that is down on a node is invisible there."""
rows = data.get("rows") if isinstance(data, dict) else None
return {str(row.get("vhid")): str(row.get("status", "")).upper()
for row in rows or [] if isinstance(row, dict) and row.get("vhid") not in (None, "")}
async def _status_for(host: OpnsenseHost) -> dict:
if not host.enabled:
return {"status": "disabled", "carp_status": None, "status_detail": None}
@@ -43,6 +51,7 @@ async def _status_for(host: OpnsenseHost) -> dict:
return {
"status": "online",
"carp_status": _extract_carp_status(data),
"carp_vips": _vip_states(data),
"carp_maintenance_mode": _truthy(carp.get("maintenancemode"), default=False),
"carp_allowed": _truthy(carp.get("allow"), default=True),
"carp_demotion": carp.get("demotion"),
+27 -3
View File
@@ -5,7 +5,7 @@ fan out live calls to every firewall (an offline host would stall it past the
scraper's timeout and a 15 s scrape interval would hammer the fleet). The
inputs are what OPNexus' own pollers already store:
* host reachability and resources — the 60 s resource sampler (a host that
* host reachability, resources, gateway health and service state — the 60 s resource sampler (a host that
produced no sample for ``STALE_AFTER`` is reported down),
* CARP role — the latest observed transition (carp_events),
* open problems — the notification engine's problem table,
@@ -19,11 +19,11 @@ from sqlalchemy.ext.asyncio import AsyncSession
from app.models.carp_event import CarpEvent
from app.models.compliance_result import ComplianceResult
from app.models.host import OpnsenseHost
from app.models.notification import NotificationProblem
from app.models.notification import DEFAULT_SERVICE_WATCHLIST, NotificationProblem
from app.models.resource_sample import HostResourceSample
from app.models.scheduled_maintenance import ScheduledMaintenance
from app.routers.dashboard import collect_pending_actions
from app.services import compliance_service
from app.services import compliance_service, gateway_health_service, notification_settings_service
from app.version import APP_VERSION
CONTENT_TYPE = "text/plain; version=0.0.4; charset=utf-8"
@@ -99,6 +99,14 @@ async def render(db: AsyncSession) -> str:
out.family("opnexus_host_memory_used_percent", "Memory in use, percent (last sample).")
out.family("opnexus_host_load1", "1-minute load average (last sample).")
out.family("opnexus_host_disk_used_percent", "Fullest disk, percent (last sample).")
out.family("opnexus_host_swap_used_percent", "Swap in use, percent (last sample; absent without swap).")
out.family("opnexus_host_gateway_up", "1 if the gateway is not down (online, degraded or not monitored), 0 if OPNsense reports it down.")
out.family("opnexus_host_gateway_loss_percent", "Packet loss to the gateway monitor address, percent (last sample).")
out.family("opnexus_host_gateway_delay_seconds", "Round-trip time to the gateway monitor address (last sample).")
out.family("opnexus_host_gateway_stddev_seconds", "Round-trip time deviation to the gateway monitor address (last sample).")
out.family("opnexus_host_service_running", "1 if a watched service (Settings > Notifications) runs, 0 if it is stopped (last sample).")
configured = (await notification_settings_service.get_settings(db)).service_watchlist
watchlist = set(DEFAULT_SERVICE_WATCHLIST if configured is None else configured)
out.family("opnexus_host_carp_master", "1 if the host's last observed CARP role is MASTER, 0 if BACKUP; absent if unknown.")
for host in hosts:
labels = {"host": host.name, "cluster": host.cluster_name or ""}
@@ -115,6 +123,22 @@ async def render(db: AsyncSession) -> str:
):
if value is not None:
out.sample(name, value, **labels)
if sample is not None:
raw = sample.raw or {}
if raw.get("swap_used_pct") is not None:
out.sample("opnexus_host_swap_used_percent", raw["swap_used_pct"], **labels)
for gw in gateway_health_service.from_compact(raw.get("gateways")):
gw_labels = {**labels, "gateway": gw.name}
out.sample("opnexus_host_gateway_up", 0 if gw.state == "offline" else 1, **gw_labels)
for name, value, factor in (
("opnexus_host_gateway_loss_percent", gw.loss, 1), ("opnexus_host_gateway_delay_seconds", gw.delay, 0.001),
("opnexus_host_gateway_stddev_seconds", gw.stddev, 0.001),
):
if value is not None:
out.sample(name, round(value * factor, 6), **gw_labels)
for key, running in sorted((raw.get("services") or {}).items()):
if key.split("/")[0] in watchlist:
out.sample("opnexus_host_service_running", running, **labels, service=key.split("/")[0], instance=key.split("/", 1)[1] if "/" in key else None)
if carp_state.get(host.id) in ("MASTER", "BACKUP"):
out.sample("opnexus_host_carp_master", 1 if carp_state[host.id] == "MASTER" else 0, **labels)
+234
View File
@@ -0,0 +1,234 @@
"""Monitoring alerts (1.24): gateway down, resource thresholds, stopped services.
Same contract as notification_checks.py (each check returns {dedup_key: context} of what is
bad right now), with one addition: they never judge a single reading. The inputs are the
60-second samples the resource sampler stores (resource_monitor_service, HostResourceSample),
and a problem needs the last N samples to agree before it opens AND before it closes again:
* all N bad -> problem,
* all N good -> no problem,
* anything in between -> keep the current state (open stays open, closed stays closed).
So a single spike never alerts, a flapping link does not open and close the alert every few
minutes, and a sample that could not be read ("unknown") neither raises nor clears anything.
A host without a fresh sample is not judged at all (check_host_offline reports it); its open
problems are kept.
"""
from datetime import datetime, timedelta, timezone
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.host import OpnsenseHost
from app.models.notification import DEFAULT_SERVICE_WATCHLIST, NotificationProblem
from app.models.resource_sample import HostResourceSample
from app.services import gateway_health_service, notification_settings_service
from app.services.notification_dedup import Problems
# The sampler runs every 60 s; three missed rounds mean the host is not reachable (same limit as metrics_service).
STALE_AFTER = timedelta(seconds=180)
# How far back a service must have been seen running before its absence is reported (samples, ~2 h at 60 s).
SERVICE_EVIDENCE_SAMPLES = 120
_DISK_TYPES = {"ufs", "zfs"}
def verdict(flags: list[bool | None], confirm: int, is_open: bool) -> bool:
"""flags: newest first; True = bad, False = good, None = unknown."""
window = flags[:confirm]
if len(window) >= confirm:
if all(f is True for f in window):
return True
if all(f is False for f in window):
return False
return is_open
async def _enabled_hosts(db: AsyncSession) -> list[OpnsenseHost]:
return list((await db.scalars(select(OpnsenseHost).where(OpnsenseHost.enabled.is_(True)))).all())
async def _open_keys(db: AsyncSession, problem_type: str) -> set[str]:
rows = await db.scalars(
select(NotificationProblem.dedup_key).where(
NotificationProblem.problem_type == problem_type, NotificationProblem.status == "open"
)
)
return set(rows.all())
async def _recent(db: AsyncSession, host_id, limit: int, *raw_keys: str) -> list[dict]:
"""The newest ``limit`` samples of a host, newest first, with just the JSON keys asked for."""
columns = [HostResourceSample.sampled_at, HostResourceSample.mem_used_pct, HostResourceSample.load_avg_1m]
columns += [HostResourceSample.raw[key].as_json() for key in raw_keys]
rows = (
await db.execute(
select(*columns).where(HostResourceSample.host_id == host_id).order_by(HostResourceSample.sampled_at.desc()).limit(limit)
)
).all()
return [
{"sampled_at": r[0], "mem_used_pct": r[1], "load_avg_1m": r[2], **{k: r[3 + i] for i, k in enumerate(raw_keys)}}
for r in rows
]
def _fresh(samples: list[dict]) -> bool:
return bool(samples) and datetime.now(timezone.utc) - samples[0]["sampled_at"] <= STALE_AFTER
def _keys_of_host(open_keys: set[str], host: OpnsenseHost) -> set[str]:
prefix = f"{host.id}:"
return {k[len(prefix):] for k in open_keys if k.startswith(prefix)}
# ── Gateways ────────────────────────────────────────────────────────────────
def _gateway_reason(g) -> str:
if g.state == "offline":
return "Gateway offline"
parts = []
if g.loss is not None:
parts.append(f"Paketverlust {g.loss:g} %")
if g.delay is not None:
parts.append(f"Latenz {g.delay:g} ms")
return ", ".join(parts) or g.status
async def check_gateway_down(db: AsyncSession) -> dict[str, dict]:
cfg = await notification_settings_service.get_settings(db)
confirm = max(1, cfg.alert_confirm_samples)
loss_limit, delay_limit = cfg.gateway_loss_threshold_pct, cfg.gateway_delay_threshold_ms
open_keys = await _open_keys(db, "gateway_down")
problems = Problems()
for host in await _enabled_hosts(db):
samples = await _recent(db, host.id, confirm, "gateways")
if not _fresh(samples):
problems.preserve_prefixes.add(f"{host.id}:")
continue
parsed = [
None if s["gateways"] is None else {g.name: g for g in gateway_health_service.from_compact(s["gateways"])}
for s in samples
]
names = {name for p in parsed if p for name in p} | _keys_of_host(open_keys, host)
for name in sorted(names):
flags: list[bool | None] = []
for p in parsed:
if p is None:
flags.append(None)
else:
g = p.get(name) # a gateway that no longer exists is "fine": its problem resolves
flags.append(False if g is None else gateway_health_service.is_bad(g, loss_limit, delay_limit))
key = f"{host.id}:{name}"
if not verdict(flags, confirm, key in open_keys):
continue
latest = next((p[name] for p in parsed if p and name in p), None)
problems[key] = {
"host_id": str(host.id), "host_name": host.name, "gateway": name,
"grund": _gateway_reason(latest) if latest else "keine aktuellen Messwerte",
"status": latest.status if latest else None,
"paketverlust_prozent": latest.loss if latest else None,
"latenz_ms": latest.delay if latest else None,
}
return problems
# ── Resources ───────────────────────────────────────────────────────────────
def disk_groups(devices) -> dict[str, tuple[str, float]]:
"""{group: (label, used %)} — one entry per ZFS pool / UFS device, the fullest dataset of a pool wins."""
groups: dict[str, tuple[str, float]] = {}
for dev in devices or []:
if not isinstance(dev, dict) or dev.get("type") not in _DISK_TYPES:
continue
try:
pct = float(dev["used_pct"])
except (KeyError, TypeError, ValueError):
continue
device = str(dev.get("device") or dev.get("mountpoint") or "?")
group = device.split("/")[0] if dev["type"] == "zfs" else device
label = group if dev["type"] == "zfs" else str(dev.get("mountpoint") or device)
if group not in groups or pct > groups[group][1]:
groups[group] = (label, pct)
return groups
async def check_resource_threshold(db: AsyncSession) -> dict[str, dict]:
cfg = await notification_settings_service.get_settings(db)
confirm = max(1, cfg.resource_confirm_samples)
open_keys = await _open_keys(db, "resource_threshold")
problems = Problems()
def over(value, limit) -> bool | None:
if not limit or value is None:
return None if value is None else False
return value >= limit
for host in await _enabled_hosts(db):
samples = await _recent(db, host.id, confirm, "disk", "swap_used_pct", "cpu_threads")
if not _fresh(samples):
problems.preserve_prefixes.add(f"{host.id}:")
continue
base = {"host_id": str(host.id), "host_name": host.name}
was_open = _keys_of_host(open_keys, host)
# Disk: one problem per pool/device.
disk = [None if s["disk"] is None else disk_groups(s["disk"]) for s in samples]
group_names = {g for d in disk if d for g in d} | {k[5:] for k in was_open if k.startswith("disk:")}
for group in sorted(group_names):
flags = [None if d is None else (over(d[group][1], cfg.disk_threshold_pct) if group in d else False) for d in disk]
if verdict(flags, confirm, f"disk:{group}" in was_open):
label, pct = next((d[group] for d in disk if d and group in d), (group, None))
problems[f"{host.id}:disk:{group}"] = {
**base, "ressource": f"Festplatte {label}", "wert_prozent": pct, "schwelle_prozent": cfg.disk_threshold_pct,
}
def simple(key: str, label: str, flags: list, value, threshold, unit: str) -> None:
if verdict(flags, confirm, key in was_open):
problems[f"{host.id}:{key}"] = {**base, "ressource": label, "wert": f"{value}{unit}", "schwelle": f"{threshold}{unit}"}
latest = samples[0]
simple("memory", "Arbeitsspeicher", [over(s["mem_used_pct"], cfg.memory_threshold_pct) for s in samples],
latest["mem_used_pct"], cfg.memory_threshold_pct, " %")
simple("swap", "Swap", [over(s["swap_used_pct"], cfg.swap_threshold_pct) for s in samples],
latest["swap_used_pct"], cfg.swap_threshold_pct, " %")
def per_cpu(s):
if s["load_avg_1m"] is None or not s["cpu_threads"]:
return None # thread count unknown (older firmware): the load cannot be judged
return s["load_avg_1m"] / s["cpu_threads"]
simple("cpu", "CPU-Last (pro Thread)", [over(per_cpu(s), cfg.load_per_cpu_threshold) for s in samples],
None if per_cpu(latest) is None else round(per_cpu(latest), 2), cfg.load_per_cpu_threshold, "")
return problems
# ── Services ────────────────────────────────────────────────────────────────
async def check_service_down(db: AsyncSession) -> dict[str, dict]:
cfg = await notification_settings_service.get_settings(db)
confirm = max(1, cfg.alert_confirm_samples)
watch = set(cfg.service_watchlist if cfg.service_watchlist is not None else DEFAULT_SERVICE_WATCHLIST)
open_keys = await _open_keys(db, "service_down")
problems = Problems()
for host in await _enabled_hosts(db):
samples = await _recent(db, host.id, confirm + SERVICE_EVIDENCE_SAMPLES, "services")
if not _fresh(samples):
problems.preserve_prefixes.add(f"{host.id}:")
continue
listings = [s["services"] for s in samples]
was_open = _keys_of_host(open_keys, host)
candidates = {k for k in (listings[0] or {}) if k.split("/")[0] in watch} | was_open
for svc in sorted(candidates):
if svc.split("/")[0] not in watch:
continue # taken off the watchlist: the problem resolves
flags = [None if sv is None else (sv[svc] == 0 if svc in sv else False) for sv in listings]
bad = verdict(flags, confirm, svc in was_open)
# Only a service that was seen running before counts: one that never ran (enabled but idle,
# e.g. DHCPv6 without a prefix) or was stopped on purpose long ago is not a failure.
if bad and svc not in was_open and not any(sv and sv.get(svc) == 1 for sv in listings[confirm:]):
bad = False
if bad:
problems[f"{host.id}:{svc}"] = {
"host_id": str(host.id), "host_name": host.name, "dienst": svc.split("/")[0],
"hinweis": "Dienst läuft nicht mehr; absichtlich gestoppt? Dann aus der Überwachungsliste nehmen.",
}
return problems
+35 -1
View File
@@ -22,6 +22,7 @@ taken before the change is the way back.
Secrets (the CARP password) are never returned, hashed into the token only, and
never written to the audit log.
"""
import asyncio
import hashlib
import ipaddress
import json
@@ -362,6 +363,20 @@ async def _verify(host: OpnsenseHost, kind: str, action: str, uuid: str | None,
return False, ["unreadable"]
async def _carp_vip_active(host: OpnsenseHost, vhid: str, attempts: int = 5) -> bool:
"""True once the firewall reports the VHID as MASTER or BACKUP, i.e. the VIP really is on the interface and
taking part in CARP (not DISABLED/INIT). The config can look right while the live VIP is gone."""
for attempt in range(attempts):
if attempt:
await asyncio.sleep(2)
data = await opnsense_client.get_vip_status(host)
rows = data.get("rows") if isinstance(data, dict) else None
states = {str(r.get("vhid")): str(r.get("status", "")).upper() for r in rows or [] if isinstance(r, dict)}
if states.get(vhid) in ("MASTER", "BACKUP"):
return True
return False
async def execute(db: AsyncSession, host: OpnsenseHost, kind: str, action: str, uuid: str | None, fields: dict,
token: str, acknowledged: bool) -> dict:
await ensure_no_maintenance(db, [host])
@@ -384,6 +399,12 @@ async def execute(db: AsyncSession, host: OpnsenseHost, kind: str, action: str,
# VipSettingsController::getVipOverlay blanks address and prefix whenever "network" is missing from
# the request, so every VIP update must repeat it (found live: a partial set was rejected / could wipe it).
send.setdefault("network", plan["_before"]["network"])
# VipSettingsController::setItemAction queues "delete the old address" whenever the posted interface differs
# from the stored one, and a partial update that leaves "interface" out counts as different. The following
# reconfigure then removes the live VIP and, working from a stale address list, never puts it back (found
# live 2026-10-20: CARP VIP stuck on DISABLED after a description edit). So repeat the interface as well.
if plan["_before"].get("interface"):
send.setdefault("interface", plan["_before"]["interface"])
# What the object must look like afterwards: for an edit that is everything it had, plus the change.
expected = {**plan["_before"], **send} if action == "set" else dict(send)
entity = fields.get("name") or fields.get("descr") or plan["_before"].get("name") or plan["_before"].get("descr") or kind
@@ -407,14 +428,27 @@ async def execute(db: AsyncSession, host: OpnsenseHost, kind: str, action: str,
await audit_service.persist(**audit, status="rejected", message=str(exc)[:500], details=details)
raise api_error(502, ErrorCode.UPSTREAM_REJECTED, reason=str(exc)[:300]) from exc
new_uuid = uuid or (result.get("uuid") if isinstance(result, dict) else None)
# A description is not wired into anything, so there is nothing to re-apply for it.
cosmetic = kind == "vip" and action == "set" and {c["field"] for c in plan["changes"]} <= {"descr"}
carp_live = kind == "vip" and action != "del" and expected.get("mode") == "carp" and not cosmetic
try:
await opnsense_client.reconfigure_network(host, kind)
if not cosmetic:
await opnsense_client.reconfigure_network(host, kind)
live_ok = True
if carp_live:
live_ok = await _carp_vip_active(host, str(expected.get("vhid")))
if not live_ok: # one more apply usually brings it back up
await opnsense_client.reconfigure_network(host, kind)
live_ok = await _carp_vip_active(host, str(expected.get("vhid")))
except OpnsenseAPIError as exc:
# Written but not (provably) applied: say so instead of reporting success.
await audit_service.persist(**audit, status="apply_uncertain", message=str(exc)[:500], details=details)
raise api_error(502, ErrorCode.NETWORK_APPLY_UNCERTAIN, host=host.name, backup_id=backup_id) from exc
verified, mismatches = await _verify(host, kind, action, new_uuid, expected)
if not live_ok:
verified = False
mismatches = [*mismatches, "carp_vip_inactive"]
await audit_service.persist(**audit, status="applied" if verified else "unverified",
message=None if verified else ", ".join(mismatches)[:500], details=details)
return {"status": "applied", "uuid": new_uuid, "verified": verified, "mismatches": mismatches, "backup_id": backup_id}
@@ -0,0 +1,250 @@
"""Extra notification channels: ntfy, Gotify, Telegram, Microsoft Teams, Matrix.
They sit beside SMTP and the generic webhook (notification_delivery.py) and reuse its message
text. Each channel is a row in ``notification_channels`` (see models/notification.py); the
credential never touches the database: it is stored through notification_secret_store as
``channel_<id>`` (mode 0600 file) and read only at send time. Where the credential is part of the
URL (a Telegram bot token, the whole Teams webhook URL) the URL is built per request, and the
HTTP request log is muted while it is in flight (``url_guard.muted``), so neither the logs nor an
error message ever contain it.
API formats, checked against the vendors' documentation:
* ntfy — JSON publish: POST <server>/ with {"topic", "title", "message", "priority", "tags"}
(docs.ntfy.sh/publish, "Publish as JSON"); optional ``Authorization: Bearer <token>``.
* Gotify — POST <server>/message, header ``X-Gotify-Key: <app token>`` (keeps the token out of
the URL), JSON {"title", "message", "priority"} (gotify.net/docs/pushmsg).
* Telegram — POST <api>/bot<token>/sendMessage, JSON {"chat_id", "text"}; text limit 4096
characters; answers {"ok": true, ...} (core.telegram.org/bots/api#sendmessage).
* Teams — POST to the (Workflows / incoming) webhook URL with a message envelope carrying an
Adaptive Card (learn.microsoft.com ... add-incoming-webhook); the URL is the secret.
* Matrix — PUT <homeserver>/_matrix/client/v3/rooms/<roomId>/send/m.room.message/<txnId> with
``Authorization: Bearer <access token>``, JSON {"msgtype": "m.text", "body"}; a fresh
transaction id per message (Matrix client-server API, "Sending events to a room").
"""
import re
import uuid
from urllib.parse import quote
import httpx
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.config import settings
from app.models.notification import CHANNEL_TYPES, NotificationChannel, NotificationProblem
from app.services import notification_delivery, notification_secret_store, url_guard
from app.services.notification_delivery import NotificationDeliveryError
TELEGRAM_LIMIT = 4096
TEAMS_LIMIT = 20000
_NTFY_TOPIC = re.compile(r"^[A-Za-z0-9_-]{1,64}$")
_MATRIX_ROOM = re.compile(r"^![^\s:]+:[^\s/]+$")
# type -> (required config keys, secret required?)
_SPEC = {
"ntfy": ({"topic"}, False),
"gotify": ({"server_url"}, True),
"telegram": ({"chat_id"}, True),
"teams": (set(), True),
"matrix": ({"homeserver_url", "room_id"}, True),
}
assert set(_SPEC) == set(CHANNEL_TYPES)
def secret_name(channel_id) -> str:
return f"channel_{channel_id}"
def clean_config(channel_type: str, config: dict) -> dict:
"""Validates and normalises the non-secret settings of a channel. Raises ValueError (German reason)."""
if channel_type not in _SPEC:
raise ValueError("Unbekannter Kanaltyp")
config = dict(config or {})
out: dict = {}
def url(key: str, default: str | None = None) -> str | None:
raw = str(config.get(key) or "").strip() or default
if raw is None:
return None
return url_guard.validate_url(raw).rstrip("/")
def integer(key: str, low: int, high: int, default: int) -> int:
value = config.get(key)
if value in (None, ""):
return default
try:
number = int(value)
except (TypeError, ValueError):
raise ValueError(f"{key}: ganze Zahl erwartet") from None
if not low <= number <= high:
raise ValueError(f"{key}: Wert zwischen {low} und {high} erwartet")
return number
if channel_type == "ntfy":
out["server_url"] = url("server_url", "https://ntfy.sh")
topic = str(config.get("topic") or "").strip()
if not _NTFY_TOPIC.match(topic):
raise ValueError("Thema: 1–64 Zeichen aus Buchstaben, Ziffern, _ und -")
out["topic"] = topic
out["priority"] = integer("priority", 1, 5, 4)
elif channel_type == "gotify":
out["server_url"] = url("server_url")
if not out["server_url"]:
raise ValueError("Serveradresse fehlt")
out["priority"] = integer("priority", 0, 10, 5)
elif channel_type == "telegram":
chat_id = str(config.get("chat_id") or "").strip()
if not re.match(r"^(-?\d{1,20}|@[A-Za-z0-9_]{4,64})$", chat_id):
raise ValueError("Chat-ID: Zahl (z. B. -1001234567890) oder @Kanalname")
out["chat_id"] = chat_id
out["api_base"] = url("api_base", "https://api.telegram.org")
elif channel_type == "matrix":
out["homeserver_url"] = url("homeserver_url")
if not out["homeserver_url"]:
raise ValueError("Homeserver-Adresse fehlt")
room = str(config.get("room_id") or "").strip()
if not _MATRIX_ROOM.match(room):
raise ValueError("Raum-ID: Form !abc123:example.org (nicht der Alias #raum:…)")
out["room_id"] = room
return out
def clean_secret(channel_type: str, secret: str) -> str:
value = (secret or "").strip()
if not value:
raise ValueError("Zugangsdaten fehlen")
if channel_type == "teams":
value = url_guard.validate_url(value, max_length=2000)
if not value.startswith("https://"):
raise ValueError("Die Teams-Webhook-Adresse muss mit https:// beginnen")
elif any(c.isspace() for c in value) or len(value) > 500:
raise ValueError("Token: keine Leerzeichen, höchstens 500 Zeichen")
return value
def missing_requirements(channel: NotificationChannel) -> str | None:
required, needs_secret = _SPEC[channel.channel_type]
if any(not channel.config.get(k) for k in required):
return "Konfiguration unvollständig"
if needs_secret and not channel.secret_set:
return "Zugangsdaten fehlen"
return None
# ── Message formatting (one function per channel, pure — unit-testable) ───────────
def _parts(problem: NotificationProblem, transition: str) -> tuple[str, str]:
"""(title, details) — the title repeated at the top of render_message's body is dropped."""
subject, body = notification_delivery.render_message(problem, transition)
details = body.split("\n", 2)[2] if body.count("\n") >= 2 else ""
return subject, details.strip()
def _clip(text: str, limit: int) -> str:
return text if len(text) <= limit else text[: limit - 1] + "…"
def format_ntfy(config: dict, problem, transition: str) -> dict:
title, details = _parts(problem, transition)
resolved = transition == "resolved"
return {
"topic": config["topic"], "title": title, "message": details or title,
"priority": 3 if resolved else int(config.get("priority", 4)),
"tags": ["white_check_mark"] if resolved else ["warning"],
}
def format_gotify(config: dict, problem, transition: str) -> dict:
title, details = _parts(problem, transition)
return {"title": title, "message": details or title, "priority": 1 if transition == "resolved" else int(config.get("priority", 5))}
def format_telegram(config: dict, problem, transition: str) -> dict:
title, details = _parts(problem, transition)
return {
"chat_id": config["chat_id"], "text": _clip(f"{title}\n\n{details}".strip(), TELEGRAM_LIMIT),
"disable_web_page_preview": True,
}
def format_teams(config: dict, problem, transition: str) -> dict:
title, details = _parts(problem, transition)
body: list[dict] = [{"type": "TextBlock", "text": title, "weight": "Bolder", "size": "Medium", "wrap": True}]
if details:
body.append({"type": "TextBlock", "text": _clip(details, TEAMS_LIMIT), "wrap": True})
return {
"type": "message",
"attachments": [{
"contentType": "application/vnd.microsoft.card.adaptive", "contentUrl": None,
"content": {
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
"type": "AdaptiveCard", "version": "1.4", "body": body,
},
}],
}
def format_matrix(config: dict, problem, transition: str) -> dict:
title, details = _parts(problem, transition)
return {"msgtype": "m.text", "body": f"{title}\n\n{details}".strip()}
# ── Sending ───────────────────────────────────────────────────────────────────────
def _request_for(channel: NotificationChannel, secret: str, problem, transition: str) -> tuple[str, str, dict, dict, str | None]:
"""(method, url, headers, json body, expected "ok" check key)."""
cfg, kind = channel.config, channel.channel_type
if kind == "ntfy":
headers = {"Authorization": f"Bearer {secret}"} if secret else {}
return "POST", cfg["server_url"].rstrip("/") + "/", headers, format_ntfy(cfg, problem, transition), None
if kind == "gotify":
return "POST", cfg["server_url"].rstrip("/") + "/message", {"X-Gotify-Key": secret}, format_gotify(cfg, problem, transition), None
if kind == "telegram":
return "POST", f"{cfg['api_base'].rstrip('/')}/bot{secret}/sendMessage", {}, format_telegram(cfg, problem, transition), "ok"
if kind == "teams":
return "POST", secret, {}, format_teams(cfg, problem, transition), None
room = quote(cfg["room_id"], safe="")
url = f"{cfg['homeserver_url'].rstrip('/')}/_matrix/client/v3/rooms/{room}/send/m.room.message/{uuid.uuid4().hex}"
return "PUT", url, {"Authorization": f"Bearer {secret}"}, format_matrix(cfg, problem, transition), None
async def send(channel: NotificationChannel, problem: NotificationProblem, transition: str) -> None:
problem_missing = missing_requirements(channel)
if problem_missing:
raise NotificationDeliveryError(f"Kanal „{channel.name}“: {problem_missing}")
secret = notification_secret_store.read_secret(secret_name(channel.id)) or ""
if channel.secret_set and not secret:
raise NotificationDeliveryError(f"Kanal „{channel.name}“: Zugangsdaten nicht lesbar – bitte neu setzen")
method, url, headers, payload, ok_key = _request_for(channel, secret, problem, transition)
label = f"Kanal „{channel.name}“ ({channel.channel_type})"
with url_guard.muted():
try:
url_guard.validate_url(url, max_length=2100)
await url_guard.ensure_resolved_safe(url)
except ValueError as exc:
raise NotificationDeliveryError(f"{label}: {exc}") from None
try:
async with httpx.AsyncClient(timeout=settings.opnsense_timeout, follow_redirects=False) as client:
resp = await client.request(method, url, json=payload, headers=headers)
resp.raise_for_status()
if ok_key and not (resp.json() or {}).get(ok_key):
raise NotificationDeliveryError(f"{label}: Zustellung abgelehnt")
except httpx.HTTPError as exc:
# str(exc) names the full URL, which for Telegram/Teams is the credential itself.
reason = f"HTTP {exc.response.status_code}" if isinstance(exc, httpx.HTTPStatusError) else type(exc).__name__
raise NotificationDeliveryError(f"{label}: Zustellung fehlgeschlagen ({reason})") from None
except ValueError:
raise NotificationDeliveryError(f"{label}: Antwort nicht lesbar") from None
async def send_test(channel: NotificationChannel) -> None:
fake = NotificationProblem(
problem_type="test", dedup_key="test",
context={"message": "Dies ist eine Testbenachrichtigung von OPNexus."},
)
await send(channel, fake, "opened")
async def enabled_channels(db: AsyncSession) -> list[NotificationChannel]:
rows = await db.scalars(select(NotificationChannel).where(NotificationChannel.enabled.is_(True)).order_by(NotificationChannel.name))
return list(rows.all())
@@ -10,6 +10,7 @@ from sqlalchemy.ext.asyncio import AsyncSession
from app.models.alias_deployment import AliasDeployment
from app.models.backup_settings import BackupSettings
from app.models.compliance_result import ComplianceResult
from app.models.host import OpnsenseHost
from app.models.host_operation import HostOperation
from app.models.one_to_one_deployment import OneToOneDeployment
@@ -235,6 +236,28 @@ async def check_carp_health(db: AsyncSession) -> dict[str, dict]:
"condition": "no_master",
"host_names": sorted(h.name for h in online),
}
problems.update(_carp_vip_problems(cluster_name, online, statuses, split_brain=len(masters) == 2))
return problems
def _carp_vip_problems(cluster_name: str, online: list[OpnsenseHost], statuses: dict, split_brain: bool) -> dict[str, dict]:
"""Per-VHID checks. The host-level role is "MASTER" as soon as one VIP is, so a VIP that is down on a
node (a node without the VIP never advertises it, the peer takes it over) looks healthy in the totals."""
problems: dict[str, dict] = {}
for host in online:
vips = statuses.get(host.id, {}).get("carp_vips") or {}
down = sorted(v for v, state in vips.items() if state not in ("MASTER", "BACKUP"))
if down:
problems[f"{cluster_name}:vip_down:{host.name}"] = {
"cluster_name": cluster_name, "condition": "vip_down", "host_names": [host.name], "vhids": down,
}
# One node MASTER on some VHIDs and BACKUP on others: a partial failover. Already covered by the
# split-brain alert when both nodes hold a MASTER.
if not split_brain and {"MASTER", "BACKUP"} <= set(vips.values()):
problems[f"{cluster_name}:role_mismatch:{host.name}"] = {
"cluster_name": cluster_name, "condition": "role_mismatch", "host_names": [host.name],
"vhids": sorted(v for v, state in vips.items() if state == "MASTER"),
}
return problems
@@ -319,3 +342,70 @@ async def check_backup_offsite(db: AsyncSession) -> dict[str, dict]:
if cfg is None or not cfg.offsite_enabled or not cfg.last_offsite_error:
return {}
return {"offsite": {"message": cfg.last_offsite_error}}
async def check_compliance(db: AsyncSession) -> dict[str, dict]:
"""Critical and high findings of the last security check, one problem per (host, check); resolved when it passes."""
from app.services import compliance_service as cs
hosts = {h.id: h for h in await _enabled_hosts(db)}
problems: dict[str, dict] = {}
for row in (await db.scalars(select(ComplianceResult))).all():
host = hosts.get(row.host_id)
if host is None or row.error:
continue
for finding in row.findings:
if finding["passed"] is False and finding["severity"] in ("critical", "high"):
params = finding.get("params") or {}
problems[f"{host.id}:{finding['id']}"] = {
"host_id": str(host.id), "host_name": host.name, "check": finding["id"],
"befund": cs.TITLES_DE.get(finding["id"], finding["id"]),
"schweregrad": cs.SEVERITIES_DE[finding["severity"]],
"beispiele": ", ".join(params.get("examples", [])) or None,
}
return problems
# ── Rollouts (1.25) ─────────────────────────────────────────────────────────
def _short(detail) -> str | None:
if not detail:
return None
parts = []
for key, value in detail.items():
if isinstance(value, list):
value = ", ".join(str(v) for v in value[:8])
parts.append(f"{key}: {value}")
return "; ".join(parts)[:500]
async def check_rollout_paused(db: AsyncSession) -> dict[str, dict]:
"""Open while a rollout run stands still waiting for a human (gate, failed host, window gone...)."""
from app.models.rollout import RolloutRun
problems: dict[str, dict] = {}
for run in (await db.scalars(select(RolloutRun).where(RolloutRun.status == "paused"))).all():
wave = next((w.label for w in run.waves if w.index == run.current_wave), None)
problems[str(run.id)] = {
"run_id": str(run.id), "plan": run.plan_name, "grund": run.pause_reason, "welle": wave,
"zielversion": run.target_version, "details": _short(run.pause_detail),
}
return problems
ROLLOUT_START_FAILURE_WINDOW = timedelta(days=3)
async def check_rollout_start_failed(db: AsyncSession) -> dict[str, dict]:
"""An automatic start at a window occurrence did not happen (event: closed without a 'resolved' notice)."""
from app.models.rollout import RolloutPlan
since = datetime.now(timezone.utc) - ROLLOUT_START_FAILURE_WINDOW
problems: dict[str, dict] = {}
for plan in (await db.scalars(select(RolloutPlan).where(RolloutPlan.auto_start_error.is_not(None)))).all():
error = plan.auto_start_error or {}
at = datetime.fromisoformat(error["at"]) if error.get("at") else None
if at is None or at < since:
continue
problems[f"{plan.id}:{error.get('occurrence')}"] = {
"plan_id": str(plan.id), "plan": plan.name, "grund": error.get("code"), "termin": error.get("occurrence"),
"details": _short(error.get("params")),
}
return problems
+18 -4
View File
@@ -16,7 +16,7 @@ import httpx
from app.config import settings
from app.models.notification import NotificationProblem, NotificationSettings
from app.services import notification_secret_store
from app.services import notification_secret_store, url_guard
class NotificationDeliveryError(Exception):
@@ -36,6 +36,13 @@ _LABELS = {
"scheduled_maintenance_failed": "Geplante Wartung nicht ausgeführt",
"backup_stale": "Kein aktuelles Backup",
"backup_offsite_failed": "Offsite-Backup fehlgeschlagen",
"compliance_finding": "Sicherheitsbefund",
"gateway_down": "Gateway gestört",
"resource_threshold": "Ressourcen-Schwelle überschritten",
"service_down": "Dienst ausgefallen",
"rollout_paused": "Rollout angehalten",
"rollout_start_failed": "Rollout nicht automatisch gestartet",
"test": "Testbenachrichtigung",
}
@@ -83,9 +90,16 @@ async def send_webhook(settings_row: NotificationSettings, problem: Notification
headers["X-OPNexus-Signature"] = f"sha256={signature}"
try:
async with httpx.AsyncClient(timeout=settings.opnsense_timeout) as client:
resp = await client.post(settings_row.webhook_url, content=raw, headers=headers)
resp.raise_for_status()
url_guard.validate_url(settings_row.webhook_url)
await url_guard.ensure_resolved_safe(settings_row.webhook_url)
except ValueError as exc:
raise NotificationDeliveryError(f"Webhook-Adresse nicht erlaubt: {exc}") from None
try:
# follow_redirects stays off: a redirect must not move the request to an address the check above never saw.
async with httpx.AsyncClient(timeout=settings.opnsense_timeout, follow_redirects=False) as client:
with url_guard.muted():
resp = await client.post(settings_row.webhook_url, content=raw, headers=headers)
resp.raise_for_status()
except httpx.HTTPError as exc:
# str(exc) names the full URL, which often is the credential itself
# (token in path/query) — keep it out of messages and logs.
+22 -6
View File
@@ -8,8 +8,8 @@ from datetime import datetime, timezone
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.notification import NotificationProblem, NotificationSettings
from app.services import notification_checks, notification_dedup, notification_delivery
from app.models.notification import NotificationChannel, NotificationProblem, NotificationSettings
from app.services import monitor_checks, notification_channels, notification_checks, notification_dedup, notification_delivery
from app.services import notification_settings_service
logger = logging.getLogger(__name__)
@@ -33,14 +33,22 @@ _CHECKS = [
("scheduled_maintenance_failed", "scheduled_maintenance_failed_enabled", notification_checks.check_scheduled_maintenance_failed),
("backup_stale", "backup_failed_enabled", notification_checks.check_backup_stale),
("backup_offsite_failed", "backup_failed_enabled", notification_checks.check_backup_offsite),
("compliance_finding", "compliance_alerts_enabled", notification_checks.check_compliance),
("gateway_down", "gateway_down_enabled", monitor_checks.check_gateway_down),
("resource_threshold", "resource_threshold_enabled", monitor_checks.check_resource_threshold),
("service_down", "service_down_enabled", monitor_checks.check_service_down),
("rollout_paused", "rollout_problems_enabled", notification_checks.check_rollout_paused),
("rollout_start_failed", "rollout_problems_enabled", notification_checks.check_rollout_start_failed),
]
# Event-like problems: when they drop out of the window nothing was "fixed", so no
# "behoben" message goes out for them.
_NO_RESOLVED_NOTICE = {"scheduled_maintenance_failed"}
_NO_RESOLVED_NOTICE = {"scheduled_maintenance_failed", "rollout_start_failed"}
async def _deliver(settings_row: NotificationSettings, problem: NotificationProblem, transition: str) -> None:
async def _deliver(
settings_row: NotificationSettings, problem: NotificationProblem, transition: str, channels: list[NotificationChannel] = (),
) -> None:
"""Best-effort, not an audit trail: attempted once per transition and
never retried, even on failure — avoids retry-storming a broken webhook
URL or SMTP relay every poll cycle."""
@@ -59,6 +67,13 @@ async def _deliver(settings_row: NotificationSettings, problem: NotificationProb
except notification_delivery.NotificationDeliveryError:
logger.exception("Email delivery failed for %s/%s", problem.problem_type, problem.dedup_key)
for channel in channels:
try:
await notification_channels.send(channel, problem, transition)
except notification_delivery.NotificationDeliveryError:
# The error text names the channel and the HTTP status, never the URL or token.
logger.exception("Channel %s (%s) delivery failed for %s/%s", channel.name, channel.channel_type, problem.problem_type, problem.dedup_key)
if transition == "resolved":
problem.resolved_notified_at = _now()
else:
@@ -68,6 +83,7 @@ async def _deliver(settings_row: NotificationSettings, problem: NotificationProb
async def run_notification_checks(db: AsyncSession) -> dict:
settings_row = await notification_settings_service.get_settings(db)
result = {"opened": 0, "resolved": 0}
channels = await notification_channels.enabled_channels(db)
for problem_type, enabled_flag, check_fn in _CHECKS:
if not getattr(settings_row, enabled_flag):
@@ -84,9 +100,9 @@ async def run_notification_checks(db: AsyncSession) -> dict:
opened, resolved = await notification_dedup.diff_and_update(db, problem_type, current)
for problem in opened:
await _deliver(settings_row, problem, "opened")
await _deliver(settings_row, problem, "opened", channels)
for problem in resolved:
await _deliver(settings_row, problem, "resolved")
await _deliver(settings_row, problem, "resolved", channels)
result["opened"] += len(opened)
result["resolved"] += len(resolved)
@@ -25,7 +25,11 @@ async def update_settings(db: AsyncSession, payload: NotificationSettingsUpdate)
"smtp_from_address", "smtp_to_addresses",
"host_offline_enabled", "cert_expiring_enabled", "rule_drift_enabled",
"revert_failed_enabled", "maintenance_unknown_enabled", "carp_health_enabled", "nat_drift_enabled",
"network_drift_enabled", "carp_auto_revert_failed_enabled", "scheduled_maintenance_failed_enabled", "backup_failed_enabled",
"network_drift_enabled", "carp_auto_revert_failed_enabled", "scheduled_maintenance_failed_enabled", "backup_failed_enabled", "compliance_alerts_enabled",
"gateway_down_enabled", "resource_threshold_enabled", "service_down_enabled", "rollout_problems_enabled",
"gateway_loss_threshold_pct", "gateway_delay_threshold_ms", "disk_threshold_pct", "memory_threshold_pct",
"swap_threshold_pct", "load_per_cpu_threshold", "alert_confirm_samples", "resource_confirm_samples",
"service_watchlist",
"poll_interval_seconds",
]
for field in simple_fields:
@@ -0,0 +1,545 @@
"""Takes over aliases, port forwards, 1:1 NAT and outbound NAT rules that were created by hand on a
firewall, so they can be edited, versioned and deployed from OPNexus like any other object. This is
the generalisation of rule_adopt_service.py (filter rules keep their own module: their model has
more special cases and the code is relied upon).
Adoption itself writes NOTHING to the firewall. It records the object as it is right now (read fresh
from the host at adoption time, never from what the browser sent) together with its OPNsense UUID
(`remote_uuid` = the deployment's opnsense_*_uuid), and stores the payload OPNexus would send for it as
the deployment's last_payload. So the preview directly afterwards says "unchanged", a later deploy
updates the same object via setItem/setRule (no duplicate), and the normal preview → push →
confirm/auto-revert flow applies from the first change on.
Only objects OPNexus can describe without distortion are adopted. Anything the model cannot express
is refused with machine-readable reasons (the UI translates them) instead of being imported in a way
that would silently change its meaning on the next edit. Fields OPNexus does not manage (log flag of a
port forward, pool options, tags, categories, ...) are never sent, and OPNsense's set*/setItem only
overwrites the posted fields (ApiMutableModelControllerBase::setBase -> setNodes), so they stay as
they are; the candidate list shows them as `kept`.
Evidence (OPNsense core master, src/opnsense/mvc/app/…, read 2026-10-20, and live against OPNsense
26.7 on test-fw-3 on the same day with hand-made objects of every case below):
* Aliases — controllers/OPNsense/Firewall/Api/AliasController.php::searchItemAction -> searchBase
("aliases.alias"), model models/OPNsense/Firewall/Alias.xml. Row keys used: uuid, name, type
("host", "network", "port", "networkgroup", "mac", "asn", plus the unsupported "url", "urltable",
"urljson", "geoip", "dynipv6host", "authgroup", and the system types "internal"/"external"),
enabled "1"/"0", content (entries separated by "\n", live-verified; for "authgroup" the controller
rewrites it to group names), description, proto (only meaningful for asn/geoip). The built-in rows
are bogons, bogonsv6, sshlockout, virusprot (type external) and one __<if>_network per interface
(type internal); they are OPNsense's own and never adoptable. A "networkgroup" lists alias NAMES;
host/network/port aliases may also contain alias names (nesting).
* Port forward — controllers/OPNsense/Firewall/Api/DNatController.php::searchRuleAction merges the
configured rules (getFlatNodes: dotted keys "source.network", "source.port", "source.not",
"destination.network", "destination.port", "destination.not", plus descr, disabled, interface,
ipprotocol, protocol, target, local-port, natreflection, nordr, pass, log, poolopts, tag, tagged,
nosync, categories, sequence) with synthetic automatic rows (uuid "automatic_*"/"lockout_*",
is_automatic true) that setRule/delRule cannot target. models/OPNsense/Firewall/DNat.xml: interface is
Multiple=Y (comma separated), ipprotocol may be blank/inet/inet6/inet46, protocol blank = any,
`nordr` ("no redirect") requires an empty target/local-port (live: "Target must be empty when No
RDR is set"), `pass` ("" manual / "pass" / "rule") links an associated filter rule, natreflection is
""/purenat/disable. OPNexus sends pass "" and not "0", so a rule using one of those would change
meaning on its first edit and is refused.
* 1:1 NAT — OneToOneController::searchRuleAction (flat keys), model Filter.xml onetoone.rule:
enabled, log, interface, type (binat/nat), source_net/source_not, destination_net/destination_not,
external, natreflection ""/enable/disable, description. All of these are managed by OPNexus.
* Outbound NAT — SourceNatController::searchRuleAction returns the configured rules ONLY when the
global mode (filter.settings.nat.snat_mode) is hybrid or advanced; in automatic/disabled mode the
manual rules do not show up at all, so adopting is refused up front (outbound_nat_mode.py) instead
of presenting an empty list. Model Filter.xml snatrules.rule: `nonat` rules ("do not NAT") are not
expressible and refused; staticnatport, poolopts, log, tag, tagged, nosync, endpoint-independent
are left alone.
"""
import re
from dataclasses import dataclass, field
from typing import Any, Awaitable, Callable, get_args
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.errors import ErrorCode, api_error
from app.models.alias import FirewallAlias
from app.models.alias_deployment import AliasDeployment
from app.models.host import OpnsenseHost
from app.models.one_to_one import OneToOneRule
from app.models.one_to_one_deployment import OneToOneDeployment
from app.models.outbound_nat import OutboundNatRule
from app.models.outbound_nat_deployment import OutboundNatDeployment
from app.models.port_forward import PortForwardRule
from app.models.port_forward_deployment import PortForwardDeployment
from app.schemas.alias import AliasType
from app.services import alias_deploy_service, alias_policy_service
from app.services import one_to_one_deploy_service, one_to_one_policy_service
from app.services import opnsense_client, outbound_nat_deploy_service, outbound_nat_policy_service
from app.services import port_forward_deploy_service, port_forward_policy_service
from app.services.adopt_common import NotAdoptable, NotFoundOnHost, clean, on
from app.services.nat_live_service import split_rows
from app.services.outbound_nat_mode import host_mode
ADOPT_NOTE = "Von Firewall übernommen"
ADOPT_MESSAGE = "Von der Firewall übernommen"
ALIAS_NAME = re.compile(r"^[A-Za-z0-9_]+$") # schemas/alias.py AliasCreate.name
ALIAS_TYPES = frozenset(get_args(AliasType))
ALIAS_CONTENT_MAX = 8000 # schemas/alias.py AliasCreate.content
# OPNsense's own aliases that are not user objects (Firewall/Alias.php: bogons & co. are `external`
# rows created by the system, __<if>_network are `internal`).
SYSTEM_ALIAS_NAMES = frozenset({"bogons", "bogonsv6", "sshlockout", "virusprot"})
@dataclass
class Entry:
row: dict
reasons: list[str] = field(default_factory=list)
details: dict[str, str] = field(default_factory=dict)
bulk: bool = False # not adoptable alone yet, but adoptable in the same run (its references come first)
@property
def uuid(self) -> str:
return clean(self.row.get("uuid"))
@dataclass(frozen=True)
class Kind:
key: str
model: type
deployment: type
fk: str # deployment column pointing at the central object
uuid_attr: str # deployment column holding the OPNsense UUID (= remote_uuid)
fetch: Callable[[OpnsenseHost], Awaitable[list[dict]]]
check: Callable[[dict, dict], tuple[list[str], dict[str, str]]]
title: Callable[[dict], str]
info: Callable[[dict], dict[str, str]]
build: Callable[[dict], dict]
payload: Callable[[Any], dict]
revision: Callable
kept: Callable[[dict], list[str]] = lambda row: []
context: Callable[[AsyncSession, list[dict]], Awaitable[dict]] | None = None
refs: Callable[[dict], set[str]] | None = None
name: Callable[[dict], str] | None = None
# ── shared helpers ───────────────────────────────────────────────────────
def _single_interface(row: dict) -> bool:
interface = clean(row.get("interface"))
return bool(interface) and "," not in interface
def _too_long(kind_model: type, values: dict) -> list[str]:
"""Columns are bounded; a live value that does not fit would fail (or be cut) on the first edit."""
columns = kind_model.__table__.columns
return [name for name, value in values.items()
if name in columns and getattr(columns[name].type, "length", None)
and isinstance(value, str) and len(value) > columns[name].type.length]
def _port(value) -> str | None:
return clean(value) or None
def _kept(row: dict, keys: tuple[str, ...]) -> list[str]:
return [key for key in keys if clean(row.get(key)) not in ("", "0")]
def _fetch_nat(search) -> Callable[[OpnsenseHost], Awaitable[list[dict]]]:
async def fetch(host: OpnsenseHost) -> list[dict]:
data = await search(host)
# split_rows drops automatic_*/lockout_* and is_automatic rows: they are OPNsense's own
return [r for r in split_rows(data)["rules"] if clean(r.get("uuid"))]
return fetch
# ── aliases ──────────────────────────────────────────────────────────────
def _alias_content(row: dict) -> str:
# same normalisation as AliasCreate.clean_content
return "\n".join(line.strip() for line in str(row.get("content") or "").splitlines() if line.strip())
def _alias_is_system(row: dict) -> bool:
name = clean(row.get("name"))
return clean(row.get("type")) == "internal" or name.startswith("__") or name in SYSTEM_ALIAS_NAMES
async def _fetch_aliases(host: OpnsenseHost) -> list[dict]:
data = await opnsense_client.search_aliases(host)
rows = data.get("rows", []) if isinstance(data, dict) else []
return [r for r in rows if isinstance(r, dict) and clean(r.get("uuid")) and clean(r.get("name"))]
async def _alias_context(db: AsyncSession, rows: list[dict]) -> dict:
return {"central_names": set((await db.scalars(select(FirewallAlias.name))).all())}
def _alias_refs(row: dict) -> set[str]:
return {line.lstrip("!").strip() for line in _alias_content(row).splitlines()} - {""}
def _alias_check(row: dict, ctx: dict) -> tuple[list[str], dict[str, str]]:
if _alias_is_system(row):
return ["system"], {}
reasons: list[str] = []
details: dict[str, str] = {}
name, type_ = clean(row.get("name")), clean(row.get("type"))
if type_ not in ALIAS_TYPES:
reasons.append("unsupported_type")
details["unsupported_type"] = clean(row.get("%type")) or type_
if not ALIAS_NAME.fullmatch(name) or len(name) > 64:
reasons.append("name_invalid")
if name in ctx["central_names"]:
reasons.append("name_exists")
if len(_alias_content(row)) > ALIAS_CONTENT_MAX:
reasons.append("content_too_large")
if type_ == "asn" and clean(row.get("proto")):
reasons.append("proto_set") # OPNexus has no field for it: a deploy elsewhere would drop the restriction
if _too_long(FirewallAlias, {"description": clean(row.get("description"))}):
reasons.append("value_too_long")
return reasons, details
def _alias_info(row: dict) -> dict[str, str]:
lines = _alias_content(row).splitlines()
return {
"type": clean(row.get("type")),
"type_label": clean(row.get("%type")) or clean(row.get("type")),
"description": clean(row.get("description")),
"content": "\n".join(lines[:6]) + ("\n…" if len(lines) > 6 else ""),
"entries": str(len(lines)),
}
def _alias_build(row: dict) -> dict:
return {
"name": clean(row.get("name")),
"type": clean(row.get("type")),
"content": _alias_content(row),
"description": clean(row.get("description")),
"enabled": on(row.get("enabled")),
}
# ── port forward ─────────────────────────────────────────────────────────
def _pf_check(row: dict, ctx: dict) -> tuple[list[str], dict[str, str]]:
reasons = []
if not _single_interface(row):
reasons.append("interface_not_single")
if clean(row.get("ipprotocol")) not in ("inet", "inet6"):
reasons.append("ipprotocol_unsupported") # blank / inet46 have no counterpart in OPNexus
if not clean(row.get("protocol")):
reasons.append("protocol_any")
if on(row.get("nordr")):
reasons.append("no_redirect")
elif not clean(row.get("target")):
reasons.append("no_target")
if clean(row.get("pass")):
reasons.append("filter_rule_linked") # OPNexus sends pass "" (manual) and would cut the link
if on(row.get("source.not")):
reasons.append("negated_source")
if on(row.get("destination.not")):
reasons.append("negated_destination")
if clean(row.get("natreflection")) not in ("", "purenat", "disable"):
reasons.append("natreflection_unsupported")
if not clean(row.get("descr")):
reasons.append("no_description")
if _too_long(PortForwardRule, _pf_build(row)):
reasons.append("value_too_long")
return reasons, {}
def _pf_build(row: dict) -> dict:
return {
"description": clean(row.get("descr")),
"interface": clean(row.get("interface")),
"ipprotocol": clean(row.get("ipprotocol")),
"protocol": clean(row.get("protocol")),
"source_net": clean(row.get("source.network")) or "any",
"source_port": _port(row.get("source.port")),
"destination_net": clean(row.get("destination.network")) or "any",
"destination_port": _port(row.get("destination.port")),
"target": clean(row.get("target")),
"local_port": _port(row.get("local-port")),
"natreflection": clean(row.get("natreflection")),
"enabled": not on(row.get("disabled")),
}
def _pf_info(row: dict) -> dict[str, str]:
return {
"interface_label": clean(row.get("%interface")) or clean(row.get("interface")),
"protocol": clean(row.get("%protocol")) or clean(row.get("protocol")) or "any",
"source": clean(row.get("source.network")) or "any",
"source_port": clean(row.get("source.port")),
"destination": clean(row.get("destination.network")) or "any",
"destination_port": clean(row.get("destination.port")),
"target": clean(row.get("target")),
"target_port": clean(row.get("local-port")),
}
# ── 1:1 NAT ──────────────────────────────────────────────────────────────
def _o2o_check(row: dict, ctx: dict) -> tuple[list[str], dict[str, str]]:
reasons = []
if not _single_interface(row):
reasons.append("interface_not_single")
if clean(row.get("type")) not in ("binat", "nat"):
reasons.append("type_unsupported")
if clean(row.get("natreflection")) not in ("", "enable", "disable"):
reasons.append("natreflection_unsupported")
if not clean(row.get("source_net")) or not clean(row.get("external")):
reasons.append("incomplete")
if not clean(row.get("description")):
reasons.append("no_description")
if _too_long(OneToOneRule, _o2o_build(row)):
reasons.append("value_too_long")
return reasons, {}
def _o2o_build(row: dict) -> dict:
return {
"description": clean(row.get("description")),
"interface": clean(row.get("interface")),
"source_net": clean(row.get("source_net")),
"destination_net": clean(row.get("destination_net")) or "any",
"source_not": on(row.get("source_not")),
"destination_not": on(row.get("destination_not")),
"enabled": on(row.get("enabled")),
"type": clean(row.get("type")),
"external": clean(row.get("external")),
"natreflection": clean(row.get("natreflection")),
"log": on(row.get("log")),
}
def _o2o_info(row: dict) -> dict[str, str]:
return {
"interface_label": clean(row.get("%interface")) or clean(row.get("interface")),
"type": clean(row.get("type")),
"source": ("! " if on(row.get("source_not")) else "") + clean(row.get("source_net")),
"destination": ("! " if on(row.get("destination_not")) else "") + (clean(row.get("destination_net")) or "any"),
"external": clean(row.get("external")),
}
# ── outbound NAT ─────────────────────────────────────────────────────────
async def _fetch_outbound(host: OpnsenseHost) -> list[dict]:
# In automatic/disabled mode OPNsense does not list manual rules at all (see module docstring):
# say so instead of showing an empty list.
state = await host_mode(host)
if not state["can_deploy"]:
raise api_error(409, ErrorCode.OUTBOUND_MODE_BLOCKS_ADOPT, host=host.name, mode=state["mode"])
return await _fetch_nat(opnsense_client.search_outbound_nat_rules)(host)
def _snat_check(row: dict, ctx: dict) -> tuple[list[str], dict[str, str]]:
reasons = []
if not _single_interface(row):
reasons.append("interface_not_single")
if on(row.get("nonat")):
reasons.append("no_nat_rule")
if clean(row.get("ipprotocol")) not in ("inet", "inet6"):
reasons.append("ipprotocol_unsupported")
if not clean(row.get("protocol")):
reasons.append("protocol_missing")
if not clean(row.get("description")):
reasons.append("no_description")
if _too_long(OutboundNatRule, _snat_build(row)):
reasons.append("value_too_long")
return reasons, {}
def _snat_build(row: dict) -> dict:
return {
"description": clean(row.get("description")),
"interface": clean(row.get("interface")),
"source_net": clean(row.get("source_net")) or "any",
"destination_net": clean(row.get("destination_net")) or "any",
"source_not": on(row.get("source_not")),
"destination_not": on(row.get("destination_not")),
"enabled": on(row.get("enabled")),
"ipprotocol": clean(row.get("ipprotocol")),
"protocol": clean(row.get("protocol")),
"source_port": _port(row.get("source_port")),
"destination_port": _port(row.get("destination_port")),
"target": clean(row.get("target")),
"target_port": _port(row.get("target_port")),
}
def _snat_info(row: dict) -> dict[str, str]:
return {
"interface_label": clean(row.get("%interface")) or clean(row.get("interface")),
"protocol": clean(row.get("protocol")) or "any",
"source": ("! " if on(row.get("source_not")) else "") + (clean(row.get("source_net")) or "any"),
"source_port": clean(row.get("source_port")),
"destination": ("! " if on(row.get("destination_not")) else "") + (clean(row.get("destination_net")) or "any"),
"destination_port": clean(row.get("destination_port")),
"target": clean(row.get("target")),
"target_port": clean(row.get("target_port")),
}
KINDS: dict[str, Kind] = {
"alias": Kind(
key="alias", model=FirewallAlias, deployment=AliasDeployment, fk="alias_id",
uuid_attr="opnsense_alias_uuid", fetch=_fetch_aliases, check=_alias_check,
title=lambda row: clean(row.get("name")), info=_alias_info, build=_alias_build,
payload=alias_deploy_service._build_payload, revision=alias_policy_service.revision,
context=_alias_context, refs=_alias_refs, name=lambda row: clean(row.get("name")),
),
"port_forward": Kind(
key="port_forward", model=PortForwardRule, deployment=PortForwardDeployment, fk="port_forward_id",
uuid_attr="opnsense_port_forward_uuid", fetch=_fetch_nat(opnsense_client.search_port_forward_rules),
check=_pf_check, title=lambda row: clean(row.get("descr")), info=_pf_info, build=_pf_build,
payload=port_forward_deploy_service._build_payload, revision=port_forward_policy_service.revision,
kept=lambda row: _kept(row, ("log", "poolopts", "tag", "tagged", "nosync", "categories")),
),
"one_to_one": Kind(
key="one_to_one", model=OneToOneRule, deployment=OneToOneDeployment, fk="one_to_one_id",
uuid_attr="opnsense_one_to_one_uuid", fetch=_fetch_nat(opnsense_client.search_one_to_one_rules),
check=_o2o_check, title=lambda row: clean(row.get("description")), info=_o2o_info, build=_o2o_build,
payload=one_to_one_deploy_service._build_payload, revision=one_to_one_policy_service.revision,
kept=lambda row: _kept(row, ("categories",)),
),
"outbound_nat": Kind(
key="outbound_nat", model=OutboundNatRule, deployment=OutboundNatDeployment, fk="outbound_nat_id",
uuid_attr="opnsense_outbound_nat_uuid", fetch=_fetch_outbound,
check=_snat_check, title=lambda row: clean(row.get("description")), info=_snat_info, build=_snat_build,
payload=outbound_nat_deploy_service._build_payload, revision=outbound_nat_policy_service.revision,
kept=lambda row: _kept(row, ("log", "staticnatport", "poolopts", "poolopts_sourcehashkey", "tag", "tagged",
"nosync", "endpoint-independent", "categories")),
),
}
# ── engine ───────────────────────────────────────────────────────────────
async def _managed_uuids(db: AsyncSession, kind: Kind, host: OpnsenseHost) -> set[str]:
column = getattr(kind.deployment, kind.uuid_attr)
rows = await db.scalars(select(column).where(kind.deployment.host_id == host.id, column.is_not(None)))
return set(rows.all())
def _resolve_references(kind: Kind, entries: list[Entry], rows: list[dict], managed: set[str], ctx: dict) -> list[Entry]:
"""Aliases may refer to other aliases by name. A reference to a live alias OPNexus does not manage
(and that is not OPNsense's own) would be dangling in the central model, so the referring alias
waits until its target is managed. Returns the entries in an order in which they can be adopted
in ONE run (dependencies first); entries whose references can never be satisfied (target is a
url alias, a user-defined external alias, ...) keep the reason `references_unmanaged_alias`."""
live = {kind.name(r): r for r in rows}
available = set(ctx["central_names"])
available |= {n for n, r in live.items() if _alias_is_system(r) or clean(r.get("uuid")) in managed}
candidates = [e for e in entries if not e.reasons]
for entry in candidates:
missing = {ref for ref in kind.refs(entry.row) if ref in live and ref not in available}
if missing:
entry.reasons.append("references_unmanaged_alias")
entry.details["references_unmanaged_alias"] = ", ".join(sorted(missing))
order: list[Entry] = []
ready = set(available)
progress = True
while progress:
progress = False
for entry in candidates:
if entry in order:
continue
if all(ref not in live or ref in ready for ref in kind.refs(entry.row)):
order.append(entry)
ready.add(kind.name(entry.row))
progress = True
for entry in order:
entry.bulk = "references_unmanaged_alias" in entry.reasons
return order
async def _plan(db: AsyncSession, kind: Kind, host: OpnsenseHost) -> tuple[list[Entry], list[Entry]]:
"""(all unmanaged entries with their reasons, the ones adoptable in one run in a safe order)."""
rows = await kind.fetch(host)
managed = await _managed_uuids(db, kind, host)
ctx = await kind.context(db, rows) if kind.context else {}
entries = []
for row in rows:
if clean(row.get("uuid")) in managed:
continue
reasons, details = kind.check(row, ctx)
entries.append(Entry(row, list(reasons), dict(details)))
if kind.refs:
order = _resolve_references(kind, entries, rows, managed, ctx)
else:
order = [e for e in entries if not e.reasons]
return entries, order
def _describe(kind: Kind, entry: Entry) -> dict:
return {
"uuid": entry.uuid,
"title": kind.title(entry.row),
"enabled": on(entry.row.get("enabled")) if "disabled" not in entry.row else not on(entry.row.get("disabled")),
"adoptable": not entry.reasons,
"bulk_adoptable": not entry.reasons or entry.bulk,
"reasons": entry.reasons,
"reason_details": entry.details,
"kept": kind.kept(entry.row),
"info": kind.info(entry.row),
}
async def list_unmanaged(db: AsyncSession, kind_key: str, host: OpnsenseHost) -> list[dict]:
kind = KINDS[kind_key]
entries, _ = await _plan(db, kind, host)
return [_describe(kind, e) for e in entries]
def _create(db: AsyncSession, kind: Kind, host: OpnsenseHost, entry: Entry):
obj = kind.model(**kind.build(entry.row), targets=[host], groups=[])
db.add(obj)
return obj
async def _record(db: AsyncSession, kind: Kind, host: OpnsenseHost, obj, remote_uuid: str) -> None:
await db.flush()
kind.revision(db, obj, ADOPT_NOTE)
db.add(kind.deployment(**{
kind.fk: obj.id, "host_id": host.id, "status": "success", "message": ADOPT_MESSAGE,
kind.uuid_attr: remote_uuid, "last_payload": kind.payload(obj), "previous_payload": None,
}))
await db.flush()
async def adopt(db: AsyncSession, kind_key: str, host: OpnsenseHost, remote_uuid: str):
kind = KINDS[kind_key]
entries, _ = await _plan(db, kind, host)
entry = next((e for e in entries if e.uuid == remote_uuid), None)
if entry is None:
# either gone from the host or already managed
if remote_uuid in await _managed_uuids(db, kind, host):
raise NotAdoptable(["already_managed"])
raise NotFoundOnHost(remote_uuid)
if entry.reasons:
raise NotAdoptable(entry.reasons, entry.details)
obj = _create(db, kind, host, entry)
await _record(db, kind, host, obj, remote_uuid)
return obj
async def adopt_all(db: AsyncSession, kind_key: str, host: OpnsenseHost) -> dict:
"""Adopts everything adoptable in one transaction (the caller commits), nested aliases in
dependency order. System objects are not reported; everything else that stays behind is, with reasons."""
kind = KINDS[kind_key]
entries, order = await _plan(db, kind, host)
adopted = []
for entry in order:
obj = _create(db, kind, host, entry)
await _record(db, kind, host, obj, entry.uuid)
adopted.append({"uuid": entry.uuid, "title": kind.title(entry.row), "id": obj.id})
done = {e.uuid for e in order}
skipped = [
{"uuid": e.uuid, "title": kind.title(e.row), "reasons": e.reasons, "reason_details": e.details}
for e in entries if e.uuid not in done and e.reasons != ["system"]
]
return {"adopted": adopted, "skipped": skipped}
+28 -10
View File
@@ -50,7 +50,7 @@ async def get_settings(db: AsyncSession) -> OidcSettings:
if row is None:
row = OidcSettings(
id=SINGLETON_ID, enabled=False, display_name="SSO", client_secret_set=False,
scopes="openid profile email groups", groups_claim="groups",
scopes="openid profile email", groups_claim="groups",
)
db.add(row)
await db.flush()
@@ -130,7 +130,7 @@ def _challenge(verifier: str) -> str:
return base64.urlsafe_b64encode(hashlib.sha256(verifier.encode()).digest()).rstrip(b"=").decode()
async def start(db: AsyncSession, cfg: OidcSettings, redirect_uri: str) -> str:
async def start(db: AsyncSession, cfg: OidcSettings, redirect_uri: str) -> tuple[str, str]:
"""Remember a fresh login attempt and return the provider URL to send the browser to."""
doc = await discovery(cfg.issuer)
state, nonce, verifier = secrets.token_urlsafe(32), secrets.token_urlsafe(24), secrets.token_urlsafe(48)
@@ -141,7 +141,7 @@ async def start(db: AsyncSession, cfg: OidcSettings, redirect_uri: str) -> str:
"response_type": "code", "client_id": cfg.client_id, "redirect_uri": redirect_uri, "scope": cfg.scopes,
"state": state, "nonce": nonce, "code_challenge": _challenge(verifier), "code_challenge_method": "S256",
})
return f"{doc['authorization_endpoint']}{'&' if '?' in doc['authorization_endpoint'] else '?'}{query}"
return f"{doc['authorization_endpoint']}{'&' if '?' in doc['authorization_endpoint'] else '?'}{query}", state
async def _consume_state(db: AsyncSession, state: str) -> OidcLoginState:
@@ -207,7 +207,8 @@ async def _verify_id_token(cfg: OidcSettings, doc: dict, id_token: str, nonce: s
def _as_groups(value) -> list[str]:
if isinstance(value, str):
return [g for g in re.split(r"[,\s]+", value) if g]
# Group names may contain spaces ("Network Admins"): a string claim is split on commas and line breaks only.
return [g.strip() for g in re.split(r"[,\n]+", value) if g.strip()]
if isinstance(value, list):
return [str(g) for g in value]
return []
@@ -224,14 +225,31 @@ def role_for(cfg: OidcSettings, groups: list[str]) -> str | None:
return None
async def _groups(cfg: OidcSettings, doc: dict, claims: dict, access_token: str | None) -> list[str]:
if cfg.groups_claim in claims:
return _as_groups(claims[cfg.groups_claim])
async def _userinfo(doc: dict, claims: dict, access_token: str | None) -> dict:
"""The provider's userinfo answer for THIS identity ({} if there is none or it belongs to somebody else)."""
if access_token and str(doc.get("userinfo_endpoint", "")).startswith("https://"):
info = await _get_json(doc["userinfo_endpoint"], headers={"Authorization": f"Bearer {access_token}"})
if info.get("sub") == claims.get("sub"): # a userinfo answer for someone else is worthless
return _as_groups(info.get(cfg.groups_claim))
return []
return info
return {}
async def _groups(cfg: OidcSettings, doc: dict, claims: dict, access_token: str | None) -> list[str]:
if cfg.groups_claim in claims:
return _as_groups(claims[cfg.groups_claim])
return _as_groups((await _userinfo(doc, claims, access_token)).get(cfg.groups_claim))
async def _with_display_name(doc: dict, claims: dict, access_token: str | None) -> dict:
"""Some providers (Authelia) keep preferred_username/email out of the ID token: ask userinfo, else the user would be named
after the opaque ``sub``. Best effort: a failing userinfo call must not block a login that already has its role."""
if claims.get("preferred_username") or claims.get("email"):
return claims
try:
info = await _userinfo(doc, claims, access_token)
except OidcError:
return claims
return {**claims, **{k: info[k] for k in ("preferred_username", "email") if info.get(k)}}
def _username(claims: dict) -> str:
@@ -267,4 +285,4 @@ async def complete(db: AsyncSession, cfg: OidcSettings, code: str, state_value:
role = role_for(cfg, await _groups(cfg, doc, claims, tokens.get("access_token")))
if role is None:
raise OidcError("no_role", "Kein zugeordnete Gruppe")
return await provision(db, cfg, claims, role)
return await provision(db, cfg, await _with_display_name(doc, claims, tokens.get("access_token")), role)
@@ -9,7 +9,7 @@ from app.models.host import OpnsenseHost
from app.models.one_to_one import OneToOneRule
from app.models.one_to_one_deployment import OneToOneDeployment
from app.services.audit_service import tracked_rollback
from app.services import opnsense_client
from app.services import opnsense_client, variables_service
from app.services.deploy_flow import push_to_host
from app.services.opnsense_client import OpnsenseAmbiguousError, OpnsenseAPIError
@@ -18,7 +18,12 @@ def _now() -> datetime:
return datetime.now(timezone.utc)
def _build_payload(rule: OneToOneRule) -> dict:
def _build_payload(rule: OneToOneRule, host: OpnsenseHost | None = None) -> dict:
payload = _base_payload(rule)
return variables_service.resolve(payload, host) if host is not None else payload
def _base_payload(rule: OneToOneRule) -> dict:
return {
"description": rule.description,
"interface": rule.interface,
@@ -35,7 +40,7 @@ def _build_payload(rule: OneToOneRule) -> dict:
async def _deploy_to_host(db: AsyncSession, rule: OneToOneRule, host: OpnsenseHost) -> OneToOneDeployment:
payload = _build_payload(rule)
payload = _build_payload(rule, host)
existing = await db.scalar(
select(OneToOneDeployment).where(
OneToOneDeployment.one_to_one_id == rule.id, OneToOneDeployment.host_id == host.id
@@ -78,6 +83,7 @@ async def deploy_one_to_one(db: AsyncSession, rule: OneToOneRule, hosts: list[Op
from app.services.host_maintenance_service import ensure_no_maintenance
from app.services.policy_hierarchy_deploy_service import reassert_after_managed_change
await ensure_no_maintenance(db, hosts)
variables_service.ensure_resolvable(_build_payload, rule, hosts) # before anything is written
deployments = [await _deploy_to_host(db, rule, host) for host in hosts]
await db.flush()
for host, deployment in zip(hosts, deployments):
@@ -8,6 +8,7 @@ import json
from app.models.policy import OneToOneRevision
from app.services.one_to_one_deploy_service import _build_payload
from app.services import variables_service
from app.services.policy_service import effective_hosts
ONE_TO_ONE_FIELDS = ('description', 'interface', 'source_net', 'destination_net', 'source_not', 'destination_not', 'enabled', 'type', 'external', 'natreflection', 'log')
@@ -27,13 +28,17 @@ def revision(db, rule, note):
def preview(rule):
payload = _build_payload(rule)
deployments = {d.host_id: d for d in rule.deployments}
hosts = effective_hosts(rule)
blocked = any(d.status in ("pending", "revert_failed") for d in rule.deployments)
rows = []
for host in hosts:
dep = deployments.get(host.id)
try:
payload = _build_payload(rule, host)
except variables_service.MissingVariables as exc:
rows.append(variables_service.preview_row_missing(host, exc.missing[host.name], dep))
continue
before = dep.last_payload if dep else None
action = "create" if not dep or not dep.opnsense_one_to_one_uuid else "update"
if before == payload and dep and dep.status in ("success", "reverted"):
@@ -60,6 +65,8 @@ def preview(rule):
warnings.append("Offene Bestätigung oder fehlgeschlagener Rollback: Push gesperrt.")
if any(r["action"] == "retained" for r in rows):
warnings.append("Frühere Ziele behalten diese Regel, bis du sie hier gezielt entfernst. Diese Löschung hat keinen automatischen Rollback.")
if any(r["action"] == "missing_variable" for r in rows):
warnings.append("Für mindestens einen Ziel-Host fehlt der Wert einer Variable ({{NAME}}). Erst auf der Host-Seite unter „Variablen“ eintragen.")
if any(r["action"] == "disabled" for r in rows):
warnings.append("Deaktivierte Hosts werden übersprungen.")
if any(d.status == "error" for d in rule.deployments):
@@ -70,7 +77,7 @@ def preview(rule):
d.host.base_url, d.host.enabled, d.host.verify_tls) for d in rule.deployments], key=lambda row: row[0])}
token = hashlib.sha256(json.dumps(state, sort_keys=True, default=str).encode()).hexdigest()
return {"token": token, "hosts": rows, "warnings": warnings,
"can_deploy": not blocked and any(r["action"] in ("create", "update") for r in rows),
"can_deploy": not blocked and not any(r["action"] == "missing_variable" for r in rows) and any(r["action"] in ("create", "update") for r in rows),
"basis": "Zuletzt von OPNexus gespeicherter Deploy-Stand; kein Live-Abgleich."}
@@ -78,12 +85,11 @@ def workflow(rule, deployments):
hosts = effective_hosts(rule)
active = [h for h in hosts if h.enabled]
by_host = {d.host_id: d for d in deployments}
payload = _build_payload(rule)
target_ids = {h.id for h in hosts}
counts = {
"targets": len(hosts),
"active_targets": len(active),
"changes": sum(1 for h in active if h.id not in by_host or by_host[h.id].last_payload != payload),
"changes": sum(1 for h in active if h.id not in by_host or by_host[h.id].last_payload != variables_service.payload_or_none(_build_payload, rule, h)),
"pending": sum(d.status == "pending" for d in deployments),
"errors": sum(d.status in ("error", "revert_failed") for d in deployments),
"retained": sum(d.host_id not in target_ids for d in deployments),
+75
View File
@@ -51,7 +51,18 @@ def _client(host: OpnsenseHost) -> httpx.AsyncClient:
)
def _refuse_unresolved_placeholders(method: str, path: str, kwargs: dict) -> None:
"""Last line of defence for site variables: a payload that still contains a {{NAME}} placeholder was never
resolved for this host and must not reach a firewall."""
if method.upper() == "GET" or "json" not in kwargs:
return
from app.services.variables_service import PLACEHOLDER
if PLACEHOLDER.search(json.dumps(kwargs["json"], default=str)):
raise OpnsenseAPIError(f"{path}: Die Anfrage enthält eine nicht aufgelöste Variable ({{{{NAME}}}}) und wird nicht gesendet")
async def _do_request(host: OpnsenseHost, method: str, path: str, **kwargs) -> httpx.Response:
_refuse_unresolved_placeholders(method, path, kwargs)
async with _client(host) as client:
try:
resp = await client.request(method, path, **kwargs)
@@ -134,6 +145,34 @@ async def get_interface_statistics(host: OpnsenseHost) -> dict:
return await _request(host, "GET", "/diagnostics/interface/getInterfaceStatistics")
# Swap and CPU count, for the resource-threshold alert (1.24). Verified against core source
# (Diagnostics/Api/SystemController::systemSwapAction -> configd "system show swapinfo") and live
# (read-only GET, test-fw-3, OPNsense 26.7):
# systemSwap -> {"swap": [{"device": "/dev/da0p3", "total": "8388608", "used": "0"}]} (KiB, strings;
# an empty list when the firewall has no swap)
# cpu_usage/getCPUType -> ["QEMU Virtual CPU version 2.5+ (6 cores, 6 threads)"]
async def get_system_swap(host: OpnsenseHost) -> dict:
return await _request(host, "GET", "/diagnostics/system/systemSwap")
async def get_cpu_type(host: OpnsenseHost) -> Any:
return await _request(host, "GET", "/diagnostics/cpu_usage/getCPUType")
# Gateway health (read-only). Routes\Api\GatewayController::statusAction runs configd "interface gateways status"
# -> scripts/routes/gateway_status.php, which merges the configured gateways with dpinger's live numbers
# (src/etc/inc/plugins.inc.d/dpinger.inc, dpinger_status()). Live-verified on test-fw-3 (26.7):
# {"items": [{"name": "WAN_GW", "address": "203.0.113.1", "status": "none", "loss": "~", "delay": "~",
# "stddev": "~", "monitor": "~", "status_translated": "Online"}, ...], "status": "ok"}
# "status" is the machine-readable verdict: none (fine), down, force_down (switched off by the admin), delay,
# loss, delay+loss (thresholds of the gateway itself), anything else = pending. loss/delay/stddev are "12.3 %" /
# "4.5 ms" strings, or "~" while nothing is measured (e.g. monitoring disabled on that gateway). "status" is
# "failed" with no items when the firewall has no gateways. searchGateway carries the same numbers but with a
# translated status text ("Online"), so it is not used here.
async def get_gateway_status(host: OpnsenseHost) -> dict:
return await _request(host, "GET", "/routes/gateway/status")
async def toggle_carp_maintenance(host: OpnsenseHost) -> dict:
"""Toggle persistent CARP maintenance mode.
@@ -380,6 +419,42 @@ async def get_pf_rule_statistics(host: OpnsenseHost) -> dict:
return await _request(host, "GET", "/diagnostics/firewall/pfStatistics/rules")
# ── Rule analysis (read-only) ─────────────────────────────────────────────
# Checked against opnsense/core master (2026-10-21) and live on OPNsense 26.7:
# - Firewall/Api/FilterUtilController::ruleStatsAction runs configd `!filter rule stats` and
# returns {"status": "ok", "stats": {"<label>": {pf_rules, evaluations, packets, bytes, states}}};
# the label is the rule UUID (MVC), an md5 (automatic) or a 32-hex label (unmigrated legacy).
# - Firewall/Api/AliasUtilController::findReferencesAction requires POST with "ip" (only hex,
# ":", ".", "/", "_" accepted, else {"status": "Not an IP address!"}), runs configd
# `filter find_table_references` (a pf table test over all aliases) and returns
# {"status": "ok", "matches": ["<alias>", ...]}. It changes nothing; POST is only the
# controller's calling convention.
# - Firewall/Api/FilterController::getInterfaceListAction: {"floating"|"groups"|"interfaces"|"any":
# {"label", "items": [{"value", "label", "type"}]}} (lo0 omitted).
# - Firewall/Api/GroupController::searchItemAction -> searchBase("ifgroupentry"): rows with
# ifname, members (comma separated identifiers), sequence; the built-in groups (enc0, openvpn,
# wireguard) appear with their name as uuid and empty members.
async def get_rule_stats(host: OpnsenseHost) -> dict:
return await _request(host, "GET", "/firewall/filter_util/ruleStats")
async def find_alias_references(host: OpnsenseHost, ip: str) -> list[str] | None:
"""Names of the aliases (pf tables) that contain ``ip`` right now; None when the firewall
could not answer (callers then treat table membership as unknown)."""
data = await _request(host, "POST", "/firewall/alias_util/findReferences", json={"ip": ip})
if not isinstance(data, dict) or data.get("status") != "ok" or not isinstance(data.get("matches"), list):
return None
return [str(name) for name in data["matches"]]
async def get_filter_interface_list(host: OpnsenseHost) -> dict:
return await _request(host, "GET", "/firewall/filter/get_interface_list")
async def search_interface_groups(host: OpnsenseHost) -> dict:
return await _request(host, "GET", "/firewall/group/searchItem", params={"rowCount": -1})
async def get_firmware_status(host: OpnsenseHost) -> dict:
# GET reads cached results. POST would trigger a synchronous probe.
return await _request(host, "GET", "/core/firmware/status")
@@ -10,7 +10,7 @@ from app.models.outbound_nat import OutboundNatRule
from app.models.outbound_nat_deployment import OutboundNatDeployment
from app.services.outbound_nat_mode import require_manual_mode
from app.services.audit_service import tracked_rollback
from app.services import opnsense_client
from app.services import opnsense_client, variables_service
from app.services.deploy_flow import push_to_host
from app.services.opnsense_client import OpnsenseAmbiguousError, OpnsenseAPIError
@@ -19,7 +19,12 @@ def _now() -> datetime:
return datetime.now(timezone.utc)
def _build_payload(rule: OutboundNatRule) -> dict:
def _build_payload(rule: OutboundNatRule, host: OpnsenseHost | None = None) -> dict:
payload = _base_payload(rule)
return variables_service.resolve(payload, host) if host is not None else payload
def _base_payload(rule: OutboundNatRule) -> dict:
return {
"description": rule.description,
"interface": rule.interface,
@@ -39,7 +44,7 @@ def _build_payload(rule: OutboundNatRule) -> dict:
async def _deploy_to_host(db: AsyncSession, rule: OutboundNatRule, host: OpnsenseHost) -> OutboundNatDeployment:
await require_manual_mode(host)
payload = _build_payload(rule)
payload = _build_payload(rule, host)
existing = await db.scalar(
select(OutboundNatDeployment).where(
OutboundNatDeployment.outbound_nat_id == rule.id, OutboundNatDeployment.host_id == host.id
@@ -82,6 +87,7 @@ async def deploy_outbound_nat(db: AsyncSession, rule: OutboundNatRule, hosts: li
from app.services.host_maintenance_service import ensure_no_maintenance
from app.services.policy_hierarchy_deploy_service import reassert_after_managed_change
await ensure_no_maintenance(db, hosts)
variables_service.ensure_resolvable(_build_payload, rule, hosts) # before anything is written
deployments = []
try:
for host in hosts:
@@ -8,6 +8,7 @@ import json
from app.models.policy import OutboundNatRevision
from app.services.outbound_nat_deploy_service import _build_payload
from app.services import variables_service
from app.services.policy_service import effective_hosts
OUTBOUND_NAT_FIELDS = ('description', 'interface', 'source_net', 'destination_net', 'source_not', 'destination_not', 'enabled', 'ipprotocol', 'protocol', 'source_port', 'destination_port', 'target', 'target_port')
@@ -27,13 +28,17 @@ def revision(db, rule, note):
def preview(rule):
payload = _build_payload(rule)
deployments = {d.host_id: d for d in rule.deployments}
hosts = effective_hosts(rule)
blocked = any(d.status in ("pending", "revert_failed") for d in rule.deployments)
rows = []
for host in hosts:
dep = deployments.get(host.id)
try:
payload = _build_payload(rule, host)
except variables_service.MissingVariables as exc:
rows.append(variables_service.preview_row_missing(host, exc.missing[host.name], dep))
continue
before = dep.last_payload if dep else None
action = "create" if not dep or not dep.opnsense_outbound_nat_uuid else "update"
if before == payload and dep and dep.status in ("success", "reverted"):
@@ -60,6 +65,8 @@ def preview(rule):
warnings.append("Offene Bestätigung oder fehlgeschlagener Rollback: Push gesperrt.")
if any(r["action"] == "retained" for r in rows):
warnings.append("Frühere Ziele behalten diese Regel, bis du sie hier gezielt entfernst. Diese Löschung hat keinen automatischen Rollback.")
if any(r["action"] == "missing_variable" for r in rows):
warnings.append("Für mindestens einen Ziel-Host fehlt der Wert einer Variable ({{NAME}}). Erst auf der Host-Seite unter „Variablen“ eintragen.")
if any(r["action"] == "disabled" for r in rows):
warnings.append("Deaktivierte Hosts werden übersprungen.")
if any(d.status == "error" for d in rule.deployments):
@@ -70,7 +77,7 @@ def preview(rule):
d.host.base_url, d.host.enabled, d.host.verify_tls) for d in rule.deployments], key=lambda row: row[0])}
token = hashlib.sha256(json.dumps(state, sort_keys=True, default=str).encode()).hexdigest()
return {"token": token, "hosts": rows, "warnings": warnings,
"can_deploy": not blocked and any(r["action"] in ("create", "update") for r in rows),
"can_deploy": not blocked and not any(r["action"] == "missing_variable" for r in rows) and any(r["action"] in ("create", "update") for r in rows),
"basis": "Zuletzt von OPNexus gespeicherter Deploy-Stand; kein Live-Abgleich."}
@@ -78,12 +85,11 @@ def workflow(rule, deployments):
hosts = effective_hosts(rule)
active = [h for h in hosts if h.enabled]
by_host = {d.host_id: d for d in deployments}
payload = _build_payload(rule)
target_ids = {h.id for h in hosts}
counts = {
"targets": len(hosts),
"active_targets": len(active),
"changes": sum(1 for h in active if h.id not in by_host or by_host[h.id].last_payload != payload),
"changes": sum(1 for h in active if h.id not in by_host or by_host[h.id].last_payload != variables_service.payload_or_none(_build_payload, rule, h)),
"pending": sum(d.status == "pending" for d in deployments),
"errors": sum(d.status in ("error", "revert_failed") for d in deployments),
"retained": sum(d.host_id not in target_ids for d in deployments),
+2 -1
View File
@@ -104,7 +104,8 @@ def parse_subnet(value: str) -> ipaddress.IPv4Network:
net = ipaddress.ip_network(value.strip(), strict=True)
except ValueError:
raise OverlayError("subnet", "kein gültiges Netz") from None
if not isinstance(net, ipaddress.IPv4Network) or not net.is_private or not (16 <= net.prefixlen <= 29):
if (not isinstance(net, ipaddress.IPv4Network) or not net.is_private or not (16 <= net.prefixlen <= 29)
or net.is_loopback or net.is_link_local or net.is_multicast or net.is_unspecified):
raise OverlayError("subnet", "ein privates IPv4-Netz zwischen /16 und /29 ist nötig")
return net
+10 -4
View File
@@ -6,6 +6,7 @@ from sqlalchemy import text
from app.models.policy import RuleRevision
from app.services.rule_deploy_service import _build_payload
from app.services import variables_service
RULE_FIELDS = ("description", "interface", "direction", "ipprotocol", "protocol", "action", "source_net", "source_port", "destination_net", "destination_port", "enabled", "log")
@@ -45,13 +46,17 @@ def ensure_editable(rule):
def preview(rule):
payload = _build_payload(rule)
deployments = {d.host_id: d for d in rule.deployments}
hosts = effective_hosts(rule)
blocked = any(d.status in ("pending", "revert_failed") for d in rule.deployments)
rows = []
for host in hosts:
dep = deployments.get(host.id)
try:
payload = _build_payload(rule, host)
except variables_service.MissingVariables as exc:
rows.append(variables_service.preview_row_missing(host, exc.missing[host.name], dep))
continue
before = dep.last_payload if dep else None
action = "create" if not dep or not dep.opnsense_rule_uuid else "update"
if before == payload and dep and dep.status in ("success", "reverted"):
@@ -78,6 +83,8 @@ def preview(rule):
warnings.append("Offene Bestätigung oder fehlgeschlagener Rollback: Push gesperrt.")
if any(r["action"] == "retained" for r in rows):
warnings.append("Frühere Ziele behalten ihre Regel, bis du sie hier gezielt entfernst. Diese Löschung hat keinen automatischen Rollback.")
if any(r["action"] == "missing_variable" for r in rows):
warnings.append("Für mindestens einen Ziel-Host fehlt der Wert einer Variable ({{NAME}}). Erst auf der Host-Seite unter „Variablen“ eintragen.")
if any(r["action"] == "disabled" for r in rows):
warnings.append("Deaktivierte Hosts werden übersprungen.")
if any(d.status == "error" for d in rule.deployments):
@@ -89,7 +96,7 @@ def preview(rule):
d.host.base_url, d.host.enabled, d.host.verify_tls) for d in rule.deployments], key=lambda row: row[0])}
token = hashlib.sha256(json.dumps(state, sort_keys=True, default=str).encode()).hexdigest()
return {"token": token, "hosts": rows, "warnings": warnings,
"can_deploy": not blocked and any(r["action"] in ("create", "update") for r in rows),
"can_deploy": not blocked and not any(r["action"] == "missing_variable" for r in rows) and any(r["action"] in ("create", "update") for r in rows),
"basis": "Zuletzt von OPNexus gespeicherter Deploy-Stand; kein Live-Abgleich."}
@@ -98,12 +105,11 @@ def workflow(rule, deployments):
hosts = effective_hosts(rule)
active = [h for h in hosts if h.enabled]
by_host = {d.host_id: d for d in deployments}
payload = _build_payload(rule)
target_ids = {h.id for h in hosts}
counts = {
"targets": len(hosts),
"active_targets": len(active),
"changes": sum(1 for h in active if h.id not in by_host or by_host[h.id].last_payload != payload),
"changes": sum(1 for h in active if h.id not in by_host or by_host[h.id].last_payload != variables_service.payload_or_none(_build_payload, rule, h)),
"pending": sum(d.status == "pending" for d in deployments),
"errors": sum(d.status in ("error", "revert_failed") for d in deployments),
"retained": sum(d.host_id not in target_ids for d in deployments),
@@ -21,7 +21,7 @@ from app.models.host import OpnsenseHost
from app.models.port_forward import PortForwardRule
from app.models.port_forward_deployment import PortForwardDeployment
from app.services.audit_service import tracked_rollback
from app.services import opnsense_client
from app.services import opnsense_client, variables_service
from app.services.deploy_flow import push_to_host
from app.services.opnsense_client import OpnsenseAmbiguousError, OpnsenseAPIError
@@ -30,7 +30,12 @@ def _now() -> datetime:
return datetime.now(timezone.utc)
def _build_payload(rule: PortForwardRule) -> dict:
def _build_payload(rule: PortForwardRule, host: OpnsenseHost | None = None) -> dict:
payload = _base_payload(rule)
return variables_service.resolve(payload, host) if host is not None else payload
def _base_payload(rule: PortForwardRule) -> dict:
return {
"disabled": "0" if rule.enabled else "1",
"interface": rule.interface,
@@ -47,7 +52,7 @@ def _build_payload(rule: PortForwardRule) -> dict:
async def _deploy_to_host(db: AsyncSession, rule: PortForwardRule, host: OpnsenseHost) -> PortForwardDeployment:
payload = _build_payload(rule)
payload = _build_payload(rule, host)
existing = await db.scalar(
select(PortForwardDeployment).where(
PortForwardDeployment.port_forward_id == rule.id, PortForwardDeployment.host_id == host.id
@@ -90,6 +95,7 @@ async def deploy_port_forward(db: AsyncSession, rule: PortForwardRule, hosts: li
from app.services.host_maintenance_service import ensure_no_maintenance
from app.services.policy_hierarchy_deploy_service import reassert_after_managed_change
await ensure_no_maintenance(db, hosts)
variables_service.ensure_resolvable(_build_payload, rule, hosts) # before anything is written
deployments = [await _deploy_to_host(db, rule, host) for host in hosts]
await db.flush()
for host, deployment in zip(hosts, deployments):
@@ -8,6 +8,7 @@ import json
from app.models.policy import PortForwardRevision
from app.services.port_forward_deploy_service import _build_payload
from app.services import variables_service
from app.services.policy_service import effective_hosts
PORT_FORWARD_FIELDS = (
@@ -30,13 +31,17 @@ def revision(db, rule, note):
def preview(rule):
payload = _build_payload(rule)
deployments = {d.host_id: d for d in rule.deployments}
hosts = effective_hosts(rule)
blocked = any(d.status in ("pending", "revert_failed") for d in rule.deployments)
rows = []
for host in hosts:
dep = deployments.get(host.id)
try:
payload = _build_payload(rule, host)
except variables_service.MissingVariables as exc:
rows.append(variables_service.preview_row_missing(host, exc.missing[host.name], dep))
continue
before = dep.last_payload if dep else None
action = "create" if not dep or not dep.opnsense_port_forward_uuid else "update"
if before == payload and dep and dep.status in ("success", "reverted"):
@@ -63,6 +68,8 @@ def preview(rule):
warnings.append("Offene Bestätigung oder fehlgeschlagener Rollback: Push gesperrt.")
if any(r["action"] == "retained" for r in rows):
warnings.append("Frühere Ziele behalten diese Regel, bis du sie hier gezielt entfernst. Diese Löschung hat keinen automatischen Rollback.")
if any(r["action"] == "missing_variable" for r in rows):
warnings.append("Für mindestens einen Ziel-Host fehlt der Wert einer Variable ({{NAME}}). Erst auf der Host-Seite unter „Variablen“ eintragen.")
if any(r["action"] == "disabled" for r in rows):
warnings.append("Deaktivierte Hosts werden übersprungen.")
if any(d.status == "error" for d in rule.deployments):
@@ -73,7 +80,7 @@ def preview(rule):
d.host.base_url, d.host.enabled, d.host.verify_tls) for d in rule.deployments], key=lambda row: row[0])}
token = hashlib.sha256(json.dumps(state, sort_keys=True, default=str).encode()).hexdigest()
return {"token": token, "hosts": rows, "warnings": warnings,
"can_deploy": not blocked and any(r["action"] in ("create", "update") for r in rows),
"can_deploy": not blocked and not any(r["action"] == "missing_variable" for r in rows) and any(r["action"] in ("create", "update") for r in rows),
"basis": "Zuletzt von OPNexus gespeicherter Deploy-Stand; kein Live-Abgleich."}
@@ -81,12 +88,11 @@ def workflow(rule, deployments):
hosts = effective_hosts(rule)
active = [h for h in hosts if h.enabled]
by_host = {d.host_id: d for d in deployments}
payload = _build_payload(rule)
target_ids = {h.id for h in hosts}
counts = {
"targets": len(hosts),
"active_targets": len(active),
"changes": sum(1 for h in active if h.id not in by_host or by_host[h.id].last_payload != payload),
"changes": sum(1 for h in active if h.id not in by_host or by_host[h.id].last_payload != variables_service.payload_or_none(_build_payload, rule, h)),
"pending": sum(d.status == "pending" for d in deployments),
"errors": sum(d.status in ("error", "revert_failed") for d in deployments),
"retained": sum(d.host_id not in target_ids for d in deployments),
@@ -5,7 +5,9 @@ poll_all_hosts. v1 deliberately has no admin-editable poll interval (see
config.py) — just a fixed constant, to keep this feature's first cut
small.
"""
import asyncio
import logging
import re
from datetime import datetime, timedelta, timezone
from sqlalchemy import delete, select
@@ -13,6 +15,7 @@ from sqlalchemy.ext.asyncio import AsyncSession
from app.models.host import OpnsenseHost
from app.models.resource_sample import HostResourceSample
from app.services import gateway_health_service
from app.services import opnsense_client as client
from app.services.opnsense_client import OpnsenseAPIError
@@ -55,11 +58,59 @@ def _disk_used_pct(disk: dict) -> float | None:
return None
def _swap_used_pct(swap) -> float | None:
"""systemSwap: {"swap": [{"device", "total", "used"}]} in KiB; None when there is no swap at all."""
try:
rows = swap.get("swap") or []
total = sum(int(r["total"]) for r in rows)
used = sum(int(r["used"]) for r in rows)
except (AttributeError, KeyError, TypeError, ValueError):
return None
return round(used / total * 100, 1) if total > 0 else None
_CPU_THREADS = re.compile(r"(\d+)\s+threads?", re.IGNORECASE)
_CPU_CORES = re.compile(r"(\d+)\s+cores?", re.IGNORECASE)
def _cpu_threads(cpu_type) -> int | None:
"""getCPUType: ["<model> (6 cores, 6 threads)"]."""
text = " ".join(str(x) for x in cpu_type) if isinstance(cpu_type, list) else str(cpu_type or "")
match = _CPU_THREADS.search(text) or _CPU_CORES.search(text)
return int(match.group(1)) if match else None
def _services_compact(listing) -> dict[str, int]:
"""{"unbound": 1, "openvpn/<uuid>": 0}: 1 = running. Only services an admin can stop (not 'locked')."""
result: dict[str, int] = {}
for row in (listing.get("rows") if isinstance(listing, dict) else None) or []:
if not isinstance(row, dict) or not row.get("name") or str(row.get("locked")) in ("1", "True", "true"):
continue
name, id_ = str(row["name"]), str(row.get("id") or row["name"])
result[name if id_ == name else f"{name}/{id_}"] = 1 if str(row.get("running")) in ("1", "True", "true") else 0
return result
async def _optional(operation):
"""The extra readings must never cost the base sample (older firmware, an endpoint that is missing)."""
try:
return await operation
except Exception as exc:
logger.debug("Optionale Messung fehlgeschlagen: %s", type(exc).__name__)
return None
async def sample_host(db: AsyncSession, host: OpnsenseHost) -> None:
resources = await client.get_system_resources(host)
system_time = await client.get_system_time(host)
disk = await client.get_system_disk(host)
interfaces = await client.get_interface_statistics(host)
swap, cpu_type, gateways, services = await asyncio.gather(
_optional(client.get_system_swap(host)),
_optional(client.get_cpu_type(host)),
_optional(gateway_health_service.get_gateway_health(host)),
_optional(client.search_services(host)),
)
db.add(
HostResourceSample(
host_id=host.id,
@@ -67,7 +118,14 @@ async def sample_host(db: AsyncSession, host: OpnsenseHost) -> None:
mem_used_pct=_mem_used_pct(resources),
load_avg_1m=_load_avg_1m(system_time),
disk_used_pct=_disk_used_pct(disk),
raw={"memory": resources.get("memory"), "disk": disk.get("devices"), "interfaces": interfaces.get("statistics")},
raw={
"memory": resources.get("memory"), "disk": disk.get("devices"), "interfaces": interfaces.get("statistics"),
# None = not readable this round (the alert checks treat that as "unknown", not as "fine").
"swap_used_pct": _swap_used_pct(swap) if swap is not None else None,
"cpu_threads": _cpu_threads(cpu_type) if cpu_type is not None else None,
"gateways": gateway_health_service.compact(gateways) if gateways is not None else None,
"services": _services_compact(services) if services is not None else None,
},
)
)
+805
View File
@@ -0,0 +1,805 @@
"""The rollout run engine (1.25): moves runs forward, one small step per poll tick.
Ground rules (an unattended engine that triggers firmware updates is the riskiest thing in OPNexus):
* It never calls a firmware action itself. Each host step is an ordinary ScheduledMaintenance
(run_at=now, origin="rollout", auto_verify=True) — locks, backup before the update, CARP handover,
audit and restart safety all come from that existing path.
* Never twice: a host gets a schedule only while its ``scheduled_maintenance_id`` is empty, written
in the same transaction as the schedule itself, under the run's row lock.
* Never in parallel: one host at a time per run, and only one active run at all; nodes of a cluster
go BACKUP first, the MASTER only with the wave's CARP handover, and before every node of an
already touched cluster the cluster is checked again.
* When in doubt, stop: anything unexpected pauses the run (``pause_reason``) and notifies; nothing
is retried on its own. A paused run only continues when a human resumes it, and resuming first
checks the health of everything done so far.
* Every step re-checks that the person responsible for the run may still roll out.
* Hard limits: waves/hosts (rollout_service), soak time, preflight/host timeouts, run age.
Concurrency: a tick (1) does DB-only bookkeeping under the run's row lock, (2) decides with the
lock released (remote reads may take seconds), and (3) applies the decision only if the run's
``revision`` is still the one it decided on — a pause/abort in between, or a second backend, wins.
"""
import logging
import uuid
from datetime import datetime, timedelta, timezone
from typing import Awaitable, Callable
from fastapi import HTTPException
from sqlalchemy import func, select
from sqlalchemy.exc import IntegrityError
from sqlalchemy.ext.asyncio import AsyncSession
from app.database import SessionLocal
from app.models.host import OpnsenseHost
from app.models.maintenance_window import MaintenanceWindow
from app.models.rollout import RolloutPlan, RolloutRun, RolloutRunHost, RolloutRunWave
from app.models.scheduled_maintenance import ScheduledMaintenance
from app.models.user import AdminUser
from app.services import audit_service, rollout_health, rollout_service, window_service
from app.services import opnsense_client as client
from app.services.host_maintenance_service import ensure_no_maintenance, peers
from app.services.host_status_service import get_statuses
from app.services.policy_service import policy_lock
logger = logging.getLogger(__name__)
ACTIVE = ("waiting_window", "preflight", "wave_running", "soaking", "gate", "awaiting_approval", "resuming", "paused")
TERMINAL = ("succeeded", "cancelled")
# Statuses in which the poll loop should tick quickly.
BUSY = ("preflight", "wave_running", "gate", "resuming")
HOST_OPEN = ("running", "verifying")
PREFLIGHT_CHECK_DELAY = timedelta(seconds=20) # after asking for an update check, before reading the result
PREFLIGHT_TIMEOUT = timedelta(minutes=10)
GATE_RECHECK = timedelta(minutes=2) # a failed gate is looked at once more (slow start after a reboot)
BLOCKED_PATIENCE = timedelta(minutes=15) # someone else's maintenance in the cluster
HOST_START_TIMEOUT = timedelta(minutes=10) # the schedule never fired
HOST_MAX_DURATION = timedelta(hours=4) # backstop above the schedule's own timeouts
MAX_RUN_AGE = timedelta(days=14)
def _now() -> datetime:
return datetime.now(timezone.utc)
def _iso(value: datetime | None) -> str | None:
return value.isoformat() if value else None
def _ts(value: str | None) -> datetime | None:
return datetime.fromisoformat(value) if value else None
def _note(code: str, **params) -> dict:
return {"code": code, "params": params}
# ── small helpers on a loaded run ─────────────────────────────────────────────
def wave_row(run: RolloutRun, index: int) -> RolloutRunWave:
return next(w for w in run.waves if w.index == index)
def wave_spec(run: RolloutRun, index: int) -> dict:
return run.plan_snapshot["waves"][index]
def hosts_of(run: RolloutRun, index: int) -> list[RolloutRunHost]:
return sorted((h for h in run.hosts if h.wave_index == index), key=lambda h: (h.order, h.host_name))
def _named(run: RolloutRun, failed: list[str]) -> list[str]:
""""<host-id>:<check>" -> "<host name>:<check>" for pause details people read."""
names = {str(h.host_id): h.host_name for h in run.hosts if h.host_id}
return [f"{names.get(item.split(':', 1)[0], item.split(':', 1)[0])}:{item.split(':', 1)[1]}" for item in failed]
def _progress(run: RolloutRun, **changes) -> None:
run.progress = {**(run.progress or {}), **changes}
async def _audit(run: RolloutRun, action: str, status: str, message: str | None = None, **details) -> None:
token = audit_service.context.set({"actor": f"{run.started_by} (Rollout)"[:150], "id": str(run.id)})
try:
await audit_service.persist(kind="rollout", action=action, status=status, entity_id=str(run.id),
entity_name=run.plan_name, message=message,
details={"wave": run.current_wave, **details})
finally:
audit_service.context.reset(token)
def _requeue(host: RolloutRunHost, code: str) -> None:
"""Back to the queue: only for a host whose schedule provably never fired (cancelled under its row lock,
or refused by fire_due as overdue). Clearing the schedule id lets a resumed run plan it once more."""
host.status, host.scheduled_maintenance_id, host.started_at, host.detail = "queued", None, None, _note(code)
async def requeue_if_pending(db: AsyncSession, host: RolloutRunHost) -> bool:
"""Cancel a host's schedule that has not fired yet and put the host back in the queue. Locked like the
router's abort: fire_due holds the row while firing, and a running action is never touched."""
if host.status not in HOST_OPEN or host.scheduled_maintenance_id is None:
return False
sched = await db.scalar(select(ScheduledMaintenance).where(ScheduledMaintenance.id == host.scheduled_maintenance_id)
.with_for_update().execution_options(populate_existing=True))
if sched is None or sched.status != "pending":
return False
sched.status = "cancelled"
sched.result = {"error": "Rollout angehalten, nicht ausgeführt", "not_fired": True}
_requeue(host, "not_fired")
return True
def pause(run: RolloutRun, reason: str, **detail) -> None:
if run.status != "paused":
run.paused_from = run.status
run.status = "paused"
run.pause_reason = reason
run.pause_detail = detail
_progress(run, paused_at=_iso(_now()))
async def may_roll_out(db: AsyncSession, username: str) -> bool:
"""Does this account (still) have the right to roll out? Same rule as AuthMiddleware's is_rollout."""
user = await db.scalar(select(AdminUser).where(AdminUser.username == username))
if user is None:
return False
if user.role == "admin":
return True
if user.role == "operator":
from app.routers import governance
return (await governance.get_settings(db)).operators_may_deploy
return False
async def _window(db: AsyncSession, run: RolloutRun) -> tuple[bool, MaintenanceWindow | None]:
"""(window configured, window). Configured but gone means: stop, never 'no time limit'."""
window_id = run.plan_snapshot.get("window_id")
if not window_id:
return False, None
return True, await db.get(MaintenanceWindow, window_id)
async def _may_start_now(db: AsyncSession, run: RolloutRun) -> str | None:
"""None if new host work may start now, else the reason ('window_closed' / 'window_missing')."""
configured, window = await _window(db, run)
if not configured:
return None
if window is None:
return "window_missing"
return None if window_service.startable(window, _now()) else "window_closed"
async def _lock(db: AsyncSession, run_id, revision: int | None = None) -> RolloutRun | None:
stmt = select(RolloutRun).where(RolloutRun.id == run_id)
if revision is not None:
stmt = stmt.where(RolloutRun.revision == revision)
return await db.scalar(stmt.with_for_update().execution_options(populate_existing=True))
# ── creating a run ────────────────────────────────────────────────────────────
async def active_run(db: AsyncSession) -> RolloutRun | None:
return await db.scalar(select(RolloutRun).where(RolloutRun.status.in_(ACTIVE)).order_by(RolloutRun.created_at).limit(1))
async def create_run(db: AsyncSession, plan: RolloutPlan, resolved: dict, *, started_by: str, trigger: str,
occurrence: datetime | None = None) -> RolloutRun:
"""Freeze the plan and its resolved hosts. The caller holds policy_lock and has checked the token."""
now = _now()
snapshot = {
"plan_id": str(plan.id), "name": plan.name, "action": plan.action,
"window_id": str(plan.window_id) if plan.window_id else None,
"gate_checks": rollout_service.effective_checks(plan.gate_checks), "compliance_mode": plan.compliance_mode,
"waves": [{k: w[k] for k in ("label", "soak_minutes", "carp_handover", "require_approval", "groups")} for w in resolved["waves"]],
}
run = RolloutRun(plan_id=plan.id, plan_name=plan.name, plan_snapshot=snapshot, action=plan.action, status="preflight",
current_wave=0, started_by=started_by, trigger=trigger, window_occurrence=occurrence,
progress={}, created_at=now, step_at=now, revision=0)
run.waves = [RolloutRunWave(index=w["index"], label=w["label"], status="preflight" if w["index"] == 0 else "pending")
for w in resolved["waves"]]
run.hosts = [RolloutRunHost(wave_index=w["index"], host_id=uuid.UUID(h["id"]), host_name=h["name"], cluster_name=h["cluster_name"],
order=i, status="queued")
for w in resolved["waves"] for i, h in enumerate(w["hosts"])]
db.add(run)
await db.flush()
return run
# ── the tick ──────────────────────────────────────────────────────────────────
async def advance_runs(db: AsyncSession) -> int:
"""One step for every run. Returns how many runs want a quick next tick."""
try:
await auto_start(db)
except Exception:
logger.exception("Rollout: automatischer Start fehlgeschlagen")
await db.rollback()
ids = list((await db.scalars(select(RolloutRun.id).where(
(RolloutRun.status.in_(ACTIVE)) | RolloutRun.hosts.any(RolloutRunHost.status.in_(HOST_OPEN))))).all())
await db.commit()
busy = 0
for run_id in ids:
try:
await tick(run_id)
except Exception as exc:
logger.exception("Rollout %s: Schritt fehlgeschlagen", run_id)
async with SessionLocal() as s:
run = await _lock(s, run_id)
if run is not None and run.status in ACTIVE and run.status != "paused":
pause(run, "internal_error", error=type(exc).__name__)
run.revision += 1
await s.commit()
await _audit(run, "pause", "paused", "Interner Fehler: Rollout angehalten", reason="internal_error")
async with SessionLocal() as s:
status = await s.scalar(select(RolloutRun.status).where(RolloutRun.id == run_id))
busy += status in BUSY
return busy
async def tick(run_id) -> None:
async with SessionLocal() as db:
# (1) bookkeeping under the lock: what did the schedules do?
run = await _lock(db, run_id)
if run is None:
return
changed = await _sync_hosts(db, run)
if (run.status in ACTIVE and run.status != "paused" and _now() - run.created_at > MAX_RUN_AGE
and not any(h.status in HOST_OPEN for h in run.hosts)):
pause(run, "run_too_old", days=MAX_RUN_AGE.days)
changed = True
if changed:
run.revision += 1
await db.commit()
if changed and run.status == "paused" and run.pause_reason in ("host_failed", "host_timeout", "host_not_started", "run_too_old"):
await _audit(run, "pause", "paused", reason=run.pause_reason, detail=run.pause_detail)
if run.status not in ACTIVE or run.status in ("paused", "awaiting_approval"):
return
revision = run.revision
# (2) decide, without holding the lock
decision = await _HANDLERS[run.status](db, run)
await db.commit()
if decision is None:
return
# (3) apply only on the revision it was decided on
run = await _lock(db, run_id, revision)
if run is None:
await db.commit()
return
events = await decision(db, run)
run.revision += 1
run.step_at = _now()
await db.commit()
for event in events or []:
await _audit(run, *event[:2], **(event[2] if len(event) > 2 else {}))
Decision = Callable[[AsyncSession, RolloutRun], Awaitable[list | None]]
async def _sync_hosts(db: AsyncSession, run: RolloutRun) -> bool:
"""Carry the outcome of each host's schedule over to the run. Returns True if anything changed."""
changed = False
now = _now()
for host in run.hosts:
if host.status not in HOST_OPEN:
continue
sched = await db.get(ScheduledMaintenance, host.scheduled_maintenance_id, populate_existing=True) \
if host.scheduled_maintenance_id else None
problem = None
if sched is None:
host.status, host.detail, host.finished_at = "failed", _note("schedule_missing"), now
problem = ("host_failed", {"host": host.host_name, "error": "schedule_missing"})
elif sched.status == "pending":
if host.started_at and now - host.started_at > HOST_START_TIMEOUT:
# Never leave it pending behind a paused run: it would fire whenever the poll loop comes back.
if await requeue_if_pending(db, host):
problem = ("host_not_started", {"host": host.host_name})
changed = True
elif (sched.result or {}).get("not_fired"):
_requeue(host, "not_fired") # fire_due refused it as overdue: nothing happened on the firewall
problem = ("host_not_started", {"host": host.host_name})
changed = True
elif sched.status == "running":
want = "verifying" if sched.phase == "verify" else "running"
if host.status != want:
host.status = want
changed = True
if host.started_at and now - host.started_at > HOST_MAX_DURATION:
problem = ("host_timeout", {"host": host.host_name})
elif sched.status == "succeeded":
result = sched.result or {}
host.status, host.finished_at = "succeeded", now
host.version_after = result.get("version_after")
host.detail = _note("verified", version=result.get("version_after"), rebooted=bool(result.get("rebooted")))
changed = True
else: # failed / cancelled
error = (sched.result or {}).get("error") or sched.status
host.status, host.finished_at = "failed", now
host.detail = _note("host_failed", error=error[:300])
problem = ("host_failed", {"host": host.host_name, "error": error[:300]})
if problem and run.status in ACTIVE and run.status != "paused":
pause(run, problem[0], **problem[1])
changed = True
elif problem and host.status == "failed":
changed = True
return changed
# ── handlers: one per run status; each returns an apply-function or None ──────
async def _actor_problem(db: AsyncSession, run: RolloutRun) -> Decision | None:
if await may_roll_out(db, run.started_by):
return None
async def apply(db, run):
pause(run, "actor_invalid", user=run.started_by)
return [("pause", "paused", {"reason": "actor_invalid"})]
return apply
def _to_waiting(reason: str) -> Decision:
async def apply(db, run):
if reason == "window_missing":
pause(run, "window_missing")
return [("pause", "paused", {"reason": reason})]
run.paused_from = run.status
run.status = "waiting_window"
return [("waiting_window", "waiting")]
return apply
async def _handle_waiting_window(db: AsyncSession, run: RolloutRun) -> Decision | None:
reason = await _may_start_now(db, run)
if reason == "window_missing":
return _to_waiting(reason)
if reason:
return None
async def apply(db, run):
_progress(run, resume_recheck_at=None, resume_attempts=0)
run.status = "resuming" # the gate of everything done so far is checked again first
return [("window_open", "resuming")]
return apply
async def _handle_resuming(db: AsyncSession, run: RolloutRun) -> Decision | None:
recheck = _ts((run.progress or {}).get("resume_recheck_at"))
if recheck and _now() < recheck:
return None
done = [h for h in run.hosts if h.status == "succeeded" and h.host_id]
gate = {"hosts": {}, "verdict": "ok"}
if done:
hosts = [h for h in [await db.get(OpnsenseHost, d.host_id) for d in done] if h is not None]
baselines = {}
for w in run.waves:
baselines.update((w.baseline or {}))
gate = await rollout_health.evaluate(db, hosts, baselines, target_version=run.target_version,
checks=run.plan_snapshot.get("gate_checks"),
compliance_mode=run.plan_snapshot.get("compliance_mode", "warn"))
async def apply(db, run):
if gate["verdict"] == "fail":
attempts = (run.progress or {}).get("resume_attempts", 0) + 1
_progress(run, resume_gate=gate, resume_attempts=attempts)
if attempts < 2:
_progress(run, resume_recheck_at=_iso(_now() + GATE_RECHECK))
return [("resume_gate", "recheck", {"failed": rollout_health.failed_checks(gate)})]
run.paused_from = run.paused_from or "preflight"
_progress(run, resume_recheck_at=None)
run.status = "paused"
run.pause_reason, run.pause_detail = "gate_failed", {"failed": _named(run, rollout_health.failed_checks(gate)), "on_resume": True}
return [("resume_gate", "failed", {"failed": rollout_health.failed_checks(gate)})]
_progress(run, resume_gate=gate, resume_recheck_at=None, resume_attempts=0)
target = run.paused_from if run.paused_from in ("preflight", "wave_running", "soaking", "gate") else "preflight"
if target == "gate":
wave_row(run, run.current_wave).gate_attempts = 0
_progress(run, gate_recheck_at=None)
if target == "preflight":
_progress(run, preflight_started=None, preflight_requested_at=None)
run.status, run.paused_from, run.pause_reason, run.pause_detail = target, None, None, None
return [("resume_gate", "passed", {"continue_with": target})]
return apply
def target_of(status: dict, action: str) -> str | None:
"""The version a firmware action will install, from core/firmware/status (read after a fresh check).
Live finding (test-fw-3, 26.7.1_1, 2026-10-21): ``product.product_latest`` said 26.7.2 while the
``opnsense`` core package was offered as 26.7.7 — and the package is what gets installed. So the
core package's new version comes first; product_latest is only a fallback."""
if action == "major_update":
return status.get("upgrade_major_version") or None
packages = status.get("all_packages") if isinstance(status.get("all_packages"), dict) else {}
core = packages.get("opnsense") if isinstance(packages.get("opnsense"), dict) else None
if core and core.get("new") and core.get("new") != "N/A":
return str(core["new"])
for row in status.get("upgrade_packages") or []:
if isinstance(row, dict) and row.get("name") == "opnsense" and row.get("new_version"):
return str(row["new_version"])
product = status.get("product") if isinstance(status.get("product"), dict) else {}
return product.get("product_latest") or status.get("product_latest") or None
async def _handle_preflight(db: AsyncSession, run: RolloutRun) -> Decision | None:
if problem := await _actor_problem(db, run):
return problem
reason = await _may_start_now(db, run)
if reason:
return _to_waiting(reason)
index = run.current_wave
prog = run.progress or {}
started = _ts(prog.get("preflight_started")) or _now()
requested = _ts(prog.get("preflight_requested_at"))
candidates = [h for h in hosts_of(run, index) if h.status in ("queued", "blocked")]
now = _now()
# Which hosts are usable at all?
usable: dict = {}
skips: dict = {}
for rh in candidates:
host = await db.get(OpnsenseHost, rh.host_id) if rh.host_id else None
if host is None:
skips[rh.id] = _note("host_deleted")
elif not host.enabled:
skips[rh.id] = _note("host_disabled")
else:
usable[rh.id] = host
if requested is None:
# Step 1: ask every usable host to look for updates (a firmware *check*, changes nothing installed).
asked = []
for rh_id, host in usable.items():
try:
await ensure_no_maintenance(db, [host])
if (await client.get_firmware_running(host)).get("status") == "ready":
await client.check_firmware_updates(host)
asked.append(str(rh_id))
except (client.OpnsenseAPIError, HTTPException):
pass # judged in step 2 (and blocked after the timeout)
async def apply(db, run):
_progress(run, preflight_started=_iso(started), preflight_requested_at=_iso(_now()), preflight_asked=asked)
w = wave_row(run, index)
w.status = "preflight"
w.started_at = w.started_at or _now()
return [("preflight", "started", {"hosts": len(usable)})]
return apply
if now - requested < PREFLIGHT_CHECK_DELAY:
return None
# Step 2: read what each host offers.
offers: dict = {}
waiting: dict = {}
for rh_id, host in usable.items():
try:
await ensure_no_maintenance(db, [host])
except HTTPException:
waiting[rh_id] = _note("locked")
continue
try:
running = (await client.get_firmware_running(host)).get("status")
if running != "ready":
waiting[rh_id] = _note("firmware_busy")
continue
status = await client.get_firmware_status(host)
except client.OpnsenseAPIError:
waiting[rh_id] = _note("offline")
continue
fw = status.get("status")
wanted = "upgrade" if run.action == "major_update" else "update"
if fw == wanted:
offers[rh_id] = target_of(status, run.action)
elif fw in ("none", "update", "upgrade"):
skips[rh_id] = _note("no_update_offered", status=fw)
else:
waiting[rh_id] = _note("firmware_status", status=str(fw)[:40])
if waiting:
if now - started < PREFLIGHT_TIMEOUT:
return None
async def apply_blocked(db, run):
names = []
for rh in hosts_of(run, index):
if rh.id in waiting:
rh.status, rh.detail = "blocked", waiting[rh.id]
names.append(rh.host_name)
pause(run, "preflight_blocked", hosts=", ".join(names))
_progress(run, preflight_started=None, preflight_requested_at=None)
return [("pause", "paused", {"reason": "preflight_blocked", "hosts": names})]
return apply_blocked
targets = {t for t in offers.values()}
expected = run.target_version
mismatch = None
if None in targets:
mismatch = {"offered": "?"}
elif expected is None and len(targets) > 1:
mismatch = {"offered": ", ".join(sorted(targets))}
elif expected is not None and targets - {expected}:
mismatch = {"expected": expected, "offered": ", ".join(sorted(targets - {expected}))}
if mismatch:
async def apply_mismatch(db, run):
# OPNsense always installs the newest offered version; a later ring must not get one the earlier ring never ran.
pause(run, "target_version_changed", **mismatch)
_progress(run, preflight_started=None, preflight_requested_at=None)
return [("pause", "paused", {"reason": "target_version_changed", **mismatch})]
return apply_mismatch
# Baselines and order (BACKUP before MASTER inside a cluster).
baselines = {}
versions = {}
for rh_id in offers:
host = usable[rh_id]
baselines[str(host.id)] = await rollout_health.baseline(db, host)
versions[rh_id] = baselines[str(host.id)].get("version")
roles = await get_statuses([usable[i] for i in offers])
rank = {"BACKUP": 0, None: 1, "MASTER": 2}
def order_key(rh_id):
host = usable[rh_id]
role = roles.get(host.id, {}).get("carp_status") if host.cluster_name else None
return (1 if host.cluster_name else 0, host.cluster_name or "", rank.get(role, 1), host.name)
ordered = sorted(offers, key=order_key)
target = next(iter(targets)) if targets else expected
async def apply_ready(db, run):
for rh in hosts_of(run, index):
if rh.id in skips:
rh.status, rh.detail = "skipped", skips[rh.id]
elif rh.id in offers:
rh.status, rh.detail = "queued", None
rh.order = ordered.index(rh.id)
rh.version_before = versions.get(rh.id)
w = wave_row(run, index)
w.baseline = baselines
if run.target_version is None and target:
run.target_version = target
_progress(run, preflight_started=None, preflight_requested_at=None, blocked_since=None, cluster_recheck_at=None)
if not offers:
w.status, w.finished_at = "skipped", _now()
events = [("wave", "skipped", {"wave": index})]
events += _next_wave(run)
return events
w.status = "running"
run.status = "wave_running"
return [("wave", "started", {"wave": index, "target_version": run.target_version,
"hosts": [usable[i].name for i in ordered], "skipped": len(skips)})]
return apply_ready
def _next_wave(run: RolloutRun) -> list:
index = run.current_wave + 1
if index >= len(run.waves):
run.status, run.finished_at = "succeeded", _now()
return [("finish", "succeeded")]
run.current_wave = index
w = wave_row(run, index)
if wave_spec(run, index).get("require_approval"):
w.status = run.status = "awaiting_approval"
return [("wave", "awaiting_approval", {"wave": index})]
w.status, run.status = "preflight", "preflight"
return []
async def _handle_wave_running(db: AsyncSession, run: RolloutRun) -> Decision | None:
if any(h.status in HOST_OPEN for h in run.hosts):
return None # strictly one host at a time
index = run.current_wave
queued = [h for h in hosts_of(run, index) if h.status == "queued"]
if not queued:
soak = int(wave_spec(run, index).get("soak_minutes") or 0)
async def apply_soak(db, run):
w = wave_row(run, index)
w.status, w.soak_until = "soaking", _now() + timedelta(minutes=soak)
run.status = "soaking"
return [("wave", "soaking", {"wave": index, "minutes": soak})]
return apply_soak
if problem := await _actor_problem(db, run):
return problem
reason = await _may_start_now(db, run)
if reason:
return _to_waiting(reason)
nxt = queued[0]
host = await db.get(OpnsenseHost, nxt.host_id) if nxt.host_id else None
if host is None or not host.enabled:
async def apply_skip(db, run):
rh = next(h for h in run.hosts if h.id == nxt.id)
rh.status, rh.detail = "skipped", _note("host_deleted" if host is None else "host_disabled")
return [("host", "skipped", {"host": nxt.host_name})]
return apply_skip
spec = wave_spec(run, index)
prog = run.progress or {}
if host.cluster_name:
fleet = await peers(db, host)
statuses = await get_statuses(fleet)
done_ids = {h.host_id for h in run.hosts if h.status == "succeeded"}
done_peers = [p for p in fleet if p.id in done_ids and p.id != host.id]
baselines = {}
for w in run.waves:
baselines.update(w.baseline or {})
# The cluster as a whole must be healthy before a node is touched; nodes done earlier in this run
# must pass their checks again (BACKUP updated -> now it may carry the traffic for the MASTER).
gate = await rollout_health.evaluate(
db, done_peers + [host], baselines, target_version=run.target_version,
checks={**(run.plan_snapshot.get("gate_checks") or {}), "carp": True, "compliance": False})
# The node itself is not updated yet: only its reachability, the cluster and the locks count for it.
failed = [f"{hid}:{c}" for hid, row in gate["hosts"].items() for c, r in row.items()
if r["result"] == "fail" and not (hid == str(host.id) and c in ("version", "gateways", "services"))]
if failed:
recheck = _ts(prog.get("cluster_recheck_at"))
if recheck is None:
async def apply_recheck(db, run):
_progress(run, cluster_recheck_at=_iso(_now() + GATE_RECHECK), cluster_gate=gate)
return [("cluster_gate", "recheck", {"host": host.name, "failed": failed})]
return apply_recheck
if _now() < recheck:
return None
async def apply_cluster_fail(db, run):
pause(run, "cluster_gate_failed", cluster=host.cluster_name, host=host.name, failed=_named(run, failed))
_progress(run, cluster_recheck_at=None, cluster_gate=gate)
return [("cluster_gate", "failed", {"host": host.name, "failed": failed})]
return apply_cluster_fail
if statuses.get(host.id, {}).get("carp_status") == "MASTER" and not spec.get("carp_handover"):
async def apply_master(db, run):
pause(run, "master_needs_handover", host=host.name, cluster=host.cluster_name)
return [("pause", "paused", {"reason": "master_needs_handover", "host": host.name})]
return apply_master
try:
await ensure_no_maintenance(db, [host])
except HTTPException:
since = _ts(prog.get("blocked_since"))
if since is None:
async def apply_blocked_start(db, run):
_progress(run, blocked_since=_iso(_now()))
return [("host", "waiting_for_lock", {"host": host.name})]
return apply_blocked_start
if _now() - since < BLOCKED_PATIENCE:
return None
async def apply_blocked(db, run):
pause(run, "blocked_by_maintenance", host=host.name)
_progress(run, blocked_since=None)
return [("pause", "paused", {"reason": "blocked_by_maintenance", "host": host.name})]
return apply_blocked
async def apply_start(db, run):
await policy_lock(db)
rh = next(h for h in run.hosts if h.id == nxt.id)
# Idempotency guard: a host that already has a schedule never gets a second one.
if rh.status != "queued" or rh.scheduled_maintenance_id is not None:
return []
now = _now()
sched = ScheduledMaintenance(
host_id=host.id, host_name=host.name, action=run.action, run_at=now, status="pending",
actor=run.started_by, created_at=now, carp_handover=bool(spec.get("carp_handover") and host.cluster_name),
auto_verify=True, origin="rollout",
progress={"rollout": {"run_id": str(run.id), "wave": index, "plan": run.plan_name}},
)
db.add(sched)
await db.flush()
rh.scheduled_maintenance_id, rh.status, rh.started_at = sched.id, "running", now
_progress(run, blocked_since=None, cluster_recheck_at=None)
return [("host", "started", {"host": host.name, "schedule_id": str(sched.id), "handover": sched.carp_handover})]
return apply_start
async def _handle_soaking(db: AsyncSession, run: RolloutRun) -> Decision | None:
w = wave_row(run, run.current_wave)
if w.soak_until and _now() < w.soak_until:
return None
async def apply(db, run):
w = wave_row(run, run.current_wave)
w.status, w.gate_attempts = "gate", 0
run.status = "gate"
_progress(run, gate_recheck_at=None)
return []
return apply
async def _handle_gate(db: AsyncSession, run: RolloutRun) -> Decision | None:
recheck = _ts((run.progress or {}).get("gate_recheck_at"))
if recheck and _now() < recheck:
return None
index = run.current_wave
w = wave_row(run, index)
done = [h for h in hosts_of(run, index) if h.status == "succeeded" and h.host_id]
hosts = [h for h in [await db.get(OpnsenseHost, d.host_id) for d in done] if h is not None]
gate = await rollout_health.evaluate(db, hosts, w.baseline or {}, target_version=run.target_version,
checks=run.plan_snapshot.get("gate_checks"),
compliance_mode=run.plan_snapshot.get("compliance_mode", "warn"))
async def apply(db, run):
w = wave_row(run, index)
w.gate_result = gate
w.gate_attempts = (w.gate_attempts or 0) + 1
failed = rollout_health.failed_checks(gate)
events = [("gate", gate["verdict"], {"wave": index, "attempt": w.gate_attempts, "failed": failed, "result": gate})]
if gate["verdict"] == "fail":
if w.gate_attempts < 2:
_progress(run, gate_recheck_at=_iso(_now() + GATE_RECHECK))
return events
_progress(run, gate_recheck_at=None)
pause(run, "gate_failed", wave=w.label, failed=_named(run, failed))
return events + [("pause", "paused", {"reason": "gate_failed"})]
w.status, w.finished_at = "passed", _now()
_progress(run, gate_recheck_at=None)
return events + _next_wave(run)
return apply
_HANDLERS = {
"waiting_window": _handle_waiting_window,
"resuming": _handle_resuming,
"preflight": _handle_preflight,
"wave_running": _handle_wave_running,
"soaking": _handle_soaking,
"gate": _handle_gate,
}
# ── automatic start at a window occurrence ────────────────────────────────────
async def auto_start(db: AsyncSession) -> int:
started = 0
plans = (await db.scalars(select(RolloutPlan).where(
RolloutPlan.auto_start.is_(True), RolloutPlan.activated_at.is_not(None), RolloutPlan.window_id.is_not(None)))).all()
for plan in plans:
window = await db.get(MaintenanceWindow, plan.window_id)
occ = window_service.startable(window, _now()) if window else None
if occ is None:
continue
if await db.scalar(select(RolloutRun.id).where(RolloutRun.plan_id == plan.id, RolloutRun.window_occurrence == occ.start)):
continue
if (plan.auto_start_error or {}).get("occurrence") == _iso(occ.start):
continue # already reported for this occurrence
await policy_lock(db)
plan = await rollout_service.load_plan(db, plan.id)
if await db.scalar(select(RolloutRun.id).where(RolloutRun.plan_id == plan.id, RolloutRun.window_occurrence == occ.start)):
continue # another backend started it while this one waited for the lock (not a refusal)
resolved = await rollout_service.resolve(db, plan)
problem = None
if plan.action != "update":
problem = _note("auto_start_update_only")
elif plan.activated_fingerprint != rollout_service.fingerprint(plan, resolved):
problem = _note("plan_changed") # someone changed the plan, its groups or its window since activation
elif not await may_roll_out(db, plan.activated_by or ""):
problem = _note("actor_invalid", user=plan.activated_by)
elif resolved["errors"]:
problem = _note("plan_invalid", reason=resolved["errors"][0]["code"])
elif (other := await active_run(db)) is not None:
problem = _note("other_run_active", plan=other.plan_name)
if problem:
plan.auto_start_error = {"occurrence": _iso(occ.start), "at": _iso(_now()), **problem}
await db.commit()
token = audit_service.context.set({"actor": "system:rollout", "id": str(plan.id)})
try:
await audit_service.persist(kind="rollout", action="auto_start", status="refused", entity_id=str(plan.id),
entity_name=plan.name, details=plan.auto_start_error)
finally:
audit_service.context.reset(token)
continue
try:
run = await create_run(db, plan, resolved, started_by=plan.activated_by, trigger="window", occurrence=occ.start)
plan.auto_start_error = None
await db.commit()
except IntegrityError:
await db.rollback() # another backend started it for this occurrence
continue
started += 1
await _audit(run, "start", "started", trigger="window", occurrence=_iso(occ.start),
hosts=sum(len(w["hosts"]) for w in resolved["waves"]))
await db.commit()
return started
# ── human actions (called by the router under policy_lock) ────────────────────
async def count_active(db: AsyncSession) -> int:
return await db.scalar(select(func.count()).select_from(RolloutRun).where(RolloutRun.status.in_(ACTIVE))) or 0
+218
View File
@@ -0,0 +1,218 @@
"""Health gate of a firmware rollout (1.25): is a host, after its update, as healthy as before?
``baseline(db, host)`` is taken right before a wave starts, ``evaluate(...)`` after the soak time
(and before each node of an already touched cluster, and on resume). Every check of every host
yields ``{"result": ok|warn|fail|skip, "code": <machine code>, "params": {...}}``; the UI translates
the code (rollouts.gate.code.*), so no German prose travels through here.
What the checks look at (all read-only on the firewall, except that the compliance check downloads
the configuration like the 6-hourly security check does):
* online — enabled, the API answers, firmware job idle (``running == ready``).
* version — the installed version is the rollout's target version.
* carp — per cluster: every node online, exactly one MASTER per VHID, no node in CARP
maintenance mode, no CARP auto-revert timer running.
* gateways — gateways that were up in the baseline are up again; a gateway that was already bad
before only warns (1.24 ``get_gateway_health``).
* services — services that ran in the baseline run again.
* locks — no open maintenance operation, restore or unconfirmed deployment in the host/cluster.
* compliance — security score not lower than before: warn (default) or fail. A weak signal: an
update may legitimately change defaults.
A reading that cannot be taken is never "ok": unreadable now but readable in the baseline fails,
unreadable in both is "skip" (nothing to compare; e.g. an API key without that permission).
"""
import asyncio
from collections import defaultdict
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.carp_maintenance_window import CarpMaintenanceWindow
from app.models.compliance_result import ComplianceResult
from app.models.host import OpnsenseHost
from app.services import compliance_service, gateway_health_service, opnsense_client as client
from app.services.host_maintenance_service import _shared_change_blockers, peers
from app.services.host_status_service import get_statuses
from app.services.resource_monitor_service import _services_compact
CHECKS = ("online", "version", "carp", "gateways", "services", "locks", "compliance")
DEFAULT_CHECKS = {"online": True, "version": True, "carp": True, "gateways": True, "services": True, "locks": True,
"compliance": False}
ALWAYS_ON = ("online", "version", "locks") # a rollout without these would be blind
_RANK = {"skip": 0, "ok": 0, "warn": 1, "fail": 2}
def _r(result: str, code: str, **params) -> dict:
return {"result": result, "code": code, "params": params}
async def _optional(coro):
try:
return await coro
except client.OpnsenseAPIError:
return None
async def _gateways(host) -> dict | None:
gws = await _optional(gateway_health_service.get_gateway_health(host))
return None if gws is None else {g.name: g.state for g in gws}
async def _services(host) -> dict | None:
listing = await _optional(client.search_services(host))
return None if listing is None else _services_compact(listing)
async def baseline(db: AsyncSession, host: OpnsenseHost) -> dict:
info, gateways, services = await asyncio.gather(
_optional(client.get_firmware_info(host)), _gateways(host), _services(host))
score = await db.scalar(select(ComplianceResult.score).where(ComplianceResult.host_id == host.id))
return {
"version": (info or {}).get("product_version"),
"gateways": gateways,
"services": services,
"compliance_score": score,
}
def _check_gateways(before: dict | None, now: dict | None) -> dict:
if now is None:
return _r("skip", "unreadable_both") if before is None else _r("fail", "unreadable")
if before is None:
bad = sorted(n for n, s in now.items() if s == "offline")
return _r("warn", "gateway_down", names=", ".join(bad)) if bad else _r("ok", "no_baseline")
down = sorted(n for n, s in before.items() if s in ("online", "unknown") and now.get(n) == "offline")
gone = sorted(n for n in before if n not in now)
degraded = sorted(n for n, s in now.items() if s == "degraded" and before.get(n) != "degraded")
still_bad = sorted(n for n, s in before.items() if s in ("offline", "degraded") and now.get(n) in ("offline", "degraded"))
# "unknown" (not monitored) going to "offline" is a real change too: monitoring just started and reports down.
if down:
return _r("fail", "gateway_down", names=", ".join(down))
if gone:
return _r("warn", "gateway_missing", names=", ".join(gone))
if degraded:
return _r("warn", "gateway_degraded", names=", ".join(degraded))
if still_bad:
return _r("warn", "gateway_bad_before", names=", ".join(still_bad))
return _r("ok", "ok")
def _check_services(before: dict | None, now: dict | None) -> dict:
if now is None:
return _r("skip", "unreadable_both") if before is None else _r("fail", "unreadable")
if before is None:
return _r("ok", "no_baseline")
stopped = sorted(name.split("/")[0] for name, running in before.items() if running == 1 and now.get(name) != 1)
if stopped:
return _r("fail", "service_stopped", names=", ".join(dict.fromkeys(stopped)))
return _r("ok", "ok")
async def _check_carp(db: AsyncSession, fleet: list[OpnsenseHost], statuses: dict) -> dict:
offline = sorted(h.name for h in fleet if h.enabled and statuses.get(h.id, {}).get("status") != "online")
if offline:
return _r("fail", "node_offline", names=", ".join(offline))
online = [h for h in fleet if statuses.get(h.id, {}).get("status") == "online"]
demoted = sorted(h.name for h in online if statuses[h.id].get("carp_maintenance_mode"))
if demoted:
return _r("fail", "maintenance_mode", names=", ".join(demoted))
timers = (await db.scalars(select(CarpMaintenanceWindow.host_name).where(
CarpMaintenanceWindow.host_id.in_([h.id for h in fleet]), CarpMaintenanceWindow.status == "active"))).all()
if timers:
return _r("fail", "auto_revert_active", names=", ".join(sorted(timers)))
masters: dict[str, int] = defaultdict(int)
broken: set[str] = set()
for h in online:
for vhid, state in (statuses[h.id].get("carp_vips") or {}).items():
masters[vhid] += state == "MASTER"
if state not in ("MASTER", "BACKUP"):
broken.add(vhid)
wrong = sorted(set(v for v, n in masters.items() if n != 1) | broken, key=lambda v: (len(v), v))
if wrong:
return _r("fail", "vhid_roles", vhids=", ".join(wrong))
if not masters and not any(statuses[h.id].get("carp_status") == "MASTER" for h in online):
return _r("fail", "no_master")
return _r("ok", "ok")
async def evaluate(db: AsyncSession, hosts: list[OpnsenseHost], baselines: dict, *, target_version: str | None,
checks: dict | None = None, compliance_mode: str = "warn") -> dict:
"""{"hosts": {host_id: {check: result}}, "verdict": ok|warn|fail}. ``baselines`` is keyed by str(host.id)."""
enabled = {**DEFAULT_CHECKS, **(checks or {})}
for name in ALWAYS_ON:
enabled[name] = True
results: dict[str, dict] = {}
fleets: dict[str, list[OpnsenseHost]] = {}
for host in hosts:
fleets[str(host.id)] = await peers(db, host) if host.cluster_name else [host]
every = {h.id: h for fleet in fleets.values() for h in fleet}
statuses = await get_statuses(list(every.values()))
carp_cache: dict[str, dict] = {}
for host in hosts:
hid = str(host.id)
before = baselines.get(hid) or {}
row: dict[str, dict] = {}
st = statuses.get(host.id, {})
running = await _optional(client.get_firmware_running(host)) if st.get("status") == "online" else None
if not host.enabled:
row["online"] = _r("fail", "disabled")
elif st.get("status") != "online":
row["online"] = _r("fail", "offline")
elif (running or {}).get("status") != "ready":
row["online"] = _r("fail", "firmware_busy")
else:
row["online"] = _r("ok", "ok")
reachable = row["online"]["result"] == "ok"
if enabled["version"]:
info = await _optional(client.get_firmware_info(host)) if reachable else None
version = (info or {}).get("product_version")
if not target_version:
row["version"] = _r("skip", "no_target")
elif version is None:
row["version"] = _r("fail", "unreadable")
elif version != target_version:
row["version"] = _r("fail", "version_mismatch", expected=target_version, actual=version)
else:
row["version"] = _r("ok", "ok", actual=version)
if enabled["carp"]:
if not host.cluster_name:
row["carp"] = _r("skip", "no_cluster")
else:
if host.cluster_name not in carp_cache:
carp_cache[host.cluster_name] = await _check_carp(db, fleets[hid], statuses)
row["carp"] = carp_cache[host.cluster_name]
if enabled["gateways"]:
row["gateways"] = _check_gateways(before.get("gateways"), await _gateways(host) if reachable else None)
if enabled["services"]:
row["services"] = _check_services(before.get("services"), await _services(host) if reachable else None)
blockers = await _shared_change_blockers(db, fleets[hid])
row["locks"] = _r("fail", "open_locks", count=len(blockers)) if blockers else _r("ok", "ok")
if enabled["compliance"]:
base_score = before.get("compliance_score")
if base_score is None:
row["compliance"] = _r("skip", "no_baseline")
elif not reachable:
row["compliance"] = _r("fail", "unreadable")
else:
fresh = await compliance_service.check_host(db, host)
if fresh.score is None:
row["compliance"] = _r("warn", "unreadable")
elif fresh.score < base_score:
row["compliance"] = _r("fail" if compliance_mode == "fail" else "warn", "score_lower",
before=base_score, after=fresh.score)
else:
row["compliance"] = _r("ok", "ok", before=base_score, after=fresh.score)
results[hid] = row
worst = max((_RANK[c["result"]] for row in results.values() for c in row.values()), default=0)
return {"hosts": results, "verdict": ("ok", "warn", "fail")[worst]}
def failed_checks(gate: dict) -> list[str]:
"""Flat "host-id:check" list of everything that failed (for notifications and the audit trail)."""
return [f"{hid}:{name}" for hid, row in (gate.get("hosts") or {}).items() for name, c in row.items() if c["result"] == "fail"]
+138
View File
@@ -0,0 +1,138 @@
"""Rollout plans: resolving waves to hosts, validation, preview token / activation fingerprint.
The run engine (rollout_engine.py) builds on ``resolve``: what a preview shows is exactly what a run
freezes when it starts.
"""
import hashlib
import json
from datetime import datetime, timezone
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.orm import selectinload
from app.models.host import OpnsenseHost
from app.models.maintenance_window import MaintenanceWindow
from app.models.policy import DeviceGroup
from app.models.rollout import RolloutPlan
from app.services import rollout_health, window_service
# Hard limits: an unattended engine that fires firmware updates must stay small and explainable.
MAX_WAVES = 10
MAX_HOSTS = 100
MAX_SOAK_MINUTES = 24 * 60
def _issue(code: str, **params) -> dict:
return {"code": code, "params": params}
async def resolve(db: AsyncSession, plan: RolloutPlan) -> dict:
"""Waves with their hosts (a host in several waves belongs to the earliest), errors that block a
start/activation, and warnings."""
errors: list[dict] = []
warnings: list[dict] = []
seen: dict = {}
duplicates: set[str] = set()
waves = []
group_ids = {g.id for w in plan.waves for g in w.groups}
groups = {g.id: g for g in (await db.scalars(
select(DeviceGroup).where(DeviceGroup.id.in_(group_ids)).options(selectinload(DeviceGroup.hosts)))).all()} if group_ids else {}
for index, wave in enumerate(plan.waves):
hosts: list[OpnsenseHost] = []
for group in sorted(wave.groups, key=lambda g: g.name):
for host in sorted(groups[group.id].hosts, key=lambda h: h.name):
if host.id in seen:
if seen[host.id] != index:
duplicates.add(host.name)
continue
seen[host.id] = index
hosts.append(host)
if not hosts:
warnings.append(_issue("empty_wave", wave=wave.label))
clusters = sorted({h.cluster_name for h in hosts if h.cluster_name})
if clusters and not wave.carp_handover:
warnings.append(_issue("master_needs_handover", wave=wave.label, clusters=", ".join(clusters)))
waves.append({
"index": index, "label": wave.label, "soak_minutes": wave.soak_minutes, "carp_handover": wave.carp_handover,
"require_approval": wave.require_approval, "groups": sorted(g.name for g in wave.groups),
"hosts": [{"id": str(h.id), "name": h.name, "cluster_name": h.cluster_name, "enabled": h.enabled} for h in hosts],
})
if duplicates:
warnings.append(_issue("duplicate_hosts", names=", ".join(sorted(duplicates))))
all_hosts = [h for w in waves for h in w["hosts"]]
disabled = sorted(h["name"] for h in all_hosts if not h["enabled"])
if disabled:
warnings.append(_issue("disabled_hosts", names=", ".join(disabled)))
if not plan.waves:
errors.append(_issue("no_waves"))
elif not all_hosts:
errors.append(_issue("no_hosts"))
if len(plan.waves) > MAX_WAVES:
errors.append(_issue("too_many_waves", limit=MAX_WAVES))
if len(all_hosts) > MAX_HOSTS:
errors.append(_issue("too_many_hosts", limit=MAX_HOSTS))
# Clusters: where are their nodes?
cluster_names = sorted({h["cluster_name"] for h in all_hosts if h["cluster_name"]})
for cluster in cluster_names:
members = (await db.scalars(select(OpnsenseHost.id).where(OpnsenseHost.cluster_name == cluster))).all()
in_plan = {h["id"]: w["index"] for w in waves for h in w["hosts"] if h["cluster_name"] == cluster}
partial = len(in_plan) < len(members)
split = len(set(in_plan.values())) > 1
if plan.action == "major_update" and (partial or split):
# Never two major releases side by side in one cluster longer than one wave.
errors.append(_issue("cluster_split", cluster=cluster))
elif partial:
warnings.append(_issue("cluster_partial", cluster=cluster))
elif split:
warnings.append(_issue("mixed_versions", cluster=cluster, wave=waves[max(in_plan.values())]["label"]))
window = await db.get(MaintenanceWindow, plan.window_id) if plan.window_id else None
if plan.auto_start and plan.action != "update":
errors.append(_issue("auto_start_update_only"))
if plan.auto_start and window is None:
errors.append(_issue("auto_start_needs_window"))
if window is None:
warnings.append(_issue("no_window"))
elif not window.enabled:
warnings.append(_issue("window_disabled"))
now = datetime.now(timezone.utc)
return {
"waves": waves, "errors": errors, "warnings": warnings,
"window": {"id": str(window.id), "name": window.name, "definition": window_service.definition(window),
"next": [o.as_dict() for o in window_service.occurrences(window, now, 3)] if window.enabled else []}
if window else None,
}
def definition(plan: RolloutPlan) -> dict:
return {
"id": str(plan.id), "name": plan.name, "action": plan.action, "window_id": str(plan.window_id) if plan.window_id else None,
"auto_start": plan.auto_start, "gate_checks": effective_checks(plan.gate_checks), "compliance_mode": plan.compliance_mode,
"waves": [{"position": w.position, "label": w.label, "soak_minutes": w.soak_minutes, "carp_handover": w.carp_handover,
"require_approval": w.require_approval, "group_ids": sorted(str(g.id) for g in w.groups)} for w in plan.waves],
}
def effective_checks(checks: dict | None) -> dict:
merged = {**rollout_health.DEFAULT_CHECKS, **{k: bool(v) for k, v in (checks or {}).items() if k in rollout_health.CHECKS}}
for name in rollout_health.ALWAYS_ON:
merged[name] = True
return merged
def fingerprint(plan: RolloutPlan, resolved: dict) -> str:
"""Covers the plan, every resolved host (id, name, cluster, enabled) and the window definition: a change
to any of them invalidates a preview and stops an activated automatic start."""
state = {
"plan": definition(plan),
"hosts": [[w["index"], h["id"], h["name"], h["cluster_name"], h["enabled"]] for w in resolved["waves"] for h in w["hosts"]],
"window": (resolved.get("window") or {}).get("definition"),
}
return hashlib.sha256(json.dumps(state, sort_keys=True, default=str).encode()).hexdigest()
async def load_plan(db: AsyncSession, plan_id) -> RolloutPlan | None:
return await db.scalar(
select(RolloutPlan).where(RolloutPlan.id == plan_id).execution_options(populate_existing=True))
+4 -13
View File
@@ -20,26 +20,17 @@ from app.models.host import OpnsenseHost
from app.models.rule import FirewallRule
from app.models.rule_deployment import RuleDeployment
from app.services import opnsense_client
from app.services.adopt_common import NotAdoptable, NotFoundOnHost, clean, on # noqa: F401 (NotAdoptable is re-exported for routers/rules.py)
from app.services.policy_service import revision
from app.services.rule_deploy_service import _build_payload
class RuleNotFoundOnHost(Exception):
class RuleNotFoundOnHost(NotFoundOnHost):
pass
class NotAdoptable(Exception):
def __init__(self, reasons: list[str]):
super().__init__(", ".join(reasons))
self.reasons = reasons
def _on(value) -> bool:
return value in ("1", 1, True)
def _clean(value) -> str:
return "" if value is None else str(value).strip()
_on = on
_clean = clean
def reasons_not_adoptable(row: dict, managed_uuids: set[str]) -> list[str]:
@@ -0,0 +1 @@
"""Rule analysis (1.26): which firewall rule decides a packet, with honest confidence."""
@@ -0,0 +1,159 @@
"""Everything about one firewall the analysis needs, fetched read-only and cached briefly.
Sources (see the evidence block in opnsense_client.py): ``firewall/filter/searchRule`` (all
rules incl. automatic ones, with ``sort_order``), ``diagnostics/firewall/pfStatistics/rules``
(what pf has loaded), ``interfaces/overview/interfacesInfo`` (identifier, device, addresses
incl. CARP VIPs, gateways), ``firewall/group/searchItem`` (interface groups),
``firewall/alias/searchItem`` (alias definitions), ``firewall/d_nat/searchRule`` (port
forwards, only to warn about NAT) and, per queried IP, ``firewall/alias_util/findReferences``.
Optional sources may fail; the analysis then lowers its confidence instead of guessing.
"""
from __future__ import annotations
import asyncio
import ipaddress
import logging
import time
from dataclasses import dataclass, field
from app.models.host import OpnsenseHost
from app.services import opnsense_client
from app.services.rule_analysis import pf_ruleset
from app.services.rule_analysis.model import IPAddr, IPNet
logger = logging.getLogger(__name__)
CACHE_SECONDS = 60
# Built-in interface groups whose members are the matching dynamic devices.
BUILTIN_GROUP_DEVICES = {"wireguard": ("wg",), "openvpn": ("ovpns", "ovpnc"), "enc0": ("enc0",)}
@dataclass
class IfInfo:
identifier: str
device: str
description: str
nets: list[IPNet] = field(default_factory=list)
addrs: list[IPAddr] = field(default_factory=list) # primary addresses
vips: list[IPAddr] = field(default_factory=list) # CARP / alias VIPs on this interface
has_gateway: bool = False
@dataclass
class Context:
rows: list[dict]
pf: pf_ruleset.PfRuleset | None
interfaces: dict[str, IfInfo]
groups: dict[str, set[str]] | None # name -> member identifiers; None = unknown
aliases: dict[str, dict]
port_forwards: list[dict] | None
refs: dict[str, list[str] | None] = field(default_factory=dict)
notes: list[str] = field(default_factory=list)
loaded_at: float = 0.0
@property
def self_addrs(self) -> list[IPAddr]:
addrs = [a for i in self.interfaces.values() for a in (*i.addrs, *i.vips)]
return addrs + [ipaddress.ip_address("127.0.0.1"), ipaddress.ip_address("::1")]
def by_device(self, device: str) -> IfInfo | None:
return next((i for i in self.interfaces.values() if i.device == device), None)
def by_label(self, label: str) -> IfInfo | None:
lowered = label.strip().lower()
return self.interfaces.get(lowered) or next(
(i for i in self.interfaces.values() if i.description.lower() == lowered), None)
def _interfaces(info: dict) -> dict[str, IfInfo]:
result: dict[str, IfInfo] = {}
for row in (info or {}).get("rows", []) or []:
identifier = str(row.get("identifier") or "").strip()
if not identifier:
continue
item = IfInfo(identifier=identifier, device=str(row.get("device") or ""),
description=str(row.get("description") or identifier),
has_gateway=bool(row.get("gateways")) or "default" in (row.get("routes") or []))
for entry in [*(row.get("ipv4") or []), *(row.get("ipv6") or [])]:
try:
iface = ipaddress.ip_interface(str(entry.get("ipaddr")).split("%")[0])
except ValueError:
continue
(item.vips if entry.get("vhid") or entry.get("vip") else item.addrs).append(iface.ip)
if iface.network not in item.nets:
item.nets.append(iface.network)
result[identifier] = item
return result
def _groups(data: dict | None, interfaces: dict[str, IfInfo]) -> dict[str, set[str]] | None:
if not isinstance(data, dict) or not isinstance(data.get("rows"), list):
return None
groups: dict[str, set[str]] = {}
for row in data["rows"]:
name = str(row.get("ifname") or "")
members = {m.strip() for m in str(row.get("members") or "").split(",") if m.strip()}
prefixes = BUILTIN_GROUP_DEVICES.get(name)
if prefixes:
members |= {i.identifier for i in interfaces.values() if i.device.startswith(prefixes)}
if name:
groups[name] = members
return groups
async def _optional(coro, note: str, notes: list[str]):
try:
return await coro
except Exception as exc: # noqa: BLE001 - optional source: degrade, never fail the analysis
logger.info("rule analysis: optional source failed (%s): %s", note, exc)
notes.append(note)
return None
_CACHE: dict[str, Context] = {}
async def load_context(host: OpnsenseHost, *, use_cache: bool = True) -> Context:
key = str(host.id)
cached = _CACHE.get(key)
if use_cache and cached and time.monotonic() - cached.loaded_at < CACHE_SECONDS:
return cached
notes: list[str] = []
rules, info = await asyncio.gather(
opnsense_client.search_rules(host, all_rows=True), opnsense_client.get_interfaces_info(host))
stats, groups, aliases, forwards = await asyncio.gather(
_optional(opnsense_client.get_pf_rule_statistics(host), "PF_RULESET_UNAVAILABLE", notes),
_optional(opnsense_client.search_interface_groups(host), "GROUPS_UNAVAILABLE", notes),
_optional(opnsense_client._request(host, "GET", "/firewall/alias/searchItem", params={"rowCount": -1}),
"ALIASES_UNAVAILABLE", notes),
_optional(opnsense_client.search_port_forward_rules(host), "NAT_UNAVAILABLE", notes),
)
interfaces = _interfaces(info)
pf = pf_ruleset.parse(stats)
if stats is not None and pf is None:
notes.append("PF_RULESET_UNAVAILABLE")
ctx = Context(
rows=list((rules or {}).get("rows") or []), pf=pf, interfaces=interfaces,
groups=_groups(groups, interfaces),
aliases={str(a.get("name")): a for a in ((aliases or {}).get("rows") or []) if a.get("name")},
port_forwards=None if forwards is None else list(forwards.get("rows") or []),
notes=notes, loaded_at=time.monotonic(),
)
_CACHE[key] = ctx
return ctx
async def ensure_refs(host: OpnsenseHost, ctx: Context, ips: list[str]) -> None:
"""Ask pf which tables contain each IP (cached in the context)."""
for ip in ips:
if ip in ctx.refs:
continue
try:
ctx.refs[ip] = await opnsense_client.find_alias_references(host, ip)
except Exception as exc: # noqa: BLE001 - table membership becomes "unknown"
logger.info("rule analysis: findReferences failed: %s", exc)
ctx.refs[ip] = None
def clear_cache() -> None:
_CACHE.clear()
@@ -0,0 +1,317 @@
"""Which rule decides a packet, following pf semantics.
pf walks the loaded ruleset top to bottom; the *last* matching rule wins unless a matching
rule is ``quick``, which ends the walk. OPNsense orders rules by ``sort_order`` (system,
floating, groups, interfaces). The analysis looks at the first packet of a new connection.
Confidence:
- ``rule_confidence`` is "sure" only when no rule that could still change the outcome
matched with an unknown result;
- ``confidence`` (the verdict) is "sure" when every such unknown rule has the same action as
the deciding rule (then the verdict holds either way), "unknown" otherwise;
- notes about guesses (interface guessed from the address, NAT nearby, pf ruleset missing,
TCP flags, rate limits) lower a "sure" to "probable".
"""
from __future__ import annotations
import ipaddress
from dataclasses import dataclass, field
from app.services.rule_analysis import resolve
from app.services.rule_analysis.context import Context
from app.services.rule_analysis.model import IPAddr, NormRule, Outcome, t_and, tri_str
from app.services.rule_analysis.normalize import norm_proto, normalize
SURE, PROBABLE, UNKNOWN = "sure", "probable", "unknown"
_RANK = {SURE: 2, PROBABLE: 1, UNKNOWN: 0}
DOWNGRADING_NOTES = {
"IFACE_GUESSED", "EGRESS_GUESSED", "NAT_NEARBY", "TCP_FLAGS", "RATE_LIMIT", "ORDER_GUESSED",
"ORDER_MISMATCH", "PF_RULESET_UNAVAILABLE", "NAT_UNAVAILABLE", "QUICK_UNKNOWN",
}
_PORT_PROTOS = {"6", "17"}
_ICMP_PROTOS = {"1", "58"}
ICMP_NAMES = {
4: {"0": "echorep", "3": "unreach", "4": "squench", "5": "redir", "8": "echoreq", "9": "routeradv",
"10": "routersol", "11": "timex", "12": "paramprob", "13": "timereq", "14": "timerep"},
6: {"1": "unreach", "2": "toobig", "3": "timex", "4": "paramprob", "128": "echoreq", "129": "echorep",
"133": "routersol", "134": "routeradv", "135": "neighbrsol", "136": "neighbradv", "137": "redir"},
}
@dataclass
class Query:
src: IPAddr
dst: IPAddr
proto: str # normalized ("6", "17", "1", "58", other number or name)
proto_label: str
sport: int | None = None
dport: int | None = None
icmptype: str | None = None
iface: str | None = None # None = guess from the source address
direction: str = "in"
egress: str | None = "none" # "none" = only the first leg, None = guess, else identifier
@property
def af(self) -> int:
return self.src.version
@dataclass
class LegResult:
direction: str
iface: str | None
iface_source: str
action: str | None
decisive: NormRule | None
confidence: str
rule_confidence: str
notes: list[str] = field(default_factory=list)
unknowns: list[str] = field(default_factory=list)
steps: list[dict] = field(default_factory=list)
def _min_conf(*values: str) -> str:
return min(values, key=lambda v: _RANK[v])
def _max_conf(*values: str) -> str:
return max(values, key=lambda v: _RANK[v])
def _icmp_name(q: Query) -> str | None:
if q.icmptype is None:
return None
return ICMP_NAMES[q.af].get(q.icmptype, q.icmptype)
def rule_fields(r: NormRule, q: Query, direction: str, iface: str, ctx: Context,
tags: set[str], first_leg_iface: str | None) -> dict[str, Outcome]:
fields: dict[str, Outcome] = {
"interface": resolve.iface_match(r.interfaces, r.if_not, iface, ctx),
"direction": Outcome(r.direction in ("any", direction)),
"family": Outcome(q.af in r.af),
"protocol": Outcome(True if r.protos is None else q.proto in r.protos),
"source": resolve.endpoint_match(r.src, q.src, ctx),
"destination": resolve.endpoint_match(r.dst, q.dst, ctx),
}
if q.proto in _PORT_PROTOS:
fields["source_port"] = resolve.port_match(r.sport, q.sport, ctx, ephemeral_default=True)
fields["destination_port"] = resolve.port_match(r.dport, q.dport, ctx)
elif r.sport or r.dport:
fields["ports"] = Outcome(False) # pf only generates port rules for tcp/udp
if r.icmptypes is not None and q.proto in _ICMP_PROTOS:
name = _icmp_name(q)
fields["icmp_type"] = Outcome(None, ["ICMP_TYPE_NOT_GIVEN"]) if name is None else \
Outcome(name in r.icmptypes or q.icmptype in r.icmptypes)
if r.tagged:
fields["tagged"] = Outcome(True) if r.tagged in tags else Outcome(None, ["TAGGED"])
if r.received_on:
if direction == "in":
fields["received_on"] = Outcome(r.received_on == iface)
elif first_leg_iface:
fields["received_on"] = Outcome(r.received_on == first_leg_iface)
else:
fields["received_on"] = Outcome(None, ["RECEIVED_ON"])
if r.action is None:
fields["action"] = Outcome(None, ["ACTION_UNKNOWN"])
return fields
def _step(r: NormRule, fields: dict[str, Outcome], result, effect: str) -> dict:
return {
"rule": r.summary(), "result": tri_str(result), "effect": effect,
"fields": {k: tri_str(v.value) for k, v in fields.items()},
"reasons": sorted({reason for v in fields.values() if v.value is None for reason in v.reasons}),
}
def eval_leg(rules: list[NormRule], q: Query, ctx: Context, direction: str, iface: str,
first_leg_iface: str | None = None) -> LegResult:
steps: list[dict] = []
candidate: NormRule | None = None
possible: list[tuple[NormRule, bool]] = [] # (rule, came after the current candidate)
tags: set[str] = set()
final: NormRule | None = None
for r in rules:
if not r.enabled:
steps.append({"rule": r.summary(), "result": "false", "effect": "disabled", "fields": {}, "reasons": []})
continue
if r.loaded is False:
steps.append({"rule": r.summary(), "result": "false", "effect": "not_loaded", "fields": {}, "reasons": []})
continue
fields = rule_fields(r, q, direction, iface, ctx, tags, first_leg_iface)
result = t_and(*(f.value for f in fields.values()))
if result is False:
steps.append(_step(r, fields, result, "no_match"))
continue
if result is None or r.quick is None:
possible.append((r, True))
steps.append(_step(r, fields, result, "possible"))
continue
if r.quick:
final = r
for s in steps:
if s["effect"] == "candidate":
s["effect"] = "overridden"
steps.append(_step(r, fields, result, "final"))
break
if candidate is not None:
for s in steps:
if s["effect"] == "candidate":
s["effect"] = "overridden"
candidate = r
possible = [(p, False) for p, _ in possible]
if r.tag:
tags.add(r.tag)
steps.append(_step(r, fields, result, "candidate"))
decisive = final or candidate
if final is None:
for s in steps:
if s["effect"] == "candidate":
s["effect"] = "decisive"
else:
steps[-1]["effect"] = "decisive"
action = decisive.action if decisive else "pass" # pf without any matching rule passes
# Unknown matches that could still change the outcome: quick (or quick-unknown) ones always,
# non-quick ones only after the deciding candidate (an earlier one is overridden anyway).
relevant = [p for p, after in possible if p.quick is not False or (final is None and after)]
rule_conf = SURE if not relevant else PROBABLE
conf = SURE if all(p.action == action for p in relevant) else UNKNOWN
unknowns = sorted({reason for s in steps if s["effect"] == "possible" for reason in s["reasons"]})
if any(p.quick is None for p, _ in possible):
unknowns = sorted({*unknowns, "QUICK_UNKNOWN"})
notes: list[str] = []
if decisive is None:
notes.append("PF_DEFAULT_PASS")
else:
notes += decisive.extra_notes
if decisive.gateway and action == "pass":
notes.append("POLICY_ROUTE")
if decisive.statetype.lower() == "none" or "no state" in getattr(decisive.pf_line, "text", ""):
notes.append("STATELESS")
if decisive.sched:
notes.append("SCHEDULE_NOW")
if any(s["effect"] == "not_loaded" and s["rule"]["loaded"] is False for s in steps):
notes.append("RULES_NOT_LOADED")
return LegResult(direction=direction, iface=iface, iface_source="given", action=action, decisive=decisive,
confidence=conf, rule_confidence=rule_conf, notes=notes, unknowns=unknowns, steps=steps)
def guess_iface(ip: IPAddr, ctx: Context) -> str | None:
"""The interface whose connected network holds ``ip`` (longest prefix), else the one with
the default gateway."""
best, best_len = None, -1
for info in ctx.interfaces.values():
if info.identifier == "lo0":
continue
for net in info.nets:
if net.version == ip.version and ip in net and net.prefixlen > best_len and not net.is_link_local:
best, best_len = info.identifier, net.prefixlen
if best:
return best
gateways = [i.identifier for i in ctx.interfaces.values() if i.has_gateway]
return gateways[0] if len(gateways) == 1 else None
def _nat_nearby(q: Query, iface: str, ctx: Context) -> bool:
for row in ctx.port_forwards or []:
if str(row.get("disabled") or "0") == "1" or str(row.get("enabled", "1")) == "0":
continue
if str(row.get("nordr") or "0") == "1": # "no rdr" exclusions (anti-lockout) redirect nothing
continue
if q.dport is not None and resolve.port_match(str(row.get("destination.port") or ""), q.dport, ctx).value is False:
continue
ifaces = {i.strip().lower() for i in str(row.get("interface") or "").split(",") if i.strip()}
if ifaces and iface not in ifaces:
continue
proto = str(row.get("protocol") or "").lower()
if proto and proto not in ("any", "tcp/udp") and norm_proto(proto) != q.proto:
continue
return True
return False
def evaluate(ctx: Context, q: Query) -> dict:
rules, order_notes = normalize(ctx)
context_notes = [*ctx.notes, *order_notes]
legs: list[LegResult] = []
iface, iface_source = q.iface, "given"
if iface is None:
iface, iface_source = guess_iface(q.src if q.direction == "in" else q.dst, ctx), "guessed"
if iface is None:
return _result(q, legs, context_notes + ["IFACE_UNRESOLVED"], unresolved=True)
first = eval_leg(rules, q, ctx, q.direction, iface)
first.iface_source = iface_source
if iface_source == "guessed":
first.notes.append("IFACE_GUESSED")
if q.direction == "in" and (ctx.port_forwards is None or _nat_nearby(q, iface, ctx)):
first.notes.append("NAT_NEARBY" if ctx.port_forwards is not None else "NAT_UNAVAILABLE")
legs.append(first)
if q.direction == "in" and q.egress != "none":
egress, source = q.egress, "given"
if egress is None:
egress, source = guess_iface(q.dst, ctx), "guessed"
if egress is None:
context_notes.append("EGRESS_UNRESOLVED")
else:
out = eval_leg(rules, q, ctx, "out", egress, first_leg_iface=iface)
out.iface_source = source
if source == "guessed":
out.notes.append("EGRESS_GUESSED")
legs.append(out)
return _result(q, legs, context_notes)
def _leg_conf(leg: LegResult, context_notes: list[str]) -> tuple[str, str]:
downgrade = any(n in DOWNGRADING_NOTES for n in (*leg.notes, *context_notes))
conf, rule_conf = leg.confidence, leg.rule_confidence
if downgrade:
conf = _min_conf(conf, PROBABLE)
rule_conf = _min_conf(rule_conf, PROBABLE)
return conf, rule_conf
def _result(q: Query, legs: list[LegResult], context_notes: list[str], unresolved: bool = False) -> dict:
leg_dicts, confs = [], []
for leg in legs:
conf, rule_conf = _leg_conf(leg, context_notes)
confs.append((leg, conf, rule_conf))
leg_dicts.append({
"direction": leg.direction, "interface": leg.iface, "interface_source": leg.iface_source,
"action": leg.action, "confidence": conf, "rule_confidence": rule_conf,
"decisive_rule": leg.decisive.summary() if leg.decisive else None,
"notes": sorted(set(leg.notes)), "unknowns": leg.unknowns,
})
if unresolved or not legs:
action, conf, rule_conf, decisive = None, UNKNOWN, UNKNOWN, None
else:
blocking = [c for c in confs if c[0].action != "pass"]
if blocking:
leg, _, rule_conf = blocking[0]
action, decisive = leg.action, leg.decisive
# Blocked if any blocking leg is right: the best of their confidences counts.
conf = _max_conf(*(c[1] for c in blocking))
if conf == SURE and any(c[0].action != action for c in blocking):
conf = PROBABLE
else:
leg, _, rule_conf = confs[0]
action, decisive = "pass", leg.decisive
conf = _min_conf(*(c[1] for c in confs))
return {
"query": {
"src": str(q.src), "dst": str(q.dst), "proto": q.proto_label, "sport": q.sport, "dport": q.dport,
"icmptype": q.icmptype, "direction": q.direction,
"assumptions": ["FIRST_PACKET"] + (["SRC_PORT_EPHEMERAL"] if q.sport is None and q.proto in _PORT_PROTOS else []),
},
"action": action, "confidence": conf, "rule_confidence": rule_conf,
"decisive_rule": decisive.summary() if decisive else None,
"notes": sorted({*context_notes, *(n for leg in legs for n in leg.notes)}),
"unknowns": sorted({u for leg in legs for u in leg.unknowns}),
"legs": leg_dicts,
"trace": [{"leg": i, "direction": leg.direction, "interface": leg.iface, "steps": leg.steps}
for i, leg in enumerate(legs)],
}
def parse_ip(value: str) -> IPAddr:
return ipaddress.ip_address(value.strip())
+122
View File
@@ -0,0 +1,122 @@
"""Shared types of the rule analysis: three-valued logic and the normalized rule.
``Tri`` is Kleene logic with ``True``/``False``/``None`` (unknown). An unknown never turns
into a definite answer by negation, and an AND is only False when one side is definitely
False. This is what keeps the engine from claiming "sure" for something it cannot prove.
"""
from __future__ import annotations
import ipaddress
from dataclasses import dataclass, field
from typing import Optional
Tri = Optional[bool]
IPAddr = ipaddress.IPv4Address | ipaddress.IPv6Address
IPNet = ipaddress.IPv4Network | ipaddress.IPv6Network
def t_and(*values: Tri) -> Tri:
if any(v is False for v in values):
return False
if any(v is None for v in values):
return None
return True
def t_or(*values: Tri) -> Tri:
if any(v is True for v in values):
return True
if any(v is None for v in values):
return None
return False
def t_not(value: Tri) -> Tri:
return None if value is None else not value
def tri_str(value: Tri) -> str:
return "unknown" if value is None else ("true" if value else "false")
class Outcome:
"""A Tri plus the reason codes that made it unknown (or noteworthy)."""
__slots__ = ("value", "reasons")
def __init__(self, value: Tri, reasons: tuple[str, ...] | list[str] = ()):
self.value = value
self.reasons = list(reasons)
def __repr__(self) -> str: # pragma: no cover - debugging aid
return f"Outcome({self.value!r}, {self.reasons!r})"
def o_or(outcomes: list[Outcome]) -> Outcome:
value = t_or(*(o.value for o in outcomes)) if outcomes else False
reasons = [] if value is True else [r for o in outcomes if o.value is None for r in o.reasons]
return Outcome(value, reasons)
SECTION_SYSTEM, SECTION_FLOATING, SECTION_GROUP, SECTION_INTERFACE = "system", "floating", "group", "interface"
SECTION_NAT_AUTO, SECTION_INVALID, SECTION_ANTISPOOF, SECTION_OTHER = "nat_auto", "invalid", "antispoof", "other"
@dataclass
class Endpoint:
raw: str
negated: bool = False
items: list[str] = field(default_factory=list) # empty = any
@property
def is_any(self) -> bool:
return not self.items
@dataclass
class NormRule:
uuid: str
label: str
description: str
order: tuple[int, int]
order_known: bool
section: str
enabled: bool
action: str | None # pass | block | reject | None (unknown)
quick: bool | None # None = unknown (automatic rule without pf ruleset)
interfaces: set[str] # identifiers or group names; empty = every interface
if_not: bool
direction: str # in | out | any
af: set[int] # {4}, {6} or {4, 6}
protos: set[str] | None # None = any; normalized names/numbers as strings
src: Endpoint
dst: Endpoint
sport: str
dport: str
icmptypes: set[str] | None = None # None = no restriction
tag: str = ""
tagged: str = ""
received_on: str = ""
gateway: str = ""
statetype: str = ""
sched: str = ""
automatic: bool = False
legacy: bool = False
loaded: bool | None = None # None = pf ruleset not available
pf_numbers: list[int] = field(default_factory=list)
extra_notes: list[str] = field(default_factory=list) # e.g. TCP_FLAGS, RATE_LIMIT from pf text
pf_line: object = None # set for unlabeled pf lines (antispoof)
def summary(self) -> dict:
return {
"uuid": self.uuid, "label": self.label, "description": self.description,
"section": self.section, "sort_order": f"{self.order[0]:06d}.{self.order[1]:07d}" if self.order_known else None,
"pf_numbers": self.pf_numbers, "action": self.action, "quick": self.quick,
"interfaces": sorted(self.interfaces), "interface_not": self.if_not, "direction": self.direction,
"automatic": self.automatic, "legacy": self.legacy, "loaded": self.loaded,
"editable": not self.automatic and not self.legacy and self.section != SECTION_ANTISPOOF,
"source": ("!" if self.src.negated else "") + (self.src.raw or "any"),
"destination": ("!" if self.dst.negated else "") + (self.dst.raw or "any"),
"source_port": self.sport or None, "destination_port": self.dport or None,
"gateway": self.gateway or None, "schedule": self.sched or None,
}
@@ -0,0 +1,211 @@
"""Turn ``searchRule`` rows (+ the loaded pf ruleset) into ``NormRule`` objects.
Format pitfalls seen live on OPNsense 26.7:
- automatic rows carry the interface *description* (``"LAN"``), MVC rows the identifier;
- automatic rows often have ``quick``/``action`` empty; the pf lines with the same label
know the truth (``pass in quick on vtnet1_vlan10 ...``);
- empty source/destination means any; address lists are comma separated;
- unmigrated legacy rules have a 32-hex label instead of a UUID.
Order is ``sort_order`` (``prio.0seq`` from FilterRuleField::getPriority: 1/5 system,
10000 force gateway, 200000 floating, 300000+n groups, 400000 interface, 500000 automatic
NAT, 600000 = interface missing, never loaded).
"""
from __future__ import annotations
from app.services.rule_analysis.context import Context
from app.services.rule_analysis.model import (
SECTION_ANTISPOOF, SECTION_FLOATING, SECTION_GROUP, SECTION_INTERFACE, SECTION_INVALID,
SECTION_NAT_AUTO, SECTION_OTHER, SECTION_SYSTEM, Endpoint, NormRule,
)
from app.services.rule_analysis.pf_ruleset import PfLine
PROTO_NUMBERS = {
"icmp": "1", "igmp": "2", "ggp": "3", "ipencap": "4", "tcp": "6", "egp": "8", "udp": "17",
"ipv6": "41", "gre": "47", "esp": "50", "ah": "51", "ipv6-icmp": "58", "icmp6": "58",
"icmpv6": "58", "ospf": "89", "pim": "103", "vrrp": "112", "carp": "112", "sctp": "132", "pfsync": "240",
}
def norm_proto(value: str) -> str:
value = str(value).strip().lower()
return PROTO_NUMBERS.get(value, value)
def _truthy(value) -> bool:
return value is True or str(value).strip().lower() in ("1", "true", "yes", "on")
def _section(prio: int) -> str:
if prio < 10001:
return SECTION_SYSTEM
if prio == 200000:
return SECTION_FLOATING
if 300000 <= prio < 400000:
return SECTION_GROUP
if prio == 400000:
return SECTION_INTERFACE
if prio == 500000:
return SECTION_NAT_AUTO
if prio >= 600000:
return SECTION_INVALID
return SECTION_OTHER
def _order(row: dict) -> tuple[tuple[int, int], bool]:
raw = str(row.get("sort_order") or "")
if "." in raw:
head, _, tail = raw.partition(".")
if head.isdigit() and tail.isdigit():
return (int(head), int(tail)), True
# Older releases without sort_order: best effort from prio_group/sequence (confidence drops).
prio = str(row.get("prio_group") or row.get("#priority") or "")
seq = str(row.get("sequence") or "")
return (int(prio) if prio.isdigit() else 400000, int(seq) if seq.isdigit() else 0), False
def _endpoint(row: dict, side: str) -> Endpoint:
raw = str(row.get(f"{side}_net") or "").strip()
items = [] if raw.lower() in ("", "any") else [i.strip() for i in raw.split(",") if i.strip()]
return Endpoint(raw=raw, negated=_truthy(row.get(f"{side}_not")), items=items)
def _af(value: str) -> set[int]:
value = str(value or "").strip().lower()
return {4} if value == "inet" else ({6} if value == "inet6" else {4, 6})
def _protos(value: str) -> set[str] | None:
value = str(value or "").strip().lower()
if value in ("", "any"):
return None
return {norm_proto(p) for p in value.split("/") if p}
def _pf_interfaces(lines: list[PfLine], ctx: Context) -> tuple[set[str], bool] | None:
devices = {(line.on_device, line.on_negated) for line in lines}
if any(device is None for device, _ in devices):
return set(), False
if len({neg for _, neg in devices}) != 1:
return None
names: set[str] = set()
for device, _ in devices:
info = ctx.by_device(device)
if info is not None:
names.add(info.identifier)
elif ctx.groups is not None and device in ctx.groups:
names.add(device)
else:
return None
return names, next(iter(devices))[1]
def normalize_row(row: dict, ctx: Context) -> NormRule:
order, order_known = _order(row)
label = str(row.get("uuid") or "")
automatic = _truthy(row.get("is_automatic"))
lines = ctx.pf.by_label.get(label, []) if ctx.pf else []
rule = NormRule(
uuid=label, label=label, description=str(row.get("description") or ""),
order=order, order_known=order_known, section=_section(order[0]),
enabled=_truthy(row.get("enabled", "1")),
action=(str(row.get("action") or "").lower() or None),
quick=None, interfaces=set(), if_not=_truthy(row.get("interfacenot")),
direction=(str(row.get("direction") or "in").lower() or "in"),
af=_af(row.get("ipprotocol")), protos=_protos(row.get("protocol")),
src=_endpoint(row, "source"), dst=_endpoint(row, "destination"),
sport=str(row.get("source_port") or "").strip(), dport=str(row.get("destination_port") or "").strip(),
tag=str(row.get("tag") or ""), tagged=str(row.get("tagged") or ""),
received_on=str(row.get("received-on") or row.get("received_on") or ""),
gateway=str(row.get("gateway") or ""), statetype=str(row.get("statetype") or ""),
sched=str(row.get("sched") or ""), automatic=automatic, legacy=_truthy(row.get("legacy")),
pf_numbers=[line.number for line in lines],
)
if rule.action not in ("pass", "block", "reject"):
rule.action = None
if row.get("quick") not in (None, ""):
rule.quick = _truthy(row.get("quick"))
raw_if = str(row.get("interface") or "").strip()
names = {n.strip() for n in raw_if.split(",") if n.strip()}
# Automatic and unmigrated legacy rows carry descriptions ("LAN"): map them to identifiers.
# Identifiers and group names stay as they are; the pf "on" clause decides when available.
mapped = set()
for name in names:
info = None if name in ctx.interfaces or name in (ctx.groups or {}) else ctx.by_label(name)
mapped.add(info.identifier if info else name)
names = mapped
rule.interfaces = names
if ctx.pf is not None:
rule.loaded = bool(lines) and rule.enabled
if lines:
actions = {line.action for line in lines}
if len(actions) == 1 and next(iter(actions)) in ("pass", "block", "reject"):
pf_action = next(iter(actions))
if rule.action is None or automatic:
rule.action = pf_action
quick = {line.quick for line in lines}
rule.quick = next(iter(quick)) if len(quick) == 1 else None
if automatic or rule.legacy:
on = _pf_interfaces(lines, ctx)
if on is not None:
rule.interfaces, rule.if_not = on
directions = {line.direction for line in lines}
if len(directions) == 1:
rule.direction = next(iter(directions))
families = {line.af for line in lines}
if None not in families:
rule.af &= families
types = {t for line in lines for t in line.icmptypes}
if types:
rule.icmptypes = types
if any(line.flags not in (None, "S/SA", "any") for line in lines):
rule.extra_notes.append("TCP_FLAGS")
if any(word in line.text for line in lines for word in ("max-src-", "overload", "max-pkt-rate")):
rule.extra_notes.append("RATE_LIMIT")
elif rule.section == SECTION_INVALID:
rule.loaded = False
if rule.icmptypes is None and str(row.get("icmptype") or "").strip():
rule.icmptypes = {t.strip() for t in str(row["icmptype"]).split(",") if t.strip()}
return rule
def antispoof_rule(line: PfLine, order: tuple[int, int]) -> NormRule:
"""An unlabeled pf line OPNsense generated itself (antispoof / own-address block)."""
return NormRule(
uuid=f"pf@{line.number}", label="", description=line.text, order=order, order_known=True,
section=SECTION_ANTISPOOF, enabled=True, action=line.action if line.action != "other" else None,
quick=line.quick, interfaces=set(), if_not=False, direction=line.direction,
af={line.af} if line.af else {4, 6}, protos=None,
src=Endpoint(raw="" if line.src == "any" else line.src, items=[] if line.src == "any" else [line.src]),
dst=Endpoint(raw="" if line.dst == "any" else line.dst, items=[] if line.dst == "any" else [line.dst]),
sport="", dport="", automatic=True, loaded=True, pf_numbers=[line.number], pf_line=line,
)
def normalize(ctx: Context) -> tuple[list[NormRule], list[str]]:
"""All rules in evaluation order plus context notes (order problems)."""
notes: list[str] = []
rules = [normalize_row(row, ctx) for row in ctx.rows]
if any(not r.order_known for r in rules):
notes.append("ORDER_GUESSED")
rules.sort(key=lambda r: (r.order, r.uuid))
if ctx.pf is not None:
loaded = [r for r in rules if r.loaded and r.pf_numbers]
firsts = [min(r.pf_numbers) for r in loaded]
if firsts != sorted(firsts):
notes.append("ORDER_MISMATCH")
# Unlabeled pf lines: placed before the first configured rule that pf evaluates later.
extra: list[tuple[tuple, NormRule]] = []
for line in ctx.pf.unlabeled:
after = next((r for r in loaded if min(r.pf_numbers) > line.number), None)
key = after.order if after else (999999, 9999999)
spoof = antispoof_rule(line, key)
if line.on_device:
info = ctx.by_device(line.on_device)
spoof.interfaces = {info.identifier if info else line.on_device}
spoof.if_not = line.on_negated
extra.append(((key, 0, line.number), spoof))
keyed = [((r.order, 1, 0), r) for r in rules] + extra
keyed.sort(key=lambda item: item[0])
rules = [r for _, r in keyed]
return rules, notes
@@ -0,0 +1,93 @@
"""The ruleset pf has actually loaded (``diagnostics/firewall/pfStatistics/rules``).
Each key looks like ``@76 pass in quick on vtnet1_vlan10 inet from (...) to any flags S/SA
keep state label "<uuid>"``. One configured rule can expand to several pf lines (address
families, ICMP types, port lists); they share one label. Lines without a label are generated
by OPNsense itself (antispoof: ``block drop in log on ! vtnet1_vlan10 inet from 192.0.2.0/24
to any``). Only what the analysis needs is parsed: position, action, quick, direction, the
``on`` interface, address family, ICMP types and a few pf options that make the answer
uncertain.
"""
from __future__ import annotations
import re
from dataclasses import dataclass, field
_HEAD = re.compile(r"^@(\d+)\s+(.*)$")
_LABEL = re.compile(r'label "([^"]+)"')
_ON = re.compile(r"\bon (!\s*)?([A-Za-z0-9_.]+)")
_ICMP = re.compile(r"\bicmp6?-type (\S+)")
_FROM = re.compile(r"\bfrom (\S+) to (\S+)")
_FLAGS = re.compile(r"\bflags (\S+)")
@dataclass
class PfLine:
number: int
text: str
action: str # pass | block | reject | match | scrub | other
quick: bool
direction: str # in | out | any
on_negated: bool
on_device: str | None
af: int | None # 4, 6 or None (both)
label: str | None
icmptypes: list[str] = field(default_factory=list)
src: str = "any"
dst: str = "any"
flags: str | None = None
def parse_line(number: int, text: str) -> PfLine:
words = text.split()
first = words[0] if words else ""
action = first if first in ("pass", "match", "scrub") else "other"
if first == "block":
action = "reject" if len(words) > 1 and words[1].startswith("return") else "block"
direction = "in" if " in " in f" {text} " else ("out" if " out " in f" {text} " else "any")
on = _ON.search(text)
af = 4 if re.search(r"\binet\b", text) else (6 if re.search(r"\binet6\b", text) else None)
label = _LABEL.search(text)
endpoints = _FROM.search(text)
flags = _FLAGS.search(text)
return PfLine(
number=number, text=text, action=action, quick=" quick " in f" {text} ",
direction=direction, on_negated=bool(on and on.group(1)), on_device=on.group(2) if on else None,
af=af, label=label.group(1) if label else None, icmptypes=_ICMP.findall(text),
src=endpoints.group(1) if endpoints else ("any" if " all" in f" {text}" else "?"),
dst=endpoints.group(2) if endpoints else ("any" if " all" in f" {text}" else "?"),
flags=flags.group(1) if flags else None,
)
@dataclass
class PfRuleset:
lines: list[PfLine]
by_label: dict[str, list[PfLine]]
@property
def unlabeled(self) -> list[PfLine]:
return [line for line in self.lines if line.label is None and line.action in ("pass", "block", "reject")]
def parse(stats: dict | None) -> PfRuleset | None:
"""None when the answer does not look like a pf ruleset at all."""
rules = (stats or {}).get("rules") if isinstance(stats, dict) else None
filter_rules = rules.get("filter rules") if isinstance(rules, dict) else None
if not isinstance(filter_rules, dict):
return None
lines: list[PfLine] = []
for key in filter_rules:
head = _HEAD.match(str(key).strip())
if not head:
continue
line = parse_line(int(head.group(1)), head.group(2))
if line.action == "scrub":
continue
lines.append(line)
lines.sort(key=lambda line: line.number)
by_label: dict[str, list[PfLine]] = {}
for line in lines:
if line.label:
by_label.setdefault(line.label, []).append(line)
return PfRuleset(lines=lines, by_label=by_label)
@@ -0,0 +1,211 @@
"""Does a rule field match the queried packet? Addresses, interfaces, aliases, ports.
Every function answers with an ``Outcome`` (True/False/None + reason codes). Whatever cannot
be proven from the firewall's own data is ``None`` (unknown), never a guess.
"""
from __future__ import annotations
import ipaddress
import re
from app.services.rule_analysis.context import Context
from app.services.rule_analysis.model import IPAddr, Outcome, o_or, t_not
MAX_ALIAS_DEPTH = 10
TABLE_ONLY_TYPES = {"url", "urltable", "geoip", "asn", "mac", "dynipv6host", "authgroup", "external", "internal"}
ADDRESS_TYPES = {"host", "network", "networkgroup"}
SERVICES = {
"ftp-data": 20, "ftp": 21, "ssh": 22, "telnet": 23, "smtp": 25, "domain": 53, "dns": 53, "bootps": 67,
"bootpc": 68, "tftp": 69, "http": 80, "www": 80, "kerberos": 88, "pop3": 110, "ntp": 123, "imap": 143,
"snmp": 161, "snmptrap": 162, "ldap": 389, "https": 443, "smb": 445, "microsoft-ds": 445, "isakmp": 500,
"syslog": 514, "submission": 587, "ldaps": 636, "imaps": 993, "pop3s": 995, "openvpn": 1194,
"ms-sql-s": 1433, "radius": 1812, "radius-acct": 1813, "nfs": 2049, "mysql": 3306, "rdp": 3389,
"ipsec-nat-t": 4500, "sip": 5060, "postgresql": 5432, "dhcpv6-client": 546, "dhcpv6-server": 547,
"http-alt": 8080, "wireguard": 51820,
}
EPHEMERAL = (1024, 65535)
def _ip_in(token: str, ip: IPAddr) -> bool | None:
"""Literal IP / CIDR / range; None when the token is not a literal."""
token = token.strip()
if "-" in token and not token.startswith("-"):
low, _, high = token.partition("-")
try:
low_ip, high_ip = ipaddress.ip_address(low.strip()), ipaddress.ip_address(high.strip())
except ValueError:
return None
return low_ip.version == ip.version and low_ip <= ip <= high_ip
try:
net = ipaddress.ip_network(token, strict=False)
except ValueError:
return None
return net.version == ip.version and ip in net
def _interface_ref(token: str, ip: IPAddr, ctx: Context) -> Outcome | None:
name = token.strip()
lower = name.lower()
m = re.fullmatch(r"__(.+)_network", lower)
if m and m.group(1) in ctx.interfaces:
lower = m.group(1)
info = ctx.interfaces.get(lower)
if info is not None: # "lan" = the interface's networks (pf: (dev:network), incl. VIP subnets)
return Outcome(any(ip in net for net in info.nets))
if lower.endswith("ip") and lower[:-2] in ctx.interfaces: # "lanip" = the interface address
info = ctx.interfaces[lower[:-2]]
if ip in info.addrs:
return Outcome(True)
if ip in info.vips:
return Outcome(None, ["VIP_AS_INTERFACE_ADDRESS"])
return Outcome(False)
return None
def addr_item(token: str, ip: IPAddr, ctx: Context, *, depth: int = 0, seen: tuple = ()) -> Outcome:
token = token.strip()
if token.lower() in ("any", ""):
return Outcome(True)
if token.lower() in ("(self)", "self", "this firewall"):
return Outcome(ip in ctx.self_addrs)
literal = _ip_in(token, ip)
if literal is not None:
return Outcome(literal)
ref = _interface_ref(token, ip, ctx)
if ref is not None:
return ref
return alias_contains(token, ip, ctx, depth=depth, seen=seen)
def alias_contains(name: str, ip: IPAddr, ctx: Context, *, depth: int = 0, seen: tuple = ()) -> Outcome:
if name in seen:
return Outcome(None, ["ALIAS_CYCLE"])
if depth > MAX_ALIAS_DEPTH:
return Outcome(None, ["ALIAS_TOO_DEEP"])
alias = ctx.aliases.get(name)
refs = ctx.refs.get(str(ip))
if alias is None:
# pf knows tables the alias list may not show (e.g. internal ones): trust a positive hit.
if refs is not None and name in refs:
return Outcome(True)
return Outcome(None, ["ALIAS_MISSING"])
kind = str(alias.get("type") or "").lower()
if depth == 0 and refs is not None:
# pf's own table test: authoritative for every alias type (nesting, "!" entries, FQDNs).
return Outcome(name in refs)
if kind in ADDRESS_TYPES:
return _alias_content(alias, ip, ctx, depth, (*seen, name))
if refs is not None:
return Outcome(name in refs)
return Outcome(None, ["ALIAS_TABLE_UNAVAILABLE"])
def _alias_content(alias: dict, ip: IPAddr, ctx: Context, depth: int, seen: tuple) -> Outcome:
entries = [e.strip() for e in re.split(r"[\n,]", str(alias.get("content") or "")) if e.strip()]
if any(e.startswith("!") for e in entries):
return Outcome(None, ["ALIAS_EXCLUSION"])
results = []
for entry in entries:
literal = _ip_in(entry, ip)
if literal is not None:
results.append(Outcome(literal))
elif entry in ctx.aliases or entry in seen:
results.append(alias_contains(entry, ip, ctx, depth=depth + 1, seen=seen))
elif "." in entry or ":" in entry:
results.append(Outcome(None, ["FQDN_UNRESOLVED"]))
else:
results.append(Outcome(None, ["ALIAS_MISSING"]))
return o_or(results)
def endpoint_match(endpoint, ip: IPAddr, ctx: Context) -> Outcome:
if endpoint.is_any:
return Outcome(True)
result = o_or([addr_item(item, ip, ctx) for item in endpoint.items])
if endpoint.negated:
return Outcome(t_not(result.value), result.reasons)
return result
# ── Ports ─────────────────────────────────────────────────────────────────
def port_ranges(spec: str, ctx: Context, *, depth: int = 0, seen: tuple = ()) -> tuple[list[tuple[int, int]] | None, list[str]]:
"""The port ranges a spec stands for; (None, reasons) when that cannot be known."""
ranges: list[tuple[int, int]] = []
reasons: list[str] = []
for part in [p.strip() for p in re.split(r"[\n,]", spec) if p.strip()]:
m = re.fullmatch(r"(\w[\w-]*?)\s*[-:]\s*(\w[\w-]*)", part) if not part.isdigit() and part not in ctx.aliases else None
if part.isdigit():
ranges.append((int(part), int(part)))
elif m and _port_number(m.group(1)) is not None and _port_number(m.group(2)) is not None:
ranges.append((_port_number(m.group(1)), _port_number(m.group(2))))
elif part.lower() in SERVICES:
ranges.append((SERVICES[part.lower()],) * 2)
elif part in ctx.aliases:
if part in seen or depth >= MAX_ALIAS_DEPTH:
return None, ["ALIAS_CYCLE" if part in seen else "ALIAS_TOO_DEEP"]
alias = ctx.aliases[part]
if str(alias.get("type") or "").lower() != "port":
return None, ["PORT_ALIAS_UNRESOLVED"]
sub, why = port_ranges(str(alias.get("content") or ""), ctx, depth=depth + 1, seen=(*seen, part))
if sub is None:
return None, why
ranges += sub
else:
return None, ["PORT_ALIAS_UNRESOLVED" if part.isidentifier() else "PORT_UNPARSEABLE"]
return ranges, reasons
def _port_number(token: str) -> int | None:
if token.isdigit():
return int(token)
return SERVICES.get(token.lower())
def port_match(spec: str, port: int | None, ctx: Context, *, ephemeral_default: bool = False) -> Outcome:
spec = (spec or "").strip()
if spec.lower() in ("", "any"):
return Outcome(True)
ranges, reasons = port_ranges(spec, ctx)
if ranges is None:
return Outcome(None, reasons)
if port is not None:
return Outcome(any(low <= port <= high for low, high in ranges))
if not ephemeral_default:
return Outcome(None, ["PORT_NOT_GIVEN"])
# No source port given: the query stands for an ephemeral client port (1024-65535).
low_e, high_e = EPHEMERAL
overlap = [(max(low, low_e), min(high, high_e)) for low, high in ranges if high >= low_e and low <= high_e]
if not overlap:
return Outcome(False)
covered, cursor = True, low_e
for low, high in sorted(overlap):
if low > cursor:
covered = False
break
cursor = max(cursor, high + 1)
if covered and cursor > high_e:
return Outcome(True)
return Outcome(None, ["SRC_PORT_NOT_GIVEN"])
# ── Interfaces ────────────────────────────────────────────────────────────
def iface_match(interfaces: set[str], if_not: bool, iface: str, ctx: Context) -> Outcome:
if not interfaces:
return Outcome(True)
results = []
for name in interfaces:
if name == iface:
results.append(Outcome(True))
elif name in ctx.interfaces:
results.append(Outcome(False))
elif ctx.groups is not None and name in ctx.groups:
results.append(Outcome(iface in ctx.groups[name]))
else:
results.append(Outcome(None, ["IFACE_UNRESOLVED" if ctx.groups is not None else "GROUPS_UNAVAILABLE"]))
result = o_or(results)
if if_not:
return Outcome(t_not(result.value), result.reasons)
return result
@@ -0,0 +1,76 @@
"""Entry point used by the API: validate a query, load the firewall's context, evaluate."""
from __future__ import annotations
import ipaddress
import logging
from app.errors import ErrorCode, api_error
from app.models.host import OpnsenseHost
from app.services.rule_analysis import context as ctx_mod
from app.services.rule_analysis.engine import Query, evaluate
from app.services.rule_analysis.normalize import PROTO_NUMBERS, norm_proto
logger = logging.getLogger(__name__)
def _ip(value: str | None, field: str):
try:
return ipaddress.ip_address(str(value or "").strip())
except ValueError:
raise api_error(422, ErrorCode.ANALYSE_ADRESSE_UNGUELTIG, field=field, value=str(value or "")[:64]) from None
def _port(value: str | int | None, field: str) -> int | None:
if value in (None, ""):
return None
text = str(value).strip()
if not text.isdigit() or int(text) > 65535:
raise api_error(422, ErrorCode.ANALYSE_PARAMETER_UNGUELTIG, field=field, value=text[:32])
return int(text)
def build_query(*, src: str, dst: str, proto: str = "tcp", sport=None, dport=None, icmptype: str | None = None,
iface: str | None = None, direction: str = "in", egress: str | None = None) -> Query:
source, destination = _ip(src, "src"), _ip(dst, "dst")
if source.version != destination.version:
raise api_error(422, ErrorCode.ANALYSE_FAMILIEN_MISCHUNG)
label = str(proto or "tcp").strip().lower()
if label == "icmp" and source.version == 6:
label = "ipv6-icmp"
number = norm_proto(label)
if not (number.isdigit() and int(number) <= 255) and label not in PROTO_NUMBERS:
raise api_error(422, ErrorCode.ANALYSE_PARAMETER_UNGUELTIG, field="proto", value=label[:32])
q = Query(src=source, dst=destination, proto=number, proto_label=label,
sport=_port(sport, "sport"), dport=_port(dport, "dport"))
if (q.sport is not None or q.dport is not None) and number not in ("6", "17"):
raise api_error(422, ErrorCode.ANALYSE_PARAMETER_UNGUELTIG, field="dport", value=str(dport or sport))
if icmptype not in (None, ""):
if number not in ("1", "58"):
raise api_error(422, ErrorCode.ANALYSE_PARAMETER_UNGUELTIG, field="icmptype", value=str(icmptype)[:32])
q.icmptype = str(icmptype).strip().lower()
if direction not in ("in", "out"):
raise api_error(422, ErrorCode.ANALYSE_PARAMETER_UNGUELTIG, field="direction", value=str(direction)[:8])
q.direction = direction
q.iface = None if str(iface or "").strip().lower() in ("", "auto") else str(iface).strip()
egress_value = str(egress or "").strip().lower()
q.egress = "none" if egress_value in ("", "none") else (None if egress_value == "auto" else str(egress).strip())
return q
def check_interfaces(q: Query, ctx: ctx_mod.Context) -> None:
for name in (q.iface, None if q.egress in (None, "none") else q.egress):
if name is not None and name not in ctx.interfaces:
raise api_error(422, ErrorCode.ANALYSE_INTERFACE_UNBEKANNT, interface=name[:64],
known=", ".join(sorted(i for i in ctx.interfaces if i != "lo0")))
async def analyze_host(host: OpnsenseHost, q: Query, *, refresh: bool = False) -> dict:
"""Raises api_error for a bad interface; OpnsenseAPIError/httpx errors when the firewall
cannot be read (callers map that)."""
ctx = await ctx_mod.load_context(host, use_cache=not refresh)
check_interfaces(q, ctx)
await ctx_mod.ensure_refs(host, ctx, [str(q.src), str(q.dst)])
result = evaluate(ctx, q)
if any(ctx.refs.get(ip) is None for ip in (str(q.src), str(q.dst))):
result["notes"] = sorted({*result["notes"], "ALIAS_REFERENCES_UNAVAILABLE"})
return result
+9 -3
View File
@@ -27,7 +27,7 @@ from app.models.host import OpnsenseHost
from app.models.rule import FirewallRule
from app.models.rule_deployment import RuleDeployment
from app.services.audit_service import tracked_rollback
from app.services import opnsense_client
from app.services import opnsense_client, variables_service
from app.services.deploy_flow import push_to_host
from app.services.opnsense_client import OpnsenseAmbiguousError, OpnsenseAPIError
@@ -36,7 +36,12 @@ def _now() -> datetime:
return datetime.now(timezone.utc)
def _build_payload(rule: FirewallRule) -> dict:
def _build_payload(rule: FirewallRule, host: OpnsenseHost | None = None) -> dict:
payload = _base_payload(rule)
return variables_service.resolve(payload, host) if host is not None else payload
def _base_payload(rule: FirewallRule) -> dict:
return {
"enabled": "1" if rule.enabled else "0",
"action": rule.action,
@@ -55,7 +60,7 @@ def _build_payload(rule: FirewallRule) -> dict:
async def _deploy_to_host(db: AsyncSession, rule: FirewallRule, host: OpnsenseHost) -> RuleDeployment:
payload = _build_payload(rule)
payload = _build_payload(rule, host)
existing = await db.scalar(
select(RuleDeployment).where(RuleDeployment.rule_id == rule.id, RuleDeployment.host_id == host.id)
)
@@ -98,6 +103,7 @@ async def deploy_rule(db: AsyncSession, rule: FirewallRule, hosts: list[Opnsense
from app.services.host_maintenance_service import ensure_no_maintenance
from app.services.policy_hierarchy_deploy_service import reassert_after_managed_change
await ensure_no_maintenance(db, hosts)
variables_service.ensure_resolvable(_build_payload, rule, hosts) # before anything is written
deployments = [await _deploy_to_host(db, rule, host) for host in hosts]
await db.flush()
for host, deployment in zip(hosts, deployments):
+6 -1
View File
@@ -58,7 +58,12 @@ class S3Client:
if parts.scheme == "http" and not settings.allow_insecure_offsite:
# Credentials and (encrypted, but still) backups must not travel in the clear.
raise S3Error("Der Endpunkt muss https:// sein")
self.scheme, self.netloc = parts.scheme, parts.netloc
# httpx leaves a scheme's default port out of the Host header, so the signed host must not carry it either.
port = parts.port
default = {"https": 443, "http": 80}[parts.scheme]
host = parts.hostname if ":" not in parts.hostname else f"[{parts.hostname}]"
self.scheme = parts.scheme
self.netloc = host if port in (None, default) else f"{host}:{port}"
self.region, self.bucket, self.path_style = region or "us-east-1", bucket, path_style
self.access_key, self.secret_key = access_key, secret_key
@@ -15,18 +15,31 @@ the UI) but is NOT wired into the NotificationSettings webhook/email
system — that system is built around persistent NotificationProblem rows
with their own admin-configurable toggles, and adding a new problem kind
for this is a bigger change than this feature's own scope. Flagged here,
not silently dropped, in case it's wanted later.
not silently dropped, in case it's wanted later. (Later: the failure is reported by
notification_checks.check_scheduled_maintenance_failed since 1.17.)
auto_verify (1.25, set for every rollout step): instead of leaving the operation "submitted"
for a human, the run waits for the job (phase job_wait) and then checks the result itself
(phase verify: firmware idle for a while, a reboot really happened when one was due, version
readable). Only then the operation is closed as "acknowledged"; anything unclear ends as
"unknown" (stays locked, notification). Without auto_verify nothing changes.
Concurrency: due rows and running rows are each taken with SELECT ... FOR UPDATE SKIP LOCKED,
one row per transaction, so a second backend (briefly possible during a web update) can never
fire or step the same row at the same time.
"""
import logging
from datetime import datetime, timedelta, timezone
from fastapi import HTTPException
from sqlalchemy import select
from sqlalchemy import select, true
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.host import OpnsenseHost
from app.models.host_operation import HostOperation
from app.models.scheduled_maintenance import ScheduledMaintenance
from contextlib import contextmanager
from app.services import audit_service, backup_store, opnsense_client as client
from app.services.host_maintenance_service import ACTIVE, ensure_no_maintenance, inspect_carp_switch, inspect_host, peers
from app.services.host_status_service import get_statuses
@@ -51,40 +64,93 @@ HANDOVER_TIMEOUT = timedelta(minutes=3)
LEAVE_TIMEOUT = timedelta(minutes=5)
JOB_GRACE = timedelta(minutes=5) # no sign of a job after this long: treat a package update as already done
JOB_TIMEOUT = {"reboot": timedelta(minutes=20), "update": timedelta(minutes=60), "major_update": timedelta(minutes=150)}
# auto_verify: the firmware must report "ready" for this long in a row (a reboot at the end of an update
# can follow a short "ready" moment), and the whole check gives up after VERIFY_TIMEOUT.
VERIFY_SETTLE = timedelta(seconds=60)
VERIFY_TIMEOUT = timedelta(minutes=20)
# A rollout step is created with run_at=now and fires on the next poll. Found much later (OPNexus was down,
# e.g. during an update), it no longer belongs to the decision that created it: the window may have closed
# and the run may have been paused meanwhile. It is then not fired; the rollout engine re-queues the host.
ROLLOUT_FIRE_GRACE = timedelta(minutes=5)
def _now() -> datetime:
return datetime.now(timezone.utc)
@contextmanager
def _as_actor(sched: ScheduledMaintenance):
"""Audit events of an unattended run name the person who planned it (not the rollback worker)."""
token = audit_service.context.set({"actor": f"{sched.actor} (geplant)"[:150], "id": str(sched.id)})
try:
yield
finally:
audit_service.context.reset(token)
def _rollout_details(sched: ScheduledMaintenance) -> dict:
rollout = (sched.progress or {}).get("rollout")
return {"rollout": rollout} if rollout else {}
async def fire_due(db: AsyncSession) -> dict:
due = list(
(
await db.scalars(
select(ScheduledMaintenance).where(
ScheduledMaintenance.status == "pending", ScheduledMaintenance.run_at <= _now()
)
)
).all()
)
fired = 0
blocked = 0
for sched in due:
try:
await _fire_one(db, sched)
except Exception:
logger.exception("Geplante Wartung %s fehlgeschlagen", sched.id)
sched.status = "failed"
sched.result = {"error": "Unerwarteter Fehler beim Ausführen"}
due = fired = blocked = 0
seen: set = set()
while True:
# One row per transaction, locked: a second backend skips it instead of firing it again.
sched = await db.scalar(
select(ScheduledMaintenance)
.where(ScheduledMaintenance.status == "pending", ScheduledMaintenance.run_at <= _now(),
ScheduledMaintenance.id.not_in(seen) if seen else true())
.order_by(ScheduledMaintenance.run_at)
.limit(1)
.with_for_update(skip_locked=True)
.execution_options(populate_existing=True)
)
if sched is None:
await db.commit()
break
seen.add(sched.id)
due += 1
with _as_actor(sched):
try:
await _fire_one(db, sched)
except Exception:
logger.exception("Geplante Wartung %s fehlgeschlagen", sched.id)
await db.rollback()
sched = await db.get(ScheduledMaintenance, sched.id, populate_existing=True)
if sched.status in ("pending", "running") and sched.phase is None:
sched.status = "failed"
sched.result = {"error": "Unerwarteter Fehler beim Ausführen"}
await db.commit()
await db.commit() # never keep the row lock past this row
if sched.status == "failed":
blocked += 1
else:
fired += 1
return {"due": len(due), "fired": fired, "blocked_or_failed": blocked}
return {"due": due, "fired": fired, "blocked_or_failed": blocked}
def _reboot_expected(action: str, state: dict) -> bool:
return action in ("reboot", "major_update") or bool(state.get("reboot_required"))
async def _boot_time(host: OpnsenseHost) -> str | None:
"""systemTime's "boottime" (Diagnostics SystemController::systemTimeAction, read-only, already used by the
resource sampler). A different value afterwards proves a reboot even if no poll caught the host offline."""
try:
return (await client.get_system_time(host)).get("boottime") or None
except client.OpnsenseAPIError:
return None
async def _fire_one(db: AsyncSession, sched: ScheduledMaintenance) -> None:
if sched.origin == "rollout" and _now() - sched.run_at > ROLLOUT_FIRE_GRACE:
sched.status = "failed"
sched.result = {"error": "Rollout-Schritt nicht rechtzeitig gestartet, nichts ausgeführt", "not_fired": True}
await db.commit()
logger.warning("Geplante Wartung %s: Rollout-Schritt überfällig, nicht ausgeführt", sched.id)
return
host = await db.get(OpnsenseHost, sched.host_id)
if not host or not host.enabled:
sched.status = "failed"
@@ -137,6 +203,7 @@ async def _fire_one(db: AsyncSession, sched: ScheduledMaintenance) -> None:
logger.warning("Geplante Wartung %s blockiert: %s", sched.id, sched.result["error"])
return
boot_before = await _boot_time(host) if sched.auto_verify else None
op = HostOperation(
host_id=host.id, host_name=host.name, actor=sched.actor, action=sched.action,
expires_at=_now(), fingerprint="", snapshot=state, status="starting", started_at=_now(),
@@ -147,14 +214,23 @@ async def _fire_one(db: AsyncSession, sched: ScheduledMaintenance) -> None:
await audit_service.persist(
kind="host", action=sched.action, status="requested",
host_id=str(host.id), host_name=host.name, entity_id=str(op.id),
details={"scheduled": True, "schedule_id": str(sched.id), "snapshot": state},
details={"scheduled": True, "schedule_id": str(sched.id), "snapshot": state, **_rollout_details(sched)},
)
try:
result = await _ACTION_FN[sched.action](host)
op.status = "submitted"
op.message = "Geplant übergeben. Abschluss und Erreichbarkeit prüfen; anschließend Wartung abschließen."
sched.status = "succeeded"
sched.result = {"response": result}
if sched.auto_verify:
# Not done yet: the poll loop waits for the job and checks the result (job_wait -> verify).
op.message = "Geplant übergeben. Abschluss wird automatisch geprüft."
sched.phase, sched.phase_since = "job_wait", _now()
_progress(sched, handover=False, job_started_at=_now().isoformat(), seen_down=False, seen_running=False,
version_before=state.get("version"), boot_before=boot_before,
reboot_expected=_reboot_expected(sched.action, state))
sched.result = {"response": result}
else:
op.message = "Geplant übergeben. Abschluss und Erreichbarkeit prüfen; anschließend Wartung abschließen."
sched.status = "succeeded"
sched.result = {"response": result}
except client.OpnsenseAPIError as exc:
op.status = "unknown"
op.message = "Ausgang unklar: " + str(exc)[:800] + ". Nicht automatisch wiederholen."
@@ -166,7 +242,7 @@ async def _fire_one(db: AsyncSession, sched: ScheduledMaintenance) -> None:
await audit_service.persist(
kind="host", action=sched.action, status=op.status,
host_id=str(host.id), host_name=host.name, entity_id=str(op.id),
message=op.message, details={"scheduled": True, "schedule_id": str(sched.id), "response": result},
message=op.message, details={"scheduled": True, "schedule_id": str(sched.id), "response": result, **_rollout_details(sched)},
)
@@ -182,21 +258,24 @@ async def _audit(host, sched, op, action, status, message=None, **details):
await audit_service.persist(
kind="host", action=action, status=status, host_id=str(host.id), host_name=host.name,
entity_id=str(op.id) if op else None, message=message,
details={"scheduled": True, "schedule_id": str(sched.id), "handover": True, **details},
details={"scheduled": True, "schedule_id": str(sched.id), "handover": bool((sched.progress or {}).get("handover")),
**_rollout_details(sched), **details},
)
async def _end(db, sched, host, op, *, ok, message, op_status=None, **result):
handover = bool((sched.progress or {}).get("handover"))
sched.status = "succeeded" if ok else "failed"
sched.phase = None
sched.result = {"handover": True, **result} if ok else {"error": message[:900], **result}
sched.result = ({"handover": handover, "auto_verified": bool(sched.auto_verify), **result} if ok
else {"error": message[:900], **result})
if op is not None:
op.status = op_status or ("acknowledged" if ok else "unknown")
op.message = message[:1000]
await db.commit()
await _audit(host, sched, op, sched.action, "completed" if ok else (op_status or "unknown"), message)
if not ok:
logger.warning("Geplante Wartung %s (CARP-Übergabe) beendet: %s", sched.id, message)
logger.warning("Geplante Wartung %s beendet: %s", sched.id, message)
async def _toggle(host, expected: str) -> None:
@@ -230,6 +309,7 @@ async def _start_handover(db: AsyncSession, sched: ScheduledMaintenance, host: O
await fail(" ".join(blocked))
return
boot_before = await _boot_time(host) if sched.auto_verify else None
now = _now()
op = HostOperation(
host_id=host.id, host_name=host.name, actor=sched.actor, action=sched.action,
@@ -237,6 +317,7 @@ async def _start_handover(db: AsyncSession, sched: ScheduledMaintenance, host: O
)
db.add(op)
sched.status = "running"
_progress(sched, handover=True, boot_before=boot_before, reboot_expected=_reboot_expected(sched.action, state))
await db.commit()
sched.host_operation_id = op.id
await _audit(host, sched, op, "carp_enter", "requested", snapshot=state)
@@ -255,32 +336,56 @@ async def _start_handover(db: AsyncSession, sched: ScheduledMaintenance, host: O
async def advance_running(db: AsyncSession) -> int:
"""One step for every handover run in progress. Returns how many are still running."""
rows = list((await db.scalars(
select(ScheduledMaintenance).where(ScheduledMaintenance.status == "running", ScheduledMaintenance.phase.is_not(None))
"""One step for every run in progress (handover and/or auto_verify). Returns how many are still running."""
ids = list((await db.scalars(
select(ScheduledMaintenance.id).where(ScheduledMaintenance.status == "running", ScheduledMaintenance.phase.is_not(None))
)).all())
for sched in rows:
host = await db.get(OpnsenseHost, sched.host_id)
op = await db.get(HostOperation, sched.host_operation_id) if sched.host_operation_id else None
try:
if host is None:
raise RuntimeError("Host nicht mehr vorhanden")
if op is not None and op.status not in ACTIVE:
# A human closed or cancelled the operation: stop here and touch nothing more.
sched.status, sched.phase = "failed", None
sched.result = {"error": f"Vorgang von Hand beendet, Ablauf gestoppt. CARP-Rolle von {host.name} prüfen."}
await db.commit()
continue
await _STEPS[sched.phase](db, sched, host, op)
except Exception as exc: # a stuck run must not loop forever or take the poll loop down
logger.exception("Geplante Wartung %s: Schritt %s fehlgeschlagen", sched.id, sched.phase)
if host is not None:
await _end(db, sched, host, op, ok=False,
message=f"Unerwarteter Fehler während der CARP-Übergabe ({type(exc).__name__}). "
f"{host.name} kann im CARP-Wartungsmodus verblieben sein — Rollen prüfen.")
return sum(1 for s in rows if s.status == "running")
await db.commit()
still_running = 0
for sched_id in ids:
# Locked for the whole step: a second backend skips the row instead of toggling or submitting twice.
sched = await db.scalar(
select(ScheduledMaintenance)
.where(ScheduledMaintenance.id == sched_id, ScheduledMaintenance.status == "running",
ScheduledMaintenance.phase.is_not(None))
.with_for_update(skip_locked=True)
.execution_options(populate_existing=True)
)
if sched is None:
await db.commit()
still_running += 1 if await db.scalar(select(ScheduledMaintenance.status).where(ScheduledMaintenance.id == sched_id)) == "running" else 0
await db.commit()
continue
with _as_actor(sched):
await _advance_one(db, sched)
await db.commit()
if sched.status == "running":
still_running += 1
return still_running
async def _advance_one(db: AsyncSession, sched: ScheduledMaintenance) -> None:
host = await db.get(OpnsenseHost, sched.host_id)
op = await db.get(HostOperation, sched.host_operation_id) if sched.host_operation_id else None
try:
if host is None:
raise RuntimeError("Host nicht mehr vorhanden")
if op is not None and op.status not in ACTIVE:
# A human closed or cancelled the operation: stop here and touch nothing more.
hint = f" CARP-Rolle von {host.name} prüfen." if (sched.progress or {}).get("handover") else ""
sched.status, sched.phase = "failed", None
sched.result = {"error": f"Vorgang von Hand beendet, Ablauf gestoppt.{hint}"}
await db.commit()
return
await _STEPS[sched.phase](db, sched, host, op)
except Exception as exc: # a stuck run must not loop forever or take the poll loop down
logger.exception("Geplante Wartung %s: Schritt %s fehlgeschlagen", sched.id, sched.phase)
if host is not None:
hint = (f"{host.name} kann im CARP-Wartungsmodus verblieben sein — Rollen prüfen."
if (sched.progress or {}).get("handover") else f"Zustand von {host.name} prüfen.")
await _end(db, sched, host, op, ok=False,
message=f"Unerwarteter Fehler während der geplanten Wartung ({type(exc).__name__}). {hint}")
def _since(sched: ScheduledMaintenance) -> timedelta:
return _now() - (sched.phase_since or _now())
@@ -352,17 +457,75 @@ async def _step_job_wait(db, sched, host, op):
else:
done = bool(prog.get("seen_down") or prog.get("seen_running")) or elapsed >= JOB_GRACE
if done:
sched.phase, sched.phase_since = "leave", _now()
sched.phase = "verify" if sched.auto_verify else "leave"
sched.phase_since = _now()
await db.commit()
return
if elapsed >= JOB_TIMEOUT[sched.action]:
await _end(db, sched, host, op, ok=False,
message=f"Auftrag „{sched.action}“ auf {host.name} nicht rechtzeitig abgeschlossen. {host.name} bleibt im "
f"CARP-Wartungsmodus, der Partner trägt den Verkehr. Bitte prüfen und von Hand zurückschalten.")
if prog.get("handover"):
text = (f"Auftrag „{sched.action}“ auf {host.name} nicht rechtzeitig abgeschlossen. {host.name} bleibt im "
f"CARP-Wartungsmodus, der Partner trägt den Verkehr. Bitte prüfen und von Hand zurückschalten.")
else:
text = f"Auftrag „{sched.action}“ auf {host.name} nicht rechtzeitig abgeschlossen. Bitte {host.name} prüfen."
await _end(db, sched, host, op, ok=False, message=text)
return
await db.commit()
async def _step_verify(db, sched, host, op):
"""auto_verify: is the job really over and the host healthy? Read-only, never repeats the action."""
prog = dict(sched.progress or {})
handover = bool(prog.get("handover"))
async def wait_or_give_up(why: str):
if _since(sched) >= VERIFY_TIMEOUT:
tail = (f" {host.name} bleibt im CARP-Wartungsmodus, der Partner trägt den Verkehr." if handover else "")
await _end(db, sched, host, op, ok=False,
message=f"Automatische Prüfung nach „{sched.action}“ nicht bestanden: {why}.{tail} "
f"Bitte {host.name} prüfen und die Wartung von Hand abschließen.")
return
_progress(sched, waiting_for=why)
await db.commit()
try:
running = (await client.get_firmware_running(host)).get("status")
except client.OpnsenseAPIError:
running = None
_progress(sched, seen_down=True)
if running != "ready":
_progress(sched, ready_since=None)
await wait_or_give_up("Firmware-Auftrag läuft noch oder Host nicht erreichbar")
return
if not prog.get("ready_since"):
_progress(sched, ready_since=_now().isoformat())
await db.commit()
return
if _now() - datetime.fromisoformat(prog["ready_since"]) < VERIFY_SETTLE:
await db.commit()
return
boot_now = await _boot_time(host)
rebooted = bool(prog.get("seen_down")) or bool(prog.get("boot_before") and boot_now and boot_now != prog["boot_before"])
if prog.get("reboot_expected") and not rebooted:
await wait_or_give_up("der erwartete Neustart wurde nicht beobachtet")
return
try:
version = (await client.get_firmware_info(host)).get("product_version")
except client.OpnsenseAPIError:
version = None
online = (await get_statuses([host])).get(host.id, {}).get("status") == "online"
if not version or not online:
await wait_or_give_up("Host nicht vollständig erreichbar (Version/Status nicht lesbar)")
return
_progress(sched, version_after=version, boot_after=boot_now, rebooted=rebooted, waiting_for=None)
if handover:
sched.phase, sched.phase_since = "leave", _now() # only now take the traffic back
await db.commit()
return
await _end(db, sched, host, op, ok=True,
message=f"Automatisch geprüft: {host.name} erreichbar, Firmware-Auftrag beendet, Version {version}.",
version_before=prog.get("version_before"), version_after=version, rebooted=rebooted)
async def _step_leave(db, sched, host, op):
me, _partner = await _roles(db, host)
if me.get("status") != "online":
@@ -397,6 +560,8 @@ async def _step_leave_wait(db, sched, host, op):
except client.OpnsenseAPIError:
pass
extra["version_before"] = (sched.progress or {}).get("version_before")
if sched.auto_verify:
extra["rebooted"] = bool((sched.progress or {}).get("rebooted")) # what verify saw before leaving
text = "Automatisch abgeschlossen: Übergabe, Auftrag und Zurückschalten bestätigt."
if extra.get("reboot_required"):
text += " Ein Neustart ist noch erforderlich."
@@ -410,6 +575,7 @@ async def _step_leave_wait(db, sched, host, op):
_STEPS = {
"handover_wait": _step_handover_wait,
"job_wait": _step_job_wait,
"verify": _step_verify,
"leave": _step_leave,
"leave_wait": _step_leave_wait,
}
+3 -1
View File
@@ -18,7 +18,7 @@ from cryptography import x509
from cryptography.hazmat.primitives import hashes, serialization
from cryptography.x509.oid import ExtensionOID, NameOID
from app.services import overlay_service, proxy_connect
from app.services import proxy_connect
MAX_PEM_BYTES = 32 * 1024
@@ -94,6 +94,8 @@ def verify_argument(verify_tls: bool, tls_ca_pem: str | None):
async def _open_tls(base_url: str, parsed, ctx: ssl.SSLContext, timeout: float):
"""TLS connection to the firewall: directly, or through the overlay hub's proxy for overlay addresses."""
# Imported here so that pinned_context() stays usable without the database layer (gui-gateway container).
from app.services import overlay_service
proxy = overlay_service.proxy_for(base_url)
port = parsed.port or 443
if proxy is None:
+44 -7
View File
@@ -17,8 +17,10 @@ from dataclasses import dataclass
from datetime import datetime, timedelta, timezone
import httpx
from sqlalchemy.ext.asyncio import AsyncSession
from app.config import settings
from app.models.update_check_settings import DEFAULT_FEED_URL, UpdateCheckSettings
from app.version import APP_VERSION
logger = logging.getLogger(__name__)
@@ -38,6 +40,7 @@ class _State:
latest: str | None = None
release_url: str | None = None
error: str | None = None
url: str | None = None
_state = _State()
@@ -45,11 +48,41 @@ _lock = asyncio.Lock()
def reset_cache() -> None:
"""Nur für Tests."""
"""Verwirft den gemerkten Stand (Tests, geänderter Feed)."""
global _state
_state = _State()
_SINGLETON_ID = 1
_URL = re.compile(r"^https?://[^\s<>\"']+$")
def valid_feed_url(value: str) -> bool:
return bool(_URL.match(value)) and len(value) <= 500
async def get_settings(db: AsyncSession) -> UpdateCheckSettings:
row = await db.get(UpdateCheckSettings, _SINGLETON_ID)
if row is None:
row = UpdateCheckSettings(id=_SINGLETON_ID, enabled=False, feed_url=DEFAULT_FEED_URL)
db.add(row)
await db.flush()
return row
def managed_by_server() -> bool:
"""UPDATE_CHECK_URL in the server's .env wins over the setting in the web UI."""
return bool(settings.update_check_url.strip())
async def feed_url(db: AsyncSession) -> str:
"""The feed to ask, or "" while the check is off."""
if managed_by_server():
return settings.update_check_url.strip()
row = await get_settings(db)
return row.feed_url.strip() if row.enabled else ""
def _parse(tag: str) -> tuple[int, int, int] | None:
match = _STABLE_TAG.match(tag.strip())
return tuple(int(part) for part in match.groups()) if match else None # type: ignore[return-value]
@@ -62,10 +95,10 @@ def _safe_url(value: object) -> str | None:
return None
async def _fetch() -> tuple[str, str | None]:
async def _fetch(url: str) -> tuple[str, str | None]:
async with httpx.AsyncClient(timeout=_TIMEOUT_SECONDS, follow_redirects=True, max_redirects=3) as http:
response = await http.get(
settings.update_check_url,
url,
headers={"Accept": "application/json", "User-Agent": f"OPNexus/{APP_VERSION}"},
)
response.raise_for_status()
@@ -78,9 +111,10 @@ async def _fetch() -> tuple[str, str | None]:
return tag, _safe_url(data.get("html_url"))
async def check() -> dict:
async def check(db: AsyncSession) -> dict:
"""Aktueller Stand für GET /api/system/version-check."""
enabled = bool(settings.update_check_url.strip())
url = await feed_url(db)
enabled = bool(url)
current = _parse(APP_VERSION)
result = {
"enabled": enabled,
@@ -95,6 +129,9 @@ async def check() -> dict:
return result
async with _lock:
if _state.url != url: # Feed geändert: alter Stand gehört nicht mehr dazu
reset_cache()
_state.url = url
now = datetime.now(timezone.utc)
interval = timedelta(hours=max(1, settings.update_check_interval_hours))
fresh = _state.checked_at is not None and now - _state.checked_at < interval
@@ -102,12 +139,12 @@ async def check() -> dict:
if not fresh and not backing_off:
_state.attempted_at = now
try:
tag, url = await _fetch()
tag, release_url = await _fetch(url)
if _parse(tag) is None:
# z. B. eine Vorabversion — kein Fehler, nur kein Update.
_state.latest, _state.release_url = None, None
else:
_state.latest, _state.release_url = tag.lstrip("v"), url
_state.latest, _state.release_url = tag.lstrip("v"), release_url
_state.checked_at, _state.error = now, None
except Exception as exc: # Netz, HTTP, JSON, Format: alles nur "geht gerade nicht"
logger.warning("Update-Check fehlgeschlagen: %s", exc.__class__.__name__)
+94
View File
@@ -0,0 +1,94 @@
"""Destination check for URLs OPNexus is told to call (notification channels, webhook).
Admins legitimately point these at servers on their own network (a self-hosted ntfy, Gotify or
Matrix), so private ranges are allowed. What is refused is what cannot be a notification target:
anything but http(s), credentials inside the URL, and addresses that only ever mean "this machine"
or "the cloud metadata service" (loopback, link-local such as 169.254.169.254, unspecified,
multicast). Redirects are never followed by the callers, so a public host cannot bounce a request
to such an address. The hostname is resolved at send time and every address is checked (a name that
does not resolve is let through; the request then fails on its own).
"""
import asyncio
import contextlib
import contextvars
import ipaddress
import logging
import socket
from urllib.parse import urlsplit
# httpx logs every request line ("HTTP Request: POST https://api.telegram.org/bot<token>/sendMessage"). For
# targets whose URL is the credential that line must not reach the logs: callers wrap the request in muted().
_muted = contextvars.ContextVar("url_guard_muted", default=False)
class _MuteFilter(logging.Filter):
def filter(self, record: logging.LogRecord) -> bool:
return not _muted.get()
for _name in ("httpx", "httpcore"):
logging.getLogger(_name).addFilter(_MuteFilter())
@contextlib.contextmanager
def muted():
token = _muted.set(True)
try:
yield
finally:
_muted.reset(token)
def _forbidden(ip: ipaddress._BaseAddress) -> bool:
if isinstance(ip, ipaddress.IPv6Address) and ip.ipv4_mapped is not None:
ip = ip.ipv4_mapped
return ip.is_loopback or ip.is_link_local or ip.is_unspecified or ip.is_multicast
def validate_url(url: str, *, max_length: int = 500) -> str:
"""Returns the cleaned URL or raises ValueError with a short reason (shown to the admin)."""
value = (url or "").strip()
if not value or len(value) > max_length or any(c.isspace() for c in value):
raise ValueError("Die Adresse ist leer, zu lang oder enthält Leerzeichen")
try:
parts = urlsplit(value)
host = parts.hostname
parts.port # noqa: B018 - raises ValueError for an invalid port
except ValueError:
raise ValueError("Die Adresse ist ungültig") from None
if parts.scheme not in ("http", "https") or not host:
raise ValueError("Die Adresse muss mit http:// oder https:// beginnen")
if parts.username or parts.password:
raise ValueError("Zugangsdaten gehören nicht in die Adresse")
try:
literal = ipaddress.ip_address(host)
except ValueError:
literal = None
if literal is not None and _forbidden(literal):
raise ValueError("Diese Adresse (lokal, Link-Local oder Metadaten-Dienst) ist als Ziel nicht erlaubt")
if literal is None and host.lower() in ("localhost", "localhost.localdomain"):
raise ValueError("Diese Adresse (lokal, Link-Local oder Metadaten-Dienst) ist als Ziel nicht erlaubt")
return value
async def ensure_resolved_safe(url: str) -> None:
"""Send-time check against DNS answers pointing at forbidden addresses. Raises ValueError."""
host = urlsplit(url).hostname
if not host:
raise ValueError("Die Adresse ist ungültig")
try:
ipaddress.ip_address(host)
return # a literal was already checked by validate_url
except ValueError:
pass
try:
infos = await asyncio.get_running_loop().getaddrinfo(host, None, type=socket.SOCK_STREAM)
except OSError:
return
for info in infos:
try:
ip = ipaddress.ip_address(info[4][0].split("%")[0])
except ValueError:
continue
if _forbidden(ip):
raise ValueError("Der Name zeigt auf eine nicht erlaubte Adresse (lokal, Link-Local oder Metadaten-Dienst)")
+78
View File
@@ -0,0 +1,78 @@
"""Site variables: ``{{NAME}}`` placeholders in centrally authored objects, filled per host.
A rule, alias or NAT entry can say ``{{LAN_NET}}`` instead of a literal network; every host that object is
deployed to supplies its own value (Host page > Variables). Resolution happens when the payload for one host is
built, so preview, deploy, the change counters and the audit all see the host's real values.
Fail closed: a placeholder without a value for a target host is never pushed. Preview marks that host
``missing_variable``, the deploy is refused before anything is written, and as a last line of defence
``opnsense_client`` refuses to send any payload that still contains a placeholder.
"""
import re
from typing import Callable
from app.models.host import OpnsenseHost
NAME_RE = re.compile(r"^[A-Z][A-Z0-9_]{0,39}$")
VALUE_RE = re.compile(r"^[\w .:/,@+\-]{1,255}$") # networks, addresses, hostnames, names, lists: no braces, quotes or newlines
PLACEHOLDER = re.compile(r"\{\{\s*([A-Z][A-Z0-9_]{0,39})\s*\}\}")
class MissingVariables(Exception):
"""One or more hosts lack values for placeholders the object uses. ``missing`` maps host name -> names."""
def __init__(self, missing: dict[str, list[str]]):
self.missing = missing
super().__init__("; ".join(f"{host}: {', '.join(names)}" for host, names in missing.items()))
def names_in(value) -> set[str]:
return set(PLACEHOLDER.findall(value)) if isinstance(value, str) else set()
def names_in_payload(payload: dict) -> set[str]:
found: set[str] = set()
for value in payload.values():
found |= names_in(value)
return found
def host_values(host: OpnsenseHost) -> dict[str, str]:
return {v.name: v.value for v in host.variables}
def resolve(payload: dict, host: OpnsenseHost) -> dict:
"""The payload with this host's values filled in; raises MissingVariables if one is not defined."""
values = host_values(host)
missing = sorted(n for n in names_in_payload(payload) if n not in values)
if missing:
raise MissingVariables({host.name: missing})
return {k: PLACEHOLDER.sub(lambda m: values[m.group(1)], v) if isinstance(v, str) else v for k, v in payload.items()}
def ensure_resolvable(builder: Callable, entity, hosts: list[OpnsenseHost]) -> None:
"""Raise MissingVariables (listing every affected host) before anything is written."""
missing: dict[str, list[str]] = {}
for host in hosts:
try:
builder(entity, host)
except MissingVariables as exc:
missing.update(exc.missing)
if missing:
raise MissingVariables(missing)
def payload_or_none(builder: Callable, entity, host: OpnsenseHost):
try:
return builder(entity, host)
except MissingVariables:
return None
def preview_row_missing(host: OpnsenseHost, names: list[str], dep) -> dict:
return {
"host_id": str(host.id), "host_name": host.name, "action": "missing_variable",
"status": dep.status if dep else None,
"message": "Variable fehlt: " + ", ".join(names), "can_remove": False,
"can_retry_rollback": False, "changes": [],
}
+147
View File
@@ -0,0 +1,147 @@
"""Occurrences of recurring maintenance windows.
Rules (deliberately simple and written down, because a firmware rollout depends on them):
* A window is a wall-clock start time in its own IANA time zone plus a duration. "Sunday 02:00
Europe/Berlin" stays 02:00 local time in summer and in winter.
* Daylight saving: a local start time that does not exist on that day (spring forward, e.g. 02:30 on
the last Sunday of March in Europe/Berlin) moves FORWARD by the gap (03:30). A local time that
exists twice (fall back) means the FIRST of the two (fold=0, still summer time). Both follow from
Python's zoneinfo with fold=0 and are covered by tests.
* The duration is real elapsed time (a 3 h window over the fall-back night still lasts 3 h).
* Exceptions are keyed by the occurrence's local date: "skip" drops it, "move" replaces its start
with an absolute instant (same duration and cut-off).
* New host actions may only START within the first ``start_cutoff_minutes`` of an occurrence
(``startable``); actions already running finish even after the window has closed.
"""
from dataclasses import dataclass
from datetime import date, datetime, timedelta, timezone
from zoneinfo import ZoneInfo, ZoneInfoNotFoundError, available_timezones
from app.models.maintenance_window import MaintenanceWindow
# How far ahead occurrences are searched. A monthly "5th ..." does not exist; the longest real gap
# between two occurrences is a month, so two years is plenty and bounds the work per call.
_SEARCH_DAYS = 2 * 366
MAX_DURATION_MINUTES = 24 * 60
@dataclass(frozen=True)
class Occurrence:
local_date: date
start: datetime # UTC
end: datetime # UTC
cutoff: datetime # UTC: no new host action after this instant
moved: bool = False
skipped: bool = False
def as_dict(self) -> dict:
return {"local_date": self.local_date.isoformat(), "start": self.start.isoformat(), "end": self.end.isoformat(),
"cutoff": self.cutoff.isoformat(), "moved": self.moved, "skipped": self.skipped}
def valid_timezone(name: str) -> bool:
if not name or name not in available_timezones():
return False
try:
ZoneInfo(name)
except (ZoneInfoNotFoundError, ValueError):
return False
return True
def _matches(window: MaintenanceWindow, day: date) -> bool:
if window.recurrence == "weekly":
return day.weekday() in (window.weekdays or [])
if window.recurrence == "monthly":
if window.month_mode == "day":
return day.day == window.month_day
if window.month_mode == "nth_weekday":
if day.weekday() != window.month_weekday:
return False
if window.month_nth == -1:
return (day + timedelta(days=7)).month != day.month
return (day.day - 1) // 7 + 1 == window.month_nth
return False
def local_start(window: MaintenanceWindow, day: date) -> datetime:
"""The UTC instant of the window's start on local date ``day`` (DST rules see module docstring)."""
tz = ZoneInfo(window.timezone)
wall = datetime.combine(day, window.start_time, tzinfo=tz).replace(fold=0)
return wall.astimezone(timezone.utc)
def _occurrence(window: MaintenanceWindow, day: date, start: datetime, *, moved: bool = False, skipped: bool = False) -> Occurrence:
duration = timedelta(minutes=window.duration_minutes)
cutoff = timedelta(minutes=min(window.start_cutoff_minutes, window.duration_minutes))
return Occurrence(local_date=day, start=start, end=start + duration, cutoff=start + cutoff, moved=moved, skipped=skipped)
def occurrences(window: MaintenanceWindow, after: datetime, n: int = 10, *, with_skipped: bool = False) -> list[Occurrence]:
"""The next ``n`` occurrences whose END lies after ``after`` (so one that is open right now is first).
``with_skipped`` lists skipped ones too (flagged, for the UI); the engine never sees them."""
if n <= 0:
return []
after = after.astimezone(timezone.utc)
tz = ZoneInfo(window.timezone)
exceptions = {e.occurrence_date: e for e in (window.exceptions or [])}
duration = timedelta(minutes=window.duration_minutes)
# Start one day early: an occurrence that began yesterday (local) may still be open.
day = (after - duration).astimezone(tz).date() - timedelta(days=1)
found: list[Occurrence] = []
# Moved occurrences can land anywhere, so they are collected separately and merged at the end.
for exc in exceptions.values():
if exc.kind == "move" and exc.moved_start is not None and _matches(window, exc.occurrence_date):
occ = _occurrence(window, exc.occurrence_date, exc.moved_start.astimezone(timezone.utc), moved=True)
if occ.end > after:
found.append(occ)
regular = 0
for _ in range(_SEARCH_DAYS):
if regular >= n:
break
if _matches(window, day):
exc = exceptions.get(day)
if exc is None or (with_skipped and exc.kind == "skip"):
occ = _occurrence(window, day, local_start(window, day), skipped=exc is not None)
if occ.end > after:
found.append(occ)
regular += 1
day += timedelta(days=1)
found.sort(key=lambda o: o.start)
return found[:n]
def current(window: MaintenanceWindow, now: datetime) -> Occurrence | None:
"""The occurrence open at ``now`` (start <= now < end), if any."""
if not window.enabled:
return None
for occ in occurrences(window, now, 3):
if occ.start <= now < occ.end:
return occ
return None
def startable(window: MaintenanceWindow | None, now: datetime) -> Occurrence | None:
"""The occurrence in which a NEW host action may start right now (start <= now < cutoff)."""
if window is None or not window.enabled:
return None
occ = current(window, now)
if occ is not None and occ.start <= now < occ.cutoff:
return occ
return None
def is_occurrence_date(window: MaintenanceWindow, day: date) -> bool:
return _matches(window, day)
def definition(window: MaintenanceWindow) -> dict:
"""What a rollout plan's fingerprint covers: changing any of this re-requires activation."""
return {
"id": str(window.id), "timezone": window.timezone, "recurrence": window.recurrence,
"weekdays": sorted(window.weekdays or []), "month_mode": window.month_mode, "month_nth": window.month_nth,
"month_weekday": window.month_weekday, "month_day": window.month_day,
"start_time": window.start_time.strftime("%H:%M"), "duration_minutes": window.duration_minutes,
"start_cutoff_minutes": window.start_cutoff_minutes, "enabled": window.enabled,
}
+2 -2
View File
@@ -6,5 +6,5 @@ convention — but both are bumped together whenever a release ships).
Versioning scheme: see CHANGELOG.md ("Versionierung").
"""
APP_VERSION = "1.21.0"
APP_CODENAME = "Osprey"
APP_VERSION = "1.27.1"
APP_CODENAME = "Buzzard"
@@ -0,0 +1,34 @@
"""Standort-Variablen: Werte für {{NAME}}-Platzhalter je Host.
Revision ID: 0016
Revises: 0015
Create Date: 2026-10-20
"""
import sqlalchemy as sa
from alembic import op
from sqlalchemy.dialects import postgresql
revision = "0016"
down_revision = "0015"
branch_labels = None
depends_on = None
def upgrade() -> None:
if sa.inspect(op.get_bind()).has_table("host_variables"):
return
op.create_table(
"host_variables",
sa.Column("id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("host_id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("name", sa.String(length=41), nullable=False),
sa.Column("value", sa.String(length=255), nullable=False),
sa.ForeignKeyConstraint(["host_id"], ["opnsense_hosts.id"], ondelete="CASCADE"),
sa.PrimaryKeyConstraint("id"),
sa.UniqueConstraint("host_id", "name", name="uq_host_variable"),
)
op.create_index("ix_host_variables_host_id", "host_variables", ["host_id"])
def downgrade() -> None:
op.execute("DROP TABLE IF EXISTS host_variables")
@@ -0,0 +1,20 @@
"""Benachrichtigung bei kritischen/hohen Sicherheitsbefunden (standardmäßig aus).
Revision ID: 0017
Revises: 0016
Create Date: 2026-10-20
"""
from alembic import op
revision = "0017"
down_revision = "0016"
branch_labels = None
depends_on = None
def upgrade() -> None:
op.execute("ALTER TABLE notification_settings ADD COLUMN IF NOT EXISTS compliance_alerts_enabled boolean NOT NULL DEFAULT false")
def downgrade() -> None:
op.execute("ALTER TABLE notification_settings DROP COLUMN IF EXISTS compliance_alerts_enabled")
@@ -0,0 +1,21 @@
"""OIDC: Standard-Scopes ohne "groups" (Keycloak und Entra ID lehnen den Scope als ungültig ab).
Revision ID: 0018
Revises: 0017
Create Date: 2026-10-20
"""
from alembic import op
revision = "0018"
down_revision = "0017"
branch_labels = None
depends_on = None
def upgrade() -> None:
# Only rows still carrying the old default; a value somebody typed on purpose stays.
op.execute("UPDATE oidc_settings SET scopes = 'openid profile email' WHERE scopes = 'openid profile email groups'")
def downgrade() -> None:
pass
@@ -0,0 +1,31 @@
"""Versionsprüfung im Webinterface einstellbar.
Revision ID: 0019
Revises: 0018
Create Date: 2026-10-20
"""
import sqlalchemy as sa
from alembic import op
revision = "0019"
down_revision = "0018"
branch_labels = None
depends_on = None
_DEFAULT_FEED_URL = "https://updates.opnexus.dev/latest.json"
def upgrade() -> None:
if sa.inspect(op.get_bind()).has_table("update_check_settings"):
return
op.create_table(
"update_check_settings",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("enabled", sa.Boolean(), server_default="false", nullable=False),
sa.Column("feed_url", sa.String(length=500), server_default=_DEFAULT_FEED_URL, nullable=False),
sa.PrimaryKeyConstraint("id"),
)
def downgrade() -> None:
op.execute("DROP TABLE IF EXISTS update_check_settings")
Loaded 100 of 182 files, more files were not shown because too many files have changed in this diff. Show more