refactor: extract _ws_auth_check helper and fix URL scheme conversion

- Extract shared auth logic into _ws_auth_check(websocket) async helper,
  used by both terminal_ws_proxy and federation_terminal_ws_proxy. Eliminates
  verbatim duplication of the cookie + bearer auth block.
- Fix URL scheme conversion in federation_terminal_ws_proxy: add elif branch
  for http:// so non-http/https URLs fall through to a safe passthrough
  (ws_url = remote_url + "/terminal/ws") instead of silently producing a
  malformed URL like ws://s://host/terminal/ws.

No behavior change for the supported http/https URL inputs.
All 15 tests pass.
This commit is contained in:
Brian Krabach
2026-04-01 11:49:08 -07:00
parent 086ef19aa4
commit 536b487f52
+32 -28
View File
@@ -590,6 +590,32 @@ def _ttyd_is_listening() -> bool:
return False return False
async def _ws_auth_check(websocket: WebSocket) -> bool:
"""Return True if the WebSocket caller is authorized.
Closes the WebSocket with code 4001 and returns False if the caller
is not authorized. Localhost connections (127.0.0.1 / ::1) are
unconditionally trusted. Remote callers must present a valid
``muxplex_session`` cookie OR a Bearer token matching ``_federation_key``.
"""
host = websocket.client.host if websocket.client else ""
if host in ("127.0.0.1", "::1"):
return True
session_cookie = websocket.cookies.get("muxplex_session")
cookie_ok = session_cookie and verify_session_cookie(
_auth_secret, session_cookie, _auth_ttl
)
bearer_ok = False
if _federation_key:
auth_header = websocket.headers.get("authorization", "")
if auth_header.lower().startswith("bearer "):
bearer_ok = hmac.compare_digest(auth_header[7:], _federation_key)
if not cookie_ok and not bearer_ok:
await websocket.close(code=4001)
return False
return True
@app.websocket("/terminal/ws") @app.websocket("/terminal/ws")
async def terminal_ws_proxy(websocket: WebSocket) -> None: async def terminal_ws_proxy(websocket: WebSocket) -> None:
"""Proxy WebSocket frames between the browser and ttyd. """Proxy WebSocket frames between the browser and ttyd.
@@ -605,19 +631,7 @@ async def terminal_ws_proxy(websocket: WebSocket) -> None:
then closed as soon as it couldn't reach the dead ttyd. then closed as soon as it couldn't reach the dead ttyd.
""" """
# Auth check before accepting — BaseHTTPMiddleware doesn't cover WebSocket scope # Auth check before accepting — BaseHTTPMiddleware doesn't cover WebSocket scope
host = websocket.client.host if websocket.client else "" if not await _ws_auth_check(websocket):
if host not in ("127.0.0.1", "::1"):
session_cookie = websocket.cookies.get("muxplex_session")
cookie_ok = session_cookie and verify_session_cookie(
_auth_secret, session_cookie, _auth_ttl
)
bearer_ok = False
if _federation_key:
auth_header = websocket.headers.get("authorization", "")
if auth_header.lower().startswith("bearer "):
bearer_ok = hmac.compare_digest(auth_header[7:], _federation_key)
if not cookie_ok and not bearer_ok:
await websocket.close(code=4001)
return return
# Ensure ttyd is reachable BEFORE accepting the browser WS. # Ensure ttyd is reachable BEFORE accepting the browser WS.
@@ -696,19 +710,7 @@ async def federation_terminal_ws_proxy(websocket: WebSocket, remote_id: int) ->
Closes with code 4004 if remote_id is out of range. Closes with code 4004 if remote_id is out of range.
""" """
# Auth check before accepting — same pattern as terminal_ws_proxy # Auth check before accepting — same pattern as terminal_ws_proxy
host = websocket.client.host if websocket.client else "" if not await _ws_auth_check(websocket):
if host not in ("127.0.0.1", "::1"):
session_cookie = websocket.cookies.get("muxplex_session")
cookie_ok = session_cookie and verify_session_cookie(
_auth_secret, session_cookie, _auth_ttl
)
bearer_ok = False
if _federation_key:
auth_header = websocket.headers.get("authorization", "")
if auth_header.lower().startswith("bearer "):
bearer_ok = hmac.compare_digest(auth_header[7:], _federation_key)
if not cookie_ok and not bearer_ok:
await websocket.close(code=4001)
return return
# Look up remote instance by index # Look up remote instance by index
@@ -724,9 +726,11 @@ async def federation_terminal_ws_proxy(websocket: WebSocket, remote_id: int) ->
# Convert http(s) URL to ws(s) # Convert http(s) URL to ws(s)
if remote_url.startswith("https://"): if remote_url.startswith("https://"):
ws_url = "wss://" + remote_url[len("https://") :] + "/terminal/ws" ws_url = "wss://" + remote_url[8:] + "/terminal/ws"
elif remote_url.startswith("http://"):
ws_url = "ws://" + remote_url[7:] + "/terminal/ws"
else: else:
ws_url = "ws://" + remote_url[len("http://") :] + "/terminal/ws" ws_url = remote_url + "/terminal/ws" # assume already ws:// or wss://
await websocket.accept(subprotocol="tty") await websocket.accept(subprotocol="tty")