fix(webui): configure public websocket URL

This commit is contained in:
concertypin
2026-08-04 21:53:16 +08:00
committed by Xubin Ren
parent e318e21cad
commit cb2f9d0bbd
5 changed files with 75 additions and 1 deletions
+30
View File
@@ -13,6 +13,7 @@ from collections.abc import Callable
from contextlib import suppress
from pathlib import Path
from typing import Any, Self, TypeGuard, cast
from urllib.parse import urlsplit, urlunsplit
from pydantic import Field, PrivateAttr, field_validator, model_validator
from websockets.asyncio.server import ServerConnection, serve, unix_serve
@@ -175,6 +176,8 @@ class WebSocketConfig(Base):
blocking ``urllib`` or synchronous ``httpx`` from inside a coroutine.
- ``token_issue_secret``: If non-empty, token requests must send ``Authorization: Bearer <secret>`` or
``X-Nanobot-Auth: <secret>``.
- ``public_ws_url``: Optional public WebSocket endpoint returned by WebUI bootstrap instead of
deriving one from proxy request headers. Its path must match ``path``.
- ``websocket_requires_token``: If True, the handshake must include a valid token (static or issued and not expired).
- Each connection has its own session: a unique ``chat_id`` maps to the agent session internally.
- ``media`` field in outbound messages contains local filesystem paths; remote clients need a
@@ -186,6 +189,7 @@ class WebSocketConfig(Base):
port: int = 8765
unix_socket_path: str = ""
path: str = "/"
public_ws_url: str = ""
token: str = ""
token_issue_path: str = ""
token_issue_secret: str = ""
@@ -234,6 +238,32 @@ class WebSocketConfig(Base):
raise ValueError('token_issue_path must start with "/"')
return _normalize_config_path(value)
@field_validator("public_ws_url")
@classmethod
def public_ws_url_format(cls, value: str) -> str:
value = value.strip()
if not value:
return ""
parsed = urlsplit(value)
if (
parsed.scheme not in {"ws", "wss"}
or not parsed.netloc
or parsed.username is not None
or parsed.password is not None
or parsed.query
or parsed.fragment
):
raise ValueError("public_ws_url must be an absolute ws:// or wss:// URL without credentials")
return urlunsplit(
(parsed.scheme, parsed.netloc, _normalize_config_path(parsed.path or "/"), "", "")
)
@model_validator(mode="after")
def public_ws_url_matches_path(self) -> Self:
if self.public_ws_url and urlsplit(self.public_ws_url).path != _normalize_config_path(self.path):
raise ValueError("public_ws_url path must match path")
return self
@model_validator(mode="after")
def token_issue_path_differs_from_ws_path(self) -> Self:
if not self.token_issue_path:
@@ -3552,6 +3552,40 @@ def test_bootstrap_ws_url_uses_forwarded_https_host(bus: MagicMock) -> None:
assert body["ws_url"] == "wss://nanobot.example/"
def test_bootstrap_ws_url_uses_configured_public_url(bus: MagicMock) -> None:
channel = _ch(
bus,
host="127.0.0.1",
port=29931,
tokenIssueSecret="s3cret",
publicWsUrl="wss://claw.wasapi.xyz/",
)
resp = channel.gateway.http._handle_bootstrap(
_LOCAL,
_FakeReq(
{
"Authorization": "Bearer s3cret",
"Host": "127.0.0.1:29931",
"X-Forwarded-Proto": "https",
}
),
)
assert resp.status_code == 200
assert json.loads(resp.body)["ws_url"] == "wss://claw.wasapi.xyz/"
def test_public_ws_url_must_match_configured_path() -> None:
from pydantic_core import ValidationError
with pytest.raises(ValidationError, match="public_ws_url path must match path"):
WebSocketConfig.model_validate(
{
"path": "/socket",
"publicWsUrl": "wss://claw.wasapi.xyz/",
}
)
def test_bootstrap_without_auth_rejects_remote_requests(bus: MagicMock) -> None:
channel = _ch(bus, host="127.0.0.1")
resp = channel.gateway.http._handle_bootstrap(_REMOTE, _NO_HEADERS)
+2
View File
@@ -441,6 +441,8 @@ class GatewayHTTPHandler:
def _bootstrap_ws_url(self, request: Any) -> str:
headers = getattr(request, "headers", {}) or {}
if self.config.public_ws_url:
return self.config.public_ws_url
host = _safe_host_header(_case_insensitive_header(headers, "Host"))
if not host:
host = _host_for_url(self.config.host, self.config.port)