Files
OPNexus/backend/app/services/oidc_service.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

289 lines
13 KiB
Python

"""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, url_guard
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_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 url_guard.guarded_client(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) -> tuple[str, str]:
"""Remember a fresh login attempt and return the provider URL to send the browser to."""
doc = await discovery(cfg.issuer)
state, nonce, verifier = secrets.token_urlsafe(32), secrets.token_urlsafe(24), secrets.token_urlsafe(48)
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}", state
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 url_guard.guarded_client(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):
# Group names may contain spaces ("Network Admins"): a string claim is split on commas and line breaks only.
return [g.strip() for g in re.split(r"[,\n]+", value) if g.strip()]
if isinstance(value, list):
return [str(g) for g in value]
return []
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 _userinfo(doc: dict, claims: dict, access_token: str | None) -> dict:
"""The provider's userinfo answer for THIS identity ({} if there is none or it belongs to somebody else)."""
if access_token and str(doc.get("userinfo_endpoint", "")).startswith("https://"):
info = await _get_json(doc["userinfo_endpoint"], headers={"Authorization": f"Bearer {access_token}"})
if info.get("sub") == claims.get("sub"): # a userinfo answer for someone else is worthless
return info
return {}
async def _groups(cfg: OidcSettings, doc: dict, claims: dict, access_token: str | None) -> list[str]:
if cfg.groups_claim in claims:
return _as_groups(claims[cfg.groups_claim])
return _as_groups((await _userinfo(doc, claims, access_token)).get(cfg.groups_claim))
async def _with_display_name(doc: dict, claims: dict, access_token: str | None) -> dict:
"""Some providers (Authelia) keep preferred_username/email out of the ID token: ask userinfo, else the user would be named
after the opaque ``sub``. Best effort: a failing userinfo call must not block a login that already has its role."""
if claims.get("preferred_username") or claims.get("email"):
return claims
try:
info = await _userinfo(doc, claims, access_token)
except OidcError:
return claims
return {**claims, **{k: info[k] for k in ("preferred_username", "email") if info.get(k)}}
def _username(claims: dict) -> str:
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, await _with_display_name(doc, claims, tokens.get("access_token")), role)