openhands-agent-server 1.50.0__tar.gz → 1.50.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/PKG-INFO +1 -1
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/api.py +16 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/auth_router.py +5 -3
- openhands_agent_server-1.50.1/openhands/agent_server/canvas_extensions/bridge.py +513 -0
- openhands_agent_server-1.50.1/openhands/agent_server/canvas_extensions_bridge_router.py +105 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/canvas_extensions_router.py +15 -3
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/config.py +20 -2
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/conversation_router.py +6 -1
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/conversation_service.py +32 -1
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/docker_runtime/proxy.py +13 -1
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/docker_runtime/registry.py +1 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/event_router.py +14 -3
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/event_service.py +276 -35
- openhands_agent_server-1.50.1/openhands/agent_server/git_provider_service.py +228 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/git_router.py +49 -2
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/init_router.py +10 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/models.py +8 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/runtime_router.py +2 -2
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/server_details_router.py +17 -2
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/vscode_service.py +44 -4
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands_agent_server.egg-info/PKG-INFO +1 -1
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands_agent_server.egg-info/SOURCES.txt +6 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/pyproject.toml +1 -1
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/__init__.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/__main__.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/_secret_redaction.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/_secrets_exposure.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/agent_profiles_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/bash_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/bash_service.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/canvas_extensions/__init__.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/canvas_extensions/backend.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/canvas_extensions/installed.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/canvas_extensions/manifest.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/conversation_lease.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/conversation_registry.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/credential_binding.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/dependencies.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/docker/Dockerfile +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/docker/build.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/docker_runtime/__init__.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/docker_runtime/mediation.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/docker_runtime/provisioning.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/docker_runtime/routers.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/env_parser.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/file_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/hooks_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/hooks_service.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/llm_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/local_secret_resolver.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/logging_config.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/managed_llm_key.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/mcp_oauth_store.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/mcp_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/meta_profiles_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/middleware.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/openai/__init__.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/openai/models.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/openai/router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/openai/service.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/openapi.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/persistence/__init__.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/persistence/models.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/persistence/store.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/plugins_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/plugins_service.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/profiles_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/provider_connections_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/pub_sub.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/py.typed +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/session_protocol.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/session_socket.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/settings_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/skills_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/skills_service.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/sockets.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/sub_agents_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry/__init__.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry/factory.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry/http_exporter.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry/models.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry/policy.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry/posthog_exporter.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry/sanitizer.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry/service.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry/sink.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry/subscriber.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/telemetry_types.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/tool_preload_service.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/tool_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/utils.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/vscode_extensions/openhands-settings/extension.js +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/vscode_extensions/openhands-settings/package.json +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/vscode_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/workspace_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/workspaces_router.py +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands_agent_server.egg-info/dependency_links.txt +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands_agent_server.egg-info/entry_points.txt +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands_agent_server.egg-info/requires.txt +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands_agent_server.egg-info/top_level.txt +0 -0
- {openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/setup.cfg +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: openhands-agent-server
|
|
3
|
-
Version: 1.50.
|
|
3
|
+
Version: 1.50.1
|
|
4
4
|
Summary: OpenHands Agent Server - REST/WebSocket interface for OpenHands AI Agent
|
|
5
5
|
Project-URL: Source, https://github.com/OpenHands/software-agent-sdk
|
|
6
6
|
Project-URL: Homepage, https://github.com/OpenHands/software-agent-sdk
|
{openhands_agent_server-1.50.0 → openhands_agent_server-1.50.1}/openhands/agent_server/api.py
RENAMED
|
@@ -24,6 +24,10 @@ from openhands.agent_server.bash_service import get_default_bash_event_service
|
|
|
24
24
|
from openhands.agent_server.canvas_extensions.backend import (
|
|
25
25
|
CanvasExtensionBackendManager,
|
|
26
26
|
)
|
|
27
|
+
from openhands.agent_server.canvas_extensions.bridge import AppBackendSessionStore
|
|
28
|
+
from openhands.agent_server.canvas_extensions_bridge_router import (
|
|
29
|
+
app_backend_bridge_router,
|
|
30
|
+
)
|
|
27
31
|
from openhands.agent_server.canvas_extensions_router import canvas_extensions_router
|
|
28
32
|
from openhands.agent_server.config import (
|
|
29
33
|
Config,
|
|
@@ -47,6 +51,7 @@ from openhands.agent_server.dependencies import (
|
|
|
47
51
|
check_session_api_key,
|
|
48
52
|
check_workspace_session,
|
|
49
53
|
)
|
|
54
|
+
from openhands.agent_server.event_service import ConversationRunLimitExceeded
|
|
50
55
|
from openhands.agent_server.file_router import file_discovery_router, file_router
|
|
51
56
|
from openhands.agent_server.git_router import git_router
|
|
52
57
|
from openhands.agent_server.hooks_router import hooks_router
|
|
@@ -293,6 +298,9 @@ async def api_lifespan(api: FastAPI) -> AsyncIterator[None]:
|
|
|
293
298
|
try:
|
|
294
299
|
yield
|
|
295
300
|
finally:
|
|
301
|
+
session_store = getattr(api.state, "app_backend_session_store", None)
|
|
302
|
+
if session_store is not None:
|
|
303
|
+
await session_store.shutdown()
|
|
296
304
|
await conversation_registry.shutdown()
|
|
297
305
|
if retention_task is not None:
|
|
298
306
|
retention_task.cancel()
|
|
@@ -481,6 +489,7 @@ def _add_api_routes(app: FastAPI) -> None:
|
|
|
481
489
|
app.include_router(workspace_api_router)
|
|
482
490
|
app.include_router(api_router)
|
|
483
491
|
|
|
492
|
+
app.include_router(app_backend_bridge_router)
|
|
484
493
|
app.include_router(conversation_registry.sockets_router)
|
|
485
494
|
|
|
486
495
|
|
|
@@ -552,6 +561,12 @@ def _sanitize_validation_errors(errors: Sequence[Any]) -> list[dict]:
|
|
|
552
561
|
def _add_exception_handlers(api: FastAPI) -> None:
|
|
553
562
|
"""Add exception handlers to the FastAPI application."""
|
|
554
563
|
|
|
564
|
+
@api.exception_handler(ConversationRunLimitExceeded)
|
|
565
|
+
async def _run_limit_handler(
|
|
566
|
+
_request: Request, exc: ConversationRunLimitExceeded
|
|
567
|
+
) -> JSONResponse:
|
|
568
|
+
return JSONResponse(status_code=429, content={"detail": str(exc)})
|
|
569
|
+
|
|
555
570
|
@api.exception_handler(CredentialBindingActivationRequired)
|
|
556
571
|
async def _credential_binding_activation_required_handler(
|
|
557
572
|
_request: Request,
|
|
@@ -711,6 +726,7 @@ def create_app(config: Config | None = None) -> FastAPI:
|
|
|
711
726
|
app.state.config = config
|
|
712
727
|
app.state.conversation_registry = create_conversation_registry(config)
|
|
713
728
|
app.state.canvas_extension_backend_manager = CanvasExtensionBackendManager()
|
|
729
|
+
app.state.app_backend_session_store = AppBackendSessionStore()
|
|
714
730
|
|
|
715
731
|
_add_api_routes(app)
|
|
716
732
|
_setup_static_files(app, config)
|
|
@@ -99,8 +99,10 @@ def _set_workspace_cookie(
|
|
|
99
99
|
_append_partitioned_to_last_set_cookie(response)
|
|
100
100
|
|
|
101
101
|
|
|
102
|
-
def _append_partitioned_to_last_set_cookie(
|
|
103
|
-
|
|
102
|
+
def _append_partitioned_to_last_set_cookie(
|
|
103
|
+
response: Response, cookie_name: str = WORKSPACE_SESSION_COOKIE_NAME
|
|
104
|
+
) -> None:
|
|
105
|
+
"""Append ``; Partitioned`` to the named Set-Cookie header.
|
|
104
106
|
|
|
105
107
|
``MutableHeaders`` doesn't expose an "edit by name" helper for
|
|
106
108
|
duplicate-allowed headers, and we need to be careful not to clobber
|
|
@@ -110,7 +112,7 @@ def _append_partitioned_to_last_set_cookie(response: Response) -> None:
|
|
|
110
112
|
for idx in range(len(raw) - 1, -1, -1):
|
|
111
113
|
name, value = raw[idx]
|
|
112
114
|
if name.lower() == b"set-cookie" and value.startswith(
|
|
113
|
-
|
|
115
|
+
cookie_name.encode("latin-1") + b"="
|
|
114
116
|
):
|
|
115
117
|
if b"partitioned" not in value.lower():
|
|
116
118
|
raw[idx] = (name, value + b"; Partitioned")
|
|
@@ -0,0 +1,513 @@
|
|
|
1
|
+
"""Authenticated browser bridge for owned Canvas App backends."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import asyncio
|
|
6
|
+
import hashlib
|
|
7
|
+
import hmac
|
|
8
|
+
import os
|
|
9
|
+
import re
|
|
10
|
+
import secrets
|
|
11
|
+
import time
|
|
12
|
+
from contextlib import suppress
|
|
13
|
+
from dataclasses import dataclass, field
|
|
14
|
+
from datetime import UTC, datetime
|
|
15
|
+
from typing import Final, Protocol
|
|
16
|
+
from urllib.parse import unquote, urlparse
|
|
17
|
+
|
|
18
|
+
from fastapi import HTTPException, Request, Response, WebSocket, status
|
|
19
|
+
from pydantic import BaseModel
|
|
20
|
+
|
|
21
|
+
from openhands.agent_server.auth_router import (
|
|
22
|
+
_append_partitioned_to_last_set_cookie,
|
|
23
|
+
)
|
|
24
|
+
from openhands.agent_server.config import Config
|
|
25
|
+
from openhands.agent_server.docker_runtime.proxy import (
|
|
26
|
+
bridge_websocket,
|
|
27
|
+
proxy_http,
|
|
28
|
+
strip_auth_query,
|
|
29
|
+
)
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
APP_BACKEND_SESSION_COOKIE_NAME: Final = "oh_app_backend_session"
|
|
33
|
+
APP_BACKEND_SESSION_TTL_SECONDS: Final = 5 * 60
|
|
34
|
+
_APP_BACKEND_PATH: Final = "/app-backends"
|
|
35
|
+
_SAFE_METHODS: Final = frozenset({"GET", "HEAD", "OPTIONS"})
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
class BackendRegistry(Protocol):
|
|
39
|
+
def ready_endpoint(self, name: str) -> tuple[str, int] | None: ...
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
class AppBackendSessionResponse(BaseModel):
|
|
43
|
+
"""Browser bootstrap result for one running Canvas App backend.
|
|
44
|
+
|
|
45
|
+
The session credential is delivered only as an HttpOnly cookie. ``ingress_url``
|
|
46
|
+
contains no credential and must be loaded from a separate browser origin. That
|
|
47
|
+
origin is the isolation boundary, so frames retain their origin for cookies,
|
|
48
|
+
workers, WebSockets, and Origin-based request validation.
|
|
49
|
+
"""
|
|
50
|
+
|
|
51
|
+
ingress_url: str
|
|
52
|
+
expires_at: datetime
|
|
53
|
+
iframe_sandbox: str = (
|
|
54
|
+
"allow-forms allow-modals allow-popups allow-same-origin allow-scripts"
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
@dataclass(frozen=True, slots=True)
|
|
59
|
+
class _BackendTarget:
|
|
60
|
+
host: str
|
|
61
|
+
api_key: str | None = None
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
@dataclass(slots=True)
|
|
65
|
+
class _AppBackendSession:
|
|
66
|
+
token_digest: bytes
|
|
67
|
+
extension_name: str
|
|
68
|
+
endpoint: tuple[str, int]
|
|
69
|
+
expires_at: float
|
|
70
|
+
sockets: set[asyncio.Task[None]] = field(default_factory=set)
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
class AppBackendSessionStore:
|
|
74
|
+
"""Own short-lived app sessions and their live WebSocket bridges.
|
|
75
|
+
|
|
76
|
+
A background reaper enforces expiry on its own: an already-bridged
|
|
77
|
+
WebSocket never calls :meth:`authorize` again, so opportunistic pruning
|
|
78
|
+
alone would let a socket keep forwarding past its TTL until some unrelated
|
|
79
|
+
session traffic happened to arrive.
|
|
80
|
+
"""
|
|
81
|
+
|
|
82
|
+
def __init__(self, ttl_seconds: int = APP_BACKEND_SESSION_TTL_SECONDS) -> None:
|
|
83
|
+
self.ttl_seconds = ttl_seconds
|
|
84
|
+
self._sessions: dict[bytes, _AppBackendSession] = {}
|
|
85
|
+
self._lock = asyncio.Lock()
|
|
86
|
+
self._reaper: asyncio.Task[None] | None = None
|
|
87
|
+
self._reaper_wakeup = asyncio.Event()
|
|
88
|
+
|
|
89
|
+
@staticmethod
|
|
90
|
+
def _digest(token: str) -> bytes:
|
|
91
|
+
return hashlib.sha256(token.encode()).digest()
|
|
92
|
+
|
|
93
|
+
async def create(
|
|
94
|
+
self, extension_name: str, endpoint: tuple[str, int]
|
|
95
|
+
) -> tuple[str, _AppBackendSession]:
|
|
96
|
+
token = secrets.token_urlsafe(32)
|
|
97
|
+
session = _AppBackendSession(
|
|
98
|
+
token_digest=self._digest(token),
|
|
99
|
+
extension_name=extension_name,
|
|
100
|
+
endpoint=endpoint,
|
|
101
|
+
expires_at=time.time() + self.ttl_seconds,
|
|
102
|
+
)
|
|
103
|
+
async with self._lock:
|
|
104
|
+
self._prune_expired_locked()
|
|
105
|
+
self._sessions[session.token_digest] = session
|
|
106
|
+
return token, session
|
|
107
|
+
|
|
108
|
+
async def authorize(
|
|
109
|
+
self, token: str | None, extension_name: str, endpoint: tuple[str, int]
|
|
110
|
+
) -> _AppBackendSession | None:
|
|
111
|
+
if not token:
|
|
112
|
+
return None
|
|
113
|
+
digest = self._digest(token)
|
|
114
|
+
async with self._lock:
|
|
115
|
+
self._prune_expired_locked()
|
|
116
|
+
session = self._sessions.get(digest)
|
|
117
|
+
if session is None or not hmac.compare_digest(session.token_digest, digest):
|
|
118
|
+
return None
|
|
119
|
+
if session.extension_name != extension_name or session.endpoint != endpoint:
|
|
120
|
+
return None
|
|
121
|
+
return session
|
|
122
|
+
|
|
123
|
+
async def attach_socket(
|
|
124
|
+
self, session: _AppBackendSession, task: asyncio.Task[None]
|
|
125
|
+
) -> None:
|
|
126
|
+
async with self._lock:
|
|
127
|
+
if self._sessions.get(session.token_digest) is not session:
|
|
128
|
+
raise RuntimeError("App backend session was revoked")
|
|
129
|
+
session.sockets.add(task)
|
|
130
|
+
# A socket attached to a session created by an instance without a
|
|
131
|
+
# running reaper (or after `shutdown`) still needs one.
|
|
132
|
+
self._ensure_reaper_locked()
|
|
133
|
+
self._reaper_wakeup.set()
|
|
134
|
+
|
|
135
|
+
async def detach_socket(
|
|
136
|
+
self, session: _AppBackendSession, task: asyncio.Task[None]
|
|
137
|
+
) -> None:
|
|
138
|
+
async with self._lock:
|
|
139
|
+
session.sockets.discard(task)
|
|
140
|
+
|
|
141
|
+
async def revoke_token(self, token: str | None) -> None:
|
|
142
|
+
if not token:
|
|
143
|
+
return
|
|
144
|
+
await self._revoke_digests({self._digest(token)})
|
|
145
|
+
|
|
146
|
+
async def revoke_app(self, extension_name: str) -> None:
|
|
147
|
+
async with self._lock:
|
|
148
|
+
digests = {
|
|
149
|
+
digest
|
|
150
|
+
for digest, session in self._sessions.items()
|
|
151
|
+
if session.extension_name == extension_name
|
|
152
|
+
}
|
|
153
|
+
await self._revoke_digests(digests)
|
|
154
|
+
|
|
155
|
+
async def shutdown(self) -> None:
|
|
156
|
+
reaper = self._reaper
|
|
157
|
+
self._reaper = None
|
|
158
|
+
if reaper is not None:
|
|
159
|
+
reaper.cancel()
|
|
160
|
+
with suppress(asyncio.CancelledError):
|
|
161
|
+
await reaper
|
|
162
|
+
async with self._lock:
|
|
163
|
+
digests = set(self._sessions)
|
|
164
|
+
await self._revoke_digests(digests)
|
|
165
|
+
|
|
166
|
+
async def _revoke_digests(self, digests: set[bytes]) -> None:
|
|
167
|
+
async with self._lock:
|
|
168
|
+
sessions = [
|
|
169
|
+
self._sessions.pop(digest)
|
|
170
|
+
for digest in digests
|
|
171
|
+
if digest in self._sessions
|
|
172
|
+
]
|
|
173
|
+
tasks = {
|
|
174
|
+
task for session in sessions for task in session.sockets if not task.done()
|
|
175
|
+
}
|
|
176
|
+
for task in tasks:
|
|
177
|
+
task.cancel()
|
|
178
|
+
if tasks:
|
|
179
|
+
await asyncio.gather(*tasks, return_exceptions=True)
|
|
180
|
+
|
|
181
|
+
def _prune_expired_locked(self) -> None:
|
|
182
|
+
now = time.time()
|
|
183
|
+
for digest, session in list(self._sessions.items()):
|
|
184
|
+
if session.expires_at <= now:
|
|
185
|
+
self._sessions.pop(digest)
|
|
186
|
+
for task in session.sockets:
|
|
187
|
+
task.cancel()
|
|
188
|
+
|
|
189
|
+
def _ensure_reaper_locked(self) -> None:
|
|
190
|
+
if self._reaper is None or self._reaper.done():
|
|
191
|
+
self._reaper = asyncio.create_task(self._reap_expired_loop())
|
|
192
|
+
|
|
193
|
+
async def _reap_expired_loop(self) -> None:
|
|
194
|
+
"""Cancel expired sessions even when no request traffic arrives.
|
|
195
|
+
|
|
196
|
+
The loop sleeps until the earliest attached-socket expiry, waking early
|
|
197
|
+
whenever a session is created or a socket attached, so a bridged
|
|
198
|
+
WebSocket is terminated at its TTL rather than at the next unrelated
|
|
199
|
+
request. It exits (and clears ``_reaper``) once no bridged sockets
|
|
200
|
+
remain, at which point opportunistic pruning covers new sessions.
|
|
201
|
+
"""
|
|
202
|
+
while True:
|
|
203
|
+
async with self._lock:
|
|
204
|
+
self._prune_expired_locked()
|
|
205
|
+
deadlines = [
|
|
206
|
+
session.expires_at
|
|
207
|
+
for session in self._sessions.values()
|
|
208
|
+
if session.sockets
|
|
209
|
+
]
|
|
210
|
+
if not deadlines:
|
|
211
|
+
self._reaper = None
|
|
212
|
+
return
|
|
213
|
+
delay = max(min(deadlines) - time.time(), 0.0)
|
|
214
|
+
self._reaper_wakeup.clear()
|
|
215
|
+
try:
|
|
216
|
+
await asyncio.wait_for(self._reaper_wakeup.wait(), timeout=delay)
|
|
217
|
+
except TimeoutError:
|
|
218
|
+
pass
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
def get_app_backend_session_store(
|
|
222
|
+
request: Request | WebSocket,
|
|
223
|
+
) -> AppBackendSessionStore:
|
|
224
|
+
store = getattr(request.app.state, "app_backend_session_store", None)
|
|
225
|
+
if store is None:
|
|
226
|
+
store = AppBackendSessionStore()
|
|
227
|
+
request.app.state.app_backend_session_store = store
|
|
228
|
+
return store
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
def _public_url(config: Config) -> str:
|
|
232
|
+
value = config.app_backend_public_url
|
|
233
|
+
if not value:
|
|
234
|
+
raise HTTPException(
|
|
235
|
+
status.HTTP_503_SERVICE_UNAVAILABLE,
|
|
236
|
+
"Canvas App backend ingress is not configured",
|
|
237
|
+
)
|
|
238
|
+
parsed = urlparse(value)
|
|
239
|
+
if parsed.scheme not in {"http", "https"} or not parsed.netloc:
|
|
240
|
+
raise HTTPException(
|
|
241
|
+
status.HTTP_503_SERVICE_UNAVAILABLE,
|
|
242
|
+
"Canvas App backend ingress is misconfigured",
|
|
243
|
+
)
|
|
244
|
+
return value.rstrip("/")
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
def _origin(value: str) -> str | None:
|
|
248
|
+
parsed = urlparse(value)
|
|
249
|
+
if parsed.scheme not in {"http", "https"} or not parsed.hostname:
|
|
250
|
+
return None
|
|
251
|
+
default_port = 443 if parsed.scheme == "https" else 80
|
|
252
|
+
port = parsed.port or default_port
|
|
253
|
+
return f"{parsed.scheme}://{parsed.hostname.lower()}:{port}"
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
def _allowed_control_origin(config: Config, origin: str) -> bool:
|
|
257
|
+
normalized = _origin(origin)
|
|
258
|
+
if normalized is None:
|
|
259
|
+
return False
|
|
260
|
+
parsed = urlparse(origin)
|
|
261
|
+
if parsed.hostname in {"localhost", "127.0.0.1"}:
|
|
262
|
+
return True
|
|
263
|
+
docker_host = os.environ.get("DOCKER_HOST_ADDR")
|
|
264
|
+
if docker_host and parsed.hostname == docker_host:
|
|
265
|
+
return True
|
|
266
|
+
if any(_origin(candidate) == normalized for candidate in config.allow_cors_origins):
|
|
267
|
+
return True
|
|
268
|
+
return bool(
|
|
269
|
+
config.allow_cors_origin_regex
|
|
270
|
+
and re.fullmatch(config.allow_cors_origin_regex, origin)
|
|
271
|
+
)
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
def _request_origin(request: Request | WebSocket) -> str | None:
|
|
275
|
+
"""Derive the request origin from the connection the server actually saw.
|
|
276
|
+
|
|
277
|
+
``X-Forwarded-Proto``/``X-Forwarded-Host`` are client-controllable, so they
|
|
278
|
+
are honored only when ``trust_forwarded_headers`` marks a deployment where a
|
|
279
|
+
proxy terminates TLS in front of this server. Otherwise the request's own
|
|
280
|
+
scheme and ``Host`` decide — the same inputs a spoofing client cannot fake.
|
|
281
|
+
"""
|
|
282
|
+
config: Config | None = getattr(request.app.state, "config", None)
|
|
283
|
+
trust_forwarded = bool(config and config.trust_forwarded_headers)
|
|
284
|
+
if trust_forwarded:
|
|
285
|
+
forwarded_proto = request.headers.get("x-forwarded-proto", "")
|
|
286
|
+
scheme = forwarded_proto.split(",")[0].strip() or request.url.scheme
|
|
287
|
+
forwarded_host = request.headers.get("x-forwarded-host", "")
|
|
288
|
+
host = forwarded_host.split(",")[0].strip() or request.headers.get("host", "")
|
|
289
|
+
else:
|
|
290
|
+
scheme = request.url.scheme
|
|
291
|
+
host = request.headers.get("host", "")
|
|
292
|
+
scheme = {"ws": "http", "wss": "https"}.get(scheme, scheme)
|
|
293
|
+
return _origin(f"{scheme}://{host}")
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
def _require_ingress_host(request: Request | WebSocket, public_url: str) -> None:
|
|
297
|
+
if _request_origin(request) != _origin(public_url):
|
|
298
|
+
raise HTTPException(
|
|
299
|
+
status.HTTP_421_MISDIRECTED_REQUEST,
|
|
300
|
+
"Canvas App request must use the configured ingress origin",
|
|
301
|
+
)
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
def _require_bootstrap_origin(request: Request, public_url: str) -> None:
|
|
305
|
+
_require_ingress_host(request, public_url)
|
|
306
|
+
origin = request.headers.get("origin", "")
|
|
307
|
+
config: Config = request.app.state.config
|
|
308
|
+
if not _allowed_control_origin(config, origin):
|
|
309
|
+
raise HTTPException(status.HTTP_403_FORBIDDEN, "Origin is not allowed")
|
|
310
|
+
if _origin(origin) == _origin(public_url):
|
|
311
|
+
raise HTTPException(
|
|
312
|
+
status.HTTP_409_CONFLICT,
|
|
313
|
+
"Canvas App ingress must use a separate browser origin",
|
|
314
|
+
)
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
def _require_app_origin(origin: str | None, public_url: str) -> None:
|
|
318
|
+
if not origin or _origin(origin) != _origin(public_url):
|
|
319
|
+
raise HTTPException(status.HTTP_403_FORBIDDEN, "Origin is not allowed")
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
def _validate_proxy_path(path: str) -> None:
|
|
323
|
+
"""Reject path traversal in an already once-decoded routing path.
|
|
324
|
+
|
|
325
|
+
Starlette decodes the raw URL once before ``path`` reaches us, so every
|
|
326
|
+
remaining ``%`` is encoded data the upstream will decode again. Decoding to
|
|
327
|
+
a fixed point therefore mirrors what the upstream path parser sees,
|
|
328
|
+
regardless of how deeply the caller nested the encoding. Each changing round
|
|
329
|
+
consumes at least one ``%XX`` escape, so ``len(path) + 1`` rounds is a hard
|
|
330
|
+
upper bound; reaching it means the value never converged and must be
|
|
331
|
+
rejected rather than forwarded.
|
|
332
|
+
"""
|
|
333
|
+
candidate = path
|
|
334
|
+
for _ in range(len(path) + 1):
|
|
335
|
+
decoded = unquote(candidate)
|
|
336
|
+
if decoded == candidate:
|
|
337
|
+
break
|
|
338
|
+
candidate = decoded
|
|
339
|
+
else:
|
|
340
|
+
raise HTTPException(status.HTTP_400_BAD_REQUEST, "Invalid backend path")
|
|
341
|
+
if "\\" in candidate or any(part in {".", ".."} for part in candidate.split("/")):
|
|
342
|
+
raise HTTPException(status.HTTP_400_BAD_REQUEST, "Invalid backend path")
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
def _ready_endpoint(
|
|
346
|
+
request: Request | WebSocket, extension_name: str
|
|
347
|
+
) -> tuple[str, int]:
|
|
348
|
+
manager: BackendRegistry | None = getattr(
|
|
349
|
+
request.app.state, "canvas_extension_backend_manager", None
|
|
350
|
+
)
|
|
351
|
+
endpoint = manager.ready_endpoint(extension_name) if manager is not None else None
|
|
352
|
+
if endpoint is None:
|
|
353
|
+
raise HTTPException(
|
|
354
|
+
status.HTTP_503_SERVICE_UNAVAILABLE,
|
|
355
|
+
"Canvas App backend is not ready",
|
|
356
|
+
)
|
|
357
|
+
host, port = endpoint
|
|
358
|
+
if host not in {"127.0.0.1", "::1", "localhost"}:
|
|
359
|
+
raise HTTPException(
|
|
360
|
+
status.HTTP_503_SERVICE_UNAVAILABLE,
|
|
361
|
+
"Canvas App backend target is not loopback",
|
|
362
|
+
)
|
|
363
|
+
return host, port
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
def _target(endpoint: tuple[str, int]) -> _BackendTarget:
|
|
367
|
+
host, port = endpoint
|
|
368
|
+
bracketed_host = f"[{host}]" if ":" in host and not host.startswith("[") else host
|
|
369
|
+
return _BackendTarget(host=f"http://{bracketed_host}:{port}")
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
def _cookie_path(extension_name: str) -> str:
|
|
373
|
+
return f"{_APP_BACKEND_PATH}/{extension_name}"
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
def _session_cookie_is_secure(request: Request) -> bool:
|
|
377
|
+
"""Whether a ``Secure`` app-session cookie can be issued for this request.
|
|
378
|
+
|
|
379
|
+
Uses :func:`_request_origin`, so it makes the same non-spoofable
|
|
380
|
+
trusted-proxy decision as the ingress checks rather than reading
|
|
381
|
+
``X-Forwarded-*`` unconditionally.
|
|
382
|
+
"""
|
|
383
|
+
origin = _request_origin(request)
|
|
384
|
+
if origin is None:
|
|
385
|
+
return False
|
|
386
|
+
parsed = urlparse(origin)
|
|
387
|
+
if parsed.scheme == "https":
|
|
388
|
+
return True
|
|
389
|
+
return parsed.hostname in {"localhost", "127.0.0.1", "::1"}
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
def _set_session_cookie(
|
|
393
|
+
response: Response,
|
|
394
|
+
request: Request,
|
|
395
|
+
extension_name: str,
|
|
396
|
+
token: str,
|
|
397
|
+
max_age: int,
|
|
398
|
+
) -> None:
|
|
399
|
+
if not _session_cookie_is_secure(request):
|
|
400
|
+
raise HTTPException(
|
|
401
|
+
status.HTTP_503_SERVICE_UNAVAILABLE,
|
|
402
|
+
"Canvas App sessions require HTTPS or a loopback secure context",
|
|
403
|
+
)
|
|
404
|
+
response.set_cookie(
|
|
405
|
+
key=APP_BACKEND_SESSION_COOKIE_NAME,
|
|
406
|
+
value=token,
|
|
407
|
+
max_age=max_age,
|
|
408
|
+
path=_cookie_path(extension_name),
|
|
409
|
+
secure=True,
|
|
410
|
+
httponly=True,
|
|
411
|
+
samesite="none",
|
|
412
|
+
)
|
|
413
|
+
_append_partitioned_to_last_set_cookie(response, APP_BACKEND_SESSION_COOKIE_NAME)
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
async def create_app_backend_session(
|
|
417
|
+
request: Request, response: Response, extension_name: str
|
|
418
|
+
) -> AppBackendSessionResponse:
|
|
419
|
+
public_url = _public_url(request.app.state.config)
|
|
420
|
+
_require_bootstrap_origin(request, public_url)
|
|
421
|
+
endpoint = _ready_endpoint(request, extension_name)
|
|
422
|
+
token, session = await get_app_backend_session_store(request).create(
|
|
423
|
+
extension_name, endpoint
|
|
424
|
+
)
|
|
425
|
+
_set_session_cookie(
|
|
426
|
+
response,
|
|
427
|
+
request,
|
|
428
|
+
extension_name,
|
|
429
|
+
token,
|
|
430
|
+
APP_BACKEND_SESSION_TTL_SECONDS,
|
|
431
|
+
)
|
|
432
|
+
return AppBackendSessionResponse(
|
|
433
|
+
ingress_url=f"{public_url}{_cookie_path(extension_name)}/",
|
|
434
|
+
expires_at=datetime.fromtimestamp(session.expires_at, UTC),
|
|
435
|
+
)
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
async def delete_app_backend_session(
|
|
439
|
+
request: Request, response: Response, extension_name: str
|
|
440
|
+
) -> None:
|
|
441
|
+
public_url = _public_url(request.app.state.config)
|
|
442
|
+
_require_bootstrap_origin(request, public_url)
|
|
443
|
+
token = request.cookies.get(APP_BACKEND_SESSION_COOKIE_NAME)
|
|
444
|
+
await get_app_backend_session_store(request).revoke_token(token)
|
|
445
|
+
_set_session_cookie(response, request, extension_name, "", 0)
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
async def proxy_app_backend_http(
|
|
449
|
+
request: Request, extension_name: str, path: str
|
|
450
|
+
) -> Response:
|
|
451
|
+
_validate_proxy_path(path)
|
|
452
|
+
public_url = _public_url(request.app.state.config)
|
|
453
|
+
_require_ingress_host(request, public_url)
|
|
454
|
+
if request.method not in _SAFE_METHODS:
|
|
455
|
+
_require_app_origin(request.headers.get("origin"), public_url)
|
|
456
|
+
endpoint = _ready_endpoint(request, extension_name)
|
|
457
|
+
token = request.cookies.get(APP_BACKEND_SESSION_COOKIE_NAME)
|
|
458
|
+
session = await get_app_backend_session_store(request).authorize(
|
|
459
|
+
token, extension_name, endpoint
|
|
460
|
+
)
|
|
461
|
+
if session is None:
|
|
462
|
+
raise HTTPException(status.HTTP_401_UNAUTHORIZED)
|
|
463
|
+
query = strip_auth_query("?" + request.url.query).lstrip("?")
|
|
464
|
+
upstream_path = f"/{path}" if path else "/"
|
|
465
|
+
if query:
|
|
466
|
+
upstream_path = f"{upstream_path}?{query}"
|
|
467
|
+
return await proxy_http(
|
|
468
|
+
request,
|
|
469
|
+
_target(endpoint),
|
|
470
|
+
upstream_path=upstream_path,
|
|
471
|
+
reject_redirects=True,
|
|
472
|
+
)
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
async def proxy_app_backend_websocket(
|
|
476
|
+
websocket: WebSocket, extension_name: str, path: str
|
|
477
|
+
) -> None:
|
|
478
|
+
try:
|
|
479
|
+
_validate_proxy_path(path)
|
|
480
|
+
public_url = _public_url(websocket.app.state.config)
|
|
481
|
+
_require_ingress_host(websocket, public_url)
|
|
482
|
+
_require_app_origin(websocket.headers.get("origin"), public_url)
|
|
483
|
+
endpoint = _ready_endpoint(websocket, extension_name)
|
|
484
|
+
token = websocket.cookies.get(APP_BACKEND_SESSION_COOKIE_NAME)
|
|
485
|
+
store = get_app_backend_session_store(websocket)
|
|
486
|
+
session = await store.authorize(token, extension_name, endpoint)
|
|
487
|
+
if session is None:
|
|
488
|
+
raise HTTPException(status.HTTP_401_UNAUTHORIZED)
|
|
489
|
+
except HTTPException:
|
|
490
|
+
await websocket.close(code=1008)
|
|
491
|
+
return
|
|
492
|
+
|
|
493
|
+
task = asyncio.current_task()
|
|
494
|
+
assert task is not None
|
|
495
|
+
try:
|
|
496
|
+
await store.attach_socket(session, task)
|
|
497
|
+
except RuntimeError:
|
|
498
|
+
await websocket.close(code=1008)
|
|
499
|
+
return
|
|
500
|
+
|
|
501
|
+
query = strip_auth_query("?" + websocket.url.query).lstrip("?")
|
|
502
|
+
upstream_path = f"/{path}" if path else "/"
|
|
503
|
+
if query:
|
|
504
|
+
upstream_path = f"{upstream_path}?{query}"
|
|
505
|
+
await websocket.accept()
|
|
506
|
+
try:
|
|
507
|
+
await bridge_websocket(
|
|
508
|
+
websocket,
|
|
509
|
+
_target(endpoint),
|
|
510
|
+
upstream_path=upstream_path,
|
|
511
|
+
)
|
|
512
|
+
finally:
|
|
513
|
+
await store.detach_socket(session, task)
|