mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-10-26 13:16:24 +00:00
* feat(authz): add plugin resource targets, provenance, action and management enforcement
PR1 of the extension-tool-authorization series
(docs/plans/2026-09-24-extension-tool-authorization-spec.md): plugin
authorization plumbing, no new author-facing declaration.
- `authz/plugin_targets.py` is the single encoder/validator for composite
targets (`namespace/part`), with one validating composer behind three
kind-checked constructors; invalid input raises instead of degrading.
- `authz/plugin_authz.py` is the harness decision layer (`plugin_action`,
`plugin_management`, plus the batch filters the page slice will consume):
disabled is a no-op, an explicit deny raises, and provider errors follow
`fail_closed` like the sandbox gate.
- `POST /api/plugins/{ns}/actions/{name}` decides `plugin_action:invoke`
after the action resolves and before the body is streamed.
- `deerflow_extension_api.auth` publishes `require_plugin_management` /
`arequire_plugin_management` with two `app.state` resolver keys; the
Gateway installs both. Contract version 0.2.3 -> 0.2.4.
- `tools/tool_provenance.py` records host-written plugin provenance for
display (assembly descriptor, Layer-2 context later); no decision reads a
label.
- Plugin providers use a `(config signature, loop key)` cache so a
loop-affine provider is never handed to another loop or to a sync caller.
- RBAC gains `plugin_actions` / `plugin_management` aliases;
`config_version` 47 -> 48 across the three mirrors.
Tests: new plugin target/provenance/action/management suites plus a
blocking-IO anchor whose offloads were reverted to prove red->green.
* fix(authz): decide plugin resources from the request's config snapshot
Review round 1 on PR #5842 (willem-bd).
P1 — the decision layer no longer reloads the configuration. The six
`authz/plugin_authz.py` functions take a required `app_config` snapshot (the
same request-scoped config the Gateway used to resolve the provider), and
`resolve_/aresolve_plugin_authorization` return it as a third element, so
`enabled`/`fail_closed` can never come from a second read that drifted from
the one that produced the provider. A snapshot the caller could not read at
all is *unavailable*, not disabled: it fails closed as
`authz.config_unavailable`. The Gateway's `_plugin_app_config` now separates
an absent `config.yaml` (no gate, today's behavior) from a config that exists
but cannot be read or validated (deny) instead of swallowing both through
`safe_app_config`.
P2 — `_validated_decision` requires `type(decision.allow) is bool` on both
the sync `authorize` and async `aauthorize` paths, so a provider returning
`AuthzDecision(allow="false")` is a malformed verdict that follows
`fail_closed` instead of being read as an allow.
Both fixes are covered by regression tests that were verified red against the
pre-fix behavior (P1: 200 vs 403 and resolver True vs False; P2: 12 cases
across fail_closed/fail_open and sync/async), plus tests pinning that an
absent config and `authorization.enabled: false` keep today's behavior.
* fix(authz): treat a request-time config absence as unavailable
Review round 2 on PR #5842 (willem-bd).
P1 — `_plugin_app_config[_async]` no longer maps a missing `config.yaml` to
`None` ("no gate"). A Gateway cannot have started without a readable config
(`app/gateway/app.py` reads it through this same accessor in `lifespan`), so
absence *during a request* means the configuration this process was running on
became unavailable — a hot reload, an atomic replace, a ConfigMap remount. It is
unavailable, not disabled: the error propagates,
`resolve_/aresolve_plugin_authorization` raise
`_PluginAuthorizationUnavailable(fail_closed=True)`, the action dispatcher
returns 403 and the management resolvers answer `False`. The dead
`(None, None, None)` allow path is gone, the resolvers return a non-optional
`AppConfig` as their third element, and callers key "authorization disabled" on
`provider is None` alone. This matches the rule the decision layer already
documented (`authz.config_unavailable`) and the public docs.
P2 — `_deny_reason_code` is total: a `reasons` that is not iterable degrades the
code to `authz.denied` instead of raising `TypeError` outside the guarded
provider path, which turned a denial into an unhandled error. It is deliberately
not folded into `_validated_decision`: `allow` was a real `bool`, so the verdict
is a valid denial, and treating it as malformed would flip it to an allow under
`fail_closed: false`.
Both fixes are covered by regression tests verified red against the pre-fix
behavior (P1: resolver True vs False, async `PermissionError` not raised, route
200 vs 403; P2: `TypeError: 'NoneType' object is not iterable` at
`plugin_authz.py:113`). The action-route tests in
`tests/test_plugin_contributions.py` now install a readable
`authorization.enabled: false` config instead of relying on a config-less
process, and `docs/full-stack-plugins.md` plus the PR1 decision log record the
new rule.
* fix(authz): apply the running policy when the plugin config is unreadable
Follow-up to f03d2ea9 (review round 2 on PR #5842, willem-bd).
The first attempt read the P1 finding as "absence is never disabled" and failed
every config read closed unconditionally. That is too broad for this repo: a
config-less host is deliberately treated as having no policy to apply
(`_get_route_authorization_config` falls back to a disabled config,
`sandbox_authz.safe_app_config` documents the same no-op for "CI runners and
direct-call tests"), and the rule turned the config-less e2e plugin host
(`extension_test_fixtures.bookmark_plugin_gateway`) into a 403 — the three
`bookmark-plugin.spec.ts` cases lost the save action. Reproduced locally:
`POST /api/plugins/community.bookmarks/actions/save` against that fixture host
returned 403 before, 200 after this change.
The rule is now "has this process loaded a configuration?", not "was the last
read successful?":
- No loaded config (`peek_loaded_app_config()`, new read-only accessor on
`deerflow.config.app_config`) and no `config.yaml`: no policy to apply, so the
gate stays a no-op — unchanged for CI runners, direct-call tests and hosts
that mount only the plugins router.
- A loaded config whose file disappears or cannot be read: *unavailable*, never
*disabled*. The resolvers raise `_PluginAuthorizationUnavailable` carrying the
failure flag of the configuration this process runs on (authorization
disabled there -> no gate; enabled -> that policy's `fail_closed`, `True` by
default), so an enabled Gateway answers 403/False in the window instead of
letting protected plugin actions and management routes through.
- A config file that exists but cannot be read or validated right now: fail
closed when nothing is loaded (round 1's rule), otherwise the loaded policy
decides.
`peek_loaded_app_config()` is preferred over a Gateway-side startup snapshot: it
reflects the last successfully loaded config, so a hot-reloaded policy is what
applies during the window, and there is no lifecycle hook to keep in sync.
Evidence: the three no-config/lost-config branches in
`tests/test_plugin_management_guard.py` and
`tests/test_plugin_action_authorization.py`, round 1's unreadable-config tests
unchanged, `test_peek_loaded_app_config_survives_a_missing_file` in
`tests/test_app_config_reload.py`, and the fixture-host probe above. Docs
(`docs/full-stack-plugins.md`, `reference.mdx` en/zh) and the PR1 decision log
state the final rule; the log records the superseded variant.
* fix(authz): keep a denial whose reasons raise while being read
* fix(authz): intersect plugin batch filters with the candidates
The plugin_page/plugin_management batch helpers returned the provider's
`filter_resources` answer verbatim, so a custom provider could hand the
projections a target that was never asked about ("*", another namespace,
a phantom page). Every other filter call site re-projects from its own
candidate list; do the same here, state the intersection on the provider
contract, and pin it with a regression test that fails on the old
pass-through.
* docs(plugins): map a management denial to 403 in the route example
The contributed-route example called `arequire_plugin_management` and let
the documented `PermissionError` escape. The Gateway installs no
`PermissionError` handler, so a route copied from the example answered 500
on a normal policy denial instead of 403. Both example routes now translate
the denial, and the surrounding bullets say why the translation is the
route's job.
* docs(extensions): point the 0.2.4 contract row at the PR that ships it
Every other row in the version-history table links the pull request that
shipped the version; 0.2.4 linked the authorization tracking issue instead.
Both the English and Chinese tables now link this PR.
145 lines
6.4 KiB
Python
145 lines
6.4 KiB
Python
"""Exercise actual LangGraph tool dispatch, not just manifest serialization."""
|
|
|
|
import json
|
|
from dataclasses import replace
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
from deerflow_extension_api.plugins import ModelTool, PluginContribution
|
|
from langchain_core.messages import AIMessage
|
|
from langgraph.graph import END, START, MessagesState, StateGraph
|
|
from langgraph.prebuilt import ToolNode
|
|
|
|
from deerflow.extensions.plugin_tools import build_plugin_tools
|
|
from deerflow.extensions.registry import ExtensionRegistry
|
|
|
|
|
|
@pytest.fixture
|
|
def installed():
|
|
calls = []
|
|
|
|
async def search(payload, context):
|
|
calls.append(context)
|
|
return {"query": payload["query"], "user": context.principal.user_id}
|
|
|
|
plugin = PluginContribution(
|
|
namespace="community.search",
|
|
title="Search",
|
|
enabled=True,
|
|
tools=(ModelTool("search", "Search selected documents", {"type": "object", "properties": {"query": {"type": "string"}}, "required": ["query"], "additionalProperties": False}, search),),
|
|
)
|
|
registry = ExtensionRegistry()
|
|
with registry.attributed_to("test"):
|
|
registry.plugin(plugin)
|
|
return registry.build(), plugin, calls
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_real_tool_node_binds_identity_and_deployment_policy(installed):
|
|
loaded, plugin, calls = installed
|
|
(tool,) = build_plugin_tools(loaded)
|
|
assert "runtime" not in json.dumps(tool.tool_call_schema)
|
|
graph = StateGraph(MessagesState)
|
|
graph.add_node("tools", ToolNode([tool]))
|
|
graph.add_edge(START, "tools")
|
|
graph.add_edge("tools", END)
|
|
agent = graph.compile()
|
|
|
|
async def invoke(args):
|
|
return (
|
|
await agent.ainvoke(
|
|
{"messages": [AIMessage(content="", tool_calls=[{"id": "c", "name": tool.name, "args": args}])]},
|
|
context={"user_id": "trusted-user", "thread_id": "thread-a"},
|
|
)
|
|
)["messages"][-1]
|
|
|
|
result = await invoke({"query": "hello"})
|
|
assert json.loads(result.content) == {"query": "hello", "user": "trusted-user"}
|
|
assert calls[0].thread_id == "thread-a"
|
|
with pytest.raises(TypeError):
|
|
calls[0].settings["enabled"] = False
|
|
assert (await invoke({"query": "x", "user_id": "victim"})).status == "error"
|
|
assert len(calls) == 1
|
|
registry = ExtensionRegistry()
|
|
with registry.attributed_to("test"):
|
|
registry.plugin(replace(plugin, enabled=False))
|
|
assert build_plugin_tools(registry.build()) == []
|
|
|
|
|
|
def test_registration_rejects_invalid_schema_without_partial_install(installed):
|
|
_, plugin, _ = installed
|
|
registry = ExtensionRegistry()
|
|
with registry.attributed_to("test"):
|
|
for schema in ({"type": "string"}, {"type": "object", "$ref": "https://example.test/schema"}, {"type": "object", "properties": {"runtime": {"type": "string"}}}):
|
|
with pytest.raises(ValueError):
|
|
registry.plugin(replace(plugin, tools=(replace(plugin.tools[0], input_schema=schema),)))
|
|
assert not registry.build().plugins
|
|
|
|
|
|
def test_group_filter_and_name_collision_fail_closed(installed):
|
|
loaded, _, _ = installed
|
|
assert build_plugin_tools(loaded, groups=["web"]) == []
|
|
(tool,) = build_plugin_tools(loaded, groups=["extensions"])
|
|
with pytest.raises(ValueError, match="collision"):
|
|
build_plugin_tools(loaded, reserved_names={tool.name})
|
|
|
|
|
|
def test_built_tools_carry_host_recorded_plugin_provenance(installed):
|
|
"""The tag is written at construction, from registry-validated values."""
|
|
from deerflow.tools.tool_provenance import get_plugin_source, is_plugin_tool, resolve_tool_provenance
|
|
|
|
loaded, plugin, _ = installed
|
|
(tool,) = build_plugin_tools(loaded)
|
|
|
|
assert is_plugin_tool(tool) is True
|
|
assert get_plugin_source(tool) == {
|
|
"namespace": plugin.namespace,
|
|
"declaration": "search",
|
|
"installation": "test",
|
|
}
|
|
provenance = resolve_tool_provenance(tool)
|
|
assert provenance is not None
|
|
assert provenance.source == f"plugin:{plugin.namespace}"
|
|
assert provenance.declaration == "search"
|
|
|
|
|
|
@pytest.mark.parametrize("source", ["config", "builtin", "mcp", "acp"])
|
|
def test_assembly_keeps_ordinary_and_unaffected_plugin_tools_on_collision(installed, monkeypatch, caplog, source):
|
|
from langchain_core.tools import Tool
|
|
|
|
from deerflow.config.extensions_config import ExtensionsConfig
|
|
from deerflow.extensions.plugin_tools import plugin_tool_name
|
|
from deerflow.tools import tools as assembly
|
|
|
|
loaded, plugin, _ = installed
|
|
name = plugin_tool_name(plugin.namespace, "search")
|
|
ordinary = Tool(name=name, description="Ordinary tool", func=lambda query: "ordinary result")
|
|
healthy = replace(plugin, namespace="community.healthy")
|
|
registry = ExtensionRegistry()
|
|
with registry.attributed_to("test"):
|
|
registry.plugin(plugin)
|
|
registry.plugin(healthy)
|
|
config = SimpleNamespace(
|
|
tools=[SimpleNamespace(name=name, use="test:ordinary", group="extensions")] if source == "config" else [],
|
|
models=[],
|
|
acp_agents={"test": {}} if source == "acp" else {},
|
|
)
|
|
monkeypatch.setattr(assembly, "BUILTIN_TOOLS", [ordinary] if source == "builtin" else [])
|
|
monkeypatch.setattr(assembly, "is_mcp_task_runtime_available", lambda: False)
|
|
monkeypatch.setattr(assembly, "is_host_bash_allowed", lambda config: False)
|
|
monkeypatch.setattr(assembly, "resolve_variable", lambda *args: ordinary)
|
|
monkeypatch.setattr(ExtensionsConfig, "from_file", lambda: SimpleNamespace(get_enabled_mcp_servers=lambda: {"test": {}}))
|
|
monkeypatch.setattr("deerflow.mcp.cache.get_cached_mcp_tools", lambda: [ordinary])
|
|
monkeypatch.setattr("deerflow.tools.builtins.invoke_acp_agent_tool.build_invoke_acp_agent_tool", lambda agents: ordinary)
|
|
|
|
result = assembly.get_available_tools(app_config=config, extensions=registry.build(), include_mcp=source == "mcp", include_upload_tool=False)
|
|
assert [tool.name for tool in result] == [name, plugin_tool_name(healthy.namespace, "search")]
|
|
assert result[0] is ordinary
|
|
assert result[0].invoke("hello") == "ordinary result"
|
|
assert "Duplicate tool name" in caplog.text
|
|
|
|
# A host collision must not weaken the strict plugin-vs-plugin check.
|
|
duplicate_snapshot = replace(loaded, plugins=loaded.plugins + loaded.plugins)
|
|
with pytest.raises(ValueError, match="collision"):
|
|
assembly.get_available_tools(app_config=config, extensions=duplicate_snapshot, include_mcp=False, include_upload_tool=False)
|