Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

fix(compile): keep API keys private while forwarding runtime args (#4865)

Qin Haojief60a71d00306
diff --git a/openviking/service/compile_service.py b/openviking/service/compile_service.py
index 860264fa9..63eec42d9 100644
--- a/openviking/service/compile_service.py
+++ b/openviking/service/compile_service.py
@@ -20,7 +20,7 @@ from openviking.service.external_task_service import (
ExternalTaskSnapshot,
)
from openviking.service.fs_service import FSService
-from openviking.service.task_tracker import TaskRecord
+from openviking.service.task_tracker import SENSITIVE_TASK_KEYS, TaskRecord
from openviking_cli.exceptions import (
InvalidArgumentError,
NotFoundError,
@@ -432,12 +432,14 @@ class CompileService:
def _split_payload(request: CompileRequest) -> tuple[dict[str, Any], dict[str, Any]]:
payload = request.model_dump(mode="json", by_alias=True, exclude_none=True)
args = payload.get("args")
- if not isinstance(args, dict) or "user_key" not in args:
+ if not isinstance(args, dict):
+ return payload, {}
+ private_args = {key: args.pop(key) for key in SENSITIVE_TASK_KEYS if key in args}
+ if not private_args:
return payload, {}
- private_payload = {"args": {"user_key": args.pop("user_key")}}
if not args:
payload.pop("args", None)
- return payload, private_payload
+ return payload, {"args": private_args}
@staticmethod
def _snapshot(task: CompileSessionStatus) -> ExternalTaskSnapshot:
diff --git a/openviking/service/task_tracker.py b/openviking/service/task_tracker.py
index a4b8c88db..38172f948 100644
--- a/openviking/service/task_tracker.py
+++ b/openviking/service/task_tracker.py
@@ -142,7 +142,7 @@ _SENSITIVE_PATTERNS = re.compile(
)
_MAX_ERROR_LEN = 500
-_SENSITIVE_RESULT_KEYS = {"user_key"}
+SENSITIVE_TASK_KEYS = frozenset({"api_key", "user_key"})
def _sanitize_error(error: str) -> str:
@@ -159,7 +159,7 @@ def _sanitize_task_result(result: Any) -> Any:
return {
key: _sanitize_task_result(value)
for key, value in result.items()
- if key not in _SENSITIVE_RESULT_KEYS
+ if key not in SENSITIVE_TASK_KEYS
}
if isinstance(result, list):
return [_sanitize_task_result(item) for item in result]
diff --git a/tests/server/test_bot_proxy_auth.py b/tests/server/test_bot_proxy_auth.py
index 66d87a4f8..0efc9067f 100644
--- a/tests/server/test_bot_proxy_auth.py
+++ b/tests/server/test_bot_proxy_auth.py
@@ -7,6 +7,7 @@ import asyncio
import json
from collections import deque
from types import SimpleNamespace
+from unittest.mock import AsyncMock
import httpx
import pytest
@@ -367,31 +368,52 @@ async def test_compile_api_client_session_protocol_retry_and_cancellation(
SimpleNamespace(),
)
tasks.register(service)
- public_payload, private_payload = service._split_payload(
- compile_service_module.CompileRequest.model_validate(
- {
- "from": ["viking://resources/source"],
- "to": "viking://resources/wiki",
- "skill": "viking://agent/skills/wiki",
- "args": {"model_name": "model-1", "user_key": "model-user-key"},
- "instruction": "Keep supporting evidence.",
- }
- )
- )
- assert public_payload["args"] == {"model_name": "model-1"}
- assert private_payload == {"args": {"user_key": "model-user-key"}}
- external_task_id = await service.submit(
- "cmp_ov_1",
+ request = compile_service_module.CompileRequest.model_validate(
{
"from": ["viking://resources/source"],
"to": "viking://resources/wiki",
"skill": "viking://agent/skills/wiki",
"instruction": "Keep supporting evidence.",
- },
- {
- "args": {"user_key": "model-user-key"},
- },
- {"api_key": "active-user-key"},
+ "args": {
+ "model_name": "model-1",
+ "user_key": "model-user-key",
+ "api_key": "compile-api-key",
+ },
+ }
+ )
+ monkeypatch.setattr(service, "_normalize_request", AsyncMock(return_value=request))
+ store = PersistentTaskStore(MockLocalAGFS(root_path=tmp_path))
+ tracker = TaskTracker(store)
+ monkeypatch.setattr(external_task_service_module, "get_task_tracker", lambda: tracker)
+ monkeypatch.setattr(
+ external_task_service_module,
+ "get_queue_manager",
+ lambda: SimpleNamespace(enqueue=AsyncMock()),
+ )
+ connection = {"api_key": "active-user-key"}
+ owner = {"account_id": "acct", "user_id": "alice"}
+ task = await service.create(
+ request,
+ connection=connection,
+ ctx=RequestContext(user=UserIdentifier("acct", "alice"), role=Role.USER),
+ )
+ assert task.to_dict()["meta"]["request"]["args"] == {"model_name": "model-1"}
+ stored = await store.get(task.task_id, **owner)
+ assert stored["meta"]["request"]["args"] == {"model_name": "model-1"}
+
+ tracker = TaskTracker(store)
+ restored = await tracker.get(task.task_id, **owner)
+ listed = (await tracker.list_tasks(**owner))[0]
+ assert restored.to_dict() == listed.to_dict() == task.to_dict()
+ auth = await tracker.get_task_auth(task.task_id, **owner)
+ assert auth["external_request_private"] == {
+ "args": {"user_key": "model-user-key", "api_key": "compile-api-key"}
+ }
+ external_task_id = await service.submit(
+ task.task_id,
+ restored.meta["request"],
+ auth["external_request_private"],
+ auth["openviking_connection"],
)
status_snapshot = await service.get(
external_task_id,
@@ -410,7 +432,7 @@ async def test_compile_api_client_session_protocol_retry_and_cancellation(
]
assert all(request["method"] == "POST" for request in forwarded)
assert "X-Gateway-Token" not in forwarded[0]["headers"]
- assert forwarded[0]["headers"]["Idempotency-Key"] == "cmp_ov_1"
+ assert forwarded[0]["headers"]["Idempotency-Key"] == task.task_id
assert forwarded[0]["headers"]["X-API-Key"] == "active-user-key"
assert forwarded[0]["body"] == {
"task_type": "compile",
@@ -419,12 +441,18 @@ async def test_compile_api_client_session_protocol_retry_and_cancellation(
"to": "viking://resources/wiki",
"skill": "viking://agent/skills/wiki",
"instruction": "Keep supporting evidence.",
- "args": {"user_key": "model-user-key"},
+ "args": {
+ "model_name": "model-1",
+ "user_key": "model-user-key",
+ "api_key": "compile-api-key",
+ },
},
}
assert forwarded[1]["body"] == {"session_id": "ma-session-1"}
assert status_snapshot.meta == {"token_usage": {"total_tokens": 12}}
assert cancel_snapshot.status == "cancelled"
+ await tracker.complete(task.task_id, {"output": "wiki"}, **owner)
+ assert await tracker.get_task_auth(task.task_id, **owner) == {}
# Exercise the real task store, work index, consumer, and ACK lifecycle.
class QueueBackend:
@@ -517,7 +545,7 @@ async def test_compile_api_client_session_protocol_retry_and_cancellation(
return await tasks.create(
"compile",
resource_id="viking://resources/source",
- payload={**public_payload, "to": target},
+ payload={**restored.meta["request"], "to": target},
connection={"api_key": "active-user-key"},
ctx=RequestContext(user=UserIdentifier(account, user), role=Role.USER),
)
diff --git a/tests/test_task_tracker.py b/tests/test_task_tracker.py
index e8000aadd..4685527bd 100644
--- a/tests/test_task_tracker.py
+++ b/tests/test_task_tracker.py
@@ -467,8 +467,8 @@ async def test_public_serialization_skips_private_payloads(tracker: TaskTracker)
task = await tracker.create("session_commit", **_owner_kwargs())
task.auth = PrivatePayload()
task._extra_fields = PrivatePayload()
- task.meta = {"nested": [{"user_key": "secret", "values": [1]}]}
- task.result = {"nested": [{"user_key": "secret", "values": [2]}]}
+ task.meta = {"nested": [{"user_key": "secret", "api_key": "compile-key", "values": [1]}]}
+ task.result = {"nested": [{"user_key": "secret", "api_key": "compile-key", "values": [2]}]}
public = task.to_dict()
assert set(public) == {