openhands-agent-server 1.59.0__tar.gz → 1.60.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.59.0 → openhands_agent_server-1.60.1}/PKG-INFO +4 -4
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/agent_profiles_router.py +4 -10
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/api.py +17 -6
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/bash_service.py +38 -6
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/canvas_extensions/backend.py +176 -13
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/canvas_extensions/manifest.py +48 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/canvas_extensions_router.py +106 -12
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/conversation_service.py +5 -2
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/dependencies.py +1 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/docker/Dockerfile +119 -44
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/docker_runtime/proxy.py +22 -11
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/docker_runtime/registry.py +231 -53
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/docker_runtime/routers.py +16 -1
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/env_parser.py +1 -1
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/hooks_router.py +21 -7
- openhands_agent_server-1.60.1/openhands/agent_server/hooks_service.py +81 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/init_router.py +3 -1
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/persistence/models.py +3 -2
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/server_details_router.py +2 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/skills_service.py +1 -1
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/workspace_router.py +4 -1
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands_agent_server.egg-info/PKG-INFO +4 -4
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands_agent_server.egg-info/requires.txt +3 -3
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/pyproject.toml +4 -4
- openhands_agent_server-1.59.0/openhands/agent_server/hooks_service.py +0 -54
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/__init__.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/__main__.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/_secret_redaction.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/_secrets_exposure.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/acp_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/auth_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/bash_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/canvas_extensions/__init__.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/canvas_extensions/bridge.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/canvas_extensions/installed.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/canvas_extensions_bridge_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/config.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/conversation_lease.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/conversation_registry.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/conversation_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/credential_binding.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/docker/build.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/docker_runtime/__init__.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/docker_runtime/hybrid.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/docker_runtime/mediation.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/docker_runtime/provisioning.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/docker_runtime/storage.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/event_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/event_service.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/file_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/git_provider_service.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/git_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/launch.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/llm_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/local_secret_resolver.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/local_storage.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/logging_config.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/managed_llm_key.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/mcp_oauth_store.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/mcp_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/meta_profiles_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/middleware.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/models.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/openai/__init__.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/openai/models.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/openai/router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/openai/service.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/openapi.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/persistence/__init__.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/persistence/store.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/plugins_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/plugins_service.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/profiles_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/provider_connections_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/pub_sub.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/py.typed +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/runtime_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/session_protocol.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/session_socket.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/settings_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/skills_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/sockets.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/storage/__init__.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/storage/model.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/storage/reclaimer.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/storage/selectors.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/storage/trash.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/sub_agents_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry/__init__.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry/factory.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry/http_exporter.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry/models.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry/policy.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry/posthog_exporter.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry/sanitizer.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry/service.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry/sink.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry/subscriber.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/telemetry_types.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/tool_preload_service.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/tool_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/utils.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/vscode_extensions/openhands-settings/extension.js +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/vscode_extensions/openhands-settings/package.json +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/vscode_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/vscode_service.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/workspaces_router.py +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands_agent_server.egg-info/SOURCES.txt +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands_agent_server.egg-info/dependency_links.txt +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands_agent_server.egg-info/entry_points.txt +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands_agent_server.egg-info/top_level.txt +0 -0
- {openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/setup.cfg +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: openhands-agent-server
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.60.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
|
|
@@ -8,7 +8,7 @@ Project-URL: Documentation, https://docs.openhands.dev/sdk
|
|
|
8
8
|
Project-URL: Bug Tracker, https://github.com/OpenHands/software-agent-sdk/issues
|
|
9
9
|
Requires-Python: >=3.12
|
|
10
10
|
Requires-Dist: aiosqlite>=0.22.1
|
|
11
|
-
Requires-Dist: alembic>=1.
|
|
11
|
+
Requires-Dist: alembic>=1.20.1
|
|
12
12
|
Requires-Dist: certifi>=2026.10.19
|
|
13
13
|
Requires-Dist: docker<8,>=7.1
|
|
14
14
|
Requires-Dist: fastapi>=0.104
|
|
@@ -16,9 +16,9 @@ Requires-Dist: openhands-sdk
|
|
|
16
16
|
Requires-Dist: openhands-tools
|
|
17
17
|
Requires-Dist: openai<3,>=2.33.0
|
|
18
18
|
Requires-Dist: pydantic>=2.13.5
|
|
19
|
-
Requires-Dist: sqlalchemy>=2
|
|
19
|
+
Requires-Dist: sqlalchemy>=2.1.5
|
|
20
20
|
Requires-Dist: uvicorn>=0.54.0
|
|
21
21
|
Requires-Dist: websockets>=12
|
|
22
22
|
Requires-Dist: wsproto>=1.2.0
|
|
23
23
|
Provides-Extra: posthog
|
|
24
|
-
Requires-Dist: posthog<8,>=7.
|
|
24
|
+
Requires-Dist: posthog<8,>=7.75.11; extra == "posthog"
|
|
@@ -61,7 +61,7 @@ from openhands.sdk.profiles.agent_profile_store import (
|
|
|
61
61
|
PROFILE_NAME_PATTERN,
|
|
62
62
|
canonical_profile_name,
|
|
63
63
|
)
|
|
64
|
-
from openhands.sdk.settings.model import
|
|
64
|
+
from openhands.sdk.settings.model import apply_agent_settings_diff
|
|
65
65
|
from openhands.sdk.utils.cipher import Cipher
|
|
66
66
|
|
|
67
67
|
|
|
@@ -455,8 +455,7 @@ def delete_agent_profile(
|
|
|
455
455
|
reseeded from the settings when it was the one deleted. If
|
|
456
456
|
``agent_settings`` is itself left on a non-OpenHands variant, it is first
|
|
457
457
|
reset to default OpenHands agent settings so stale ACP configuration does
|
|
458
|
-
not outlive the profile it came from;
|
|
459
|
-
carried over.
|
|
458
|
+
not outlive the profile it came from; server-wide settings are carried over.
|
|
460
459
|
"""
|
|
461
460
|
store = get_agent_profile_store()
|
|
462
461
|
deleted_id = _summary_id_for_name(store, name)
|
|
@@ -474,15 +473,10 @@ def delete_agent_profile(
|
|
|
474
473
|
s: PersistedSettings,
|
|
475
474
|
) -> PersistedSettings:
|
|
476
475
|
s.active_agent_profile_id = None
|
|
477
|
-
# Stale non-OpenHands settings outlive their profile. Reset to
|
|
478
|
-
# a fresh OpenHands base rather than merging across the variant
|
|
479
|
-
# boundary (see _apply_agent_settings_diff), except for
|
|
480
|
-
# ``mcp_config``: it is the server-wide MCP registry every other
|
|
481
|
-
# profile resolves ``mcp_server_refs`` against, not ACP state.
|
|
482
476
|
prior_kind = s.agent_settings.agent_kind
|
|
483
477
|
if prior_kind != "openhands":
|
|
484
|
-
s.agent_settings =
|
|
485
|
-
|
|
478
|
+
s.agent_settings = apply_agent_settings_diff(
|
|
479
|
+
s.agent_settings, {"agent_kind": "openhands"}
|
|
486
480
|
)
|
|
487
481
|
logger.info(
|
|
488
482
|
f"Reset agent_settings to default "
|
{openhands_agent_server-1.59.0 → openhands_agent_server-1.60.1}/openhands/agent_server/api.py
RENAMED
|
@@ -18,6 +18,7 @@ from fastapi.exceptions import RequestValidationError
|
|
|
18
18
|
from fastapi.responses import JSONResponse, RedirectResponse
|
|
19
19
|
from fastapi.staticfiles import StaticFiles
|
|
20
20
|
from starlette.requests import Request
|
|
21
|
+
from starlette.types import ASGIApp
|
|
21
22
|
|
|
22
23
|
from openhands.agent_server.acp_router import acp_router
|
|
23
24
|
from openhands.agent_server.agent_profiles_router import agent_profiles_router
|
|
@@ -528,13 +529,25 @@ def _get_root_path(config: Config) -> str:
|
|
|
528
529
|
return root_path
|
|
529
530
|
|
|
530
531
|
|
|
532
|
+
class AgentServerApp(FastAPI):
|
|
533
|
+
def build_middleware_stack(self) -> ASGIApp:
|
|
534
|
+
# ServerErrorMiddleware creates unhandled 500 responses outside user
|
|
535
|
+
# middleware, so CORS must wrap the complete stack to decorate them.
|
|
536
|
+
config = self.state.config
|
|
537
|
+
return CORSDispatcher(
|
|
538
|
+
super().build_middleware_stack(),
|
|
539
|
+
allow_origins=config.allow_cors_origins,
|
|
540
|
+
allow_origin_regex=config.allow_cors_origin_regex,
|
|
541
|
+
)
|
|
542
|
+
|
|
543
|
+
|
|
531
544
|
def _create_fastapi_instance(config: Config) -> FastAPI:
|
|
532
545
|
"""Create the basic FastAPI application instance.
|
|
533
546
|
|
|
534
547
|
Returns:
|
|
535
548
|
Basic FastAPI application with title, description, and lifespan.
|
|
536
549
|
"""
|
|
537
|
-
return
|
|
550
|
+
return AgentServerApp(
|
|
538
551
|
title="OpenHands Agent Server",
|
|
539
552
|
version=version("openhands-agent-server"),
|
|
540
553
|
description=(
|
|
@@ -908,11 +921,9 @@ def create_app(config: Config | None = None) -> FastAPI:
|
|
|
908
921
|
)
|
|
909
922
|
|
|
910
923
|
app.add_middleware(RuntimeDispatchMiddleware)
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
allow_origin_regex=config.allow_cors_origin_regex,
|
|
915
|
-
)
|
|
924
|
+
# CORS is not added as user middleware here: AgentServerApp wraps the
|
|
925
|
+
# complete stack (including ServerErrorMiddleware) in CORSDispatcher so
|
|
926
|
+
# unhandled 500 responses also carry CORS headers.
|
|
916
927
|
_add_exception_handlers(app)
|
|
917
928
|
|
|
918
929
|
return app
|
|
@@ -8,6 +8,8 @@ from datetime import UTC, datetime, timedelta
|
|
|
8
8
|
from pathlib import Path
|
|
9
9
|
from uuid import UUID
|
|
10
10
|
|
|
11
|
+
from pydantic import SecretStr
|
|
12
|
+
|
|
11
13
|
from openhands.agent_server.models import (
|
|
12
14
|
BashCommand,
|
|
13
15
|
BashEventBase,
|
|
@@ -19,6 +21,7 @@ from openhands.agent_server.models import (
|
|
|
19
21
|
from openhands.agent_server.pub_sub import PubSub, Subscriber
|
|
20
22
|
from openhands.sdk.logger import get_logger
|
|
21
23
|
from openhands.sdk.utils import sanitized_env, utc_now
|
|
24
|
+
from openhands.sdk.utils.cipher import FERNET_TOKEN_PREFIX, Cipher
|
|
22
25
|
|
|
23
26
|
|
|
24
27
|
logger = get_logger(__name__)
|
|
@@ -32,6 +35,12 @@ class BashEventService:
|
|
|
32
35
|
|
|
33
36
|
bash_events_dir: Path = field()
|
|
34
37
|
default_cwd: str | None = None
|
|
38
|
+
# Encrypts each event file at rest. The files hold the app server's setup
|
|
39
|
+
# commands and the terminal's output verbatim, on the sandbox volume,
|
|
40
|
+
# where an agent can publish them on the app ports (OHE-3812); the key
|
|
41
|
+
# lives in the server's environment, never on the volume. None writes
|
|
42
|
+
# plaintext, as before. Files written before encryption still read.
|
|
43
|
+
cipher: Cipher | None = None
|
|
35
44
|
_tasks: set[asyncio.Task] = field(default_factory=set, init=False)
|
|
36
45
|
_closed: bool = field(default=False, init=False)
|
|
37
46
|
# Processes of currently running commands, keyed by command id. A None
|
|
@@ -88,20 +97,41 @@ class BashEventService:
|
|
|
88
97
|
return "_".join(result)
|
|
89
98
|
|
|
90
99
|
def _save_event_to_file(self, event: BashEventBase) -> None:
|
|
91
|
-
"""Save an event to a file."""
|
|
100
|
+
"""Save an event to a file, encrypted when a cipher is configured."""
|
|
92
101
|
self._ensure_bash_events_dir()
|
|
93
102
|
filename = self._get_event_filename(event)
|
|
94
103
|
filepath = self.bash_events_dir / filename
|
|
95
104
|
|
|
105
|
+
# Use model_dump with mode='json' to handle UUID serialization
|
|
106
|
+
data = json.dumps(event.model_dump(mode="json"), indent=2)
|
|
107
|
+
if self.cipher is not None:
|
|
108
|
+
# encrypt() is None only for a None secret.
|
|
109
|
+
encrypted = self.cipher.encrypt(SecretStr(data))
|
|
110
|
+
data = data if encrypted is None else encrypted
|
|
96
111
|
with open(filepath, "w") as f:
|
|
97
|
-
|
|
98
|
-
data = event.model_dump(mode="json")
|
|
99
|
-
f.write(json.dumps(data, indent=2))
|
|
112
|
+
f.write(data)
|
|
100
113
|
|
|
101
114
|
def _load_event_from_file(self, filepath: Path) -> BashEventBase | None:
|
|
102
|
-
"""Load an event from a file.
|
|
115
|
+
"""Load an event from a file.
|
|
116
|
+
|
|
117
|
+
An encrypted file (a Fernet token) is decrypted with the cipher, which
|
|
118
|
+
tries its previous keys too, so files from before a key rotation still
|
|
119
|
+
read; a plaintext file from before encryption is parsed as it is.
|
|
120
|
+
"""
|
|
103
121
|
try:
|
|
104
122
|
json_data = filepath.read_text()
|
|
123
|
+
if json_data.startswith(FERNET_TOKEN_PREFIX):
|
|
124
|
+
if self.cipher is None:
|
|
125
|
+
logger.error(
|
|
126
|
+
f"Event file {filepath} is encrypted but no cipher "
|
|
127
|
+
"is configured"
|
|
128
|
+
)
|
|
129
|
+
return None
|
|
130
|
+
decrypted = self.cipher.try_decrypt_str(json_data)
|
|
131
|
+
if decrypted is None:
|
|
132
|
+
logger.error(f"Event file {filepath} does not decrypt with any key")
|
|
133
|
+
return None
|
|
134
|
+
json_data = decrypted
|
|
105
135
|
return BashEventBase.model_validate_json(json_data)
|
|
106
136
|
except Exception as e:
|
|
107
137
|
logger.error(f"Error loading event from {filepath}: {e}")
|
|
@@ -611,5 +641,7 @@ def get_default_bash_event_service() -> BashEventService:
|
|
|
611
641
|
from openhands.agent_server.config import get_default_config
|
|
612
642
|
|
|
613
643
|
config = get_default_config()
|
|
614
|
-
_bash_event_service = BashEventService(
|
|
644
|
+
_bash_event_service = BashEventService(
|
|
645
|
+
bash_events_dir=config.bash_events_dir, cipher=config.cipher
|
|
646
|
+
)
|
|
615
647
|
return _bash_event_service
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
"""Owned lifecycle for optional Canvas App backend subprocesses."""
|
|
2
2
|
|
|
3
3
|
import asyncio
|
|
4
|
+
import codecs
|
|
4
5
|
import gzip
|
|
5
6
|
import hashlib
|
|
6
7
|
import os
|
|
7
8
|
import platform
|
|
9
|
+
import re
|
|
8
10
|
import shutil
|
|
9
11
|
import signal
|
|
10
12
|
import socket
|
|
@@ -32,7 +34,10 @@ from openhands.agent_server.canvas_extensions.manifest import (
|
|
|
32
34
|
CanvasExtensionBackendArtifact,
|
|
33
35
|
CanvasExtensionManifest,
|
|
34
36
|
)
|
|
37
|
+
from openhands.agent_server.persistence.store import SecretsStore, get_secrets_store
|
|
38
|
+
from openhands.sdk.conversation.secret_registry import StreamOutputMask
|
|
35
39
|
from openhands.sdk.utils.path import get_user_persistence_dir
|
|
40
|
+
from openhands.sdk.utils.pydantic_secrets import REDACTED_SECRET_VALUE
|
|
36
41
|
|
|
37
42
|
|
|
38
43
|
BackendState = Literal[
|
|
@@ -61,6 +66,13 @@ class BackendRevisionRequest(BaseModel):
|
|
|
61
66
|
revision: str = Field(min_length=1)
|
|
62
67
|
|
|
63
68
|
|
|
69
|
+
class BackendSecretGrantRequest(BackendRevisionRequest):
|
|
70
|
+
"""Consent to the exact declared names, never credential values."""
|
|
71
|
+
|
|
72
|
+
model_config = {"extra": "forbid"}
|
|
73
|
+
secret_refs: list[str]
|
|
74
|
+
|
|
75
|
+
|
|
64
76
|
class BackendStatus(BaseModel):
|
|
65
77
|
"""Current state of an installed Canvas App backend."""
|
|
66
78
|
|
|
@@ -68,6 +80,8 @@ class BackendStatus(BaseModel):
|
|
|
68
80
|
state: BackendState
|
|
69
81
|
revision: str | None = None
|
|
70
82
|
prepared_revision: str | None = None
|
|
83
|
+
secret_refs: list[str] = Field(default_factory=list)
|
|
84
|
+
secret_grant_revision: str | None = None
|
|
71
85
|
pid: int | None = None
|
|
72
86
|
port: int | None = None
|
|
73
87
|
detail: str | None = None
|
|
@@ -115,6 +129,7 @@ class _Runtime:
|
|
|
115
129
|
self.revision: str | None = None
|
|
116
130
|
self.state: BackendState = "stopped"
|
|
117
131
|
self.detail: str | None = None
|
|
132
|
+
self.secret_values: tuple[bytes, ...] = ()
|
|
118
133
|
self.logs: deque[bytes] = deque()
|
|
119
134
|
self.log_bytes = 0
|
|
120
135
|
self.logs_truncated = False
|
|
@@ -135,11 +150,13 @@ class CanvasExtensionBackendManager:
|
|
|
135
150
|
*,
|
|
136
151
|
allow_insecure_artifact_urls: bool = False,
|
|
137
152
|
max_artifact_bytes: int = _MAX_ARTIFACT_BYTES,
|
|
153
|
+
secrets_store: SecretsStore | None = None,
|
|
138
154
|
) -> None:
|
|
139
155
|
self.installed_dir = installed_dir or get_installed_canvas_extensions_dir()
|
|
140
156
|
root = (
|
|
141
157
|
state_dir or get_user_persistence_dir() / "canvas-extensions" / "backends"
|
|
142
158
|
)
|
|
159
|
+
self.secrets_store = secrets_store
|
|
143
160
|
self.state_dir = root
|
|
144
161
|
self.artifacts_dir = root / "artifacts"
|
|
145
162
|
self.downloads_dir = root / "downloads"
|
|
@@ -165,9 +182,9 @@ class CanvasExtensionBackendManager:
|
|
|
165
182
|
manifest = self._manifest(name)
|
|
166
183
|
if info is None or manifest is None:
|
|
167
184
|
return None
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
185
|
+
payload = (
|
|
186
|
+
str(info.resolved_ref or "") + manifest.model_dump_json(exclude_none=True)
|
|
187
|
+
).encode()
|
|
171
188
|
return f"sha256:{hashlib.sha256(payload).hexdigest()}"
|
|
172
189
|
|
|
173
190
|
@staticmethod
|
|
@@ -218,8 +235,68 @@ class CanvasExtensionBackendManager:
|
|
|
218
235
|
temporary.write_text(state.model_dump_json())
|
|
219
236
|
os.replace(temporary, destination)
|
|
220
237
|
|
|
238
|
+
def _grant_path(self, name: str) -> Path:
|
|
239
|
+
return self.state_dir / "secret-grants" / f"{name}.json"
|
|
240
|
+
|
|
241
|
+
def _read_grant(self, name: str) -> BackendSecretGrantRequest | None:
|
|
242
|
+
try:
|
|
243
|
+
return BackendSecretGrantRequest.model_validate_json(
|
|
244
|
+
self._grant_path(name).read_text()
|
|
245
|
+
)
|
|
246
|
+
except (OSError, ValueError):
|
|
247
|
+
return None
|
|
248
|
+
|
|
249
|
+
def _grant_valid(self, name: str) -> bool:
|
|
250
|
+
manifest = self._manifest(name)
|
|
251
|
+
grant = self._read_grant(name)
|
|
252
|
+
return bool(
|
|
253
|
+
manifest
|
|
254
|
+
and manifest.backend
|
|
255
|
+
and grant
|
|
256
|
+
and grant.revision == self.revision(name)
|
|
257
|
+
and sorted(grant.secret_refs) == sorted(manifest.backend.secret_refs)
|
|
258
|
+
)
|
|
259
|
+
|
|
260
|
+
async def grant_secrets(
|
|
261
|
+
self, name: str, grant: BackendSecretGrantRequest
|
|
262
|
+
) -> BackendStatus:
|
|
263
|
+
async with self._lock(name):
|
|
264
|
+
manifest = self._manifest(name)
|
|
265
|
+
if (
|
|
266
|
+
not manifest
|
|
267
|
+
or not manifest.backend
|
|
268
|
+
or grant.revision != self.revision(name)
|
|
269
|
+
or len(grant.secret_refs) != len(set(grant.secret_refs))
|
|
270
|
+
or sorted(grant.secret_refs) != sorted(manifest.backend.secret_refs)
|
|
271
|
+
):
|
|
272
|
+
raise ValueError(
|
|
273
|
+
"Grant must match installed revision and declared names"
|
|
274
|
+
)
|
|
275
|
+
destination = self._grant_path(name)
|
|
276
|
+
destination.parent.mkdir(parents=True, exist_ok=True, mode=0o700)
|
|
277
|
+
temporary = destination.with_suffix(".tmp")
|
|
278
|
+
temporary.write_text(grant.model_dump_json())
|
|
279
|
+
temporary.chmod(0o600)
|
|
280
|
+
os.replace(temporary, destination)
|
|
281
|
+
return self._status_unlocked(name)
|
|
282
|
+
|
|
283
|
+
async def revoke_secrets(self, name: str) -> BackendStatus:
|
|
284
|
+
async with self._lock(name):
|
|
285
|
+
self._grant_path(name).unlink(missing_ok=True)
|
|
286
|
+
runtime = self._runtimes.get(name)
|
|
287
|
+
if runtime:
|
|
288
|
+
runtime.stop_requested.set()
|
|
289
|
+
if runtime.start_task:
|
|
290
|
+
runtime.start_task.cancel()
|
|
291
|
+
runtime.start_task = None
|
|
292
|
+
await self._terminate_runtime(runtime)
|
|
293
|
+
runtime.state = "stopped"
|
|
294
|
+
runtime.detail = None
|
|
295
|
+
return self._status_unlocked(name)
|
|
296
|
+
|
|
221
297
|
def invalidate_approval(self, name: str) -> None:
|
|
222
298
|
self._approval_path(name).unlink(missing_ok=True)
|
|
299
|
+
self._grant_path(name).unlink(missing_ok=True)
|
|
223
300
|
|
|
224
301
|
@staticmethod
|
|
225
302
|
def _resolve_contained(root: Path, relative: str) -> Path:
|
|
@@ -470,6 +547,10 @@ class CanvasExtensionBackendManager:
|
|
|
470
547
|
state=state,
|
|
471
548
|
revision=revision,
|
|
472
549
|
prepared_revision=prepared_revision,
|
|
550
|
+
secret_refs=manifest.backend.secret_refs
|
|
551
|
+
if manifest and manifest.backend
|
|
552
|
+
else [],
|
|
553
|
+
secret_grant_revision=revision if self._grant_valid(name) else None,
|
|
473
554
|
pid=(
|
|
474
555
|
runtime.process.pid
|
|
475
556
|
if runtime and runtime.process and runtime.process.returncode is None
|
|
@@ -489,6 +570,13 @@ class CanvasExtensionBackendManager:
|
|
|
489
570
|
|
|
490
571
|
async def _refresh_unlocked(self, name: str) -> BackendStatus:
|
|
491
572
|
runtime = self._runtimes.get(name)
|
|
573
|
+
if runtime and runtime.process and runtime.revision != self.revision(name):
|
|
574
|
+
runtime.stop_requested.set()
|
|
575
|
+
if runtime.start_task:
|
|
576
|
+
runtime.start_task.cancel()
|
|
577
|
+
runtime.start_task = None
|
|
578
|
+
await self._terminate_runtime(runtime)
|
|
579
|
+
runtime.state = "stopped"
|
|
492
580
|
if runtime and runtime.process and runtime.process.returncode is not None:
|
|
493
581
|
returncode = runtime.process.returncode
|
|
494
582
|
runtime.port = None
|
|
@@ -585,13 +673,33 @@ class CanvasExtensionBackendManager:
|
|
|
585
673
|
) -> None:
|
|
586
674
|
if stream is None:
|
|
587
675
|
return
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
676
|
+
values = sorted(
|
|
677
|
+
(value.decode("utf-8") for value in runtime.secret_values),
|
|
678
|
+
key=len,
|
|
679
|
+
reverse=True,
|
|
680
|
+
)
|
|
681
|
+
pattern = (
|
|
682
|
+
re.compile("|".join(re.escape(value) for value in values))
|
|
683
|
+
if values
|
|
684
|
+
else None
|
|
685
|
+
)
|
|
686
|
+
masker = StreamOutputMask(pattern, max(map(len, values), default=0))
|
|
687
|
+
decoder = codecs.getincrementaldecoder("utf-8")("replace")
|
|
688
|
+
while True:
|
|
689
|
+
chunk = await stream.read(8192)
|
|
690
|
+
text = decoder.decode(chunk, final=not chunk)
|
|
691
|
+
output = masker.feed(text)
|
|
692
|
+
if not chunk:
|
|
693
|
+
output += masker.flush()
|
|
694
|
+
if output:
|
|
695
|
+
entry = label + output.encode("utf-8")
|
|
696
|
+
runtime.logs.append(entry)
|
|
697
|
+
runtime.log_bytes += len(entry)
|
|
698
|
+
while runtime.log_bytes > _MAX_LOG_BYTES and runtime.logs:
|
|
699
|
+
runtime.log_bytes -= len(runtime.logs.popleft())
|
|
700
|
+
runtime.logs_truncated = True
|
|
701
|
+
if not chunk:
|
|
702
|
+
return
|
|
595
703
|
|
|
596
704
|
@staticmethod
|
|
597
705
|
def _probe(url: str) -> bool:
|
|
@@ -645,9 +753,21 @@ class CanvasExtensionBackendManager:
|
|
|
645
753
|
|
|
646
754
|
async def start(self, name: str, revision: str) -> BackendStatus:
|
|
647
755
|
async with self._lock(name):
|
|
648
|
-
current = self.
|
|
756
|
+
current = await self._refresh_unlocked(name)
|
|
649
757
|
if current.state in {"missing", "unsupported"}:
|
|
650
758
|
return current
|
|
759
|
+
if revision != self.revision(name):
|
|
760
|
+
raise ValueError("approval revision does not match installed revision")
|
|
761
|
+
manifest = self._manifest(name)
|
|
762
|
+
if (
|
|
763
|
+
manifest
|
|
764
|
+
and manifest.backend
|
|
765
|
+
and manifest.backend.secret_refs
|
|
766
|
+
and not self._grant_valid(name)
|
|
767
|
+
):
|
|
768
|
+
raise ValueError(
|
|
769
|
+
"Backend secrets require an exact revision-bound grant"
|
|
770
|
+
)
|
|
651
771
|
runtime = self._runtime(name)
|
|
652
772
|
task = runtime.start_task
|
|
653
773
|
if runtime.process and runtime.process.returncode is None:
|
|
@@ -685,6 +805,30 @@ class CanvasExtensionBackendManager:
|
|
|
685
805
|
)
|
|
686
806
|
if runtime.process is not None:
|
|
687
807
|
await self._terminate_runtime(runtime)
|
|
808
|
+
secret_environment: dict[str, str] = {}
|
|
809
|
+
if backend.secret_refs:
|
|
810
|
+
store = self.secrets_store or get_secrets_store()
|
|
811
|
+
for secret_name in backend.secret_refs:
|
|
812
|
+
try:
|
|
813
|
+
value = await asyncio.to_thread(
|
|
814
|
+
store.get_secret, secret_name
|
|
815
|
+
)
|
|
816
|
+
except Exception:
|
|
817
|
+
raise ValueError(
|
|
818
|
+
"Backend secret store could not be read"
|
|
819
|
+
) from None
|
|
820
|
+
if not value or "\x00" in value:
|
|
821
|
+
raise ValueError(
|
|
822
|
+
f"Backend secret is missing or invalid: {secret_name}"
|
|
823
|
+
)
|
|
824
|
+
secret_environment[secret_name] = value
|
|
825
|
+
runtime.secret_values = tuple(
|
|
826
|
+
sorted(
|
|
827
|
+
{value.encode() for value in secret_environment.values()},
|
|
828
|
+
key=len,
|
|
829
|
+
reverse=True,
|
|
830
|
+
)
|
|
831
|
+
)
|
|
688
832
|
package_root = (self.installed_dir / name).resolve()
|
|
689
833
|
data_dir = self.data_dir / name
|
|
690
834
|
data_dir.mkdir(parents=True, exist_ok=True)
|
|
@@ -701,7 +845,10 @@ class CanvasExtensionBackendManager:
|
|
|
701
845
|
runtime.process = await asyncio.create_subprocess_exec(
|
|
702
846
|
*self._expand_argv(backend, port, data_dir, artifact_dir),
|
|
703
847
|
cwd=package_root,
|
|
704
|
-
env=
|
|
848
|
+
env={
|
|
849
|
+
**self._environment(backend, data_dir),
|
|
850
|
+
**secret_environment,
|
|
851
|
+
},
|
|
705
852
|
stdout=asyncio.subprocess.PIPE,
|
|
706
853
|
stderr=asyncio.subprocess.PIPE,
|
|
707
854
|
start_new_session=True,
|
|
@@ -709,6 +856,10 @@ class CanvasExtensionBackendManager:
|
|
|
709
856
|
except Exception as exc:
|
|
710
857
|
runtime.state = "unhealthy"
|
|
711
858
|
runtime.detail = str(exc)
|
|
859
|
+
for value in secret_environment.values():
|
|
860
|
+
runtime.detail = runtime.detail.replace(
|
|
861
|
+
value, REDACTED_SECRET_VALUE
|
|
862
|
+
)
|
|
712
863
|
await self._terminate_runtime(runtime)
|
|
713
864
|
return self._status_unlocked(name)
|
|
714
865
|
self._write_run_record(name, runtime.process.pid)
|
|
@@ -795,6 +946,7 @@ class CanvasExtensionBackendManager:
|
|
|
795
946
|
self._run_record_path(pgid).unlink(missing_ok=True)
|
|
796
947
|
runtime.process = None
|
|
797
948
|
runtime.port = None
|
|
949
|
+
runtime.secret_values = ()
|
|
798
950
|
|
|
799
951
|
def _run_record_path(self, pgid: int) -> Path:
|
|
800
952
|
return self.run_dir / f"{pgid}.json"
|
|
@@ -859,6 +1011,12 @@ class CanvasExtensionBackendManager:
|
|
|
859
1011
|
for runtime in self._runtimes.values()
|
|
860
1012
|
)
|
|
861
1013
|
|
|
1014
|
+
async def wait_until_ready(self, name: str) -> BackendStatus:
|
|
1015
|
+
runtime = self._runtimes.get(name)
|
|
1016
|
+
if runtime and runtime.start_task:
|
|
1017
|
+
await runtime.start_task
|
|
1018
|
+
return await self.status(name)
|
|
1019
|
+
|
|
862
1020
|
async def stop(self, name: str) -> BackendStatus:
|
|
863
1021
|
task: asyncio.Task[None] | None = None
|
|
864
1022
|
async with self._lock(name):
|
|
@@ -906,7 +1064,12 @@ class CanvasExtensionBackendManager:
|
|
|
906
1064
|
def ready_endpoint(self, name: str) -> tuple[str, int] | None:
|
|
907
1065
|
"""Internal registry boundary for the future authenticated router."""
|
|
908
1066
|
runtime = self._runtimes.get(name)
|
|
909
|
-
if
|
|
1067
|
+
if (
|
|
1068
|
+
runtime is None
|
|
1069
|
+
or runtime.state != "ready"
|
|
1070
|
+
or runtime.port is None
|
|
1071
|
+
or runtime.revision != self.revision(name)
|
|
1072
|
+
):
|
|
910
1073
|
return None
|
|
911
1074
|
# `state` is only reconciled by status()/start()/stop(); a backend that
|
|
912
1075
|
# crashed since then must not be dialed (the next status poll reports
|
|
@@ -171,6 +171,54 @@ class CanvasExtensionBackend(BaseModel):
|
|
|
171
171
|
default_factory=CanvasExtensionBackendHealth
|
|
172
172
|
)
|
|
173
173
|
inherit_environment: list[str] = Field(default_factory=list)
|
|
174
|
+
secret_refs: list[str] = Field(default_factory=list)
|
|
175
|
+
|
|
176
|
+
@field_validator("secret_refs")
|
|
177
|
+
@classmethod
|
|
178
|
+
def _validate_secret_refs(cls, value: list[str]) -> list[str]:
|
|
179
|
+
reserved = {
|
|
180
|
+
"HOME",
|
|
181
|
+
"PATH",
|
|
182
|
+
"TMPDIR",
|
|
183
|
+
"LANG",
|
|
184
|
+
"LC_ALL",
|
|
185
|
+
"LC_CTYPE",
|
|
186
|
+
"TZ",
|
|
187
|
+
"PWD",
|
|
188
|
+
"SHELL",
|
|
189
|
+
"ENV",
|
|
190
|
+
"BASH_ENV",
|
|
191
|
+
"IFS",
|
|
192
|
+
"PYTHONPATH",
|
|
193
|
+
"PYTHONHOME",
|
|
194
|
+
"NODE_OPTIONS",
|
|
195
|
+
"SESSION_API_KEY",
|
|
196
|
+
"LOCAL_BACKEND_API_KEY",
|
|
197
|
+
"VITE_SESSION_API_KEY",
|
|
198
|
+
"LD_PRELOAD",
|
|
199
|
+
"LD_LIBRARY_PATH",
|
|
200
|
+
}
|
|
201
|
+
if len(value) != len(set(value)):
|
|
202
|
+
raise ValueError("secret_refs entries must be unique")
|
|
203
|
+
for name in value:
|
|
204
|
+
if (
|
|
205
|
+
not re.fullmatch(r"[A-Za-z_][A-Za-z0-9_]*", name)
|
|
206
|
+
or name.upper() in reserved
|
|
207
|
+
or name.upper().startswith(
|
|
208
|
+
(
|
|
209
|
+
"OH_",
|
|
210
|
+
"OPENHANDS_",
|
|
211
|
+
"LD_",
|
|
212
|
+
"DYLD_",
|
|
213
|
+
"PYTHON",
|
|
214
|
+
"NODE_",
|
|
215
|
+
"BASH_",
|
|
216
|
+
"UV_",
|
|
217
|
+
)
|
|
218
|
+
)
|
|
219
|
+
):
|
|
220
|
+
raise ValueError("secret_refs contains an invalid or reserved name")
|
|
221
|
+
return value
|
|
174
222
|
|
|
175
223
|
@field_validator("argv")
|
|
176
224
|
@classmethod
|