Files
OPNexus/backend/app/services/notification_delivery.py
T
Julian Boldt ec20940139
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
Release v1.29.0
- **Fehlende API-Rechte werden sichtbar:** Darf der API-Schlüssel einer Firewall den Gateway- oder Dienststatus nicht lesen (OPNsense antwortet
  mit 403), fiel das bisher niemandem auf, und der standardmäßig aktive Gateway-Alarm konnte nie auslösen. Jetzt zeigen die Host-Seite
  (Abschnitt „Gateways“) und die Dashboard-Karte „Fleet-/CARP-Gesundheit“ ein Warn-Badge „API-Rechte fehlen: Gateways, Dienste“; der Tooltip nennt die
  OPNsense-Berechtigung, die beim Benutzer oder bei der Gruppe fehlt (System: Gateways, Status: Services, Lobby: Dashboard). Zusätzlich gibt es
  den neuen Alarm **API-Rechte fehlen** (standardmäßig an, abschaltbar unter Einstellungen › Benachrichtigungen, gleiche Entprellung wie die
  anderen Messungs-Alarme) und die Prometheus-Metrik `opnexus_host_api_rights_missing{host,read}`. Nur eine ausdrückliche Ablehnung zählt;
  Zeitüberschreitungen oder Serverfehler bleiben „unbekannt“.
- **Gateway-Alarm pro Gateway abschaltbar:** In der Gateway-Liste der Host-Seite schaltet eine Glocke den Alarm für ein einzelnes Gateway aus
  (z. B. ruhendes Zweit-WAN oder tote IPv6-Gateways); ein „Alarm aus“-Badge zeigt es an. Ein offener Alarm dieses Gateways löst sich dabei
  auf. Nur Administratoren, die Änderung steht im Audit-Log. Das Dashboard zeigt bei mehr als acht Gateways „+ N weitere“.
- **Firewall-Oberfläche (GUI-Zugriff) härter:** Ein frei gewordener Platz wird für eine **andere** Firewall erst 5 Minuten nach dem Ende der letzten
  Sitzung vergeben (Schutz, falls dort noch ein Tab offen ist, der die Cookies des Platzes teilt); dieselbe Firewall bekommt ihn sofort wieder.
  Sind alle Plätze belegt oder noch in der Abkühlzeit, nennt die Meldung den Grund. Ändern sich Adresse, festgesetztes Zertifikat oder Tunnelweg
  einer Firewall, während ihre Oberfläche offen ist, endet die Sitzung spätestens nach 20 Sekunden. Das Limit von 64 gleichzeitigen Sitzungen
  verdrängt keine laufende Sitzung mehr: eine neue wird abgelehnt (mit Meldung), bis eine endet. **Hinweis:** Das GUI-Gateway-Image muss zur
  Backend-Version passen (wie bisher beim Update beider Container).
- **Anmeldung (Cookies) härter:** Das alte Sitzungs-Cookie `opnexus-session` wird bei HTTPS **nicht mehr akzeptiert**. **Alle, die sich seit der
  Umstellung auf 1.27 nicht neu angemeldet haben, müssen sich einmal neu anmelden**; Skripte mit rohem Sitzungs-Cookie brauchen den Namen
  `__Host-opnexus-session` (API-Tokens sind nicht betroffen, ohne HTTPS bleibt `opnexus-session` der normale Name). Beim Abmelden wird ein altes
  Cookie weiterhin gelöscht. Das Cookie, das die SSO-Anmeldung an den Browser bindet, heißt bei HTTPS jetzt `__Host-opnexus-oidc-state`; der
  Rückweg vom Anbieter wird nur noch als Seitenaufruf (Navigation) von einer fremden Seite zugelassen, und ohne dieses Cookie scheitert er immer.
- **Webhook, Benachrichtigungskanäle und SSO-Anbieter: Schutz vor DNS-Rebinding:** Bisher prüfte OPNexus die Adresse, auf die ein Name zeigt, und
  der HTTP-Client löste den Namen danach noch einmal auf; ein Server unter Fremdkontrolle konnte beim zweiten Mal eine interne Adresse liefern. Jetzt
  verbindet OPNexus genau zu der geprüften Adresse (Host-Name, TLS-Zertifikatsprüfung und Anfrage bleiben beim Namen); zeigt eine Antwort auch nur
  teilweise auf Loopback, Link-Local oder einen Cloud-Metadaten-Dienst (auch AWS-IPv6 und Alibaba), kommt keine Verbindung zustande und die Zustellung meldet „Zieladresse nicht
  erlaubt“. Private Netze bleiben erlaubt (eigener ntfy, Gotify, Matrix). Proxy-Umgebungsvariablen werden für diese Aufrufe nicht mehr beachtet.
