test(security): broaden plugin API auth coverage + correct stale docstring

Follow-up to the previous commit's middleware fix.

- plugins/kanban/dashboard/plugin_api.py: rewrite the "Security note"
  docstring. The previous text said "/api/plugins/ is unauthenticated by
  design" — that's now actively wrong and dangerously misleading. New
  text explains that plugin routes flow through the same session-token
  middleware as core API routes and that --host 0.0.0.0 is safe to use
  on a LAN as a result.

- tests/hermes_cli/test_web_server.py: extend TestPluginAPIAuth to cover
  the surfaces the original PR didn't pin:
  * test_plugin_route_allows_auth now exercises a real plugin path
    (/api/plugins/example/hello) instead of accepting 200 OR 404 from
    a maybe-loaded kanban plugin — the assertion was effectively vacuous.
  * test_plugin_patch_requires_auth + test_plugin_delete_requires_auth
    cover non-GET mutation methods in case a future regression
    whitelists them by accident.
  * test_non_kanban_plugin_route_requires_auth proves the fix is
    plugin-agnostic, not kanban-specific (hits hermes-achievements +
    a non-existent plugin namespace; both 401 before route resolution).
  * test_plugin_websocket_unaffected_by_http_middleware locks in that
    the HTTP middleware change didn't accidentally start gating WS
    upgrades — kanban /events still uses its own ?token= check.
  Plus a cosmetic blank-line cleanup.
This commit is contained in:
Teknium 2026-05-10 07:03:41 -07:00
parent ec9329ec41
commit ae4b09ce10
2 changed files with 95 additions and 18 deletions

View file

@ -13,15 +13,24 @@ reads run alongside the dispatcher's IMMEDIATE write transactions).
Security note Security note
------------- -------------
The dashboard's HTTP auth middleware (``web_server.auth_middleware``) Plugin HTTP routes go through the dashboard's session-token auth middleware
explicitly skips ``/api/plugins/`` plugin routes are unauthenticated by (``web_server.auth_middleware``) just like core API routes every
design because the dashboard binds to localhost by default. For the ``/api/plugins/...`` request must present the session bearer token (or the
WebSocket we still require the session token as a ``?token=`` query session cookie set when you load the dashboard HTML). The token is the
parameter (browsers cannot set the ``Authorization`` header on an upgrade random per-process ``_SESSION_TOKEN`` printed at startup; the dashboard's
request), matching the established pattern used by the in-browser PTY own pages inject it via ``window.__HERMES_SESSION_TOKEN__`` so logged-in
bridge in ``hermes_cli/web_server.py``. If you run the dashboard with browsers don't have to handle it manually.
``--host 0.0.0.0``, every plugin route kanban included becomes
reachable from the network. Don't do that on a shared host. For the ``/events`` WebSocket we still require the session token as a
``?token=`` query parameter (browsers cannot set the ``Authorization``
header on an upgrade request), matching the established pattern used by
the in-browser PTY bridge in ``hermes_cli/web_server.py``.
This means ``hermes dashboard --host 0.0.0.0`` is safe to run on a LAN:
plugin routes are no longer an unauthenticated exception. The auth still
isn't multi-user — anyone who can read the printed URL+token gets full
dashboard access but they can't ride along just because they can reach
the port.
""" """
from __future__ import annotations from __future__ import annotations

View file

