The gated dashboard verifies a session cookie by trying each registered DashboardAuthProvider's verify_session in turn (the session cookie stores only the access token, not which provider issued it). A provider that doesn't recognise a token returns None; a provider whose IDP/JWKS is unreachable raises ProviderError. The loop used to return HTTP 503 on the FIRST ProviderError, before any later provider got a turn. With multiple providers stacked, that means an unreachable IDP for a session you didn't even use blocks login through a different, reachable provider. Concrete repro: a self-hosted-OIDC session hits the 'nous' provider first (registered earlier); nous tries to reach Nous Portal's JWKS, which is unreachable in a self-hosted deployment, so it raises — and the gate 503s before the 'self-hosted' provider can verify the token. Hit live while testing the new self-hosted OIDC plugin against a local Keycloak. Fix: a ProviderError from one provider is logged and the loop continues to the next. A 503 is returned only if NO provider verified the token AND at least one was unreachable — distinguishing a transient IDP outage (don't force a needless re-login) from a token that's genuinely invalid (fall through to refresh/relogin). Single-provider behaviour is unchanged. Tests: adds an _UnreachableProvider stub and three cases — unreachable provider first must not block a working second; all-unreachable still 503s; reachable-but-unrecognised falls through to 401/relogin (not 503). Mutation-tested: reverting the fix makes the first case fail with the exact 503 bug.
467 lines
18 KiB
Python
467 lines
18 KiB
Python
"""End-to-end behavioural tests for the dashboard auth gate.
|
|
|
|
Uses ``StubAuthProvider`` so the OAuth round trip can complete in-process
|
|
without any external IDP. Exercises:
|
|
|
|
* `/api/status` flips from public (loopback) to gated (auth_required)
|
|
* `/` redirects to /login when no cookie present
|
|
* `/api/auth/providers` is the public bootstrap endpoint
|
|
* `/login` renders HTML listing all providers
|
|
* /assets/* still passes through unauthenticated
|
|
* Full /auth/login → /auth/callback → / round trip with the stub
|
|
* Invalid / missing cookies return 401 (api) or 302 (html)
|
|
* Zero-providers + gate-on fails closed
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
import pytest
|
|
|
|
# Phase 5 / Phase 6: these tests mutate ``web_server.app.state.auth_required``
|
|
# at module level. Run them in the same xdist worker so they don't race
|
|
# against each other (and against any other file that also touches
|
|
# ``app.state``) — the marker name is shared across all dashboard-auth test
|
|
# files that gate the app.
|
|
pytestmark = pytest.mark.xdist_group("dashboard_auth_app_state")
|
|
from fastapi.testclient import TestClient
|
|
|
|
from hermes_cli import web_server
|
|
from hermes_cli.dashboard_auth import clear_providers, register_provider
|
|
from hermes_cli.dashboard_auth.cookies import SESSION_AT_COOKIE
|
|
from tests.hermes_cli.conftest_dashboard_auth import StubAuthProvider
|
|
|
|
|
|
@pytest.fixture
|
|
def gated_app():
|
|
"""Configure web_server.app for gated mode + register the stub provider."""
|
|
clear_providers()
|
|
register_provider(StubAuthProvider())
|
|
prev_host = getattr(web_server.app.state, "bound_host", None)
|
|
prev_port = getattr(web_server.app.state, "bound_port", None)
|
|
prev_required = getattr(web_server.app.state, "auth_required", None)
|
|
web_server.app.state.bound_host = "fly-app.fly.dev"
|
|
web_server.app.state.bound_port = 443
|
|
web_server.app.state.auth_required = True
|
|
# Use https base_url so cookies pick up Secure flag and host_header
|
|
# matches the bound interface.
|
|
client = TestClient(web_server.app, base_url="https://fly-app.fly.dev")
|
|
yield client
|
|
clear_providers()
|
|
web_server.app.state.bound_host = prev_host
|
|
web_server.app.state.bound_port = prev_port
|
|
web_server.app.state.auth_required = prev_required
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Allowlist (public) routes
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_gated_status_is_public(gated_app):
|
|
"""``/api/status`` MUST be public under the OAuth gate.
|
|
|
|
Regression guard for the wildcard-subdomain rollout: NAS
|
|
(``fly-provider.ts`` ``getInstanceRuntimeStatus``) hits
|
|
``/api/status`` without a cookie as its sole liveness probe. A 401
|
|
here surfaces every healthy agent as STARTING/down in the portal
|
|
UI. The endpoint returns only version + gateway/auth-gate metadata
|
|
(no user data, no session content), so it stays in the shared
|
|
``PUBLIC_API_PATHS`` allowlist under both the legacy ``_SESSION_TOKEN``
|
|
gate and the OAuth gate.
|
|
|
|
The body also reports the gate's shape (``auth_required``,
|
|
``auth_providers``) so the SPA's StatusPage and external monitors
|
|
can distinguish loopback / gated / no-providers without a separate
|
|
round trip.
|
|
"""
|
|
r = gated_app.get("/api/status")
|
|
assert r.status_code == 200, (
|
|
f"Expected 200, got {r.status_code}: {r.text}"
|
|
)
|
|
body = r.json()
|
|
assert body["auth_required"] is True
|
|
assert "version" in body
|
|
assert "gateway_state" in body
|
|
|
|
|
|
@pytest.mark.parametrize("path", [
|
|
"/api/config/defaults",
|
|
"/api/config/schema",
|
|
"/api/model/info",
|
|
"/api/dashboard/themes",
|
|
"/api/dashboard/plugins",
|
|
])
|
|
def test_other_public_api_paths_are_public_under_gate(gated_app, path):
|
|
"""The remaining ``PUBLIC_API_PATHS`` entries must also bypass the
|
|
gate. They're documented as non-sensitive read-only endpoints that
|
|
the SPA pre-loads before login (themes, config schema, model
|
|
metadata). A 401 / 302-to-login here would block the dashboard
|
|
shell from rendering pre-auth.
|
|
|
|
Accept any non-auth-failure status: 200 when the route succeeds,
|
|
or any route-specific error (e.g. 400 / 404 / 500 from a missing
|
|
dependency) — but NEVER 401, and NEVER a 302 to ``/login``.
|
|
"""
|
|
r = gated_app.get(path, follow_redirects=False)
|
|
assert r.status_code != 401, (
|
|
f"{path} returned 401 under the OAuth gate — should be public"
|
|
)
|
|
if r.status_code == 302:
|
|
location = r.headers.get("location", "")
|
|
assert "/login" not in location, (
|
|
f"{path} redirected to {location} — should be public, "
|
|
"not bounced to /login"
|
|
)
|
|
|
|
|
|
def test_gated_html_redirects_to_login(gated_app):
|
|
r = gated_app.get("/", follow_redirects=False)
|
|
assert r.status_code == 302
|
|
# Phase 6: gate carries a ``next=`` so post-login bounces back to /.
|
|
assert r.headers["location"] in ("/login", "/login?next=%2F")
|
|
|
|
|
|
def test_gated_auth_providers_is_public(gated_app):
|
|
r = gated_app.get("/api/auth/providers")
|
|
assert r.status_code == 200
|
|
body = r.json()
|
|
assert any(p["name"] == "stub" for p in body["providers"])
|
|
assert body["providers"][0]["display_name"] == "Stub IdP (test only)"
|
|
|
|
|
|
def test_gated_login_html_is_public_and_lists_providers(gated_app):
|
|
r = gated_app.get("/login")
|
|
assert r.status_code == 200
|
|
assert r.headers["content-type"].startswith("text/html")
|
|
assert "Stub IdP" in r.text
|
|
assert 'href="/auth/login?provider=stub"' in r.text
|
|
|
|
|
|
def test_gated_static_asset_path_is_public(gated_app):
|
|
"""``/assets/*`` is allowlisted so the SPA's CSS/JS loads pre-login."""
|
|
r = gated_app.get("/assets/_nonexistent.css")
|
|
# 404 not 401 — proves middleware let the request through to the
|
|
# static-files mount, which then 404'd because the file isn't there.
|
|
assert r.status_code == 404
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# OAuth round trip
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_full_login_round_trip_unlocks_gated_api(gated_app):
|
|
# 1) Click "Sign in with Stub IdP" — /auth/login redirects to the stub
|
|
# with a PKCE cookie on the response.
|
|
r1 = gated_app.get("/auth/login?provider=stub", follow_redirects=False)
|
|
assert r1.status_code == 302
|
|
pkce = next(
|
|
(c for c in r1.headers.get_list("set-cookie")
|
|
if "hermes_session_pkce" in c),
|
|
None,
|
|
)
|
|
assert pkce and "HttpOnly" in pkce
|
|
|
|
redirect = r1.headers["location"]
|
|
# Stub bounces back to {redirect_uri}?code=stub_code&state=<s>
|
|
assert "code=stub_code" in redirect
|
|
assert "state=" in redirect
|
|
state = redirect.split("state=")[1]
|
|
|
|
# 2) The browser would now follow the redirect to /auth/callback.
|
|
# TestClient automatically carries the PKCE cookie forward.
|
|
r2 = gated_app.get(
|
|
f"/auth/callback?code=stub_code&state={state}",
|
|
follow_redirects=False,
|
|
)
|
|
assert r2.status_code == 302
|
|
assert r2.headers["location"] == "/"
|
|
set_cookies = r2.headers.get_list("set-cookie")
|
|
assert any("hermes_session_at" in c for c in set_cookies)
|
|
assert any("hermes_session_rt" in c for c in set_cookies)
|
|
|
|
# 3) A gated API route (``/api/sessions``) now succeeds because we
|
|
# have a valid session cookie. (We deliberately don't probe
|
|
# ``/api/status`` here — it's in the shared PUBLIC_API_PATHS
|
|
# allowlist and would 200 even without a login, so it can't
|
|
# distinguish "logged in" from "gate accidentally disabled".)
|
|
r3 = gated_app.get("/api/sessions")
|
|
assert r3.status_code == 200, (
|
|
f"Expected 200 for /api/sessions post-login, got {r3.status_code}: "
|
|
f"{r3.text}"
|
|
)
|
|
|
|
|
|
def test_login_unknown_provider_returns_404(gated_app):
|
|
r = gated_app.get("/auth/login?provider=nonexistent", follow_redirects=False)
|
|
assert r.status_code == 404
|
|
|
|
|
|
def test_callback_without_pkce_cookie_returns_400(gated_app):
|
|
# No prior /auth/login → no PKCE cookie.
|
|
r = gated_app.get(
|
|
"/auth/callback?code=stub_code&state=anything",
|
|
follow_redirects=False,
|
|
)
|
|
assert r.status_code == 400
|
|
|
|
|
|
def test_callback_state_mismatch_returns_400(gated_app):
|
|
# Walk through /auth/login first to plant the PKCE cookie.
|
|
r1 = gated_app.get("/auth/login?provider=stub", follow_redirects=False)
|
|
# ...then pretend the IDP returned a different state.
|
|
r2 = gated_app.get(
|
|
"/auth/callback?code=stub_code&state=WRONG",
|
|
follow_redirects=False,
|
|
)
|
|
assert r2.status_code == 400
|
|
|
|
|
|
def test_callback_invalid_code_returns_400(gated_app):
|
|
r1 = gated_app.get("/auth/login?provider=stub", follow_redirects=False)
|
|
state = r1.headers["location"].split("state=")[1]
|
|
r2 = gated_app.get(
|
|
f"/auth/callback?code=BAD_CODE&state={state}",
|
|
follow_redirects=False,
|
|
)
|
|
assert r2.status_code == 400
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Cookie validation
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_invalid_cookie_returns_401_on_api(gated_app):
|
|
gated_app.cookies.set(SESSION_AT_COOKIE, "garbage-not-a-real-token")
|
|
r = gated_app.get("/api/sessions")
|
|
assert r.status_code == 401
|
|
|
|
|
|
def test_invalid_cookie_redirects_on_html(gated_app):
|
|
gated_app.cookies.set(SESSION_AT_COOKIE, "garbage")
|
|
r = gated_app.get("/", follow_redirects=False)
|
|
assert r.status_code == 302
|
|
# Phase 6: gate carries a ``next=`` so post-login bounces back to /.
|
|
assert r.headers["location"] in ("/login", "/login?next=%2F")
|
|
|
|
|
|
def test_logout_clears_cookies_and_redirects_to_login(gated_app):
|
|
# First log in.
|
|
r1 = gated_app.get("/auth/login?provider=stub", follow_redirects=False)
|
|
state = r1.headers["location"].split("state=")[1]
|
|
gated_app.get(
|
|
f"/auth/callback?code=stub_code&state={state}",
|
|
follow_redirects=False,
|
|
)
|
|
# Now log out.
|
|
r = gated_app.post("/auth/logout", follow_redirects=False)
|
|
assert r.status_code == 302
|
|
assert r.headers["location"] == "/login"
|
|
set_cookies = r.headers.get_list("set-cookie")
|
|
assert any(
|
|
c.startswith("hermes_session_at=") and "Max-Age=0" in c
|
|
for c in set_cookies
|
|
)
|
|
assert any(
|
|
c.startswith("hermes_session_rt=") and "Max-Age=0" in c
|
|
for c in set_cookies
|
|
)
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Identity probe
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_api_auth_me_returns_session_after_login(gated_app):
|
|
r1 = gated_app.get("/auth/login?provider=stub", follow_redirects=False)
|
|
state = r1.headers["location"].split("state=")[1]
|
|
gated_app.get(
|
|
f"/auth/callback?code=stub_code&state={state}",
|
|
follow_redirects=False,
|
|
)
|
|
r = gated_app.get("/api/auth/me")
|
|
assert r.status_code == 200
|
|
body = r.json()
|
|
assert body["user_id"] == "stub-user-1"
|
|
assert body["email"] == "stub@example.test"
|
|
assert body["display_name"] == "Stub User"
|
|
assert body["provider"] == "stub"
|
|
assert body["org_id"] == "stub-org-1"
|
|
assert "expires_at" in body
|
|
|
|
|
|
def test_api_auth_me_requires_auth(gated_app):
|
|
# No cookies.
|
|
r = gated_app.get("/api/auth/me")
|
|
assert r.status_code == 401
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Zero-providers fail-closed
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_gated_zero_providers_fails_closed_on_api_auth_providers():
|
|
"""If gate is on but no providers are registered, /api/auth/providers 503s."""
|
|
clear_providers()
|
|
prev_required = getattr(web_server.app.state, "auth_required", None)
|
|
prev_host = getattr(web_server.app.state, "bound_host", None)
|
|
web_server.app.state.bound_host = "fly-app.fly.dev"
|
|
web_server.app.state.auth_required = True
|
|
try:
|
|
client = TestClient(web_server.app, base_url="https://fly-app.fly.dev")
|
|
r = client.get("/api/auth/providers")
|
|
assert r.status_code == 503
|
|
assert "no auth providers" in r.text.lower()
|
|
finally:
|
|
web_server.app.state.auth_required = prev_required
|
|
web_server.app.state.bound_host = prev_host
|
|
|
|
|
|
def test_gated_zero_providers_login_page_renders_help_text():
|
|
clear_providers()
|
|
prev_required = getattr(web_server.app.state, "auth_required", None)
|
|
prev_host = getattr(web_server.app.state, "bound_host", None)
|
|
web_server.app.state.bound_host = "fly-app.fly.dev"
|
|
web_server.app.state.auth_required = True
|
|
try:
|
|
client = TestClient(web_server.app, base_url="https://fly-app.fly.dev")
|
|
r = client.get("/login")
|
|
assert r.status_code == 200
|
|
# Empty-provider HTML mentions the fix-up path. (HTML wraps text
|
|
# so we can't grep for the exact phrase; check for the canonical
|
|
# fragments instead.)
|
|
text = r.text.lower()
|
|
assert "sign-in unavailable" in text
|
|
assert "no authentication" in text
|
|
assert "providers are installed" in text
|
|
assert "--insecure" in text
|
|
finally:
|
|
web_server.app.state.auth_required = prev_required
|
|
web_server.app.state.bound_host = prev_host
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Multi-provider verify: a ProviderError from one provider must not abort the
|
|
# chain when another provider can verify the token.
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class _UnreachableProvider(StubAuthProvider):
|
|
"""A provider whose IDP is unreachable: verify_session always raises.
|
|
|
|
Models the real-world bug — a self-hosted-OIDC session hits the ``nous``
|
|
provider first, which tries to reach Nous Portal's JWKS; if that's
|
|
unreachable ``nous`` raises ProviderError. The gate must keep trying the
|
|
remaining providers rather than 503-ing the whole request.
|
|
"""
|
|
|
|
name = "unreachable"
|
|
display_name = "Unreachable IdP (test only)"
|
|
|
|
def verify_session(self, *, access_token: str):
|
|
from hermes_cli.dashboard_auth.base import ProviderError
|
|
|
|
raise ProviderError("simulated: IDP/JWKS unreachable")
|
|
|
|
def refresh_session(self, *, refresh_token: str):
|
|
from hermes_cli.dashboard_auth.base import ProviderError
|
|
|
|
raise ProviderError("simulated: IDP/JWKS unreachable")
|
|
|
|
|
|
def _mint_stub_at(stub: StubAuthProvider) -> str:
|
|
"""Mint a valid access-token cookie value from a StubAuthProvider via its
|
|
own login round trip (so the HMAC signature matches what verify expects)."""
|
|
ls = stub.start_login(redirect_uri="https://fly-app.fly.dev/auth/callback")
|
|
state = dict(
|
|
seg.split("=", 1)
|
|
for seg in ls.cookie_payload["hermes_session_pkce"].split(";")
|
|
if "=" in seg
|
|
)["state"]
|
|
verifier = dict(
|
|
seg.split("=", 1)
|
|
for seg in ls.cookie_payload["hermes_session_pkce"].split(";")
|
|
if "=" in seg
|
|
)["verifier"]
|
|
session = stub.complete_login(
|
|
code="stub_code",
|
|
state=state,
|
|
code_verifier=verifier,
|
|
redirect_uri="https://fly-app.fly.dev/auth/callback",
|
|
)
|
|
return session.access_token
|
|
|
|
|
|
@pytest.fixture
|
|
def _gated_state():
|
|
"""Bare gated app-state setup WITHOUT registering any provider, so each
|
|
test controls provider registration order itself. Yields a factory that
|
|
builds the TestClient after providers are registered."""
|
|
clear_providers()
|
|
prev_host = getattr(web_server.app.state, "bound_host", None)
|
|
prev_port = getattr(web_server.app.state, "bound_port", None)
|
|
prev_required = getattr(web_server.app.state, "auth_required", None)
|
|
web_server.app.state.bound_host = "fly-app.fly.dev"
|
|
web_server.app.state.bound_port = 443
|
|
web_server.app.state.auth_required = True
|
|
|
|
def _client() -> TestClient:
|
|
return TestClient(web_server.app, base_url="https://fly-app.fly.dev")
|
|
|
|
yield _client
|
|
clear_providers()
|
|
web_server.app.state.bound_host = prev_host
|
|
web_server.app.state.bound_port = prev_port
|
|
web_server.app.state.auth_required = prev_required
|
|
|
|
|
|
def test_unreachable_first_provider_does_not_block_second(_gated_state):
|
|
"""An unreachable provider registered FIRST must not 503 a request whose
|
|
token a later provider can verify.
|
|
|
|
Regression for the stacked-provider bug: the verify loop used to return
|
|
503 on the first provider's ProviderError, before the working provider
|
|
ever got a turn. Now it logs, continues, and the working provider wins.
|
|
"""
|
|
working = StubAuthProvider()
|
|
register_provider(_UnreachableProvider()) # registered first → tried first
|
|
register_provider(working) # the one that can verify
|
|
|
|
at = _mint_stub_at(working)
|
|
client = _gated_state()
|
|
client.cookies.set(SESSION_AT_COOKIE, at)
|
|
r = client.get("/api/auth/me")
|
|
assert r.status_code == 200, (
|
|
f"Expected the working provider to verify the session despite the "
|
|
f"unreachable one being tried first; got {r.status_code}: {r.text}"
|
|
)
|
|
body = r.json()
|
|
assert body["provider"] == "stub"
|
|
assert body["user_id"] == "stub-user-1"
|
|
|
|
|
|
def test_all_providers_unreachable_returns_503(_gated_state):
|
|
"""If NO provider can verify the token AND at least one was unreachable,
|
|
surface 503 (transient outage) rather than forcing a needless re-login."""
|
|
register_provider(_UnreachableProvider())
|
|
client = _gated_state()
|
|
# Any non-empty cookie — the unreachable provider raises before parsing.
|
|
client.cookies.set(SESSION_AT_COOKIE, "some-opaque-token")
|
|
r = client.get("/api/auth/me")
|
|
assert r.status_code == 503
|
|
assert "unreachable" in r.text.lower()
|
|
|
|
|
|
def test_unverifiable_token_with_reachable_providers_redirects(_gated_state):
|
|
"""When every provider is REACHABLE but none recognises the token (all
|
|
return None, none raises), the gate falls through to re-login — NOT 503."""
|
|
register_provider(StubAuthProvider())
|
|
client = _gated_state()
|
|
client.cookies.set(SESSION_AT_COOKIE, "garbage-not-a-real-token")
|
|
# API path → 401; HTML would 302. Either way, NOT 503.
|
|
r = client.get("/api/auth/me")
|
|
assert r.status_code == 401
|
|
assert "unreachable" not in r.text.lower()
|