- **Benachrichtigungen parallel zugestellt:** Webhook, E-Mail und alle Kanäle werden gleichzeitig bedient, jeder mit eigener Zeitgrenze (20 Sekunden),
  und ein Prüfdurchlauf sendet insgesamt höchstens 90 Sekunden. Ein hängender Kanal verzögert weder die anderen noch die nächsten Prüfungen; im Log
  steht dann „timed out“ (ohne Adresse oder Token). Wie bisher wird einmal je Ereignis zugestellt, ohne Wiederholung, **außer** der Durchlauf war so voll, dass
  für ein Ereignis noch gar kein Versuch stattfand: es wird im nächsten Durchlauf zugestellt. Die Zustellung beginnt jetzt nach allen Prüfungen
  eines Durchlaufs statt mitten darin.
- **Rollouts: Fingerabdruck, verantwortliche Person, überlappende Termine:** Der Fingerabdruck eines aktivierten Plans umfasst jetzt auch die
  ausgelassenen und verschobenen Termine seines Fensters: **wer einen Termin auslässt oder verschiebt, muss einen automatischen Plan danach neu
  aktivieren** (ohne solche Ausnahmen bleiben bestehende Aktivierungen gültig; **Pläne, deren Fenster schon Ausnahmen haben, nach dem Update
  einmal neu aktivieren**, sonst meldet der Plan „Plan geändert“ und startet nicht automatisch). Die verantwortliche Person (Aktivierende, Startende, Freigebende)
  wird zusätzlich als Konto-ID gespeichert (Migration 0026, bestehende Einträge werden über den Namen zugeordnet): ein gelöschtes und unter gleichem
  Namen neu angelegtes Konto gilt nicht mehr als dieselbe Person, der Lauf pausiert bzw. der automatische Start unterbleibt mit „Person darf nicht mehr
  ausrollen“. Angezeigt wird weiter der Benutzername. Überlappen sich zwei Termine eines Wartungsfensters, zählt der zuletzt begonnene (bisher der
  früheste), sodass ein älterer, längst abgeschnittener Termin keinen neuen Start mehr blockiert.
- **Kleinigkeiten:** Ressourcen-Alarme zeigen bei fehlendem Messwert keine Zahl mehr („None %“ entfällt). Der Dialog „Von Firewall übernehmen“ zeigt ohne aktive
  Firewall einen Hinweis statt dauerhaft „Lädt…“. Fehlermeldungen beim Übernehmen und Verknüpfen nennen die Gründe in Klartext (Deutsch/Englisch) statt
  roher Codes wie `name_exists`; dasselbe gilt für „GUI-Zugriff nicht eingerichtet“ und blockierte Netzwerkänderungen. Der Test-Knopf der
  Benachrichtigungskanäle ist für Nicht-Admins ausgeblendet (der Server verweigert den Test ohnehin). Der Tooltip der aktiven Plätze nennt keine
  Umgebungsvariable mehr. Eine Gateway-Sitzung, die der Gateway-Container nicht mehr bestätigt (Absturz), zählt für die Abkühlzeit der Plätze als
  beendet.
- **Grafana-Dashboard erweitert:** neue Felder für Gateways (erreichbar, Paketverlust, Latenz), Swap, gestoppte Dienste, fehlende API-Rechte und
  Rollouts nach Status; dazu die Metrik `opnexus_rollout_runs{status}`.
2026-10-22 01:58:06 +02:00