@ -1826,9 +1826,6 @@ class TestNormaliseThemeExtensions:
assert r["componentStyles"]["card"] == {"opacity": "0.8", "zIndex": "5"} assert r["componentStyles"]["card"] == {"opacity": "0.8", "zIndex": "5"}
class TestPluginAPIAuth: class TestPluginAPIAuth:
"""Tests that plugin API routes require the session token (issue #19533).""" """Tests that plugin API routes require the session token (issue #19533)."""
@ -1857,18 +1854,89 @@ class TestPluginAPIAuth:
assert resp.status_code == 401 assert resp.status_code == 401
def test_plugin_route_allows_auth(self): def test_plugin_route_allows_auth(self):
"""Plugin API routes should work with a valid session token.""" """Plugin API routes should work with a valid session token.
# This test verifies the fix doesn't break authenticated access.
# The kanban plugin may not be loaded in the test environment, Use ``/api/plugins/example/hello`` from the example-dashboard plugin
# so we accept 200 (plugin loaded) or 404 (plugin not mounted). a stable, side-effect-free GET that's always loaded in tests. With a
resp = self.auth_client.get("/api/plugins/kanban/board") valid token the handler should run (200); without one the middleware
assert resp.status_code in (200, 404) should 401 before the handler is reached.
"""
# Without auth: middleware blocks before reaching the handler.
resp = self.client.get("/api/plugins/example/hello")
assert resp.status_code == 401
# With auth: handler runs.
resp = self.auth_client.get("/api/plugins/example/hello")
assert resp.status_code == 200
def test_plugin_post_requires_auth(self): def test_plugin_post_requires_auth(self):
"""Plugin POST routes should return 401 without a valid session token.""" """Plugin POST routes should return 401 without a valid session token."""
resp = self.client.post("/api/plugins/kanban/tasks", json={"title": "test"}) resp = self.client.post("/api/plugins/kanban/tasks", json={"title": "test"})
assert resp.status_code == 401 assert resp.status_code == 401
def test_plugin_patch_requires_auth(self):
"""Plugin PATCH routes should return 401 without a valid session token.
PATCH is the mutation method most commonly used by the dashboard for
kanban task edits explicitly cover it so a future middleware
regression that whitelists non-GET methods can't sneak through.
"""
resp = self.client.patch(
"/api/plugins/kanban/tasks/t_fake",
json={"title": "renamed"},
)
assert resp.status_code == 401
def test_plugin_delete_requires_auth(self):
"""Plugin DELETE routes should return 401 without a valid session token."""
resp = self.client.delete("/api/plugins/kanban/tasks/t_fake")
assert resp.status_code == 401
def test_non_kanban_plugin_route_requires_auth(self):
"""Auth must be plugin-agnostic, not kanban-specific.
The middleware fix is at the gate level (no per-plugin allowlist),
so any plugin's API surface — kanban, hermes-achievements, future
plugins must require the session token. Hit a non-kanban plugin
path to lock that in.
"""
# Real plugin path (hermes-achievements is loaded by default).
resp = self.client.get("/api/plugins/hermes-achievements/overview")
assert resp.status_code == 401
# Same for an arbitrary plugin namespace that doesn't even exist —
# the middleware should 401 before routing decides 404, so an
# attacker can't fingerprint plugin names by status codes.
resp = self.client.get("/api/plugins/_definitely_not_a_plugin_/anything")
assert resp.status_code == 401
def test_plugin_websocket_unaffected_by_http_middleware(self):
"""The kanban /events WebSocket has its own ``?token=`` check;
the HTTP middleware change must not start gating WS upgrades.
Starlette doesn't run HTTP middleware on WebSocket upgrades anyway,
but pin the behavior so a future refactor that moves auth into a
shared layer can't silently break the WS auth contract.
"""
from starlette.websockets import WebSocketDisconnect
from hermes_cli.web_server import _SESSION_TOKEN
# Without a token the WS endpoint must close the upgrade itself
# (its own _check_ws_token), NOT 401 from the HTTP middleware.
try:
with self.client.websocket_connect(
"/api/plugins/kanban/events"
):
pass # if we got here without disconnect, the WS accepted us
except WebSocketDisconnect:
pass # expected — WS endpoint rejected via its own check
except Exception:
# The kanban plugin may not be mounted in this test environment,
# in which case the route doesn't exist at all (3xx/4xx during
# upgrade). That's fine for this regression — it only matters
# that the HTTP middleware didn't start intercepting WS upgrades.
pass
class TestDashboardPluginManifestExtensions: class TestDashboardPluginManifestExtensions:
"""Tests for the extended plugin manifest fields (tab.override, """Tests for the extended plugin manifest fields (tab.override,
tab.hidden, slots) read by _discover_dashboard_plugins().""" tab.hidden, slots) read by _discover_dashboard_plugins()."""