Compare commits

..
9 Commits
Author SHA1 Message Date
Julian Boldt f5dbe8a41a Release v1.21.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
- **Management-Tunnel** (System › Management-Tunnel): Firewalls hinter NAT/CGNAT verwalten. Ein optionaler WireGuard-Hub auf dem
  OPNexus-Server (Compose-Profil `overlay`, Container `wg-hub` aus dem Backend-Image mit `NET_ADMIN`) nimmt die Firewalls entgegen, die sich
  nach außen einwählen; OPNexus erreicht deren API über einen kleinen CONNECT-Proxy des Hubs, der nur ins Tunnel-Netz verbindet. Je Firewall
  eine Tunnel-Adresse und ein eigener Pre-Shared Key, Anleitung mit kopierbaren Werten, Live-Status (Handshake, Datenmenge). Der Hub nimmt
  keine neuen Verbindungen aus dem Tunnel an. Ende-zu-Ende gegen eine echte OPNsense 26.7 geprüft (Handshake, API, Zertifikat festsetzen).
  Neue Tabellen `overlay_settings`, `overlay_peers` (Migration `0015`); das Backend-Image enthält jetzt `wireguard-tools`, `iproute2`, `iptables`.
2026-10-20 01:21:45 +02:00
Julian Boldt 552c88e425 Release v1.20.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
- **Single Sign-on (OIDC)**: Anmeldung über Authentik, Keycloak, Entra ID, Google u. a. (Authorization Code mit PKCE). Die Rolle
  kommt bei jeder Anmeldung aus den Gruppen des Anbieters, ohne zugeordnete Gruppe kommt niemand hinein; SSO-Konten werden nie mit
  lokalen Konten verknüpft; lokale Anmeldung bleibt als Notzugang. ID-Token werden streng geprüft (Signatur nur asymmetrisch, Aussteller,
  Zielgruppe, Ablauf, Nonce, einmaliger State), gegen einen nachgebauten Anbieter getestet (inkl. Fälschungsversuche). Neue Tabellen
  `oidc_settings`, `oidc_login_states`, Spalten `admin_users.auth_source/oidc_subject` (Migration `0013`). Neue Abhängigkeit: PyJWT.
- **Behoben:** `opnexus backup --full` und `opnexus restore` (Vollsicherung, in 1.19.0 beschrieben) fehlten im 1.19.0-Bundle und -Updater-Image,
  weil die Änderung am Skript nicht mit eingecheckt war; sie sind erst ab dieser Version enthalten.
- **Aufgabentrennung**: Schalter, mit dem nur Admins ausrollen dürfen, Operatoren aber vorbereiten (Migration `0014`).
2026-10-20 00:50:45 +02:00
Julian Boldt b2c69f51a0 Release v1.19.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
Backups, Governance, Regelnutzung. Auf einem Test-Stack mit drei Test-Firewalls geprüft; die Vollsicherung Ende-zu-Ende
(sichern, Schaden anrichten, zurückspielen), siehe Handbuch „Konfigurationssicherungen“, „Sichern und Wiederherstellen“.

- **Rolle „Operator“**: rollt aus und betreibt (Regeln, NAT, VPN, Wartung, Sicherungen), verwaltet aber keine
  Benutzer, Einstellungen oder Hosts und lädt keine Roh-Backups herunter. Abgelehnte Versuche stehen im Audit.
  Tokens eines Operators gehen bis zum Bereich „Ausrollen“.
- **Audit-Export** (Einstellungen): Syslog (RFC 5424, UDP/TCP/TLS) und/oder signierter Webhook, mindestens
  einmal zugestellt, ohne Objektinhalte. Neue Tabelle `audit_export_settings` (Migration `0010`).
- **Geplante Backups** mit Aufbewahrung, **verschlüsseltem Offsite-Ziel** (S3-kompatibel, AES-256-GCM,
  Passphrase bleibt auf dem Server), Benachrichtigungen bei Problemen und einer **Änderungsansicht** zwischen
  zwei Sicherungen (Geheimnisse nur als Hash). Neue Tabellen `backup_settings`, `backup_uploads`, Spalte
  `notification_settings.backup_failed_enabled` (Migration `0011`). Die S3-Signatur ist gegen die offiziellen
  AWS-Beispiele geprüft; ein Lauf gegen einen echten Anbieter steht noch aus.
- **Vollsicherung** `opnexus backup --full` und `opnexus restore`: Datenbank und alle Geheimnis-Volumes in einer
  verschlüsselten Datei; Ende-zu-Ende auf dem Test-Stack geprüft (Sichern, Schaden anrichten, Zurückspielen).
- **Regelnutzung**: wann hat jede Regel zuletzt etwas getroffen (aus den pf-Zählern, überlebt Neuladen und
  Neustart); Befund „Regeln in Benutzung“ in der Sicherheitslage nach 30 Tagen ohne Treffer. Neue Tabelle
  `rule_hits` (Migration `0012`).
- Änderungen an Einstellungen (`/api/settings/…`) und das Auslösen von Sicherungen stehen jetzt im Audit.
2026-10-20 00:26:57 +02:00
Julian Boldt 218a1f14ac Release v1.18.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
Automatisierung und Sicherheitslage. Ende-zu-Ende gegen einen Test-Stack und drei Test-Firewalls geprüft,
siehe Handbuch „Sicherheitslage“ und „Automatisierung“.

- **API-Tokens** (System › API-Tokens): persönliche Tokens für Skripte, CI, Prometheus und KI-Assistenten,
  Bereiche *Lesen*, *Ausrollen*, *Admin*. Nur als Hash gespeichert, einmal angezeigt, widerrufbar, mit
  Ablaufdatum; Anlegen verlangt das Passwort. Ein Token überschreitet nie die Rechte seines Besitzers.
  Tokens verwalten und das eigene Konto geht nur in einer normalen Anmeldung. Geheimnisse (Roh-Backups,
  Benachrichtigungseinstellungen) liest nur der Bereich *Admin*. Das Audit nennt das Token. Neue Tabelle
  `api_tokens` (Migration `0008`).
- **Prometheus-Metriken** unter `GET /api/metrics` (Host erreichbar, Last, Speicher, Platte, CARP-Rolle,
  offene Aktionen und Probleme, Sicherheitswert), nur aus der Datenbank, ohne Anfragen an die Firewalls.
- **MCP-Endpunkt** `POST /api/mcp` (nur lesend) für KI-Assistenten: Flottenübersicht, Hosts, Auslastung, CARP-Ereignisse,
  Audit, Suche und ein Leser für jeden GET-Endpunkt, mit den Rechten des Tokens.
- **OpenAPI-Schema** jetzt unter `/api/openapi.json` (bisher unter `/openapi.json`, vom Proxy nicht
  erreichbar); die Swagger-/ReDoc-Seiten entfallen (ihre CDN-Skripte verbietet die CSP).
- **Sicherheitslage** (Monitoring › Sicherheitslage): Härtungs- und Regel-Hygiene-Prüfungen je Firewall mit Wert
  0–100: Allow-all am WAN, HTTPS, SSH, SNMP, verdeckte/doppelte/unbeschriftete Regeln, Zeitserver, externe
  Logs, Firmware, Backup-Alter. Liest die Konfiguration nur lesend, speichert sie nicht, alle 6 Stunden und
  auf Knopfdruck. Neue Tabelle `compliance_results` (Migration `0009`).
- Behoben: Änderungen am Benutzer in einer Anfrage (z. B. 2FA aktivieren) gingen verloren, wenn die
  Middleware den Benutzer aus einer anderen Datenbank-Sitzung lieferte; er wird jetzt in der Sitzung der
  Anfrage neu geladen.
2026-10-19 23:54:02 +02:00
Julian Boldt 79783d6d62 Release v1.17.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
Geplante Wartung: Fehler zeigen sich sofort statt erst um 3 Uhr nachts, und der Master lässt sich
unbeaufsichtigt aktualisieren. Auf einem Test-Cluster live geprüft (Neustart und ein echtes Update
mit Umschaltung), siehe Handbuch „Geplante Wartung“.

- **Rollenprüfung beim Einplanen:** Ein Host, der in einem Cluster gerade CARP-MASTER ist,
  lässt sich nicht mehr einplanen (Neustart/Update/Major-Upgrade). Bisher wurde der Plan
  angenommen und scheiterte erst zur Uhrzeit. Der Planungsdialog zeigt den Grund an und
  sperrt den Button. Ist die Rolle nicht feststellbar (Host gerade nicht erreichbar), wird
  weiter angenommen; die volle Prüfung läuft wie bisher zum Zündzeitpunkt.
- **Benachrichtigung „Geplante Wartung nicht ausgeführt“:** Eine fehlgeschlagene geplante
  Wartung meldet sich per Webhook/E-Mail (einzeln schaltbar in den Einstellungen, standardmäßig
  an). Offen für drei Tage nach dem geplanten Zeitpunkt, dann ohne „behoben“-Meldung geschlossen.
  Neue Spalte `notification_settings.scheduled_maintenance_failed_enabled` (Migration `0006`).
- **Automatische CARP-Umschaltung (Option pro Plan, standardmäßig aus):** Ein geplanter Neustart,
  Update oder Major-Upgrade auf dem MASTER schaltet vorher auf den Partner um, prüft die
  Übernahme, führt die Aktion aus, wartet auf die Rückkehr des Hosts und schaltet zurück. Fehler
  vor dem Start der Aktion stellen den Normalbetrieb wieder her; danach bleibt der Host bewusst im
  Wartungsmodus (Partner trägt den Verkehr) und es kommt eine Benachrichtigung. Der Ablauf steht in
  der Datenbank und überlebt einen Neustart des Backends. Neue Spalten an `scheduled_maintenance`
  (Migration `0007`).
- **Backup vor geplantem Update:** Ein geplantes Update oder Major-Upgrade zieht unmittelbar vor
  dem Start selbst ein Konfigurationsbackup (nur lesend auf der Firewall). Bisher scheiterte jeder
  Plan, der mehr als 24 Stunden in der Zukunft lag, an der Backup-Aktualität. Schlägt das Backup
  fehl, wird nicht aktualisiert.
2026-10-19 16:45:07 +02:00
Julian Boldt c15417869b Handbook rewritten as a user manual
docs/HANDBUCH.md is now organised for operators (install, TLS, configuration, users, firewalls, rules, network, VPN, certificates, HA, updates, monitoring, operation, security, troubleshooting, limits). The unused September screenshots are removed; README and configuration comments point at the new section names.
2026-10-10 14:36:58 +02:00
Julian Boldt cf326d2d17 Release v1.16.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
Erste Schritte nach der Installation. Ende-zu-Ende gegen einen isolierten Stack getestet, siehe
Handbuch „Einrichtungsassistent und Passwort-Reset“:

- **Einrichtungsassistent** (`/setup`, System › Einrichtung): vier Schritte mit Erklärungen —
  Willkommen und Sprache, Konto (eigenes Passwort, Zwei-Faktor-Anmeldung), erste Firewall
  verbinden (inklusive Anleitung für den API-Key in OPNsense, Zertifikat festsetzen,
  Verbindungsstatus) und eine Übersicht, was als Nächstes sinnvoll ist. Auf einer frischen
  Installation ohne Hosts öffnet er sich nach der ersten Anmeldung von selbst; „Assistent
  überspringen“ merkt sich das pro Benutzer, erneut öffnen geht jederzeit über System › Einrichtung
  oder die Einstellungen. Nur für Admins. Neue Spalte `user_preferences.setup_done`
  (Migration `0005`).
- **`opnexus password [NAME]`** setzt ein neues Zufallspasswort für den Admin und zeigt es an
  (`--yes` ohne Rückfrage; Rückfrage nur, wenn sich schon jemand angemeldet hat). Ersetzt das
  Suchen im Backend-Log nach dem beim ersten Start erzeugten Passwort und taugt zugleich für ein
  vergessenes Admin-Passwort. Alle Sitzungen des Kontos enden. Dahinter steht
  `python -m app.reset_password`. Die Meldung beim ersten Start verweist darauf.
2026-10-10 14:15:55 +02:00
Julian Boldt 8fccb1a547 Remove maintainer and website tooling from the public repository
Website build/deploy scripts, release/publishing tooling, developer verification scripts and internal planning notes are not part of the product for operators. The release process notes moved out of the manual.
2026-10-10 12:43:22 +02:00
Julian Boldt cf59bdb38e Remove website sources from the public repository
The site opnexus.dev is built and deployed from a separate repository. README images now live in docs/screenshots/.
2026-10-10 12:40:41 +02:00
148 changed files with 15993 additions and 3652 deletions

No files matched your search

+11 -6
View File
@@ -36,7 +36,7 @@ PROXY_BIND_ADDRESS=0.0.0.0
# Host interface the backend/frontend ports are published on. Defaults
# to 127.0.0.1 (this host only) if unset. Set to 0.0.0.0 for access from
# other machines without a reverse proxy (see README's "Produktivbetrieb"
# other machines without a reverse proxy (see the handbook, "Zugriff aus dem Netz und TLS"
# for the safer TLS-proxy alternative), or to one specific interface IP.
BIND_ADDRESS=
# Host-Ports von Backend und Frontend (nur nötig, wenn 8100/3100 schon belegt
@@ -44,15 +44,15 @@ BIND_ADDRESS=
# BACKEND_PORT=8100
# FRONTEND_PORT=3100
# Set to true once this is running behind TLS (see README's
# "Produktivbetrieb" section) — otherwise the session cookie is sent
# Set to true once this is running behind TLS (see the handbook,
# "Zugriff aus dem Netz und TLS") — otherwise the session cookie is sent
# unencrypted and browsers won't even attach a Secure cookie without
# HTTPS in the first place.
COOKIE_SECURE=false
# Set to true ONLY when running behind a reverse proxy you trust to
# always set/overwrite X-Forwarded-For itself (every example in README's
# "Produktivbetrieb" does). Used to attribute failed logins to the real
# always set/overwrite X-Forwarded-For itself (every example in the handbook's
# "Zugriff aus dem Netz und TLS" does). Used to attribute failed logins to the real
# client IP for the login lockout instead of the proxy's own IP. Leave
# false (default) if the app is reachable directly with no proxy in
# front — otherwise any client could spoof this header to dodge the
@@ -80,7 +80,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.
# AUS. Benötigt außerdem UPDATE_CHECK_URL (oben). Siehe Handbuch, "Updates per Klick".
# COMPOSE_PROFILES=updater
# ── Transportsicherheit (nur ändern, wenn nötig) ──────────────────────
@@ -93,3 +93,8 @@ TRUST_PROXY_HEADERS=false
# SMTP_CA_FILE=/data/smtp-ca.pem
# SMTP-Anmeldung ohne Verschlüsselung (Sicherheit "none") bleibt gesperrt.
# ALLOW_INSECURE_SMTP_AUTH=false
# Management-Tunnel (WireGuard-Hub für Firewalls hinter NAT), optional.
# Zum Aktivieren (Handbuch „Firewalls hinter NAT“): COMPOSE_PROFILES=overlay
# und den UDP-Port aus dem Internet erreichbar machen.
#OVERLAY_PORT=51820
+113
View File
@@ -31,6 +31,119 @@ den Einstellungen.
Nächste Codenamen (der Reihe nach, wenn die jeweils nächste MINOR-Version
ansteht): Merlin …
## [1.21.0] "Osprey" — 2026-10-20
- **Management-Tunnel** (System › Management-Tunnel): Firewalls hinter NAT/CGNAT verwalten. Ein optionaler WireGuard-Hub auf dem
OPNexus-Server (Compose-Profil `overlay`, Container `wg-hub` aus dem Backend-Image mit `NET_ADMIN`) nimmt die Firewalls entgegen, die sich
nach außen einwählen; OPNexus erreicht deren API über einen kleinen CONNECT-Proxy des Hubs, der nur ins Tunnel-Netz verbindet. Je Firewall
eine Tunnel-Adresse und ein eigener Pre-Shared Key, Anleitung mit kopierbaren Werten, Live-Status (Handshake, Datenmenge). Der Hub nimmt
keine neuen Verbindungen aus dem Tunnel an. Ende-zu-Ende gegen eine echte OPNsense 26.7 geprüft (Handshake, API, Zertifikat festsetzen).
Neue Tabellen `overlay_settings`, `overlay_peers` (Migration `0015`); das Backend-Image enthält jetzt `wireguard-tools`, `iproute2`, `iptables`.
## [1.20.0] "Lilli" — 2026-10-20
- **Single Sign-on (OIDC)**: Anmeldung über Authentik, Keycloak, Entra ID, Google u. a. (Authorization Code mit PKCE). Die Rolle
kommt bei jeder Anmeldung aus den Gruppen des Anbieters, ohne zugeordnete Gruppe kommt niemand hinein; SSO-Konten werden nie mit
lokalen Konten verknüpft; lokale Anmeldung bleibt als Notzugang. ID-Token werden streng geprüft (Signatur nur asymmetrisch, Aussteller,
Zielgruppe, Ablauf, Nonce, einmaliger State), gegen einen nachgebauten Anbieter getestet (inkl. Fälschungsversuche). Neue Tabellen
`oidc_settings`, `oidc_login_states`, Spalten `admin_users.auth_source/oidc_subject` (Migration `0013`). Neue Abhängigkeit: PyJWT.
- **Behoben:** `opnexus backup --full` und `opnexus restore` (Vollsicherung, in 1.19.0 beschrieben) fehlten im 1.19.0-Bundle und -Updater-Image,
weil die Änderung am Skript nicht mit eingecheckt war; sie sind erst ab dieser Version enthalten.
- **Aufgabentrennung**: Schalter, mit dem nur Admins ausrollen dürfen, Operatoren aber vorbereiten (Migration `0014`).
## [1.19.0] "Lanner" — 2026-10-20
Backups, Governance, Regelnutzung. Auf einem Test-Stack mit drei Test-Firewalls geprüft; die Vollsicherung Ende-zu-Ende
(sichern, Schaden anrichten, zurückspielen), siehe Handbuch „Konfigurationssicherungen“, „Sichern und Wiederherstellen“.
- **Rolle „Operator“**: rollt aus und betreibt (Regeln, NAT, VPN, Wartung, Sicherungen), verwaltet aber keine
Benutzer, Einstellungen oder Hosts und lädt keine Roh-Backups herunter. Abgelehnte Versuche stehen im Audit.
Tokens eines Operators gehen bis zum Bereich „Ausrollen“.
- **Audit-Export** (Einstellungen): Syslog (RFC 5424, UDP/TCP/TLS) und/oder signierter Webhook, mindestens
einmal zugestellt, ohne Objektinhalte. Neue Tabelle `audit_export_settings` (Migration `0010`).
- **Geplante Backups** mit Aufbewahrung, **verschlüsseltem Offsite-Ziel** (S3-kompatibel, AES-256-GCM,
Passphrase bleibt auf dem Server), Benachrichtigungen bei Problemen und einer **Änderungsansicht** zwischen
zwei Sicherungen (Geheimnisse nur als Hash). Neue Tabellen `backup_settings`, `backup_uploads`, Spalte
`notification_settings.backup_failed_enabled` (Migration `0011`). Die S3-Signatur ist gegen die offiziellen
AWS-Beispiele geprüft; ein Lauf gegen einen echten Anbieter steht noch aus.
- **Vollsicherung** `opnexus backup --full` und `opnexus restore`: Datenbank und alle Geheimnis-Volumes in einer
verschlüsselten Datei; Ende-zu-Ende auf dem Test-Stack geprüft (Sichern, Schaden anrichten, Zurückspielen).
- **Regelnutzung**: wann hat jede Regel zuletzt etwas getroffen (aus den pf-Zählern, überlebt Neuladen und
Neustart); Befund „Regeln in Benutzung“ in der Sicherheitslage nach 30 Tagen ohne Treffer. Neue Tabelle
`rule_hits` (Migration `0012`).
- Änderungen an Einstellungen (`/api/settings/…`) und das Auslösen von Sicherungen stehen jetzt im Audit.
## [1.18.0] "Kestrel" — 2026-10-19
Automatisierung und Sicherheitslage. Ende-zu-Ende gegen einen Test-Stack und drei Test-Firewalls geprüft,
siehe Handbuch „Sicherheitslage“ und „Automatisierung“.
- **API-Tokens** (System › API-Tokens): persönliche Tokens für Skripte, CI, Prometheus und KI-Assistenten,
Bereiche *Lesen*, *Ausrollen*, *Admin*. Nur als Hash gespeichert, einmal angezeigt, widerrufbar, mit
Ablaufdatum; Anlegen verlangt das Passwort. Ein Token überschreitet nie die Rechte seines Besitzers.
Tokens verwalten und das eigene Konto geht nur in einer normalen Anmeldung. Geheimnisse (Roh-Backups,
Benachrichtigungseinstellungen) liest nur der Bereich *Admin*. Das Audit nennt das Token. Neue Tabelle
`api_tokens` (Migration `0008`).
- **Prometheus-Metriken** unter `GET /api/metrics` (Host erreichbar, Last, Speicher, Platte, CARP-Rolle,
offene Aktionen und Probleme, Sicherheitswert), nur aus der Datenbank, ohne Anfragen an die Firewalls.
- **MCP-Endpunkt** `POST /api/mcp` (nur lesend) für KI-Assistenten: Flottenübersicht, Hosts, Auslastung, CARP-Ereignisse,
Audit, Suche und ein Leser für jeden GET-Endpunkt, mit den Rechten des Tokens.
- **OpenAPI-Schema** jetzt unter `/api/openapi.json` (bisher unter `/openapi.json`, vom Proxy nicht
erreichbar); die Swagger-/ReDoc-Seiten entfallen (ihre CDN-Skripte verbietet die CSP).
- **Sicherheitslage** (Monitoring › Sicherheitslage): Härtungs- und Regel-Hygiene-Prüfungen je Firewall mit Wert
0–100: Allow-all am WAN, HTTPS, SSH, SNMP, verdeckte/doppelte/unbeschriftete Regeln, Zeitserver, externe
Logs, Firmware, Backup-Alter. Liest die Konfiguration nur lesend, speichert sie nicht, alle 6 Stunden und
auf Knopfdruck. Neue Tabelle `compliance_results` (Migration `0009`).
- Behoben: Änderungen am Benutzer in einer Anfrage (z. B. 2FA aktivieren) gingen verloren, wenn die
Middleware den Benutzer aus einer anderen Datenbank-Sitzung lieferte; er wird jetzt in der Sitzung der
Anfrage neu geladen.
## [1.17.0] "Imperial" — 2026-10-19
Geplante Wartung: Fehler zeigen sich sofort statt erst um 3 Uhr nachts, und der Master lässt sich
unbeaufsichtigt aktualisieren. Auf einem Test-Cluster live geprüft (Neustart und ein echtes Update
mit Umschaltung), siehe Handbuch „Geplante Wartung“.
- **Rollenprüfung beim Einplanen:** Ein Host, der in einem Cluster gerade CARP-MASTER ist,
lässt sich nicht mehr einplanen (Neustart/Update/Major-Upgrade). Bisher wurde der Plan
angenommen und scheiterte erst zur Uhrzeit. Der Planungsdialog zeigt den Grund an und
sperrt den Button. Ist die Rolle nicht feststellbar (Host gerade nicht erreichbar), wird
weiter angenommen; die volle Prüfung läuft wie bisher zum Zündzeitpunkt.
- **Benachrichtigung „Geplante Wartung nicht ausgeführt“:** Eine fehlgeschlagene geplante
Wartung meldet sich per Webhook/E-Mail (einzeln schaltbar in den Einstellungen, standardmäßig
an). Offen für drei Tage nach dem geplanten Zeitpunkt, dann ohne „behoben“-Meldung geschlossen.
Neue Spalte `notification_settings.scheduled_maintenance_failed_enabled` (Migration `0006`).
- **Automatische CARP-Umschaltung (Option pro Plan, standardmäßig aus):** Ein geplanter Neustart,
Update oder Major-Upgrade auf dem MASTER schaltet vorher auf den Partner um, prüft die
Übernahme, führt die Aktion aus, wartet auf die Rückkehr des Hosts und schaltet zurück. Fehler
vor dem Start der Aktion stellen den Normalbetrieb wieder her; danach bleibt der Host bewusst im
Wartungsmodus (Partner trägt den Verkehr) und es kommt eine Benachrichtigung. Der Ablauf steht in
der Datenbank und überlebt einen Neustart des Backends. Neue Spalten an `scheduled_maintenance`
(Migration `0007`).
- **Backup vor geplantem Update:** Ein geplantes Update oder Major-Upgrade zieht unmittelbar vor
dem Start selbst ein Konfigurationsbackup (nur lesend auf der Firewall). Bisher scheiterte jeder
Plan, der mehr als 24 Stunden in der Zukunft lag, an der Backup-Aktualität. Schlägt das Backup
fehl, wird nicht aktualisiert.
## [1.16.0] "Hobby" — 2026-10-10
Erste Schritte nach der Installation. Ende-zu-Ende gegen einen isolierten Stack getestet, siehe
Handbuch „Einrichtungsassistent und Passwort-Reset“:
- **Einrichtungsassistent** (`/setup`, System › Einrichtung): vier Schritte mit Erklärungen —
Willkommen und Sprache, Konto (eigenes Passwort, Zwei-Faktor-Anmeldung), erste Firewall
verbinden (inklusive Anleitung für den API-Key in OPNsense, Zertifikat festsetzen,
Verbindungsstatus) und eine Übersicht, was als Nächstes sinnvoll ist. Auf einer frischen
Installation ohne Hosts öffnet er sich nach der ersten Anmeldung von selbst; „Assistent
überspringen“ merkt sich das pro Benutzer, erneut öffnen geht jederzeit über System › Einrichtung
oder die Einstellungen. Nur für Admins. Neue Spalte `user_preferences.setup_done`
(Migration `0005`).
- **`opnexus password [NAME]`** setzt ein neues Zufallspasswort für den Admin und zeigt es an
(`--yes` ohne Rückfrage; Rückfrage nur, wenn sich schon jemand angemeldet hat). Ersetzt das
Suchen im Backend-Log nach dem beim ersten Start erzeugten Passwort und taugt zugleich für ein
vergessenes Admin-Passwort. Alle Sitzungen des Kontos enden. Dahinter steht
`python -m app.reset_password`. Die Meldung beim ersten Start verweist darauf.
## [1.15.0] "Gyrfalcon" — 2026-10-10
Updates aus dem Webinterface. Auf Klick, mit Fortschritt und automatischem Rollback; ein eigener,
+14 -7
View File
@@ -5,9 +5,9 @@ Zentrale Verwaltung mehrerer [OPNsense](https://opnsense.org)-Firewalls: Regeln,
[Website](https://opnexus.dev/) · [Changelog](CHANGELOG.md) · [Handbuch](docs/HANDBUCH.md) · [English](README.md)
![Zentrale Firewall-Regeln](website/assets/screenshots/de/rules-light-desktop.webp)
![Zentrale Firewall-Regeln](docs/screenshots/readme-rules-de.webp)
> **Stand:** `1.15.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.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.
## Funktionen
@@ -20,8 +20,13 @@ Zentrale Verwaltung mehrerer [OPNsense](https://opnsense.org)-Firewalls: Regeln,
- **Zertifikate** — Trust-Store für alle Firewalls und Ausstellung per ACME / Let's Encrypt.
- **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.
- **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).
- **Zugang** — HTTPS mit gepinnten Firewall-Zertifikaten, optionale Zwei-Faktor-Anmeldung, Rollen (Admin / Nur-Lesen), Tastaturbedienung, Dark Mode, Oberfläche auf Deutsch und Englisch.
- **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.
- **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.
Alle Screenshots zeigen fiktive Beispieldaten.
@@ -43,19 +48,21 @@ cp .env.example .env # POSTGRES_PASSWORD (und ADMIN_PASSWORD) setzen
docker compose up -d --build
```
Die Oberfläche läuft dann unter `http://localhost:3100`. Ohne `ADMIN_PASSWORD` wird beim ersten Start ein zufälliges Admin-Passwort erzeugt und **einmalig** im Backend-Log ausgegeben:
Die Oberfläche läuft dann unter `http://localhost:3100`. Ohne `ADMIN_PASSWORD` wird beim ersten Start ein zufälliges Admin-Passwort erzeugt und **einmalig** im Backend-Log ausgegeben. Verloren oder nie gesehen? Dieses Kommando setzt ein neues Zufallspasswort und zeigt es an (im Repo-Checkout `scripts/opnexus`, im Release-Bundle `./opnexus`):
```bash
docker compose logs backend | grep -A5 "generated password"
scripts/opnexus password
```
Für den Zugriff von anderen Rechnern und den Produktivbetrieb mit TLS (mitgelieferter Caddy-Proxy) siehe das [Handbuch](docs/HANDBUCH.md#zugriff-von-außerhalb-dieser-vm--produktivbetrieb-mit-tls).
Nach der ersten Anmeldung öffnet sich von selbst ein kurzer **Einrichtungsassistent**: eigenes Passwort setzen, optional Zwei-Faktor-Anmeldung einschalten, die erste Firewall verbinden (samt Anleitung für den API-Key in OPNsense). Er lässt sich überspringen und jederzeit unter System › Einrichtung wieder öffnen.
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`:
```bash
OPNEXUS_IMAGE_REPO=git.opnexus.dev/opnexus
OPNEXUS_VERSION=1.15.0
OPNEXUS_VERSION=1.21.0
```
```bash
+15 -8
View File
@@ -5,9 +5,9 @@ Central management for multiple [OPNsense](https://opnsense.org) firewalls: rule
[Website](https://opnexus.dev) · [Changelog](CHANGELOG.md) · [Handbook (German)](docs/HANDBUCH.md) · [Deutsch](README.de.md)
![Central firewall rules](website/assets/screenshots/en/rules-light-desktop.webp)
![Central firewall rules](docs/screenshots/readme-rules-en.webp)
> **Status:** `1.15.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.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.
## What it does
@@ -20,10 +20,15 @@ Central management for multiple [OPNsense](https://opnsense.org) firewalls: rule
- **Certificates** — trust store for all firewalls and ACME / Let's Encrypt issuance.
- **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.
- **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).
- **Access** — HTTPS with pinned firewall certificates, optional two-factor sign-in, roles (admin / read-only), keyboard operation, dark mode, German and English UI.
- **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.
- **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.
![Cluster view](website/assets/screenshots/en/cluster-light-desktop.webp)
![Cluster view](docs/screenshots/readme-cluster-en.webp)
All screenshots show fictitious sample data.
@@ -45,19 +50,21 @@ cp .env.example .env # set POSTGRES_PASSWORD (and ADMIN_PASSWORD)
docker compose up -d --build
```
The UI is then available at `http://localhost:3100`. Without `ADMIN_PASSWORD` a random admin password is generated on first start and printed **once** in the backend log:
The UI is then available at `http://localhost:3100`. Without `ADMIN_PASSWORD` a random admin password is generated on first start and printed **once** in the backend log. Lost it, or never saw it? This sets a new random one and prints it (use `scripts/opnexus` in a repo checkout, `./opnexus` in the release bundle):
```bash
docker compose logs backend | grep -A5 "generated password"
scripts/opnexus password
```
For access from other machines and for production use with TLS (bundled Caddy proxy), see the [handbook](docs/HANDBUCH.md#zugriff-von-außerhalb-dieser-vm--produktivbetrieb-mit-tls) (German).
After the first sign-in a short **setup assistant** opens on its own: set your own password, optionally enable two-factor sign-in, connect your first firewall (including how to create the API key in OPNsense). You can skip it and reopen it any time under System › Setup.
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`:
```bash
OPNEXUS_IMAGE_REPO=git.opnexus.dev/opnexus
OPNEXUS_VERSION=1.15.0
OPNEXUS_VERSION=1.21.0
```
```bash
+4
View File
@@ -8,6 +8,10 @@ WORKDIR /app
COPY scripts/install_pg_client.sh /tmp/install_pg_client.sh
RUN /tmp/install_pg_client.sh 16 && rm /tmp/install_pg_client.sh
# Management-Overlay (nur der wg-hub-Container nutzt das, siehe app/overlay_hub.py).
RUN apt-get update && apt-get install -y --no-install-recommends wireguard-tools iproute2 iptables \
&& rm -rf /var/lib/apt/lists/*
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
+54 -5
View File
@@ -8,13 +8,19 @@ from starlette.responses import JSONResponse
from app.database import SessionLocal
from app.errors import ErrorCode
from app.routers.auth import COOKIE_NAME
from app.services import auth_service
from app.routers import governance
from app.routers.auth import client_ip
from app.services import api_token_service, auth_service
_PUBLIC_PATHS = {
"/api/auth/login",
"/api/auth/logout",
"/api/auth/me",
"/api/health",
# SSO: the browser arrives here without a session; every step is checked inside.
"/api/auth/oidc/config",
"/api/auth/oidc/start",
"/api/auth/oidc/callback",
}
# /docs, /redoc and /openapi.json used to be public — fully documenting a
@@ -35,6 +41,8 @@ _PUBLIC_PATHS = {
_READ_ONLY_ALLOWED_WRITES = {
"/api/auth/change-password",
"/api/settings",
# Read-only JSON-RPC tools (see routers/mcp.py).
"/api/mcp",
# Self-scoped: a user managing their own second factor.
"/api/auth/2fa/setup",
"/api/auth/2fa/enable",
@@ -48,6 +56,7 @@ _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",
}
_COLLECTIONS = {"tunnels", "instances", "managed", "accounts", "certificates", "settings"}
@@ -86,19 +95,37 @@ class AuthMiddleware(BaseHTTPMiddleware):
if request.url.path in _PUBLIC_PATHS:
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, "")
if token:
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:
resolved = await api_token_service.resolve(db, bearer, client_ip(request))
user, api_token = resolved if resolved is not None else (None, None)
token = bearer
elif token:
async with SessionLocal() as db:
user = await auth_service.resolve_session(db, token)
if token:
if user is not None and api_token is not None and api_token_service.denies(
api_token.scope, request.method, request.url.path
):
return JSONResponse(
status_code=403,
content={"detail": {"code": ErrorCode.API_TOKEN_SCOPE_FORBIDDEN.value, "params": {"scope": api_token.scope}}},
)
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"}
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"}
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}}
kind = event["kind"]
else:
kind = kinds.get(parts[1]) if len(parts) > 1 else None
if len(parts) > 2 and parts[1] == "settings":
kind = "settings" # where OPNexus stores/sends things (own prefs at /api/settings stay unaudited)
action = ("delete" if request.method == "DELETE" else parts[-1] if len(parts) > 3 else "edit" if request.method in ("PUT", "PATCH") else "create")
event = {"kind": kind, "action": action, "entity_id": parts[2] if len(parts) > 2 else None,
"host_id": parts[2] if kind == "host" and len(parts) > 2 else None,
@@ -109,10 +136,12 @@ class AuthMiddleware(BaseHTTPMiddleware):
user.role == "read_only"
and request.method not in ("GET", "HEAD", "OPTIONS")
and request.url.path not in _READ_ONLY_ALLOWED_WRITES
# Own API tokens (the router limits a read_only user to read scope).
and not request.url.path.startswith("/api/tokens")
):
if tracked:
# Refused attempts at security-relevant writes stay attributable.
ctx = audit_service.context.set({"actor": user.username, "id": str(uuid.uuid4()), "action": event["action"]})
ctx = audit_service.context.set({"actor": user.username if api_token is None else f"{user.username} (API: {api_token.name})"[:150], "id": str(uuid.uuid4()), "action": event["action"]})
try:
await audit_service.persist(**event, status="denied", message="Schreibzugriff für Nur-Lese-Konto verweigert")
finally:
@@ -121,8 +150,28 @@ class AuthMiddleware(BaseHTTPMiddleware):
status_code=403,
content={"detail": {"code": ErrorCode.READ_ONLY_ACCESS.value, "params": {}}},
)
if user.role == "operator" and api_token_service.operator_denies(request.method, request.url.path):
if tracked:
ctx = audit_service.context.set({"actor": user.username if api_token is None else f"{user.username} (API: {api_token.name})"[:150], "id": str(uuid.uuid4()), "action": event["action"]})
try:
await audit_service.persist(**event, status="denied", message="Nur für Administratoren")
finally:
audit_service.context.reset(ctx)
return JSONResponse(status_code=403, content={"detail": {"code": ErrorCode.ADMIN_REQUIRED.value, "params": {}}})
if user.role == "operator" and api_token_service.is_rollout(request.method, request.url.path):
async with SessionLocal() as gdb:
allowed = (await governance.get_settings(gdb)).operators_may_deploy
if not allowed:
ctx = audit_service.context.set({"actor": user.username if api_token is None else f"{user.username} (API: {api_token.name})"[:150], "id": str(uuid.uuid4()), "action": event["action"]})
try:
await audit_service.persist(**event, status="denied", message="Ausrollen nur durch Administratoren (Aufgabentrennung)")
finally:
audit_service.context.reset(ctx)
return JSONResponse(status_code=403, content={"detail": {"code": ErrorCode.DEPLOY_NEEDS_ADMIN.value, "params": {}}})
request.state.user = user
token = audit_service.context.set({"actor": user.username, "id": str(uuid.uuid4()), "action": event["action"]})
request.state.api_token = api_token
actor = user.username if api_token is None else f"{user.username} (API: {api_token.name})"[:150]
token = audit_service.context.set({"actor": actor, "id": str(uuid.uuid4()), "action": event["action"]})
try:
if tracked:
await audit_service.persist(**event, status="requested")
+31
View File
@@ -0,0 +1,31 @@
"""Decrypt an offsite backup (``.opxbak``) back into a config.xml.
docker compose exec -T backend python -m app.backup_decrypt < file.opxbak > config.xml
The passphrase comes from the BACKUP_PASSPHRASE environment variable or, if that is
not set, from the passphrase stored in OPNexus. For a disaster-recovery machine
without OPNexus run it with the passphrase you kept elsewhere:
docker run --rm -i -e BACKUP_PASSPHRASE=... <backend image> python -m app.backup_decrypt < file.opxbak > config.xml
"""
import os
import sys
from app.services import backup_crypto, notification_secret_store
def main() -> int:
passphrase = os.environ.get("BACKUP_PASSPHRASE") or notification_secret_store.read_secret("backup_passphrase")
if not passphrase:
print("Keine Passphrase: BACKUP_PASSPHRASE setzen.", file=sys.stderr)
return 2
try:
sys.stdout.buffer.write(backup_crypto.decrypt(sys.stdin.buffer.read(), passphrase))
except backup_crypto.DecryptError as exc:
print(str(exc), file=sys.stderr)
return 1
return 0
if __name__ == "__main__":
sys.exit(main())
+5
View File
@@ -53,6 +53,11 @@ class Settings(BaseSettings):
# reachable both by IP and by name: "https://10.0.0.5,https://opnexus.lan".
frontend_origin: str = ""
opnsense_secret_dir: str = "/data/opnsense-secrets"
# Management overlay (WireGuard hub in the optional `wg-hub` container, see services/overlay_service.py).
overlay_dir: str = "/data/overlay"
overlay_proxy_url: str = "http://wg-hub:8888"
# Lab only: allow an http:// endpoint for offsite backups (credentials in the clear).
allow_insecure_offsite: bool = False
opnsense_backup_dir: str = "/data/opnsense-backups"
opnsense_timeout: float = 10.0
# Firewall API credentials are sent as HTTP Basic auth. Plain http://
+15
View File
@@ -49,6 +49,8 @@ class ErrorCode(str, Enum):
FUER_DIESEN_TUNNEL_IST_NOCH_KEIN_SERVER_PRIVATSCHLUESSEL_D7527998 = "FUER_DIESEN_TUNNEL_IST_NOCH_KEIN_SERVER_PRIVATSCHLUESSEL_D7527998"
FUER_DIESES_ZIEL_LIEGT_KEIN_WIEDERHOLBARER_ROLLBACK_VOR = "FUER_DIESES_ZIEL_LIEGT_KEIN_WIEDERHOLBARER_ROLLBACK_VOR"
GEPLANTE_WARTUNG_NICHT_GEFUNDEN = "GEPLANTE_WARTUNG_NICHT_GEFUNDEN"
GEPLANTE_WARTUNG_NUR_AUF_DEM_CARP_BACKUP_MOEGLICH = "GEPLANTE_WARTUNG_NUR_AUF_DEM_CARP_BACKUP_MOEGLICH"
CARP_UEBERGABE_BRAUCHT_EINEN_CLUSTER = "CARP_UEBERGABE_BRAUCHT_EINEN_CLUSTER"
GROUP_HAS_ASSIGNED_ITEMS = "GROUP_HAS_ASSIGNED_ITEMS"
GRUPPENMITGLIEDER_ODER_REGELN_WURDEN_GEAENDERT_AUSWIRKUNGEN_ERNEUT_PRUEFEN = "GRUPPENMITGLIEDER_ODER_REGELN_WURDEN_GEAENDERT_AUSWIRKUNGEN_ERNEUT_PRUEFEN"
GRUPPENNAME_BEREITS_VERGEBEN = "GRUPPENNAME_BEREITS_VERGEBEN"
@@ -152,6 +154,19 @@ class ErrorCode(str, Enum):
SERVICE_NOT_FOUND = "SERVICE_NOT_FOUND"
SERVICE_LOCKED = "SERVICE_LOCKED"
READ_ONLY_ACCESS = "READ_ONLY_ACCESS"
API_TOKEN_LIMIT_REACHED = "API_TOKEN_LIMIT_REACHED"
OFFSITE_TEST_FAILED = "OFFSITE_TEST_FAILED"
OIDC_TEST_FAILED = "OIDC_TEST_FAILED"
OVERLAY_INVALID = "OVERLAY_INVALID"
OVERLAY_SUBNET_LOCKED = "OVERLAY_SUBNET_LOCKED"
OVERLAY_NAME_TAKEN = "OVERLAY_NAME_TAKEN"
OVERLAY_PEER_NOT_FOUND = "OVERLAY_PEER_NOT_FOUND"
DEPLOY_NEEDS_ADMIN = "DEPLOY_NEEDS_ADMIN"
OIDC_MANAGED_USER = "OIDC_MANAGED_USER"
BACKUP_UNLESBAR = "BACKUP_UNLESBAR"
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"
def api_error(status_code: int, code: ErrorCode, **params: Any) -> HTTPException:
+208
View File
@@ -0,0 +1,208 @@
"""Full OPNexus backup: the database and every secret store in one encrypted file.
The nightly database dump is not enough to rebuild an OPNexus server: the firewalls' API secrets, TOTP
secrets, VPN/certificate keys and the stored config snapshots live in separate volumes. This packs all of it
(``database.dump`` + the data directories + ``manifest.json``) into a tar.gz and encrypts it with a passphrase
(AES-256-GCM, services/backup_crypto.py). Without the passphrase the file is useless, so keep it elsewhere.
Normally driven by the host CLI:
./opnexus backup --full [FILE] # writes an encrypted .opxfull file
./opnexus restore FILE # onto a fresh or existing installation
or directly (passphrase in FULL_BACKUP_PASSPHRASE):
python -m app.full_backup create > file.opxfull
python -m app.full_backup info < file.opxfull # manifest only
python -m app.full_backup restore < file.opxfull
"""
import io
import json
import os
import subprocess
import sys
import tarfile
import tempfile
from datetime import datetime, timezone
from pathlib import Path
from sqlalchemy.engine import make_url
from app.config import settings
from app.services import backup_crypto
from app.version import APP_VERSION
FORMAT = 1
MIN_PASSPHRASE = 12
# manifest key -> settings attribute holding the directory
_DATA_DIRS = {
"opnsense_secrets": "opnsense_secret_dir",
"opnsense_backups": "opnsense_backup_dir",
"ipsec_psk_secrets": "ipsec_psk_secret_dir",
"openvpn_key_secrets": "openvpn_key_secret_dir",
"wireguard_key_secrets": "wireguard_key_secret_dir",
"cert_key_secrets": "cert_key_secret_dir",
"acme_secrets": "acme_secret_dir",
"totp_secrets": "totp_secret_dir",
"notification_secrets": "notification_secret_dir",
"overlay": "overlay_dir",
}
class FullBackupError(Exception):
pass
def _dir(name: str) -> Path:
return Path(getattr(settings, _DATA_DIRS[name]))
def _db_args() -> tuple[list[str], dict]:
url = make_url(settings.database_url)
return (
["-h", url.host or "localhost", "-p", str(url.port or 5432), "-U", url.username or "", "-d", url.database or ""],
{**os.environ, "PGPASSWORD": url.password or ""},
)
def _dump_database(target: Path) -> None:
args, env = _db_args()
skip = [f"--exclude-table-data={t}" for t in ("firewall_log_entries", "host_resource_samples")]
subprocess.run(["pg_dump", *args, "-F", "c", *skip, "-f", str(target)], env=env, check=True, capture_output=True, timeout=1800)
def _restore_database(source: Path) -> None:
args, env = _db_args()
result = subprocess.run(
["pg_restore", *args, "--clean", "--if-exists", "--no-owner", "--exit-on-error", str(source)],
env=env, capture_output=True, text=True, timeout=1800,
)
if result.returncode != 0:
raise FullBackupError(f"pg_restore fehlgeschlagen: {result.stderr.strip()[:400]}")
def _head_revision() -> str:
from alembic.script import ScriptDirectory
from app import migrate
return ScriptDirectory.from_config(migrate._config()).get_current_head()
def create(passphrase: str, *, dump=_dump_database, revision=None) -> bytes:
if len(passphrase) < MIN_PASSPHRASE:
raise FullBackupError(f"Die Passphrase braucht mindestens {MIN_PASSPHRASE} Zeichen")
manifest = {
"format": FORMAT, "app_version": APP_VERSION, "db_revision": revision or _head_revision(),
"created_at": datetime.now(timezone.utc).isoformat(), "data": sorted(_DATA_DIRS),
}
plain = io.BytesIO()
with tempfile.TemporaryDirectory() as tmp, tarfile.open(fileobj=plain, mode="w:gz") as tar:
raw = json.dumps(manifest, indent=1).encode()
info = tarfile.TarInfo("manifest.json")
info.size = len(raw)
tar.addfile(info, io.BytesIO(raw))
dump_path = Path(tmp) / "database.dump"
dump(dump_path)
tar.add(dump_path, arcname="database.dump")
for name in _DATA_DIRS:
path = _dir(name)
if path.is_dir():
tar.add(path, arcname=f"data/{name}")
return backup_crypto.encrypt(plain.getvalue(), passphrase)
def _open(blob: bytes, passphrase: str) -> tarfile.TarFile:
try:
plain = backup_crypto.decrypt(blob, passphrase)
except backup_crypto.DecryptError as exc:
raise FullBackupError(str(exc)) from None
try:
return tarfile.open(fileobj=io.BytesIO(plain), mode="r:gz")
except tarfile.TarError:
raise FullBackupError("Das ist keine vollständige OPNexus-Sicherung (Archiv unlesbar)") from None
def _manifest(tar: tarfile.TarFile) -> dict:
try:
member = tar.extractfile("manifest.json")
manifest = json.loads(member.read()) if member else None
except (KeyError, ValueError):
manifest = None
if not isinstance(manifest, dict) or manifest.get("format") != FORMAT:
raise FullBackupError("Das ist keine vollständige OPNexus-Sicherung (Manifest fehlt oder ist neuer)")
return manifest
def info(blob: bytes, passphrase: str) -> dict:
with _open(blob, passphrase) as tar:
return _manifest(tar)
def restore(blob: bytes, passphrase: str, *, restore_db=_restore_database, head=None) -> dict:
"""Put database and data directories back. The caller stops the backend first."""
with _open(blob, passphrase) as tar:
manifest = _manifest(tar)
if not _older_or_equal(manifest.get("db_revision"), head):
raise FullBackupError(
f"Die Sicherung stammt aus einer neueren OPNexus-Version ({manifest.get('app_version')}). "
"Erst auf diese Version aktualisieren, dann zurückspielen."
)
members = tar.getmembers()
for member in members: # reject anything that could escape: absolute paths, .., links, devices
if member.name.startswith(("/", "\\")) or ".." in Path(member.name).parts or not (member.isfile() or member.isdir()):
raise FullBackupError(f"Unzulässiger Eintrag im Archiv: {member.name!r}")
known = {f"data/{name}" for name in _DATA_DIRS}
with tempfile.TemporaryDirectory() as tmp:
dump = tar.extractfile("database.dump")
if dump is None:
raise FullBackupError("Die Sicherung enthält keine Datenbank")
dump_path = Path(tmp) / "database.dump"
dump_path.write_bytes(dump.read())
restore_db(dump_path)
restored = []
for member in members:
parts = Path(member.name).parts
if len(parts) < 2 or parts[0] != "data" or f"data/{parts[1]}" not in known:
continue
target_root = _dir(parts[1])
target = target_root.joinpath(*parts[2:])
if member.isdir():
target.mkdir(parents=True, exist_ok=True, mode=0o700)
continue
target.parent.mkdir(parents=True, exist_ok=True, mode=0o700)
source = tar.extractfile(member)
fd = os.open(target, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600)
with os.fdopen(fd, "wb") as out:
out.write(source.read())
os.utime(target, (member.mtime, member.mtime)) # snapshot ages come from file times
restored.append(parts[1])
return {**manifest, "files_restored": len(restored)}
def _older_or_equal(revision: str | None, head: str | None) -> bool:
"""Revisions are zero-padded numbers ('0009'): a dump from an older schema is fine, the app migrates it."""
try:
return int(revision) <= int(head or _head_revision())
except (TypeError, ValueError):
return False
def _main(argv: list[str]) -> int:
passphrase = os.environ.get("FULL_BACKUP_PASSPHRASE", "")
if len(argv) != 2 or argv[1] not in ("create", "info", "restore"):
print(__doc__, file=sys.stderr)
return 2
try:
if argv[1] == "create":
sys.stdout.buffer.write(create(passphrase))
elif argv[1] == "info":
print(json.dumps(info(sys.stdin.buffer.read(), passphrase), indent=1))
else:
print(json.dumps(restore(sys.stdin.buffer.read(), passphrase), indent=1))
except (FullBackupError, subprocess.SubprocessError, OSError) as exc:
print(f"Fehler: {exc}", file=sys.stderr)
return 1
return 0
if __name__ == "__main__":
sys.exit(_main(sys.argv))
+113 -4
View File
@@ -5,6 +5,7 @@ from contextlib import asynccontextmanager
from fastapi import FastAPI, Request
from fastapi.exceptions import RequestValidationError
from fastapi.openapi.utils import get_openapi
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import JSONResponse
from sqlalchemy.exc import DBAPIError
@@ -17,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
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 one_to_one
from app.services.one_to_one_deploy_service import sweep_expired_one_to_one_deployments
from app.routers import outbound_nat
@@ -49,6 +50,10 @@ 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.services import scheduled_maintenance_service
from app.services import compliance_service
from app.services import audit_export_service
from app.services import overlay_service
from app.services import backup_schedule_service
from app.services import carp_event_service, carp_maintenance_window_service
# Without this, Python's root logger defaults to WARNING with no handler,
@@ -229,6 +234,7 @@ async def _resource_poll_loop():
_SCHEDULED_MAINTENANCE_POLL_SECONDS = 60
_RUNNING_MAINTENANCE_POLL_SECONDS = 15
async def _scheduled_maintenance_poll_loop():
@@ -244,9 +250,64 @@ async def _scheduled_maintenance_poll_loop():
"Geplante Wartung: %d fällig, %d ausgeführt, %d blockiert/fehlgeschlagen",
result["due"], result["fired"], result["blocked_or_failed"],
)
in_progress = await scheduled_maintenance_service.advance_running(db)
except Exception:
logger.exception("Geplante-Wartung-Poll fehlgeschlagen")
await asyncio.sleep(_SCHEDULED_MAINTENANCE_POLL_SECONDS)
in_progress = 0
# 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)
_COMPLIANCE_FIRST_RUN_SECONDS = 120
_COMPLIANCE_INTERVAL_SECONDS = 6 * 3600
async def _compliance_poll_loop():
"""Sixth background loop: refreshes every enabled host's security-posture result.
Each check is one read-only config download per firewall, so every six hours
is plenty; the first run waits a little so a restart is not a thundering herd."""
await asyncio.sleep(_COMPLIANCE_FIRST_RUN_SECONDS)
while True:
try:
async with SessionLocal() as db:
await compliance_service.check_all(db)
except Exception:
logger.exception("Sicherheitslage-Prüfung fehlgeschlagen")
await asyncio.sleep(_COMPLIANCE_INTERVAL_SECONDS)
_AUDIT_EXPORT_POLL_SECONDS = 10
async def _audit_export_poll_loop():
"""Seventh background loop: forwards new audit events (syslog / webhook) when configured.
Cheap when off (one settings read); keeps draining while batches come back full."""
while True:
shipped = 0
try:
async with SessionLocal() as db:
shipped = await audit_export_service.run_once(db)
except Exception:
logger.exception("Audit-Export fehlgeschlagen")
await asyncio.sleep(0 if shipped >= audit_export_service.BATCH else _AUDIT_EXPORT_POLL_SECONDS)
_BACKUP_POLL_SECONDS = 15 * 60
async def _backup_poll_loop():
"""Eighth background loop: takes due scheduled config backups, prunes, copies offsite."""
await asyncio.sleep(90)
while True:
try:
async with SessionLocal() as db:
result = await backup_schedule_service.run_due(db)
if result["taken"] or result["failed"] or result["uploaded"]:
logger.info("Geplante Backups: %s", result)
except Exception:
logger.exception("Geplante Backups fehlgeschlagen")
await asyncio.sleep(_BACKUP_POLL_SECONDS)
@asynccontextmanager
@@ -254,6 +315,10 @@ async def lifespan(app: FastAPI):
await migrate.run()
async with SessionLocal() as db:
await auth_service.bootstrap_admin(db)
try:
await overlay_service.sync(db) # hub config + proxy rule follow the database after every start
except Exception:
logger.exception("Overlay-Konfiguration konnte nicht geschrieben werden")
if any(o.startswith("https://") for o in settings.allowed_origins) and not settings.cookie_secure:
logger.warning(
"FRONTEND_ORIGIN is https:// but COOKIE_SECURE is false — the session cookie "
@@ -267,6 +332,9 @@ async def lifespan(app: FastAPI):
log_ingest_task = asyncio.create_task(_log_ingest_poll_loop())
resource_task = asyncio.create_task(_resource_poll_loop())
scheduled_maintenance_task = asyncio.create_task(_scheduled_maintenance_poll_loop())
compliance_task = asyncio.create_task(_compliance_poll_loop())
audit_export_task = asyncio.create_task(_audit_export_poll_loop())
backup_task = asyncio.create_task(_backup_poll_loop())
try:
yield
finally:
@@ -275,14 +343,46 @@ async def lifespan(app: FastAPI):
log_ingest_task.cancel()
resource_task.cancel()
scheduled_maintenance_task.cancel()
for task in (sweep_task, notification_task, log_ingest_task, resource_task, scheduled_maintenance_task):
compliance_task.cancel()
audit_export_task.cancel()
backup_task.cancel()
for task in (sweep_task, notification_task, log_ingest_task, resource_task, scheduled_maintenance_task, compliance_task, audit_export_task, backup_task):
try:
await task
except asyncio.CancelledError:
pass
app = FastAPI(title="OPNexus", version=APP_VERSION, lifespan=lifespan)
API_DESCRIPTION = (
"REST API of OPNexus, the central management for OPNsense firewall fleets.\n\n"
"**Authentication:** send a personal API token as `Authorization: Bearer opx_...` "
"(create one under *System > API tokens*). Scopes: `read` (GET only), `deploy` "
"(+ roll out rules, NAT, VPN, maintenance), `admin` (+ users, settings, hosts). "
"A token never exceeds its owner's role. Token and account management is session-only.\n\n"
"Errors are `{\"detail\": {\"code\": \"...\", \"params\": {...}}}` with a stable `code`."
)
# The interactive Swagger/ReDoc pages load scripts from a CDN, which the proxy's
# Content-Security-Policy forbids; the schema itself is served (behind auth) for
# any client that renders it (Postman, openapi-generator, an AI assistant).
app = FastAPI(
title="OPNexus", version=APP_VERSION, lifespan=lifespan, description=API_DESCRIPTION,
docs_url=None, redoc_url=None, openapi_url="/api/openapi.json",
)
def _custom_openapi():
if app.openapi_schema is None:
schema = get_openapi(title=app.title, version=app.version, description=app.description, routes=app.routes)
schema.setdefault("components", {}).setdefault("securitySchemes", {})["bearerAuth"] = {
"type": "http", "scheme": "bearer", "description": "Personal API token (opx_...)",
}
schema["security"] = [{"bearerAuth": []}]
app.openapi_schema = schema
return app.openapi_schema
app.openapi = _custom_openapi
@app.exception_handler(RequestValidationError)
async def _safe_validation_error(request: Request, exc: RequestValidationError):
@@ -342,6 +442,15 @@ app.include_router(hosts.router, prefix="/api")
app.include_router(rules.router, prefix="/api")
app.include_router(search_router.router, prefix="/api")
app.include_router(users_router.router, prefix="/api")
app.include_router(tokens_router.router, prefix="/api")
app.include_router(metrics_router.router, prefix="/api")
app.include_router(mcp_router.router, prefix="/api")
app.include_router(compliance_router.router, prefix="/api")
app.include_router(audit_export_router.router, prefix="/api")
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(logs.router, prefix="/api")
app.include_router(groups.router, prefix="/api")
app.include_router(aliases.router, prefix="/api")
+38
View File
@@ -0,0 +1,38 @@
"""Personal API tokens for scripts, CI jobs, Prometheus and MCP clients.
Only the SHA-256 of the token is stored (the token is 256 random bits, so a
fast hash is enough and lets a request be resolved with one indexed lookup);
the raw value is shown exactly once, at creation. A token belongs to a user and
never exceeds that user's role: see services/api_token_service.py for the
scopes and AuthMiddleware for where they are enforced.
"""
import uuid
from datetime import datetime
from typing import Optional
from sqlalchemy import DateTime, ForeignKey, String, func
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column, relationship
from app.database import Base
class ApiToken(Base):
__tablename__ = "api_tokens"
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
user_id: Mapped[uuid.UUID] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("admin_users.id", ondelete="CASCADE"), nullable=False, index=True
)
name: Mapped[str] = mapped_column(String(80), nullable=False)
# "read" | "deploy" | "admin"
scope: Mapped[str] = mapped_column(String(10), nullable=False)
token_hash: Mapped[str] = mapped_column(String(64), nullable=False, unique=True, index=True)
# First characters of the token, so a list can tell tokens apart. Not secret.
prefix: Mapped[str] = mapped_column(String(16), nullable=False)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())
expires_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True)
last_used_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True)
last_used_ip: Mapped[Optional[str]] = mapped_column(String(45), nullable=True)
user: Mapped["AdminUser"] = relationship("AdminUser")
+33
View File
@@ -0,0 +1,33 @@
"""Forwarding of the audit trail to a syslog server and/or a webhook (singleton row).
``cursor_*`` is the position of the last shipped event, so delivery resumes where
it stopped (at-least-once). Enabling a channel starts at "now": the existing history
is not replayed. The webhook signing secret lives on disk, like every other secret
(services/notification_secret_store.py).
"""
from datetime import datetime
from typing import Optional
from sqlalchemy import Boolean, DateTime, Integer, String
from sqlalchemy.orm import Mapped, mapped_column
from app.database import Base
class AuditExportSettings(Base):
__tablename__ = "audit_export_settings"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
syslog_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
syslog_host: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
syslog_port: Mapped[int] = mapped_column(Integer, nullable=False, default=514)
# "udp" | "tcp" | "tls"
syslog_protocol: Mapped[str] = mapped_column(String(3), nullable=False, default="udp")
webhook_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
webhook_url: Mapped[Optional[str]] = mapped_column(String(500), nullable=True)
webhook_signing_secret_set: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
cursor_created_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True)
cursor_id: Mapped[Optional[str]] = mapped_column(String(36), nullable=True)
last_success_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True)
last_error: Mapped[Optional[str]] = mapped_column(String(300), nullable=True)
last_error_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True)
+48
View File
@@ -0,0 +1,48 @@
"""Scheduled config backups and their offsite copy (singleton row + upload ledger).
The S3 secret key and the encryption passphrase live on disk (notification_secret_store,
names ``backup_s3_secret`` / ``backup_passphrase``), never here.
"""
import uuid
from datetime import datetime
from typing import Optional
from sqlalchemy import Boolean, DateTime, ForeignKey, Integer, String, UniqueConstraint
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column
from app.database import Base
class BackupSettings(Base):
__tablename__ = "backup_settings"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
scheduled_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True)
interval_hours: Mapped[int] = mapped_column(Integer, nullable=False, default=24)
keep_count: Mapped[int] = mapped_column(Integer, nullable=False, default=30)
offsite_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
s3_endpoint: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
s3_region: Mapped[str] = mapped_column(String(64), nullable=False, default="us-east-1")
s3_bucket: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
s3_prefix: Mapped[str] = mapped_column(String(255), nullable=False, default="opnexus")
s3_access_key: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
s3_path_style: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True)
s3_secret_set: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
passphrase_set: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
last_run_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True)
last_offsite_ok_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True)
last_offsite_error: Mapped[Optional[str]] = mapped_column(String(300), nullable=True)
class BackupUpload(Base):
"""Which local snapshot already exists offsite (so nothing is uploaded twice)."""
__tablename__ = "backup_uploads"
__table_args__ = (UniqueConstraint("host_id", "snapshot_id", name="uq_backup_upload"),)
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)
snapshot_id: Mapped[str] = mapped_column(String(64), nullable=False)
remote_key: Mapped[str] = mapped_column(String(400), nullable=False)
uploaded_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
+31
View File
@@ -0,0 +1,31 @@
"""Latest security-posture result per host (see services/compliance_service.py).
One row per host, replaced on every check. The findings never contain
configuration values beyond rule descriptions and the protocol names they
report on; secrets from config.xml are never read into them.
"""
import uuid
from datetime import datetime
from typing import Optional
from sqlalchemy import JSON, 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 ComplianceResult(Base):
__tablename__ = "compliance_results"
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"), nullable=False, unique=True, index=True
)
checked_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
# None when the check could not run (see error).
score: Mapped[Optional[int]] = mapped_column(Integer, nullable=True)
findings: Mapped[list] = mapped_column(JSON, nullable=False, default=list)
# None | "unreachable" | "invalid_config"
error: Mapped[Optional[str]] = mapped_column(String(20), nullable=True)
error_detail: Mapped[Optional[str]] = mapped_column(String(300), nullable=True)
+13
View File
@@ -0,0 +1,13 @@
"""Separation of duties (singleton row): may operators roll changes out themselves?"""
from sqlalchemy import Boolean, Integer
from sqlalchemy.orm import Mapped, mapped_column
from app.database import Base
class GovernanceSettings(Base):
__tablename__ = "governance_settings"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
# False: an operator prepares changes (edit, preview) but only an admin may deploy them.
operators_may_deploy: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True)
+3 -1
View File
@@ -50,6 +50,8 @@ class NotificationSettings(Base):
nat_drift_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True, server_default="true")
network_drift_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True, server_default="true")
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")
poll_interval_seconds: Mapped[int] = mapped_column(Integer, default=300)
updated_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now, onupdate=_now)
@@ -71,7 +73,7 @@ class NotificationProblem(Base):
__table_args__ = (UniqueConstraint("problem_type", "dedup_key", name="uq_notification_problem_key"),)
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
# host_offline | cert_expiry | rule_drift | revert_failed | maintenance_unknown
# host_offline | cert_expiry | rule_drift | revert_failed | maintenance_unknown | ... (see ProblemType)
problem_type: Mapped[str] = mapped_column(String(32))
dedup_key: Mapped[str] = mapped_column(String(300))
status: Mapped[str] = mapped_column(String(16), default="open") # open | resolved
+42
View File
@@ -0,0 +1,42 @@
"""Single sign-on via OpenID Connect: settings (singleton) and in-flight login attempts.
The client secret lives on disk (notification_secret_store, name ``oidc_client_secret``), not here.
"""
import uuid
from datetime import datetime
from typing import Optional
from sqlalchemy import Boolean, DateTime, Integer, String, func
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column
from app.database import Base
class OidcSettings(Base):
__tablename__ = "oidc_settings"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
display_name: Mapped[str] = mapped_column(String(60), nullable=False, default="SSO")
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")
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)
read_only_group: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
class OidcLoginState(Base):
"""One row per started login; consumed (deleted) by the callback, expires after minutes."""
__tablename__ = "oidc_login_states"
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
state_hash: Mapped[str] = mapped_column(String(64), nullable=False, unique=True, index=True)
nonce: Mapped[str] = mapped_column(String(64), nullable=False)
code_verifier: Mapped[str] = mapped_column(String(128), nullable=False)
redirect_uri: Mapped[str] = mapped_column(String(500), nullable=False)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())
+39
View File
@@ -0,0 +1,39 @@
"""Management overlay: a WireGuard hub so OPNexus can reach firewalls behind NAT/CGNAT.
The firewall dials OUT to the hub; OPNexus then talks to its API at the firewall's overlay address. Keys live
on disk (services/overlay_service.py), never in the database.
"""
import uuid
from datetime import datetime
from typing import Optional
from sqlalchemy import Boolean, DateTime, ForeignKey, Integer, String, func
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column
from app.database import Base
class OverlaySettings(Base):
__tablename__ = "overlay_settings"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
# host or host:port that firewalls dial (public name/IP of this server and the published UDP port)
endpoint: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
subnet: Mapped[str] = mapped_column(String(18), nullable=False, default="10.99.0.0/24")
listen_port: Mapped[int] = mapped_column(Integer, nullable=False, default=51820)
class OverlayPeer(Base):
__tablename__ = "overlay_peers"
id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
name: Mapped[str] = mapped_column(String(80), nullable=False, unique=True)
ip: Mapped[str] = mapped_column(String(15), nullable=False, unique=True)
# the firewall's WireGuard public key, entered once the firewall side exists
public_key: Mapped[Optional[str]] = mapped_column(String(44), nullable=True, unique=True)
host_id: Mapped[Optional[uuid.UUID]] = mapped_column(
PGUUID(as_uuid=True), ForeignKey("opnsense_hosts.id", ondelete="SET NULL"), nullable=True
)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())
+4 -1
View File
@@ -1,5 +1,5 @@
import uuid
from sqlalchemy import ForeignKey, String
from sqlalchemy import Boolean, ForeignKey, String
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column
from app.database import Base
@@ -9,3 +9,6 @@ class UserPreferences(Base):
user_id: Mapped[uuid.UUID] = mapped_column(PGUUID(as_uuid=True), ForeignKey('admin_users.id',ondelete='CASCADE'), primary_key=True)
theme: Mapped[str] = mapped_column(String(10), default='system')
language: Mapped[str] = mapped_column(String(5), nullable=False, default='de', server_default='de')
# Set once the user finished or dismissed the first-run setup assistant
# (frontend /setup); it is then no longer offered automatically.
setup_done: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default='false')
+32
View File
@@ -0,0 +1,32 @@
"""When did a firewall rule last match something? (per host and rule UUID)
pf's own counters restart whenever the ruleset is reloaded (every apply, every reboot), so
"packets = 0" alone proves nothing. OPNexus samples them periodically and keeps the time of the
last observed hit, which survives those resets. See services/rule_hit_service.py.
"""
import uuid
from datetime import datetime
from typing import Optional
from sqlalchemy import BigInteger, Boolean, DateTime, ForeignKey, String, UniqueConstraint
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column
from app.database import Base
class RuleHit(Base):
__tablename__ = "rule_hits"
__table_args__ = (UniqueConstraint("host_id", "rule_uuid", name="uq_rule_hit"),)
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)
rule_uuid: Mapped[str] = mapped_column(String(36), nullable=False)
description: Mapped[str] = mapped_column(String(255), nullable=False, default="")
enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True)
first_seen_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
last_sampled_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
# None = never seen a hit since OPNexus started watching.
last_hit_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True)
last_packets: Mapped[int] = mapped_column(BigInteger, nullable=False, default=0)
last_bytes: Mapped[int] = mapped_column(BigInteger, nullable=False, default=0)
+8 -1
View File
@@ -13,7 +13,7 @@ table only tracks the *schedule* itself, not the resulting operation.
import uuid
from datetime import datetime
from sqlalchemy import DateTime, ForeignKey, Index, JSON, String
from sqlalchemy import Boolean, DateTime, ForeignKey, Index, JSON, String
from sqlalchemy.dialects.postgresql import UUID as PGUUID
from sqlalchemy.orm import Mapped, mapped_column
@@ -40,3 +40,10 @@ class ScheduledMaintenance(Base):
# Set to the resulting HostOperation's id once fired, so the UI can
# link from the schedule to the operation it produced.
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.
# 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)
progress: Mapped[dict] = mapped_column(JSON, nullable=False, default=dict)
+4
View File
@@ -32,6 +32,10 @@ class AdminUser(Base):
totp_enabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False, server_default="false")
totp_last_step: Mapped[int] = mapped_column(BigInteger, nullable=False, default=0, server_default="0")
totp_recovery_hashes: Mapped[Optional[list]] = mapped_column(JSON, nullable=True)
# "local" (password) or "oidc" (single sign-on: role follows the identity provider's groups at every
# login, the password hash is an unusable placeholder). oidc_subject is "<issuer>|<sub>".
auth_source: Mapped[str] = mapped_column(String(10), nullable=False, default="local", server_default="local")
oidc_subject: Mapped[Optional[str]] = mapped_column(String(600), nullable=True, unique=True, index=True)
sessions: Mapped[list["Session"]] = relationship(
"Session", back_populates="user", cascade="all, delete-orphan"
+191
View File
@@ -0,0 +1,191 @@
"""The ``wg-hub`` container: WireGuard interface + a CONNECT proxy for the management overlay.
Runs from the backend image (``python -m app.overlay_hub``) with CAP_NET_ADMIN and the WireGuard UDP port
published. Everything it needs comes from ``<overlay_dir>/hub.json`` (written by the backend, see
services/overlay_service.py); it reports back through ``status.json``. It never talks to the database.
* WireGuard: wg0 with the hub address, peers synced with ``wg syncconf`` whenever hub.json changes. Inbound
NEW connections from the tunnel are dropped (iptables), so a compromised firewall cannot reach anything on this
container; OPNexus' own requests to the firewalls and their replies are unaffected.
* Proxy: an HTTP CONNECT proxy (port 8888, compose network only). It is not an open proxy: it only connects to
IPv4 addresses inside the overlay subnet from hub.json.
"""
import asyncio
import ipaddress
import json
import logging
import os
import subprocess
import sys
import time
from pathlib import Path
from app.config import settings
logger = logging.getLogger("overlay_hub")
INTERFACE = "wg0"
PROXY_PORT = 8888
APPLY_EVERY = 5
def run(*cmd: str, stdin: str | None = None) -> tuple[int, str]:
try:
result = subprocess.run(list(cmd), input=stdin, capture_output=True, text=True, timeout=20)
except (OSError, subprocess.SubprocessError) as exc:
return 127, str(exc)
return result.returncode, (result.stdout + result.stderr).strip()
def wg_conf(config: dict) -> str:
lines = ["[Interface]", f"PrivateKey = {config['private_key']}", f"ListenPort = {int(config['listen_port'])}"]
for peer in config.get("peers", []):
lines += ["", "[Peer]", f"PublicKey = {peer['public_key']}", f"PresharedKey = {peer['psk']}", f"AllowedIPs = {peer['ip']}/32"]
return "\n".join(lines) + "\n"
def parse_dump(text: str) -> list[dict]:
"""`wg show <if> dump`: first line is the interface, then one tab-separated line per peer."""
peers = []
for line in text.splitlines()[1:]:
f = line.split("\t")
if len(f) >= 7:
peers.append({"public_key": f[0], "endpoint": None if f[2] == "(none)" else f[2], "handshake_at": int(f[4] or 0),
"rx": int(f[5] or 0), "tx": int(f[6] or 0)})
return peers
class Hub:
def __init__(self, directory: Path, runner=run):
self.dir, self.run = directory, runner
self.subnet: ipaddress.IPv4Network | None = None
self._applied_mtime = 0.0
def read_config(self) -> dict | None:
try:
config = json.loads((self.dir / "hub.json").read_text())
return config if isinstance(config, dict) else None
except (OSError, ValueError):
return None
def apply(self, config: dict) -> str | None:
"""Bring the interface in line with the config. Returns an error text or None."""
self.subnet = ipaddress.ip_network(config["subnet"]) if config.get("enabled") and config.get("subnet") else None
exists = self.run("ip", "link", "show", INTERFACE)[0] == 0
if not config.get("enabled"):
if exists:
self.run("ip", "link", "del", INTERFACE)
return None
steps = []
if not exists:
steps.append(("ip", "link", "add", INTERFACE, "type", "wireguard"))
steps += [("ip", "address", "replace", config["address"], "dev", INTERFACE), ("ip", "link", "set", INTERFACE, "up")]
for step in steps:
code, out = self.run(*step)
if code != 0:
return f"{' '.join(step[:3])}: {out}"[:300]
conf = self.dir / ".wg0.conf"
fd = os.open(conf, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600)
with os.fdopen(fd, "w") as handle:
handle.write(wg_conf(config))
try:
code, out = self.run("wg", "syncconf", INTERFACE, str(conf))
finally:
conf.unlink(missing_ok=True)
if code != 0:
return f"wg syncconf: {out}"[:300]
# Nothing may start a connection INTO this container from the tunnel; replies to ours still pass.
rule = ("INPUT", "-i", INTERFACE, "-m", "conntrack", "--ctstate", "NEW", "-j", "DROP")
if self.run("iptables", "-C", *rule)[0] != 0:
code, out = self.run("iptables", "-I", *rule)
if code != 0:
return f"iptables: {out}"[:300]
return None
def status(self, error: str | None) -> dict:
code, out = self.run("wg", "show", INTERFACE, "dump")
return {"updated_at": time.time(), "up": code == 0, "peers": parse_dump(out) if code == 0 else [], "error": error}
def write_status(self, error: str | None) -> None:
tmp = self.dir / "status.json.tmp"
tmp.write_text(json.dumps(self.status(error)))
os.replace(tmp, self.dir / "status.json")
def tick(self, last_error: str | None) -> str | None:
"""One round: re-apply if hub.json changed, then report. Returns the current error."""
config = self.read_config()
if config is not None:
mtime = (self.dir / "hub.json").stat().st_mtime
if mtime != self._applied_mtime or last_error:
last_error = self.apply(config)
self._applied_mtime = mtime
self.write_status(last_error)
return last_error
# ── CONNECT proxy ────────────────────────────────────────────────────
def allowed(self, host: str) -> bool:
try:
return self.subnet is not None and ipaddress.ip_address(host) in self.subnet
except ValueError:
return False
async def handle_client(self, reader: asyncio.StreamReader, writer: asyncio.StreamWriter) -> None:
try:
head = await asyncio.wait_for(reader.readuntil(b"\r\n\r\n"), 10)
method, target, _ = head.split(b"\r\n", 1)[0].decode("latin-1").split(" ", 2)
host, _, port_text = target.rpartition(":")
if method != "CONNECT" or not port_text.isdigit() or not 0 < int(port_text) < 65536 or not self.allowed(host.strip("[]")):
writer.write(b"HTTP/1.1 403 Forbidden\r\nContent-Length: 0\r\n\r\n")
await writer.drain()
return
try:
up_reader, up_writer = await asyncio.wait_for(asyncio.open_connection(host, int(port_text)), 8)
except (OSError, asyncio.TimeoutError):
writer.write(b"HTTP/1.1 502 Bad Gateway\r\nContent-Length: 0\r\n\r\n")
await writer.drain()
return
writer.write(b"HTTP/1.1 200 Connection established\r\n\r\n")
await writer.drain()
await asyncio.gather(self._pipe(reader, up_writer), self._pipe(up_reader, writer))
except (asyncio.IncompleteReadError, asyncio.LimitOverrunError, asyncio.TimeoutError, ValueError, OSError):
pass
finally:
writer.close()
@staticmethod
async def _pipe(src: asyncio.StreamReader, dst: asyncio.StreamWriter) -> None:
try:
while data := await src.read(65536):
dst.write(data)
await dst.drain()
except (OSError, asyncio.CancelledError):
pass
finally:
dst.close()
async def main() -> None:
logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(name)s: %(message)s")
directory = Path(settings.overlay_dir)
directory.mkdir(parents=True, exist_ok=True)
hub = Hub(directory)
server = await asyncio.start_server(hub.handle_client, "0.0.0.0", PROXY_PORT)
logger.info("Overlay-Hub gestartet (Proxy auf :%d)", PROXY_PORT)
error = None
async with server:
while True:
try:
new_error = await asyncio.to_thread(hub.tick, error)
except Exception:
logger.exception("Overlay-Hub-Runde fehlgeschlagen")
new_error = "interner Fehler"
if new_error and new_error != error:
logger.warning("Overlay: %s", new_error)
error = new_error
await asyncio.sleep(APPLY_EVERY)
if __name__ == "__main__":
try:
asyncio.run(main())
except KeyboardInterrupt:
sys.exit(0)
+67
View File
@@ -0,0 +1,67 @@
"""Recovery: give an account a new random password and print it once.
For a fresh install whose generated first-start password scrolled out of the
log, and for an admin who forgot theirs. Needs shell access to the server,
which is the trust boundary for this tool anyway (same as app.reset_2fa).
All sessions and API tokens of the account are ended. Normally called through the host
CLI:
./opnexus password [username]
or directly:
docker compose exec backend python -m app.reset_password [username]
Without a username the configured ADMIN_USERNAME is used; if that account does
not exist and there is exactly one admin, that one.
"""
import asyncio
import secrets
import sys
from sqlalchemy import select
from app.config import settings
from app.database import SessionLocal
from app.models.user import AdminUser
from app.services import api_token_service, auth_service
async def main(username: str | None) -> int:
async with SessionLocal() as db:
if username is None:
username = settings.admin_username
user = (await db.execute(select(AdminUser).where(AdminUser.username == username))).scalar_one_or_none()
if user is None:
admins = (await db.execute(select(AdminUser).where(AdminUser.role == "admin"))).scalars().all()
if len(admins) != 1:
names = ", ".join(sorted(a.username for a in admins)) or "-"
print(f"No account named '{username}'. Pass the username (admins: {names}).", file=sys.stderr)
return 1
user = admins[0]
else:
user = (await db.execute(select(AdminUser).where(AdminUser.username == username))).scalar_one_or_none()
if user is None:
print(f"No such user: {username}", file=sys.stderr)
return 1
password = secrets.token_urlsafe(18)
user.password_hash = await auth_service.hash_password_async(password)
await auth_service.revoke_sessions(db, user.id, commit=False)
await api_token_service.revoke_all(db, user.id, commit=False)
await db.commit()
name = user.username
has_totp = user.totp_enabled
print(f"Username: {name}")
print(f"Password: {password}")
if has_totp:
print("Two-factor sign-in is still on (lost the code? python -m app.reset_2fa).", file=sys.stderr)
return 0
if __name__ == "__main__":
if len(sys.argv) > 2:
print("usage: python -m app.reset_password [username]", file=sys.stderr)
sys.exit(2)
sys.exit(asyncio.run(main(sys.argv[1] if len(sys.argv) == 2 else None)))
+59
View File
@@ -0,0 +1,59 @@
"""Audit export settings (admin only): where the audit trail is forwarded to."""
from datetime import datetime, timezone
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.user import AdminUser
from app.routers.auth import current_user
from app.schemas.audit_export import AuditExportRead, AuditExportUpdate
from app.services import audit_export_service as svc
from app.services import notification_secret_store
router = APIRouter(prefix="/settings/audit-export", tags=["audit-export"])
def _require_admin(user: AdminUser) -> None:
if user.role != "admin":
raise api_error(403, ErrorCode.ADMIN_REQUIRED)
@router.get("", response_model=AuditExportRead)
async def read(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
return await svc.get_settings(db)
@router.put("", response_model=AuditExportRead)
async def update(payload: AuditExportUpdate, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
row = await svc.get_settings(db)
was_active = svc.active(row)
for field in ("syslog_enabled", "syslog_host", "syslog_port", "syslog_protocol", "webhook_enabled", "webhook_url"):
value = getattr(payload, field)
if value is not None:
setattr(row, field, value.strip() if isinstance(value, str) else value)
if payload.clear_webhook_signing_secret:
notification_secret_store.delete_secret(svc.SECRET_NAME)
row.webhook_signing_secret_set = False
elif payload.webhook_signing_secret is not None:
notification_secret_store.save_secret(svc.SECRET_NAME, payload.webhook_signing_secret)
row.webhook_signing_secret_set = True
if not svc.active(row):
row.cursor_created_at = row.cursor_id = None # next enabling starts from "now" again
elif not was_active:
row.cursor_created_at, row.cursor_id = datetime.now(timezone.utc), None
await db.commit()
return row
@router.post("/test")
async def test(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
try:
await svc.send_test(await svc.get_settings(db))
except svc.ExportError as exc:
raise api_error(502, ErrorCode.UPSTREAM_REQUEST_FAILED) from exc
return {"success": True}
+17 -1
View File
@@ -9,7 +9,7 @@ from app.errors import ErrorCode, api_error
from app.config import settings
from app.database import get_db
from app.models.user import AdminUser
from app.services import auth_service, totp_service
from app.services import api_token_service, auth_service, totp_service
logger = logging.getLogger(__name__)
@@ -63,6 +63,14 @@ def _account_success(user: AdminUser, action: str) -> None:
async def resolve_user(request: Request, db: AsyncSession) -> AdminUser:
# AuthMiddleware already resolved the caller (session cookie or API token), but
# in its own, closed DB session: re-load into this request's session so that
# changes made to the user (2FA, password...) are actually persisted.
resolved = getattr(request.state, "user", None)
if resolved is not None:
user = await db.get(AdminUser, resolved.id)
if user is not None:
return user
token = request.cookies.get(COOKIE_NAME, "")
user = await auth_service.resolve_session(db, token)
if user is None:
@@ -262,6 +270,14 @@ async def logout(request: Request, response: Response, db: AsyncSession = Depend
@router.get("/me")
async def me(request: Request, 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))
if resolved is None:
return {"authenticated": False}
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, "")
user = await auth_service.resolve_session(db, token)
if user is None:
+104
View File
@@ -0,0 +1,104 @@
"""Scheduled backups: status for everybody, settings and offsite test for admins, "run now" for operators."""
import uuid
from datetime import datetime, timezone
from fastapi import APIRouter, Depends, Query
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.models.user import AdminUser
from app.routers.auth import current_user
from app.schemas.backup_settings import BackupSettingsRead, BackupSettingsUpdate, BackupStatusRead
from app.services import backup_diff_service, backup_store
from app.services import backup_schedule_service as svc
from app.services import notification_secret_store
from app.services.s3_client import S3Error
router = APIRouter(tags=["backups"])
def _require_admin(user: AdminUser) -> None:
if user.role != "admin":
raise api_error(403, ErrorCode.ADMIN_REQUIRED)
@router.get("/backups/status", response_model=BackupStatusRead)
async def status(db: AsyncSession = Depends(get_db)):
return await svc.get_settings(db)
@router.post("/backups/run")
async def run_now(db: AsyncSession = Depends(get_db)):
"""Back up every enabled host now (and copy offsite if configured)."""
return await svc.run_due(db, force=True)
@router.get("/settings/backups", response_model=BackupSettingsRead)
async def read(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
return await svc.get_settings(db)
@router.put("/settings/backups", response_model=BackupSettingsRead)
async def update(payload: BackupSettingsUpdate, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
row = await svc.get_settings(db)
for field in ("scheduled_enabled", "interval_hours", "keep_count", "offsite_enabled", "s3_region", "s3_path_style"):
value = getattr(payload, field)
if value is not None:
setattr(row, field, value)
for field in ("s3_endpoint", "s3_bucket", "s3_access_key", "s3_prefix"):
value = getattr(payload, field)
if value is not None:
setattr(row, field, value.strip().rstrip("/") if field == "s3_endpoint" else value.strip())
if payload.clear_s3_secret:
notification_secret_store.delete_secret(svc.S3_SECRET)
row.s3_secret_set = False
elif payload.s3_secret_key is not None:
notification_secret_store.save_secret(svc.S3_SECRET, payload.s3_secret_key)
row.s3_secret_set = True
if payload.passphrase is not None:
notification_secret_store.save_secret(svc.PASSPHRASE, payload.passphrase)
row.passphrase_set = True
await db.commit()
return row
@router.post("/settings/backups/test-offsite")
async def test_offsite(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
"""Write, read back and delete a probe object in the bucket."""
_require_admin(user)
cfg = await svc.get_settings(db)
try:
key = "/".join(p for p in (cfg.s3_prefix.strip("/"), f".opnexus-test-{int(datetime.now(timezone.utc).timestamp())}") if p)
await svc.s3_for(cfg).test(key)
except S3Error as exc:
raise api_error(502, ErrorCode.OFFSITE_TEST_FAILED, reason=str(exc)) from exc
return {"success": True}
@router.get("/hosts/{host_id}/backup-diff")
async def backup_diff(
host_id: uuid.UUID,
a: str | None = Query(default=None, description="Older backup id (default: the one before b)"),
b: str | None = Query(default=None, description="Newer backup id (default: the newest)"),
db: AsyncSession = Depends(get_db),
):
"""What changed between two stored backups of this host. Secrets are replaced by hashes."""
if await db.get(OpnsenseHost, host_id) is None:
raise api_error(404, ErrorCode.HOST_NICHT_GEFUNDEN)
snapshots = [s["id"] for s in backup_store.list_snapshots(host_id)] # newest first
new_id = b or (snapshots[0] if snapshots else None)
old_id = a or (snapshots[snapshots.index(new_id) + 1] if new_id in snapshots and snapshots.index(new_id) + 1 < len(snapshots) else None)
if not new_id or not old_id:
raise api_error(404, ErrorCode.BACKUP_NICHT_GEFUNDEN)
old, new = backup_store.read_snapshot(host_id, old_id), backup_store.read_snapshot(host_id, new_id)
if old is None or new is None:
raise api_error(404, ErrorCode.BACKUP_NICHT_GEFUNDEN)
try:
result = backup_diff_service.diff(old, new)
except backup_diff_service.InvalidConfig as exc:
raise api_error(422, ErrorCode.BACKUP_UNLESBAR, reason=str(exc)) from exc
return {"a": old_id, "b": new_id, **result}
+88
View File
@@ -0,0 +1,88 @@
"""Security posture ("Sicherheitslage"): stored results and on-demand checks.
Reads (GET) only return what the last check stored, so they are cheap and safe
for dashboards, Prometheus and MCP. A check (POST) downloads the host's config
read-only, evaluates it and stores the result; see services/compliance_service.py.
"""
import uuid
from datetime import datetime, timezone
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.compliance_result import ComplianceResult
from app.models.host import OpnsenseHost
from app.models.rule_hit import RuleHit
from app.services import compliance_service, rule_hit_service
router = APIRouter(tags=["compliance"])
def _read(host: OpnsenseHost, row: ComplianceResult | None, *, detail: bool) -> dict:
result = {
"host_id": host.id, "host_name": host.name, "cluster_name": host.cluster_name, "enabled": host.enabled,
"checked_at": row.checked_at if row else None,
"score": row.score if row else None,
"grade": compliance_service.grade(row.score) if row and row.score is not None else None,
"error": row.error if row else None,
"counts": compliance_service.counts(row.findings) if row else None,
}
if detail:
result["findings"] = row.findings if row else []
return result
@router.get("/compliance")
async def fleet_compliance(db: AsyncSession = Depends(get_db)):
hosts = (await db.scalars(select(OpnsenseHost).order_by(OpnsenseHost.name))).all()
rows = {r.host_id: r for r in (await db.scalars(select(ComplianceResult))).all()}
return [_read(host, rows.get(host.id), detail=False) for host in hosts]
@router.post("/compliance/check")
async def check_fleet(db: AsyncSession = Depends(get_db)):
await compliance_service.check_all(db)
return await fleet_compliance(db)
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
@router.get("/hosts/{host_id}/compliance")
async def host_compliance(host_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
host = await _host(db, host_id)
row = await db.scalar(select(ComplianceResult).where(ComplianceResult.host_id == host_id))
return _read(host, row, detail=True)
@router.post("/hosts/{host_id}/compliance/check")
async def check_host(host_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
host = await _host(db, host_id)
row = await compliance_service.check_host(db, host)
return _read(host, row, detail=True)
@router.get("/hosts/{host_id}/rule-hits")
async def rule_hits(host_id: uuid.UUID, db: AsyncSession = Depends(get_db)):
"""When each rule last matched something, as observed by OPNexus (see services/rule_hit_service.py)."""
await _host(db, host_id)
now = datetime.now(timezone.utc)
rows = (await db.scalars(select(RuleHit).where(RuleHit.host_id == host_id))).all()
return sorted(
(
{
"rule_uuid": r.rule_uuid, "description": r.description, "enabled": r.enabled,
"state": rule_hit_service.classify(r, now), "packets": r.last_packets, "bytes": r.last_bytes,
"last_hit_at": r.last_hit_at, "first_seen_at": r.first_seen_at, "last_sampled_at": r.last_sampled_at,
}
for r in rows
),
key=lambda item: (item["state"] != "unused", item["last_hit_at"] or datetime.min.replace(tzinfo=timezone.utc), item["description"]),
)
+18 -12
View File
@@ -184,18 +184,8 @@ async def _carp_auto_revert_actions(db: AsyncSession) -> list[PendingAction]:
return actions
@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)
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,
)
for host in hosts
]
async def collect_pending_actions(db: AsyncSession) -> list[PendingAction]:
"""Everything that needs a human, newest first (shared with the metrics endpoint)."""
pending_actions: list[PendingAction] = []
pending_actions += await _rule_actions(db)
pending_actions += await _nat_actions(db, PortForwardDeployment, PortForwardRule, "port_forward_id", "port_forward", "port-forward")
@@ -209,6 +199,22 @@ async def summary(db: AsyncSession = Depends(get_db)):
pending_actions += await _stuck_host_operations(db)
pending_actions += await _carp_auto_revert_actions(db)
pending_actions.sort(key=lambda item: item.created_at, reverse=True)
return pending_actions
@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)
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,
)
for host in hosts
]
pending_actions = await collect_pending_actions(db)
activity_rows = (
await db.scalars(select(AuditEvent).order_by(AuditEvent.created_at.desc(), AuditEvent.id.desc()).limit(15))
+41
View File
@@ -0,0 +1,41 @@
"""Separation of duties: with ``operators_may_deploy`` off, only admins roll changes out (AuthMiddleware enforces it)."""
from fastapi import APIRouter, Depends
from pydantic import BaseModel
from sqlalchemy.ext.asyncio import AsyncSession
from app.database import get_db
from app.errors import ErrorCode, api_error
from app.models.governance import GovernanceSettings
from app.models.user import AdminUser
from app.routers.auth import current_user
router = APIRouter(prefix="/settings/governance", tags=["governance"])
class GovernanceRead(BaseModel):
operators_may_deploy: bool
async def get_settings(db: AsyncSession) -> GovernanceSettings:
row = await db.get(GovernanceSettings, 1)
if row is None:
row = GovernanceSettings(id=1, operators_may_deploy=True)
db.add(row)
await db.flush()
return row
@router.get("", response_model=GovernanceRead)
async def read(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
"""Readable by everybody signed in (the UI explains why a deploy was refused)."""
return await get_settings(db)
@router.put("", response_model=GovernanceRead)
async def update(payload: GovernanceRead, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
if user.role != "admin":
raise api_error(403, ErrorCode.ADMIN_REQUIRED)
row = await get_settings(db)
row.operators_may_deploy = payload.operators_may_deploy
await db.commit()
return row
+202
View File
@@ -0,0 +1,202 @@
"""Read-only MCP server (Model Context Protocol, streamable HTTP transport).
Lets an AI assistant (Claude Code, Claude Desktop, ...) look at the fleet:
claude mcp add --transport http opnexus https://<opnexus>/api/mcp \
--header "Authorization: Bearer opx_..."
Stateless JSON-RPC over POST (the spec allows plain ``application/json``
replies; there is no server-initiated stream, GET answers 405). Every tool is a
GET against OPNexus' own API, sent through the app itself with the caller's own
credentials, so exactly the caller's permissions apply: a ``read`` token sees
what a ``read`` token sees, secret-bearing endpoints stay closed. Nothing here
can change state.
"""
import json
from urllib.parse import urlencode
import httpx
from fastapi import APIRouter, Request, Response
from fastapi.responses import JSONResponse
from app.version import APP_VERSION
router = APIRouter(tags=["mcp"])
SUPPORTED_VERSIONS = ("2025-06-18", "2025-03-26", "2024-11-05")
MAX_RESULT_CHARS = 60_000
# Not reachable through the generic reader (credentials management, the MCP endpoint itself).
_BLOCKED_PREFIXES = ("/api/tokens", "/api/auth", "/api/mcp")
TOOLS = [
{
"name": "fleet_overview",
"description": "Fleet status at a glance: every firewall with online state and CARP role, items that need "
"attention (failed or unconfirmed deployments, stuck maintenance) and the latest activity.",
"inputSchema": {"type": "object", "properties": {}},
"path": "/api/dashboard",
},
{
"name": "list_hosts",
"description": "All managed firewalls with name, URL, cluster and whether monitoring is enabled.",
"inputSchema": {"type": "object", "properties": {}},
"path": "/api/hosts",
},
{
"name": "host_resources",
"description": "Recent CPU load, memory and disk usage samples of one firewall (a sample per minute).",
"inputSchema": {
"type": "object", "required": ["host_id"],
"properties": {
"host_id": {"type": "string", "description": "Firewall id from list_hosts"},
"since_hours": {"type": "integer", "minimum": 1, "maximum": 720, "default": 1},
},
},
"path": "/api/hosts/{host_id}/resource-samples",
"query": ("since_hours",),
# The raw per-sample payload (every interface counter) would drown the useful numbers.
"drop": ("raw",),
},
{
"name": "carp_events",
"description": "History of CARP role changes (MASTER/BACKUP) across the clusters.",
"inputSchema": {"type": "object", "properties": {}},
"path": "/api/cluster/carp-events",
},
{
"name": "recent_audit",
"description": "The audit trail: who changed or deployed what, newest first.",
"inputSchema": {
"type": "object",
"properties": {
"limit": {"type": "integer", "minimum": 1, "maximum": 200, "default": 25},
"kind": {"type": "string", "description": "e.g. rule, alias, host, user"},
"status": {"type": "string", "description": "e.g. accepted, rejected, denied"},
"q": {"type": "string", "description": "free-text filter"},
},
},
"path": "/api/audit",
"query": ("limit", "kind", "status", "q"),
},
{
"name": "search",
"description": "Search rules, aliases, NAT, VPN, certificates, groups and hosts by text.",
"inputSchema": {
"type": "object", "required": ["q"],
"properties": {"q": {"type": "string", "description": "at least 2 characters"}},
},
"path": "/api/search",
"query": ("q",),
},
{
"name": "api_get",
"description": "Read any other OPNexus API endpoint (GET only), e.g. /api/rules, /api/aliases, /api/logs. "
"The schema of all endpoints is at /api/openapi.json.",
"inputSchema": {
"type": "object", "required": ["path"],
"properties": {
"path": {"type": "string", "description": "Starts with /api/"},
"query": {"type": "object", "description": "Query parameters", "additionalProperties": {"type": "string"}},
},
},
},
]
def _tool_list() -> list[dict]:
return [{k: v for k, v in tool.items() if k in ("name", "description", "inputSchema")} for tool in TOOLS]
def _text(text: str, is_error: bool = False) -> dict:
if len(text) > MAX_RESULT_CHARS:
text = text[:MAX_RESULT_CHARS] + f"\n… truncated ({len(text)} characters in total); narrow the request."
return {"content": [{"type": "text", "text": text}], "isError": is_error}
async def _get(request: Request, path: str, query: dict, drop: tuple = ()) -> dict:
if not path.startswith("/api/") or ".." in path or "?" in path or "#" in path or path.startswith(_BLOCKED_PREFIXES):
return _text("This path cannot be read through MCP.", True)
headers = {k: v for k in ("authorization", "cookie") if (v := request.headers.get(k))}
url = path + (("?" + urlencode(query)) if query else "")
transport = httpx.ASGITransport(app=request.app)
async with httpx.AsyncClient(transport=transport, base_url="http://opnexus", headers=headers, timeout=30) as client:
response = await client.get(url)
body = response.text
try:
data = response.json()
if drop and isinstance(data, list):
data = [{k: v for k, v in item.items() if k not in drop} if isinstance(item, dict) else item for item in data]
body = json.dumps(data, ensure_ascii=False, indent=1)
except ValueError:
pass
return _text(body, response.status_code >= 400)
async def _call_tool(request: Request, name: str, arguments: dict) -> dict:
tool = next((t for t in TOOLS if t["name"] == name), None)
if tool is None:
return _text(f"Unknown tool: {name}", True)
if name == "api_get":
query = arguments.get("query") or {}
if not isinstance(arguments.get("path"), str) or not isinstance(query, dict):
return _text("path (string) is required.", True)
return await _get(request, arguments["path"], {str(k): str(v) for k, v in query.items()})
path = tool["path"]
if "{host_id}" in path:
host_id = str(arguments.get("host_id", ""))
if not host_id.replace("-", "").isalnum():
return _text("host_id is required (see list_hosts).", True)
path = path.format(host_id=host_id)
query = {key: arguments[key] for key in tool.get("query", ()) if arguments.get(key) not in (None, "")}
return await _get(request, path, query, tool.get("drop", ()))
def _error(request_id, code: int, message: str) -> dict:
return {"jsonrpc": "2.0", "id": request_id, "error": {"code": code, "message": message}}
async def _handle(request: Request, message: dict) -> dict | None:
"""The JSON-RPC response for one message, None for a notification."""
if not isinstance(message, dict) or message.get("jsonrpc") != "2.0" or "method" not in message:
return _error(message.get("id") if isinstance(message, dict) else None, -32600, "Invalid request")
method, request_id = message["method"], message.get("id")
params = message.get("params") or {}
if "id" not in message: # notification (e.g. notifications/initialized): nothing to answer
return None
if method == "initialize":
requested = params.get("protocolVersion")
return {"jsonrpc": "2.0", "id": request_id, "result": {
"protocolVersion": requested if requested in SUPPORTED_VERSIONS else SUPPORTED_VERSIONS[0],
"capabilities": {"tools": {"listChanged": False}},
"serverInfo": {"name": "opnexus", "version": APP_VERSION},
"instructions": "Read-only access to an OPNsense fleet managed by OPNexus.",
}}
if method == "ping":
return {"jsonrpc": "2.0", "id": request_id, "result": {}}
if method == "tools/list":
return {"jsonrpc": "2.0", "id": request_id, "result": {"tools": _tool_list()}}
if method == "tools/call":
arguments = params.get("arguments") or {}
if not isinstance(params.get("name"), str) or not isinstance(arguments, dict):
return _error(request_id, -32602, "name (string) and arguments (object) are required")
return {"jsonrpc": "2.0", "id": request_id, "result": await _call_tool(request, params["name"], arguments)}
return _error(request_id, -32601, f"Method not found: {method}")
@router.post("/mcp")
async def mcp_endpoint(request: Request):
try:
payload = await request.json()
except ValueError:
return JSONResponse(_error(None, -32700, "Parse error"), status_code=400)
if isinstance(payload, list):
replies = [reply for message in payload if (reply := await _handle(request, message)) is not None]
return JSONResponse(replies) if replies else Response(status_code=202)
reply = await _handle(request, payload)
return JSONResponse(reply) if reply is not None else Response(status_code=202)
@router.get("/mcp")
async def mcp_no_stream():
# No server-initiated messages: tell clients not to expect an SSE stream.
return Response(status_code=405, headers={"Allow": "POST"})
+18
View File
@@ -0,0 +1,18 @@
"""GET /api/metrics — Prometheus text exposition (see services/metrics_service.py).
Authenticated like everything else; the intended client is a Prometheus job
with ``authorization: {credentials: <read token>}``.
"""
from fastapi import APIRouter, Depends
from fastapi.responses import PlainTextResponse
from sqlalchemy.ext.asyncio import AsyncSession
from app.database import get_db
from app.services import metrics_service
router = APIRouter(tags=["metrics"])
@router.get("/metrics", response_class=PlainTextResponse)
async def metrics(db: AsyncSession = Depends(get_db)):
return PlainTextResponse(await metrics_service.render(db), media_type=metrics_service.CONTENT_TYPE)
+120
View File
@@ -0,0 +1,120 @@
"""OIDC single sign-on: public login endpoints and admin-only settings (see services/oidc_service.py)."""
import logging
from urllib.parse import urlsplit
from fastapi import APIRouter, Depends, Request
from fastapi.responses import RedirectResponse
from sqlalchemy.ext.asyncio import AsyncSession
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.schemas.oidc import OidcSettingsRead, OidcSettingsUpdate
from app.security_middleware import _origin_allowed
from app.services import auth_service, notification_secret_store, oidc_service
logger = logging.getLogger(__name__)
router = APIRouter(tags=["oidc"])
CALLBACK_PATH = "/api/auth/oidc/callback"
def _login_error(code: str) -> RedirectResponse:
return RedirectResponse(f"/login?sso_error={code}", status_code=302)
@router.get("/auth/oidc/config")
async def public_config(db: AsyncSession = Depends(get_db)):
"""For the login page: is there an SSO button, and what does it say. Nothing else is revealed."""
cfg = await oidc_service.get_settings(db)
ready = oidc_service.configured(cfg)
return {"enabled": ready, "name": cfg.display_name if ready else None}
@router.get("/auth/oidc/start")
async def start(request: Request, origin: str, db: AsyncSession = Depends(get_db)):
cfg = await oidc_service.get_settings(db)
parts = urlsplit(origin)
# The redirect URI is built from the browser's own origin (so any hostname the operator uses works), but only
# an origin this server is actually reachable at is accepted: no path, no credentials, same host as the request.
if (not oidc_service.configured(cfg) or parts.path not in ("", "/") or parts.query or parts.fragment or parts.username
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}")
except oidc_service.OidcError as exc:
logger.warning("OIDC start fehlgeschlagen: %s", exc)
return _login_error(exc.code)
return RedirectResponse(url, status_code=302)
@router.get("/auth/oidc/callback")
async def callback(request: Request, code: str = "", state: str = "", error: str = "", db: AsyncSession = Depends(get_db)):
ip = client_ip(request)
if auth_service.throttle.retry_after(ip, "oidc") > 0:
return _login_error("throttled")
cfg = await oidc_service.get_settings(db)
if not oidc_service.configured(cfg):
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'}")
user = await oidc_service.complete(db, cfg, code, state)
except oidc_service.OidcError as exc:
auth_service.throttle.record_failure(ip, "oidc")
logger.warning("OIDC-Anmeldung abgelehnt (%s): %s", exc.code, exc)
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)
response = RedirectResponse("/dashboard", status_code=302)
_set_session_cookie(response, token)
logger.info("SSO-Anmeldung von '%s' (%s) aus %s", user.username, user.role, ip)
return response
def _require_admin(user: AdminUser) -> None:
if user.role != "admin":
raise api_error(403, ErrorCode.ADMIN_REQUIRED)
@router.get("/settings/oidc", response_model=OidcSettingsRead)
async def read(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
return await oidc_service.get_settings(db)
@router.put("/settings/oidc", response_model=OidcSettingsRead)
async def update(payload: OidcSettingsUpdate, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
cfg = await oidc_service.get_settings(db)
for field in ("enabled", "display_name", "issuer", "client_id", "scopes", "groups_claim", "admin_group", "operator_group", "read_only_group"):
value = getattr(payload, field)
if value is not None:
setattr(cfg, field, value.strip() if isinstance(value, str) else value)
if payload.clear_client_secret:
notification_secret_store.delete_secret(oidc_service.SECRET_NAME)
cfg.client_secret_set = False
elif payload.client_secret is not None:
notification_secret_store.save_secret(oidc_service.SECRET_NAME, payload.client_secret)
cfg.client_secret_set = True
await db.commit()
oidc_service.clear_caches()
return cfg
@router.post("/settings/oidc/test")
async def test(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
"""Fetch the provider's discovery document and signing keys: proves the issuer URL, not the login."""
_require_admin(user)
cfg = await oidc_service.get_settings(db)
if not cfg.issuer:
raise api_error(422, ErrorCode.OIDC_TEST_FAILED, reason="Kein Aussteller eingetragen")
try:
oidc_service.clear_caches()
doc = await oidc_service.discovery(cfg.issuer)
await oidc_service._jwk_for(doc, None)
except oidc_service.OidcError as exc:
raise api_error(502, ErrorCode.OIDC_TEST_FAILED, reason=str(exc)) from exc
return {"success": True, "authorization_endpoint": doc["authorization_endpoint"]}
+142
View File
@@ -0,0 +1,142 @@
"""Management overlay API (see services/overlay_service.py). Writes and the pre-shared key are admin-only."""
import uuid
from fastapi import APIRouter, Depends
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.host import OpnsenseHost
from app.models.overlay import OverlayPeer
from app.models.user import AdminUser
from app.routers.auth import current_user
from app.schemas.overlay import OverlaySettingsRead, OverlaySettingsUpdate, PeerCreate, PeerRead, PeerUpdate
from app.services import overlay_service as svc
router = APIRouter(prefix="/overlay", tags=["overlay"])
def _require_admin(user: AdminUser) -> None:
if user.role != "admin":
raise api_error(403, ErrorCode.ADMIN_REQUIRED)
async def _settings_read(db: AsyncSession) -> dict:
cfg = await svc.get_settings(db)
net = svc.parse_subnet(cfg.subnet)
return {
"enabled": cfg.enabled, "endpoint": cfg.endpoint, "subnet": cfg.subnet, "listen_port": cfg.listen_port,
"hub_public_key": svc.hub_public_key() if cfg.enabled else None, "hub_address": str(svc.hub_address(net)),
"hub_state": svc.hub_state(svc.read_status()),
}
async def _peers(db: AsyncSession) -> list[dict]:
status = svc.read_status()
rows = (await db.execute(select(OverlayPeer, OpnsenseHost.name).outerjoin(OpnsenseHost, OverlayPeer.host_id == OpnsenseHost.id).order_by(OverlayPeer.ip))).all()
return [
{"id": p.id, "name": p.name, "ip": p.ip, "public_key": p.public_key, "host_id": p.host_id, "host_name": host_name,
**svc.peer_status(status, p.public_key)}
for p, host_name in rows
]
@router.get("")
async def overview(db: AsyncSession = Depends(get_db)):
return {"settings": await _settings_read(db), "peers": await _peers(db)}
@router.put("/settings", response_model=OverlaySettingsRead)
async def update_settings(payload: OverlaySettingsUpdate, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
cfg = await svc.get_settings(db)
if payload.subnet is not None and payload.subnet.strip() != cfg.subnet:
try:
svc.parse_subnet(payload.subnet)
except svc.OverlayError as exc:
raise api_error(422, ErrorCode.OVERLAY_INVALID, reason=str(exc)) from exc
if (await db.scalar(select(OverlayPeer.id).limit(1))) is not None:
raise api_error(409, ErrorCode.OVERLAY_SUBNET_LOCKED) # peers already hold addresses in the old network
cfg.subnet = payload.subnet.strip()
for field in ("enabled", "listen_port"):
value = getattr(payload, field)
if value is not None:
setattr(cfg, field, value)
if payload.endpoint is not None:
cfg.endpoint = payload.endpoint.strip() or None
if cfg.enabled and not cfg.endpoint:
raise api_error(422, ErrorCode.OVERLAY_INVALID, reason="Ohne Endpunkt wissen die Firewalls nicht, wohin sie sich verbinden sollen")
await db.commit()
await svc.sync(db)
return await _settings_read(db)
@router.post("/peers", status_code=201)
async def create_peer(payload: PeerCreate, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
cfg = await svc.get_settings(db)
taken = set((await db.scalars(select(OverlayPeer.ip))).all())
try:
ip = svc.next_free_ip(svc.parse_subnet(cfg.subnet), taken)
except svc.OverlayError as exc:
raise api_error(409, ErrorCode.OVERLAY_INVALID, reason=str(exc)) from exc
peer = OverlayPeer(name=payload.name.strip(), ip=ip)
db.add(peer)
try:
await db.commit()
except IntegrityError:
await db.rollback()
raise api_error(409, ErrorCode.OVERLAY_NAME_TAKEN) from None
await svc.sync(db)
return {"id": peer.id, "name": peer.name, "ip": peer.ip, "instructions": svc.instructions(cfg, peer)}
@router.get("/peers/{peer_id}/instructions")
async def peer_instructions(peer_id: uuid.UUID, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
peer = await db.get(OverlayPeer, peer_id)
if peer is None:
raise api_error(404, ErrorCode.OVERLAY_PEER_NOT_FOUND)
return svc.instructions(await svc.get_settings(db), peer)
@router.patch("/peers/{peer_id}")
async def update_peer(peer_id: uuid.UUID, payload: PeerUpdate, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
peer = await db.get(OverlayPeer, peer_id)
if peer is None:
raise api_error(404, ErrorCode.OVERLAY_PEER_NOT_FOUND)
if payload.public_key is not None:
key = payload.public_key.strip()
if key and not svc.valid_public_key(key):
raise api_error(422, ErrorCode.OVERLAY_INVALID, reason="Das ist kein WireGuard-Schlüssel (44 Zeichen, Base64)")
if key and key == svc.hub_public_key():
raise api_error(422, ErrorCode.OVERLAY_INVALID, reason="Das ist der Schlüssel des Hubs, nicht der der Firewall")
peer.public_key = key or None
if payload.clear_host:
peer.host_id = None
elif payload.host_id is not None:
if await db.get(OpnsenseHost, payload.host_id) is None:
raise api_error(404, ErrorCode.HOST_NICHT_GEFUNDEN)
peer.host_id = payload.host_id
try:
await db.commit()
except IntegrityError:
await db.rollback()
raise api_error(409, ErrorCode.OVERLAY_INVALID, reason="Dieser Schlüssel gehört schon zu einem anderen Eintrag") from None
await svc.sync(db)
return {"ok": True}
@router.delete("/peers/{peer_id}", status_code=204)
async def delete_peer(peer_id: uuid.UUID, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
_require_admin(user)
peer = await db.get(OverlayPeer, peer_id)
if peer is None:
raise api_error(404, ErrorCode.OVERLAY_PEER_NOT_FOUND)
await db.delete(peer)
await db.commit()
svc.delete_peer_secret(peer_id)
await svc.sync(db)
+17 -1
View File
@@ -11,6 +11,8 @@ from app.errors import ErrorCode, api_error
from app.database import get_db
from app.models import OpnsenseHost
from app.models.scheduled_maintenance import ScheduledMaintenance
from app.services.host_maintenance_service import peers
from app.services.host_status_service import get_statuses
from app.services.policy_service import policy_lock
router = APIRouter(prefix="/hosts/{host_id}/maintenance/schedule", tags=["host-maintenance"])
@@ -20,6 +22,8 @@ class Schedule(BaseModel):
action: Literal["reboot", "update", "major_update"]
run_at: datetime
acknowledge_unattended: Literal[True]
# Hand the traffic over to the CARP partner first and switch back afterwards (cluster nodes only).
carp_handover: bool = False
def _read(sched: ScheduledMaintenance) -> dict:
@@ -27,6 +31,7 @@ def _read(sched: ScheduledMaintenance) -> dict:
"id": sched.id, "host_id": sched.host_id, "action": sched.action, "run_at": sched.run_at,
"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,
}
@@ -61,9 +66,20 @@ async def create_scheduled(host_id: uuid.UUID, payload: Schedule, request: Reque
run_at = payload.run_at if payload.run_at.tzinfo else payload.run_at.replace(tzinfo=timezone.utc)
if run_at <= now:
raise api_error(422, ErrorCode.ZEITPUNKT_MUSS_IN_DER_ZUKUNFT_LIEGEN)
if payload.carp_handover:
if not host.cluster_name or len(await peers(db, host)) < 2:
raise api_error(409, ErrorCode.CARP_UEBERGABE_BRAUCHT_EINEN_CLUSTER)
elif host.cluster_name:
# Without a handover, fire time refuses every cluster node that is not the CARP BACKUP, so a
# plan for the current MASTER can only ever end as "failed" at 3 a.m. Say so now.
# Only a *known* MASTER is rejected here: an unreachable node or an unclear role
# is still judged by the full check when the plan fires.
statuses = await get_statuses(await peers(db, host))
if statuses.get(host.id, {}).get("carp_status") == "MASTER":
raise api_error(409, ErrorCode.GEPLANTE_WARTUNG_NUR_AUF_DEM_CARP_BACKUP_MOEGLICH)
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,
actor=request.state.user.username, created_at=now, carp_handover=payload.carp_handover,
)
db.add(sched)
await db.commit()
+5 -2
View File
@@ -14,12 +14,14 @@ router=APIRouter(prefix='/settings',tags=['settings'])
class Preferences(BaseModel):
theme: Literal['light','dark','system'] | None = None
language: Literal['de','en'] | None = None
setup_done: bool | None = None
@router.get('')
async def read(user: AdminUser=Depends(current_user),db:AsyncSession=Depends(get_db)):
preferences=await db.get(UserPreferences,user.id)
return {'username':user.username,'theme':preferences.theme if preferences else 'system',
'language':preferences.language if preferences else 'de',
'setup_done':preferences.setup_done if preferences else False,
'deploy_confirm_window_seconds':settings.deploy_confirm_window_seconds,
'session_lifetime_seconds':settings.session_lifetime}
@@ -29,8 +31,9 @@ async def update(payload:Preferences,user:AdminUser=Depends(current_user),db:Asy
current = await db.get(UserPreferences, user.id)
theme = payload.theme or (current.theme if current else 'system')
language = payload.language or (current.language if current else 'de')
await db.execute(insert(UserPreferences).values(user_id=user.id,theme=theme,language=language).on_conflict_do_update(index_elements=['user_id'],set_={'theme':theme,'language':language}))
setup_done = payload.setup_done if payload.setup_done is not None else bool(current.setup_done if current else False)
await db.execute(insert(UserPreferences).values(user_id=user.id,theme=theme,language=language,setup_done=setup_done).on_conflict_do_update(index_elements=['user_id'],set_={'theme':theme,'language':language,'setup_done':setup_done}))
await db.commit()
return {'username':username,'theme':theme,'language':language,
return {'username':username,'theme':theme,'language':language,'setup_done':setup_done,
'deploy_confirm_window_seconds':settings.deploy_confirm_window_seconds,
'session_lifetime_seconds':settings.session_lifetime}
+68
View File
@@ -0,0 +1,68 @@
"""Manage personal API tokens (see services/api_token_service.py for scopes).
Session-only: an API token cannot reach these endpoints (AuthMiddleware), so a
leaked token can never mint a replacement or list/revoke its siblings. A
read_only user may manage their own tokens, but only with read scope (an operator up to deploy).
"""
import uuid
from fastapi import APIRouter, Depends, status
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.api_token import ApiToken
from app.models.user import AdminUser
from app.routers.auth import _account_failure, _account_success, _check_account_budget, current_user
from app.schemas.api_token import ApiTokenCreate, ApiTokenCreated, ApiTokenRead, TokenScope
from app.services import api_token_service, auth_service
router = APIRouter(prefix="/tokens", tags=["tokens"])
def _read(token: ApiToken, owner: str) -> dict:
return {
"id": token.id, "name": token.name, "scope": token.scope, "prefix": token.prefix, "owner": owner,
"created_at": token.created_at, "expires_at": token.expires_at,
"last_used_at": token.last_used_at, "last_used_ip": token.last_used_ip,
}
@router.get("", response_model=list[ApiTokenRead])
async def list_tokens(db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)):
"""Own tokens; an admin sees everybody's (to be able to revoke them)."""
query = select(ApiToken, AdminUser.username).join(AdminUser, ApiToken.user_id == AdminUser.id)
if user.role != "admin":
query = query.where(ApiToken.user_id == user.id)
rows = (await db.execute(query.order_by(ApiToken.created_at.desc()))).all()
return [_read(token, owner) for token, owner in rows]
@router.post("", response_model=ApiTokenCreated, status_code=status.HTTP_201_CREATED)
async def create_token(
payload: ApiTokenCreate, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)
):
allowed = {"admin": (TokenScope.read, TokenScope.deploy, TokenScope.admin), "operator": (TokenScope.read, TokenScope.deploy)}
if payload.scope not in allowed.get(user.role, (TokenScope.read,)):
raise api_error(403, ErrorCode.API_TOKEN_SCOPE_TOO_HIGH)
_check_account_budget(user, "create-token")
if not await auth_service.verify_password_async(user.password_hash, payload.current_password):
_account_failure(user, "create-token")
raise api_error(401, ErrorCode.AKTUELLES_PASSWORT_IST_FALSCH)
_account_success(user, "create-token")
token, raw = await api_token_service.create(
db, user, name=payload.name.strip(), scope=payload.scope.value, expires_in_days=payload.expires_in_days
)
return {**_read(token, user.username), "token": raw}
@router.delete("/{token_id}", status_code=204)
async def revoke_token(
token_id: uuid.UUID, db: AsyncSession = Depends(get_db), user: AdminUser = Depends(current_user)
):
token = await db.get(ApiToken, token_id)
if token is None or (token.user_id != user.id and user.role != "admin"):
raise api_error(404, ErrorCode.API_TOKEN_NOT_FOUND)
await db.delete(token)
await db.commit()
+6 -1
View File
@@ -9,7 +9,7 @@ from app.database import get_db
from app.models.user import AdminUser
from app.routers.auth import current_user
from app.schemas.user import UserCreate, UserPasswordReset, UserRead, UserRoleUpdate
from app.services import auth_service, totp_service
from app.services import api_token_service, auth_service, totp_service
router = APIRouter(prefix="/users", tags=["users"])
@@ -47,6 +47,8 @@ async def update_role(user_id: uuid.UUID, payload: UserRoleUpdate, db: AsyncSess
target = await db.get(AdminUser, user_id)
if target is None:
raise api_error(404, ErrorCode.BENUTZER_NICHT_GEFUNDEN)
if target.auth_source == "oidc":
raise api_error(409, ErrorCode.OIDC_MANAGED_USER) # the identity provider's groups decide, at every login
if target.role == "admin" and payload.role.value != "admin" and await _admin_count(db, exclude_id=target.id) == 0:
raise api_error(409, ErrorCode.MINDESTENS_EIN_ADMIN_ACCOUNT_MUSS_BESTEHEN_BLEIBEN)
target.role = payload.role.value
@@ -75,10 +77,13 @@ async def reset_password(user_id: uuid.UUID, payload: UserPasswordReset, db: Asy
target = await db.get(AdminUser, user_id)
if target is None:
raise api_error(404, ErrorCode.BENUTZER_NICHT_GEFUNDEN)
if target.auth_source == "oidc":
raise api_error(409, ErrorCode.OIDC_MANAGED_USER)
target.password_hash = await auth_service.hash_password_async(payload.new_password)
# A reset is the answer to a suspected compromise: every session of the
# account ends with the old password, atomically with the new hash.
await auth_service.revoke_sessions(db, target.id, commit=False)
await api_token_service.revoke_all(db, target.id, commit=False)
await db.commit()
return target
+40
View File
@@ -0,0 +1,40 @@
import uuid
from datetime import datetime
from enum import Enum
from pydantic import BaseModel, ConfigDict, Field
class TokenScope(str, Enum):
read = "read"
deploy = "deploy"
admin = "admin"
class ApiTokenCreate(BaseModel):
name: str = Field(min_length=1, max_length=80)
# Least privilege by default.
scope: TokenScope = TokenScope.read
# None = never expires. The UI defaults to 90 days.
expires_in_days: int | None = Field(default=None, ge=1, le=3650)
# Creating a long-lived credential needs the account password again.
current_password: str = Field(min_length=1, max_length=1024)
class ApiTokenRead(BaseModel):
model_config = ConfigDict(from_attributes=True)
id: uuid.UUID
name: str
scope: TokenScope
prefix: str
owner: str
created_at: datetime
expires_at: datetime | None
last_used_at: datetime | None
last_used_ip: str | None
class ApiTokenCreated(ApiTokenRead):
# The only time the raw token is ever returned.
token: str
+32
View File
@@ -0,0 +1,32 @@
from datetime import datetime
from typing import Literal
from pydantic import BaseModel, ConfigDict, Field
class AuditExportRead(BaseModel):
model_config = ConfigDict(from_attributes=True)
syslog_enabled: bool
syslog_host: str | None
syslog_port: int
syslog_protocol: Literal["udp", "tcp", "tls"]
webhook_enabled: bool
webhook_url: str | None
webhook_signing_secret_set: bool
last_success_at: datetime | None
last_error: str | None
last_error_at: datetime | None
class AuditExportUpdate(BaseModel):
"""Partial update; the signing secret is write-only (set it or clear it)."""
syslog_enabled: bool | None = None
syslog_host: str | None = Field(default=None, max_length=255)
syslog_port: int | None = Field(default=None, ge=1, le=65535)
syslog_protocol: Literal["udp", "tcp", "tls"] | None = None
webhook_enabled: bool | None = None
webhook_url: str | None = Field(default=None, max_length=500)
webhook_signing_secret: str | None = Field(default=None, min_length=1)
clear_webhook_signing_secret: bool = False
+46
View File
@@ -0,0 +1,46 @@
from datetime import datetime
from pydantic import BaseModel, ConfigDict, Field
class BackupStatusRead(BaseModel):
"""What every signed-in user may see: no endpoints, no keys."""
model_config = ConfigDict(from_attributes=True)
scheduled_enabled: bool
interval_hours: int
keep_count: int
offsite_enabled: bool
last_run_at: datetime | None
last_offsite_ok_at: datetime | None
last_offsite_error: str | None
class BackupSettingsRead(BackupStatusRead):
s3_endpoint: str | None
s3_region: str
s3_bucket: str | None
s3_prefix: str
s3_access_key: str | None
s3_path_style: bool
s3_secret_set: bool
passphrase_set: bool
class BackupSettingsUpdate(BaseModel):
"""Partial update; the S3 secret key and the passphrase are write-only."""
scheduled_enabled: bool | None = None
interval_hours: int | None = Field(default=None, ge=1, le=24 * 30)
keep_count: int | None = Field(default=None, ge=3, le=1000)
offsite_enabled: bool | None = None
s3_endpoint: str | None = Field(default=None, max_length=255)
s3_region: str | None = Field(default=None, min_length=1, max_length=64)
s3_bucket: str | None = Field(default=None, max_length=255)
s3_prefix: str | None = Field(default=None, max_length=255)
s3_access_key: str | None = Field(default=None, max_length=255)
s3_path_style: bool | None = None
s3_secret_key: str | None = Field(default=None, min_length=1, max_length=512)
clear_s3_secret: bool = False
passphrase: str | None = Field(default=None, min_length=12, max_length=512)
+7
View File
@@ -10,6 +10,9 @@ SmtpSecurity = Literal["none", "starttls", "ssl"]
ProblemType = Literal[
"host_offline", "cert_expiry", "rule_drift", "revert_failed", "maintenance_unknown",
"carp_split_brain", "nat_drift", "carp_auto_revert_failed", "network_drift",
"scheduled_maintenance_failed",
"backup_stale",
"backup_offsite_failed",
]
@@ -38,6 +41,8 @@ class NotificationSettingsRead(BaseModel):
nat_drift_enabled: bool
network_drift_enabled: bool = True
carp_auto_revert_failed_enabled: bool
scheduled_maintenance_failed_enabled: bool = True
backup_failed_enabled: bool = True
poll_interval_seconds: int
updated_at: datetime
@@ -74,6 +79,8 @@ class NotificationSettingsUpdate(BaseModel):
nat_drift_enabled: bool | None = None
network_drift_enabled: bool | None = None
carp_auto_revert_failed_enabled: bool | None = None
scheduled_maintenance_failed_enabled: bool | None = None
backup_failed_enabled: bool | None = None
poll_interval_seconds: int | None = Field(
default=None, ge=settings.notification_poll_min_interval_seconds
+39
View File
@@ -0,0 +1,39 @@
from pydantic import BaseModel, ConfigDict, Field, field_validator
class OidcSettingsRead(BaseModel):
model_config = ConfigDict(from_attributes=True)
enabled: bool
display_name: str
issuer: str | None
client_id: str | None
client_secret_set: bool
scopes: str
groups_claim: str
admin_group: str | None
operator_group: str | None
read_only_group: str | None
class OidcSettingsUpdate(BaseModel):
"""Partial update; the client secret is write-only (set it or clear it)."""
enabled: bool | None = None
display_name: str | None = Field(default=None, min_length=1, max_length=60)
issuer: str | None = Field(default=None, max_length=500)
client_id: str | None = Field(default=None, max_length=255)
client_secret: str | None = Field(default=None, min_length=1, max_length=512)
clear_client_secret: bool = False
scopes: str | None = Field(default=None, min_length=1, max_length=255)
groups_claim: str | None = Field(default=None, min_length=1, max_length=64)
admin_group: str | None = Field(default=None, max_length=255)
operator_group: str | None = Field(default=None, max_length=255)
read_only_group: str | None = Field(default=None, max_length=255)
@field_validator("issuer")
@classmethod
def https_only(cls, value):
if value and not value.startswith("https://"):
raise ValueError("issuer must be an https:// URL")
return value.strip().rstrip("/") if value else value
+45
View File
@@ -0,0 +1,45 @@
from datetime import datetime
import uuid
from pydantic import BaseModel, Field
class OverlaySettingsRead(BaseModel):
enabled: bool
endpoint: str | None
subnet: str
listen_port: int
hub_public_key: str | None
hub_address: str
hub_state: str # running | stale | absent
class OverlaySettingsUpdate(BaseModel):
enabled: bool | None = None
endpoint: str | None = Field(default=None, max_length=255)
subnet: str | None = Field(default=None, max_length=18)
listen_port: int | None = Field(default=None, ge=1, le=65535)
class PeerCreate(BaseModel):
name: str = Field(min_length=1, max_length=80)
class PeerUpdate(BaseModel):
public_key: str | None = Field(default=None, max_length=44)
host_id: uuid.UUID | None = None
clear_host: bool = False
class PeerRead(BaseModel):
id: uuid.UUID
name: str
ip: str
public_key: str | None
host_id: uuid.UUID | None
host_name: str | None
connected: bool
last_handshake_at: datetime | None
rx_bytes: int
tx_bytes: int
remote_endpoint: str | None
+4
View File
@@ -7,6 +7,9 @@ from pydantic import BaseModel, ConfigDict, Field
class UserRole(str, Enum):
admin = "admin"
# Rolls out and operates (rules, NAT, VPN, maintenance, tokens of its own) but cannot
# change who may access OPNexus or where it sends data (users, settings, hosts).
operator = "operator"
read_only = "read_only"
@@ -36,3 +39,4 @@ class UserRead(BaseModel):
created_at: datetime
last_login_at: datetime | None
totp_enabled: bool = False
auth_source: str = "local"
+144
View File
@@ -0,0 +1,144 @@
"""Personal API tokens: creation, lookup and scope rules.
Scopes (a token can never do more than its owner's role allows; a read_only
user's token is read-only whatever its scope says):
* ``read`` — GET/HEAD/OPTIONS only, except endpoints that return secrets (raw
config backups, notification settings): those need ``admin``. For Prometheus,
dashboards, MCP clients.
* ``deploy`` — additionally every write that rolls out or operates on the fleet
(rules, aliases, NAT, VPN, maintenance, backups...). NOT the writes that
change who can access OPNexus or where it sends data: users, settings,
notifications, host registration/removal, log settings, OPNexus self-update.
* ``admin`` — everything the owner may do, except what is session-only.
Session-only for every scope: managing tokens themselves and the account
endpoints (/api/auth/*), so a leaked token can neither mint more tokens nor
change a password or second factor.
The enforcement lives in AuthMiddleware (one place, like the read_only role).
"""
import hashlib
import re
import secrets
from datetime import datetime, timedelta, timezone
from sqlalchemy import delete, select
from sqlalchemy.ext.asyncio import AsyncSession
from app.errors import ErrorCode, api_error
from app.models.api_token import ApiToken
from app.models.user import AdminUser
TOKEN_PREFIX = "opx_"
SCOPES = ("read", "deploy", "admin")
MAX_TOKENS_PER_USER = 50
# last_used_at is only rewritten when older than this, so a scraper hitting
# /api/metrics every few seconds does not turn into a write per request.
_LAST_USED_GRANULARITY = timedelta(minutes=1)
_SAFE_METHODS = ("GET", "HEAD", "OPTIONS")
_SESSION_ONLY = re.compile(r"^/api/(tokens|auth)(/|$)")
# 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$")
# The MCP endpoint is POST (JSON-RPC) but its tools only ever read.
_MCP_PATH = "/api/mcp"
_ADMIN_ONLY_WRITES = re.compile(
r"^/api/(users|settings|system|notifications|overlay)(/|$)"
r"|^/api/logs/settings$"
r"|^/api/hosts(/tls-probe|/[^/]+)?$"
)
def _now() -> datetime:
return datetime.now(timezone.utc)
def hash_token(raw: str) -> str:
return hashlib.sha256(raw.encode()).hexdigest()
def denies(scope: str, method: str, path: str) -> bool:
"""True if a token with this scope must not make this request."""
if _SESSION_ONLY.match(path):
return True
if path == _MCP_PATH:
return False
if method in _SAFE_METHODS:
return scope != "admin" and bool(_ADMIN_SCOPE_READS.match(path))
if scope == "read":
return True
if scope == "deploy" and _ADMIN_ONLY_WRITES.match(path):
return True
return False
def operator_denies(method: str, path: str) -> bool:
"""True if an `operator` account must not make this request: the writes that
change who may access OPNexus or where it sends data. (Their own theme at
PUT /api/settings stays open; account endpoints are not matched here.)"""
return method not in _SAFE_METHODS and path != "/api/settings" and bool(_ADMIN_ONLY_WRITES.match(path))
# 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)$"
)
def is_rollout(method: str, path: str) -> bool:
return method == "POST" and bool(_ROLLOUT.search(path))
def bearer_from_header(header: str) -> str | None:
"""The token of an ``Authorization: Bearer opx_...`` header, else None."""
scheme, _, value = header.partition(" ")
value = value.strip()
if scheme.lower() == "bearer" and value.startswith(TOKEN_PREFIX):
return value
return None
async def create(
db: AsyncSession, user: AdminUser, *, name: str, scope: str, expires_in_days: int | None
) -> tuple[ApiToken, str]:
count = len((await db.scalars(select(ApiToken.id).where(ApiToken.user_id == user.id))).all())
if count >= MAX_TOKENS_PER_USER:
raise api_error(409, ErrorCode.API_TOKEN_LIMIT_REACHED, limit=MAX_TOKENS_PER_USER)
raw = TOKEN_PREFIX + secrets.token_urlsafe(32)
token = ApiToken(
user_id=user.id,
name=name,
scope=scope,
token_hash=hash_token(raw),
prefix=raw[: len(TOKEN_PREFIX) + 6],
expires_at=_now() + timedelta(days=expires_in_days) if expires_in_days else None,
)
db.add(token)
await db.commit()
await db.refresh(token)
return token, raw
async def resolve(db: AsyncSession, raw: str, ip: str | None) -> tuple[AdminUser, ApiToken] | None:
"""The owner and token for a raw bearer token, or None if unknown/expired."""
token = await db.scalar(select(ApiToken).where(ApiToken.token_hash == hash_token(raw)))
if token is None or (token.expires_at is not None and token.expires_at <= _now()):
return None
user = await db.get(AdminUser, token.user_id)
if user is None:
return None
if token.last_used_at is None or _now() - token.last_used_at > _LAST_USED_GRANULARITY:
token.last_used_at = _now()
token.last_used_ip = ip
await db.commit()
return user, token
async def revoke_all(db: AsyncSession, user_id, *, commit: bool = True) -> None:
"""Delete every token of an account (password reset: answer to a suspected compromise)."""
await db.execute(delete(ApiToken).where(ApiToken.user_id == user_id))
if commit:
await db.commit()
@@ -0,0 +1,177 @@
"""Ships new audit events to syslog (RFC 5424, UDP / TCP / TLS) and/or a webhook.
A poll loop (main.py) calls ``run_once``: events after the stored cursor, oldest
first, in batches. A channel failing leaves the cursor where it is, so the same
events are tried again next round (at-least-once; every event carries its id so a
receiver can de-duplicate). If both channels are on, both must succeed to advance.
What is sent: who, what kind/action/status, which entity and host, the message and
a correlation id. NOT ``details`` — those hold before/after payloads of firewall
objects, which have no business in a log aggregator.
"""
import asyncio
import hashlib
import hmac
import json
import logging
import socket
import ssl
import uuid
from datetime import datetime, timedelta, timezone
import httpx
from sqlalchemy import and_, or_, select
from sqlalchemy.ext.asyncio import AsyncSession
from app.config import settings
from app.models.audit import AuditEvent
from app.models.audit_export import AuditExportSettings
from app.services import notification_secret_store
from app.version import APP_VERSION
logger = logging.getLogger(__name__)
SINGLETON_ID = 1
BATCH = 200
SECRET_NAME = "audit_webhook_signing_secret"
_FACILITY_LOCAL0 = 16
_BAD_STATUSES = {"denied", "rejected", "error", "revert_failed", "failed"}
class ExportError(Exception):
pass
async def get_settings(db: AsyncSession) -> AuditExportSettings:
row = await db.get(AuditExportSettings, SINGLETON_ID)
if row is None:
row = AuditExportSettings(
id=SINGLETON_ID, syslog_enabled=False, syslog_port=514, syslog_protocol="udp",
webhook_enabled=False, webhook_signing_secret_set=False,
)
db.add(row)
await db.flush()
return row
def event_dict(event: AuditEvent) -> dict:
return {
"id": str(event.id), "time": event.created_at.isoformat(), "correlation_id": event.correlation_id,
"actor": event.actor, "kind": event.kind, "action": event.action, "status": event.status,
"entity_id": event.entity_id, "entity_name": event.entity_name,
"host_id": event.host_id, "host_name": event.host_name, "message": event.message,
}
def syslog_line(event: dict, hostname: str = "opnexus") -> bytes:
"""RFC 5424: <PRI>1 TIMESTAMP HOSTNAME APP-NAME PROCID MSGID - MSG (JSON)."""
severity = 4 if event["status"] in _BAD_STATUSES else 6
pri = _FACILITY_LOCAL0 * 8 + severity
return f"<{pri}>1 {event['time']} {hostname} opnexus - AUDIT - {json.dumps(event, ensure_ascii=False)}".encode()
def _frame_tcp(lines: list[bytes]) -> bytes:
"""RFC 6587 octet counting: '<len> <message>' per message."""
return b"".join(str(len(line)).encode() + b" " + line for line in lines)
def _send_syslog_sync(row: AuditExportSettings, lines: list[bytes]) -> None:
host, port = row.syslog_host, row.syslog_port
if row.syslog_protocol == "udp":
with socket.socket(socket.AF_INET6 if ":" in (host or "") else socket.AF_INET, socket.SOCK_DGRAM) as sock:
for line in lines:
sock.sendto(line[:8000], (host, port))
return
with socket.create_connection((host, port), timeout=settings.opnsense_timeout) as raw:
if row.syslog_protocol == "tls":
context = ssl.create_default_context(cafile=settings.smtp_ca_file or None)
with context.wrap_socket(raw, server_hostname=host) as tls:
tls.sendall(_frame_tcp(lines))
else:
raw.sendall(_frame_tcp(lines))
async def send_syslog(row: AuditExportSettings, events: list[dict]) -> None:
if not row.syslog_host:
raise ExportError("Kein Syslog-Ziel konfiguriert")
try:
await asyncio.to_thread(_send_syslog_sync, row, [syslog_line(e) for e in events])
except (OSError, ssl.SSLError) as exc:
raise ExportError(f"Syslog-Zustellung fehlgeschlagen ({type(exc).__name__})") from None
async def send_webhook(row: AuditExportSettings, events: list[dict]) -> None:
if not row.webhook_url:
raise ExportError("Keine Webhook-URL konfiguriert")
raw = json.dumps({"source": "opnexus", "version": APP_VERSION, "events": events}, ensure_ascii=False).encode()
headers = {"Content-Type": "application/json"}
if row.webhook_signing_secret_set:
secret = notification_secret_store.read_secret(SECRET_NAME)
if not secret:
raise ExportError("Signaturschlüssel ist konfiguriert, aber nicht lesbar – bitte neu setzen")
headers["X-OPNexus-Signature"] = "sha256=" + hmac.new(secret.encode(), raw, hashlib.sha256).hexdigest()
try:
async with httpx.AsyncClient(timeout=settings.opnsense_timeout) as client:
(await client.post(row.webhook_url, content=raw, headers=headers)).raise_for_status()
except httpx.HTTPError as exc:
# The URL often is the credential: never put it in a message.
reason = f"HTTP {exc.response.status_code}" if isinstance(exc, httpx.HTTPStatusError) else type(exc).__name__
raise ExportError(f"Webhook-Zustellung fehlgeschlagen ({reason})") from None
def active(row: AuditExportSettings) -> bool:
return bool((row.syslog_enabled and row.syslog_host) or (row.webhook_enabled and row.webhook_url))
async def _ship(row: AuditExportSettings, events: list[dict]) -> None:
if row.syslog_enabled and row.syslog_host:
await send_syslog(row, events)
if row.webhook_enabled and row.webhook_url:
await send_webhook(row, events)
async def run_once(db: AsyncSession, lag_seconds: float = 3.0) -> int:
"""Ship one batch; returns how many events went out (0 when idle or failing).
Only events at least ``lag_seconds`` old are shipped: an event is stamped when it
is created, a moment before its transaction commits, and the cursor must not
jump past one that becomes visible a little later."""
row = await get_settings(db)
if not active(row):
return 0
if row.cursor_created_at is None:
# First round after enabling: start from now, do not replay history.
row.cursor_created_at = datetime.now(timezone.utc)
row.cursor_id = None
await db.commit()
return 0
after = AuditEvent.created_at > row.cursor_created_at
if row.cursor_id:
after = or_(after, and_(AuditEvent.created_at == row.cursor_created_at, AuditEvent.id > uuid.UUID(row.cursor_id)))
ripe = AuditEvent.created_at <= datetime.now(timezone.utc) - timedelta(seconds=lag_seconds)
# Ordering by (created_at, id) must match the cursor comparison above.
events = (await db.scalars(select(AuditEvent).where(after, ripe).order_by(AuditEvent.created_at, AuditEvent.id).limit(BATCH))).all()
if not events:
return 0
try:
await _ship(row, [event_dict(e) for e in events])
except ExportError as exc:
row.last_error, row.last_error_at = str(exc)[:300], datetime.now(timezone.utc)
await db.commit()
logger.warning("Audit-Export: %s", exc)
return 0
row.cursor_created_at, row.cursor_id = events[-1].created_at, str(events[-1].id)
row.last_success_at, row.last_error = datetime.now(timezone.utc), None
await db.commit()
return len(events)
async def send_test(row: AuditExportSettings) -> None:
event = {
"id": "00000000-0000-0000-0000-000000000000", "time": datetime.now(timezone.utc).isoformat(),
"correlation_id": "test", "actor": "opnexus", "kind": "test", "action": "test", "status": "accepted",
"entity_id": None, "entity_name": None, "host_id": None, "host_name": None,
"message": "Dies ist ein Test des Audit-Exports von OPNexus.",
}
if not (row.syslog_enabled or row.webhook_enabled):
raise ExportError("Kein Kanal eingeschaltet")
await _ship(row, [event])
+3 -2
View File
@@ -1,7 +1,7 @@
"""Authentication core: password hashing, server-side sessions, brute-force
protection and the initial admin bootstrap.
Two roles ("admin", "read_only"), no orgs, no API keys — see
Two roles ("admin", "read_only"), no orgs; API tokens live in api_token_service — see
AdminUser/AuthMiddleware for how a role is enforced. Originally mirrored
InfraPanel's own app/services/auth_service.py (single-admin-only); the role
column and its enforcement are OPNexus-specific additions on top of that.
@@ -367,7 +367,8 @@ async def bootstrap_admin(db: AsyncSession) -> None:
logger.warning(
"\n%s\n No ADMIN_PASSWORD set — created admin user '%s' with a\n"
" generated password:\n\n %s\n\n"
" Log in and change it now. This is shown only once.\n%s",
" Log in and change it now. This is shown only once.\n"
" Lost it? ./opnexus password (sets and prints a new one)\n%s",
"=" * 64, settings.admin_username, password, "=" * 64,
)
else:
+45
View File
@@ -0,0 +1,45 @@
"""Client-side encryption of config backups before they leave the server.
File format (``.opxbak``): ``OPXBAK1`` | salt (16) | nonce (12) | AES-256-GCM ciphertext+tag.
The key is scrypt(passphrase, salt). The header is authenticated as associated data, so a
file cannot be re-labelled. The passphrase never leaves OPNexus' secret store; without it
an offsite copy is unreadable, which is the point — and also why it must be kept somewhere
else too (see the handbook). Decrypt with ``python -m app.backup_decrypt``.
"""
import os
from cryptography.exceptions import InvalidTag
from cryptography.hazmat.primitives.ciphers.aead import AESGCM
from cryptography.hazmat.primitives.kdf.scrypt import Scrypt
MAGIC = b"OPXBAK1"
_SALT, _NONCE = 16, 12
# scrypt cost: ~64 MiB, well above interactive defaults; a backup is encrypted rarely.
_N, _R, _P = 2**16, 8, 1
class DecryptError(Exception):
pass
def _key(passphrase: str, salt: bytes) -> bytes:
return Scrypt(salt=salt, length=32, n=_N, r=_R, p=_P).derive(passphrase.encode())
def encrypt(plaintext: bytes, passphrase: str) -> bytes:
salt, nonce = os.urandom(_SALT), os.urandom(_NONCE)
header = MAGIC + salt + nonce
return header + AESGCM(_key(passphrase, salt)).encrypt(nonce, plaintext, header)
def decrypt(blob: bytes, passphrase: str) -> bytes:
header_len = len(MAGIC) + _SALT + _NONCE
if len(blob) < header_len + 16 or not blob.startswith(MAGIC):
raise DecryptError("Keine OPNexus-Backup-Datei (Kopfzeile fehlt).")
header, body = blob[:header_len], blob[header_len:]
salt = header[len(MAGIC): len(MAGIC) + _SALT]
nonce = header[len(MAGIC) + _SALT:]
try:
return AESGCM(_key(passphrase, salt)).decrypt(nonce, body, header)
except InvalidTag:
raise DecryptError("Falsche Passphrase oder beschädigte Datei.") from None
@@ -0,0 +1,55 @@
"""Readable, redacted diff between two stored config backups of the same host.
Both files are parsed (defusedxml), the volatile ``revision`` block is dropped, and every leaf that
looks like a secret (password, key, token, PSK, community...) or is a long blob (certificates,
private keys) is replaced by a short hash. A changed secret therefore still shows up as a change,
but its value never leaves the server. Output is a unified diff, capped in size.
"""
import difflib
import hashlib
import re
from xml.etree.ElementTree import Element, indent, tostring
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)
_HARMLESS_SUFFIX = re.compile(r"(len|length|type|size|bits|file|name)$", re.I)
_BLOB = 120
class InvalidConfig(ValueError):
pass
def _redact(root: Element) -> 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] + "›"
def normalise(xml_bytes: bytes) -> list[str]:
if not xml_bytes.strip() or len(xml_bytes) > MAX_BYTES:
raise InvalidConfig("leer oder zu groß")
try:
root = safe_ET.fromstring(xml_bytes)
except Exception as exc: # defusedxml raises several parse/forbidden-entity types
raise InvalidConfig(type(exc).__name__) from None
if root.tag != "opnsense":
raise InvalidConfig("keine OPNsense-Konfiguration")
for volatile in root.findall("revision"):
root.remove(volatile)
_redact(root)
indent(root, space=" ")
return tostring(root, encoding="unicode").splitlines()
def diff(old: bytes, new: bytes) -> dict:
a, b = normalise(old), normalise(new)
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("---"))
return {"identical": not lines, "added": added, "removed": removed, "truncated": len(lines) > MAX_LINES, "lines": lines[:MAX_LINES]}
@@ -0,0 +1,136 @@
"""Scheduled config backups: take, keep the newest N, copy encrypted offsite.
Called by a poll loop (main.py). Per enabled host a new snapshot is taken when the newest one
is older than the interval; the oldest beyond ``keep_count`` are deleted. When an offsite target
is set, every local snapshot that is not offsite yet is encrypted (backup_crypto) and uploaded
(s3_client); the ledger ``backup_uploads`` remembers what is already there. Nothing is ever
deleted offsite: use the bucket's lifecycle rules for that.
"""
import logging
import re
from datetime import datetime, timedelta, timezone
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.backup_settings import BackupSettings, BackupUpload
from app.models.host import OpnsenseHost
from app.services import backup_crypto, backup_store, notification_secret_store
from app.services import opnsense_client as client
from app.services.opnsense_client import OpnsenseAPIError
from app.services.s3_client import S3Client, S3Error
logger = logging.getLogger(__name__)
SINGLETON_ID = 1
S3_SECRET, PASSPHRASE = "backup_s3_secret", "backup_passphrase"
MAX_UPLOADS_PER_RUN = 20
async def get_settings(db: AsyncSession) -> BackupSettings:
row = await db.get(BackupSettings, SINGLETON_ID)
if row is None:
row = BackupSettings(
id=SINGLETON_ID, scheduled_enabled=True, interval_hours=24, keep_count=30, offsite_enabled=False,
s3_region="us-east-1", s3_prefix="opnexus", s3_path_style=True, s3_secret_set=False, passphrase_set=False,
)
db.add(row)
await db.flush()
return row
def offsite_ready(cfg: BackupSettings) -> bool:
return bool(cfg.offsite_enabled and cfg.s3_endpoint and cfg.s3_bucket and cfg.s3_access_key and cfg.s3_secret_set and cfg.passphrase_set)
def s3_for(cfg: BackupSettings) -> S3Client:
secret = notification_secret_store.read_secret(S3_SECRET)
if not (cfg.s3_endpoint and cfg.s3_bucket and cfg.s3_access_key and secret):
raise S3Error("Offsite-Ziel unvollständig (Endpunkt, Bucket, Zugangsdaten)")
return S3Client(endpoint=cfg.s3_endpoint, region=cfg.s3_region, bucket=cfg.s3_bucket, access_key=cfg.s3_access_key,
secret_key=secret, path_style=cfg.s3_path_style)
def remote_key(cfg: BackupSettings, host: OpnsenseHost, snapshot_id: str) -> str:
safe = re.sub(r"[^A-Za-z0-9._-]+", "-", host.name).strip("-") or "host"
prefix = cfg.s3_prefix.strip("/")
return "/".join(p for p in (prefix, f"{safe}-{str(host.id)[:8]}", snapshot_id.removesuffix(".xml") + ".opxbak") if p)
async def _take(host: OpnsenseHost) -> str:
content = await client.download_backup(host)
if b"<opnsense" not in content[:4096]:
raise OpnsenseAPIError("Antwort ist keine OPNsense-Konfiguration")
return backup_store.save_snapshot(host.id, content)
async def _prune(db: AsyncSession, host: OpnsenseHost, keep: int) -> int:
old = backup_store.list_snapshots(host.id)[keep:]
for snapshot in old:
backup_store.delete_snapshot(host.id, snapshot["id"])
if old:
rows = (await db.scalars(select(BackupUpload).where(BackupUpload.host_id == host.id, BackupUpload.snapshot_id.in_([s["id"] for s in old])))).all()
for row in rows:
await db.delete(row)
return len(old)
async def upload_pending(db: AsyncSession, cfg: BackupSettings, hosts: list[OpnsenseHost]) -> int:
"""Encrypt and upload local snapshots that are not offsite yet (newest first, bounded per run)."""
passphrase = notification_secret_store.read_secret(PASSPHRASE)
if not passphrase:
raise S3Error("Passphrase fehlt oder ist nicht lesbar – bitte neu setzen")
s3 = s3_for(cfg)
done, budget = 0, MAX_UPLOADS_PER_RUN
for host in hosts:
have = set((await db.scalars(select(BackupUpload.snapshot_id).where(BackupUpload.host_id == host.id))).all())
for snapshot in backup_store.list_snapshots(host.id):
if snapshot["id"] in have:
continue
if budget == 0:
return done
content = backup_store.read_snapshot(host.id, snapshot["id"])
if content is None:
continue
key = remote_key(cfg, host, snapshot["id"])
await s3.put(key, backup_crypto.encrypt(content, passphrase))
db.add(BackupUpload(host_id=host.id, snapshot_id=snapshot["id"], remote_key=key, uploaded_at=datetime.now(timezone.utc)))
await db.commit()
budget -= 1
done += 1
return done
async def run_due(db: AsyncSession, *, force: bool = False) -> dict:
cfg = await get_settings(db)
hosts = list((await db.scalars(select(OpnsenseHost).where(OpnsenseHost.enabled.is_(True)).order_by(OpnsenseHost.name))).all())
taken = failed = pruned = 0
if cfg.scheduled_enabled or force:
now = datetime.now(timezone.utc)
for host in hosts:
snapshots = backup_store.list_snapshots(host.id)
if not force and snapshots and now - snapshots[0]["created_at"] < timedelta(hours=cfg.interval_hours):
pruned += await _prune(db, host, cfg.keep_count)
continue
try:
await _take(host)
taken += 1
except OpnsenseAPIError as exc:
failed += 1
logger.warning("Geplantes Backup von %s fehlgeschlagen: %s", host.name, exc)
pruned += await _prune(db, host, cfg.keep_count)
cfg.last_run_at = now
uploaded = 0
if cfg.offsite_enabled:
try:
if not offsite_ready(cfg):
raise S3Error("Offsite-Ziel unvollständig (Endpunkt, Bucket, Zugangsdaten, Passphrase)")
uploaded = await upload_pending(db, cfg, hosts)
cfg.last_offsite_error = None
if uploaded or cfg.last_offsite_ok_at is None:
cfg.last_offsite_ok_at = datetime.now(timezone.utc)
except S3Error as exc:
cfg.last_offsite_error = str(exc)[:300]
logger.warning("Offsite-Backup: %s", exc)
await db.commit()
return {"hosts": len(hosts), "taken": taken, "failed": failed, "pruned": pruned, "uploaded": uploaded}
+10 -1
View File
@@ -42,7 +42,8 @@ def list_snapshots(host_id: uuid.UUID) -> list[dict]:
"created_at": datetime.fromtimestamp(stat.st_mtime, tz=timezone.utc),
"size": stat.st_size,
})
return sorted(items, key=lambda i: i["created_at"], reverse=True)
# Names are sortable timestamps: they break ties between files written within one mtime tick.
return sorted(items, key=lambda i: (i["created_at"], i["id"]), reverse=True)
def read_snapshot(host_id: uuid.UUID, backup_id: str) -> bytes | None:
@@ -53,3 +54,11 @@ def read_snapshot(host_id: uuid.UUID, backup_id: str) -> bytes | None:
if backup_id != path.name or not path.is_file():
return None
return path.read_bytes()
def delete_snapshot(host_id: uuid.UUID, backup_id: str) -> bool:
path = _host_dir(host_id) / backup_id
if backup_id != path.name or not path.is_file():
return False
path.unlink()
return True
+287
View File
@@ -0,0 +1,287 @@
"""Security posture of a firewall: hardening checks and rule hygiene.
The checks read the firewall's own config.xml (one read-only download, parsed
in memory with defusedxml, never stored) plus two facts OPNexus already knows:
whether firmware updates are pending and how old the newest local backup is.
The XML layout was verified against real OPNsense 26.7 configs: rules live in
``OPNsense/Firewall/Filter/rules/rule`` (MVC) or, on installs not yet migrated,
in ``filter/rule`` (legacy). Both are normalised to the same shape below.
``evaluate`` is pure (bytes in, findings out). A finding is
``{id, severity, passed, params}``; ``passed`` is None when a check could not be
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 re
from datetime import datetime, timezone
from xml.etree.ElementTree import Element
import defusedxml.ElementTree as safe_ET
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.compliance_result import ComplianceResult
from app.models.host import OpnsenseHost
from app.services import backup_store, rule_hit_service
from app.services import opnsense_client as client
from app.services.opnsense_client import OpnsenseAPIError
MAX_CONFIG_BYTES = 32 * 1024 * 1024
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
def grade(score: int) -> str:
return "good" if score >= 90 else "fair" if score >= 70 else "poor"
def _text(el: Element | None, path: str) -> str | None:
node = el.find(path) if el is not None else None
if node is None or node.text is None or not node.text.strip():
return None
return node.text.strip()
# ── Rule normalisation ───────────────────────────────────────────────────
def _endpoint(node: Element | None) -> tuple[str, bool, str | None]:
"""(network, negated, port) of a legacy <source>/<destination> element."""
if node is None:
return "any", False, None
negated = node.find("not") is not None
port = _text(node, "port")
if node.find("any") is not None:
return "any", negated, port
for tag in ("network", "address"):
value = _text(node, tag)
if value:
return value, negated, port
return "any", negated, port
def _mvc_rule(rule: Element) -> dict:
return {
"enabled": _text(rule, "enabled") != "0",
"action": (_text(rule, "action") or "pass").lower(),
"interfaces": [i for i in (_text(rule, "interface") or "").split(",") if i],
"direction": _text(rule, "direction") or "in",
"ipprotocol": _text(rule, "ipprotocol") or "inet",
"protocol": (_text(rule, "protocol") or "any").lower(),
"src": _text(rule, "source_net") or "any", "src_not": _text(rule, "source_not") == "1",
"sport": _text(rule, "source_port"),
"dst": _text(rule, "destination_net") or "any", "dst_not": _text(rule, "destination_not") == "1",
"dport": _text(rule, "destination_port"),
"floating": False,
"quick": _text(rule, "quick") != "0",
"descr": _text(rule, "description") or "",
"order": int(_text(rule, "sequence") or 0),
}
def _legacy_rule(rule: Element, index: int) -> dict:
src, src_not, sport = _endpoint(rule.find("source"))
dst, dst_not, dport = _endpoint(rule.find("destination"))
return {
"enabled": rule.find("disabled") is None,
"action": (_text(rule, "type") or "pass").lower(),
"interfaces": [i for i in (_text(rule, "interface") or "").split(",") if i],
"direction": _text(rule, "direction") or "in",
"ipprotocol": _text(rule, "ipprotocol") or "inet",
"protocol": (_text(rule, "protocol") or "any").lower(),
"src": src, "src_not": src_not, "sport": sport, "dst": dst, "dst_not": dst_not, "dport": dport,
"floating": _text(rule, "floating") == "yes",
"quick": _text(rule, "quick") != "0",
"descr": _text(rule, "descr") or "",
"order": index,
}
def extract_rules(root: Element) -> list[list[dict]]:
"""Rule lists in evaluation order, one per source (MVC, legacy)."""
mvc = sorted((_mvc_rule(r) for r in root.findall("OPNsense/Firewall/Filter/rules/rule")), key=lambda r: r["order"])
legacy = [_legacy_rule(r, i) for i, r in enumerate(root.findall("filter/rule"))]
return [group for group in (mvc, legacy) if group]
def wan_interfaces(root: Element) -> set[str]:
"""Interfaces facing the outside: the one named wan*, or any with an upstream gateway."""
result = set()
for node in root.findall("interfaces/*"):
if node.tag.lower().startswith("wan") or _text(node, "gateway"):
result.add(node.tag)
return result
def _is_any_any(rule: dict) -> bool:
return (
rule["enabled"] and rule["action"] == "pass" and rule["src"] == "any" and not rule["src_not"]
and rule["dst"] == "any" and not rule["dst_not"] and rule["protocol"] == "any"
and not rule["sport"] and not rule["dport"]
)
def _covers(a: dict, b: dict) -> bool:
"""Every packet matched by rule b is already matched by the earlier rule a.
Only exact-or-any comparisons, so it never claims coverage it cannot prove."""
if not (a["enabled"] and b["enabled"]) or a["floating"] or b["floating"] or not a["quick"]:
return False
if not a["interfaces"] or not set(b["interfaces"]) <= set(a["interfaces"]):
return False
if a["direction"] != b["direction"] or a["ipprotocol"] != b["ipprotocol"]:
return False
if a["protocol"] != "any" and a["protocol"] != b["protocol"]:
return False
for side in ("src", "dst"):
if a[side + "_not"] or b[side + "_not"]:
if (a[side], a[side + "_not"]) != (b[side], b[side + "_not"]):
return False
elif a[side] != "any" and a[side] != b[side]:
return False
for port in ("sport", "dport"):
if a[port] and a[port] != b[port]:
return False
return True
def _label(rule: dict) -> str:
return rule["descr"] or f"{rule['action']} {rule['src']} → {rule['dst']}"
def analyse_rules(groups: list[list[dict]]) -> dict:
shadowed, duplicates = [], []
for rules in groups:
for j, later in enumerate(rules):
for earlier in rules[:j]:
if _covers(earlier, later):
(duplicates if earlier["action"] == later["action"] and _covers(later, earlier) else shadowed).append(_label(later))
break
return {"shadowed": shadowed, "duplicates": duplicates}
# ── Checks ───────────────────────────────────────────────────────────────
def _finding(check_id: str, severity: str, passed: bool | None, **params) -> dict:
return {"id": check_id, "severity": severity, "passed": passed, "params": params}
def _listing(items: list[str]) -> dict:
return {"count": len(items), "examples": items[:MAX_EXAMPLES]}
def evaluate(xml_bytes: bytes, *, firmware_status: str | None, newest_backup_age_s: float | None,
unused_rules: dict | None = None) -> list[dict]:
if len(xml_bytes) > MAX_CONFIG_BYTES or not xml_bytes.strip():
raise ValueError("config.xml missing or too large")
root = safe_ET.fromstring(xml_bytes)
if root.tag != "opnsense":
raise ValueError("not an OPNsense config.xml")
findings: list[dict] = []
# Management access
protocol = _text(root, "system/webgui/protocol")
findings.append(_finding("webgui_https", "high", protocol == "https", protocol=protocol or "http"))
ssh = root.find("system/ssh")
ssh_enabled = ssh is not None and _text(ssh, "enabled") in ("enabled", "1")
root_login = ssh_enabled and _text(ssh, "permitrootlogin") == "1"
password_login = ssh_enabled and _text(ssh, "passwordauth") == "1"
if root_login and password_login:
findings.append(_finding("ssh_hardened", "high", False, reason="root_password"))
elif password_login:
findings.append(_finding("ssh_hardened", "medium", False, reason="password"))
else:
findings.append(_finding("ssh_hardened", "high", True))
community = _text(root, "snmpd/rocommunity")
if root.find("snmpd") is not None:
findings.append(_finding("snmp_community", "high", (community or "").lower() not in ("", "public")))
# Rules
wans = wan_interfaces(root)
groups = extract_rules(root)
all_rules = [rule for group in groups for rule in group]
wan_open = [_label(r) for r in all_rules if _is_any_any(r) and set(r["interfaces"]) & wans]
findings.append(_finding("wan_any_any", "critical", not wan_open, **_listing(wan_open)))
inner_open = [_label(r) for r in all_rules if _is_any_any(r) and r["interfaces"] and not set(r["interfaces"]) & wans]
findings.append(_finding("internal_any_any", "medium", not inner_open, **_listing(inner_open)))
analysis = analyse_rules(groups)
findings.append(_finding("rules_shadowed", "medium", not analysis["shadowed"], **_listing(analysis["shadowed"])))
findings.append(_finding("rules_duplicate", "low", not analysis["duplicates"], **_listing(analysis["duplicates"])))
undocumented = [f"{r['action']} {r['src']} → {r['dst']}" for r in all_rules if r["enabled"] and not r["descr"]]
findings.append(_finding("rules_documented", "low", not undocumented, **_listing(undocumented)))
# Usage (from the pf counters OPNexus has been sampling; None = no data yet)
if unused_rules is not None:
names = unused_rules["unused"]
findings.append(_finding("rules_unused", "low", None if (not names and unused_rules["collecting"]) else not names, **_listing(names)))
# Operations
findings.append(_finding("ntp_configured", "low", bool(_text(root, "system/timeservers"))))
syslog_targets = [d for d in root.findall("OPNsense/Syslog/destinations/destination") if _text(d, "enabled") != "0"]
findings.append(_finding("remote_logging", "low", bool(syslog_targets) or bool(_text(root, "syslog/remoteserver"))))
findings.append(_finding("ids_enabled", "info", _text(root, "OPNsense/IDS/general/enabled") == "1"))
# From what OPNexus already knows
findings.append(_finding("firmware_current", "medium", None if firmware_status is None else firmware_status != "update"))
if newest_backup_age_s is None:
findings.append(_finding("backup_recent", "medium", False, age_days=None))
else:
age_days = int(newest_backup_age_s // 86400)
findings.append(_finding("backup_recent", "medium", age_days < BACKUP_MAX_AGE_DAYS, age_days=age_days))
return findings
def score(findings: list[dict]) -> int:
return max(0, 100 - sum(PENALTY[f["severity"]] for f in findings if f["passed"] is False))
def counts(findings: list[dict]) -> dict:
result = {severity: 0 for severity in SEVERITY_ORDER}
for finding in findings:
if finding["passed"] is False:
result[finding["severity"]] += 1
return result
# ── Running it for a host ────────────────────────────────────────────────
async def check_host(db: AsyncSession, host: OpnsenseHost) -> ComplianceResult:
"""Download the config, evaluate, store (one row per host, replaced each time)."""
row = await db.scalar(select(ComplianceResult).where(ComplianceResult.host_id == host.id))
if row is None:
row = ComplianceResult(host_id=host.id)
db.add(row)
row.checked_at = datetime.now(timezone.utc)
try:
xml = await client.download_backup(host)
try:
firmware_status = (await client.get_firmware_status(host)).get("status")
except OpnsenseAPIError:
firmware_status = None
snapshots = backup_store.list_snapshots(host.id)
age = (datetime.now(timezone.utc) - snapshots[0]["created_at"]).total_seconds() if snapshots else None
try:
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))
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:
row.findings, row.score, row.error = [], None, "invalid_config"
row.error_detail = str(exc)[:300]
await db.commit()
return row
async def check_all(db: AsyncSession) -> int:
hosts = (await db.scalars(select(OpnsenseHost).where(OpnsenseHost.enabled.is_(True)).order_by(OpnsenseHost.name))).all()
for host in hosts:
await check_host(db, host)
return len(hosts)
@@ -59,7 +59,9 @@ async def _shared_change_blockers(db, fleet):
return blocked
async def inspect_host(db, host):
async def inspect_host(db, host, *, skip_role_checks=False):
"""skip_role_checks: for the planned CARP handover, where the node is still MASTER when
it is inspected and becomes BACKUP only afterwards (the role is verified separately)."""
fleet = await peers(db, host)
statuses, info, firmware, running = await asyncio.gather(
get_statuses(fleet), client.get_firmware_info(host), client.get_firmware_status(host), client.get_firmware_running(host))
@@ -68,7 +70,7 @@ async def inspect_host(db, host):
if statuses.get(host.id, {}).get("status") != "online": blocked.append("Host ist nicht erreichbar.")
# Fail closed: only the verified ready value permits a disruptive action.
if running.get("status") != "ready": blocked.append("Firmware-Auftrag läuft oder Status ist unbekannt.")
if host.cluster_name:
if host.cluster_name and not skip_role_checks:
others = [h for h in fleet if h.id != host.id]
if statuses.get(host.id, {}).get("carp_status") != "BACKUP":
blocked.append("Cluster-Wartung nur auf dem CARP-BACKUP. Rollenwechsel separat in OPNsense durchführen.")
+155
View File
@@ -0,0 +1,155 @@
"""Prometheus exposition of the fleet state (GET /api/metrics).
Deliberately database-only, like the dashboard summary: a scrape must never
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
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,
* pending actions — the same list the dashboard shows.
"""
from datetime import datetime, timedelta, timezone
from sqlalchemy import func, select
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.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.version import APP_VERSION
CONTENT_TYPE = "text/plain; version=0.0.4; charset=utf-8"
# The sampler runs every 60 s; three missed rounds mean the host is not reachable.
STALE_AFTER = timedelta(seconds=180)
def _escape(value: str) -> str:
return value.replace("\\", "\\\\").replace('"', '\\"').replace("\n", "\\n")
class _Exposition:
def __init__(self) -> None:
self.lines: list[str] = []
def family(self, name: str, help_text: str, kind: str = "gauge") -> None:
self.lines.append(f"# HELP {name} {help_text}")
self.lines.append(f"# TYPE {name} {kind}")
def sample(self, name: str, value: float, **labels: str) -> None:
rendered = ",".join(f'{key}="{_escape(str(val))}"' for key, val in labels.items() if val is not None)
number = repr(float(value)) if not float(value).is_integer() else str(int(value))
self.lines.append(f"{name}{{{rendered}}} {number}" if rendered else f"{name} {number}")
def text(self) -> str:
return "\n".join(self.lines) + "\n"
async def render(db: AsyncSession) -> str:
now = datetime.now(timezone.utc)
out = _Exposition()
out.family("opnexus_info", "OPNexus version (always 1).")
out.sample("opnexus_info", 1, version=APP_VERSION)
hosts = (await db.scalars(select(OpnsenseHost).order_by(OpnsenseHost.name))).all()
latest_sample = (
select(HostResourceSample.host_id, func.max(HostResourceSample.sampled_at).label("at"))
.group_by(HostResourceSample.host_id)
.subquery()
)
samples = {
sample.host_id: sample
for sample in (
await db.scalars(
select(HostResourceSample).join(
latest_sample,
(HostResourceSample.host_id == latest_sample.c.host_id)
& (HostResourceSample.sampled_at == latest_sample.c.at),
)
)
).all()
}
latest_event = (
select(CarpEvent.host_id, func.max(CarpEvent.detected_at).label("at")).group_by(CarpEvent.host_id).subquery()
)
carp_state = {
event.host_id: event.to_status
for event in (
await db.scalars(
select(CarpEvent).join(
latest_event, (CarpEvent.host_id == latest_event.c.host_id) & (CarpEvent.detected_at == latest_event.c.at)
)
)
).all()
}
out.family("opnexus_hosts", "Number of managed firewalls.")
out.sample("opnexus_hosts", len(hosts))
out.family("opnexus_host_enabled", "1 if monitoring of the host is enabled.")
out.family("opnexus_host_up", "1 if the host answered the resource sampler within the last 3 minutes.")
out.family("opnexus_host_last_sample_timestamp_seconds", "Unix time of the last successful resource sample.")
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_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 ""}
sample = samples.get(host.id)
up = bool(host.enabled and sample is not None and now - sample.sampled_at <= STALE_AFTER)
out.sample("opnexus_host_enabled", 1 if host.enabled else 0, **labels)
out.sample("opnexus_host_up", 1 if up else 0, **labels)
if sample is not None:
out.sample("opnexus_host_last_sample_timestamp_seconds", sample.sampled_at.timestamp(), **labels)
for name, value in (
("opnexus_host_memory_used_percent", sample.mem_used_pct),
("opnexus_host_load1", sample.load_avg_1m),
("opnexus_host_disk_used_percent", sample.disk_used_pct),
):
if value is not None:
out.sample(name, value, **labels)
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)
out.family("opnexus_host_compliance_score", "Security posture score 0-100 of the last check (absent if never checked).")
out.family("opnexus_host_compliance_findings", "Failed security checks of the last check, by severity.")
results = {r.host_id: r for r in (await db.scalars(select(ComplianceResult))).all()}
for host in hosts:
row = results.get(host.id)
if row is None or row.score is None:
continue
labels = {"host": host.name, "cluster": host.cluster_name or ""}
out.sample("opnexus_host_compliance_score", row.score, **labels)
for severity, count in compliance_service.counts(row.findings).items():
out.sample("opnexus_host_compliance_findings", count, severity=severity, **labels)
out.family("opnexus_pending_actions", "Deployments and operations that need attention, by kind and status.")
counts: dict[tuple[str, str], int] = {}
for action in await collect_pending_actions(db):
counts[(action.kind, action.status)] = counts.get((action.kind, action.status), 0) + 1
for (kind, status), count in sorted(counts.items()):
out.sample("opnexus_pending_actions", count, kind=kind, status=status)
out.family("opnexus_problems_open", "Open problems known to the notification engine, by type.")
rows = (
await db.execute(
select(NotificationProblem.problem_type, func.count())
.where(NotificationProblem.status == "open")
.group_by(NotificationProblem.problem_type)
)
).all()
for problem_type, count in sorted(rows):
out.sample("opnexus_problems_open", count, type=problem_type)
out.family("opnexus_scheduled_maintenance_pending", "Scheduled maintenance jobs that have not run yet.")
pending = await db.scalar(select(func.count()).select_from(ScheduledMaintenance).where(ScheduledMaintenance.status == "pending"))
out.sample("opnexus_scheduled_maintenance_pending", pending or 0)
return out.text()
+58 -1
View File
@@ -3,18 +3,21 @@ whatever's currently bad. Pure detection — no delivery, no state tracking
here (see notification_dedup.py for the open/resolved diffing that turns
these snapshots into actual notifications)."""
from collections import defaultdict
from datetime import datetime, timedelta, timezone
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.alias_deployment import AliasDeployment
from app.models.backup_settings import BackupSettings
from app.models.host import OpnsenseHost
from app.models.host_operation import HostOperation
from app.models.one_to_one_deployment import OneToOneDeployment
from app.models.outbound_nat_deployment import OutboundNatDeployment
from app.models.port_forward_deployment import PortForwardDeployment
from app.models.rule_deployment import RuleDeployment
from app.services import nat_drift_service, network_drift_service, rule_drift_service
from app.models.scheduled_maintenance import ScheduledMaintenance
from app.services import backup_store, nat_drift_service, network_drift_service, rule_drift_service
from app.services.notification_dedup import Problems
from app.services.host_status_service import get_statuses
from app.services.live_certificates_service import get_live_certificates
@@ -262,3 +265,57 @@ async def check_carp_auto_revert_failed(db: AsyncSession) -> dict[str, dict]:
"message": window.message,
}
return problems
# A failed scheduled run never turns "fixed" by itself, so it is reported as an event:
# open for this long after its planned time, then closed without a "resolved" message
# (see notification_service._NO_RESOLVED_NOTICE).
SCHEDULED_FAILURE_WINDOW = timedelta(days=3)
async def check_scheduled_maintenance_failed(db: AsyncSession) -> dict[str, dict]:
since = datetime.now(timezone.utc) - SCHEDULED_FAILURE_WINDOW
result = await db.execute(
select(ScheduledMaintenance).where(
ScheduledMaintenance.status == "failed", ScheduledMaintenance.run_at >= since
)
)
problems: dict[str, dict] = {}
for sched in result.scalars().all():
problems[str(sched.id)] = {
"schedule_id": str(sched.id),
"host_id": str(sched.host_id),
"host_name": sched.host_name,
"action": sched.action,
"run_at": sched.run_at.isoformat(),
"message": (sched.result or {}).get("error"),
}
return problems
async def check_backup_stale(db: AsyncSession) -> dict[str, dict]:
"""Scheduled backups are on but a host has no recent one: three missed intervals
(at least 6 hours) cover a reboot or a short outage without crying wolf."""
cfg = await db.get(BackupSettings, 1)
if cfg is not None and not cfg.scheduled_enabled:
return {}
interval = cfg.interval_hours if cfg is not None else 24
limit = timedelta(hours=max(3 * interval, 6))
now = datetime.now(timezone.utc)
problems: dict[str, dict] = {}
for host in await _enabled_hosts(db):
snapshots = backup_store.list_snapshots(host.id)
newest = snapshots[0]["created_at"] if snapshots else None
if (newest is None and now - host.created_at > limit) or (newest is not None and now - newest > limit):
problems[str(host.id)] = {
"host_id": str(host.id), "host_name": host.name,
"last_backup": newest.isoformat() if newest else "noch nie",
}
return problems
async def check_backup_offsite(db: AsyncSession) -> dict[str, dict]:
cfg = await db.get(BackupSettings, 1)
if cfg is None or not cfg.offsite_enabled or not cfg.last_offsite_error:
return {}
return {"offsite": {"message": cfg.last_offsite_error}}
@@ -33,6 +33,9 @@ _LABELS = {
"nat_drift": "NAT-Drift im Cluster",
"network_drift": "Netzwerk-Abweichung im Cluster",
"carp_auto_revert_failed": "CARP-Auto-Revert fehlgeschlagen",
"scheduled_maintenance_failed": "Geplante Wartung nicht ausgeführt",
"backup_stale": "Kein aktuelles Backup",
"backup_offsite_failed": "Offsite-Backup fehlgeschlagen",
}
@@ -30,13 +30,23 @@ _CHECKS = [
("nat_drift", "nat_drift_enabled", notification_checks.check_nat_drift),
("network_drift", "network_drift_enabled", notification_checks.check_network_drift),
("carp_auto_revert_failed", "carp_auto_revert_failed_enabled", notification_checks.check_carp_auto_revert_failed),
("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),
]
# 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"}
async def _deliver(settings_row: NotificationSettings, problem: NotificationProblem, transition: str) -> 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."""
if transition == "resolved" and problem.problem_type in _NO_RESOLVED_NOTICE:
problem.resolved_notified_at = _now()
return
if settings_row.webhook_enabled:
try:
await notification_delivery.send_webhook(settings_row, problem, transition)
@@ -25,7 +25,7 @@ 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",
"network_drift_enabled", "carp_auto_revert_failed_enabled", "scheduled_maintenance_failed_enabled", "backup_failed_enabled",
"poll_interval_seconds",
]
for field in simple_fields:
+270
View File
@@ -0,0 +1,270 @@
"""OpenID Connect login (authorization code flow with PKCE) and role mapping.
What is checked on the ID token, in this order of suspicion: the signature (against the provider's JWKS,
asymmetric algorithms only: ``none`` and HMAC are never accepted), ``iss`` equal to the configured issuer,
``aud`` containing our client id (and ``azp`` equal to it if there are several audiences), ``exp``/``nbf``,
and the ``nonce`` we sent. The role comes from the groups claim (ID token, else userinfo) at EVERY login, so
removing someone from the group takes the access away at their next sign-in. Local accounts are never linked
to or taken over by an identity: an OIDC user is keyed by ``<issuer>|<sub>`` and a name clash with a local
account gets a suffix. Without a mapped group nobody is let in.
"""
import base64
import hashlib
import logging
import re
import secrets
import time
from datetime import datetime, timedelta, timezone
from urllib.parse import urlencode
import httpx
import jwt
from jwt import PyJWK
from sqlalchemy import delete, select
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.oidc import OidcLoginState, OidcSettings
from app.models.user import AdminUser
from app.services import notification_secret_store
logger = logging.getLogger(__name__)
SINGLETON_ID = 1
SECRET_NAME = "oidc_client_secret"
STATE_TTL = timedelta(minutes=10)
ALGORITHMS = ["RS256", "RS384", "RS512", "PS256", "PS384", "PS512", "ES256", "ES384", "ES512"]
UNUSABLE_PASSWORD = "!oidc"
_ROLE_ORDER = ("admin", "operator", "read_only")
class OidcError(Exception):
"""Carries a short, user-safe code (shown on the login page), never provider internals."""
def __init__(self, code: str, detail: str = ""):
super().__init__(detail or code)
self.code = code
async def get_settings(db: AsyncSession) -> OidcSettings:
row = await db.get(OidcSettings, SINGLETON_ID)
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",
)
db.add(row)
await db.flush()
return row
def configured(cfg: OidcSettings) -> bool:
return bool(cfg.enabled and cfg.issuer and cfg.client_id and (cfg.admin_group or cfg.operator_group or cfg.read_only_group))
# ── provider metadata (cached) ───────────────────────────────────────────
_discovery_cache: dict[str, tuple[float, dict]] = {}
_jwks_cache: dict[str, tuple[float, dict]] = {}
_DISCOVERY_TTL, _JWKS_TTL, _JWKS_MIN_REFETCH = 600, 3600, 60
def clear_caches() -> None:
_discovery_cache.clear()
_jwks_cache.clear()
async def _get_json(url: str, **kw) -> dict:
if not url.startswith("https://"):
raise OidcError("provider", "Nur https:// wird akzeptiert")
try:
async with httpx.AsyncClient(timeout=10, follow_redirects=False) as client:
response = await client.get(url, **kw)
response.raise_for_status()
data = response.json()
except (httpx.HTTPError, ValueError):
raise OidcError("provider", "Der Identitätsanbieter ist nicht erreichbar oder antwortet unverständlich") from None
if not isinstance(data, dict):
raise OidcError("provider", "Unerwartete Antwort des Identitätsanbieters")
return data
async def discovery(issuer: str) -> dict:
cached = _discovery_cache.get(issuer)
if cached and time.monotonic() - cached[0] < _DISCOVERY_TTL:
return cached[1]
doc = await _get_json(issuer.rstrip("/") + "/.well-known/openid-configuration")
if doc.get("issuer") != issuer and doc.get("issuer", "").rstrip("/") != issuer.rstrip("/"):
raise OidcError("provider", "Der Aussteller in der Discovery-Antwort passt nicht zur eingetragenen URL")
for key in ("authorization_endpoint", "token_endpoint", "jwks_uri"):
if not str(doc.get(key, "")).startswith("https://"):
raise OidcError("provider", f"Discovery enthält kein gültiges {key}")
_discovery_cache[issuer] = (time.monotonic(), doc)
return doc
async def _jwk_for(doc: dict, kid: str | None) -> PyJWK:
uri = doc["jwks_uri"]
for attempt in (0, 1):
cached = _jwks_cache.get(uri)
stale = cached is None or time.monotonic() - cached[0] > _JWKS_TTL
if stale or attempt == 1:
if attempt == 1 and cached and time.monotonic() - cached[0] < _JWKS_MIN_REFETCH:
break # unknown kid, but we just fetched: do not let a forged kid hammer the provider
_jwks_cache[uri] = (time.monotonic(), await _get_json(uri))
for key in _jwks_cache[uri][1].get("keys", []):
if (kid is None or key.get("kid") == kid) and key.get("use", "sig") == "sig":
try:
return PyJWK(key)
except Exception: # unsupported key type: try the next one
continue
raise OidcError("token", "Kein passender Signaturschlüssel")
# ── the flow ─────────────────────────────────────────────────────────────
def _hash(value: str) -> str:
return hashlib.sha256(value.encode()).hexdigest()
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:
"""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)
await db.execute(delete(OidcLoginState).where(OidcLoginState.created_at < datetime.now(timezone.utc) - STATE_TTL))
db.add(OidcLoginState(state_hash=_hash(state), nonce=nonce, code_verifier=verifier, redirect_uri=redirect_uri))
await db.commit()
query = urlencode({
"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}"
async def _consume_state(db: AsyncSession, state: str) -> OidcLoginState:
row = await db.scalar(select(OidcLoginState).where(OidcLoginState.state_hash == _hash(state)).with_for_update())
if row is None:
raise OidcError("state", "Unbekannter oder bereits benutzter Anmeldeversuch")
created = row.created_at
await db.delete(row) # single use, whatever happens next
await db.commit()
if datetime.now(timezone.utc) - created > STATE_TTL:
raise OidcError("state", "Der Anmeldeversuch ist abgelaufen")
return row
async def _exchange(cfg: OidcSettings, doc: dict, code: str, state: OidcLoginState) -> dict:
data = {"grant_type": "authorization_code", "code": code, "redirect_uri": state.redirect_uri,
"client_id": cfg.client_id, "code_verifier": state.code_verifier}
secret = notification_secret_store.read_secret(SECRET_NAME) if cfg.client_secret_set else None
auth = None
if secret:
methods = doc.get("token_endpoint_auth_methods_supported") or ["client_secret_basic"]
if "client_secret_basic" in methods:
auth = httpx.BasicAuth(cfg.client_id, secret)
else:
data["client_secret"] = secret
try:
async with httpx.AsyncClient(timeout=15, follow_redirects=False) as client:
response = await client.post(doc["token_endpoint"], data=data, auth=auth)
if response.status_code >= 400:
raise OidcError("token", f"Token-Endpunkt antwortet mit HTTP {response.status_code}")
tokens = response.json()
except httpx.HTTPError:
raise OidcError("provider", "Token-Endpunkt nicht erreichbar") from None
except ValueError:
raise OidcError("token", "Unverständliche Token-Antwort") from None
if not isinstance(tokens, dict) or not tokens.get("id_token"):
raise OidcError("token", "Die Antwort enthält kein ID-Token")
return tokens
async def _verify_id_token(cfg: OidcSettings, doc: dict, id_token: str, nonce: str) -> dict:
try:
header = jwt.get_unverified_header(id_token)
except jwt.PyJWTError:
raise OidcError("token", "ID-Token unlesbar") from None
if header.get("alg") not in ALGORITHMS:
raise OidcError("token", f"Nicht erlaubter Signaturalgorithmus {header.get('alg')!r}")
key = await _jwk_for(doc, header.get("kid"))
try:
claims = jwt.decode(
id_token, key.key, algorithms=ALGORITHMS, audience=cfg.client_id, issuer=cfg.issuer,
options={"require": ["exp", "iss", "aud", "sub"]}, leeway=60,
)
except jwt.PyJWTError as exc:
raise OidcError("token", f"ID-Token ungültig ({type(exc).__name__})") from None
audience = claims.get("aud")
if isinstance(audience, list) and len(audience) > 1 and claims.get("azp") != cfg.client_id:
raise OidcError("token", "azp passt nicht zur Client-ID")
if not secrets.compare_digest(str(claims.get("nonce", "")), nonce):
raise OidcError("token", "Nonce stimmt nicht")
return claims
def _as_groups(value) -> list[str]:
if isinstance(value, str):
return [g for g in re.split(r"[,\s]+", value) if g]
if isinstance(value, list):
return [str(g) for g in value]
return []
def role_for(cfg: OidcSettings, groups: list[str]) -> str | None:
"""The most privileged role whose group the user is in; None = not allowed in."""
wanted = {"admin": cfg.admin_group, "operator": cfg.operator_group, "read_only": cfg.read_only_group}
have = {g.lower() for g in groups}
for role in _ROLE_ORDER:
group = wanted[role]
if group and group.strip().lower() in have:
return role
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])
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 []
def _username(claims: dict) -> str:
raw = claims.get("preferred_username") or claims.get("email") or claims["sub"]
return re.sub(r"[\x00-\x1f]", "", str(raw)).strip()[:140] or "sso-user"
async def provision(db: AsyncSession, cfg: OidcSettings, claims: dict, role: str) -> AdminUser:
"""The account for this identity: created on first login, role synced on every login."""
subject = f"{cfg.issuer}|{claims['sub']}"[:600]
user = await db.scalar(select(AdminUser).where(AdminUser.oidc_subject == subject))
if user is None:
base, name, n = _username(claims), None, 0
while True:
name = base if n == 0 else f"{base}~sso{n if n > 1 else ''}"
if await db.scalar(select(AdminUser.id).where(AdminUser.username == name)) is None:
break
n += 1
user = AdminUser(username=name, password_hash=UNUSABLE_PASSWORD, role=role, auth_source="oidc", oidc_subject=subject)
db.add(user)
else:
user.role = role
await db.commit()
return user
async def complete(db: AsyncSession, cfg: OidcSettings, code: str, state_value: str) -> AdminUser:
"""Callback: state -> tokens -> verified identity -> role -> account. Raises OidcError."""
state = await _consume_state(db, state_value)
doc = await discovery(cfg.issuer)
tokens = await _exchange(cfg, doc, code, state)
claims = await _verify_id_token(cfg, doc, tokens["id_token"], state.nonce)
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)
+12 -1
View File
@@ -16,7 +16,7 @@ import httpx
from app.config import settings
from app.models.host import OpnsenseHost
from app.services import firewall_url, opnsense_secret_store, tls_pin_service
from app.services import firewall_url, opnsense_secret_store, overlay_service, tls_pin_service
from app.services.redaction import redact_data, redact_text
logger = logging.getLogger(__name__)
@@ -46,6 +46,8 @@ def _client(host: OpnsenseHost) -> httpx.AsyncClient:
auth=(host.api_key, secret),
verify=tls_pin_service.verify_argument(host.verify_tls, host.tls_ca_pem),
timeout=settings.opnsense_timeout,
# Firewalls reached through the management overlay (WireGuard hub) go via the hub's CONNECT proxy.
proxy=overlay_service.proxy_for(host.base_url),
)
@@ -369,6 +371,15 @@ async def get_source_nat_settings(host: OpnsenseHost) -> dict:
# Core controllers, checked against OPNsense core source:
# https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/controllers/OPNsense/Core/Api/FirmwareController.php
# https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/controllers/OPNsense/Core/Api/SystemController.php
async def get_pf_rule_statistics(host: OpnsenseHost) -> dict:
"""`diagnostics/firewall/pfStatistics/rules` (Diagnostics Api FirewallController):
{"rules": {"filter rules": {"@N <pf rule text> label \"<uuid>\"": {evaluations, packets,
bytes, states, ...}}}}. Verified live on OPNsense 26.7: the pf label of a rule created in
the rule editor/API is its UUID, so counters can be tied to rules; automatic rules carry
an md5 label instead."""
return await _request(host, "GET", "/diagnostics/firewall/pfStatistics/rules")
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")
+207
View File
@@ -0,0 +1,207 @@
"""Management overlay: keys, addressing, the hub's config file and the live status.
How it fits together
--------------------
* The ``wg-hub`` container (app/overlay_hub.py, same image as the backend, NET_ADMIN, UDP port published)
owns the WireGuard interface. It reads ``<overlay_dir>/hub.json`` — written here whenever settings or peers
change — and writes ``<overlay_dir>/status.json`` (handshakes, traffic) every few seconds.
* The backend itself needs no extra privileges: requests to a firewall whose address lies in the overlay subnet
go through the hub's small CONNECT proxy (``proxy_for``), which only lets traffic into that subnet.
* The firewall dials out to the hub. Its private key never leaves it; OPNexus only learns its public key. A
per-peer pre-shared key is generated here and shown to an admin for entering on the firewall.
"""
import base64
import ipaddress
import json
import os
import re
import secrets
from datetime import datetime, timezone
from pathlib import Path
from urllib.parse import urlsplit
from cryptography.hazmat.primitives import serialization
from cryptography.hazmat.primitives.asymmetric.x25519 import X25519PrivateKey
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from app.config import settings
from app.models.overlay import OverlayPeer, OverlaySettings
from app.services import secure_files
SINGLETON_ID = 1
KEEPALIVE = 25
CONNECTED_WITHIN = 180 # seconds since the last handshake
_B64_KEY = re.compile(r"^[A-Za-z0-9+/]{43}=$")
_active_network: ipaddress.IPv4Network | None = None
class OverlayError(Exception):
"""A user-facing problem; ``code`` is stable, ``detail`` is for the log."""
def __init__(self, code: str, detail: str = ""):
super().__init__(detail or code)
self.code = code
def _dir() -> Path:
return Path(settings.overlay_dir)
# ── keys ─────────────────────────────────────────────────────────────────
def valid_public_key(value: str) -> bool:
if not _B64_KEY.match(value or ""):
return False
try:
return len(base64.b64decode(value, validate=True)) == 32
except ValueError:
return False
def _raw_b64(data: bytes) -> str:
return base64.b64encode(data).decode()
def generate_private_key() -> str:
key = X25519PrivateKey.generate()
return _raw_b64(key.private_bytes(serialization.Encoding.Raw, serialization.PrivateFormat.Raw, serialization.NoEncryption()))
def public_from_private(private_b64: str) -> str:
key = X25519PrivateKey.from_private_bytes(base64.b64decode(private_b64))
return _raw_b64(key.public_key().public_bytes(serialization.Encoding.Raw, serialization.PublicFormat.Raw))
def hub_private_key() -> str:
"""The hub's private key, created on first use."""
path = _dir() / "hub.key"
if not path.exists():
secure_files.write_private(path, generate_private_key())
return path.read_text().strip()
def hub_public_key() -> str:
return public_from_private(hub_private_key())
def peer_psk(peer_id) -> str:
path = _dir() / f"psk-{peer_id}"
if not path.exists():
secure_files.write_private(path, _raw_b64(secrets.token_bytes(32)))
return path.read_text().strip()
def delete_peer_secret(peer_id) -> None:
(_dir() / f"psk-{peer_id}").unlink(missing_ok=True)
# ── addressing ───────────────────────────────────────────────────────────
def parse_subnet(value: str) -> ipaddress.IPv4Network:
try:
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):
raise OverlayError("subnet", "ein privates IPv4-Netz zwischen /16 und /29 ist nötig")
return net
def hub_address(net: ipaddress.IPv4Network) -> ipaddress.IPv4Address:
return net.network_address + 1
def next_free_ip(net: ipaddress.IPv4Network, taken: set[str]) -> str:
hub = hub_address(net)
for candidate in net.hosts():
if candidate != hub and str(candidate) not in taken:
return str(candidate)
raise OverlayError("full", "Im Overlay-Netz ist keine Adresse mehr frei")
def proxy_for(base_url: str) -> str | None:
"""The hub's proxy if this firewall address is inside the overlay subnet, else None (direct)."""
if _active_network is None:
return None
try:
host = urlsplit(base_url).hostname
return settings.overlay_proxy_url if host and ipaddress.ip_address(host) in _active_network else None
except ValueError:
return None
# ── settings, hub config ─────────────────────────────────────────────────
async def get_settings(db: AsyncSession) -> OverlaySettings:
row = await db.get(OverlaySettings, SINGLETON_ID)
if row is None:
row = OverlaySettings(id=SINGLETON_ID, enabled=False, subnet="10.99.0.0/24", listen_port=51820)
db.add(row)
await db.flush()
return row
def endpoint_with_port(cfg: OverlaySettings) -> str | None:
if not cfg.endpoint:
return None
return cfg.endpoint if re.search(r":\d+$", cfg.endpoint) else f"{cfg.endpoint}:{cfg.listen_port}"
async def sync(db: AsyncSession) -> None:
"""Make hub.json match the database (call after every change and at startup) and refresh the proxy rule."""
global _active_network
cfg = await get_settings(db)
net = parse_subnet(cfg.subnet)
_active_network = net if cfg.enabled else None
peers = (await db.scalars(select(OverlayPeer).order_by(OverlayPeer.ip))).all()
config = {
"enabled": bool(cfg.enabled), "address": f"{hub_address(net)}/{net.prefixlen}", "subnet": str(net),
"listen_port": cfg.listen_port,
"private_key": hub_private_key() if cfg.enabled else None,
"peers": [{"public_key": p.public_key, "psk": peer_psk(p.id), "ip": p.ip} for p in peers if p.public_key] if cfg.enabled else [],
}
_dir().mkdir(parents=True, exist_ok=True, mode=0o700)
tmp = _dir() / "hub.json.tmp"
secure_files.write_private(tmp, json.dumps(config))
os.replace(tmp, _dir() / "hub.json")
# ── live status (written by the hub) ─────────────────────────────────────
def read_status() -> dict | None:
try:
data = json.loads((_dir() / "status.json").read_text())
except (OSError, ValueError):
return None
return data if isinstance(data, dict) else None
def hub_state(status: dict | None, now: float | None = None) -> str:
"""'running' | 'stale' (the hub stopped reporting) | 'absent' (never reported: container not running)"""
if not status:
return "absent"
now = now or datetime.now(timezone.utc).timestamp()
return "running" if now - float(status.get("updated_at", 0)) < 30 else "stale"
def peer_status(status: dict | None, public_key: str | None, now: float | None = None) -> dict:
now = now or datetime.now(timezone.utc).timestamp()
entry = next((p for p in (status or {}).get("peers", []) if p.get("public_key") == public_key), None) if public_key else None
handshake = int(entry.get("handshake_at", 0)) if entry else 0
return {
"connected": bool(handshake and now - handshake < CONNECTED_WITHIN and hub_state(status, now) == "running"),
"last_handshake_at": datetime.fromtimestamp(handshake, timezone.utc) if handshake else None,
"rx_bytes": int(entry.get("rx", 0)) if entry else 0, "tx_bytes": int(entry.get("tx", 0)) if entry else 0,
"remote_endpoint": entry.get("endpoint") if entry else None,
}
def instructions(cfg: OverlaySettings, peer: OverlayPeer) -> dict:
net = parse_subnet(cfg.subnet)
return {
"hub_public_key": hub_public_key(), "endpoint": endpoint_with_port(cfg),
"tunnel_address": f"{peer.ip}/32", "allowed_ips": f"{hub_address(net)}/32", "psk": peer_psk(peer.id),
"keepalive": KEEPALIVE, "hub_ip": str(hub_address(net)), "host_url": f"https://{peer.ip}",
}
+20
View File
@@ -0,0 +1,20 @@
"""HTTP CONNECT through the overlay hub's proxy, for the few places that open a raw TLS connection."""
import asyncio
from urllib.parse import urlsplit
async def open_tunnel(proxy_url: str, host: str, port: int, timeout: float = 8.0):
"""(reader, writer) connected to host:port through the proxy; TLS can be started on top with ``writer.start_tls``."""
proxy = urlsplit(proxy_url)
reader, writer = await asyncio.wait_for(asyncio.open_connection(proxy.hostname, proxy.port or 8888), timeout)
try:
writer.write(f"CONNECT {host}:{port} HTTP/1.1\r\nHost: {host}:{port}\r\n\r\n".encode())
await writer.drain()
head = await asyncio.wait_for(reader.readuntil(b"\r\n\r\n"), timeout)
status = int(head.split(b" ", 2)[1])
if status != 200:
raise OSError(f"Der Overlay-Proxy lehnt die Verbindung ab (HTTP {status})")
except Exception:
writer.close()
raise
return reader, writer
+116
View File
@@ -0,0 +1,116 @@
"""Rule usage from pf's counters: which rules never match anything?
``sample_host`` reads the per-rule packet counters (``diagnostics/firewall/pfStatistics/rules``) and the
configured rules (``searchRule``) and updates one row per rule: the time of the last observed hit.
* A counter that grew since the last sample is a hit "now" (at most one sampling interval late).
* A counter that is *lower* than before means pf reloaded its ruleset (an apply or a reboot), which
zeroes everything. Whatever it shows above zero was hit since the reload, so that also counts as a hit now;
zero tells nothing, the old ``last_hit_at`` stays.
* A rule is called unused only after OPNexus has watched it for ``UNUSED_AFTER_DAYS`` without a hit.
A new rule, or a brand-new installation, is "still collecting data" instead of a false alarm.
Only rules with a UUID label are tied to a configured rule (rules created in the rule editor or API; OPNsense's
built-in automatic rules carry hash labels and are not user rules).
"""
import logging
import re
from datetime import datetime, timedelta, timezone
from sqlalchemy import delete, select
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.host import OpnsenseHost
from app.models.rule_hit import RuleHit
from app.services import opnsense_client as client
from app.services.opnsense_client import OpnsenseAPIError
logger = logging.getLogger(__name__)
UNUSED_AFTER_DAYS = 30
_LABEL = re.compile(r'label "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})"')
def parse_counters(stats: dict) -> dict[str, dict]:
"""{rule uuid: {packets, bytes, evaluations}} summed over every pf line a rule expands to."""
lines = ((stats or {}).get("rules") or {}).get("filter rules") or {}
result: dict[str, dict] = {}
for text, values in lines.items():
match = _LABEL.search(text)
if not match or not isinstance(values, dict):
continue
entry = result.setdefault(match.group(1).lower(), {"packets": 0, "bytes": 0, "evaluations": 0})
for key in entry:
entry[key] += int(values.get(key) or 0)
return result
def configured_rules(search: dict) -> dict[str, dict]:
rows = (search or {}).get("rows") or []
return {
str(r["uuid"]).lower(): {"description": r.get("description") or "", "enabled": r.get("enabled") in ("1", 1, True)}
for r in rows if r.get("uuid") and not r.get("is_automatic")
}
async def sample_host(db: AsyncSession, host: OpnsenseHost, now: datetime | None = None) -> int:
now = now or datetime.now(timezone.utc)
counters = parse_counters(await client.get_pf_rule_statistics(host))
rules = configured_rules(await client.search_rules(host, all_rows=True))
rows = {r.rule_uuid: r for r in (await db.scalars(select(RuleHit).where(RuleHit.host_id == host.id))).all()}
for uuid_, meta in rules.items():
counter = counters.get(uuid_, {"packets": 0, "bytes": 0})
row = rows.get(uuid_)
if row is None:
row = RuleHit(host_id=host.id, rule_uuid=uuid_, first_seen_at=now, last_packets=0, last_bytes=0, last_sampled_at=now)
db.add(row)
if counter["packets"] > 0:
row.last_hit_at = now # already matching when first seen
elif counter["packets"] > row.last_packets or (counter["packets"] < row.last_packets and counter["packets"] > 0):
row.last_hit_at = now
row.description = meta["description"][:255]
row.enabled = meta["enabled"]
row.last_packets, row.last_bytes, row.last_sampled_at = counter["packets"], counter["bytes"], now
for uuid_, row in rows.items(): # rule deleted on the firewall
if uuid_ not in rules:
await db.delete(row)
await db.commit()
return len(rules)
async def sample_all(db: AsyncSession) -> int:
hosts = (await db.scalars(select(OpnsenseHost).where(OpnsenseHost.enabled.is_(True)))).all()
sampled = 0
for host in hosts:
try:
await sample_host(db, host)
sampled += 1
except OpnsenseAPIError as exc:
logger.warning("Regelnutzung von %s nicht lesbar: %s", host.name, exc)
except Exception:
logger.exception("Regelnutzung von %s fehlgeschlagen", host.name)
return sampled
def classify(row: RuleHit, now: datetime) -> str:
"""'used' | 'unused' | 'collecting' | 'disabled'"""
if not row.enabled:
return "disabled"
if row.last_hit_at is not None and now - row.last_hit_at < timedelta(days=UNUSED_AFTER_DAYS):
return "used"
watched = now - row.first_seen_at
if watched < timedelta(days=UNUSED_AFTER_DAYS):
return "used" if row.last_hit_at is not None else "collecting"
return "unused"
async def unused_summary(db: AsyncSession, host_id) -> dict | None:
"""For the security check: None while nothing is known yet, else {"ready": bool, "rules": [names]}."""
rows = (await db.scalars(select(RuleHit).where(RuleHit.host_id == host_id))).all()
if not rows:
return None
now = datetime.now(timezone.utc)
states = [(r, classify(r, now)) for r in rows]
unused = [r.description or r.rule_uuid for r, s in states if s == "unused"]
watching = [s for _, s in states if s == "collecting"]
return {"unused": unused, "collecting": len(watching)}
+109
View File
@@ -0,0 +1,109 @@
"""Minimal S3-compatible object client (AWS Signature V4) for offsite backups.
Just what is needed — PUT, GET, DELETE and a connection test — so no AWS SDK is pulled
into the image. Works with AWS S3, MinIO, Backblaze B2, Wasabi, Cloudflare R2, Hetzner
Object Storage... Path-style addressing (``https://endpoint/bucket/key``) is the default
because it works everywhere; virtual-hosted style is available for providers that need it.
"""
import hashlib
import hmac
from datetime import datetime, timezone
from urllib.parse import quote, urlsplit
import httpx
from app.config import settings
class S3Error(Exception):
pass
def _sha256(data: bytes) -> str:
return hashlib.sha256(data).hexdigest()
def _hmac(key: bytes, message: str) -> bytes:
return hmac.new(key, message.encode(), hashlib.sha256).digest()
def _quote(path: str) -> str:
return quote(path, safe="/-_.~")
def sign(*, method: str, host: str, path: str, query: str, payload_hash: str, access_key: str, secret_key: str,
region: str, now: datetime, extra_headers: dict[str, str] | None = None) -> dict[str, str]:
"""SigV4 headers for one request (the algorithm of the AWS docs, service ``s3``)."""
amz_date = now.strftime("%Y%m%dT%H%M%SZ")
day = now.strftime("%Y%m%d")
headers = {"host": host, "x-amz-content-sha256": payload_hash, "x-amz-date": amz_date}
headers.update({k.lower(): v.strip() for k, v in (extra_headers or {}).items()})
names = sorted(headers)
canonical_headers = "".join(f"{n}:{headers[n]}\n" for n in names)
signed = ";".join(names)
canonical_request = "\n".join([method, _quote(path), query, canonical_headers, signed, payload_hash])
scope = f"{day}/{region}/s3/aws4_request"
to_sign = "\n".join(["AWS4-HMAC-SHA256", amz_date, scope, _sha256(canonical_request.encode())])
key = _hmac(_hmac(_hmac(_hmac(("AWS4" + secret_key).encode(), day), region), "s3"), "aws4_request")
signature = hmac.new(key, to_sign.encode(), hashlib.sha256).hexdigest()
headers["authorization"] = f"AWS4-HMAC-SHA256 Credential={access_key}/{scope}, SignedHeaders={signed}, Signature={signature}"
return headers
class S3Client:
def __init__(self, *, endpoint: str, region: str, bucket: str, access_key: str, secret_key: str, path_style: bool = True):
parts = urlsplit(endpoint)
if parts.scheme not in ("http", "https") or not parts.hostname:
raise S3Error("Ungültiger Endpunkt")
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
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
def _target(self, key: str) -> tuple[str, str, str]:
"""(host header, URL path, URL)"""
if self.path_style:
host, path = self.netloc, f"/{self.bucket}/{key}"
else:
host, path = f"{self.bucket}.{self.netloc}", f"/{key}"
return host, path, f"{self.scheme}://{host}{_quote(path)}"
async def _request(self, method: str, key: str, body: bytes = b"") -> httpx.Response:
host, path, url = self._target(key)
headers = sign(
method=method, host=host, path=path, query="", payload_hash=_sha256(body), access_key=self.access_key,
secret_key=self.secret_key, region=self.region, now=datetime.now(timezone.utc),
)
try:
async with httpx.AsyncClient(timeout=60) as client:
return await client.request(method, url, content=body if method == "PUT" else None, headers=headers)
except httpx.HTTPError as exc:
raise S3Error(f"Verbindung fehlgeschlagen ({type(exc).__name__})") from None
@staticmethod
def _check(response: httpx.Response, what: str) -> None:
if response.status_code >= 300:
raise S3Error(f"{what}: HTTP {response.status_code}")
async def put(self, key: str, data: bytes) -> None:
self._check(await self._request("PUT", key, data), "Hochladen")
async def get(self, key: str) -> bytes:
response = await self._request("GET", key)
self._check(response, "Herunterladen")
return response.content
async def delete(self, key: str) -> None:
response = await self._request("DELETE", key)
if response.status_code not in (200, 204, 404):
self._check(response, "Löschen")
async def test(self, key: str) -> None:
"""Write, read back and delete a tiny object: proves credentials, bucket and permissions."""
probe = b"opnexus connection test"
await self.put(key, probe)
if await self.get(key) != probe:
raise S3Error("Der Speicher lieferte etwas anderes zurück")
await self.delete(key)
@@ -6,6 +6,9 @@ action dispatch table) rather than duplicating that logic differently,
since this is the exact same remote action, just fired by a timer instead
of a click.
Updates take a fresh config backup right before firing (a plan for the day after tomorrow
would otherwise always trip over the 24h freshness rule).
v1 scope decision: a blocked or failed scheduled fire is logged and
recorded on the ScheduledMaintenance row's own `result` field (visible in
the UI) but is NOT wired into the NotificationSettings webhook/email
@@ -15,7 +18,7 @@ for this is a bigger change than this feature's own scope. Flagged here,
not silently dropped, in case it's wanted later.
"""
import logging
from datetime import datetime, timezone
from datetime import datetime, timedelta, timezone
from fastapi import HTTPException
from sqlalchemy import select
@@ -24,12 +27,30 @@ 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 app.services import audit_service, opnsense_client as client
from app.services.host_maintenance_service import ensure_no_maintenance, inspect_host
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
logger = logging.getLogger(__name__)
_ACTION_FN = {"reboot": client.reboot_host, "update": client.update_firmware, "major_update": client.upgrade_firmware}
# Actions that need a config backup no older than 24h (see host_maintenance_service.inspect_host).
# Unattended, nobody can take it by hand beforehand, so it is taken right before firing.
_BACKUP_BEFORE = {"update", "major_update"}
# ── CARP handover run (opt-in per plan) ─────────────────────────────────────
# MASTER -> maintenance mode -> partner must become MASTER -> action -> wait until the node is
# back -> leave maintenance mode. One step per poll tick, state in the schedule row.
# Rules that keep it safe:
# * the CARP toggle is a toggle: it is only ever sent against freshly read state and never
# replayed after an unclear answer (see routers/maintenance.py carp_execute);
# * until the action was submitted, any problem restores normal operation (nothing happened yet);
# * after that, any problem leaves the node demoted — the partner keeps carrying traffic, which is
# the safe side — and the run ends as failed (=> notification) with an "unknown" operation.
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)}
def _now() -> datetime:
@@ -79,6 +100,16 @@ async def _fire_one(db: AsyncSession, sched: ScheduledMaintenance) -> None:
await db.commit()
logger.warning("Geplante Wartung %s blockiert: %s", sched.id, exc.detail)
return
if sched.carp_handover and host.cluster_name:
try:
statuses = await get_statuses(await peers(db, host))
except client.OpnsenseAPIError as exc:
statuses = {}
logger.warning("Geplante Wartung %s: Rolle nicht lesbar: %s", sched.id, exc)
if statuses.get(host.id, {}).get("carp_status") == "MASTER":
await _start_handover(db, sched, host)
return
# Already BACKUP (or role unclear): no handover needed, the normal path below decides.
try:
state = await inspect_host(db, host)
except client.OpnsenseAPIError as exc:
@@ -87,6 +118,18 @@ async def _fire_one(db: AsyncSession, sched: ScheduledMaintenance) -> None:
await db.commit()
logger.warning("Geplante Wartung %s: Host nicht erreichbar", sched.id)
return
if sched.action in _BACKUP_BEFORE and not state["blocked"]:
# Read-only on the firewall. Fail closed: no backup, no update. Taken only after the
# other blockers passed, so a plan that is going to fail anyway does not pile up backups.
try:
backup_store.save_snapshot(host.id, await client.download_backup(host))
state = await inspect_host(db, host)
except client.OpnsenseAPIError as exc:
sched.status = "failed"
sched.result = {"error": f"Automatisches Backup vor dem Update fehlgeschlagen: {str(exc)[:300]}"}
await db.commit()
logger.warning("Geplante Wartung %s: Backup vor dem Update fehlgeschlagen", sched.id)
return
if state["actions"][sched.action]:
sched.status = "failed"
sched.result = {"error": " ".join(state["actions"][sched.action])}
@@ -125,3 +168,248 @@ async def _fire_one(db: AsyncSession, sched: ScheduledMaintenance) -> None:
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},
)
# ── handover run ─────────────────────────────────────────────────────────────
def _progress(sched: ScheduledMaintenance, **changes) -> dict:
"""JSON columns only notice reassignment, so always hand back a new dict."""
sched.progress = {**(sched.progress or {}), **changes}
return sched.progress
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},
)
async def _end(db, sched, host, op, *, ok, message, op_status=None, **result):
sched.status = "succeeded" if ok else "failed"
sched.phase = None
sched.result = {"handover": True, **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)
async def _toggle(host, expected: str) -> None:
"""One CARP maintenance toggle; raises OpnsenseAPIError for an unclear or wrong-direction answer."""
result = await client.toggle_carp_maintenance(host)
if result.get("action") != expected:
raise client.OpnsenseAPIError("CARP-Antwort passt nicht zur angeforderten Richtung")
async def _start_handover(db: AsyncSession, sched: ScheduledMaintenance, host: OpnsenseHost) -> None:
"""The node is MASTER now. All preconditions are checked while nothing has been changed yet."""
def fail(message: str):
sched.status = "failed"
sched.result = {"error": message[:900]}
return db.commit()
try:
carp = await inspect_carp_switch(db, host)
state = await inspect_host(db, host, skip_role_checks=True)
blocked = list(dict.fromkeys(carp["blocked"] + state["blocked"]))
if carp["action"] != "carp_enter": # MASTER but already in maintenance mode: unclear, do not toggle blindly
blocked.append(f"{host.name} steht bereits im CARP-Wartungsmodus. Rollen prüfen.")
if not blocked and sched.action in _BACKUP_BEFORE:
backup_store.save_snapshot(host.id, await client.download_backup(host))
state = await inspect_host(db, host, skip_role_checks=True)
blocked = list(dict.fromkeys(blocked + state["actions"][sched.action]))
except client.OpnsenseAPIError as exc:
await fail(f"Vorbereitung der CARP-Übergabe fehlgeschlagen, nichts wurde verändert: {str(exc)[:300]}")
return
if blocked:
await fail(" ".join(blocked))
return
now = _now()
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,
)
db.add(op)
sched.status = "running"
await db.commit()
sched.host_operation_id = op.id
await _audit(host, sched, op, "carp_enter", "requested", snapshot=state)
try:
await _toggle(host, "enter_maintenance")
except client.OpnsenseAPIError as exc:
await _end(db, sched, host, op, ok=False,
message=f"CARP-Umschalten mit unklarem Ergebnis: {str(exc)[:300]}. Nicht automatisch wiederholt — "
f"Rollen von {host.name} und Partner prüfen.")
return
sched.phase, sched.phase_since = "handover_wait", _now()
_progress(sched, version_before=state.get("version"))
op.message = "CARP-Übergabe angefordert, warte auf Bestätigung."
await db.commit()
await _audit(host, sched, op, "carp_enter", "submitted")
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))
)).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")
def _since(sched: ScheduledMaintenance) -> timedelta:
return _now() - (sched.phase_since or _now())
async def _roles(db, host) -> tuple[dict, bool]:
"""(own status, a partner is online and MASTER)."""
fleet = await peers(db, host)
statuses = await get_statuses(fleet)
partner_master = any(
statuses.get(h.id, {}).get("status") == "online" and statuses.get(h.id, {}).get("carp_status") == "MASTER"
for h in fleet if h.id != host.id
)
return statuses.get(host.id, {}), partner_master
async def _step_handover_wait(db, sched, host, op):
me, partner_master = await _roles(db, host)
if me.get("status") == "online" and me.get("carp_maintenance_mode") and me.get("carp_status") == "BACKUP" and partner_master:
try:
await _ACTION_FN[sched.action](host)
except client.OpnsenseAPIError as exc:
await _end(db, sched, host, op, ok=False,
message=f"Auftrag „{sched.action}“ mit unklarem Ergebnis: {str(exc)[:300]}. Nicht wiederholt. "
f"{host.name} bleibt im CARP-Wartungsmodus, der Partner trägt den Verkehr.")
return
sched.phase, sched.phase_since = "job_wait", _now()
_progress(sched, job_started_at=_now().isoformat(), seen_down=False, seen_running=False)
op.status, op.message = "submitted", "Übergabe bestätigt, Auftrag gestartet."
await db.commit()
await _audit(host, sched, op, sched.action, "submitted")
return
if _since(sched) < HANDOVER_TIMEOUT:
return
# The partner never took over. Nothing has run yet, so put the node back to normal.
if me.get("status") == "online" and me.get("carp_maintenance_mode"):
try:
await _toggle(host, "leave_maintenance")
except client.OpnsenseAPIError as exc:
await _end(db, sched, host, op, ok=False,
message=f"CARP-Übergabe nicht bestätigt, und der Normalbetrieb konnte nicht wiederhergestellt werden "
f"({str(exc)[:200]}). {host.name} prüfen.")
return
await _end(db, sched, host, op, ok=False, op_status="cancelled",
message="CARP-Übergabe nicht bestätigt (der Partner wurde nicht MASTER). Normalbetrieb wiederhergestellt, nichts aktualisiert.")
elif me.get("status") == "online":
await _end(db, sched, host, op, ok=False, op_status="cancelled",
message="CARP-Übergabe hat nicht stattgefunden (Wartungsmodus nicht aktiv). Nichts aktualisiert.")
else:
await _end(db, sched, host, op, ok=False,
message=f"CARP-Übergabe nicht bestätigt und {host.name} nicht erreichbar. Rollen prüfen.")
async def _step_job_wait(db, sched, host, op):
prog = dict(sched.progress or {})
started = datetime.fromisoformat(prog["job_started_at"])
elapsed = _now() - started
try:
running = (await client.get_firmware_running(host)).get("status")
except client.OpnsenseAPIError:
_progress(sched, seen_down=True) # rebooting: exactly what a reboot or base update looks like
running = None
else:
if running != "ready":
_progress(sched, seen_running=True)
prog = sched.progress
if running == "ready":
if sched.action == "reboot":
done = bool(prog.get("seen_down"))
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()
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.")
return
await db.commit()
async def _step_leave(db, sched, host, op):
me, _partner = await _roles(db, host)
if me.get("status") != "online":
if _since(sched) >= LEAVE_TIMEOUT:
await _end(db, sched, host, op, ok=False,
message=f"{host.name} ist nach dem Auftrag nicht wieder erreichbar. Der Partner trägt den Verkehr.")
return
if me.get("carp_maintenance_mode"):
try:
await _toggle(host, "leave_maintenance")
except client.OpnsenseAPIError as exc:
await _end(db, sched, host, op, ok=False,
message=f"Zurückschalten mit unklarem Ergebnis: {str(exc)[:300]}. Nicht automatisch wiederholt — "
f"{host.name} prüfen, ggf. „CARP-Normalbetrieb herstellen“.")
return
await _audit(host, sched, op, "carp_leave", "submitted")
sched.phase, sched.phase_since = "leave_wait", _now()
await db.commit()
async def _step_leave_wait(db, sched, host, op):
fleet = await peers(db, host)
statuses = await get_statuses(fleet)
me = statuses.get(host.id, {})
online = [h for h in fleet if statuses.get(h.id, {}).get("status") == "online"]
masters = [h for h in online if statuses.get(h.id, {}).get("carp_status") == "MASTER"]
if me.get("status") == "online" and not me.get("carp_maintenance_mode") and len(masters) == 1 and len(online) == len(fleet):
extra = {}
try:
extra["version_after"] = (await client.get_firmware_info(host)).get("product_version")
extra["reboot_required"] = str((await client.get_firmware_status(host)).get("status_reboot", "0")) == "1"
except client.OpnsenseAPIError:
pass
extra["version_before"] = (sched.progress or {}).get("version_before")
text = "Automatisch abgeschlossen: Übergabe, Auftrag und Zurückschalten bestätigt."
if extra.get("reboot_required"):
text += " Ein Neustart ist noch erforderlich."
await _end(db, sched, host, op, ok=True, message=text, **extra)
return
if _since(sched) >= LEAVE_TIMEOUT:
await _end(db, sched, host, op, ok=False,
message=f"Normalbetrieb nach dem Zurückschalten nicht bestätigt. Rollen von {host.name} und Partner prüfen.")
_STEPS = {
"handover_wait": _step_handover_wait,
"job_wait": _step_job_wait,
"leave": _step_leave,
"leave_wait": _step_leave_wait,
}
+21 -8
View File
@@ -18,6 +18,8 @@ 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
MAX_PEM_BYTES = 32 * 1024
@@ -90,6 +92,23 @@ def verify_argument(verify_tls: bool, tls_ca_pem: str | None):
return True
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."""
proxy = overlay_service.proxy_for(base_url)
port = parsed.port or 443
if proxy is None:
return await asyncio.wait_for(
asyncio.open_connection(parsed.hostname, port, ssl=ctx, server_hostname=parsed.hostname), timeout
)
reader, writer = await proxy_connect.open_tunnel(proxy, parsed.hostname, port, timeout)
try:
await asyncio.wait_for(writer.start_tls(ctx, server_hostname=parsed.hostname), timeout)
except Exception:
writer.close()
raise
return reader, writer
async def probe(base_url: str, timeout: float = 8.0) -> dict:
"""Fetch the certificate a firewall presents, *without* trusting it. The
caller must show the fingerprint to a human to compare with the firewall."""
@@ -100,10 +119,7 @@ async def probe(base_url: str, timeout: float = 8.0) -> dict:
ctx.check_hostname = False
ctx.verify_mode = ssl.CERT_NONE
try:
_, writer = await asyncio.wait_for(
asyncio.open_connection(parsed.hostname, parsed.port or 443, ssl=ctx, server_hostname=parsed.hostname),
timeout,
)
_, writer = await _open_tls(base_url, parsed, ctx, timeout)
except (OSError, ssl.SSLError, asyncio.TimeoutError) as exc:
raise TlsPinError(f"Verbindung fehlgeschlagen: {exc}") from exc
try:
@@ -122,10 +138,7 @@ async def verify_matches(base_url: str, pem: str, timeout: float = 8.0) -> None:
presents anything else."""
parsed = urlparse(base_url)
try:
_, writer = await asyncio.wait_for(
asyncio.open_connection(parsed.hostname, parsed.port or 443, ssl=pinned_context(pem), server_hostname=parsed.hostname),
timeout,
)
_, writer = await _open_tls(base_url, parsed, pinned_context(pem), timeout)
writer.close()
except ssl.SSLError as exc:
raise TlsPinError("Das Zertifikat der Firewall passt nicht zum festgesetzten Zertifikat") from exc
+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.15.0"
APP_CODENAME = "Gyrfalcon"
APP_VERSION = "1.21.0"
APP_CODENAME = "Osprey"
@@ -0,0 +1,20 @@
"""Einrichtungsassistent: Merker, dass ein Nutzer ihn abgeschlossen oder übersprungen hat.
Revision ID: 0005
Revises: 0004
Create Date: 2026-10-10
"""
from alembic import op
revision = "0005"
down_revision = "0004"
branch_labels = None
depends_on = None
def upgrade() -> None:
op.execute("ALTER TABLE user_preferences ADD COLUMN IF NOT EXISTS setup_done boolean NOT NULL DEFAULT false")
def downgrade() -> None:
op.execute("ALTER TABLE user_preferences DROP COLUMN IF EXISTS setup_done")
@@ -0,0 +1,23 @@
"""Benachrichtigung, wenn eine geplante Wartung nicht ausgeführt werden konnte.
Revision ID: 0006
Revises: 0005
Create Date: 2026-10-10
"""
from alembic import op
revision = "0006"
down_revision = "0005"
branch_labels = None
depends_on = None
def upgrade() -> None:
op.execute(
"ALTER TABLE notification_settings ADD COLUMN IF NOT EXISTS "
"scheduled_maintenance_failed_enabled boolean NOT NULL DEFAULT true"
)
def downgrade() -> None:
op.execute("ALTER TABLE notification_settings DROP COLUMN IF EXISTS scheduled_maintenance_failed_enabled")
@@ -0,0 +1,26 @@
"""Geplante Wartung mit automatischer CARP-Übergabe: Option, Phase und Fortschritt.
Revision ID: 0007
Revises: 0006
Create Date: 2026-10-19
"""
from alembic import op
revision = "0007"
down_revision = "0006"
branch_labels = None
depends_on = None
def upgrade() -> None:
op.execute("ALTER TABLE scheduled_maintenance ADD COLUMN IF NOT EXISTS carp_handover boolean NOT NULL DEFAULT false")
op.execute("ALTER TABLE scheduled_maintenance ADD COLUMN IF NOT EXISTS phase varchar(16)")
op.execute("ALTER TABLE scheduled_maintenance ADD COLUMN IF NOT EXISTS phase_since timestamp with time zone")
# The default only fills existing rows; like every JSON column here the model has no server default.
op.execute("ALTER TABLE scheduled_maintenance ADD COLUMN IF NOT EXISTS progress json NOT NULL DEFAULT '{}'::json")
op.execute("ALTER TABLE scheduled_maintenance ALTER COLUMN progress DROP DEFAULT")
def downgrade() -> None:
for column in ("progress", "phase_since", "phase", "carp_handover"):
op.execute(f"ALTER TABLE scheduled_maintenance DROP COLUMN IF EXISTS {column}")
@@ -0,0 +1,42 @@
"""API-Tokens für Skripte, CI, Prometheus und MCP.
Revision ID: 0008
Revises: 0007
Create Date: 2026-10-19
"""
import sqlalchemy as sa
from alembic import op
from sqlalchemy.dialects import postgresql
revision = "0008"
down_revision = "0007"
branch_labels = None
depends_on = None
def upgrade() -> None:
# Eine Altinstallation (vor Alembic) wird mit create_all() nach den aktuellen
# Modellen gebaut und hat die Tabelle dann schon.
if sa.inspect(op.get_bind()).has_table("api_tokens"):
return
op.create_table(
"api_tokens",
sa.Column("id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("user_id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("name", sa.String(length=80), nullable=False),
sa.Column("scope", sa.String(length=10), nullable=False),
sa.Column("token_hash", sa.String(length=64), nullable=False),
sa.Column("prefix", sa.String(length=16), nullable=False),
sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
sa.Column("expires_at", sa.DateTime(timezone=True), nullable=True),
sa.Column("last_used_at", sa.DateTime(timezone=True), nullable=True),
sa.Column("last_used_ip", sa.String(length=45), nullable=True),
sa.ForeignKeyConstraint(["user_id"], ["admin_users.id"], ondelete="CASCADE"),
sa.PrimaryKeyConstraint("id"),
)
op.create_index("ix_api_tokens_user_id", "api_tokens", ["user_id"])
op.create_index("ix_api_tokens_token_hash", "api_tokens", ["token_hash"], unique=True)
def downgrade() -> None:
op.execute("DROP TABLE IF EXISTS api_tokens")
@@ -0,0 +1,37 @@
"""Sicherheitslage: letztes Prüfergebnis je Host.
Revision ID: 0009
Revises: 0008
Create Date: 2026-10-19
"""
import sqlalchemy as sa
from alembic import op
from sqlalchemy.dialects import postgresql
revision = "0009"
down_revision = "0008"
branch_labels = None
depends_on = None
def upgrade() -> None:
# Eine Altinstallation wird mit create_all() nach den aktuellen Modellen gebaut.
if sa.inspect(op.get_bind()).has_table("compliance_results"):
return
op.create_table(
"compliance_results",
sa.Column("id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("host_id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("checked_at", sa.DateTime(timezone=True), nullable=False),
sa.Column("score", sa.Integer(), nullable=True),
sa.Column("findings", sa.JSON(), nullable=False),
sa.Column("error", sa.String(length=20), nullable=True),
sa.Column("error_detail", sa.String(length=300), nullable=True),
sa.ForeignKeyConstraint(["host_id"], ["opnsense_hosts.id"], ondelete="CASCADE"),
sa.PrimaryKeyConstraint("id"),
)
op.create_index("ix_compliance_results_host_id", "compliance_results", ["host_id"], unique=True)
def downgrade() -> None:
op.execute("DROP TABLE IF EXISTS compliance_results")
@@ -0,0 +1,39 @@
"""Audit-Export: Syslog und Webhook.
Revision ID: 0010
Revises: 0009
Create Date: 2026-10-20
"""
import sqlalchemy as sa
from alembic import op
revision = "0010"
down_revision = "0009"
branch_labels = None
depends_on = None
def upgrade() -> None:
if sa.inspect(op.get_bind()).has_table("audit_export_settings"):
return
op.create_table(
"audit_export_settings",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("syslog_enabled", sa.Boolean(), nullable=False),
sa.Column("syslog_host", sa.String(length=255), nullable=True),
sa.Column("syslog_port", sa.Integer(), nullable=False),
sa.Column("syslog_protocol", sa.String(length=3), nullable=False),
sa.Column("webhook_enabled", sa.Boolean(), nullable=False),
sa.Column("webhook_url", sa.String(length=500), nullable=True),
sa.Column("webhook_signing_secret_set", sa.Boolean(), nullable=False),
sa.Column("cursor_created_at", sa.DateTime(timezone=True), nullable=True),
sa.Column("cursor_id", sa.String(length=36), nullable=True),
sa.Column("last_success_at", sa.DateTime(timezone=True), nullable=True),
sa.Column("last_error", sa.String(length=300), nullable=True),
sa.Column("last_error_at", sa.DateTime(timezone=True), nullable=True),
sa.PrimaryKeyConstraint("id"),
)
def downgrade() -> None:
op.execute("DROP TABLE IF EXISTS audit_export_settings")
@@ -0,0 +1,59 @@
"""Geplante Backups mit Aufbewahrung und verschlüsseltem Offsite-Ziel; Benachrichtigung bei Backup-Problemen.
Revision ID: 0011
Revises: 0010
Create Date: 2026-10-20
"""
import sqlalchemy as sa
from alembic import op
from sqlalchemy.dialects import postgresql
revision = "0011"
down_revision = "0010"
branch_labels = None
depends_on = None
def upgrade() -> None:
inspector = sa.inspect(op.get_bind())
op.execute("ALTER TABLE notification_settings ADD COLUMN IF NOT EXISTS backup_failed_enabled boolean NOT NULL DEFAULT true")
if not inspector.has_table("backup_settings"):
op.create_table(
"backup_settings",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("scheduled_enabled", sa.Boolean(), nullable=False),
sa.Column("interval_hours", sa.Integer(), nullable=False),
sa.Column("keep_count", sa.Integer(), nullable=False),
sa.Column("offsite_enabled", sa.Boolean(), nullable=False),
sa.Column("s3_endpoint", sa.String(length=255), nullable=True),
sa.Column("s3_region", sa.String(length=64), nullable=False),
sa.Column("s3_bucket", sa.String(length=255), nullable=True),
sa.Column("s3_prefix", sa.String(length=255), nullable=False),
sa.Column("s3_access_key", sa.String(length=255), nullable=True),
sa.Column("s3_path_style", sa.Boolean(), nullable=False),
sa.Column("s3_secret_set", sa.Boolean(), nullable=False),
sa.Column("passphrase_set", sa.Boolean(), nullable=False),
sa.Column("last_run_at", sa.DateTime(timezone=True), nullable=True),
sa.Column("last_offsite_ok_at", sa.DateTime(timezone=True), nullable=True),
sa.Column("last_offsite_error", sa.String(length=300), nullable=True),
sa.PrimaryKeyConstraint("id"),
)
if not inspector.has_table("backup_uploads"):
op.create_table(
"backup_uploads",
sa.Column("id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("host_id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("snapshot_id", sa.String(length=64), nullable=False),
sa.Column("remote_key", sa.String(length=400), nullable=False),
sa.Column("uploaded_at", sa.DateTime(timezone=True), nullable=False),
sa.ForeignKeyConstraint(["host_id"], ["opnsense_hosts.id"], ondelete="CASCADE"),
sa.PrimaryKeyConstraint("id"),
sa.UniqueConstraint("host_id", "snapshot_id", name="uq_backup_upload"),
)
op.create_index("ix_backup_uploads_host_id", "backup_uploads", ["host_id"])
def downgrade() -> None:
op.execute("DROP TABLE IF EXISTS backup_uploads")
op.execute("DROP TABLE IF EXISTS backup_settings")
op.execute("ALTER TABLE notification_settings DROP COLUMN IF EXISTS backup_failed_enabled")
@@ -0,0 +1,40 @@
"""Regelnutzung: wann hat eine Regel zuletzt etwas getroffen.
Revision ID: 0012
Revises: 0011
Create Date: 2026-10-20
"""
import sqlalchemy as sa
from alembic import op
from sqlalchemy.dialects import postgresql
revision = "0012"
down_revision = "0011"
branch_labels = None
depends_on = None
def upgrade() -> None:
if sa.inspect(op.get_bind()).has_table("rule_hits"):
return
op.create_table(
"rule_hits",
sa.Column("id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("host_id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("rule_uuid", sa.String(length=36), nullable=False),
sa.Column("description", sa.String(length=255), nullable=False),
sa.Column("enabled", sa.Boolean(), nullable=False),
sa.Column("first_seen_at", sa.DateTime(timezone=True), nullable=False),
sa.Column("last_sampled_at", sa.DateTime(timezone=True), nullable=False),
sa.Column("last_hit_at", sa.DateTime(timezone=True), nullable=True),
sa.Column("last_packets", sa.BigInteger(), nullable=False),
sa.Column("last_bytes", sa.BigInteger(), nullable=False),
sa.ForeignKeyConstraint(["host_id"], ["opnsense_hosts.id"], ondelete="CASCADE"),
sa.PrimaryKeyConstraint("id"),
sa.UniqueConstraint("host_id", "rule_uuid", name="uq_rule_hit"),
)
op.create_index("ix_rule_hits_host_id", "rule_hits", ["host_id"])
def downgrade() -> None:
op.execute("DROP TABLE IF EXISTS rule_hits")
+57
View File
@@ -0,0 +1,57 @@
"""Single Sign-on (OIDC): Einstellungen, Anmeldeversuche, Herkunft der Konten.
Revision ID: 0013
Revises: 0012
Create Date: 2026-10-20
"""
import sqlalchemy as sa
from alembic import op
from sqlalchemy.dialects import postgresql
revision = "0013"
down_revision = "0012"
branch_labels = None
depends_on = None
def upgrade() -> None:
inspector = sa.inspect(op.get_bind())
op.execute("ALTER TABLE admin_users ADD COLUMN IF NOT EXISTS auth_source varchar(10) NOT NULL DEFAULT 'local'")
op.execute("ALTER TABLE admin_users ADD COLUMN IF NOT EXISTS oidc_subject varchar(600)")
op.execute("CREATE UNIQUE INDEX IF NOT EXISTS ix_admin_users_oidc_subject ON admin_users (oidc_subject)")
if not inspector.has_table("oidc_settings"):
op.create_table(
"oidc_settings",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("enabled", sa.Boolean(), nullable=False),
sa.Column("display_name", sa.String(length=60), nullable=False),
sa.Column("issuer", sa.String(length=500), nullable=True),
sa.Column("client_id", sa.String(length=255), nullable=True),
sa.Column("client_secret_set", sa.Boolean(), nullable=False),
sa.Column("scopes", sa.String(length=255), nullable=False),
sa.Column("groups_claim", sa.String(length=64), nullable=False),
sa.Column("admin_group", sa.String(length=255), nullable=True),
sa.Column("operator_group", sa.String(length=255), nullable=True),
sa.Column("read_only_group", sa.String(length=255), nullable=True),
sa.PrimaryKeyConstraint("id"),
)
if not inspector.has_table("oidc_login_states"):
op.create_table(
"oidc_login_states",
sa.Column("id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("state_hash", sa.String(length=64), nullable=False),
sa.Column("nonce", sa.String(length=64), nullable=False),
sa.Column("code_verifier", sa.String(length=128), nullable=False),
sa.Column("redirect_uri", sa.String(length=500), nullable=False),
sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
sa.PrimaryKeyConstraint("id"),
)
op.create_index("ix_oidc_login_states_state_hash", "oidc_login_states", ["state_hash"], unique=True)
def downgrade() -> None:
op.execute("DROP TABLE IF EXISTS oidc_login_states")
op.execute("DROP TABLE IF EXISTS oidc_settings")
op.execute("DROP INDEX IF EXISTS ix_admin_users_oidc_subject")
op.execute("ALTER TABLE admin_users DROP COLUMN IF EXISTS oidc_subject")
op.execute("ALTER TABLE admin_users DROP COLUMN IF EXISTS auth_source")
@@ -0,0 +1,28 @@
"""Aufgabentrennung: dürfen Operatoren selbst ausrollen?
Revision ID: 0014
Revises: 0013
Create Date: 2026-10-20
"""
import sqlalchemy as sa
from alembic import op
revision = "0014"
down_revision = "0013"
branch_labels = None
depends_on = None
def upgrade() -> None:
if sa.inspect(op.get_bind()).has_table("governance_settings"):
return
op.create_table(
"governance_settings",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("operators_may_deploy", sa.Boolean(), nullable=False),
sa.PrimaryKeyConstraint("id"),
)
def downgrade() -> None:
op.execute("DROP TABLE IF EXISTS governance_settings")
@@ -0,0 +1,48 @@
"""Management-Overlay (WireGuard-Hub) für Firewalls hinter NAT.
Revision ID: 0015
Revises: 0014
Create Date: 2026-10-20
"""
import sqlalchemy as sa
from alembic import op
from sqlalchemy.dialects import postgresql
revision = "0015"
down_revision = "0014"
branch_labels = None
depends_on = None
def upgrade() -> None:
inspector = sa.inspect(op.get_bind())
if not inspector.has_table("overlay_settings"):
op.create_table(
"overlay_settings",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("enabled", sa.Boolean(), nullable=False),
sa.Column("endpoint", sa.String(length=255), nullable=True),
sa.Column("subnet", sa.String(length=18), nullable=False),
sa.Column("listen_port", sa.Integer(), nullable=False),
sa.PrimaryKeyConstraint("id"),
)
if not inspector.has_table("overlay_peers"):
op.create_table(
"overlay_peers",
sa.Column("id", postgresql.UUID(as_uuid=True), nullable=False),
sa.Column("name", sa.String(length=80), nullable=False),
sa.Column("ip", sa.String(length=15), nullable=False),
sa.Column("public_key", sa.String(length=44), nullable=True),
sa.Column("host_id", postgresql.UUID(as_uuid=True), nullable=True),
sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
sa.ForeignKeyConstraint(["host_id"], ["opnsense_hosts.id"], ondelete="SET NULL"),
sa.PrimaryKeyConstraint("id"),
sa.UniqueConstraint("name"),
sa.UniqueConstraint("ip"),
sa.UniqueConstraint("public_key"),
)
def downgrade() -> None:
op.execute("DROP TABLE IF EXISTS overlay_peers")
op.execute("DROP TABLE IF EXISTS overlay_settings")
+1
View File
@@ -12,3 +12,4 @@ pytest-asyncio==1.4.0
respx==0.23.1
cryptography==50.0.2
alembic==1.20.0
PyJWT==2.10.1
+1
View File
@@ -20,6 +20,7 @@ os.environ["WIREGUARD_KEY_SECRET_DIR"] = "/tmp/opnexus-test-wireguard-secrets"
os.environ["CERT_KEY_SECRET_DIR"] = "/tmp/opnexus-test-cert-key-secrets"
os.environ["ACME_SECRET_DIR"] = "/tmp/opnexus-test-acme-secrets"
os.environ["TOTP_SECRET_DIR"] = "/tmp/opnexus-test-totp-secrets"
os.environ["OVERLAY_DIR"] = "/tmp/opnexus-test-overlay"
os.environ.setdefault("ADMIN_USERNAME", "admin")
# Force-set rather than setdefault: docker-compose's backend service sets
# ADMIN_PASSWORD="" (present-but-empty) by default, which setdefault would
+281
View File
@@ -0,0 +1,281 @@
"""API tokens: creation, scopes, session-only boundaries, revocation, audit."""
from datetime import datetime, timedelta, timezone
import pytest
from httpx import ASGITransport, AsyncClient
from sqlalchemy import select, update
from app.config import settings
from app.database import SessionLocal
from app.main import app
from app.models.api_token import ApiToken
from app.services import api_token_service
PASSWORD = settings.admin_password
async def _make(client, scope="read", name="ci", **extra):
resp = await client.post("/api/tokens", json={"name": name, "scope": scope, "current_password": PASSWORD, **extra})
assert resp.status_code == 201, resp.text
return resp.json()
def _bearer(token: str) -> AsyncClient:
return AsyncClient(
transport=ASGITransport(app=app), base_url="http://test", headers={"Authorization": f"Bearer {token}"}
)
async def _login(username: str, password: str) -> AsyncClient:
ac = AsyncClient(transport=ASGITransport(app=app), base_url="http://test")
resp = await ac.post("/api/auth/login", json={"username": username, "password": password})
assert resp.status_code == 200, resp.text
return ac
@pytest.mark.parametrize(
"scope,method,path,denied",
[
("read", "GET", "/api/hosts", False),
("read", "POST", "/api/rules", True),
# Secret-bearing reads need the admin scope; MCP (read-only tools) is open to every scope.
("read", "GET", "/api/hosts/abc/backups/config-1.xml", True),
("deploy", "GET", "/api/hosts/abc/backups/config-1.xml", True),
("admin", "GET", "/api/hosts/abc/backups/config-1.xml", False),
("read", "GET", "/api/hosts/abc/backups", False),
("read", "GET", "/api/notifications/settings", True),
("admin", "GET", "/api/notifications/settings", False),
("read", "POST", "/api/mcp", False),
("deploy", "POST", "/api/rules", False),
("deploy", "DELETE", "/api/aliases/x", False),
("deploy", "POST", "/api/hosts", True),
("deploy", "POST", "/api/hosts/tls-probe", True),
("deploy", "PATCH", "/api/hosts/abc", True),
("deploy", "DELETE", "/api/hosts/abc", True),
("deploy", "POST", "/api/hosts/abc/maintenance/execute", False),
("deploy", "POST", "/api/users", True),
("deploy", "PUT", "/api/settings", True),
("deploy", "PUT", "/api/notifications/settings", True),
("deploy", "PUT", "/api/logs/settings", True),
("deploy", "POST", "/api/system/updater/update", True),
("admin", "POST", "/api/users", False),
("admin", "POST", "/api/hosts", False),
# Session-only for every scope, reads included.
("admin", "GET", "/api/tokens", True),
("admin", "POST", "/api/tokens", True),
("read", "GET", "/api/tokens", True),
("admin", "POST", "/api/auth/change-password", True),
("admin", "POST", "/api/auth/2fa/disable", True),
],
)
def test_scope_matrix(scope, method, path, denied):
assert api_token_service.denies(scope, method, path) is denied
@pytest.mark.asyncio
async def test_create_needs_password_and_shows_token_once(client):
bad = await client.post("/api/tokens", json={"name": "x", "current_password": "wrong"})
assert bad.status_code == 401
assert bad.json()["detail"]["code"] == "AKTUELLES_PASSWORT_IST_FALSCH"
created = await _make(client, expires_in_days=30)
assert created["token"].startswith("opx_")
assert created["scope"] == "read"
assert created["prefix"] == created["token"][:10]
assert created["expires_at"] is not None
listed = (await client.get("/api/tokens")).json()
assert [t["id"] for t in listed] == [created["id"]]
assert "token" not in listed[0] and created["token"] not in str(listed)
@pytest.mark.asyncio
async def test_only_the_hash_is_stored(client):
created = await _make(client)
async with SessionLocal() as db:
row = await db.scalar(select(ApiToken))
assert row.token_hash == api_token_service.hash_token(created["token"])
assert created["token"] not in (row.token_hash, row.prefix)
@pytest.mark.asyncio
async def test_bearer_authenticates_without_a_session(client, anon_client):
created = await _make(client)
async with _bearer(created["token"]) as api:
assert (await api.get("/api/hosts")).status_code == 200
me = (await api.get("/api/auth/me")).json()
assert me["authenticated"] and me["via"] == "token" and me["scope"] == "read"
assert (await anon_client.get("/api/hosts")).status_code == 401
@pytest.mark.asyncio
async def test_read_scope_cannot_write(client):
created = await _make(client, "read")
async with _bearer(created["token"]) as api:
resp = await api.post("/api/groups", json={"name": "g"})
assert resp.status_code == 403
assert resp.json()["detail"]["code"] == "API_TOKEN_SCOPE_FORBIDDEN"
@pytest.mark.asyncio
async def test_deploy_scope_writes_fleet_objects_but_not_access_control(client):
created = await _make(client, "deploy")
async with _bearer(created["token"]) as api:
assert (await api.post("/api/groups", json={"name": "from-ci"})).status_code == 201
for method, path, body in [
("POST", "/api/users", {"username": "evil", "password": "evil-password-123", "role": "admin"}),
("POST", "/api/hosts", {}),
]:
resp = await api.request(method, path, json=body)
assert resp.status_code == 403, (path, resp.text)
assert resp.json()["detail"]["code"] == "API_TOKEN_SCOPE_FORBIDDEN"
@pytest.mark.asyncio
async def test_tokens_cannot_manage_tokens_or_accounts(client):
created = await _make(client, "admin")
async with _bearer(created["token"]) as api:
for method, path in [("GET", "/api/tokens"), ("POST", "/api/tokens"), ("DELETE", f"/api/tokens/{created['id']}"),
("POST", "/api/auth/change-password")]:
resp = await api.request(method, path, json={"name": "x", "current_password": PASSWORD})
assert resp.status_code == 403, (path, resp.text)
assert resp.json()["detail"]["code"] == "API_TOKEN_SCOPE_FORBIDDEN"
@pytest.mark.asyncio
async def test_admin_scope_acts_as_admin_and_is_audited_with_token_name(client):
created = await _make(client, "admin", name="terraform")
async with _bearer(created["token"]) as api:
resp = await api.post("/api/users", json={"username": "viaapi", "password": "via-api-password-1", "role": "read_only"})
assert resp.status_code == 201, resp.text
items = (await client.get("/api/audit", params={"kind": "user"})).json()["items"]
assert any(e["actor"] == "admin (API: terraform)" for e in items), items
@pytest.mark.asyncio
async def test_bad_or_expired_token_is_401_and_never_falls_back_to_the_cookie(client):
# `client` carries a valid session cookie; a broken bearer header must still fail.
resp = await client.get("/api/hosts", headers={"Authorization": "Bearer opx_doesnotexist"})
assert resp.status_code == 401
created = await _make(client)
async with SessionLocal() as db:
await db.execute(update(ApiToken).values(expires_at=datetime.now(timezone.utc) - timedelta(seconds=1)))
await db.commit()
async with _bearer(created["token"]) as api:
assert (await api.get("/api/hosts")).status_code == 401
@pytest.mark.asyncio
async def test_non_token_bearer_values_are_ignored(client):
# Only opx_ values are API tokens; anything else leaves normal cookie auth alone.
resp = await client.get("/api/hosts", headers={"Authorization": "Bearer something-else"})
assert resp.status_code == 200
@pytest.mark.asyncio
async def test_revoked_token_stops_working(client):
created = await _make(client)
async with _bearer(created["token"]) as api:
assert (await api.get("/api/hosts")).status_code == 200
assert (await client.delete(f"/api/tokens/{created['id']}")).status_code == 204
assert (await api.get("/api/hosts")).status_code == 401
assert (await client.delete(f"/api/tokens/{created['id']}")).status_code == 404
@pytest.mark.asyncio
async def test_last_used_is_recorded(client):
created = await _make(client)
async with _bearer(created["token"]) as api:
await api.get("/api/hosts")
listed = (await client.get("/api/tokens")).json()[0]
assert listed["last_used_at"] is not None
@pytest.mark.asyncio
async def test_read_only_user_gets_only_read_tokens_and_sees_only_their_own(client):
resp = await client.post("/api/users", json={"username": "tokviewer", "password": "viewer-password-123", "role": "read_only"})
assert resp.status_code == 201, resp.text
admin_token = await _make(client, "admin", name="admins")
viewer = await _login("tokviewer", "viewer-password-123")
try:
denied = await viewer.post("/api/tokens", json={"name": "x", "scope": "deploy", "current_password": "viewer-password-123"})
assert denied.status_code == 403
assert denied.json()["detail"]["code"] == "API_TOKEN_SCOPE_TOO_HIGH"
ok = await viewer.post("/api/tokens", json={"name": "grafana", "scope": "read", "current_password": "viewer-password-123"})
assert ok.status_code == 201, ok.text
mine = (await viewer.get("/api/tokens")).json()
assert [t["name"] for t in mine] == ["grafana"]
# Not someone else's token.
assert (await viewer.delete(f"/api/tokens/{admin_token['id']}")).status_code == 404
finally:
await viewer.aclose()
# The admin sees both and may revoke the viewer's.
all_tokens = {t["name"]: t for t in (await client.get("/api/tokens")).json()}
assert set(all_tokens) == {"admins", "grafana"} and all_tokens["grafana"]["owner"] == "tokviewer"
assert (await client.delete(f"/api/tokens/{all_tokens['grafana']['id']}")).status_code == 204
@pytest.mark.asyncio
async def test_demoted_owner_makes_the_token_read_only(client):
users = await client.post("/api/users", json={"username": "demotee", "password": "demotee-password-1", "role": "admin"})
uid = users.json()["id"]
owner = await _login("demotee", "demotee-password-1")
try:
created = (await owner.post("/api/tokens", json={"name": "t", "scope": "admin", "current_password": "demotee-password-1"})).json()
finally:
await owner.aclose()
assert (await client.patch(f"/api/users/{uid}/role", json={"role": "read_only"})).status_code == 200
async with _bearer(created["token"]) as api:
resp = await api.post("/api/groups", json={"name": "g"})
assert resp.status_code == 403
assert resp.json()["detail"]["code"] == "READ_ONLY_ACCESS"
@pytest.mark.asyncio
async def test_password_reset_and_user_delete_revoke_tokens(client):
resp = await client.post("/api/users", json={"username": "resetme", "password": "resetme-password-1", "role": "admin"})
uid = resp.json()["id"]
owner = await _login("resetme", "resetme-password-1")
try:
t1 = (await owner.post("/api/tokens", json={"name": "a", "current_password": "resetme-password-1"})).json()
finally:
await owner.aclose()
async with _bearer(t1["token"]) as api:
assert (await api.get("/api/hosts")).status_code == 200
assert (await client.post(f"/api/users/{uid}/reset-password", json={"new_password": "brand-new-password-1"})).status_code == 200
assert (await api.get("/api/hosts")).status_code == 401
assert (await client.delete(f"/api/users/{uid}")).status_code == 204
async with SessionLocal() as db:
assert (await db.scalars(select(ApiToken))).all() == []
@pytest.mark.asyncio
async def test_token_count_is_limited(client, monkeypatch):
monkeypatch.setattr(api_token_service, "MAX_TOKENS_PER_USER", 2)
await _make(client, name="1")
await _make(client, name="2")
resp = await client.post("/api/tokens", json={"name": "3", "current_password": PASSWORD})
assert resp.status_code == 409
assert resp.json()["detail"]["code"] == "API_TOKEN_LIMIT_REACHED"
@pytest.mark.asyncio
async def test_wrong_password_attempts_are_throttled(client):
codes = []
for _ in range(15):
codes.append((await client.post("/api/tokens", json={"name": "x", "current_password": "nope"})).status_code)
assert 429 in codes
@pytest.mark.asyncio
async def test_openapi_schema_is_served_behind_auth_with_bearer_scheme(client, anon_client):
assert (await anon_client.get("/api/openapi.json")).status_code == 401
schema = (await client.get("/api/openapi.json")).json()
assert schema["components"]["securitySchemes"]["bearerAuth"]["scheme"] == "bearer"
assert "/api/tokens" in schema["paths"] and "/api/hosts" in schema["paths"]
created = await _make(client)
async with _bearer(created["token"]) as api:
assert (await api.get("/api/openapi.json")).status_code == 200
# No interactive docs page (its CDN scripts would be blocked by the CSP anyway).
assert (await client.get("/docs")).status_code != 200
+239
View File
@@ -0,0 +1,239 @@
"""Audit export: cursor semantics, wire formats (syslog UDP/TCP, signed webhook), admin-only settings."""
import asyncio
import hashlib
import hmac
import json
import socket
import threading
from datetime import datetime, timedelta, timezone
import httpx
import pytest
from sqlalchemy import select
from app.database import SessionLocal
from app.models.audit import AuditEvent
from app.models.audit_export import AuditExportSettings
from app.services import audit_export_service as svc
from app.services import notification_secret_store
from tests.test_api_tokens import _login
async def _event(n: int, *, age_s: float = 60, status="accepted", details=None) -> AuditEvent:
async with SessionLocal() as db:
event = AuditEvent(
created_at=datetime.now(timezone.utc) - timedelta(seconds=age_s + (10 - n) * 0.001), correlation_id="c", actor="admin", kind="rule",
action="deploy", status=status, entity_name=f"rule-{n}", message=f"m{n}", details=details or {},
)
db.add(event)
await db.commit()
return event
async def _configure(**fields):
async with SessionLocal() as db:
row = await svc.get_settings(db)
for key, value in fields.items():
setattr(row, key, value)
await db.commit()
async def _run(lag=0):
async with SessionLocal() as db:
return await svc.run_once(db, lag_seconds=lag)
async def _state():
async with SessionLocal() as db:
return await svc.get_settings(db)
class _UdpReceiver:
def __init__(self):
self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
self.sock.bind(("127.0.0.1", 0))
self.sock.settimeout(2)
self.port = self.sock.getsockname()[1]
def receive(self, n):
return [self.sock.recvfrom(65535)[0].decode() for _ in range(n)]
class _TcpReceiver:
def __init__(self):
self.server = socket.socket()
self.server.bind(("127.0.0.1", 0))
self.server.listen(1)
self.port = self.server.getsockname()[1]
self.data = b""
self.thread = threading.Thread(target=self._serve, daemon=True)
self.thread.start()
def _serve(self):
conn, _ = self.server.accept()
while chunk := conn.recv(65535):
self.data += chunk
conn.close()
@pytest.fixture(autouse=True)
async def _reset(tmp_path):
async with SessionLocal() as db:
await db.execute(AuditExportSettings.__table__.delete())
await db.commit()
yield
@pytest.mark.asyncio
async def test_idle_when_nothing_is_enabled():
await _event(1)
assert await _run() == 0
assert (await _state()).cursor_created_at is None
@pytest.mark.asyncio
async def test_first_round_starts_from_now_without_replaying_history():
await _event(1, age_s=3600)
udp = _UdpReceiver()
await _configure(syslog_enabled=True, syslog_host="127.0.0.1", syslog_port=udp.port)
assert await _run() == 0 # sets the cursor
assert (await _state()).cursor_created_at is not None
await asyncio.sleep(0.05)
await _event(2, age_s=0)
assert await _run() == 1
(line,) = udp.receive(1)
assert '"entity_name": "rule-2"' in line and "rule-1" not in line
@pytest.mark.asyncio
async def test_syslog_udp_line_is_rfc5424_with_severity_by_status_and_no_details():
udp = _UdpReceiver()
await _configure(syslog_enabled=True, syslog_host="127.0.0.1", syslog_port=udp.port, cursor_created_at=datetime.now(timezone.utc) - timedelta(hours=1))
await _event(1, status="accepted", details={"after_payload": {"password": "hunter2"}})
await _event(2, status="denied")
assert await _run() == 2
ok, bad = udp.receive(2)
assert ok.startswith("<134>1 ") and bad.startswith("<132>1 ") # local0.info / local0.warning
assert " opnexus - AUDIT - {" in ok
body = json.loads(ok.split(" - AUDIT - ", 1)[1])
assert body["actor"] == "admin" and body["kind"] == "rule" and "details" not in body
assert "hunter2" not in ok
@pytest.mark.asyncio
async def test_syslog_tcp_uses_octet_counting():
tcp = _TcpReceiver()
await _configure(syslog_enabled=True, syslog_host="127.0.0.1", syslog_port=tcp.port, syslog_protocol="tcp",
cursor_created_at=datetime.now(timezone.utc) - timedelta(hours=1))
await _event(1)
assert await _run() == 1
tcp.thread.join(timeout=3)
length, _, rest = tcp.data.partition(b" ")
assert int(length) == len(rest) and rest.startswith(b"<134>1 ")
@pytest.mark.asyncio
async def test_failure_keeps_the_cursor_and_the_next_round_retries(respx_mock):
await _configure(webhook_enabled=True, webhook_url="https://hook.test/secret-token",
cursor_created_at=datetime.now(timezone.utc) - timedelta(hours=1))
await _event(1)
route = respx_mock.post("https://hook.test/secret-token").mock(return_value=httpx.Response(500))
assert await _run() == 0
state = await _state()
assert state.cursor_id is None and "HTTP 500" in state.last_error and "secret-token" not in state.last_error
route.mock(return_value=httpx.Response(200))
assert await _run() == 1
state = await _state()
assert state.last_error is None and state.last_success_at is not None and state.cursor_id is not None
assert await _run() == 0 # nothing new
@pytest.mark.asyncio
async def test_webhook_batch_is_signed(respx_mock):
notification_secret_store.save_secret(svc.SECRET_NAME, "s3cret")
await _configure(webhook_enabled=True, webhook_url="https://hook.test/in", webhook_signing_secret_set=True,
cursor_created_at=datetime.now(timezone.utc) - timedelta(hours=1))
await _event(1)
await _event(2)
route = respx_mock.post("https://hook.test/in").mock(return_value=httpx.Response(200))
assert await _run() == 2
request = route.calls.last.request
assert request.headers["X-OPNexus-Signature"] == "sha256=" + hmac.new(b"s3cret", request.content, hashlib.sha256).hexdigest()
payload = json.loads(request.content)
assert [e["entity_name"] for e in payload["events"]] == ["rule-1", "rule-2"] and payload["source"] == "opnexus"
@pytest.mark.asyncio
async def test_missing_signing_secret_fails_closed(respx_mock):
notification_secret_store.delete_secret(svc.SECRET_NAME)
await _configure(webhook_enabled=True, webhook_url="https://hook.test/in", webhook_signing_secret_set=True,
cursor_created_at=datetime.now(timezone.utc) - timedelta(hours=1))
await _event(1)
assert await _run() == 0 # respx would fail the test on any request: nothing was sent
assert "nicht lesbar" in (await _state()).last_error
@pytest.mark.asyncio
async def test_batches_are_ordered_and_resume_without_gaps_or_duplicates(respx_mock, monkeypatch):
monkeypatch.setattr(svc, "BATCH", 2)
await _configure(webhook_enabled=True, webhook_url="https://hook.test/in", cursor_created_at=datetime.now(timezone.utc) - timedelta(hours=1))
for n in range(1, 6):
await _event(n)
route = respx_mock.post("https://hook.test/in").mock(return_value=httpx.Response(200))
assert [await _run(), await _run(), await _run(), await _run()] == [2, 2, 1, 0]
names = [e["entity_name"] for call in route.calls for e in json.loads(call.request.content)["events"]]
assert names == [f"rule-{n}" for n in range(1, 6)]
@pytest.mark.asyncio
async def test_very_fresh_events_wait_for_the_lag():
udp = _UdpReceiver()
await _configure(syslog_enabled=True, syslog_host="127.0.0.1", syslog_port=udp.port, cursor_created_at=datetime.now(timezone.utc) - timedelta(hours=1))
await _event(1, age_s=0.2)
assert await _run(lag=3) == 0
assert await _run(lag=0) == 1
# ── Settings API ─────────────────────────────────────────────────────────
@pytest.mark.asyncio
async def test_settings_roundtrip_hides_the_secret_and_enabling_starts_from_now(client):
got = (await client.get("/api/settings/audit-export")).json()
assert got["syslog_enabled"] is False and got["webhook_signing_secret_set"] is False
put = await client.put("/api/settings/audit-export", json={
"syslog_enabled": True, "syslog_host": "127.0.0.1", "syslog_port": 5514, "syslog_protocol": "tcp",
"webhook_signing_secret": "shh"})
assert put.status_code == 200, put.text
body = put.json()
assert body["syslog_protocol"] == "tcp" and body["webhook_signing_secret_set"] is True and "shh" not in put.text
assert (await _state()).cursor_created_at is not None
cleared = (await client.put("/api/settings/audit-export", json={"clear_webhook_signing_secret": True, "syslog_enabled": False})).json()
assert cleared["webhook_signing_secret_set"] is False
assert (await _state()).cursor_created_at is None
@pytest.mark.asyncio
async def test_settings_validation(client):
for body in ({"syslog_protocol": "carrier-pigeon"}, {"syslog_port": 0}, {"webhook_url": "x" * 501}):
assert (await client.put("/api/settings/audit-export", json=body)).status_code == 422
@pytest.mark.asyncio
async def test_test_endpoint_needs_a_channel_and_reports_delivery_failures(client, respx_mock):
assert (await client.post("/api/settings/audit-export/test")).status_code == 502
await client.put("/api/settings/audit-export", json={"webhook_enabled": True, "webhook_url": "https://hook.test/in"})
respx_mock.post("https://hook.test/in").mock(return_value=httpx.Response(200))
assert (await client.post("/api/settings/audit-export/test")).json() == {"success": True}
@pytest.mark.asyncio
async def test_only_admins_may_read_or_change_it(client):
for role in ("operator", "read_only"):
name = f"exp-{role}"
assert (await client.post("/api/users", json={"username": name, "password": "export-password-1", "role": role})).status_code == 201
user = await _login(name, "export-password-1")
try:
assert (await user.get("/api/settings/audit-export")).status_code == 403
assert (await user.put("/api/settings/audit-export", json={"syslog_enabled": True})).status_code == 403
finally:
await user.aclose()
+6 -4
View File
@@ -92,13 +92,15 @@ async def test_health_stays_public_but_docs_require_auth(anon_client):
# /docs/redoc/openapi.json used to be public — now require a session
# like any other endpoint, since fully documenting a firewall-fleet
# API surface to an anonymous caller is free recon for an attacker.
for path in ("/docs", "/redoc", "/openapi.json"):
for path in ("/docs", "/redoc", "/openapi.json", "/api/openapi.json"):
resp = await anon_client.get(path)
assert resp.status_code == 401
@pytest.mark.asyncio
async def test_docs_reachable_once_logged_in(client):
async def test_openapi_schema_reachable_once_logged_in(client):
# The schema lives under /api (the proxy only routes /api to the backend); the
# interactive Swagger/ReDoc pages are gone (their CDN scripts violate the CSP).
assert (await client.get("/api/openapi.json")).status_code == 200
for path in ("/docs", "/redoc", "/openapi.json"):
resp = await client.get(path)
assert resp.status_code == 200
assert (await client.get(path)).status_code == 404
+435
View File
@@ -0,0 +1,435 @@
"""Scheduled backups, retention, encrypted offsite copy: crypto, S3 signing, schedule logic, API."""
import io
import json
import os
import re
import subprocess
import sys
from datetime import datetime, timedelta, timezone
import httpx
import pytest
from sqlalchemy import select
from app.database import SessionLocal
from app.models.backup_settings import BackupSettings, BackupUpload
from app.services import backup_crypto, backup_schedule_service as svc, backup_store, notification_checks, notification_secret_store
from app.services import s3_client
from tests.test_api_tokens import _login
from tests.test_rules import _create_host
CONFIG = b"<?xml version='1.0'?><opnsense><system><hostname>fw</hostname></system></opnsense>"
# ── encryption ───────────────────────────────────────────────────────────
def test_encryption_roundtrip_and_every_failure_mode():
blob = backup_crypto.encrypt(CONFIG, "correct horse battery")
assert blob.startswith(backup_crypto.MAGIC) and CONFIG not in blob
assert backup_crypto.decrypt(blob, "correct horse battery") == CONFIG
assert backup_crypto.encrypt(CONFIG, "correct horse battery") != blob # fresh salt and nonce
with pytest.raises(backup_crypto.DecryptError):
backup_crypto.decrypt(blob, "wrong passphrase!")
tampered = bytearray(blob)
tampered[-1] ^= 1
with pytest.raises(backup_crypto.DecryptError):
backup_crypto.decrypt(bytes(tampered), "correct horse battery")
relabelled = bytearray(blob)
relabelled[len(backup_crypto.MAGIC)] ^= 1 # salt is authenticated header data
with pytest.raises(backup_crypto.DecryptError):
backup_crypto.decrypt(bytes(relabelled), "correct horse battery")
for junk in (b"", b"OPXBAK1", b"not a backup at all, really not" * 3):
with pytest.raises(backup_crypto.DecryptError):
backup_crypto.decrypt(junk, "x" * 12)
def test_decrypt_cli_reads_stdin_and_the_environment():
blob = backup_crypto.encrypt(CONFIG, "cli passphrase 123")
ok = subprocess.run([sys.executable, "-m", "app.backup_decrypt"], input=blob, capture_output=True,
env={**os.environ, "BACKUP_PASSPHRASE": "cli passphrase 123"})
assert ok.returncode == 0 and ok.stdout == CONFIG
bad = subprocess.run([sys.executable, "-m", "app.backup_decrypt"], input=blob, capture_output=True,
env={**os.environ, "BACKUP_PASSPHRASE": "nope nope nope!"})
assert bad.returncode == 1 and bad.stdout == b""
# ── SigV4 (examples from the AWS S3 documentation) ───────────────────────
_AK, _SK = "AKIAIOSFODNN7EXAMPLE", "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
_EMPTY = s3_client._sha256(b"")
def test_sigv4_matches_the_aws_get_object_example():
headers = s3_client.sign(
method="GET", host="examplebucket.s3.amazonaws.com", path="/test.txt", query="", payload_hash=_EMPTY,
access_key=_AK, secret_key=_SK, region="us-east-1", now=datetime(2013, 5, 24, tzinfo=timezone.utc),
extra_headers={"Range": "bytes=0-9"},
)
assert headers["authorization"].endswith("Signature=f0e8bdb87c964420e857bd35b5d6ed310bd44f0170aba48dd91039c6036bdb41")
assert "SignedHeaders=host;range;x-amz-content-sha256;x-amz-date" in headers["authorization"]
def test_sigv4_matches_the_aws_put_object_example_with_an_escaped_key():
body = b"Welcome to Amazon S3."
headers = s3_client.sign(
method="PUT", host="examplebucket.s3.amazonaws.com", path="/test$file.text", query="", payload_hash=s3_client._sha256(body),
access_key=_AK, secret_key=_SK, region="us-east-1", now=datetime(2013, 5, 24, tzinfo=timezone.utc),
extra_headers={"Date": "Fri, 24 May 2013 00:00:00 GMT", "x-amz-storage-class": "REDUCED_REDUNDANCY"},
)
assert headers["authorization"].endswith("Signature=98ad721746da40c64f1a55b78f14c238d841ea1380cd77a1b5971af0ece108bd")
def _s3(**kw):
return s3_client.S3Client(endpoint="https://s3.test", region="eu-1", bucket="bk", access_key="AK", secret_key="SK", **kw)
@pytest.mark.asyncio
async def test_s3_client_requests_and_errors(respx_mock):
put = respx_mock.put("https://s3.test/bk/a/b%20c.opxbak").mock(return_value=httpx.Response(200))
await _s3().put("a/b c.opxbak", b"data")
request = put.calls.last.request
assert request.headers["authorization"].startswith("AWS4-HMAC-SHA256 Credential=AK/") and "/eu-1/s3/aws4_request" in request.headers["authorization"]
assert request.headers["x-amz-content-sha256"] == s3_client._sha256(b"data") and request.content == b"data"
respx_mock.put("https://bk.s3.test/x").mock(return_value=httpx.Response(403))
with pytest.raises(s3_client.S3Error, match="HTTP 403"):
await _s3(path_style=False).put("x", b"1")
respx_mock.delete("https://s3.test/bk/gone").mock(return_value=httpx.Response(404))
await _s3().delete("gone") # deleting what is not there is fine
respx_mock.put("https://s3.test/bk/net").mock(side_effect=httpx.ConnectError("boom"))
with pytest.raises(s3_client.S3Error, match="Verbindung"):
await _s3().put("net", b"1")
def test_s3_endpoint_must_be_https_unless_the_lab_switch_is_on(monkeypatch):
with pytest.raises(s3_client.S3Error):
s3_client.S3Client(endpoint="http://minio.lan:9000", region="r", bucket="b", access_key="a", secret_key="s")
for bad in ("ftp://x", "minio", ""):
with pytest.raises(s3_client.S3Error):
s3_client.S3Client(endpoint=bad, region="r", bucket="b", access_key="a", secret_key="s")
monkeypatch.setattr(s3_client.settings, "allow_insecure_offsite", True)
s3_client.S3Client(endpoint="http://minio.lan:9000", region="r", bucket="b", access_key="a", secret_key="s")
@pytest.mark.asyncio
async def test_s3_connection_test_proves_write_read_delete(respx_mock):
store = {}
respx_mock.put(url__regex=r"https://s3.test/bk/probe").mock(side_effect=lambda r: store.update(v=r.content) or httpx.Response(200))
respx_mock.get(url__regex=r"https://s3.test/bk/probe").mock(side_effect=lambda r: httpx.Response(200, content=store["v"]))
gone = respx_mock.delete(url__regex=r"https://s3.test/bk/probe").mock(return_value=httpx.Response(204))
await _s3().test("probe")
assert gone.called
respx_mock.get(url__regex=r"https://s3.test/bk/probe").mock(return_value=httpx.Response(200, content=b"other"))
with pytest.raises(s3_client.S3Error):
await _s3().test("probe")
# ── schedule, retention, offsite ─────────────────────────────────────────
def _mock_fw(respx_mock, content=CONFIG):
respx_mock.get(url__regex=r".*/getVipStatus").mock(return_value=httpx.Response(200, json={"rows": []}))
return respx_mock.get(url__regex=r".*/core/backup/download/this").mock(return_value=httpx.Response(200, content=content))
async def _cfg(**fields):
async with SessionLocal() as db:
row = await svc.get_settings(db)
for k, v in fields.items():
setattr(row, k, v)
await db.commit()
async def _run(force=False):
async with SessionLocal() as db:
return await svc.run_due(db, force=force)
def _age(host_id, snapshot_id, hours):
import app.services.backup_store as bs
path = bs._host_dir(host_id) / snapshot_id
t = (datetime.now(timezone.utc) - timedelta(hours=hours)).timestamp()
os.utime(path, (t, t))
@pytest.mark.asyncio
async def test_a_backup_is_taken_when_due_and_not_before(client, respx_mock):
download = _mock_fw(respx_mock)
host = await _create_host(client, "fw1", "https://fw1.test")
assert (await _run())["taken"] == 1 and len(backup_store.list_snapshots(host["id"])) == 1
assert (await _run())["taken"] == 0 # fresh, nothing due
first = backup_store.list_snapshots(host["id"])[0]["id"]
_age(host["id"], first, 25)
assert (await _run())["taken"] == 1 and download.call_count == 2
assert (await _run(force=True))["taken"] == 1 # "run now" ignores the interval
@pytest.mark.asyncio
async def test_disabled_schedule_takes_nothing_and_disabled_hosts_are_skipped(client, respx_mock):
_mock_fw(respx_mock)
host = await _create_host(client, "fw1", "https://fw1.test")
await _cfg(scheduled_enabled=False)
assert (await _run())["taken"] == 0
await _cfg(scheduled_enabled=True)
await client.patch(f"/api/hosts/{host['id']}", json={"enabled": False})
assert (await _run())["taken"] == 0
@pytest.mark.asyncio
async def test_retention_keeps_only_the_newest_n(client, respx_mock):
_mock_fw(respx_mock)
host = await _create_host(client, "fw1", "https://fw1.test")
await _cfg(keep_count=3)
for _ in range(6):
backup_store.save_snapshot(host["id"], CONFIG)
result = await _run()
kept = backup_store.list_snapshots(host["id"])
assert len(kept) == 3 and result["pruned"] >= 3
@pytest.mark.asyncio
async def test_failure_is_counted_a_garbage_answer_is_not_stored_and_others_continue(client, respx_mock):
respx_mock.get(url__regex=r".*/getVipStatus").mock(return_value=httpx.Response(200, json={"rows": []}))
ok = await _create_host(client, "fw-ok", "https://ok.test")
bad = await _create_host(client, "fw-bad", "https://bad.test")
junk = await _create_host(client, "fw-junk", "https://junk.test")
respx_mock.get("https://ok.test/api/core/backup/download/this").mock(return_value=httpx.Response(200, content=CONFIG))
respx_mock.get("https://bad.test/api/core/backup/download/this").mock(return_value=httpx.Response(500))
respx_mock.get("https://junk.test/api/core/backup/download/this").mock(return_value=httpx.Response(200, content=b"<html>login</html>"))
result = await _run()
assert (result["taken"], result["failed"]) == (1, 2)
assert backup_store.list_snapshots(ok["id"]) and not backup_store.list_snapshots(bad["id"]) and not backup_store.list_snapshots(junk["id"])
async def _offsite_on(passphrase="offsite passphrase 1"):
notification_secret_store.save_secret(svc.S3_SECRET, "SK")
notification_secret_store.save_secret(svc.PASSPHRASE, passphrase)
await _cfg(offsite_enabled=True, s3_endpoint="https://s3.test", s3_bucket="bk", s3_access_key="AK", s3_secret_set=True, passphrase_set=True, s3_prefix="/opnexus/")
@pytest.mark.asyncio
async def test_offsite_upload_is_encrypted_once_only_and_named_by_host(client, respx_mock):
_mock_fw(respx_mock)
host = await _create_host(client, "fw 1/main", "https://fw1.test")
await _offsite_on()
puts = respx_mock.put(url__regex=r"https://s3\.test/bk/opnexus/.*").mock(return_value=httpx.Response(200))
result = await _run()
assert result["uploaded"] == 1 and puts.call_count == 1
request = puts.calls.last.request
assert re.fullmatch(rf"/bk/opnexus/fw-1-main-{host['id'][:8]}/\d{{8}}T\d+\.opxbak", request.url.path)
assert CONFIG not in request.content and backup_crypto.decrypt(request.content, "offsite passphrase 1") == CONFIG
assert (await _run())["uploaded"] == 0 and puts.call_count == 1 # ledger: nothing twice
async with SessionLocal() as db:
assert len((await db.scalars(select(BackupUpload))).all()) == 1
cfg = await svc.get_settings(db)
assert cfg.last_offsite_error is None and cfg.last_offsite_ok_at is not None
@pytest.mark.asyncio
async def test_offsite_failure_is_recorded_and_retried_next_round(client, respx_mock):
_mock_fw(respx_mock)
await _create_host(client, "fw1", "https://fw1.test")
await _offsite_on()
route = respx_mock.put(url__regex=r"https://s3\.test/bk/.*").mock(return_value=httpx.Response(503))
await _run()
async with SessionLocal() as db:
assert "HTTP 503" in (await svc.get_settings(db)).last_offsite_error
assert (await db.scalars(select(BackupUpload))).all() == []
route.mock(return_value=httpx.Response(200))
assert (await _run())["uploaded"] == 1
async with SessionLocal() as db:
assert (await svc.get_settings(db)).last_offsite_error is None
@pytest.mark.asyncio
async def test_incomplete_offsite_config_and_lost_passphrase_fail_closed(client, respx_mock):
_mock_fw(respx_mock)
await _create_host(client, "fw1", "https://fw1.test")
await _cfg(offsite_enabled=True)
await _run()
async with SessionLocal() as db:
assert "unvollständig" in (await svc.get_settings(db)).last_offsite_error
await _offsite_on()
notification_secret_store.delete_secret(svc.PASSPHRASE) # respx would fail on any upload: nothing leaves unencrypted
await _run()
async with SessionLocal() as db:
assert "Passphrase" in (await svc.get_settings(db)).last_offsite_error
@pytest.mark.asyncio
async def test_pruned_snapshots_leave_the_ledger(client, respx_mock):
_mock_fw(respx_mock)
host = await _create_host(client, "fw1", "https://fw1.test")
await _offsite_on()
respx_mock.put(url__regex=r"https://s3\.test/bk/.*").mock(return_value=httpx.Response(200))
await _cfg(keep_count=3)
for _ in range(4):
backup_store.save_snapshot(host["id"], CONFIG)
await _run()
async with SessionLocal() as db:
names = {r.snapshot_id for r in (await db.scalars(select(BackupUpload))).all()}
assert names <= {s["id"] for s in backup_store.list_snapshots(host["id"])}
# ── notifications ────────────────────────────────────────────────────────
@pytest.mark.asyncio
async def test_stale_backup_problem_after_three_missed_intervals(client, respx_mock):
_mock_fw(respx_mock)
host = await _create_host(client, "fw1", "https://fw1.test")
async with SessionLocal() as db:
assert await notification_checks.check_backup_stale(db) == {} # brand-new host: not yet
from app.models.host import OpnsenseHost
async with SessionLocal() as db:
row = await db.get(OpnsenseHost, __import__("uuid").UUID(host["id"]))
row.created_at = datetime.now(timezone.utc) - timedelta(days=5)
await db.commit()
async with SessionLocal() as db:
assert list(await notification_checks.check_backup_stale(db)) == [host["id"]]
name = backup_store.save_snapshot(host["id"], CONFIG)
async with SessionLocal() as db:
assert await notification_checks.check_backup_stale(db) == {}
_age(host["id"], name, 80)
async with SessionLocal() as db:
assert list(await notification_checks.check_backup_stale(db)) == [host["id"]]
await _cfg(scheduled_enabled=False)
async with SessionLocal() as db:
assert await notification_checks.check_backup_stale(db) == {}
@pytest.mark.asyncio
async def test_offsite_problem_follows_the_last_error():
await _cfg(offsite_enabled=True, last_offsite_error="HTTP 503")
async with SessionLocal() as db:
assert (await notification_checks.check_backup_offsite(db)) == {"offsite": {"message": "HTTP 503"}}
await _cfg(last_offsite_error=None)
async with SessionLocal() as db:
assert await notification_checks.check_backup_offsite(db) == {}
# ── API ──────────────────────────────────────────────────────────────────
@pytest.mark.asyncio
async def test_settings_roundtrip_never_returns_secrets(client):
put = await client.put("/api/settings/backups", json={
"interval_hours": 12, "keep_count": 10, "offsite_enabled": True, "s3_endpoint": "https://s3.test/", "s3_bucket": "bk",
"s3_access_key": "AK", "s3_secret_key": "TOPSECRET", "passphrase": "a long passphrase here"})
assert put.status_code == 200, put.text
body = put.json()
assert body["s3_endpoint"] == "https://s3.test" and body["s3_secret_set"] and body["passphrase_set"]
assert "TOPSECRET" not in put.text and "passphrase here" not in put.text
assert notification_secret_store.read_secret(svc.S3_SECRET) == "TOPSECRET"
cleared = (await client.put("/api/settings/backups", json={"clear_s3_secret": True})).json()
assert cleared["s3_secret_set"] is False and notification_secret_store.read_secret(svc.S3_SECRET) is None
@pytest.mark.asyncio
async def test_settings_validation(client):
for body in ({"interval_hours": 0}, {"keep_count": 2}, {"passphrase": "short"}, {"s3_region": ""}):
assert (await client.put("/api/settings/backups", json=body)).status_code == 422, body
@pytest.mark.asyncio
async def test_status_is_visible_to_everyone_settings_only_to_admins_run_now_to_operators(client, respx_mock):
_mock_fw(respx_mock)
await _create_host(client, "fw1", "https://fw1.test")
for role in ("read_only", "operator"):
name = f"bk-{role}"
assert (await client.post("/api/users", json={"username": name, "password": "backup-password-1", "role": role})).status_code == 201
user = await _login(name, "backup-password-1")
try:
status = (await user.get("/api/backups/status")).json()
assert "s3_endpoint" not in status and status["interval_hours"] == 24
assert (await user.get("/api/settings/backups")).status_code == 403
assert (await user.put("/api/settings/backups", json={"keep_count": 5})).status_code == 403
assert (await user.post("/api/settings/backups/test-offsite")).status_code == 403
expected = 403 if role == "read_only" else 200
assert (await user.post("/api/backups/run")).status_code == expected
finally:
await user.aclose()
@pytest.mark.asyncio
async def test_test_offsite_reports_the_reason(client, respx_mock):
resp = await client.post("/api/settings/backups/test-offsite")
assert resp.status_code == 502 and resp.json()["detail"]["code"] == "OFFSITE_TEST_FAILED"
await _offsite_on()
respx_mock.route(url__regex=r"https://s3\.test/bk/.*").mock(return_value=httpx.Response(403))
resp = await client.post("/api/settings/backups/test-offsite")
assert resp.status_code == 502 and "403" in resp.json()["detail"]["params"]["reason"]
respx_mock.clear()
store = {}
respx_mock.put(url__regex=r"https://s3\.test/bk/.*").mock(side_effect=lambda r: store.update(v=r.content) or httpx.Response(200))
respx_mock.get(url__regex=r"https://s3\.test/bk/.*").mock(side_effect=lambda r: httpx.Response(200, content=store["v"]))
respx_mock.delete(url__regex=r"https://s3\.test/bk/.*").mock(return_value=httpx.Response(204))
assert (await client.post("/api/settings/backups/test-offsite")).json() == {"success": True}
@pytest.mark.asyncio
async def test_settings_changes_are_audited_without_secrets(client):
from app.models.audit import AuditEvent
await client.put("/api/settings/backups", json={"s3_secret_key": "LEAKME-1234"})
async with SessionLocal() as db:
rows = (await db.scalars(select(AuditEvent).where(AuditEvent.kind == "settings"))).all()
assert rows and "LEAKME" not in json.dumps([r.details for r in rows]) + "".join(r.message or "" for r in rows)
# ── config diff ──────────────────────────────────────────────────────────
def _xml(*, hostname="fw", password="p1", dns="1.1.1.1", cert="A" * 200, revision="r1", keylength="4096"):
return (f"<opnsense><revision><time>{revision}</time></revision><system><hostname>{hostname}</hostname>"
f"<user><name>root</name><password>{password}</password><apikey>KEY-{password}</apikey></user>"
f"<dnsserver>{dns}</dnsserver></system><cert><crt>{cert}</crt><keylength>{keylength}</keylength></cert></opnsense>").encode()
@pytest.mark.asyncio
async def test_diff_shows_changes_and_hides_every_secret(client):
host = await _create_host(client, "fw1", "https://fw1.test")
backup_store.save_snapshot(host["id"], _xml())
backup_store.save_snapshot(host["id"], _xml(hostname="fw-new", password="SUPERSECRET2", dns="9.9.9.9", cert="B" * 200, revision="r2", keylength="2048"))
body = (await client.get(f"/api/hosts/{host['id']}/backup-diff")).json()
text = "\n".join(body["lines"])
assert not body["identical"] and body["added"] >= 4 and body["removed"] >= 4
assert "- <hostname>fw</hostname>" in text and "+ <hostname>fw-new</hostname>" in text
assert "9.9.9.9" in text and "<keylength>2048</keylength>" in text # ordinary values stay readable
for secret in ("SUPERSECRET2", "KEY-SUPERSECRET2", "p1", "A" * 50, "B" * 50):
assert secret not in text, secret
assert "‹sha256:" in text # a changed secret is still visible as a change
assert "r1" not in text and "r2" not in text # the volatile revision block is ignored
@pytest.mark.asyncio
async def test_identical_backups_and_explicit_selection(client):
host = await _create_host(client, "fw1", "https://fw1.test")
first = backup_store.save_snapshot(host["id"], _xml(revision="r1"))
second = backup_store.save_snapshot(host["id"], _xml(revision="r2"))
assert (await client.get(f"/api/hosts/{host['id']}/backup-diff")).json()["identical"] is True
third = backup_store.save_snapshot(host["id"], _xml(dns="8.8.8.8"))
body = (await client.get(f"/api/hosts/{host['id']}/backup-diff", params={"a": first, "b": third})).json()
assert (body["a"], body["b"]) == (first, third) and not body["identical"]
assert (await client.get(f"/api/hosts/{host['id']}/backup-diff")).json()["a"] == second # default: previous vs newest
@pytest.mark.asyncio
async def test_diff_errors(client):
import uuid
assert (await client.get(f"/api/hosts/{uuid.uuid4()}/backup-diff")).status_code == 404
host = await _create_host(client, "fw1", "https://fw1.test")
assert (await client.get(f"/api/hosts/{host['id']}/backup-diff")).status_code == 404 # nothing to compare
one = backup_store.save_snapshot(host["id"], _xml())
assert (await client.get(f"/api/hosts/{host['id']}/backup-diff")).status_code == 404 # only one
bad = backup_store.save_snapshot(host["id"], b"<html>not a config</html>")
resp = await client.get(f"/api/hosts/{host['id']}/backup-diff", params={"a": one, "b": bad})
assert resp.status_code == 422 and resp.json()["detail"]["code"] == "BACKUP_UNLESBAR"
assert (await client.get(f"/api/hosts/{host['id']}/backup-diff", params={"a": "../../etc/passwd", "b": one})).status_code == 404
xxe = b'<?xml version="1.0"?><!DOCTYPE x [<!ENTITY e SYSTEM "file:///etc/passwd">]><opnsense>&e;</opnsense>'
evil = backup_store.save_snapshot(host["id"], xxe)
assert (await client.get(f"/api/hosts/{host['id']}/backup-diff", params={"a": one, "b": evil})).status_code == 422
@pytest.mark.asyncio
async def test_diff_is_capped(client):
host = await _create_host(client, "fw1", "https://fw1.test")
many = "".join(f"<dns{i}>1.1.1.{i % 250}</dns{i}>" for i in range(5000))
backup_store.save_snapshot(host["id"], f"<opnsense><system>{many}</system></opnsense>".encode())
backup_store.save_snapshot(host["id"], f"<opnsense><system>{many.replace('1.1.1', '2.2.2')}</system></opnsense>".encode())
body = (await client.get(f"/api/hosts/{host['id']}/backup-diff")).json()
assert body["truncated"] is True and len(body["lines"]) == 3000
+326
View File
@@ -0,0 +1,326 @@
"""Security posture: check logic on config.xml shapes taken from real OPNsense 26.7 installs,
the stored-result API, and the metrics that follow from it."""
from datetime import datetime, timedelta, timezone
import httpx
import pytest
from sqlalchemy import select
from app.services import compliance_service as cs
from tests.test_api_tokens import _bearer, _make
from tests.test_rules import _create_host
def _mvc_rule(*, interface="lan", action="pass", src="any", dst="any", protocol="any", descr="r", seq=1,
enabled="1", dport="", direction="in", ipprotocol="inet", quick="1", src_not="0"):
return (f"<rule><enabled>{enabled}</enabled><action>{action}</action><quick>{quick}</quick><interface>{interface}</interface>"
f"<direction>{direction}</direction><ipprotocol>{ipprotocol}</ipprotocol><protocol>{protocol}</protocol>"
f"<source_net>{src}</source_net><source_not>{src_not}</source_not><destination_net>{dst}</destination_net>"
f"<destination_not>0</destination_not><destination_port>{dport}</destination_port>"
f"<description>{descr}</description><sequence>{seq}</sequence></rule>")
def _config(*, rules="", legacy="", protocol="https", ssh="", snmpd="", timeservers="0.pool.ntp.org", syslog="",
interfaces='<wan><if>vtnet0</if></wan><lan><if>vtnet1</if></lan>', ids="0"):
return (f"<opnsense><system><webgui><protocol>{protocol}</protocol></webgui>"
f"<timeservers>{timeservers}</timeservers>{ssh}</system><interfaces>{interfaces}</interfaces>"
f"<filter>{legacy}</filter>{snmpd}<OPNsense><Firewall><Filter><rules>{rules}</rules></Filter></Firewall>"
f"<IDS><general><enabled>{ids}</enabled></general></IDS><Syslog><destinations>{syslog}</destinations></Syslog>"
f"</OPNsense></opnsense>").encode()
def _run(xml, firmware="none", backup_age=3600.0):
return {f["id"]: f for f in cs.evaluate(xml, firmware_status=firmware, newest_backup_age_s=backup_age)}
def test_clean_config_passes_everything_and_scores_100():
findings = cs.evaluate(
_config(rules=_mvc_rule(descr="lan out", src="lan"), syslog="<destination><enabled>1</enabled></destination>", ids="1"),
firmware_status="none", newest_backup_age_s=3600,
)
assert [f["id"] for f in findings if f["passed"] is False] == []
assert cs.score(findings) == 100 and cs.grade(100) == "good"
def test_wan_any_any_is_critical_and_names_the_rule():
# What the OPNexus test firewalls have: a pass-everything rule on the WAN.
by_id = _run(_config(rules=_mvc_rule(interface="wan", descr="Allow ALL")))
assert by_id["wan_any_any"]["passed"] is False and by_id["wan_any_any"]["severity"] == "critical"
assert by_id["wan_any_any"]["params"] == {"count": 1, "examples": ["Allow ALL"]}
assert cs.score(list(by_id.values())) <= 70
def test_default_lan_rule_is_not_a_finding_but_a_lan_any_source_is():
assert _run(_config(rules=_mvc_rule(src="lan", descr="Default allow LAN to any rule")))["internal_any_any"]["passed"] is True
assert _run(_config(rules=_mvc_rule(src="any", descr="open")))["internal_any_any"]["passed"] is False
def test_a_wan_rule_with_a_port_or_protocol_is_not_any_any():
for extra in ({"dport": "443"}, {"protocol": "TCP"}):
assert _run(_config(rules=_mvc_rule(interface="wan", **extra)))["wan_any_any"]["passed"] is True
def test_disabled_rules_do_not_count():
assert _run(_config(rules=_mvc_rule(interface="wan", enabled="0")))["wan_any_any"]["passed"] is True
def test_legacy_rule_format_is_understood():
legacy = ("<rule><type>pass</type><interface>wan</interface><ipprotocol>inet</ipprotocol><descr>ALLOW ANY</descr>"
"<source><any>1</any></source><destination><any/></destination></rule>")
by_id = _run(_config(legacy=legacy))
assert by_id["wan_any_any"]["passed"] is False and by_id["wan_any_any"]["params"]["examples"] == ["ALLOW ANY"]
def test_interface_with_a_gateway_counts_as_wan():
interfaces = "<opt1><if>vtnet2</if><gateway>GW1</gateway></opt1><lan><if>vtnet1</if></lan>"
assert _run(_config(interfaces=interfaces, rules=_mvc_rule(interface="opt1")))["wan_any_any"]["passed"] is False
def test_shadowed_and_duplicate_rules():
rules = (
_mvc_rule(interface="lan", src="any", dst="any", action="block", descr="block all", seq=1)
+ _mvc_rule(interface="lan", src="10.0.0.0/8", dst="any", action="pass", descr="never reached", seq=2)
+ _mvc_rule(interface="dmz", src="dmz", dst="any", descr="a", seq=3)
+ _mvc_rule(interface="dmz", src="dmz", dst="any", descr="a again", seq=4)
)
by_id = _run(_config(rules=rules))
assert by_id["rules_shadowed"]["passed"] is False and by_id["rules_shadowed"]["params"]["examples"] == ["never reached"]
assert by_id["rules_duplicate"]["passed"] is False and by_id["rules_duplicate"]["params"]["examples"] == ["a again"]
def test_coverage_is_never_claimed_without_proof():
rules = (
_mvc_rule(interface="lan", src="lan", dst="any", dport="443", seq=1, descr="https only")
+ _mvc_rule(interface="lan", src="lan", dst="any", dport="80", seq=2, descr="http")
+ _mvc_rule(interface="lan", src="lan", dst="any", seq=3, descr="everything")
+ _mvc_rule(interface="lan", src="lan", dst="any", ipprotocol="inet6", seq=4, descr="v6")
+ _mvc_rule(interface="lan", src="lan", dst="any", src_not="1", seq=5, descr="negated")
)
by_id = _run(_config(rules=rules))
assert by_id["rules_shadowed"]["passed"] is True and by_id["rules_duplicate"]["passed"] is True
def test_rules_are_ordered_by_sequence_not_file_order():
rules = _mvc_rule(src="10.0.0.0/8", descr="narrow", seq=9) + _mvc_rule(src="any", descr="broad", seq=1, action="block")
assert _run(_config(rules=rules))["rules_shadowed"]["params"]["examples"] == ["narrow"]
def test_ssh_levels():
on = "<ssh><enabled>enabled</enabled><permitrootlogin>{}</permitrootlogin><passwordauth>{}</passwordauth></ssh>"
worst = _run(_config(ssh=on.format(1, 1)))["ssh_hardened"]
assert (worst["passed"], worst["severity"]) == (False, "high")
mid = _run(_config(ssh=on.format(0, 1)))["ssh_hardened"]
assert (mid["passed"], mid["severity"]) == (False, "medium")
assert _run(_config(ssh=on.format(0, 0)))["ssh_hardened"]["passed"] is True
assert _run(_config(ssh="<ssh><permitrootlogin>1</permitrootlogin><passwordauth>1</passwordauth></ssh>"))["ssh_hardened"]["passed"] is True
assert _run(_config())["ssh_hardened"]["passed"] is True
def test_webgui_snmp_ntp_logging_ids():
assert _run(_config(protocol="http"))["webgui_https"]["passed"] is False
assert "snmp_community" not in _run(_config())
assert _run(_config(snmpd="<snmpd><rocommunity>public</rocommunity></snmpd>"))["snmp_community"]["passed"] is False
assert _run(_config(snmpd="<snmpd><rocommunity>s3cret-ro</rocommunity></snmpd>"))["snmp_community"]["passed"] is True
assert _run(_config(timeservers=""))["ntp_configured"]["passed"] is False
assert _run(_config())["remote_logging"]["passed"] is False
assert _run(_config(ids="0"))["ids_enabled"]["severity"] == "info"
def test_firmware_and_backup_inputs():
assert _run(_config(), firmware="update")["firmware_current"]["passed"] is False
assert _run(_config(), firmware=None)["firmware_current"]["passed"] is None
assert _run(_config(), backup_age=None)["backup_recent"]["passed"] is False
assert _run(_config(), backup_age=8 * 86400)["backup_recent"]["passed"] is False
assert _run(_config(), backup_age=2 * 86400)["backup_recent"]["passed"] is True
def test_unknown_results_do_not_cost_points_and_info_is_free():
findings = cs.evaluate(_config(), firmware_status=None, newest_backup_age_s=0)
failed = [f["id"] for f in findings if f["passed"] is False]
assert cs.score(findings) == 100 - sum(cs.PENALTY[f["severity"]] for f in findings if f["passed"] is False)
assert "firmware_current" not in failed and "ids_enabled" in failed and cs.PENALTY["info"] == 0
@pytest.mark.parametrize("bad", [b"", b" ", b"<html/>", b"<opnsense>", b'<!DOCTYPE x [<!ENTITY a "b">]><opnsense>&a;</opnsense>'])
def test_invalid_or_hostile_input_is_rejected(bad):
with pytest.raises(Exception):
cs.evaluate(bad, firmware_status=None, newest_backup_age_s=None)
def test_findings_carry_no_config_secrets():
xml = _config(rules=_mvc_rule(interface="wan", descr="Allow ALL")).replace(
b"<opnsense>", b"<opnsense><system2><user><password>$2y$hash</password><apikey>KEY123</apikey></user></system2>")
assert b"KEY123" not in repr(cs.evaluate(xml, firmware_status=None, newest_backup_age_s=None)).encode()
# ── API ──────────────────────────────────────────────────────────────────
def _mock_host(respx_mock, xml, firmware_status="none"):
respx_mock.get(url__regex=r".*/getVipStatus").mock(return_value=httpx.Response(200, json={"rows": []}))
respx_mock.get(url__regex=r".*/core/backup/download/this").mock(return_value=httpx.Response(200, content=xml))
respx_mock.get(url__regex=r".*/core/firmware/status").mock(return_value=httpx.Response(200, json={"status": firmware_status}))
respx_mock.get(url__regex=r".*/diagnostics/firewall/pfStatistics/rules").mock(return_value=httpx.Response(200, json={"rules": {"filter rules": {}}}))
respx_mock.get(url__regex=r".*/firewall/filter/searchRule").mock(return_value=httpx.Response(200, json={"rows": []}))
@pytest.mark.asyncio
async def test_check_stores_and_lists_the_result(client, respx_mock):
_mock_host(respx_mock, _config(rules=_mvc_rule(interface="wan", descr="Allow ALL")))
host = await _create_host(client, "fw1", "https://fw1.test")
assert (await client.get(f"/api/hosts/{host['id']}/compliance")).json()["checked_at"] is None
result = (await client.post(f"/api/hosts/{host['id']}/compliance/check")).json()
assert result["error"] is None and result["score"] < 100 and result["grade"] in ("fair", "poor")
assert result["counts"]["critical"] == 1
assert next(f for f in result["findings"] if f["id"] == "wan_any_any")["passed"] is False
stored = (await client.get(f"/api/hosts/{host['id']}/compliance")).json()
assert stored["score"] == result["score"] and stored["findings"] == result["findings"]
fleet = (await client.get("/api/compliance")).json()
assert [(h["host_name"], h["score"]) for h in fleet] == [("fw1", result["score"])] and "findings" not in fleet[0]
# Second check replaces the row instead of adding one.
await client.post(f"/api/hosts/{host['id']}/compliance/check")
assert len((await client.get("/api/compliance")).json()) == 1
@pytest.mark.asyncio
async def test_unreachable_host_is_reported_not_scored(client, respx_mock):
respx_mock.get(url__regex=r".*/getVipStatus").mock(return_value=httpx.Response(200, json={"rows": []}))
host = await _create_host(client, "fw1", "https://fw1.test")
respx_mock.get(url__regex=r".*/core/backup/download/this").mock(return_value=httpx.Response(500))
result = (await client.post(f"/api/hosts/{host['id']}/compliance/check")).json()
assert result["error"] == "unreachable" and result["score"] is None and result["grade"] is None
@pytest.mark.asyncio
async def test_garbage_config_is_reported_as_invalid(client, respx_mock):
_mock_host(respx_mock, b"<html>not a config</html>")
host = await _create_host(client, "fw1", "https://fw1.test")
assert (await client.post(f"/api/hosts/{host['id']}/compliance/check")).json()["error"] == "invalid_config"
@pytest.mark.asyncio
async def test_unknown_host_is_404_and_checks_need_write_rights(client):
import uuid
assert (await client.get(f"/api/hosts/{uuid.uuid4()}/compliance")).status_code == 404
token = await _make(client, "read")
async with _bearer(token["token"]) as api:
assert (await api.get("/api/compliance")).status_code == 200 # reading is fine
assert (await api.post("/api/compliance/check")).status_code == 403 # running a check is not
@pytest.mark.asyncio
async def test_metrics_expose_the_score(client, respx_mock):
_mock_host(respx_mock, _config(rules=_mvc_rule(interface="wan", descr="Allow ALL")))
host = await _create_host(client, "fw1", "https://fw1.test")
result = (await client.post(f"/api/hosts/{host['id']}/compliance/check")).json()
text = (await client.get("/api/metrics")).text
assert f'opnexus_host_compliance_score{{host="fw1",cluster=""}} {result["score"]}' in text
assert 'opnexus_host_compliance_findings{severity="critical",host="fw1",cluster=""} 1' in text
# ── rule usage (pf counters) ─────────────────────────────────────────────
from app.database import SessionLocal # noqa: E402
from app.models.host import OpnsenseHost # noqa: E402
from app.models.rule_hit import RuleHit # noqa: E402
from app.services import rule_hit_service as rh # noqa: E402
U1, U2, U3 = "11111111-1111-4111-8111-111111111111", "22222222-2222-4222-8222-222222222222", "33333333-3333-4333-8333-333333333333"
def _pf(**packets):
"""pfStatistics/rules shaped like the real answer: one entry per pf line, label = rule uuid."""
lines = {f'@{i} pass in quick on vtnet0 inet all flags S/SA keep state label "{u}"': {"evaluations": 10, "packets": p, "bytes": p * 100}
for i, (u, p) in enumerate(packets.items())}
lines['@99 pass out log quick on vtnet0 inet6 proto udp from fe80::/10 to any keep state label "2f2c37025cd02b5cd29fd330f8e48954"'] = {"evaluations": 5, "packets": 9, "bytes": 9}
return {"rules": {"filter rules": lines}}
def _search(*uuids, disabled=()):
rows = [{"uuid": u, "description": f"rule {u[0]}", "enabled": "0" if u in disabled else "1"} for u in uuids]
rows.append({"uuid": "autoautoauto", "description": "Default deny", "enabled": "1", "is_automatic": True})
return {"rows": rows}
def test_pf_counters_are_tied_to_rule_uuids_and_summed_over_expanded_lines():
stats = _pf(**{U1: 5})
stats["rules"]["filter rules"][f'@7 pass in quick on vtnet0 inet6 all label "{U1}"'] = {"evaluations": 2, "packets": 3, "bytes": 30}
got = rh.parse_counters(stats)
assert got[U1] == {"packets": 8, "bytes": 530, "evaluations": 12}
assert "2f2c37025cd02b5cd29fd330f8e48954" not in got # md5 labels are automatic rules, not user rules
assert rh.parse_counters({}) == {} and rh.parse_counters({"rules": None}) == {}
def test_configured_rules_skip_automatic_ones():
assert set(rh.configured_rules(_search(U1, U2, disabled=(U2,)))) == {U1, U2}
assert rh.configured_rules(_search(U1, U2, disabled=(U2,)))[U2]["enabled"] is False
async def _sample(host_id, stats, search, at):
async with SessionLocal() as db:
host = await db.get(OpnsenseHost, __import__("uuid").UUID(host_id))
from unittest.mock import AsyncMock, patch
with patch.object(rh.client, "get_pf_rule_statistics", AsyncMock(return_value=stats)), \
patch.object(rh.client, "search_rules", AsyncMock(return_value=search)):
return await rh.sample_host(db, host, now=at)
async def _rows(host_id):
async with SessionLocal() as db:
return {r.rule_uuid: r for r in (await db.scalars(select(RuleHit))).all()}
@pytest.mark.asyncio
async def test_last_hit_tracking_survives_counter_resets(client, respx_mock):
respx_mock.get(url__regex=r".*/getVipStatus").mock(return_value=httpx.Response(200, json={"rows": []}))
host = await _create_host(client, "fw1", "https://fw1.test")
day0 = datetime(2026, 1, 1, tzinfo=timezone.utc)
day = lambda n: day0 + timedelta(days=n) # noqa: E731
await _sample(host["id"], _pf(**{U1: 0, U2: 7, U3: 0}), _search(U1, U2, U3), day(0))
rows = await _rows(host["id"])
assert rows[U1].last_hit_at is None and rows[U2].last_hit_at == day(0) # already matching when first seen
await _sample(host["id"], _pf(**{U1: 0, U2: 7, U3: 4}), _search(U1, U2, U3), day(1))
rows = await _rows(host["id"])
assert rows[U2].last_hit_at == day(0) and rows[U3].last_hit_at == day(1) # U2 flat, U3 grew
# pf reloaded (counters restart): U2 is lower but above zero -> hit since the reload; U1 at zero tells nothing
await _sample(host["id"], _pf(**{U1: 0, U2: 2, U3: 0}), _search(U1, U2, U3), day(2))
rows = await _rows(host["id"])
assert rows[U2].last_hit_at == day(2) and rows[U3].last_hit_at == day(1) and rows[U1].last_hit_at is None
# a rule that disappeared from the firewall is forgotten
await _sample(host["id"], _pf(**{U1: 0, U2: 2}), _search(U1, U2), day(3))
assert set(await _rows(host["id"])) == {U1, U2}
@pytest.mark.asyncio
async def test_unused_only_after_the_observation_window(client, respx_mock):
respx_mock.get(url__regex=r".*/getVipStatus").mock(return_value=httpx.Response(200, json={"rows": []}))
host = await _create_host(client, "fw1", "https://fw1.test")
now = datetime.now(timezone.utc)
await _sample(host["id"], _pf(**{U1: 0, U2: 5}), _search(U1, U2, U3, disabled=(U3,)), now - timedelta(days=10))
async with SessionLocal() as db:
states = {r.rule_uuid: rh.classify(r, now) for r in (await db.scalars(select(RuleHit))).all()}
summary = await rh.unused_summary(db, __import__("uuid").UUID(host["id"]))
assert states == {U1: "collecting", U2: "used", U3: "disabled"}
assert summary == {"unused": [], "collecting": 1}
await _sample(host["id"], _pf(**{U1: 0, U2: 5}), _search(U1, U2, U3, disabled=(U3,)), now - timedelta(days=1))
async with SessionLocal() as db:
row = (await db.scalars(select(RuleHit).where(RuleHit.rule_uuid == U1))).one()
row.first_seen_at = now - timedelta(days=45) # watched long enough
await db.commit()
summary = await rh.unused_summary(db, __import__("uuid").UUID(host["id"]))
assert summary["unused"] == ["rule 1"]
body = (await client.get(f"/api/hosts/{host['id']}/rule-hits")).json()
assert body[0]["state"] == "unused" and body[0]["rule_uuid"] == U1 # unused rules first
def test_unused_finding_is_unknown_while_collecting_and_a_low_finding_when_found():
xml = _config()
ids = lambda f: {x["id"]: x for x in f} # noqa: E731
none_yet = ids(cs.evaluate(xml, firmware_status="none", newest_backup_age_s=1))
assert "rules_unused" not in none_yet
collecting = ids(cs.evaluate(xml, firmware_status="none", newest_backup_age_s=1, unused_rules={"unused": [], "collecting": 3}))
assert collecting["rules_unused"]["passed"] is None
clean = ids(cs.evaluate(xml, firmware_status="none", newest_backup_age_s=1, unused_rules={"unused": [], "collecting": 0}))
assert clean["rules_unused"]["passed"] is True
found = ids(cs.evaluate(xml, firmware_status="none", newest_backup_age_s=1, unused_rules={"unused": ["old vpn rule"], "collecting": 0}))
assert found["rules_unused"]["passed"] is False and found["rules_unused"]["severity"] == "low"
assert found["rules_unused"]["params"] == {"count": 1, "examples": ["old vpn rule"]}
+142
View File
@@ -0,0 +1,142 @@
"""Full OPNexus backup: round trip, integrity, refusal of hostile or newer archives."""
import io
import json
import os
import tarfile
from pathlib import Path
import pytest
from app import full_backup as fb
from app.config import settings
from app.services import backup_crypto
PASS = "full backup passphrase 1"
old_mtime = 1_700_000_000 # Nov 2023
@pytest.fixture
def data(tmp_path, monkeypatch):
"""Point every data directory at a scratch tree with recognisable content."""
for name, attr in fb._DATA_DIRS.items():
path = tmp_path / name
path.mkdir()
monkeypatch.setattr(settings, attr, str(path))
(tmp_path / "opnsense_secrets" / "host-1.secret").write_text("API-SECRET-1")
(tmp_path / "totp_secrets").joinpath("u.secret").write_text("TOTP-SECRET")
sub = tmp_path / "opnsense_backups" / "host-1"
sub.mkdir()
(sub / "20260101T000000.xml").write_text("<opnsense/>")
os.utime(sub / "20260101T000000.xml", (old_mtime, old_mtime))
return tmp_path
def _dump(path: Path) -> None:
path.write_bytes(b"PGDMP-fake-database")
def _create(**kw):
return fb.create(PASS, dump=_dump, revision="0009", **kw)
def test_roundtrip_restores_every_secret_and_the_database(data):
blob = _create()
assert b"API-SECRET-1" not in blob and b"TOTP-SECRET" not in blob and b"PGDMP" not in blob
# Wipe the data, then restore.
for f in data.rglob("*"):
if f.is_file():
f.unlink()
seen = {}
result = fb.restore(blob, PASS, restore_db=lambda p: seen.update(dump=p.read_bytes()), head="0012")
assert seen["dump"] == b"PGDMP-fake-database"
assert (data / "opnsense_secrets" / "host-1.secret").read_text() == "API-SECRET-1"
assert (data / "totp_secrets" / "u.secret").read_text() == "TOTP-SECRET"
assert (data / "opnsense_backups" / "host-1" / "20260101T000000.xml").read_text() == "<opnsense/>"
assert result["files_restored"] == 3 and result["db_revision"] == "0009"
mode = (data / "opnsense_secrets" / "host-1.secret").stat().st_mode & 0o777
assert mode == 0o600
# file times survive: stored config backups are aged by their mtime
assert abs((data / "opnsense_backups" / "host-1" / "20260101T000000.xml").stat().st_mtime - old_mtime) < 2
def test_info_shows_only_the_manifest_and_needs_the_passphrase(data):
blob = _create()
manifest = fb.info(blob, PASS)
assert manifest["format"] == 1 and manifest["db_revision"] == "0009" and "opnsense_secrets" in manifest["data"]
with pytest.raises(fb.FullBackupError, match="Passphrase"):
fb.info(blob, "wrong passphrase 123")
def test_short_passphrase_is_refused(data):
with pytest.raises(fb.FullBackupError, match="mindestens"):
fb.create("short", dump=_dump, revision="0009")
def test_tampered_or_foreign_files_are_refused(data):
blob = bytearray(_create())
blob[-5] ^= 0xFF
with pytest.raises(fb.FullBackupError):
fb.restore(bytes(blob), PASS, restore_db=lambda p: None, head="0012")
for junk in (b"", b"not a backup"):
with pytest.raises(fb.FullBackupError):
fb.restore(junk, PASS, restore_db=lambda p: None, head="0012")
# A valid encrypted file that is not a full backup (a single config backup, say).
with pytest.raises(fb.FullBackupError, match="Archiv unlesbar"):
fb.restore(backup_crypto.encrypt(b"<opnsense/>", PASS), PASS, restore_db=lambda p: None, head="0012")
def test_a_backup_from_a_newer_version_is_refused_before_anything_is_touched(data):
blob = fb.create(PASS, dump=_dump, revision="0020")
touched = []
with pytest.raises(fb.FullBackupError, match="neueren"):
fb.restore(blob, PASS, restore_db=lambda p: touched.append(p), head="0012")
assert touched == []
(data / "totp_secrets" / "u.secret").write_text("UNCHANGED")
assert (data / "totp_secrets" / "u.secret").read_text() == "UNCHANGED"
def _hostile(member_name: str, kind=tarfile.REGTYPE, link=""):
plain = io.BytesIO()
with tarfile.open(fileobj=plain, mode="w:gz") as tar:
manifest = json.dumps({"format": 1, "db_revision": "0001"}).encode()
info = tarfile.TarInfo("manifest.json"); info.size = len(manifest)
tar.addfile(info, io.BytesIO(manifest))
dump = tarfile.TarInfo("database.dump"); dump.size = 1
tar.addfile(dump, io.BytesIO(b"x"))
evil = tarfile.TarInfo(member_name); evil.type = kind; evil.linkname = link
evil.size = 4 if kind == tarfile.REGTYPE else 0
tar.addfile(evil, io.BytesIO(b"evil") if kind == tarfile.REGTYPE else None)
return backup_crypto.encrypt(plain.getvalue(), PASS)
@pytest.mark.parametrize("name,kind,link", [
("../../etc/cron.d/x", tarfile.REGTYPE, ""),
("/etc/passwd", tarfile.REGTYPE, ""),
("data/opnsense_secrets/../../escape", tarfile.REGTYPE, ""),
("data/opnsense_secrets/link", tarfile.SYMTYPE, "/etc/shadow"),
("data/opnsense_secrets/dev", tarfile.CHRTYPE, ""),
])
def test_hostile_archives_are_rejected_before_the_database_is_touched(data, name, kind, link):
touched = []
with pytest.raises(fb.FullBackupError, match="Unzulässig"):
fb.restore(_hostile(name, kind, link), PASS, restore_db=lambda p: touched.append(p), head="0012")
assert touched == [] and not (data.parent / "escape").exists()
def test_unknown_directories_in_the_archive_are_ignored(data, tmp_path):
blob = _hostile("data/not_a_known_volume/file")
fb.restore(blob, PASS, restore_db=lambda p: None, head="0012")
assert not (tmp_path / "not_a_known_volume").exists()
def test_command_line_reads_the_passphrase_from_the_environment(data, monkeypatch, capsys):
blob = _create()
monkeypatch.setenv("FULL_BACKUP_PASSPHRASE", PASS)
class _In: # sys.stdin stand-in with a binary buffer
buffer = io.BytesIO(blob)
monkeypatch.setattr("sys.stdin", _In)
assert fb._main(["full_backup", "info"]) == 0
assert '"format": 1' in capsys.readouterr().out
monkeypatch.setenv("FULL_BACKUP_PASSPHRASE", "")
assert fb._main(["full_backup", "create"]) == 1
assert fb._main(["full_backup", "bogus"]) == 2
+105
View File
@@ -0,0 +1,105 @@
"""Read-only MCP endpoint: protocol basics, tools, and that it cannot be used to escalate."""
import pytest
from tests.test_api_tokens import _bearer, _make
def _rpc(method, params=None, id_=1):
message = {"jsonrpc": "2.0", "method": method}
if id_ is not None:
message["id"] = id_
if params is not None:
message["params"] = params
return message
async def _call(api, name, **arguments):
resp = await api.post("/api/mcp", json=_rpc("tools/call", {"name": name, "arguments": arguments}))
assert resp.status_code == 200, resp.text
return resp.json()["result"]
@pytest.mark.asyncio
async def test_requires_authentication(anon_client):
assert (await anon_client.post("/api/mcp", json=_rpc("ping"))).status_code == 401
@pytest.mark.asyncio
async def test_handshake_and_tool_list_with_a_read_token(client):
token = await _make(client, "read")
async with _bearer(token["token"]) as api:
init = (await api.post("/api/mcp", json=_rpc("initialize", {"protocolVersion": "2025-06-18"}))).json()["result"]
assert init["protocolVersion"] == "2025-06-18"
assert init["serverInfo"]["name"] == "opnexus" and "tools" in init["capabilities"]
# Unknown future version: answer with one we speak.
other = (await api.post("/api/mcp", json=_rpc("initialize", {"protocolVersion": "2099-01-01"}))).json()["result"]
assert other["protocolVersion"] == "2025-06-18"
# A notification gets no body.
note = await api.post("/api/mcp", json=_rpc("notifications/initialized", id_=None))
assert note.status_code == 202 and note.content == b""
tools = (await api.post("/api/mcp", json=_rpc("tools/list"))).json()["result"]["tools"]
assert {"fleet_overview", "list_hosts", "recent_audit", "search", "api_get"} <= {t["name"] for t in tools}
assert all("inputSchema" in t and "path" not in t for t in tools)
assert (await api.post("/api/mcp", json=_rpc("ping"))).json()["result"] == {}
unknown = (await api.post("/api/mcp", json=_rpc("resources/list"))).json()
assert unknown["error"]["code"] == -32601
@pytest.mark.asyncio
async def test_get_is_405_and_bad_json_is_a_parse_error(client):
assert (await client.get("/api/mcp")).status_code == 405
bad = await client.post("/api/mcp", content=b"{nope", headers={"Content-Type": "application/json"})
assert bad.status_code == 400 and bad.json()["error"]["code"] == -32700
@pytest.mark.asyncio
async def test_tools_read_through_the_callers_own_permissions(client):
await client.post("/api/groups", json={"name": "findable-group"})
token = await _make(client, "read")
async with _bearer(token["token"]) as api:
hosts = await _call(api, "list_hosts")
assert hosts["isError"] is False and hosts["content"][0]["text"] == "[]"
found = await _call(api, "search", q="findable")
assert "findable-group" in found["content"][0]["text"]
audit = await _call(api, "recent_audit", limit=5)
assert audit["isError"] is False
overview = await _call(api, "fleet_overview")
assert "pending_actions" in overview["content"][0]["text"]
@pytest.mark.asyncio
async def test_generic_reader_cannot_reach_credentials_or_secrets_and_never_writes(client):
token = await _make(client, "read")
async with _bearer(token["token"]) as api:
for path in ("/api/tokens", "/api/auth/me", "/api/mcp", "/etc/passwd", "/api/../x", "/api/hosts?x=1", "relative"):
result = await _call(api, "api_get", path=path)
assert result["isError"] is True, path
# Secret-bearing endpoint: refused by the caller's own (read) scope, not by the tool.
denied = await _call(api, "api_get", path="/api/notifications/settings")
assert denied["isError"] is True and "API_TOKEN_SCOPE_FORBIDDEN" in denied["content"][0]["text"]
# api_get is GET-only by construction: there is no way to name another method.
tools = (await api.post("/api/mcp", json=_rpc("tools/list"))).json()["result"]["tools"]
schema = next(t for t in tools if t["name"] == "api_get")["inputSchema"]
assert set(schema["properties"]) == {"path", "query"}
@pytest.mark.asyncio
async def test_unknown_tool_and_bad_arguments_are_tool_errors(client):
token = await _make(client, "read")
async with _bearer(token["token"]) as api:
assert (await _call(api, "delete_everything"))["isError"] is True
assert (await _call(api, "host_resources"))["isError"] is True
bad = await api.post("/api/mcp", json=_rpc("tools/call", {"arguments": {}}))
assert bad.json()["error"]["code"] == -32602
@pytest.mark.asyncio
async def test_read_only_users_session_can_use_it_too(client):
resp = await client.post("/api/users", json={"username": "mcpviewer", "password": "viewer-password-123", "role": "read_only"})
assert resp.status_code == 201
from tests.test_api_tokens import _login
viewer = await _login("mcpviewer", "viewer-password-123")
try:
assert (await viewer.post("/api/mcp", json=_rpc("ping"))).status_code == 200
finally:
await viewer.aclose()
+104
View File
@@ -0,0 +1,104 @@
"""Prometheus endpoint: format, content and that it never calls a firewall."""
import re
from datetime import datetime, timedelta, timezone
import httpx
import pytest
from app.database import SessionLocal
from app.models.carp_event import CarpEvent
from app.models.notification import NotificationProblem
from app.models.resource_sample import HostResourceSample
from tests.test_api_tokens import _bearer, _make
from tests.test_rules import _create_host
_SAMPLE_LINE = re.compile(r'^[a-zA-Z_:][a-zA-Z0-9_:]*(\{([a-zA-Z_][a-zA-Z0-9_]*="([^"\\]|\\.)*"(,|(?=\})))*\})? -?\d+(\.\d+)?(e[+-]?\d+)?$')
def _parse(text: str) -> dict[str, float]:
"""name{labels} -> value, asserting the exposition grammar line by line."""
values = {}
for line in text.splitlines():
if not line or line.startswith("# HELP ") or line.startswith("# TYPE "):
continue
assert _SAMPLE_LINE.match(line), f"not valid exposition: {line!r}"
key, _, value = line.rpartition(" ")
values[key] = float(value)
return values
async def _seed(host_id: str, *, age_s: int, carp: str | None):
async with SessionLocal() as db:
db.add(HostResourceSample(
host_id=host_id, sampled_at=datetime.now(timezone.utc) - timedelta(seconds=age_s),
mem_used_pct=25.0, load_avg_1m=0.42, disk_used_pct=12.0, raw={},
))
if carp:
db.add(CarpEvent(host_id=host_id, host_name="fw1", cluster_name="ha", from_status=None, to_status=carp))
await db.commit()
@pytest.mark.asyncio
async def test_metrics_requires_auth_and_is_prometheus_text(client, anon_client):
assert (await anon_client.get("/api/metrics")).status_code == 401
resp = await client.get("/api/metrics")
assert resp.status_code == 200
assert resp.headers["content-type"].startswith("text/plain; version=0.0.4")
values = _parse(resp.text)
assert values["opnexus_hosts"] == 0
assert any(key.startswith('opnexus_info{version="') for key in values)
@pytest.mark.asyncio
async def test_host_metrics_from_stored_samples_without_calling_the_firewall(client, respx_mock):
respx_mock.get(url__regex=r".*/getVipStatus").mock(return_value=httpx.Response(200, json={"rows": []}))
host = await _create_host(client, "fw1", "https://fw1.test")
await _seed(host["id"], age_s=30, carp="MASTER")
before = len(respx_mock.calls)
values = _parse((await client.get("/api/metrics")).text)
# The scrape is DB-only: not a single request went to a firewall.
assert len(respx_mock.calls) == before
assert values["opnexus_hosts"] == 1
assert values['opnexus_host_up{host="fw1",cluster=""}'] == 1
assert values['opnexus_host_memory_used_percent{host="fw1",cluster=""}'] == 25
assert values['opnexus_host_load1{host="fw1",cluster=""}'] == 0.42
assert values['opnexus_host_disk_used_percent{host="fw1",cluster=""}'] == 12
assert values['opnexus_host_carp_master{host="fw1",cluster=""}'] == 1
@pytest.mark.asyncio
async def test_stale_sample_means_host_down_and_unknown_carp_is_omitted(client):
host = await _create_host(client, "fw1", "https://fw1.test")
await _seed(host["id"], age_s=600, carp=None)
text = (await client.get("/api/metrics")).text
values = _parse(text)
assert values['opnexus_host_up{host="fw1",cluster=""}'] == 0
assert "opnexus_host_carp_master{" not in text
@pytest.mark.asyncio
async def test_open_problems_are_counted_and_resolved_ones_are_not(client):
async with SessionLocal() as db:
db.add(NotificationProblem(problem_type="host_offline", dedup_key="a", status="open"))
db.add(NotificationProblem(problem_type="host_offline", dedup_key="b", status="open"))
db.add(NotificationProblem(problem_type="cert_expiry", dedup_key="c", status="resolved"))
await db.commit()
values = _parse((await client.get("/api/metrics")).text)
assert values['opnexus_problems_open{type="host_offline"}'] == 2
assert not any("cert_expiry" in key for key in values)
@pytest.mark.asyncio
async def test_label_values_are_escaped(client):
await _create_host(client, 'we"ird\\name', "https://fw1.test")
text = (await client.get("/api/metrics")).text
assert 'host="we\\"ird\\\\name"' in text
_parse(text)
@pytest.mark.asyncio
async def test_read_token_can_scrape(client):
created = await _make(client, "read", name="prometheus")
async with _bearer(created["token"]) as api:
resp = await api.get("/api/metrics")
assert resp.status_code == 200 and "opnexus_info" in resp.text
+344
View File
@@ -0,0 +1,344 @@
"""OIDC single sign-on against a fake identity provider (respx): the happy path and every way a forged or
confused login could succeed."""
import base64
import hashlib
import json
import time
from urllib.parse import parse_qs, urlsplit
import httpx
import jwt
import pytest
from cryptography.hazmat.primitives import serialization
from cryptography.hazmat.primitives.asymmetric import rsa
from jwt.algorithms import RSAAlgorithm
from sqlalchemy import select, update
from app.database import SessionLocal
from app.models.oidc import OidcLoginState
from app.models.user import AdminUser
from app.services import notification_secret_store, oidc_service
from tests.test_api_tokens import _login
ISSUER = "https://idp.test/realm"
CLIENT = "opnexus-client"
def _keypair(kid):
key = rsa.generate_private_key(public_exponent=65537, key_size=2048)
pem = key.private_bytes(serialization.Encoding.PEM, serialization.PrivateFormat.PKCS8, serialization.NoEncryption())
jwk = json.loads(RSAAlgorithm.to_jwk(key.public_key()))
jwk.update(kid=kid, use="sig", alg="RS256")
return pem, jwk
KEY, JWK = _keypair("k1")
OTHER_KEY, _ = _keypair("k1") # same kid, different key: a forger
@pytest.fixture(autouse=True)
async def _fresh():
oidc_service.clear_caches()
notification_secret_store.delete_secret(oidc_service.SECRET_NAME)
async with SessionLocal() as db:
await db.execute(OidcLoginState.__table__.delete())
await db.execute(AdminUser.__table__.delete().where(AdminUser.auth_source == "oidc"))
await db.commit()
yield
async def _configure(client, **extra):
body = {"enabled": True, "display_name": "Authentik", "issuer": ISSUER, "client_id": CLIENT, "client_secret": "s3cret",
"admin_group": "opnexus-admins", "operator_group": "opnexus-ops", "read_only_group": "opnexus-viewers", **extra}
resp = await client.put("/api/settings/oidc", json=body)
assert resp.status_code == 200, resp.text
def _mock_idp(respx_mock, *, userinfo=None):
respx_mock.get(f"{ISSUER}/.well-known/openid-configuration").mock(return_value=httpx.Response(200, json={
"issuer": ISSUER, "authorization_endpoint": f"{ISSUER}/auth", "token_endpoint": f"{ISSUER}/token",
"jwks_uri": f"{ISSUER}/jwks", **({"userinfo_endpoint": f"{ISSUER}/userinfo"} if userinfo else {}),
"token_endpoint_auth_methods_supported": ["client_secret_basic"]}))
respx_mock.get(f"{ISSUER}/jwks").mock(return_value=httpx.Response(200, json={"keys": [JWK]}))
if userinfo is not None:
respx_mock.get(f"{ISSUER}/userinfo").mock(return_value=httpx.Response(200, json=userinfo))
def _claims(sent_nonce, **over):
now = int(time.time())
base = {"iss": ISSUER, "aud": CLIENT, "sub": "user-1", "exp": now + 300, "iat": now, "nonce": sent_nonce,
"preferred_username": "alice", "groups": ["opnexus-admins"]}
base.update(over)
return {k: v for k, v in base.items() if v is not None}
def _id_token(claims, key=KEY, alg="RS256", kid="k1"):
return jwt.encode(claims, key, algorithm=alg, headers={"kid": kid})
async def _start(anon, respx_mock, **idp):
_mock_idp(respx_mock, **idp)
resp = await anon.get("/api/auth/oidc/start", params={"origin": "http://test"})
assert resp.status_code == 302, resp.text
location = urlsplit(resp.headers["location"])
assert f"{location.scheme}://{location.netloc}{location.path}" == f"{ISSUER}/auth"
return {k: v[0] for k, v in parse_qs(location.query).items()}
async def _callback(anon, respx_mock, query, *, claims=None, token_response=None, **token_kw):
"""Drive the callback: the fake token endpoint answers with an ID token for the nonce of this attempt."""
seen = {}
def token(request):
seen["form"] = {k: v[0] for k, v in parse_qs(request.content.decode()).items()}
seen["auth"] = request.headers.get("authorization")
if token_response is not None:
return httpx.Response(200, json=token_response)
return httpx.Response(200, json={"id_token": _id_token(claims if claims is not None else _claims(query["nonce"]), **token_kw), "access_token": "at"})
respx_mock.post(f"{ISSUER}/token").mock(side_effect=token)
resp = await anon.get("/api/auth/oidc/callback", params={"code": "abc", "state": query["state"]})
return resp, seen
def _error(resp):
assert resp.status_code == 302, resp.text
loc = resp.headers["location"]
assert loc.startswith("/login?sso_error="), loc
return loc.split("=", 1)[1]
async def _users(prefix):
async with SessionLocal() as db:
return {u.username: u for u in (await db.scalars(select(AdminUser).where(AdminUser.auth_source == "oidc"))).all()}
@pytest.mark.asyncio
async def test_login_creates_the_account_with_the_role_of_the_group_and_a_working_session(client, anon_client, respx_mock):
await _configure(client)
query = await _start(anon_client, respx_mock)
assert query["code_challenge_method"] == "S256" and query["redirect_uri"] == "http://test/api/auth/oidc/callback"
assert query["client_id"] == CLIENT and "openid" in query["scope"]
resp, seen = await _callback(anon_client, respx_mock, query)
assert resp.status_code == 302 and resp.headers["location"] == "/dashboard"
# The provider got the PKCE verifier matching the challenge, the redirect URI and the client secret (HTTP basic).
digest = base64.urlsafe_b64encode(hashlib.sha256(seen["form"]["code_verifier"].encode()).digest()).rstrip(b"=").decode()
assert digest == query["code_challenge"] and seen["form"]["redirect_uri"] == query["redirect_uri"]
assert seen["auth"] == "Basic " + base64.b64encode(f"{CLIENT}:s3cret".encode()).decode()
me = (await anon_client.get("/api/auth/me")).json()
assert me == {"authenticated": True, "username": "alice", "role": "admin"}
user = (await _users("alice"))["alice"]
assert user.auth_source == "oidc" and user.oidc_subject == f"{ISSUER}|user-1" and user.last_login_at is not None
@pytest.mark.asyncio
async def test_role_follows_the_groups_on_every_login_and_the_most_privileged_wins(client, anon_client, respx_mock):
await _configure(client)
for groups, expected in ((["opnexus-viewers"], "read_only"), (["opnexus-viewers", "opnexus-ops"], "operator"),
(["OPNEXUS-ADMINS", "x"], "admin"), (["opnexus-ops"], "operator")):
query = await _start(anon_client, respx_mock)
resp, _ = await _callback(anon_client, respx_mock, query, claims=_claims(query["nonce"], groups=groups))
assert resp.headers["location"] == "/dashboard"
assert (await _users("alice"))["alice"].role == expected, groups
assert len(await _users("alice")) == 1 # same identity, same account
@pytest.mark.asyncio
async def test_without_a_mapped_group_nobody_gets_in_and_no_account_is_created(client, anon_client, respx_mock):
await _configure(client)
for groups in ([], ["random"], None):
query = await _start(anon_client, respx_mock)
resp, _ = await _callback(anon_client, respx_mock, query, claims=_claims(query["nonce"], groups=groups))
assert _error(resp) == "no_role"
assert await _users("alice") == {}
assert (await anon_client.get("/api/auth/me")).json() == {"authenticated": False}
@pytest.mark.asyncio
async def test_groups_can_come_from_userinfo_but_only_for_the_same_subject(client, anon_client, respx_mock):
await _configure(client)
query = await _start(anon_client, respx_mock, userinfo={"sub": "user-1", "groups": ["opnexus-ops"]})
resp, _ = await _callback(anon_client, respx_mock, query, claims=_claims(query["nonce"], groups=None))
assert resp.headers["location"] == "/dashboard" and (await _users("alice"))["alice"].role == "operator"
respx_mock.clear()
query = await _start(anon_client, respx_mock, userinfo={"sub": "someone-else", "groups": ["opnexus-admins"]})
resp, _ = await _callback(anon_client, respx_mock, query, claims=_claims(query["nonce"], groups=None, sub="user-2"))
assert _error(resp) == "no_role"
@pytest.mark.asyncio
async def test_group_claim_may_be_a_string(client, anon_client, respx_mock):
await _configure(client)
query = await _start(anon_client, respx_mock)
resp, _ = await _callback(anon_client, respx_mock, query, claims=_claims(query["nonce"], groups="foo, opnexus-viewers bar"))
assert resp.headers["location"] == "/dashboard" and (await _users("alice"))["alice"].role == "read_only"
@pytest.mark.parametrize("label,over", [
("wrong audience", {"aud": "someone-elses-client"}),
("wrong issuer", {"iss": "https://evil.test/realm"}),
("expired", {"exp": int(time.time()) - 3600}),
("no expiry", {"exp": None}),
("wrong nonce", {"nonce": "not-the-one-we-sent"}),
("no nonce", {"nonce": None}),
("multi audience, wrong azp", {"aud": [CLIENT, "other"], "azp": "other"}),
])
@pytest.mark.asyncio
async def test_forged_or_confused_id_tokens_are_rejected(client, anon_client, respx_mock, label, over):
await _configure(client)
query = await _start(anon_client, respx_mock)
resp, _ = await _callback(anon_client, respx_mock, query, claims=_claims(query["nonce"], **over))
assert _error(resp) == "token", label
assert await _users("alice") == {}
@pytest.mark.asyncio
async def test_signature_attacks_are_rejected(client, anon_client, respx_mock):
await _configure(client)
public_pem = serialization.load_pem_public_key # noqa: F841 (documenting the confusion attack below)
cases = {
"signed with another key": dict(key=OTHER_KEY),
"unknown key id": dict(kid="nope"),
"alg none": None,
"hmac with the public key as secret": "hs",
}
for label, spec in cases.items():
query = await _start(anon_client, respx_mock)
claims = _claims(query["nonce"])
if spec is None:
token = jwt.encode(claims, None, algorithm="none", headers={"kid": "k1"})
elif spec == "hs":
token = jwt.encode(claims, json.dumps(JWK), algorithm="HS256", headers={"kid": "k1"})
else:
token = _id_token(claims, **spec)
resp, _ = await _callback(anon_client, respx_mock, query, token_response={"id_token": token})
assert _error(resp) == "token", label
oidc_service.clear_caches()
respx_mock.clear()
assert await _users("alice") == {}
@pytest.mark.asyncio
async def test_a_state_works_exactly_once_and_unknown_or_expired_ones_fail(client, anon_client, respx_mock):
await _configure(client)
query = await _start(anon_client, respx_mock)
first, _ = await _callback(anon_client, respx_mock, query)
assert first.headers["location"] == "/dashboard"
replay = await anon_client.get("/api/auth/oidc/callback", params={"code": "abc", "state": query["state"]})
assert _error(replay) == "state"
forged = await anon_client.get("/api/auth/oidc/callback", params={"code": "abc", "state": "made-up"})
assert _error(forged) == "state"
query = await _start(anon_client, respx_mock)
async with SessionLocal() as db:
from datetime import datetime, timedelta, timezone
await db.execute(update(OidcLoginState).values(created_at=datetime.now(timezone.utc) - timedelta(minutes=30)))
await db.commit()
expired, _ = await _callback(anon_client, respx_mock, query)
assert _error(expired) == "state"
@pytest.mark.asyncio
async def test_provider_errors_and_missing_parameters(client, anon_client, respx_mock):
await _configure(client)
query = await _start(anon_client, respx_mock)
denied = await anon_client.get("/api/auth/oidc/callback", params={"error": "access_denied", "state": query["state"]})
assert _error(denied) == "provider"
assert _error(await anon_client.get("/api/auth/oidc/callback")) == "provider"
query = await _start(anon_client, respx_mock)
respx_mock.post(f"{ISSUER}/token").mock(return_value=httpx.Response(400, json={"error": "invalid_grant"}))
bad = await anon_client.get("/api/auth/oidc/callback", params={"code": "abc", "state": query["state"]})
assert _error(bad) == "token"
@pytest.mark.asyncio
async def test_an_sso_identity_never_takes_over_a_local_account(client, anon_client, respx_mock):
await _configure(client)
query = await _start(anon_client, respx_mock)
resp, _ = await _callback(anon_client, respx_mock, query, claims=_claims(query["nonce"], preferred_username="admin", sub="evil-1"))
assert resp.headers["location"] == "/dashboard"
users = await _users("admin")
assert "admin" not in users and any(n.startswith("admin~sso") for n in users)
async with SessionLocal() as db:
local = (await db.scalars(select(AdminUser).where(AdminUser.username == "admin"))).one()
assert local.auth_source == "local" and local.oidc_subject is None and local.role == "admin"
# A second identity with the same preferred name gets yet another account.
query = await _start(anon_client, respx_mock)
await _callback(anon_client, respx_mock, query, claims=_claims(query["nonce"], preferred_username="admin", sub="evil-2"))
assert len([n for n in await _users("admin") if n.startswith("admin~sso")]) == 2
@pytest.mark.asyncio
async def test_sso_accounts_have_no_usable_password_and_cannot_be_managed_locally(client, anon_client, respx_mock):
await _configure(client)
query = await _start(anon_client, respx_mock)
await _callback(anon_client, respx_mock, query)
for password in ("", "!oidc", "alice", "!"):
resp = await anon_client.post("/api/auth/login", json={"username": "alice", "password": password or "x"})
assert resp.status_code == 401
listing = {u["username"]: u for u in (await client.get("/api/users")).json()}
uid = listing["alice"]["id"]
assert listing["alice"]["auth_source"] == "oidc"
for path, body, method in ((f"/api/users/{uid}/role", {"role": "read_only"}, "PATCH"),
(f"/api/users/{uid}/reset-password", {"new_password": "a-new-password-1"}, "POST")):
resp = await client.request(method, path, json=body)
assert resp.status_code == 409 and resp.json()["detail"]["code"] == "OIDC_MANAGED_USER"
assert (await client.delete(f"/api/users/{uid}")).status_code == 204 # deleting is fine; they can sign in again
@pytest.mark.asyncio
async def test_start_refuses_foreign_origins_and_disabled_sso(client, anon_client, respx_mock):
assert _error(await anon_client.get("/api/auth/oidc/start", params={"origin": "http://test"})) == "disabled"
await _configure(client)
_mock_idp(respx_mock)
for origin in ("http://evil.test", "http://test/path", "http://user@test", "javascript:alert(1)", "http://test?x=1"):
assert _error(await anon_client.get("/api/auth/oidc/start", params={"origin": origin})) == "disabled", origin
await client.put("/api/settings/oidc", json={"enabled": False})
assert _error(await anon_client.get("/api/auth/oidc/start", params={"origin": "http://test"})) == "disabled"
@pytest.mark.asyncio
async def test_public_config_reveals_only_the_button_text(client, anon_client):
assert (await anon_client.get("/api/auth/oidc/config")).json() == {"enabled": False, "name": None}
await _configure(client)
assert (await anon_client.get("/api/auth/oidc/config")).json() == {"enabled": True, "name": "Authentik"}
await client.put("/api/settings/oidc", json={"admin_group": "", "operator_group": "", "read_only_group": ""})
assert (await anon_client.get("/api/auth/oidc/config")).json()["enabled"] is False # no group mapping = nobody could enter
@pytest.mark.asyncio
async def test_settings_are_admin_only_hide_the_secret_and_validate(client):
await _configure(client)
got = (await client.get("/api/settings/oidc")).json()
assert got["client_secret_set"] is True and "s3cret" not in json.dumps(got)
assert notification_secret_store.read_secret(oidc_service.SECRET_NAME) == "s3cret"
assert (await client.put("/api/settings/oidc", json={"issuer": "http://idp.test"})).status_code == 422
assert (await client.put("/api/settings/oidc", json={"clear_client_secret": True})).json()["client_secret_set"] is False
for role in ("operator", "read_only"):
name = f"sso-{role}"
assert (await client.post("/api/users", json={"username": name, "password": "sso-password-123", "role": role})).status_code == 201
user = await _login(name, "sso-password-123")
try:
assert (await user.get("/api/settings/oidc")).status_code == 403
assert (await user.put("/api/settings/oidc", json={"enabled": False})).status_code == 403
assert (await user.post("/api/settings/oidc/test")).status_code == 403
finally:
await user.aclose()
@pytest.mark.asyncio
async def test_connection_test(client, respx_mock):
assert (await client.post("/api/settings/oidc/test")).status_code == 422
await _configure(client)
_mock_idp(respx_mock)
assert (await client.post("/api/settings/oidc/test")).json()["authorization_endpoint"] == f"{ISSUER}/auth"
respx_mock.clear()
respx_mock.get(f"{ISSUER}/.well-known/openid-configuration").mock(return_value=httpx.Response(200, json={"issuer": "https://other.test"}))
resp = await client.post("/api/settings/oidc/test")
assert resp.status_code == 502 and resp.json()["detail"]["code"] == "OIDC_TEST_FAILED"
@pytest.mark.asyncio
async def test_failed_callbacks_are_throttled(client, anon_client, respx_mock):
await _configure(client)
results = [_error(await anon_client.get("/api/auth/oidc/callback", params={"code": "x", "state": f"s{i}"})) for i in range(12)]
assert "throttled" in results
+170
View File
@@ -0,0 +1,170 @@
"""The operator role: rolls out and operates, but cannot change access or destinations."""
import pytest
from sqlalchemy import select
from app.database import SessionLocal
from app.models.audit import AuditEvent
from tests.test_api_tokens import _bearer, _login
PW = "operator-password-1"
async def _operator(client, name="oper"):
resp = await client.post("/api/users", json={"username": name, "password": PW, "role": "operator"})
assert resp.status_code == 201, resp.text
assert resp.json()["role"] == "operator"
return await _login(name, PW)
@pytest.mark.asyncio
async def test_operator_can_deploy_but_not_manage_access(client):
op = await _operator(client)
try:
assert (await op.post("/api/groups", json={"name": "ops-group"})).status_code == 201
for method, path, body in [
("POST", "/api/users", {"username": "x", "password": "x" * 12, "role": "admin"}),
("PATCH", "/api/users/00000000-0000-0000-0000-000000000000/role", {"role": "admin"}),
("POST", "/api/hosts", {}),
("PUT", "/api/notifications/settings", {}),
("POST", "/api/system/updater/update", {}),
]:
resp = await op.request(method, path, json=body)
assert resp.status_code == 403, (path, resp.text)
assert resp.json()["detail"]["code"] == "ADMIN_REQUIRED"
finally:
await op.aclose()
@pytest.mark.asyncio
async def test_operator_keeps_self_service(client):
op = await _operator(client, "selfserve")
try:
assert (await op.put("/api/settings", json={"theme": "dark"})).status_code == 200
resp = await op.post("/api/auth/change-password", json={"current_password": PW, "new_password": "another-password-1"})
assert resp.status_code == 200, resp.text
assert (await op.get("/api/users")).status_code == 200
finally:
await op.aclose()
@pytest.mark.asyncio
async def test_operator_tokens_are_capped_at_deploy_and_inherit_the_limits(client):
op = await _operator(client, "tokop")
try:
denied = await op.post("/api/tokens", json={"name": "a", "scope": "admin", "current_password": PW})
assert denied.status_code == 403 and denied.json()["detail"]["code"] == "API_TOKEN_SCOPE_TOO_HIGH"
made = await op.post("/api/tokens", json={"name": "ci", "scope": "deploy", "current_password": PW})
assert made.status_code == 201, made.text
finally:
await op.aclose()
async with _bearer(made.json()["token"]) as api:
assert (await api.post("/api/groups", json={"name": "from-op-token"})).status_code == 201
assert (await api.post("/api/users", json={"username": "y", "password": "y" * 12})).status_code == 403
@pytest.mark.asyncio
async def test_operator_cannot_download_raw_backups(client, respx_mock):
import httpx
from tests.test_rules import _create_host
respx_mock.get(url__regex=r".*/getVipStatus").mock(return_value=httpx.Response(200, json={"rows": []}))
host = await _create_host(client, "fw1", "https://fw1.test")
op = await _operator(client, "nobackup")
try:
resp = await op.get(f"/api/hosts/{host['id']}/backups/anything.xml")
assert resp.status_code == 403
finally:
await op.aclose()
@pytest.mark.asyncio
async def test_refused_operator_writes_are_audited(client):
op = await _operator(client, "audited")
try:
await op.post("/api/users", json={"username": "z", "password": "z" * 12})
finally:
await op.aclose()
async with SessionLocal() as db:
rows = (await db.scalars(select(AuditEvent).where(AuditEvent.actor == "audited", AuditEvent.status == "denied"))).all()
assert rows and rows[0].kind == "user"
@pytest.mark.asyncio
async def test_demoting_an_admin_to_operator_takes_effect_at_once(client):
resp = await client.post("/api/users", json={"username": "wasadmin", "password": PW, "role": "admin"})
uid = resp.json()["id"]
user = await _login("wasadmin", PW)
try:
assert (await user.post("/api/groups", json={"name": "g1"})).status_code == 201
assert (await client.patch(f"/api/users/{uid}/role", json={"role": "operator"})).status_code == 200
assert (await user.post("/api/users", json={"username": "w", "password": "w" * 12})).status_code == 403
finally:
await user.aclose()
# ── separation of duties ─────────────────────────────────────────────────
@pytest.mark.parametrize("method,path,rollout", [
("POST", "/api/rules/abc/deploy", True),
("POST", "/api/aliases/abc/deploy", True),
("POST", "/api/port-forward/abc/deploy", True),
("POST", "/api/rules/abc/deployments/def/remove", True),
("POST", "/api/rules/abc/deployments/def/retry-rollback", True),
("POST", "/api/hosts/abc/maintenance/execute", True),
("POST", "/api/hosts/abc/maintenance/carp-execute", True),
("POST", "/api/hosts/abc/maintenance/schedule", True),
("POST", "/api/hosts/abc/network/changes", True),
("POST", "/api/rules/abc/preview", False),
("POST", "/api/rules", False),
("PUT", "/api/rules/abc", False),
("POST", "/api/rules/abc/confirm", False),
("GET", "/api/rules/abc/deploy", False),
("POST", "/api/hosts/abc/network/changes/preview", False),
])
def test_what_counts_as_a_rollout(method, path, rollout):
from app.services import api_token_service
assert api_token_service.is_rollout(method, path) is rollout
@pytest.mark.asyncio
async def test_with_separation_of_duties_operators_prepare_but_only_admins_deploy(client):
op = await _operator(client, "dutyop")
try:
assert (await op.get("/api/settings/governance")).json() == {"operators_may_deploy": True}
assert (await op.put("/api/settings/governance", json={"operators_may_deploy": False})).status_code == 403
assert (await client.put("/api/settings/governance", json={"operators_may_deploy": False})).json() == {"operators_may_deploy": False}
# Preparing still works ...
assert (await op.post("/api/groups", json={"name": "prepared"})).status_code == 201
# ... rolling out does not, whatever the target (the 403 comes before any lookup).
for path in ("/api/rules/00000000-0000-0000-0000-000000000000/deploy", "/api/hosts/00000000-0000-0000-0000-000000000000/maintenance/execute"):
resp = await op.post(path, json={})
assert resp.status_code == 403 and resp.json()["detail"]["code"] == "DEPLOY_NEEDS_ADMIN", path
# An admin is not affected (404 = got past the gate and looked for the rule).
assert (await client.post("/api/rules/00000000-0000-0000-0000-000000000000/deploy", json={})).status_code in (404, 422)
# Switching it back lets the operator through the gate again.
await client.put("/api/settings/governance", json={"operators_may_deploy": True})
assert (await op.post("/api/rules/00000000-0000-0000-0000-000000000000/deploy", json={})).status_code in (404, 422)
finally:
await op.aclose()
await client.put("/api/settings/governance", json={"operators_may_deploy": True})
@pytest.mark.asyncio
async def test_the_refusal_is_audited_and_covers_operator_tokens(client):
from sqlalchemy import select
from app.database import SessionLocal
from app.models.audit import AuditEvent
op = await _operator(client, "dutytok")
try:
token = (await op.post("/api/tokens", json={"name": "ci", "scope": "deploy", "current_password": PW})).json()["token"]
finally:
await op.aclose()
await client.put("/api/settings/governance", json={"operators_may_deploy": False})
try:
async with _bearer(token) as api:
resp = await api.post("/api/rules/00000000-0000-0000-0000-000000000000/deploy", json={})
assert resp.status_code == 403 and resp.json()["detail"]["code"] == "DEPLOY_NEEDS_ADMIN"
finally:
await client.put("/api/settings/governance", json={"operators_may_deploy": True})
async with SessionLocal() as db:
rows = (await db.scalars(select(AuditEvent).where(AuditEvent.status == "denied", AuditEvent.actor.like("dutytok%")))).all()
assert rows and rows[0].kind == "rule" and "dutytok (API: ci)" in {r.actor for r in rows}
+439
View File
@@ -0,0 +1,439 @@
"""Management overlay: keys, addressing, hub config, the hub's proxy, and routing requests through it."""
import asyncio
import ipaddress
import json
import os
import ssl
import tempfile
import time
from datetime import datetime, timedelta, timezone
from pathlib import Path
import pytest
from cryptography import x509
from cryptography.hazmat.primitives import hashes, serialization
from cryptography.hazmat.primitives.asymmetric import rsa
from cryptography.x509.oid import NameOID
from app.config import settings
from app.overlay_hub import Hub, parse_dump, wg_conf
from app.services import overlay_service as svc
from tests.test_api_tokens import _login
@pytest.fixture(autouse=True)
def _clean_overlay():
root = Path(settings.overlay_dir)
if root.exists():
for f in root.iterdir():
f.unlink()
svc._active_network = None
yield
svc._active_network = None
# ── keys and addresses ───────────────────────────────────────────────────
def test_keys_are_valid_wireguard_keys_and_the_hub_key_is_stable():
private = svc.generate_private_key()
public = svc.public_from_private(private)
assert svc.valid_public_key(public) and len(public) == 44 and public != private
assert svc.hub_public_key() == svc.hub_public_key()
assert oct((Path(settings.overlay_dir) / "hub.key").stat().st_mode & 0o777) == "0o600"
# RFC 7748 section 6.1 vector (Alice): the standard X25519 public key for a given private key
alice_priv = bytes.fromhex("77076d0a7318a57d3c16c17251b26645df4c2f87ebc0992ab177fba51db92c2a")
import base64
assert svc.public_from_private(base64.b64encode(alice_priv).decode()) == base64.b64encode(
bytes.fromhex("8520f0098930a754748b7ddcb43ef75a0dbf3a0d26381af4eba4a98eaa9b4e6a")).decode()
@pytest.mark.parametrize("value,ok", [
("A" * 43 + "=", True), ("", False), ("short", False), ("A" * 44, False), ("A" * 42 + "==", False), ("!" * 43 + "=", False),
])
def test_public_key_validation(value, ok):
assert svc.valid_public_key(value) is ok
def test_subnets():
assert str(svc.parse_subnet("10.99.0.0/24")) == "10.99.0.0/24"
for bad in ("8.8.8.0/24", "10.99.0.5/24", "10.0.0.0/8", "10.99.0.0/30", "fd00::/64", "nonsense", ""):
with pytest.raises(svc.OverlayError):
svc.parse_subnet(bad)
def test_allocation_skips_the_hub_and_taken_addresses_and_runs_out():
net = svc.parse_subnet("10.99.0.0/29") # .1 hub, .2-.6 usable
assert str(svc.hub_address(net)) == "10.99.0.1"
taken: set[str] = set()
for expected in ("10.99.0.2", "10.99.0.3", "10.99.0.4", "10.99.0.5", "10.99.0.6"):
ip = svc.next_free_ip(net, taken)
assert ip == expected
taken.add(ip)
with pytest.raises(svc.OverlayError):
svc.next_free_ip(net, taken)
taken.discard("10.99.0.3")
assert svc.next_free_ip(net, taken) == "10.99.0.3" # reuses holes
def test_proxy_routing_decision():
svc._active_network = ipaddress.ip_network("10.99.0.0/24")
assert svc.proxy_for("https://10.99.0.2") == settings.overlay_proxy_url
assert svc.proxy_for("https://10.99.0.2:8443/x") == settings.overlay_proxy_url
for direct in ("https://10.98.0.2", "https://fw.example.com", "https://[fd00::1]", "not a url", "https://"):
assert svc.proxy_for(direct) is None
svc._active_network = None
assert svc.proxy_for("https://10.99.0.2") is None
# ── API ──────────────────────────────────────────────────────────────────
async def _enable(client, **extra):
resp = await client.put("/api/overlay/settings", json={"enabled": True, "endpoint": "vpn.example.com", **extra})
assert resp.status_code == 200, resp.text
return resp.json()
def _hub_json():
return json.loads((Path(settings.overlay_dir) / "hub.json").read_text())
@pytest.mark.asyncio
async def test_enabling_needs_an_endpoint_and_writes_the_hub_config(client):
assert (await client.put("/api/overlay/settings", json={"enabled": True})).status_code == 422
body = await _enable(client)
assert body["enabled"] and body["hub_public_key"] == svc.hub_public_key() and body["hub_address"] == "10.99.0.1"
assert body["hub_state"] == "absent" # no hub container reporting
config = _hub_json()
assert config["enabled"] and config["address"] == "10.99.0.1/24" and config["listen_port"] == 51820 and config["peers"] == []
assert config["private_key"] == svc.hub_private_key()
assert svc._active_network == ipaddress.ip_network("10.99.0.0/24")
assert oct((Path(settings.overlay_dir) / "hub.json").stat().st_mode & 0o777) == "0o600"
await client.put("/api/overlay/settings", json={"enabled": False})
off = _hub_json()
assert off["enabled"] is False and off["private_key"] is None and off["peers"] == [] and svc._active_network is None
@pytest.mark.asyncio
async def test_peer_lifecycle_and_hub_config(client):
await _enable(client, listen_port=51999)
created = (await client.post("/api/overlay/peers", json={"name": "branch-1"})).json()
assert created["ip"] == "10.99.0.2"
ins = created["instructions"]
assert ins["tunnel_address"] == "10.99.0.2/32" and ins["allowed_ips"] == "10.99.0.1/32" and ins["endpoint"] == "vpn.example.com:51999"
assert ins["host_url"] == "https://10.99.0.2" and ins["keepalive"] == 25 and svc.valid_public_key(ins["hub_public_key"]) and ins["psk"]
again = (await client.get(f"/api/overlay/peers/{created['id']}/instructions")).json()
assert again["psk"] == ins["psk"] # stable, so the admin can look it up again
second = (await client.post("/api/overlay/peers", json={"name": "branch-2"})).json()
assert second["ip"] == "10.99.0.3" and second["instructions"]["psk"] != ins["psk"]
assert (await client.post("/api/overlay/peers", json={"name": "branch-1"})).status_code == 409
# A peer without a public key is not in the hub config yet.
assert _hub_json()["peers"] == []
key = svc.public_from_private(svc.generate_private_key())
assert (await client.patch(f"/api/overlay/peers/{created['id']}", json={"public_key": key})).status_code == 200
peers = _hub_json()["peers"]
assert peers == [{"public_key": key, "psk": ins["psk"], "ip": "10.99.0.2"}]
# Deleting removes it from the config and the PSK from disk.
assert (await client.delete(f"/api/overlay/peers/{created['id']}")).status_code == 204
assert _hub_json()["peers"] == [] and not (Path(settings.overlay_dir) / f"psk-{created['id']}").exists()
assert (await client.delete(f"/api/overlay/peers/{created['id']}")).status_code == 404
# The freed address is reused.
assert (await client.post("/api/overlay/peers", json={"name": "branch-3"})).json()["ip"] == "10.99.0.2"
@pytest.mark.asyncio
async def test_peer_key_validation_and_host_link(client, respx_mock):
import httpx
from tests.test_rules import _create_host
await _enable(client)
peer = (await client.post("/api/overlay/peers", json={"name": "p"})).json()
other = (await client.post("/api/overlay/peers", json={"name": "q"})).json()
for bad in ("nonsense", "A" * 44, svc.hub_public_key()):
assert (await client.patch(f"/api/overlay/peers/{peer['id']}", json={"public_key": bad})).status_code == 422, bad
good = svc.public_from_private(svc.generate_private_key())
assert (await client.patch(f"/api/overlay/peers/{peer['id']}", json={"public_key": good})).status_code == 200
assert (await client.patch(f"/api/overlay/peers/{other['id']}", json={"public_key": good})).status_code == 409 # one key, one peer
respx_mock.get(url__regex=r".*/getVipStatus").mock(return_value=httpx.Response(200, json={"rows": []}))
host = await _create_host(client, "fw1", "https://fw1.test")
assert (await client.patch(f"/api/overlay/peers/{peer['id']}", json={"host_id": host["id"]})).status_code == 200
listing = (await client.get("/api/overlay")).json()["peers"]
assert next(p for p in listing if p["id"] == peer["id"])["host_name"] == "fw1"
import uuid
assert (await client.patch(f"/api/overlay/peers/{peer['id']}", json={"host_id": str(uuid.uuid4())})).status_code == 404
assert (await client.patch(f"/api/overlay/peers/{peer['id']}", json={"clear_host": True})).status_code == 200
assert (await client.patch(f"/api/overlay/peers/{peer['id']}", json={"public_key": ""})).status_code == 200 # clearing is allowed
assert _hub_json()["peers"] == []
@pytest.mark.asyncio
async def test_subnet_changes_only_without_peers(client):
await _enable(client)
assert (await client.put("/api/overlay/settings", json={"subnet": "172.30.5.0/24"})).json()["hub_address"] == "172.30.5.1"
assert (await client.put("/api/overlay/settings", json={"subnet": "8.8.8.0/24"})).status_code == 422
peer = (await client.post("/api/overlay/peers", json={"name": "x"})).json()
assert peer["ip"] == "172.30.5.2"
resp = await client.put("/api/overlay/settings", json={"subnet": "10.50.0.0/24"})
assert resp.status_code == 409 and resp.json()["detail"]["code"] == "OVERLAY_SUBNET_LOCKED"
assert (await client.put("/api/overlay/settings", json={"subnet": "172.30.5.0/24"})).status_code == 200 # same value is no change
@pytest.mark.asyncio
async def test_live_status_from_the_hubs_report(client):
await _enable(client)
key = svc.public_from_private(svc.generate_private_key())
peer = (await client.post("/api/overlay/peers", json={"name": "p"})).json()
await client.patch(f"/api/overlay/peers/{peer['id']}", json={"public_key": key})
status_file = Path(settings.overlay_dir) / "status.json"
now = time.time()
status_file.write_text(json.dumps({"updated_at": now, "up": True, "error": None,
"peers": [{"public_key": key, "endpoint": "203.0.113.9:4000", "handshake_at": int(now) - 30, "rx": 1000, "tx": 2000}]}))
data = (await client.get("/api/overlay")).json()
assert data["settings"]["hub_state"] == "running"
p = data["peers"][0]
assert p["connected"] is True and p["rx_bytes"] == 1000 and p["tx_bytes"] == 2000 and p["remote_endpoint"] == "203.0.113.9:4000"
status_file.write_text(json.dumps({"updated_at": now, "up": True, "peers": [{"public_key": key, "handshake_at": int(now) - 900, "rx": 1, "tx": 1}]}))
assert (await client.get("/api/overlay")).json()["peers"][0]["connected"] is False # handshake too old
status_file.write_text(json.dumps({"updated_at": now - 600, "up": True, "peers": [{"public_key": key, "handshake_at": int(now), "rx": 1, "tx": 1}]}))
data = (await client.get("/api/overlay")).json()
assert data["settings"]["hub_state"] == "stale" and data["peers"][0]["connected"] is False # hub stopped reporting
status_file.write_text("not json")
assert (await client.get("/api/overlay")).json()["settings"]["hub_state"] == "absent"
@pytest.mark.asyncio
async def test_only_admins_write_or_read_the_psk(client):
await _enable(client)
peer = (await client.post("/api/overlay/peers", json={"name": "p"})).json()
for role in ("operator", "read_only"):
name = f"ov-{role}"
assert (await client.post("/api/users", json={"username": name, "password": "overlay-password-1", "role": role})).status_code == 201
user = await _login(name, "overlay-password-1")
try:
assert (await user.get("/api/overlay")).status_code == 200 # status is for everybody ...
assert "psk" not in (await user.get("/api/overlay")).text
assert (await user.get(f"/api/overlay/peers/{peer['id']}/instructions")).status_code == 403 # ... the pre-shared key is not
for method, path, body in (("PUT", "/api/overlay/settings", {"enabled": False}), ("POST", "/api/overlay/peers", {"name": "z"}),
("PATCH", f"/api/overlay/peers/{peer['id']}", {"clear_host": True}), ("DELETE", f"/api/overlay/peers/{peer['id']}", None)):
assert (await user.request(method, path, json=body)).status_code == 403, (role, path)
finally:
await user.aclose()
# ── the hub ──────────────────────────────────────────────────────────────
def test_wg_config_and_dump_parsing():
conf = wg_conf({"private_key": "PRIV", "listen_port": 51820, "peers": [{"public_key": "PUB1", "psk": "PSK1", "ip": "10.99.0.2"}]})
assert conf == "[Interface]\nPrivateKey = PRIV\nListenPort = 51820\n\n[Peer]\nPublicKey = PUB1\nPresharedKey = PSK1\nAllowedIPs = 10.99.0.2/32\n"
dump = "hubpriv\thubpub\t51820\toff\n" + "PUB1\tpsk\t198.51.100.7:5000\t10.99.0.2/32\t1700000000\t111\t222\t25\n" + "PUB2\tpsk\t(none)\t10.99.0.3/32\t0\t0\t0\t25\n"
assert parse_dump(dump) == [
{"public_key": "PUB1", "endpoint": "198.51.100.7:5000", "handshake_at": 1700000000, "rx": 111, "tx": 222},
{"public_key": "PUB2", "endpoint": None, "handshake_at": 0, "rx": 0, "tx": 0}]
assert parse_dump("only-interface-line") == []
class _FakeRunner:
def __init__(self, existing=False, fail=None):
self.calls, self.existing, self.fail = [], existing, fail
def __call__(self, *cmd, stdin=None):
self.calls.append(cmd)
if cmd[:3] == ("ip", "link", "show"):
return (0 if self.existing else 1), ""
if cmd[:2] == ("iptables", "-C"):
return 1, ""
if self.fail and cmd[0] == self.fail:
return 1, "boom"
if cmd[:2] == ("wg", "show"):
return 0, "hubpriv\thubpub\t51820\toff\nPUB1\tpsk\t(none)\t10.99.0.2/32\t0\t0\t0\t25\n"
return 0, ""
def _config(**over):
return {"enabled": True, "address": "10.99.0.1/24", "subnet": "10.99.0.0/24", "listen_port": 51820, "private_key": "PRIV",
"peers": [{"public_key": "PUB1", "psk": "PSK1", "ip": "10.99.0.2"}], **over}
def test_hub_applies_the_interface_peers_and_the_inbound_drop_rule(tmp_path):
runner = _FakeRunner()
hub = Hub(tmp_path, runner)
assert hub.apply(_config()) is None
cmds = [c[:3] for c in runner.calls]
assert ("ip", "link", "add") in cmds and ("ip", "address", "replace") in cmds and ("wg", "syncconf", "wg0") in cmds
assert any(c[0] == "iptables" and c[1] == "-I" and "-i" in c and "NEW" in c and c[-1] == "DROP" for c in runner.calls)
assert not list(tmp_path.glob(".wg0.conf")) # the private key file does not linger
assert hub.subnet == ipaddress.ip_network("10.99.0.0/24")
# An existing interface is reused, not re-created.
runner2 = _FakeRunner(existing=True)
Hub(tmp_path, runner2).apply(_config())
assert ("ip", "link", "add", "wg0", "type", "wireguard") not in runner2.calls
def test_hub_takes_the_interface_down_when_disabled_and_reports_errors(tmp_path):
runner = _FakeRunner(existing=True)
hub = Hub(tmp_path, runner)
assert hub.apply(_config(enabled=False)) is None and ("ip", "link", "del", "wg0") in runner.calls and hub.subnet is None
failing = Hub(tmp_path, _FakeRunner(fail="wg"))
assert "wg syncconf" in failing.apply(_config())
assert "ip link add" in (Hub(tmp_path, _FakeRunner(fail="ip")).apply(_config()) or "")
def test_hub_tick_applies_on_change_and_reports_status(tmp_path):
runner = _FakeRunner()
hub = Hub(tmp_path, runner)
assert hub.tick(None) is None # no config yet: still reports
status = json.loads((tmp_path / "status.json").read_text())
assert status["up"] is True and status["peers"][0]["public_key"] == "PUB1" and abs(status["updated_at"] - time.time()) < 5
(tmp_path / "hub.json").write_text(json.dumps(_config()))
hub.tick(None)
applied = len([c for c in runner.calls if c[:2] == ("wg", "syncconf")])
assert applied == 1
hub.tick(None)
assert len([c for c in runner.calls if c[:2] == ("wg", "syncconf")]) == 1 # unchanged file: no re-apply
os.utime(tmp_path / "hub.json", (time.time() + 10, time.time() + 10))
hub.tick(None)
assert len([c for c in runner.calls if c[:2] == ("wg", "syncconf")]) == 2
async def _serve_echo(prefix=b"echo:"):
async def handle(reader, writer):
while data := await reader.read(1024):
writer.write(prefix + data)
await writer.drain()
writer.close()
server = await asyncio.start_server(handle, "127.0.0.1", 0)
return server, server.sockets[0].getsockname()[1]
async def _proxy(subnet="127.0.0.0/8"):
hub = Hub(Path(tempfile.mkdtemp()), _FakeRunner())
hub.subnet = ipaddress.ip_network(subnet)
server = await asyncio.start_server(hub.handle_client, "127.0.0.1", 0)
return server, server.sockets[0].getsockname()[1]
async def _connect(proxy_port, target):
reader, writer = await asyncio.open_connection("127.0.0.1", proxy_port)
writer.write(f"CONNECT {target} HTTP/1.1\r\nHost: {target}\r\n\r\n".encode())
await writer.drain()
return reader, writer, await asyncio.wait_for(reader.readuntil(b"\r\n\r\n"), 5)
@pytest.mark.asyncio
async def test_proxy_relays_connections_into_the_overlay_subnet():
echo, echo_port = await _serve_echo()
proxy, proxy_port = await _proxy()
try:
reader, writer, head = await _connect(proxy_port, f"127.0.0.1:{echo_port}")
assert head.startswith(b"HTTP/1.1 200")
writer.write(b"hello")
await writer.drain()
assert await asyncio.wait_for(reader.readexactly(10), 5) == b"echo:hello"
writer.close()
finally:
proxy.close(); echo.close()
@pytest.mark.asyncio
async def test_proxy_is_not_an_open_proxy():
echo, echo_port = await _serve_echo()
proxy, proxy_port = await _proxy(subnet="10.99.0.0/24") # loopback is outside this overlay
try:
for target in (f"127.0.0.1:{echo_port}", "8.8.8.8:443", "example.com:443", "10.99.0.2:0", "10.99.0.2:99999", "10.99.0.2:abc", "nonsense"):
_, writer, head = await _connect(proxy_port, target)
assert head.startswith(b"HTTP/1.1 403"), target
writer.close()
reader, writer = await asyncio.open_connection("127.0.0.1", proxy_port)
writer.write(b"GET http://10.99.0.2/ HTTP/1.1\r\nHost: 10.99.0.2\r\n\r\n") # plain proxying is not offered either
assert (await asyncio.wait_for(reader.readuntil(b"\r\n\r\n"), 5)).startswith(b"HTTP/1.1 403")
writer.close()
finally:
proxy.close(); echo.close()
@pytest.mark.asyncio
async def test_proxy_reports_unreachable_firewalls_and_survives_garbage():
proxy, proxy_port = await _proxy()
free = socket_free_port()
try:
_, writer, head = await _connect(proxy_port, f"127.0.0.1:{free}")
assert head.startswith(b"HTTP/1.1 502")
writer.close()
reader, writer = await asyncio.open_connection("127.0.0.1", proxy_port)
writer.write(b"\x00\xff" * 100 + b"\r\n\r\n")
await writer.drain()
await asyncio.sleep(0.2)
writer.close()
_, writer, head = await _connect(proxy_port, f"127.0.0.1:{free}") # still serving
assert head.startswith(b"HTTP/1.1 502")
writer.close()
finally:
proxy.close()
def socket_free_port() -> int:
import socket
with socket.socket() as s:
s.bind(("127.0.0.1", 0))
return s.getsockname()[1]
# ── requests to overlay firewalls go through the proxy ───────────────────
def test_clients_for_overlay_hosts_use_the_proxy_and_others_do_not(monkeypatch):
from app.models.host import OpnsenseHost
from app.services import opnsense_client, opnsense_secret_store
import uuid
monkeypatch.setattr(opnsense_secret_store, "read_secret", lambda host_id: "secret")
svc._active_network = ipaddress.ip_network("10.99.0.0/24")
overlay = OpnsenseHost(id=uuid.uuid4(), name="o", base_url="https://10.99.0.2", api_key="k", verify_tls=False)
direct = OpnsenseHost(id=uuid.uuid4(), name="d", base_url="https://10.10.10.2", api_key="k", verify_tls=False)
assert opnsense_client._client(overlay)._mounts, "the overlay client must have a proxy mount"
assert not opnsense_client._client(direct)._mounts
def _self_signed(cn="fw.test"):
key = rsa.generate_private_key(public_exponent=65537, key_size=2048)
name = x509.Name([x509.NameAttribute(NameOID.COMMON_NAME, cn)])
cert = (x509.CertificateBuilder().subject_name(name).issuer_name(name).public_key(key.public_key()).serial_number(x509.random_serial_number())
.not_valid_before(datetime.now(timezone.utc) - timedelta(days=1)).not_valid_after(datetime.now(timezone.utc) + timedelta(days=30))
.sign(key, hashes.SHA256()))
return cert, key
@pytest.mark.asyncio
async def test_tls_probe_and_pin_check_work_through_the_proxy(tmp_path, monkeypatch):
from app.services import tls_pin_service
cert, key = _self_signed()
(tmp_path / "c.pem").write_bytes(cert.public_bytes(serialization.Encoding.PEM))
(tmp_path / "k.pem").write_bytes(key.private_bytes(serialization.Encoding.PEM, serialization.PrivateFormat.PKCS8, serialization.NoEncryption()))
ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
ctx.load_cert_chain(tmp_path / "c.pem", tmp_path / "k.pem")
fw = await asyncio.start_server(lambda r, w: w.close(), "127.0.0.1", 0, ssl=ctx)
fw_port = fw.sockets[0].getsockname()[1]
proxy, proxy_port = await _proxy()
monkeypatch.setattr(settings, "overlay_proxy_url", f"http://127.0.0.1:{proxy_port}")
svc._active_network = ipaddress.ip_network("127.0.0.0/8")
try:
info = await tls_pin_service.probe(f"https://127.0.0.1:{fw_port}")
assert info["pem"].startswith("-----BEGIN CERTIFICATE-----")
await tls_pin_service.verify_matches(f"https://127.0.0.1:{fw_port}", info["pem"])
other, _ = _self_signed("someone-else")
with pytest.raises(tls_pin_service.TlsPinError):
await tls_pin_service.verify_matches(f"https://127.0.0.1:{fw_port}", other.public_bytes(serialization.Encoding.PEM).decode())
# The proxy refusing (target outside the overlay) surfaces as a connection error, not a hang.
svc._active_network = ipaddress.ip_network("127.0.0.0/8")
hub_only = await _proxy(subnet="10.99.0.0/24")
monkeypatch.setattr(settings, "overlay_proxy_url", f"http://127.0.0.1:{hub_only[1]}")
with pytest.raises(tls_pin_service.TlsPinError):
await tls_pin_service.probe(f"https://127.0.0.1:{fw_port}")
hub_only[0].close()
finally:
proxy.close(); fw.close()
@pytest.mark.asyncio
async def test_a_dead_proxy_is_a_clean_error(monkeypatch):
from app.services import tls_pin_service
monkeypatch.setattr(settings, "overlay_proxy_url", f"http://127.0.0.1:{socket_free_port()}")
svc._active_network = ipaddress.ip_network("10.99.0.0/24")
with pytest.raises(tls_pin_service.TlsPinError):
await tls_pin_service.probe("https://10.99.0.2")
+335
View File
@@ -0,0 +1,335 @@
"""Scheduled maintenance with the opt-in CARP handover: MASTER -> maintenance -> partner MASTER ->
action -> node back -> leave maintenance. A tiny fake cluster stands in for the two firewalls."""
import uuid
from datetime import datetime, timedelta, timezone
import httpx
import pytest
from sqlalchemy import select
from app.database import SessionLocal
from app.models import HostOperation
from app.models.scheduled_maintenance import ScheduledMaintenance
from app.services import backup_store, scheduled_maintenance_service as svc
from tests.test_rules import _create_host
A, B = "https://fw-a.test", "https://fw-b.test"
class FakeCluster:
"""fw-a is the node being maintained (MASTER), fw-b the partner."""
def __init__(self, respx_mock, *, toggle_flips=True, partner_follows=True, toggle_error=None, firmware="update"):
self.mock = respx_mock
self.roles = {A: {"role": "MASTER", "maintenance": False}, B: {"role": "BACKUP", "maintenance": False}}
self.job = "ready" # what fw-a's firmware/running reports: ready | running | down
self.toggle_flips, self.partner_follows, self.toggle_error, self.firmware = toggle_flips, partner_follows, toggle_error, firmware
self.toggles = respx_mock.post(f"{A}/api/diagnostics/interface/carp_status/maintenance").mock(side_effect=self._toggle)
self.update = respx_mock.post(f"{A}/api/core/firmware/update").respond(200, json={"status": "ok"})
self.reboot = respx_mock.post(f"{A}/api/core/system/reboot").respond(200, json={"status": "ok"})
self.backup = respx_mock.get(f"{A}/api/core/backup/download/this").respond(200, content=b"<opnsense/>")
for base in (A, B):
respx_mock.get(f"{base}/api/diagnostics/interface/getVipStatus").mock(side_effect=lambda r, b=base: self._vip(b))
respx_mock.get(f"{base}/api/core/firmware/info").respond(200, json={"product_version": "26.7.5"})
respx_mock.get(f"{base}/api/core/firmware/status").respond(
200, json={"status": firmware, "all_packages": {}, "status_msg": "x", "status_reboot": "0"})
respx_mock.get(f"{A}/api/core/firmware/running").mock(side_effect=self._running_a)
respx_mock.get(f"{B}/api/core/firmware/running").respond(200, json={"status": "ready"})
def _vip(self, base):
if base == A and self.job == "down":
raise httpx.ConnectError("rebooting")
cur = self.roles[base]
return httpx.Response(200, json={"rows": [{"vhid": "1", "status": cur["role"]}], "carp": {
"allow": "1", "maintenancemode": cur["maintenance"], "demotion": "240" if cur["maintenance"] else "0", "status_msg": ""}})
def _running_a(self, request):
if self.job == "down":
raise httpx.ConnectError("rebooting")
return httpx.Response(200, json={"status": self.job})
def _toggle(self, request):
if self.toggle_error:
raise self.toggle_error
cur = self.roles[A]
cur["maintenance"] = not cur["maintenance"]
entering = cur["maintenance"]
if self.toggle_flips:
cur["role"] = "BACKUP" if entering else "MASTER"
if self.partner_follows:
self.roles[B]["role"] = "MASTER" if entering else "BACKUP"
return httpx.Response(200, json={"status": "ok", "action": "enter_maintenance" if entering else "leave_maintenance"})
async def _setup(client, **kwargs):
a = await _create_host(client, "fw-a", A)
b = await _create_host(client, "fw-b", B)
await client.patch(f"/api/hosts/{a['id']}", json={"cluster_name": "ha"})
await client.patch(f"/api/hosts/{b['id']}", json={"cluster_name": "ha"})
return a, b
async def _plan(host, action="update", handover=True):
async with SessionLocal() as db:
s = ScheduledMaintenance(
host_id=uuid.UUID(host["id"]), host_name=host["name"], action=action, carp_handover=handover,
run_at=datetime.now(timezone.utc) - timedelta(minutes=1), actor="admin", created_at=datetime.now(timezone.utc))
db.add(s)
await db.commit()
return s.id
async def _fire():
async with SessionLocal() as db:
return await svc.fire_due(db)
async def _advance():
async with SessionLocal() as db:
return await svc.advance_running(db)
async def _get(sched_id):
async with SessionLocal() as db:
s = await db.get(ScheduledMaintenance, sched_id)
op = await db.get(HostOperation, s.host_operation_id) if s.host_operation_id else None
return s, op
async def _age(sched_id, *, phase=None, job=None):
"""Pretend the phase (or the job) started `phase`/`job` ago."""
async with SessionLocal() as db:
s = await db.get(ScheduledMaintenance, sched_id)
if phase is not None:
s.phase_since = datetime.now(timezone.utc) - phase
if job is not None:
s.progress = {**s.progress, "job_started_at": (datetime.now(timezone.utc) - job).isoformat()}
await db.commit()
# ── happy paths ───────────────────────────────────────────────────────────
@pytest.mark.asyncio
async def test_update_with_handover_runs_end_to_end(client, respx_mock):
cluster = FakeCluster(respx_mock)
a, _b = await _setup(client)
sid = await _plan(a, "update")
assert (await _fire())["fired"] == 1
s, op = await _get(sid)
assert (s.status, s.phase, op.status) == ("running", "handover_wait", "starting")
assert cluster.backup.call_count == 1 and cluster.toggles.call_count == 1 and cluster.update.call_count == 0
assert cluster.roles[B]["role"] == "MASTER"
assert await _advance() == 1 # partner confirmed -> job submitted
s, op = await _get(sid)
assert (s.phase, op.status) == ("job_wait", "submitted") and cluster.update.call_count == 1
cluster.job = "running"
await _advance()
cluster.job = "ready"
await _advance()
assert (await _get(sid))[0].phase == "leave"
assert cluster.toggles.call_count == 1 # not back yet
await _advance() # leave: toggles once
assert cluster.toggles.call_count == 2 and (await _get(sid))[0].phase == "leave_wait"
assert await _advance() == 0 # roles back to normal -> done
s, op = await _get(sid)
assert s.status == "succeeded" and s.phase is None and s.result["handover"] is True
assert s.result["version_before"] == "26.7.5"
assert op.status == "acknowledged"
assert cluster.roles[A] == {"role": "MASTER", "maintenance": False}
assert cluster.update.call_count == 1 and cluster.toggles.call_count == 2
@pytest.mark.asyncio
async def test_reboot_with_handover_needs_to_see_the_node_go_down(client, respx_mock):
cluster = FakeCluster(respx_mock, firmware="none")
a, _b = await _setup(client)
sid = await _plan(a, "reboot")
await _fire()
assert cluster.backup.call_count == 0 # no backup for a plain reboot
await _advance()
assert cluster.reboot.call_count == 1
await _advance() # still "ready" and never seen down: not a finished reboot
assert (await _get(sid))[0].phase == "job_wait"
cluster.job = "down"
await _advance()
cluster.job = "ready"
await _advance()
assert (await _get(sid))[0].phase == "leave"
await _advance()
await _advance()
assert (await _get(sid))[0].status == "succeeded"
@pytest.mark.asyncio
async def test_handover_flag_on_a_backup_node_just_runs_the_action(client, respx_mock):
cluster = FakeCluster(respx_mock)
cluster.roles[A].update(role="BACKUP")
cluster.roles[B].update(role="MASTER")
a, _b = await _setup(client)
sid = await _plan(a, "update")
await _fire()
s, _op = await _get(sid)
assert s.status == "succeeded" and s.phase is None
assert cluster.toggles.call_count == 0 and cluster.update.call_count == 1
@pytest.mark.asyncio
async def test_without_the_flag_a_master_is_still_refused(client, respx_mock):
cluster = FakeCluster(respx_mock)
a, _b = await _setup(client)
sid = await _plan(a, "update", handover=False)
await _fire()
s, _ = await _get(sid)
assert s.status == "failed" and "CARP-BACKUP" in s.result["error"]
assert cluster.toggles.call_count == 0 and cluster.update.call_count == 0
# ── failures: what happens to the node ────────────────────────────────────
@pytest.mark.asyncio
async def test_partner_never_takes_over_restores_normal_operation(client, respx_mock):
cluster = FakeCluster(respx_mock, toggle_flips=False)
a, _b = await _setup(client)
sid = await _plan(a, "update")
await _fire()
cluster.roles[A]["maintenance"] = True # the toggle was accepted, but no role change happened
await _advance() # too early: keep waiting
assert (await _get(sid))[0].phase == "handover_wait" and cluster.toggles.call_count == 1
await _age(sid, phase=timedelta(minutes=4))
await _advance()
s, op = await _get(sid)
assert s.status == "failed" and "wiederhergestellt" in s.result["error"] and op.status == "cancelled"
assert cluster.toggles.call_count == 2 and cluster.roles[A]["maintenance"] is False
assert cluster.update.call_count == 0
@pytest.mark.asyncio
async def test_demoted_node_but_partner_not_master_never_starts_the_job(client, respx_mock):
"""The dangerous case: both nodes BACKUP, nobody carries traffic. The action must not start."""
cluster = FakeCluster(respx_mock, partner_follows=False)
a, _b = await _setup(client)
sid = await _plan(a, "update")
await _fire()
assert cluster.roles[A]["role"] == "BACKUP" and cluster.roles[B]["role"] == "BACKUP"
await _advance()
assert (await _get(sid))[0].phase == "handover_wait" and cluster.update.call_count == 0
await _age(sid, phase=timedelta(minutes=4))
await _advance()
s, op = await _get(sid)
assert s.status == "failed" and op.status == "cancelled" and cluster.update.call_count == 0
assert cluster.roles[A]["maintenance"] is False # normal operation restored
@pytest.mark.asyncio
async def test_unclear_toggle_answer_is_never_replayed(client, respx_mock):
cluster = FakeCluster(respx_mock, toggle_error=httpx.ReadTimeout("timeout"))
a, _b = await _setup(client)
sid = await _plan(a, "update")
await _fire()
s, op = await _get(sid)
assert s.status == "failed" and op.status == "unknown" and "unklar" in s.result["error"]
assert await _advance() == 0
assert cluster.toggles.call_count == 1 and cluster.update.call_count == 0
@pytest.mark.asyncio
async def test_job_timeout_leaves_the_node_demoted(client, respx_mock):
cluster = FakeCluster(respx_mock)
a, _b = await _setup(client)
sid = await _plan(a, "update")
await _fire()
await _advance()
cluster.job = "running"
await _age(sid, job=timedelta(minutes=61))
await _advance()
s, op = await _get(sid)
assert s.status == "failed" and op.status == "unknown" and "Wartungsmodus" in s.result["error"]
assert cluster.roles[A]["maintenance"] is True and cluster.toggles.call_count == 1 # the safe side: partner keeps traffic
@pytest.mark.asyncio
async def test_blocked_preconditions_change_nothing(client, respx_mock):
cluster = FakeCluster(respx_mock)
cluster.roles[B]["role"] = "MASTER" # no BACKUP partner to hand over to (split-brain-like)
a, _b = await _setup(client)
sid = await _plan(a, "update")
await _fire()
s, op = await _get(sid)
assert s.status == "failed" and op is None
assert cluster.toggles.call_count == 0 and cluster.update.call_count == 0
@pytest.mark.asyncio
async def test_failed_backup_aborts_before_any_switch(client, respx_mock):
cluster = FakeCluster(respx_mock)
respx_mock.get(f"{A}/api/core/backup/download/this").mock(side_effect=httpx.ConnectError("down"))
a, _b = await _setup(client)
sid = await _plan(a, "update")
await _fire()
s, _ = await _get(sid)
assert s.status == "failed" and "nichts wurde verändert" in s.result["error"]
assert cluster.toggles.call_count == 0
@pytest.mark.asyncio
async def test_run_stops_when_a_human_closes_the_operation(client, respx_mock):
cluster = FakeCluster(respx_mock)
a, _b = await _setup(client)
sid = await _plan(a, "update")
await _fire()
_s, op = await _get(sid)
async with SessionLocal() as db:
(await db.get(HostOperation, op.id)).status = "cancelled"
await db.commit()
assert await _advance() == 0
s, _ = await _get(sid)
assert s.status == "failed" and "von Hand" in s.result["error"]
assert cluster.toggles.call_count == 1 and cluster.update.call_count == 0
@pytest.mark.asyncio
async def test_step_survives_backend_restart(client, respx_mock):
"""Every step reads its state from the row; nothing lives in memory between ticks."""
cluster = FakeCluster(respx_mock)
a, _b = await _setup(client)
sid = await _plan(a, "update")
await _fire()
async with SessionLocal() as db: # a fresh session per step is what a restarted backend does
assert await svc.advance_running(db) == 1
async with SessionLocal() as db:
s = await db.get(ScheduledMaintenance, sid)
assert s.phase == "job_wait" and s.progress["job_started_at"]
# ── API ───────────────────────────────────────────────────────────────────
@pytest.mark.asyncio
async def test_schedule_api_accepts_handover_for_the_master_only_with_the_flag(client, respx_mock):
FakeCluster(respx_mock)
a, _b = await _setup(client)
when = (datetime.now(timezone.utc) + timedelta(hours=1)).isoformat()
url = f"/api/hosts/{a['id']}/maintenance/schedule"
plain = await client.post(url, json={"action": "update", "run_at": when, "acknowledge_unattended": True})
assert plain.status_code == 409
ok = await client.post(url, json={"action": "update", "run_at": when, "acknowledge_unattended": True, "carp_handover": True})
assert ok.status_code == 200 and ok.json()["carp_handover"] is True and ok.json()["phase"] is None
@pytest.mark.asyncio
async def test_schedule_api_handover_needs_a_cluster(client, respx_mock):
respx_mock.get("https://solo.test/api/diagnostics/interface/getVipStatus").respond(200, json={"rows": []})
h = await _create_host(client, "solo", "https://solo.test")
when = (datetime.now(timezone.utc) + timedelta(hours=1)).isoformat()
r = await client.post(f"/api/hosts/{h['id']}/maintenance/schedule",
json={"action": "reboot", "run_at": when, "acknowledge_unattended": True, "carp_handover": True})
assert r.status_code == 409
assert r.json()["detail"]["code"] == "CARP_UEBERGABE_BRAUCHT_EINEN_CLUSTER"
+165 -10
View File
@@ -1,6 +1,8 @@
import json
import uuid
from datetime import datetime, timedelta, timezone
import httpx
import pytest
from sqlalchemy import select
@@ -76,25 +78,58 @@ async def test_fire_due_reboot_success(client, respx_mock):
assert reboot.call_count == 1
@pytest.mark.asyncio
async def test_fire_due_update_blocked_without_fresh_backup(client, respx_mock):
mock_reads(respx_mock, status="update")
h = await _create_host(client, "fw1", "https://fw1.test")
async def _due_update(h, action="update"):
async with SessionLocal() as db:
sched = ScheduledMaintenance(
host_id=uuid.UUID(h["id"]), host_name="fw1", action="update",
host_id=uuid.UUID(h["id"]), host_name="fw1", action=action,
run_at=datetime.now(timezone.utc) - timedelta(minutes=1),
actor="admin", created_at=datetime.now(timezone.utc),
)
db.add(sched)
await db.commit()
return sched.id
result = await scheduled_maintenance_service.fire_due(db)
assert result == {"due": 1, "fired": 0, "blocked_or_failed": 1}
refreshed = await db.get(ScheduledMaintenance, sched.id)
@pytest.mark.asyncio
async def test_fire_due_update_takes_its_own_backup_first(client, respx_mock):
mock_reads(respx_mock, status="update")
h = await _create_host(client, "fw1", "https://fw1.test")
download = respx_mock.get("https://fw1.test/api/core/backup/download/this").respond(200, content=b"<opnsense/>")
update = respx_mock.post("https://fw1.test/api/core/firmware/update").respond(200, json={"status": "ok"})
sched_id = await _due_update(h)
async with SessionLocal() as db:
assert await scheduled_maintenance_service.fire_due(db) == {"due": 1, "fired": 1, "blocked_or_failed": 0}
assert (await db.get(ScheduledMaintenance, sched_id)).status == "succeeded"
assert download.call_count == 1 and update.call_count == 1
assert len(backup_store.list_snapshots(uuid.UUID(h["id"]))) == 1
@pytest.mark.asyncio
async def test_fire_due_update_fails_closed_when_backup_fails(client, respx_mock):
mock_reads(respx_mock, status="update")
h = await _create_host(client, "fw1", "https://fw1.test")
respx_mock.get("https://fw1.test/api/core/backup/download/this").mock(side_effect=httpx.ConnectError("down"))
update = respx_mock.post("https://fw1.test/api/core/firmware/update").respond(200, json={"status": "ok"})
sched_id = await _due_update(h)
async with SessionLocal() as db:
assert await scheduled_maintenance_service.fire_due(db) == {"due": 1, "fired": 0, "blocked_or_failed": 1}
refreshed = await db.get(ScheduledMaintenance, sched_id)
assert refreshed.status == "failed"
assert "Konfigurationsbackup" in refreshed.result["error"]
assert "Backup" in refreshed.result["error"]
assert update.call_count == 0
@pytest.mark.asyncio
async def test_fire_due_reboot_takes_no_backup(client, respx_mock):
mock_reads(respx_mock)
h = await _create_host(client, "fw1", "https://fw1.test")
respx_mock.post("https://fw1.test/api/core/system/reboot").respond(200, json={"status": "ok"})
sched_id = await _due_update(h, action="reboot") # no backup route mocked: a download would raise
async with SessionLocal() as db:
await scheduled_maintenance_service.fire_due(db)
assert (await db.get(ScheduledMaintenance, sched_id)).status == "succeeded"
@pytest.mark.asyncio
@@ -126,3 +161,123 @@ async def test_fire_due_blocked_by_active_operation_on_cluster_peer(client, resp
assert result == {"due": 1, "fired": 0, "blocked_or_failed": 1}
refreshed = await db.get(ScheduledMaintenance, sched.id)
assert refreshed.status == "failed"
# ── CARP role is checked when the plan is created, not first at 3 a.m. ────
def _cluster_roles(respx_mock, roles):
for base, role in roles.items():
if role is None:
respx_mock.get(f"{base}/api/diagnostics/interface/getVipStatus").mock(side_effect=httpx.ConnectError("down"))
else:
respx_mock.get(f"{base}/api/diagnostics/interface/getVipStatus").respond(
200, json={"rows": [{"vhid": "1", "status": role}], "carp": {"allow": "1", "maintenancemode": "0", "demotion": "0"}}
)
respx_mock.get(f"{base}/api/core/firmware/running").respond(200, json={"status": "ready"})
async def _cluster(client, a_url="https://fw-a.test", b_url="https://fw-b.test"):
a = await _create_host(client, "fw-a", a_url)
b = await _create_host(client, "fw-b", b_url)
await client.patch(f"/api/hosts/{a['id']}", json={"cluster_name": "ha"})
await client.patch(f"/api/hosts/{b['id']}", json={"cluster_name": "ha"})
return a, b
@pytest.mark.asyncio
async def test_schedule_on_carp_master_is_rejected_up_front(client, respx_mock):
_cluster_roles(respx_mock, {"https://fw-a.test": "MASTER", "https://fw-b.test": "BACKUP"})
a, b = await _cluster(client)
rejected = await schedule(client, a, action="update")
assert rejected.status_code == 409, rejected.text
assert rejected.json()["detail"]["code"] == "GEPLANTE_WARTUNG_NUR_AUF_DEM_CARP_BACKUP_MOEGLICH"
assert (await client.get(f"/api/hosts/{a['id']}/maintenance/schedule")).json() == []
# The backup node is where unattended maintenance belongs.
accepted = await schedule(client, b, action="update")
assert accepted.status_code == 200, accepted.text
@pytest.mark.asyncio
async def test_schedule_accepted_when_role_cannot_be_determined(client, respx_mock):
# Unreachable now does not mean wrong at run time — the full check still runs when it fires.
_cluster_roles(respx_mock, {"https://fw-a.test": None, "https://fw-b.test": "MASTER"})
a, _b = await _cluster(client)
assert (await schedule(client, a)).status_code == 200
@pytest.mark.asyncio
async def test_schedule_on_standalone_host_skips_role_check(client, respx_mock):
mock_reads(respx_mock, carp="MASTER")
h = await _create_host(client, "fw1", "https://fw1.test")
assert (await schedule(client, h)).status_code == 200
# ── a plan that did not run is reported ───────────────────────────────────
async def _only_enable(db, flag):
from app.services import notification_settings_service
row = await notification_settings_service.get_settings(db)
for column in row.__table__.columns.keys():
if column.endswith("_enabled"):
setattr(row, column, column == flag)
row.webhook_enabled = True
row.webhook_url = "https://hooks.test/notify"
await db.commit()
@pytest.mark.asyncio
async def test_failed_schedule_is_notified_once_and_closes_silently(client, respx_mock):
from app.models.notification import NotificationProblem
from app.services.notification_service import run_notification_checks
mock_reads(respx_mock)
h = await _create_host(client, "fw1", "https://fw1.test")
hook = respx_mock.post("https://hooks.test/notify").respond(200)
async with SessionLocal() as db:
await _only_enable(db, "scheduled_maintenance_failed_enabled")
now = datetime.now(timezone.utc)
failed = ScheduledMaintenance(
host_id=uuid.UUID(h["id"]), host_name="fw1", action="update", run_at=now - timedelta(hours=2),
status="failed", actor="admin", created_at=now - timedelta(days=1),
result={"error": "Cluster-Wartung nur auf dem CARP-BACKUP."},
)
ok = ScheduledMaintenance(
host_id=uuid.UUID(h["id"]), host_name="fw1", action="reboot", run_at=now - timedelta(hours=1),
status="succeeded", actor="admin", created_at=now - timedelta(days=1),
)
old = ScheduledMaintenance(
host_id=uuid.UUID(h["id"]), host_name="fw1", action="reboot", run_at=now - timedelta(days=10),
status="failed", actor="admin", created_at=now - timedelta(days=11),
)
db.add_all([failed, ok, old])
await db.commit()
assert (await run_notification_checks(db))["opened"] == 1
assert hook.call_count == 1
sent = json.loads(hook.calls.last.request.content)
assert sent["problem_type"] == "scheduled_maintenance_failed"
assert sent["context"]["host_name"] == "fw1" and "CARP-BACKUP" in sent["context"]["message"]
# Still failed on the next poll: no second message.
assert (await run_notification_checks(db))["opened"] == 0
assert hook.call_count == 1
# Once it drops out of the window nothing was "fixed" — no "behoben" message.
failed.run_at = now - timedelta(days=4)
await db.commit()
result = await run_notification_checks(db)
assert result["resolved"] == 1
assert hook.call_count == 1
problem = (await db.execute(select(NotificationProblem).where(NotificationProblem.problem_type == "scheduled_maintenance_failed"))).scalar_one()
assert problem.status == "resolved"
@pytest.mark.asyncio
async def test_settings_roundtrip_scheduled_maintenance_failed_toggle(client):
assert (await client.get("/api/notifications/settings")).json()["scheduled_maintenance_failed_enabled"] is True
resp = await client.put("/api/notifications/settings", json={"scheduled_maintenance_failed_enabled": False})
assert resp.status_code == 200, resp.text
assert resp.json()["scheduled_maintenance_failed_enabled"] is False
+66
View File
@@ -0,0 +1,66 @@
"""First-run setup assistant: per-user "done" flag and the password reset tool."""
import pytest
from sqlalchemy import select
from app import reset_password
from app.config import settings
from app.database import SessionLocal
from app.models.user import AdminUser, Session
from app.services import auth_service
@pytest.mark.asyncio
async def test_setup_done_defaults_to_false_and_persists(client):
assert (await client.get("/api/settings")).json()["setup_done"] is False
resp = await client.put("/api/settings", json={"setup_done": True})
assert resp.status_code == 200
assert resp.json()["setup_done"] is True
assert (await client.get("/api/settings")).json()["setup_done"] is True
@pytest.mark.asyncio
async def test_other_preference_changes_keep_setup_done(client):
await client.put("/api/settings", json={"setup_done": True})
resp = await client.put("/api/settings", json={"theme": "dark", "language": "en"})
body = resp.json()
assert (body["theme"], body["language"], body["setup_done"]) == ("dark", "en", True)
# ...and the other direction: saving setup_done leaves theme/language alone.
resp = await client.put("/api/settings", json={"setup_done": False})
body = resp.json()
assert (body["theme"], body["language"], body["setup_done"]) == ("dark", "en", False)
@pytest.mark.asyncio
async def test_setup_done_rejects_non_boolean(client):
assert (await client.put("/api/settings", json={"setup_done": "maybe"})).status_code == 422
@pytest.mark.asyncio
async def test_reset_password_prints_new_password_and_ends_sessions(client, capsys):
async with SessionLocal() as db:
before = (await db.execute(select(Session))).scalars().all()
assert before, "the client fixture logged in, so a session must exist"
assert await reset_password.main(None) == 0
out = capsys.readouterr().out
lines = dict(line.split(": ", 1) for line in out.strip().splitlines())
assert lines["Username"] == settings.admin_username
new_password = lines["Password"]
assert len(new_password) >= 20 and new_password != settings.admin_password
async with SessionLocal() as db:
assert (await db.execute(select(Session))).scalars().all() == []
user = (await db.execute(select(AdminUser).where(AdminUser.username == settings.admin_username))).scalar_one()
assert await auth_service.verify_password_async(user.password_hash, new_password)
assert not await auth_service.verify_password_async(user.password_hash, settings.admin_password)
# Put the shared bootstrap admin back for the tests that follow.
user.password_hash = await auth_service.hash_password_async(settings.admin_password)
await db.commit()
@pytest.mark.asyncio
async def test_reset_password_unknown_user_fails(capsys):
assert await reset_password.main("does-not-exist") == 1
assert "No such user" in capsys.readouterr().err
+31 -6
View File
@@ -28,9 +28,8 @@ services:
logging: *default-logging
# Docker's default 64MB /dev/shm is too small for Postgres's parallel
# vacuum/query workers on anything but a toy dataset — found the hard
# way running VACUUM on a multi-GB table (see docs/HANDBUCH.md's "Backup &
# Restore" section for how that table got that large in the first
# place). Official Postgres image docs recommend raising this.
# way running VACUUM on a multi-GB table (see docs/HANDBUCH.md's "Logs" section for how
# large that table gets). Official Postgres image docs recommend raising this.
shm_size: "256mb"
environment:
# Datenbank- und Benutzername. Wirken nur beim allerersten Start eines
@@ -62,8 +61,8 @@ services:
# path at all. Reuses the postgres image directly (pg_dump is already
# in it) rather than adding a new image to build/maintain.
# Excludes firewall_log_entries/host_resource_samples: high-volume,
# disposable operational history (see docs/HANDBUCH.md's "Backup & Restore"
# section for exactly how large this got in practice) rather than
# disposable operational history (see docs/HANDBUCH.md's "Logs" section for
# how large these get) rather than
# config a disaster recovery actually needs — including them would
# make the backup itself multi-GB and a disk-usage risk in its own
# right, working against the point of this service.
@@ -110,6 +109,7 @@ services:
ACME_SECRET_DIR: /data/acme-secrets
TOTP_SECRET_DIR: /data/totp-secrets
NOTIFICATION_SECRET_DIR: /data/notification-secrets
OVERLAY_DIR: /data/overlay
ADMIN_USERNAME: ${ADMIN_USERNAME:-admin}
ADMIN_PASSWORD: ${ADMIN_PASSWORD:-}
FRONTEND_ORIGIN: ${FRONTEND_ORIGIN:-}
@@ -133,6 +133,8 @@ services:
- acme_secrets:/data/acme-secrets
- totp_secrets:/data/totp-secrets
- notification_secrets:/data/notification-secrets
# Management-Overlay: Konfiguration für den wg-hub und dessen Status.
- overlay_state:/data/overlay
# Gleiches Volume wie der postgres-backup-Service: hier landet das
# automatische Sicherheits-Backup vor einer Schema-Migration.
- postgres_backups:/backups
@@ -142,7 +144,7 @@ services:
# Bound to loopback only by default — reachable from this host, not
# the network. Set BIND_ADDRESS in .env (e.g. to 0.0.0.0, or a
# specific interface IP) for network-wide access instead of editing
# this file — see docs/HANDBUCH.md's "Produktivbetrieb" for the TLS-proxy
# this file — see docs/HANDBUCH.md's "Zugriff aus dem Netz und TLS" for the TLS-proxy
# alternative, which is safer than widening this directly.
ports:
- "${BIND_ADDRESS:-127.0.0.1}:${BACKEND_PORT:-8100}:8000"
@@ -201,6 +203,28 @@ services:
- caddy_data:/data
- caddy_config:/config
# ── Optional: Management-Overlay (WireGuard-Hub) ─────────────────────
# Standardmäßig NICHT gestartet. Aktivieren mit COMPOSE_PROFILES=overlay in
# .env und `docker compose up -d`. Damit erreicht OPNexus auch Firewalls hinter
# NAT/CGNAT: sie wählen sich per WireGuard hier ein (UDP-Port ${OVERLAY_PORT:-51820}
# muss vom Internet erreichbar sein). Gleiches Image wie das Backend, mit
# NET_ADMIN nur für die WireGuard-Schnittstelle. Einrichtung: Handbuch,
# "Firewalls hinter NAT".
wg-hub:
image: ${OPNEXUS_IMAGE_REPO:-local}/opnexus-backend:${OPNEXUS_VERSION:-latest}
profiles: ["overlay"]
restart: unless-stopped
logging: *default-logging
command: ["python", "-m", "app.overlay_hub"]
cap_add:
- NET_ADMIN
environment:
OVERLAY_DIR: /data/overlay
volumes:
- overlay_state:/data/overlay
ports:
- "${OVERLAY_PORT:-51820}:51820/udp"
# ── Optional: Updates aus dem Webinterface ──────────────────────────
# Standardmäßig NICHT gestartet. Aktivieren mit COMPOSE_PROFILES=updater in
# .env und `docker compose up -d`. Dies ist der einzige Container mit
@@ -240,5 +264,6 @@ volumes:
acme_secrets:
totp_secrets:
notification_secrets:
overlay_state:
caddy_data:
caddy_config:
+1220 -3502
View File
File diff suppressed because it is too large. Load diff
+332
View File
@@ -0,0 +1,332 @@
# Opnexus security review — 2026-10-07
## Instructions for Claude Code
This is a remediation handoff, not a record of applied fixes. Work from the finding IDs below. Recheck each finding against the current source before modifying it, preserve unrelated user changes, and add the specified regression coverage. Address SEC-01 through SEC-05 first. Do not deploy to real firewalls to reproduce these issues: use mocked OPNsense responses and a disposable test database. Never include actual credentials, backups, or private keys in tests, logs, or commits.
The review covers commit `ee7b35953a326e848d0bc9e5b19bf7755f78a937` plus the working tree as inspected. Existing user changes were present in `frontend/app/aliases/page.tsx`, `frontend/app/rules/page.tsx`, and the OneToOnePanel, OutboundNatPanel, and PortForwardPanel components. Those files were not modified by this review. All locations below are repository-relative; line references describe this snapshot and can move during remediation.
## Scope and evidence
Reviewed the authentication and authorization boundary; account/password/TOTP flows; all router registrations; firewall rule, alias, NAT, hierarchy, VPN, certificate and ACME operation paths; maintenance and restore controls; secret stores; outbound HTTP and SMTP; frontend API calls and rendering sinks; website worker and scripts; Docker/Compose/proxy configuration; migration and update scripts; CI and release configuration; dependency manifests and lockfile.
The backend inventory contains 164 Python application files and 187 route decorators. This was a broad static review with targeted tracing and isolated probes, not line-by-line proof of every possible behavior or a complete penetration test.
Evidence is in [security-review-2026-10-07](security-review-2026-10-07/):
- `probe-results.json`: 13 synthetic probes, including positive controls. These report current vulnerable behavior, not passing remediation tests.
- `reproduce.py`: reusable, mocked reproduction harness. It does not invoke application lifespan, connect to a database, or contact a firewall. Authentication, database, backup and relevant secret reads are replaced with synthetic fixtures.
- `npm-audit.json`: npm registry audit of the frontend lockfile, reporting 12 affected package entries (10 high, 2 moderate). Dependency-chain entries are not separate exploitable vulnerabilities.
- `pip-audit.json`: resolved requirements audit reporting no known vulnerabilities. This is not a scan of every installed production package or container OS package.
- `route-inventory.tsv`: route source locations, methods, local paths and function names. Apply router prefixes from `main.py` and router declarations to obtain public paths.
- `source-manifest.json`: hashes of tracked source/deployment/website files for identifying the reviewed snapshot. A hash entry does not mean every line was manually examined.
The probes were rerun in a disposable backend-image container with no network and no volume mounts. Source hashes of 12 central authentication, routing, schema and SMTP modules were also compared with the existing backend container and matched. Runtime read-only checks found the existing backend and frontend processes running as UID 0 and the Compose PostgreSQL user marked as a superuser. No real backup contents or secret files were read, no live firewall operations were performed, and no application database rows were changed.
Reproduce using an image built from the reviewed source:
```sh
docker run --rm -i --network none --entrypoint python \
local/opnexus-backend:latest - \
< docs/security-review-2026-10-07/reproduce.py
```
Run the harness only against this snapshot or after reviewing changes to the functions it mocks. The standalone harness has no pytest fixtures and does not drop/create tables. The normal backend pytest suite has database setup/teardown fixtures; it was not run as part of this report. No load tests, exploit payloads for dependency vulnerabilities, browser exploitation, image vulnerability scan, full git-history secret scan, or real-firewall integration tests were performed.
## Findings and priority
Severity is contextual to a firewall-fleet management product. High findings can expose credentials, preserve unauthorized administrative access, or defeat safeguards for live firewall changes. Medium findings require more prerequisites or concern integrity, monitoring or supply-chain exposure. Conditional findings state the necessary deployment conditions. No anonymous remote-code-execution exploit was demonstrated.
| ID | Severity | Finding | Evidence level |
|---|---|---|---|
| SEC-01 | High | Read-only users can download secret-bearing firewall backups | Mocked HTTP reproduction |
| SEC-02 | High | Password changes/resets do not revoke all account sessions | Source + mocked reset |
| SEC-03 | High | SMTP TLS does not verify certificates or hostname | Source + runtime library inspection |
| SEC-04 | High | Ambiguous/live deployment failures disable automatic rollback | Source + mocked deploy |
| SEC-05 | High, conditional | HTTP firewall URLs send API credentials without TLS | Schema probe + client source |
| SEC-06 | Medium | Concurrent TOTP/recovery-code consumption is not atomic | Concurrent mocked reproduction |
| SEC-07 | Medium | Login throttle leaks records and password verification blocks the event loop | Source + expiration probe |
| SEC-08 | Medium, conditional | Raw upstream errors reach readers and persisted records | Source + synthetic error probe |
| SEC-09 | Medium | Host deletion omits VPN/certificate/ACME deployment guards | Source tracing |
| SEC-10 | Medium | Security-sensitive operations are absent from durable audit history | Source tracing |
| SEC-11 | Medium | Notification secrets are ephemeral and missing signing keys fail open | Compose + source tracing |
| SEC-12 | Medium, reachability unverified | Known vulnerable frontend dependencies remain in the lockfile | Registry audit + advisory verification |
| SEC-13 | Medium | MFA self-service endpoints lack attempt limits | Source tracing |
| SEC-14 | Medium | VPN approval can be omitted and tokens do not bind secret rotations | Source + synthetic token probe |
| SEC-15 | Low | Validation errors echo submitted secret values | Mocked HTTP reproduction |
| SEC-16 | Medium, conditional | Read-only notification settings expose capability-bearing webhook URLs | Schema + route tracing |
### SEC-01 — Read-only backup access exposes firewall secrets
**Locations:** `backend/app/auth_middleware.py:55-58`; `backend/app/routers/hosts.py:242-258`; `backend/app/services/backup_store.py:48-55`; `backend/app/services/opnsense_client.py`, `download_backup()`.
**Cause:** The read-only role is implemented as “allow every GET.” Backup listing and download do not enforce a separate permission. Download returns the original snapshot bytes, not the redacted restore manifest. The normal snapshot flow downloads full OPNsense `config.xml` revisions.
**Prerequisites/impact:** Any valid read-only session and an existing backup. Full configurations can contain password hashes, VPN PSKs, private keys and other credentials, depending on the firewall configuration. Exposure can enable offline password attacks and access outside Opnexus. No anonymous access was found. The role's documented allowance for all GETs explains the behavior but does not make secret export least-privileged.
**Reproduce:** Create a synthetic firewall backup fixture. Authenticate as read-only; list `/api/hosts/{host_id}/backups`, then GET `/api/hosts/{host_id}/backups/{backup_id}`. The probe returned HTTP 200 with a synthetic secret marker; a read-only POST control returned 403.
**Fix:** Add server-enforced admin-only or explicit `export_firewall_secrets` authorization for raw downloads, consistently for GET and HEAD. Keep any reader-visible backup metadata separate from export permission. Update the frontend accordingly. Audit successful and denied secret exports without storing their contents.
**Acceptance:** Reader gets 403 for raw download/HEAD, admin gets the exact synthetic bytes, anonymous gets 401. Ordinary reader pages continue working. A path traversal string cannot retrieve another host's backup.
### SEC-02 — Password rotation leaves compromised sessions valid
**Locations:** `backend/app/routers/auth.py:221-241`; `backend/app/routers/users.py:71-78`; `backend/app/services/auth_service.py:151-194`; `backend/app/config.py`, `session_lifetime`.
**Cause:** Self-service password change updates the hash and revokes only the caller's token before creating a replacement. Admin password reset updates only the hash. Session resolution uses token hash, expiry and user existence; it does not check a credential generation. Sessions can remain valid for the configured 30-day default lifetime. MFA enable/disable/reset likewise do not invalidate existing sessions.
**Prerequisites/impact:** Attacker already possesses a session. Changing or administratively resetting the password does not reliably contain the incident; the old session can continue reading secrets or changing firewall policy according to the current account role. This does not let an expired or unknown token authenticate.
**Reproduce:** Log in twice in a disposable database. Change the password in session A or reset it through another admin. Call `/api/auth/me` and a protected route using session B. Source predicts continued access; the mocked reset probe recorded one commit and zero revocation SQL statements. Full two-session database reproduction was not performed.
**Fix:** Revoke every target-account session atomically with password reset/change; for self-service change issue a replacement only after revocation. Consider a credential/session generation for robust concurrency. Define explicit MFA-change session policy, and require reauthentication where appropriate. Do not rely on password hash comparisons at request time.
**Acceptance:** All preexisting tokens fail on protected routes after reset/change. A replacement self-service session works. Failure rolls back both credential change and revocation. A concurrent session-creation attempt cannot bypass the chosen revocation/generation semantics.
### SEC-03 — SMTP encryption lacks peer authentication
**Locations:** `backend/app/services/notification_delivery.py:82-102`, particularly SMTP_SSL construction at line 93 and `client.starttls()` at line 98.
**Cause:** Both TLS modes omit an explicit verifying SSL context. Inspection of the deployed Python 3.12 standard library showed both falling back to `ssl._create_stdlib_context()`, with `verify_mode=0` (`CERT_NONE`) and `check_hostname=False`.
**Prerequisites/impact:** An active network attacker, malicious DNS/route or incorrectly configured SMTP endpoint. The attacker can impersonate the mail server and obtain SMTP credentials and operational notification content even when the UI selects `ssl` or `starttls`. Mode `none` intentionally has no TLS and should not be confused with this defect.
**Fix:** Pass `ssl.create_default_context()` to SMTP_SSL and starttls. Support an explicit custom trust store if needed, without silently disabling verification. Preserve STARTTLS fail-closed behavior when unsupported. Reject authenticated plaintext SMTP by default or require an explicit, documented insecure override.
**Acceptance:** Both modes reject self-signed/untrusted certificates and hostname mismatches; a trusted, matching local test certificate succeeds. Assert the passed context has CERT_REQUIRED and hostname checks. On handshake failure `login()` and `send_message()` must not run.
**Reference:** [Python SMTP TLS context documentation](https://docs.python.org/3.12/library/smtplib.html). The vulnerability conclusion also relies on the inspected runtime implementation, not merely the documentation.
### SEC-04 — Rollback is dropped precisely when a deployment outcome is uncertain
**Locations:** `backend/app/services/rule_deploy_service.py:56-137,154-172`; corresponding `_deploy_to_host()` and post-deploy hierarchy handling in `alias_deploy_service.py`, `port_forward_deploy_service.py`, `one_to_one_deploy_service.py`, `outbound_nat_deploy_service.py`; `policy_hierarchy_deploy_service.py:220-278`.
**Cause:** The API may accept a rule write and apply it before the response is lost. On apply error, the code records `status="error"` and no revert deadline. It generally captures rollback payload/deadline only after successful apply. There is a second, stronger case: after confirmed apply, hierarchy reordering failure changes `pending` to `error` and clears the deadline. The sweeper selects only expired `pending` rows. Policy hierarchy positioning failure can return before saving the new payload and rollback baseline.
**Impact:** A restrictive, permissive or misplaced live rule/NAT/alias change can remain indefinitely despite lack of confirmation. Operators expecting automatic rollback may lose connectivity or leave an unintended opening. Requires an authorized deployment and a failure/race; it is a safety-control failure, not an anonymous authorization bypass. Recovery also requires the management path to remain reachable: Opnexus cannot undo a change over a connection that has become permanently inaccessible.
**Reproduce:** Mock a successful add with a returned remote UUID, then make apply raise a timeout representing a lost response after execution. The probe returned `error`, a known remote UUID and null revert deadline. Separately mock successful apply followed by failed hierarchy reassertion; verify the worker excludes the now-live change.
**Fix:** Introduce explicit state for written/applied/unknown outcomes with durable rollback baseline and recovery scheduling. Persist intent/baseline before external mutation where possible. Do not erase the recovery obligation when apply or ordering is ambiguous. Block ordinary retry/edit paths until reconciliation. Avoid blindly retrying non-idempotent remote actions. Apply the same recovery semantics across all affected resource types.
**Acceptance:** Test failed write before mutation, successful write plus apply timeout, successful apply plus ordering failure, and process interruption between phases. Known or potentially live changes retain recovery metadata and cannot be mistaken for harmless failures. Simulate recovery worker execution without a firewall. Confirmed validation rejection before a write does not spuriously remove a remote rule.
### SEC-05 — Firewall connections accept plaintext HTTP
**Locations:** `backend/app/schemas/host.py:10-14`; `backend/app/routers/hosts.py:102-127`; `backend/app/services/opnsense_client.py:28-37`; `backend/app/services/tls_pin_service.py:84-90`.
**Cause:** `base_url` is a plain string. Create accepts `http://...`; httpx receives the API key/secret as Basic authentication. `verify_tls=True` only affects TLS validation and does not upgrade or reject HTTP. The schema probe accepted an HTTP URL while verification remained true. Setting `verify_tls=False` also deliberately allows unauthenticated HTTPS.
**Prerequisites/impact:** Admin configures an HTTP host or disables verification, then a network observer/attacker is on the path. API credentials and firewall responses are exposed or forgeable. Existing correctly pinned HTTPS hosts are not shown vulnerable by this finding.
**Fix:** Validate canonical HTTPS host URLs, rejecting userinfo, fragments, unsuitable paths and unsupported schemes. Enforce the rule in the client too, including existing database rows. If HTTP or disabled verification must remain for development, put it behind an explicit deployment-level insecure override with clear status and audit evidence. Do not ban private IPs: management of internal firewalls is core functionality.
**Acceptance:** HTTP is rejected before credentials are sent; HTTPS hostname/IP with valid pin works. Existing unsafe records cannot silently continue after migration. Tests distinguish URL scheme protection from `verify_tls` certificate protection.
### SEC-06 — TOTP and recovery codes can be used concurrently more than once
**Locations:** `backend/app/routers/auth.py:116-131`; `backend/app/services/totp_service.py:45-58,77-86`; user resolution/authentication before these calls.
**Cause:** Separate sessions load the same `totp_last_step` or recovery hash list, check locally, modify locally and commit without row locking or conditional updates. Two requests can both pass before either committed update is visible. Sequential replay tests do not cover this.
**Impact:** An attacker with the password and a captured second factor can race legitimate use, violating single-use protection. This is not a bypass with only the password and no code.
**Reproduce:** Two independent synthetic user snapshots and a barrier at commit accepted the same current TOTP twice, `[true,true]`. The same concurrent test accepted one recovery code twice. This demonstrates the check/commit race with mocks; database-level concurrent integration remains to be added.
**Fix:** Lock/reload the user row inside the consumption transaction or use an atomic conditional update that only succeeds once. Consume recovery codes atomically too. Ensure login and MFA-disable use the same primitive and avoid commits that release locks before consumption finishes.
**Acceptance:** Concurrent real-test-database requests for the same code yield exactly one acceptance. Sequential replay, drift window, remaining recovery codes and unrelated-account concurrency continue working.
### SEC-07 — Login throttling has unbounded state and synchronous expensive work
**Locations:** `backend/app/services/auth_service.py:55-60,78-139,199-233`; `backend/app/routers/auth.py:74-113`; backend Dockerfile uvicorn invocation.
**Cause:** `_records` and `_failures_since_success` have no TTL eviction or size cap. Expired attempt records remain, and arbitrary nonexistent usernames create counters. A probe created 200 bucket records for 100 synthetic sources; advancing time and checking every bucket left all 200 records and 100 username counters. Password verification is synchronous Argon2 work inside an async request handler. The limiter is per-process, per-IP/account and per-IP; it has no shared/account-wide policy across sources/processes. A correct password on an MFA account with omitted code exits without recording a failure, allowing repeated expensive checks on that path.
**Impact:** Public login requests can consume memory over time and stall the single event loop, also delaying status, deployment and rollback tasks. One IP's existing lockout reduces simple repeated attacks, so sustained abuse generally needs multiple sources/windows; multiworker deployment introduces additional independent buckets. The review did not load-test a running instance.
**Fix:** Bound/expire all throttle maps, including informational username counters. Use a shared limiter if supporting multiple workers and an account-aware policy that avoids trivially locking users out. Offload Argon2 into a bounded worker pool with admission/concurrency limits. Limit request body size before JSON parsing; field max lengths do not bound the raw HTTP body. Count appropriate incomplete/failed MFA attempts.
**Acceptance:** Expired records are removed, capacity remains bounded under many usernames, and throttles work across supported workers. Heartbeat/health requests stay responsive during bounded synthetic password verification. Missing MFA codes cannot create an unlimited costly path. Oversized chunked and Content-Length bodies are rejected before buffering.
### SEC-08 — Untrusted upstream errors cross the reader/secret boundary
**Locations:** `backend/app/services/opnsense_client.py:40-67`; `backend/app/services/host_status_service.py:35-50`; `backend/app/routers/hosts.py:42-57,69-75,131-136`; `backend/app/routers/maintenance.py:53-61`; `backend/app/services/managed_certificate_service.py`, `push_certificate()`; analogous `str(exc)` assignments in VPN/ACME/deploy services.
**Cause:** HTTP error exceptions include the entire upstream response body. Some direct host routes sanitize with `_upstream_error`, but status returns `str(exc)` through `status_detail`, maintenance returns it as `error`, and multiple deploy/certificate/ACME paths persist it as user-visible messages. An upstream response or validation object may contain reflected secret-bearing inputs. `_mutation_result()` also embeds up to 350 characters of unfiltered JSON.
**Prerequisites/impact:** Upstream emits sensitive details or is compromised/misconfigured. Readers can see otherwise privileged error content; messages may additionally enter database backups/audit exports/logs. The synthetic status probe returned the embedded marker. Actual firewall credential reflection was not tested or claimed.
**Fix:** Use structured upstream exceptions with safe code/status/operation fields. Centralize redaction before persistence, logging and response serialization; avoid raw bodies even in generic backend logs. Bound retained diagnostic data. Cover success-shaped-but-invalid mutation responses too.
**Acceptance:** Mock an upstream error/validation response containing API credentials, PSK, private key and arbitrary markers. None appear in reader JSON, database messages, audit details or logs. Safe operation/status diagnostics remain useful.
### SEC-09 — Deleting a host can leave live VPN/certificate state untracked
**Locations:** `backend/app/routers/hosts.py:175-201`; host foreign keys in `backend/app/models/ipsec_tunnel_deployment.py:40`, `openvpn_instance_deployment.py:44`, `wireguard_tunnel_deployment.py:44`, `managed_certificate.py:61`, `acme_account.py:47`, `acme_certificate_request.py:62`.
**Cause:** Host deletion checks rule/alias/NAT/hierarchy deployments and active maintenance operations but omits VPN deployments and certificate/ACME records. Their host FKs cascade deletion. Deleting the host removes local tracking and its API secret without undeploying the remote objects. File-backed entity secrets can also outlive cascaded entity deletion.
**Impact:** Authorized cleanup can leave unintended VPN trust/tunnels/certificates live while destroying their local management records. This is an integrity/lifecycle issue requiring admin access, not a privilege escalation.
**Reproduce:** In a disposable DB, associate a host only with a deployed VPN or managed certificate. DELETE the host; inspect cascaded local records and mocked remote-call history. Do not run this on a real firewall.
**Fix:** Extend guards across every managed remote resource. Require explicit reconciliation/undeployment or a separately acknowledged orphaning workflow. Clean entity secret files only after a safe, successful cleanup; keep identifiers for partial failures. Serialize creation/deletion races with the same operation lock.
**Acceptance:** Each VPN/certificate/ACME case blocks unsafe deletion or performs the documented explicit cleanup. Partial remote failure preserves tracking and secret access needed for recovery. Ordinary undeployed-host deletion succeeds.
### SEC-10 — Durable audit misses MFA, VPN, certificate and notification changes
**Locations:** `backend/app/auth_middleware.py:65-80`; `backend/app/services/audit_service.py:27-50`; `backend/app/routers/auth.py`; `backend/app/routers/ipsec.py`, `openvpn.py`, `wireguard.py`, `certificates.py`, `notifications.py`.
**Cause:** Middleware's resource mapping covers rules, aliases, NAT, hosts and users. The transactional deployment-history hook covers rule/alias/NAT/hierarchy deployment models, not VPN/certificate/ACME. Those routers/services have no compensating durable audit events. MFA changes and password change use ordinary logs or no audit event. Raw backup downloads also are not tracked.
**Impact:** VPN trust, certificate issuance, notification disablement and account security changes can occur without attributable records in `/api/audit`. Some related operations do have audit coverage and should not be duplicated. An account's current role still restricts writes.
**Fix:** Define an explicit security event inventory and record actor, action, target, correlation ID, timestamp and safe result for each missing operation. Include secret exports and failed authorization for sensitive actions. Preserve transactional history and durable pre-operation intent where externally visible operations require it. Never audit submitted secret bodies.
**Acceptance:** Exercise success/failure for each operation class and verify durable, attributable events. Passwords, keys, cookies, webhook tokens and raw backups never appear. Interrupted remote calls have an interpretable incomplete state. Existing audit views/exports remain compatible.
### SEC-11 — Notification secrets disappear on container replacement; signing fails open
**Locations:** `backend/app/config.py:82`; `docker-compose.yml:103-134,193-205`; `backend/app/services/notification_secret_store.py:15-30`; `backend/app/services/notification_delivery.py:67-72,82-100`; `backend/app/services/notification_settings_service.py:35-49`.
**Cause:** Notification secrets default to `/data/notification-secrets`, but Compose mounts sibling secret directories individually and omits this directory. SMTP/signing material remains in the backend writable layer and disappears on recreation/update; DB `*_set` flags survive. When `webhook_signing_secret_set` is true but the file is missing, webhook delivery silently sends without a signature. Missing SMTP password can lead to sending without login or failed delivery.
**Impact:** Routine replacement can disable authenticated alert delivery or drop expected message authentication. A receiver that correctly rejects unsigned messages will reject delivery; a permissive receiver may accept unauthenticated messages. Mere container restart normally preserves the writable layer; recreation is the trigger.
**Fix:** Mount a dedicated persistent notification-secret volume and document backup/restore. Migrate existing secrets before replacing a container. If a configured secret is absent, fail closed with a safe diagnostic and visible unhealthy notification state rather than silently changing authentication behavior.
**Acceptance:** Save synthetic secrets, recreate disposable backend containers with the intended volume, and verify persistence. With signing flag true but missing file, no HTTP request is sent. With SMTP authentication configured but secret missing, no unauthenticated send occurs. Diagnose state without revealing values.
### SEC-12 — Dependency audit is no longer clean
**Locations:** `frontend/package-lock.json:710,1135,1144,3718,4068,4203`; `frontend/package.json`; `frontend/Dockerfile`; `.github/workflows/ci.yml`. Full chain/version data is in `npm-audit.json`.
**Observed versions:** `sharp 0.35.4`, `source-map-js 1.2.1`, `braces 3.0.3`, `brace-expansion 1.1.18` and nested `5.0.9`, `postcss-selector-parser 6.1.4`. npm also flags their dependent chains. Most listed packages are dev dependencies; sharp and source-map-js are not marked dev in the lockfile.
**Impact/limitations:** Registry advisories establish affected versions, not exploitability in this application. The sharp advisory discusses memory corruption under specific runtime conditions, including glibc; the supplied frontend runner is Alpine/musl. The review found no frontend `next/image` usage and demonstrated no attacker-controlled SVG decoding or remote-code execution. Other advisories concern parsing untrusted patterns/selectors/maps and are primarily build/tooling risks here. Check standalone-image contents and actual input reachability before assigning a higher product severity.
**Fix:** Refresh affected dependencies to compatible patched versions, review transitive overrides, and regenerate the lockfile. Do not blindly use `npm audit fix --force`: its suggested framework downgrade/major Tailwind changes require compatibility analysis. Audit the actual runtime image and add recurring dependency auditing to CI. Revise dated documentation that claims no known vulnerabilities without a current scan.
**Acceptance:** Fresh lockfile audit has no unresolved relevant advisories, or documented time-bounded exceptions with reachability evidence. Frontend build/lint succeed. Verify the standalone runtime uses patched native libraries. Backend audit remains clean for the resolved dependency set, and separately scan OS images.
**Verified primary references:** [sharp maintainer advisory](https://github.com/advisories/GHSA-wq5f-xc86-pv6w), [braces advisory](https://github.com/advisories/GHSA-vfj7-8cjw-p6xm). Additional advisory URLs are preserved in npm's JSON evidence. The sharp advisory lists 0.35.5 as patched; confirm compatible current releases before changing dependencies.
### SEC-13 — MFA management bypasses login attempt limiting
**Locations:** `backend/app/routers/auth.py:153-200`; `backend/app/services/auth_service.py:78-139`.
**Cause:** Setup verifies a password without the login throttle; enable checks a six-digit code without a limit; disable checks password plus second factor without a limit. Only `/login` consults/updates the throttle. Pending enrollment has no explicit expiry or session binding.
**Prerequisites/impact:** An authenticated session. A stolen session allows repeated password guesses against setup/disable; with the password, an attacker can repeatedly guess the disable second factor. An attacker with a session and a pending enrollment can try to complete it without a bounded attempt budget. Argon2 cost and network latency reduce throughput but are not an explicit attempt limit.
**Fix:** Add a bounded per-account/per-action rate limiter and short-lived, session-bound enrollment state. Require recent authentication for security-sensitive changes. Avoid resetting the attempt budget merely by recreating pending enrollment. Reuse atomic factor consumption from SEC-06.
**Acceptance:** Repeated invalid password/code requests become 429 or a documented lockout; counters and enrollment survive the supported worker model. Expired or another session's enrollment cannot enable MFA. Normal read-only self-service still works.
### SEC-14 — VPN preview approval is optional and ignores secret-only changes
**Locations:** `backend/app/routers/ipsec.py:152-160`; `backend/app/routers/openvpn.py:155-163`; `backend/app/routers/wireguard.py:164-172`; `backend/app/services/ipsec_service.py:90-100`; analogous token construction in `openvpn_service.py:109-119`, `wireguard_service.py:104-114`.
**Cause:** Deploy accepts `approval=None`, and checks the token only if supplied. Tokens are built from snapshots with secret-present booleans and masked diff rows, not the current secret's version/hash. Rotating only a PSK/private key while keeping flags true can produce the same token. The IPsec probe used an enabled synthetic target and two different PSKs and observed equal tokens.
**Impact:** An admin API call can skip the claimed preview gate, and an existing approval can apply different secret material than reviewed. This concerns change integrity/lockout prevention; admin already has deployment permission. The source explicitly describes some confirmations as UI-only, so implementing a backend gate changes that policy intentionally.
**Fix:** Make approval mandatory when preview is part of the promised safety workflow. Bind it to entity revision, resolved targets, relevant transport trust and secret version/change identifiers. Keep actual secrets and offline-guessable low-entropy secret fingerprints out of user-visible responses; use an opaque server-side approval record or keyed fingerprint where appropriate. Add expiry/single-use semantics if treating approval as an authorization artifact. Correct comparisons of raw payloads versus redacted stored payloads so unchanged secrets do not always appear modified.
**Acceptance:** Missing token fails without a remote call. Secret-only rotation invalidates old approval; metadata/target/transport changes also invalidate it. An unchanged draft permits the intended no-op. Test all three VPN types, not just IPsec. Exposed preview/revision JSON contains no plaintext secret.
### SEC-15 — Validation responses echo secret-bearing input
**Locations:** `backend/app/main.py` (default validation exception handling); `backend/app/schemas/certificates.py:57-79`; other password/key request schemas.
**Cause:** FastAPI's default validation response includes `input`. Model-level validators can include an entire submitted object; field validators can include invalid secret values. The synthetic request to `/api/certificates/managed` returned 422 containing the submitted private-key marker.
**Impact:** The submitting client already knows the value, so this alone is not cross-user disclosure. It unnecessarily puts secrets into response bodies that error telemetry, browser diagnostics or proxies may capture. Classified low rather than claiming account takeover.
**Fix:** Install a safe RequestValidationError response serializer retaining useful field locations, safe messages and codes while removing/redacting inputs and sensitive context. Do not log raw validation objects. `SecretStr` alone is insufficient unless serialization behavior is explicitly tested.
**Acceptance:** Invalid password, private key, PSK and model-level requests return useful 422 responses without markers anywhere in their JSON/logs. Non-secret validation remains understandable.
### SEC-16 — Reader settings expose webhook credentials embedded in URLs
**Locations:** `backend/app/routers/notifications.py:19-21`; `backend/app/schemas/notification.py:18-19`; `backend/app/services/notification_settings_service.py:22-32`; webhook URL column in `backend/app/models/notification.py`.
**Cause:** Settings GET returns the full webhook URL to any authenticated role. Many webhook integrations authenticate possession of a token in the URL path/query; that URL is therefore a credential, unlike an ordinary hostname. Signing-secret and SMTP-password flags correctly avoid returning those secret values but do not protect URL-embedded tokens.
**Prerequisites/impact:** A configured URL contains a capability token, and a reader account accesses settings. The reader can reuse it outside Opnexus to submit forged messages or use whatever access that receiver grants. For a token-free URL protected separately by a signature, this finding's credential impact does not apply. No real configured URLs were inspected.
**Fix:** Treat capability URLs as write-only secrets or return a carefully redacted display value. Keep a `webhook_url_set` indicator; preserve omitted values on updates and provide explicit clear/replace behavior. At minimum require an explicit privileged permission for the unredacted value. Avoid tokens in DB dumps, audit records and logs where the threat model requires secret-store separation.
**Acceptance:** Reader GET never returns a synthetic path/query token. Saving/reloading settings preserves delivery functionality. Masked UI text is not accidentally written back as the real URL. Both signed token-free URLs and capability URLs work with the intended authorization.
## Additional hardening and policy decisions
These are separate from the 16 findings above. Do not call them demonstrated remote exploits.
| ID | Locations | Observation, prerequisites and concrete next step |
|---|---|---|
| HARD-01 | `backend/Dockerfile`; `frontend/Dockerfile:13-23`; `docker-compose.yml:29-39,103` | Backend/frontend run as root; application uses the PostgreSQL bootstrap superuser. This amplifies a future application compromise. Add non-root runtime users, compatible volume ownership, reduced capabilities/no-new-privileges and a least-privileged DB role. Keep migration credentials separate. Verify runtime UID, secret-store access and migrations before rollout. |
| HARD-02 | `backend/app/security_middleware.py:25-31` | Same-origin check compares only netloc to Host, so `http://host` is accepted for an HTTPS host. Probe confirmed cross-scheme acceptance. Exploitability depends on same-site delivery and access to an insecure origin; HSTS and Secure cookies reduce it. Compare a canonical scheme/host/port origin, respecting only explicitly trusted forwarding. Add cross-scheme and default-port tests. Headerless requests being allowed is not by itself proof of browser CSRF; no such exploit was demonstrated. |
| HARD-03 | All `*_secret_store.py`; `totp_service.py:95-99`; `wireguard_key_store.py:39-44,57-62`; `backup_store.py:19-29` | Files are written before chmod 0600. With umask 022 a newly created file can briefly be 0644; writes are not atomic and follow symlinks. Requires local access to the secret directory; no remote path to that access was found. Create restrictive directories and mode-0600 temporary files at open time, avoid symlink following, then atomically replace. Test permissions before writing and crash/partial-write behavior. |
| HARD-04 | `schemas/host.py`; `tls_pin_service.py:93-113`; `notification_delivery.py:55-100`; `update_check_service.py:65-78` | Admin-controlled hosts, TLS probes and notification targets can cause outbound connections. Private targets are necessary for this product, and only admins can set these inputs; this was not classified as anonymous SSRF. Restrict schemes/ports and optionally provide operator-defined management/notification egress policy, protecting metadata services where relevant. Enforce streaming response-size limits; update-feed size is checked only after full buffering. |
| HARD-05 | `docs/HANDBUCH.md:213-217`; `proxy/Caddyfile`, `/opnexus-ca.crt` handler | First-time CA installation is bootstrapped from the same initially untrusted HTTPS endpoint, without an independent fingerprint in those instructions. An attacker on the first-use path could substitute a root users then trust system-wide. Provide an operator-side fingerprint command/out-of-band comparison before import, or use an already-trusted organizational CA. Do not tell users that encryption alone authenticates the initial download. |
| HARD-06 | `docker-compose.yml:115-116`; `.env.example`; `backend/app/config.py`, `cookie_secure` | Bundled proxy is enabled but Secure-cookie defaults remain false. Production handbook correctly says true. Make secure production defaults/validation align with the shipped TLS topology and retain an explicit local-dev mode. HSTS protects established HTTPS clients but does not replace a Secure cookie on first use. Verify cookie flags behind the proxy and HTTP-only dev behavior. |
| HARD-07 | `.github/workflows/ci.yml`, `release.yml`; Dockerfiles; `scripts/opnexus:130-139,163-166` | CI actions/base images are referenced by mutable tags, Python transitives are not fully hash-locked, and release images have no documented verified signature/provenance gate. Rollback sources a local state file as shell code; exploitation requires ability to write that trusted installation file. Pin/verify build inputs, publish/verifiably check provenance, and parse rollback state as data with strict field validation and restrictive permissions. Do not assume a new remote exploit without establishing who can modify these inputs. |
| HARD-08 | `backup_store.py`; `routers/hosts.py:231-258`; `migrate.py`, `_dump_to()`; `docker-compose.yml`, backup service | Firewall snapshots have no retention/deletion/total-size policy; downloads buffer complete responses. Database dumps are not explicitly chmod-hardened and include authentication-related records. Define backup retention/capacity, streaming caps and restrictive file modes, plus encrypted/off-host backup and complete secret-volume recovery procedures. This is availability/confidentiality hardening requiring access/usage conditions, not proof that stored backups were exposed over the network. |
## Controls checked and non-findings
- Session tokens use cryptographic randomness; only their SHA-256 hashes are stored. Passwords use Argon2. Reader write restrictions and anonymous protected-route restrictions are present. No authentication bypass was demonstrated.
- ORM queries and inspected SQL use bound parameters or trusted static statements. No request-driven SQL injection or shell-command injection path was established. Migration subprocesses use argument lists rather than a shell.
- XML restore parsing uses defusedxml, an input size check and an allowlisted metadata manifest. Raw backup export is a distinct path covered by SEC-01.
- Backup filename checks prevent straightforward directory traversal. UUID-based secret filenames do not use request-controlled arbitrary path strings.
- VPN deployment payloads are currently redacted/hashed before persistence, despite stale secret-store docstrings claiming otherwise. The report does not repeat those obsolete plaintext-payload claims as a current vulnerability. Error paths remain covered by SEC-08, and full git-history/legacy database data were not scanned.
- Inspected React content is normally escaped. The layout's `dangerouslySetInnerHTML` contains a static script; the website lightbox `innerHTML` uses static markup and two fixed language labels. No attacker-controlled HTML sink was established. The proxy's `unsafe-inline` CSP remains a defense-in-depth limitation, not proof of XSS.
- Caddy terminates TLS and adds HSTS/CSP/frame/content headers. Compose publishes backend/frontend to loopback by default and does not publish PostgreSQL. Widening `BIND_ADDRESS` can expose HTTP directly; operators should keep the documented proxy topology.
- Firewall TLS pinning uses a verifying trust context; the unauthenticated probe is deliberately only a fingerprint-discovery step. Trusting an uploaded CA intentionally trusts certificates it signs and is not identical to an exact leaf fingerprint pin. Confirm the chosen trust scope in UI/docs.
- Maintenance execute checks bind preview to actor, host, freshness and observed state and consume it before a non-idempotent remote action. VPN approval is weaker and is separately covered by SEC-14.
- Audit UPDATE/DELETE triggers exist. They are useful accidental-tampering controls, not resistance to the application database superuser, which can disable triggers/truncate tables.
## Remediation execution order
1. Implement explicit secret-export authorization, atomic credential/session revocation, verifying SMTP TLS and durable uncertain-deployment recovery (SEC-01–04).
2. Reject plaintext firewall URLs by default and make production transport settings consistent (SEC-05, HARD-06).
3. Make MFA consumption atomic and bound every authentication/security-management attempt path (SEC-06, SEC-07, SEC-13).
4. Remove raw-error/validation secret reflection, protect capability URLs and persist notification secrets with fail-closed delivery (SEC-08, SEC-11, SEC-15, SEC-16).
5. Guard managed-resource lifecycle, complete durable auditing and bind VPN approval to current secret versions (SEC-09, SEC-10, SEC-14).
6. Update dependencies after compatibility/reachability analysis, then apply infrastructure/build/backup hardening (SEC-12, HARD-01–08).
For each ticket, report the final affected files, regression evidence, migration/backward-compatibility consequences and unresolved limitations. Keep deployment approval separate from implementation work. A clean dependency scan or passing mocks alone must not be described as proof the whole product is secure.
## Remediation status (2026-10-07, Claude Code)
Every finding was re-checked against the source before changing it; all 16 SEC findings were confirmed as described (SEC-03 by reading `smtplib` in the Python 3.12 image, SEC-11 by listing `/data` in the live backend container: no `notification-secrets`, and no notification secrets are configured there). Regression tests: `backend/tests/test_security_review.py` (42 tests); full backend suite 475 passed. Nothing was deployed and no firewall was contacted; the frontend lint/typecheck/build passed in a scratch copy.
| ID | Status | What was done / what remains |
|---|---|---|
| SEC-01 | Fixed | Raw backup download is admin-only (403 `READ_ONLY_ACCESS` otherwise), listing stays visible; every attempt audited (`backup/download`, status `accepted`/`denied`); UI hides the button for readers. |
| SEC-02 | Fixed | Password change/reset revoke all sessions atomically with the new hash; admin 2FA reset revokes all; 2FA enable/disable revoke the *other* sessions; login re-checks the password hash under a row lock so a login racing a reset cannot create a session. |
| SEC-03 | Fixed | Verifying `ssl.create_default_context()` for SSL and STARTTLS (optional `SMTP_CA_FILE`); authenticated plaintext SMTP refused unless `ALLOW_INSECURE_SMTP_AUTH`. |
| SEC-04 | Fixed | New shared write path `services/deploy_flow.py` (all six deploy types): a durable intent row is committed before the first remote call (existing deployment: armed pending with previous payload; first deployment: `revert_failed` = "outcome unknown", blocks retries, notifies, "Rollback wiederholen" forgets it); UUID committed right after a confirmed write; failed apply keeps the deadline; timeouts/lost replies/5xx are classed ambiguous (`OpnsenseAmbiguousError`), connect failures and answered refusals are plain errors. Residual: a crash in the few milliseconds between the firewall executing `addRule` and the intent row being the only trace leaves the "unknown" row, which needs a manual look by design. |
| SEC-05 | Fixed, one deliberate gap | `http://`, userinfo, query/fragment rejected on create and in the client (existing rows get "offline", no credentials sent); `ALLOW_INSECURE_FIREWALL_URLS` as explicit override. `verify_tls=false` over HTTPS is **kept**: it is an existing explicit opt-in (pinning is the supported alternative). |
| SEC-06 | Fixed | User row re-read `FOR UPDATE` before consuming a TOTP step or recovery code; concurrent-request tests with the real database. |
| SEC-07 | Mostly fixed | Bounded/expiring throttle state, Argon2 in a bounded thread pool (4 concurrent, 32 queued, then 503/429), 2 MB request-body cap in Caddy. **Not changed:** the missing-MFA-code path is not counted as a failure (counting it would lock out ordinary two-step logins; the password was already correct and the cost is now bounded); the limiter stays per process (the backend runs one uvicorn worker). |
| SEC-08 | Fixed | Upstream error bodies are scrubbed (secret-named JSON fields, PEM blocks, key=value pairs, the host's own key/secret) and cut to 300 characters where the exception is built, so status, maintenance, deploy messages, DB rows and logs all get the safe form; webhook delivery errors no longer contain the URL. |
| SEC-09 | Fixed | Deletion blocked while VPN deployments or deployed certificate/ACME objects exist; secret files of never-deployed drafts are removed with the host. |
| SEC-10 | Fixed | Middleware now records VPN, certificate/ACME, notification, MFA/password and user-admin operations, plus denied writes of read-only accounts. Paths only — no bodies, no query strings. |
| SEC-11 | Fixed | `notification_secrets` volume + `NOTIFICATION_SECRET_DIR` in `docker-compose.yml`; missing signing secret/SMTP password now fails closed. No migration needed on the live instance (no secrets stored there); `docker compose up -d` creates the volume. |
| SEC-12 | Partly fixed | Lockfile refreshed (`sharp` 0.35.5, `source-map-js` 1.2.2, `brace-expansion`); these were the only findings present in the runtime image. Remaining 9 npm findings are build tooling (Tailwind 3/ESLint chain), no patched `braces` exists, `postcss-selector-parser` fix needs a Tailwind major. Re-scan the image after the next build; no recurring audit job added to CI yet. |
| SEC-13 | Fixed, one gap | Attempt budget on 2FA setup/enable/disable and password change (not reset by a new enrolment); pending enrolment expires after 15 minutes. Session binding of the enrolment not added. |
| SEC-14 | Fixed | Approval token mandatory for all three VPN types, bound to the stored secret's version (no secret-derived value in the token); preview now compares in the redacted form, so unchanged secrets no longer show as modified. Expiry/single-use not added. |
| SEC-15 | Fixed | Custom 422 handler returns only `loc`/`msg`/`type`. |
| SEC-16 | Fixed | Non-admins get the webhook URL reduced to scheme/host/port. |
| HARD-02 | Fixed | Same-host origins must be `https` when `COOKIE_SECURE=true`. |
| HARD-03 | Fixed | Secret files are created 0600 under a temp name with `O_EXCL|O_NOFOLLOW`, fsynced and renamed into place. |
| HARD-05 | Documented | Handbook now gives the fingerprint comparison before importing the CA. |
| HARD-06 | Partly | Startup warning when `FRONTEND_ORIGIN` is https but `COOKIE_SECURE` is false; the compose default is unchanged (would break HTTP development). |
| HARD-01, 04, 07, 08 | Open | Non-root containers/least-privilege DB role (volume ownership and migration role need a rollout plan), egress policy and streaming limits, CI pinning/signing and `scripts/opnexus` state-file parsing, backup retention/permissions — separate work items. |
Rollout notes: rebuild backend, frontend **and proxy** images (Caddyfile is baked in); apply the lockfile with the frontend rebuild; no database migration.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 119 KiB

Loaded 100 of 148 files, more files were not shown because too many files have changed in this diff. Show more