162 lines
7.0 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""Webhook + email delivery for notification_service.py. Webhook uses httpx
(already the project's only HTTP client); email uses stdlib smtplib/email,
run via asyncio.to_thread since smtplib is blocking — no new dependency
needed (requirements.txt has no SMTP library, and this project deliberately
avoids adding dependencies where the standard library already covers it).
"""
import asyncio
import hashlib
import hmac
import json
import smtplib
import ssl
from email.message import EmailMessage
import httpx
from app.config import settings
from app.models.notification import NotificationProblem, NotificationSettings
from app.services import notification_secret_store, url_guard
class NotificationDeliveryError(Exception):
pass
_LABELS = {
"host_offline": "Host nicht erreichbar",
"cert_expiry": "Zertifikat läuft ab",
"rule_drift": "Regel-Drift im Cluster",
"revert_failed": "Rollback fehlgeschlagen",
"maintenance_unknown": "Wartungsergebnis unklar",
"carp_split_brain": "CARP-Zustand kritisch",
"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",
"compliance_finding": "Sicherheitsbefund",
"gateway_down": "Gateway gestört",
"resource_threshold": "Ressourcen-Schwelle überschritten",
"service_down": "Dienst ausgefallen",
"api_rights_missing": "API-Rechte fehlen",
"rollout_paused": "Rollout angehalten",
"rollout_start_failed": "Rollout nicht automatisch gestartet",
"test": "Testbenachrichtigung",
}
def render_message(problem: NotificationProblem, transition: str) -> tuple[str, str]:
"""transition: "opened" | "resolved". Single source of copy for both
delivery channels, so webhook and email never drift in wording."""
label = _LABELS.get(problem.problem_type, problem.problem_type)
if transition == "resolved":
subject = f"OPNexus: {label} behoben"
else:
subject = f"OPNexus: {label}"
lines = [subject, ""]
for key, value in problem.context.items():
if value in (None, "", []):
continue
lines.append(f"{key}: {value}")
body = "\n".join(lines)
return subject, body
async def send_webhook(settings_row: NotificationSettings, problem: NotificationProblem, transition: str) -> None:
if not settings_row.webhook_url:
raise NotificationDeliveryError("Keine Webhook-URL konfiguriert")
subject, body = render_message(problem, transition)
payload = {
"problem_type": problem.problem_type,
"transition": transition,
"subject": subject,
"message": body,
"context": problem.context,
}
raw = json.dumps(payload).encode("utf-8")
headers = {"Content-Type": "application/json"}
if settings_row.webhook_signing_secret_set:
secret = notification_secret_store.read_secret("webhook_signing_secret")
if not secret:
# Fail closed: silently sending an UNSIGNED message to a receiver that
# was told to expect signatures would change the authentication
# behaviour without anyone noticing.
raise NotificationDeliveryError(
"Signaturschlüssel für den Webhook ist konfiguriert, aber nicht lesbar – bitte neu setzen"
)
signature = hmac.new(secret.encode("utf-8"), raw, hashlib.sha256).hexdigest()
headers["X-OPNexus-Signature"] = f"sha256={signature}"
try:
url_guard.validate_url(settings_row.webhook_url)
await url_guard.ensure_resolved_safe(settings_row.webhook_url)
except ValueError as exc:
raise NotificationDeliveryError(f"Webhook-Adresse nicht erlaubt: {exc}") from None
try:
# follow_redirects stays off: a redirect must not move the request to an address the check above never saw.
async with url_guard.guarded_client(timeout=settings.opnsense_timeout, follow_redirects=False) as client:
with url_guard.muted():
resp = await client.post(settings_row.webhook_url, content=raw, headers=headers)
resp.raise_for_status()
except httpx.HTTPError as exc:
# str(exc) names the full URL, which often is the credential itself
# (token in path/query) — keep it out of messages and logs.
reason = url_guard.failure_reason(exc)
raise NotificationDeliveryError(f"Webhook-Zustellung fehlgeschlagen ({reason})") from None
def _tls_context() -> ssl.SSLContext:
"""Verifying context (certificate chain AND hostname). smtplib's own default
when no context is passed is an *unverifying* one — the connection would be
encrypted but could be impersonated."""
return ssl.create_default_context(cafile=settings.smtp_ca_file or None)
def _send_email_sync(settings_row: NotificationSettings, subject: str, body: str) -> None:
password = notification_secret_store.read_secret("smtp_password")
authenticated = bool(settings_row.smtp_username and settings_row.smtp_password_set)
if authenticated and not password:
raise NotificationDeliveryError("SMTP-Passwort ist konfiguriert, aber nicht lesbar – bitte neu setzen")
if authenticated and settings_row.smtp_security == "none" and not settings.allow_insecure_smtp_auth:
raise NotificationDeliveryError(
"SMTP-Anmeldung ohne Verschlüsselung ist deaktiviert – STARTTLS oder SSL/TLS wählen"
)
message = EmailMessage()
message["Subject"] = subject
message["From"] = settings_row.smtp_from_address
message["To"] = ", ".join(settings_row.smtp_to_addresses)
message.set_content(body)
timeout = settings.notification_smtp_timeout_seconds
if settings_row.smtp_security == "ssl":
client = smtplib.SMTP_SSL(
settings_row.smtp_host, settings_row.smtp_port, timeout=timeout, context=_tls_context()
)
else:
client = smtplib.SMTP(settings_row.smtp_host, settings_row.smtp_port, timeout=timeout)
try:
if settings_row.smtp_security == "starttls":
client.starttls(context=_tls_context())
if authenticated:
client.login(settings_row.smtp_username, password)
client.send_message(message)
finally:
try:
client.quit()
except (smtplib.SMTPException, OSError):
client.close()
async def send_email(settings_row: NotificationSettings, subject: str, body: str) -> None:
if not settings_row.smtp_host or not settings_row.smtp_from_address or not settings_row.smtp_to_addresses:
raise NotificationDeliveryError("SMTP-Konfiguration unvollständig")
try:
await asyncio.to_thread(_send_email_sync, settings_row, subject, body)
except NotificationDeliveryError:
raise
except (OSError, smtplib.SMTPException) as exc:
raise NotificationDeliveryError(f"E-Mail-Zustellung fehlgeschlagen: {exc}") from exc