hermes-agent/tests/hermes_cli/test_dashboard_auth_native_flow.py
Teknium 4d23b2238e fix(dashboard-auth): harden the public native-authorize surface
Two tightenings on /auth/native/authorize (a public pre-auth route):

- Per-IP pending cap (8): the broker store is capacity-bounded fail-closed
  at 256 entries with a 600s TTL, so one unauthenticated spammer could fill
  it and deny native sign-in gateway-wide for the pending window. Pending
  entries now record the requester IP and each address is capped well above
  any legitimate concurrent-login count; other addresses keep signing in.
- Loopback redirect_uri accepts IP literals only (127.0.0.1 / ::1):
  'localhost' can be re-pointed via the hosts file or a hostile resolver
  (RFC 8252 \u00a78.3 says to use loopback IP literals); the desktop always
  sends 127.0.0.1, so nothing legitimate used the name.

3 new tests: per-IP cap enforced, cap frees on TTL expiry, localhost
redirect rejected at the route.
2026-07-22 06:50:50 -07:00

512 lines
18 KiB
Python

"""E2E + unit tests for the RFC 8252 native-app (system-browser + loopback +
PKCE) dashboard-auth flow.
Covers:
* ``native_flow`` broker unit behaviour — PKCE binding, single-use codes,
expiry, capacity, replay resistance.
* The full ``/auth/native/authorize`` → ``/auth/callback`` →
``/auth/native/token`` round trip in-process against ``StubAuthProvider``.
* ``/api/status`` capability advertisement (``auth_flows``).
* Cookieless bearer authentication of a gated route (the whole point of the
feature — a desktop authenticates REST with ``Authorization: Bearer`` and
sets/needs no cookie).
* ``/auth/native/refresh`` token rotation and terminal-expiry semantics.
Run: pytest tests/hermes_cli/test_dashboard_auth_native_flow.py
"""
from __future__ import annotations
import hashlib
import base64
import time
from urllib.parse import parse_qs, urlparse
import pytest
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 import native_flow
from hermes_cli.dashboard_auth.base import Session
from tests.hermes_cli.conftest_dashboard_auth import StubAuthProvider
# ---------------------------------------------------------------------------
# PKCE helpers (desktop side)
# ---------------------------------------------------------------------------
def _b64url_no_pad(raw: bytes) -> str:
return base64.urlsafe_b64encode(raw).rstrip(b"=").decode("ascii")
def _make_pkce() -> tuple[str, str]:
"""Return ``(verifier, challenge)`` — the desktop's PKCE pair."""
verifier = _b64url_no_pad(b"desktop-verifier-secret-material-0123456789abcd")
challenge = _b64url_no_pad(hashlib.sha256(verifier.encode("ascii")).digest())
return verifier, challenge
# ---------------------------------------------------------------------------
# native_flow broker unit tests
# ---------------------------------------------------------------------------
@pytest.fixture(autouse=True)
def _reset_broker():
native_flow._reset_for_tests()
# Snapshot the shared app.state auth fields + provider registry so a test
# that flips auth_required / registers a stub provider can't leak into a
# later test file (e.g. the MCP dashboard-oauth suite shares web_server.app).
prev_required = getattr(web_server.app.state, "auth_required", None)
prev_host = getattr(web_server.app.state, "bound_host", None)
prev_port = getattr(web_server.app.state, "bound_port", None)
yield
native_flow._reset_for_tests()
clear_providers()
web_server.app.state.auth_required = prev_required
web_server.app.state.bound_host = prev_host
web_server.app.state.bound_port = prev_port
def _stub_session(exp_offset: int = 3600) -> Session:
now = int(time.time())
return Session(
user_id="u1",
email="u1@example.test",
display_name="U One",
org_id="org1",
provider="stub",
expires_at=now + exp_offset,
access_token="at-opaque",
refresh_token="rt-opaque",
)
def test_broker_happy_path_binds_pkce_and_returns_session():
verifier, challenge = _make_pkce()
broker_state = native_flow.register_pending(
code_challenge=challenge,
redirect_uri="http://127.0.0.1:53123/callback",
client_state="client-state-xyz",
)
pending = native_flow.get_pending(broker_state)
assert pending.redirect_uri == "http://127.0.0.1:53123/callback"
assert pending.client_state == "client-state-xyz"
sess = _stub_session()
code = native_flow.complete_pending(broker_state, session=sess)
redeemed = native_flow.redeem_code(code=code, code_verifier=verifier)
assert redeemed.access_token == "at-opaque"
assert redeemed.user_id == "u1"
def test_broker_rejects_wrong_verifier():
_verifier, challenge = _make_pkce()
broker_state = native_flow.register_pending(
code_challenge=challenge,
redirect_uri="http://127.0.0.1:1/cb",
client_state="s",
)
code = native_flow.complete_pending(broker_state, session=_stub_session())
with pytest.raises(native_flow.CodeInvalid):
native_flow.redeem_code(code=code, code_verifier="wrong-verifier")
def test_broker_code_is_single_use():
verifier, challenge = _make_pkce()
broker_state = native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s",
)
code = native_flow.complete_pending(broker_state, session=_stub_session())
native_flow.redeem_code(code=code, code_verifier=verifier)
# Replay must fail — the code was consumed.
with pytest.raises(native_flow.CodeInvalid):
native_flow.redeem_code(code=code, code_verifier=verifier)
def test_broker_wrong_verifier_still_consumes_code_no_oracle():
"""A wrong-verifier attempt must not leave the code redeemable — otherwise
an attacker who steals the loopback code could brute-force the verifier."""
verifier, challenge = _make_pkce()
broker_state = native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s",
)
code = native_flow.complete_pending(broker_state, session=_stub_session())
with pytest.raises(native_flow.CodeInvalid):
native_flow.redeem_code(code=code, code_verifier="wrong")
# Even the CORRECT verifier now fails: the code was consumed on the first
# (failed) attempt.
with pytest.raises(native_flow.CodeInvalid):
native_flow.redeem_code(code=code, code_verifier=verifier)
def test_broker_pending_expiry():
verifier, challenge = _make_pkce()
now = int(time.time())
broker_state = native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s", now=now,
)
# Past the pending TTL, the entry is gone.
with pytest.raises(native_flow.PendingNotFound):
native_flow.get_pending(broker_state, now=now + 601)
def test_broker_code_expiry():
verifier, challenge = _make_pkce()
now = int(time.time())
broker_state = native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s", now=now,
)
code = native_flow.complete_pending(
broker_state, session=_stub_session(), now=now,
)
with pytest.raises(native_flow.CodeInvalid):
native_flow.redeem_code(
code=code, code_verifier=verifier, now=now + 121,
)
def test_broker_capacity_fails_closed():
_verifier, challenge = _make_pkce()
# Fill to capacity.
for _ in range(native_flow._MAX_ENTRIES):
native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s",
)
with pytest.raises(native_flow.NativeFlowError):
native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s",
)
def test_broker_per_ip_pending_cap():
"""One address cannot hog the pending store (public pre-auth route)."""
_verifier, challenge = _make_pkce()
for _ in range(native_flow._MAX_PENDING_PER_IP):
native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s", client_ip="203.0.113.7",
)
# The capped IP is refused...
with pytest.raises(native_flow.NativeFlowError):
native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s", client_ip="203.0.113.7",
)
# ...while a different address still signs in fine.
assert native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s", client_ip="198.51.100.9",
)
def test_broker_per_ip_cap_frees_on_expiry():
"""Expired pending entries stop counting against the per-IP cap."""
_verifier, challenge = _make_pkce()
now = int(time.time())
for _ in range(native_flow._MAX_PENDING_PER_IP):
native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s", client_ip="203.0.113.7", now=now,
)
# Past the pending TTL the old entries are GC'd and the IP can retry.
assert native_flow.register_pending(
code_challenge=challenge, redirect_uri="http://127.0.0.1:1/cb",
client_state="s", client_ip="203.0.113.7",
now=now + native_flow._PENDING_TTL_SECONDS + 1,
)
# ---------------------------------------------------------------------------
# Route-level E2E against StubAuthProvider
# ---------------------------------------------------------------------------
@pytest.fixture
def gated_client():
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
# follow_redirects=False so we can inspect each 302 leg of the flow.
client = TestClient(
web_server.app, base_url="https://fly-app.fly.dev",
follow_redirects=False,
)
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 _walk_native_login(client, *, redirect_uri, challenge, state="cli-state"):
"""Drive authorize → (stub redirects to callback) → loopback code.
Returns the ``code`` + ``state`` the gateway put on the loopback redirect.
"""
# 1. Desktop opens the system browser at /auth/native/authorize.
r = client.get(
"/auth/native/authorize",
params={
"provider": "stub",
"code_challenge": challenge,
"code_challenge_method": "S256",
"redirect_uri": redirect_uri,
"state": state,
},
)
assert r.status_code == 302, r.text
# Stub's start_login redirects straight to /auth/callback?code=stub_code.
loc = r.headers["location"]
parsed = urlparse(loc)
cb_qs = parse_qs(parsed.query)
# Carry the gateway PKCE cookie forward (holds broker_state + verifier).
cookies = r.cookies
# 2. Browser hits the gateway callback.
r2 = client.get(
"/auth/callback",
params={"code": cb_qs["code"][0], "state": cb_qs["state"][0]},
cookies=cookies,
)
assert r2.status_code == 302, r2.text
# 3. The callback 302s to the desktop's loopback redirect_uri.
loop = urlparse(r2.headers["location"])
assert f"{loop.scheme}://{loop.netloc}" == redirect_uri.rsplit("/", 1)[0] or \
loop.netloc in redirect_uri
loop_qs = parse_qs(loop.query)
# No session cookie must be set on the native callback response.
set_cookie = r2.headers.get("set-cookie", "")
assert "hermes_session_at" not in set_cookie, (
f"native callback must NOT set a session cookie; got {set_cookie!r}"
)
return loop_qs["code"][0], loop_qs["state"][0]
def test_native_full_roundtrip_returns_tokens_no_cookie(gated_client):
verifier, challenge = _make_pkce()
redirect_uri = "http://127.0.0.1:53999/callback"
code, state = _walk_native_login(
gated_client, redirect_uri=redirect_uri, challenge=challenge,
state="my-cli-state",
)
assert state == "my-cli-state" # client state echoed verbatim
# 4. Desktop redeems the loopback code + its verifier for tokens.
r = gated_client.post(
"/auth/native/token",
json={"code": code, "code_verifier": verifier},
)
assert r.status_code == 200, r.text
body = r.json()
assert body["token_type"] == "Bearer"
assert body["access_token"]
assert body["refresh_token"]
assert body["provider"] == "stub"
assert body["user_id"] == "stub-user-1"
# No cookie set on the token response either.
assert "set-cookie" not in {k.lower() for k in r.headers}
def test_native_token_rejects_wrong_verifier(gated_client):
_verifier, challenge = _make_pkce()
code, _state = _walk_native_login(
gated_client, redirect_uri="http://127.0.0.1:53999/cb",
challenge=challenge,
)
r = gated_client.post(
"/auth/native/token",
json={"code": code, "code_verifier": "attacker-does-not-have-this"},
)
assert r.status_code == 400
def test_native_authorize_rejects_non_loopback_redirect(gated_client):
_verifier, challenge = _make_pkce()
r = gated_client.get(
"/auth/native/authorize",
params={
"provider": "stub",
"code_challenge": challenge,
"code_challenge_method": "S256",
"redirect_uri": "https://evil.example.com/steal",
"state": "s",
},
)
assert r.status_code == 400
assert "loopback" in r.json()["detail"].lower()
def test_native_authorize_rejects_localhost_name(gated_client):
"""RFC 8252 §8.3 — loopback IP literals only; `localhost` can be
re-pointed via the hosts file / a hostile resolver."""
_verifier, challenge = _make_pkce()
r = gated_client.get(
"/auth/native/authorize",
params={
"provider": "stub",
"code_challenge": challenge,
"code_challenge_method": "S256",
"redirect_uri": "http://localhost:53999/cb",
"state": "s",
},
)
assert r.status_code == 400
assert "loopback" in r.json()["detail"].lower()
def test_native_authorize_requires_s256(gated_client):
_verifier, challenge = _make_pkce()
r = gated_client.get(
"/auth/native/authorize",
params={
"provider": "stub",
"code_challenge": challenge,
"code_challenge_method": "plain",
"redirect_uri": "http://127.0.0.1:1/cb",
"state": "s",
},
)
assert r.status_code == 400
assert "s256" in r.json()["detail"].lower()
# ---------------------------------------------------------------------------
# Cookieless bearer auth of a gated route — the core deliverable
# ---------------------------------------------------------------------------
def test_bearer_authenticates_gated_route_without_cookie(gated_client):
"""A desktop that redeemed tokens can call a gated route with only an
``Authorization: Bearer`` header — no cookie in the jar."""
verifier, challenge = _make_pkce()
code, _state = _walk_native_login(
gated_client, redirect_uri="http://127.0.0.1:53999/cb",
challenge=challenge,
)
tokens = gated_client.post(
"/auth/native/token",
json={"code": code, "code_verifier": verifier},
).json()
at = tokens["access_token"]
# /api/auth/me is gated; a cookieless request with the bearer must pass
# and identify the user.
r = gated_client.get(
"/api/auth/me",
headers={"Authorization": f"Bearer {at}"},
)
assert r.status_code == 200, r.text
assert r.json()["user_id"] == "stub-user-1"
def test_bearer_ws_ticket_mint_without_cookie(gated_client):
"""The desktop mints a WS ticket with the bearer (no cookie), proving the
WebSocket path also works cookielessly."""
verifier, challenge = _make_pkce()
code, _state = _walk_native_login(
gated_client, redirect_uri="http://127.0.0.1:53999/cb",
challenge=challenge,
)
at = gated_client.post(
"/auth/native/token",
json={"code": code, "code_verifier": verifier},
).json()["access_token"]
r = gated_client.post(
"/api/auth/ws-ticket",
headers={"Authorization": f"Bearer {at}"},
)
assert r.status_code == 200, r.text
assert r.json()["ticket"]
def test_invalid_bearer_returns_401_envelope(gated_client):
r = gated_client.get(
"/api/auth/me",
headers={"Authorization": "Bearer not-a-real-token"},
)
assert r.status_code == 401
assert r.json()["error"] == "session_expired"
# ---------------------------------------------------------------------------
# Capability advertisement on /api/status
# ---------------------------------------------------------------------------
def test_status_advertises_native_pkce_flow(gated_client):
r = gated_client.get("/api/status")
assert r.status_code == 200
body = r.json()
assert body["auth_required"] is True
assert "cookie" in body["auth_flows"]
assert "native_pkce" in body["auth_flows"], (
"a brokerable OAuth provider must advertise native_pkce so the "
"desktop can pick the system-browser flow"
)
def test_status_loopback_mode_has_no_auth_flows():
clear_providers()
prev_required = getattr(web_server.app.state, "auth_required", None)
web_server.app.state.auth_required = False
try:
client = TestClient(web_server.app, base_url="http://127.0.0.1:8080")
body = client.get("/api/status").json()
assert body["auth_required"] is False
assert body["auth_flows"] == []
finally:
web_server.app.state.auth_required = prev_required
# ---------------------------------------------------------------------------
# Native refresh
# ---------------------------------------------------------------------------
def test_native_refresh_rotates_tokens(gated_client):
verifier, challenge = _make_pkce()
code, _state = _walk_native_login(
gated_client, redirect_uri="http://127.0.0.1:53999/cb",
challenge=challenge,
)
tokens = gated_client.post(
"/auth/native/token",
json={"code": code, "code_verifier": verifier},
).json()
rt = tokens["refresh_token"]
r = gated_client.post(
"/auth/native/refresh",
json={"refresh_token": rt, "provider": "stub"},
)
assert r.status_code == 200, r.text
body = r.json()
assert body["access_token"]
assert body["refresh_token"]
assert body["token_type"] == "Bearer"
def test_native_refresh_dead_token_returns_401(gated_client):
r = gated_client.post(
"/auth/native/refresh",
json={"refresh_token": "garbage-not-a-real-rt", "provider": "stub"},
)
assert r.status_code == 401
assert r.json()["error"] == "session_expired"