Files
openclaw/src/plugins/registry.ts
clawsweeper[bot] 0603c2327d fix(file-transfer): require canonical node policy authorization (#74742)
* feat(file-transfer): add bundled plugin for binary file ops on nodes

New extensions/file-transfer/ plugin exposing four agent tools
(file_fetch, dir_list, dir_fetch, file_write) and four matching
node-host commands (file.fetch, dir.list, dir.fetch, file.write).
Lets agents read and write files on paired nodes by absolute path,
bypassing the bash output cap (200KB) and the live tool-result
text cap that would otherwise truncate base64 payloads.

Public surface
--------------
- file_fetch({ node, path, maxBytes? })
  Image MIMEs return image content blocks; small text (<=8 KB) inlines
  as text content; everything else returns a saved-media-path text
  block. sha256-verified end-to-end.
- dir_list({ node, path, pageToken?, maxEntries? })
  Structured directory listing — name, path, size, mimeType, isDir,
  mtime. Paginated. No content transfer.
- dir_fetch({ node, path, maxBytes?, includeDotfiles? })
  Server-side tar -czf streamed back, unpacked into the gateway media
  store, returns a manifest of saved paths. Single round-trip.
  60s wall-clock timeouts on tar create/unpack. tar -xzf without -P
  rejects absolute paths in archive entries.
- file_write({ node, path, contentBase64, mimeType?, overwrite?,
              createParents? })
  Atomic write (temp + rename). Refuses to overwrite by default.
  Refuses to write through symlinks (lstat check). Buffer-side
  sha256 (no read-back race). Pair with file_fetch to round-trip
  files between nodes — DO NOT use exec/cp for file copies.

All four commands gated by:
  - dangerous-by-default node command policy
    (gateway.nodes.allowCommands opt-in)
  - per-node path policy (gateway.nodes.fileTransfer)
  - optional operator approval prompt (ask: off | on-miss | always)

16 MB raw byte ceiling per single-frame round-trip (25 MB WS frame
with ~33% base64 overhead and JSON envelope). 8 MB defaults.

Path policy and approvals
-------------------------
Default behavior is DENY. The operator must explicitly opt in:

  {
    "gateway": {
      "nodes": {
        "fileTransfer": {
          "<nodeId-or-displayName>": {
            "ask":              "off" | "on-miss" | "always",
            "allowReadPaths":   ["~/Screenshots/**", "/tmp/**"],
            "allowWritePaths":  ["~/Downloads/**"],
            "denyPaths":        ["**/.ssh/**", "**/.aws/**"],
            "maxBytes":         16777216
          },
          "*": { "ask": "on-miss" }
        }
      }
    }
  }

ask modes:
  off       — silent: allow if matched, deny if not (default)
  on-miss   — silent allow if matched; prompt on miss
  always    — prompt every call (denyPaths still hard-deny)

denyPaths always wins. allow-always from the prompt persists the
exact path back into allowReadPaths/allowWritePaths via
mutateConfigFile so subsequent matching calls go silent.

Reuses existing primitives — no new gateway methods:
  plugin.approval.request / plugin.approval.waitDecision
  decision: allow-once | allow-always | deny

Pre-flight against requested path AND post-flight against the
canonicalPath returned by the node — closes symlink-escape attacks
where the requested path matched policy but realpath resolves
somewhere else.

Audit log
---------
JSONL at ~/.openclaw/audit/file-transfer.jsonl. Records every
decision (allow/allowed-once/allowed-always/denied/error) with
timestamp, op, nodeId, displayName, requestedPath, canonicalPath,
decision, error code, sizeBytes, sha256, durationMs. Best-effort
writes; never propagates failure.

Plugin layout
-------------
extensions/file-transfer/
  index.ts                       definePluginEntry, nodeHostCommands
  openclaw.plugin.json           contracts.tools registration
  package.json
  src/node-host/{file-fetch,dir-list,dir-fetch,file-write}.ts
  src/tools/{file-fetch,dir-list,dir-fetch,file-write}-tool.ts
  src/shared/
    mime.ts        single-source extension->MIME map + image/text sets
    errors.ts      shared error code enum and helpers
    params.ts      shared param-validation helpers + GatewayCallOptions
    policy.ts      evaluateFilePolicy, persistAllowAlways
    approval.ts    plugin.approval.request wrapper
    gatekeep.ts    one-stop policy + approval + audit orchestrator
    audit.ts       JSONL audit sink

Core touch points
-----------------
- src/infra/node-commands.ts: NODE_FILE_FETCH_COMMAND,
  NODE_DIR_LIST_COMMAND, NODE_DIR_FETCH_COMMAND,
  NODE_FILE_WRITE_COMMAND, NODE_FILE_COMMANDS array
- src/gateway/node-command-policy.ts: all four added to
  DEFAULT_DANGEROUS_NODE_COMMANDS
- src/security/audit-extra.sync.ts: audit detail mentions file ops
- src/agents/tools/nodes-tool-media.ts: MEDIA_INVOKE_ACTIONS entry
  for file.fetch redirects raw nodes(action=invoke) callers to the
  dedicated file_fetch tool to prevent base64 context bloat
- src/agents/tools/nodes-tool.ts: nodes tool description points to
  the dedicated file_fetch tool

Known limitations / follow-ups
------------------------------
- No tests in this PR. For a security-sensitive surface this is a
  gap; will follow up with a test pass.
- Direct CLI invocation (openclaw nodes invoke --command file.fetch)
  bypasses the plugin policy entirely. Plugin-side gating is the
  realistic threat model (agent on iMessage requesting paths it
  shouldn't), but for true defense-in-depth, policy belongs in the
  gateway-side node.invoke dispatch. Move-policy-to-core is a
  separate PR.
- file_watch (long-lived filesystem event subscription) is not
  included; it needs a new node-protocol primitive for streaming
  event channels and was descoped from this PR.
- dir_fetch includeDotfiles: true is the only supported mode;
  BSD tar exclude patterns reliably collapse dotfile filtering
  to an empty archive. Reliable filtering needs a
  `find ! -name ".*" | tar -T -` pipeline; deferred.
- dir_fetch du -sk preflight is a heuristic (du * 4 vs maxBytes);
  the mid-stream byte cap is the actual safety net.

* test(file-transfer): add unit tests for handlers, policy, and shared utilities

Adds 77 tests covering:
- handleFileFetch: validation, fs errors, sha256, size cap, symlink canonicalization
- handleFileWrite: validation, atomic write, overwrite policy, parent dir handling, symlink refusal, integrity check, size cap
- handleDirList: validation, fs errors, sorted listing, dotfile inclusion, pagination
- handleDirFetch: validation, fs errors, gzipped tar with sha256, mid-stream byte cap
- evaluateFilePolicy: default-deny, denyPaths-wins, allow matching, ask modes (off/on-miss/always), node-id/displayName/'*' resolution
- persistAllowAlways: append, dedupe, create-on-missing
- shared/mime: extension lookup, image/text inline sets
- shared/errors: err helper, classifyFsError, throwFromNodePayload

Also fixes accumulated lint regressions in the prod source flagged once these
files moved into the changed-gate scope (parseInt -> Number.parseInt, redundant
type casts removed, single-statement if bodies wrapped in braces).

* fix(file-transfer): address PR review feedback (security + availability)

Reviewer findings addressed (greptile + aisle):

- policy: persistAllowAlways no longer escalates per-node approvals to the
  '*' wildcard entry; allow-always now writes under the specific node's
  own entry, never the wildcard (greptile P1 SECURITY).
- policy: add literal '..' segment short-circuit in evaluateFilePolicy,
  raised before glob match. Stops "/allowed/../etc/passwd" from passing
  preflight against "/allowed/**" globs (aisle MEDIUM CWE-22).
- file-write: replace no-op base64 try/catch with actual round-trip
  validation. Buffer.from(s, "base64") never throws — invalid input
  silently decoded to garbage bytes. Now re-encodes and compares
  modulo padding/url-variant chars (greptile P1 SECURITY).
- file-write: document the parent-symlink residual risk and rely on the
  existing gateway-side post-flight policy check; full rollback requires
  a node-side file.unlink which is deferred to a follow-up. Initial
  segment-walk attempt was reverted because it false-positives on system
  symlinks like macOS /var → /private/var (aisle HIGH CWE-59).
- dir-fetch tool: add preValidateTarball pass that runs `tar -tzvf` and
  rejects symlinks, hardlinks, absolute paths, '..' traversal,
  uncompressed sizes >64MB, and entry counts >5000 — before any
  extraction. Drops --no-overwrite-dir (GNU-only flag rejected by BSD
  tar on macOS) (aisle HIGH x2 CWE-22 + CWE-409, greptile P2).
- dir-fetch tool: stream-hash files via fs.open + read loop instead of
  fs.readFile to avoid full-buffer reads on large extracted entries.
- dir-fetch handler: replace spawnSync in countTarEntries with async
  spawn + bounded buffer so tar -tzf can't park the node-host event
  loop for up to 10s on a slow filesystem (greptile P1 AVAIL).
- audit: clear auditDirPromise on rejection so a transient mkdir
  failure doesn't permanently silence the audit log (greptile P2).

New tests: wildcard escalation rejection, base64 malformed/url-variant,
'..' traversal short-circuit (3 cases). 84/84 passing.

* fix(file-transfer): CI failures + second-round PR review feedback

CI failures on previous push:

- Declare runtime deps (minimatch, typebox) in package.json — failed the
  extension-runtime-dependencies contract test that scans imports.
- Switch policy.ts and policy.test.ts off the broad
  openclaw/plugin-sdk/config-runtime barrel and onto the narrow
  openclaw/plugin-sdk/config-mutation + runtime-config-snapshot subpaths.
  This satisfies the deprecated-internal-config-api architecture guard.

Second-round Aisle findings:

- policy: traversal-segment check now treats backslash and forward slash
  as equivalent, so a Windows node can't be hit with mixed-separator
  "C:\\allowed\\..\\Windows\\system.ini" (Aisle HIGH CWE-22).
- dir-fetch tool: replace the single fragile `tar -tvzf` parser pass
  (which broke for filenames containing whitespace) with two robust
  passes: `tar -tzf` for paths only (one per line, no parsing of
  fixed columns) and `tar -tzvf` for type chars only (FIRST CHAR of each
  line, never the path column). Also reject backslash-containing entry
  names. Drops the in-process uncompressed-size cap because reliably
  parsing sizes from tar output is fragile and Aisle flagged it as a
  bypass primitive — entry-count cap stays (Aisle HIGH CWE-22, MED).

Tests still 84/84 passing.

* fix(file-transfer): third-round PR review feedback

Aisle's re-analysis on b63daa6a05 surfaced 3 actionable findings:

- nodes.invoke bypass (HIGH CWE-285): generic nodes.action="invoke" let
  agents call dir.list/dir.fetch/file.write directly, skipping the
  file-transfer plugin's gatekeep + policy + approval flow. Only file.fetch
  was redirected to its dedicated tool. Add the other three to
  MEDIA_INVOKE_ACTIONS so the redirect-or-deny logic in
  nodes-tool-commands fires for all four. The dedicated tools enforce
  policy; the generic invoke surface no longer has a way to skip them
  without an explicit allowMediaInvokeCommands opt-in.
- prototype pollution in persistAllowAlways (MED CWE-1321): a paired
  node with displayName "__proto__" / "prototype" / "constructor" would
  mutate the fileTransfer object's prototype when persisting allow-always.
  Reject those keys explicitly. Switch the existing-key lookup to
  Object.prototype.hasOwnProperty.call so a key like "constructor"
  doesn't accidentally match Object.prototype.constructor.
- decompression-bomb cap in dir_fetch (MED CWE-409): compressed tar is
  bounded upstream, but a highly compressible bomb can still expand to
  gigabytes. Enforce DIR_FETCH_MAX_UNCOMPRESSED_BYTES (64MB) summed
  across extracted files and DIR_FETCH_MAX_SINGLE_FILE_BYTES (16MB) per
  entry, both checked during the post-extract walk. On bust, rm -rf the
  rootDir and audit-log + throw UNCOMPRESSED_TOO_LARGE.

Tests: 85/85 passing (added prototype-pollution rejection test).

Aisle's HIGH parent-symlink finding remains documented as deferred — full
rollback requires a node-side file.unlink command which is out of scope
for this PR. The gateway-side post-flight policy check still detects and
loudly errors on canonical-path mismatches.

* fix(file-transfer): refuse symlink traversal by default with followSymlinks opt-in

Closes the deferred Aisle HIGH parent-symlink finding. Instead of
detecting the escape in a post-flight gateway check after the file is
already written, the node-side handler now refuses pre-flight if any
component of the requested path resolves through a symlink.

Behavior:
- Reads (file.fetch / dir.list / dir.fetch): node realpath()s the
  requested path. If canonical != requested AND followSymlinks=false,
  return SYMLINK_REDIRECT { canonicalPath } — no I/O happens.
- Writes (file.write): node realpath()s the parent dir. Same refusal
  rule. The lstat-on-final check is kept to catch the case where the
  target file itself is an existing symlink.
- Opt-in: set gateway.nodes.fileTransfer.<node>.followSymlinks=true to
  bring back the previous "follow + post-flight check" behavior.

Operator UX: the SYMLINK_REDIRECT response includes the canonical path
so the operator can either update their allow list to the canonical form
or set followSymlinks=true on that node. On macOS, /var → /private/var
and /tmp → /private/tmp are system aliases that trip the new check, so
operators using those paths need followSymlinks=true OR canonical-path
allowlists.

Wiring:
- Add followSymlinks?: boolean to NodeFilePolicyConfig.
- evaluateFilePolicy returns followSymlinks (default false) on its
  ok=true branches.
- gatekeep propagates it via GatekeepOutcome.
- Each tool passes it as a node.invoke param.
- Each handler honors it pre-flight before any read/write.

Tests updated: 89/89 passing.
- realpath(mkdtemp()) so existing happy-path tests don't trip the new
  default on macOS where mkdtemp lands under symlinked /var/folders.
- New tests: SYMLINK_REDIRECT refusal for file.fetch and file.write
  parent traversal; opt-in passthrough when followSymlinks=true.
- New policy test: followSymlinks propagation default false / true.

* fix(file-transfer): close two more aisle findings on 069bd66

Aisle re-analysis on 069bd66 surfaced two issues my earlier round-three
fix missed:

- HIGH (CWE-284): file.fetch / dir.fetch / dir.list / file.write were
  still bypassable via the generic nodes.action="invoke" surface when
  the operator had set allowMediaInvokeCommands=true. That flag was
  meant to opt in to base64-bloat for camera/screen, not to disable
  path policy on file-transfer. Split the redirect map: introduce
  POLICY_REDIRECT_INVOKE_COMMANDS (file-transfer only) which ALWAYS
  rerouts to its dedicated tool regardless of the bloat flag. Camera
  and screen continue to use the bloat-only redirect (suppressed by
  allowMediaInvokeCommands=true). Confirmed by clawsweeper P1.
- MED (CWE-276): tar -xzf in dir_fetch unpack preserved archive
  ownership and permissions, so a malicious node could plant
  setuid/setgid or world-writable files on a gateway running with
  elevated privileges. Add --no-same-owner --no-same-permissions
  (both flags are portable across BSD tar / GNU tar).

Tests: 89/89 passing.

* chore(file-transfer): drop file_watch from plugin description

Phase 5 (file_watch) was deferred earlier in this PR. Strip the watch
mention from the plugin description in package.json,
openclaw.plugin.json, and index.ts so the metadata reflects what's
actually shipped (file_fetch, dir_list, dir_fetch, file_write).
Closes clawsweeper P3.

* fix(file-transfer): hash before rename and allow zero-byte round-trip

Two of Peter's review findings on PR #74134:

- P2 (file-write integrity): hash the decoded buffer + compare against
  expectedSha256 BEFORE temp+rename. Previously the rename happened
  first, then the sha check unlinked the target on mismatch — with
  overwrite=true a bad caller hash could replace + delete the original.
  Now a hash mismatch returns INTEGRITY_FAILURE without touching disk.
  Added a regression test that asserts the original file survives.

- P2/P3 (zero-byte round-trip): the tool layer's truthy checks on
  contentBase64 and base64 rejected the empty string, blocking zero-byte
  files from round-tripping through file_fetch -> file_write. Switched
  to type-checks (typeof === "string") and added zero-byte tests at the
  handler layer for both fetch and write (sha matches the known empty
  digest).

Tests: 92/92 passing.

* fix(file-transfer): declare gateway.nodes.fileTransfer in core config schema

Peter's P1/P2 finding: the plugin reads/writes gateway.nodes.fileTransfer
via casts through unknown because the strict zod schema and OpenClawConfig
type didn't declare it. That meant `openclaw config validate` would
reject the very examples in the plugin's own documentation.

- Add fileTransfer block to gateway.nodes in src/config/zod-schema.ts
  with the full per-node entry shape (ask, allowReadPaths,
  allowWritePaths, denyPaths, maxBytes, followSymlinks).
- Add GatewayNodeFileTransferEntry + the fileTransfer field on
  GatewayNodesConfig in src/config/types.gateway.ts.
- Drop the `as unknown` casts in the extension's policy.ts now that
  gateway.nodes.fileTransfer is properly typed end-to-end.
- Regenerate docs/.generated/config-baseline.sha256.

Tests: 92/92 passing. pnpm config:docs:check OK.

* fix(file-transfer): enforce path policy at gateway dispatch

Closes Peter's P1 review finding on PR #74134.

The agent-tool-only redirect added in earlier commits left CLI
(`openclaw nodes invoke`), plugin-runtime, and raw `node.invoke` callers
able to skip the file-transfer path policy entirely. The fix moves the
security boundary down to the gateway: every code path that reaches
`node.invoke` for file.fetch / dir.list / dir.fetch / file.write now
runs the same allow/deny check.

- New: src/gateway/file-transfer-dispatch.ts with
  `evaluateFileTransferDispatchPolicy` and `isFileTransferCommand`. Same
  semantics as the extension-side `evaluateFilePolicy` minus the
  operator-prompt flow (prompts stay at the agent-tool layer; the
  gateway is silent enforcement).
- src/gateway/server-methods/nodes.ts: after the existing command
  allowlist check, run the new gate before forwarding. Denies emit
  INVALID_REQUEST with a structured `{ command, code, reason }`.
- Decision matrix mirrors the extension: NO_POLICY (no entry for
  this node) deny, denyPaths-wins, '..' traversal short-circuit
  (with backslash separator handling), allowPaths match → allow,
  no allow match → deny.
- 19 new unit tests covering each branch including identity
  resolution (nodeId/displayName/'*'), prototype-pollution-safe lookup,
  and read-vs-write allow-list separation.

Note on allow-once approvals: the agent tool's interactive
`allow-once` decision now has to flow through the dedicated tool's
pre-flight (which forwards an approved request); raw `nodes.invoke`
callers cannot benefit from one-time approvals because the gateway is
silent. allow-always (which persists to allowReadPaths/allowWritePaths)
continues to work transparently because by the time the next request
hits the gateway the path is in the persisted allow list.

Tests: 92 extension + 19 gateway = 111 total, all passing.

* fix(file-transfer): enforce node policy in gateway

* fix(file-transfer): use plugin node policy only

* fix(file-transfer): harden node policy edge cases

* fix(file-transfer): close review hardening gaps

* fix(file-transfer): harden node invoke policy

* fix(file-transfer): align runtime dependency versions

* fix(file-transfer): keep minimatch extension-owned

* refactor(file-transfer): remove unused approval gate

* fix(file-transfer): require canonical node policy authorization

Co-authored-by: Omar Shahine <10343873+omarshahine@users.noreply.github.com>

* fix(clawsweeper): address review for automerge-openclaw-openclaw-74134 (1)

Co-authored-by: Omar Shahine <10343873+omarshahine@users.noreply.github.com>

* fix(file-transfer): recheck dir fetch archive policy after fetch

* fix(file-transfer): name file-transfer tool in invoke redirect

---------

Co-authored-by: Omar Shahine <10343873+omarshahine@users.noreply.github.com>
Co-authored-by: Peter Steinberger <steipete@gmail.com>
Co-authored-by: clawsweeper-repair <clawsweeper-repair@users.noreply.github.com>
2026-04-30 04:03:40 +00:00

2516 lines
86 KiB
TypeScript

import path from "node:path";
import {
getRegisteredAgentHarness,
registerAgentHarness as registerGlobalAgentHarness,
} from "../agents/harness/registry.js";
import type { AgentHarness } from "../agents/harness/types.js";
import type { AnyAgentTool } from "../agents/tools/common.js";
import type { ChannelPlugin } from "../channels/plugins/types.plugin.js";
import {
normalizeCommandDescriptorName,
sanitizeCommandDescriptorDescription,
} from "../cli/program/command-descriptor-utils.js";
import type { OpenClawConfig } from "../config/types.openclaw.js";
import {
clearContextEnginesForOwner,
registerContextEngineForOwner,
} from "../context-engine/registry.js";
import { isOperatorScope, type OperatorScope } from "../gateway/operator-scopes.js";
import type { GatewayRequestHandler } from "../gateway/server-methods/types.js";
import { registerInternalHook, unregisterInternalHook } from "../hooks/internal-hooks.js";
import type { HookEntry } from "../hooks/types.js";
import {
NODE_EXEC_APPROVALS_COMMANDS,
NODE_SYSTEM_NOTIFY_COMMAND,
NODE_SYSTEM_RUN_COMMANDS,
} from "../infra/node-commands.js";
import {
createPluginStateKeyedStore,
type OpenKeyedStoreOptions,
type PluginStateKeyedStore,
} from "../plugin-state/plugin-state-store.js";
import { normalizePluginGatewayMethodScope } from "../shared/gateway-method-policy.js";
import { resolveGlobalSingleton } from "../shared/global-singleton.js";
import {
normalizeLowercaseStringOrEmpty,
normalizeOptionalString,
} from "../shared/string-coerce.js";
import {
getDetachedTaskLifecycleRuntimeRegistration,
registerDetachedTaskLifecycleRuntime,
} from "../tasks/detached-task-runtime-state.js";
import { resolveUserPath } from "../utils.js";
import type { AgentToolResultMiddleware } from "./agent-tool-result-middleware-types.js";
import {
normalizeAgentToolResultMiddlewareRuntimeIds,
normalizeAgentToolResultMiddlewareRuntimes,
} from "./agent-tool-result-middleware.js";
import { buildPluginApi } from "./api-builder.js";
import { normalizeRegisteredChannelPlugin } from "./channel-validation.js";
import { CODEX_APP_SERVER_EXTENSION_RUNTIME_ID } from "./codex-app-server-extension-factory.js";
import type { CodexAppServerExtensionFactory } from "./codex-app-server-extension-types.js";
import {
isReservedCommandName,
registerPluginCommand,
validatePluginCommandDefinition,
} from "./command-registration.js";
import { clearPluginCommandsForPlugin, pluginCommands } from "./command-registry-state.js";
import {
getRegisteredCompactionProvider,
registerCompactionProvider,
} from "./compaction-provider.js";
import {
clearPluginRunContext,
getPluginRunContext,
getPluginSessionSchedulerJobGeneration,
registerPluginSessionSchedulerJob,
setPluginRunContext,
} from "./host-hook-runtime.js";
import { enqueuePluginNextTurnInjection } from "./host-hook-state.js";
import {
isPluginJsonValue,
normalizePluginHostHookId,
type PluginAgentEventSubscriptionRegistration,
type PluginControlUiDescriptor,
type PluginRuntimeLifecycleRegistration,
type PluginSessionSchedulerJobRegistration,
type PluginSessionExtensionRegistration,
type PluginToolMetadataRegistration,
type PluginTrustedToolPolicyRegistration,
} from "./host-hooks.js";
import { normalizePluginHttpPath } from "./http-path.js";
import { findOverlappingPluginHttpRoute } from "./http-route-overlap.js";
import {
clearPluginInteractiveHandlersForPlugin,
registerPluginInteractiveHandler,
} from "./interactive-registry.js";
import type { PluginDiagnostic } from "./manifest-types.js";
import {
getRegisteredMemoryEmbeddingProvider,
registerMemoryEmbeddingProvider,
} from "./memory-embedding-providers.js";
import {
registerMemoryCapability,
registerMemoryCorpusSupplement,
registerMemoryFlushPlanResolver,
registerMemoryPromptSupplement,
registerMemoryPromptSection,
registerMemoryRuntime,
} from "./memory-state.js";
import { normalizeRegisteredProvider } from "./provider-validation.js";
import { createEmptyPluginRegistry } from "./registry-empty.js";
import type {
PluginCliBackendRegistration,
PluginCliRegistration,
PluginCommandRegistration,
PluginControlUiDescriptorRegistryRegistration,
PluginConversationBindingResolvedHandlerRegistration,
PluginHookRegistration,
PluginHttpRouteRegistration as RegistryTypesPluginHttpRouteRegistration,
PluginAgentHarnessRegistration,
PluginMemoryEmbeddingProviderRegistration,
PluginNodeHostCommandRegistration,
PluginProviderRegistration,
PluginRecord,
PluginRegistry,
PluginRegistryParams,
PluginReloadRegistration,
PluginRuntimeLifecycleRegistryRegistration,
PluginSecurityAuditCollectorRegistration,
PluginServiceRegistration,
PluginSessionExtensionRegistryRegistration,
PluginTextTransformsRegistration,
PluginToolMetadataRegistryRegistration,
PluginTrustedToolPolicyRegistryRegistration,
} from "./registry-types.js";
import { withPluginRuntimePluginIdScope } from "./runtime/gateway-request-scope.js";
import type { PluginRuntime } from "./runtime/types.js";
import { defaultSlotIdForKey, hasKind } from "./slots.js";
import {
isConversationHookName,
isPluginHookName,
isPromptInjectionHookName,
stripPromptMutationFieldsFromLegacyHookResult,
} from "./types.js";
import type {
CliBackendPlugin,
ImageGenerationProviderPlugin,
MusicGenerationProviderPlugin,
OpenClawPluginApi,
OpenClawPluginChannelRegistration,
OpenClawPluginCliCommandDescriptor,
OpenClawPluginCliRegistrar,
OpenClawPluginCommandDefinition,
PluginConversationBindingResolvedEvent,
OpenClawPluginGatewayRuntimeScopeSurface,
OpenClawGatewayDiscoveryService,
OpenClawPluginHttpRouteParams,
OpenClawPluginHookOptions,
OpenClawPluginNodeHostCommand,
OpenClawPluginNodeInvokePolicy,
OpenClawPluginReloadRegistration,
OpenClawPluginSecurityAuditCollector,
MediaUnderstandingProviderPlugin,
MigrationProviderPlugin,
OpenClawPluginService,
OpenClawPluginToolContext,
OpenClawPluginToolFactory,
PluginHookHandlerMap,
PluginHookName,
PluginHookRegistration as TypedPluginHookRegistration,
PluginLogger,
PluginRegistrationMode,
ProviderPlugin,
RealtimeTranscriptionProviderPlugin,
RealtimeVoiceProviderPlugin,
SpeechProviderPlugin,
VideoGenerationProviderPlugin,
WebFetchProviderPlugin,
WebSearchProviderPlugin,
} from "./types.js";
export type PluginHttpRouteRegistration = RegistryTypesPluginHttpRouteRegistration & {
gatewayRuntimeScopeSurface?: OpenClawPluginGatewayRuntimeScopeSurface;
};
type PluginOwnedProviderRegistration<T extends { id: string }> = {
pluginId: string;
pluginName?: string;
provider: T;
source: string;
rootDir?: string;
};
export type {
PluginChannelRegistration,
PluginChannelSetupRegistration,
PluginCliBackendRegistration,
PluginCliRegistration,
PluginCommandRegistration,
PluginConversationBindingResolvedHandlerRegistration,
PluginHookRegistration,
PluginAgentHarnessRegistration,
PluginMemoryEmbeddingProviderRegistration,
PluginNodeHostCommandRegistration,
PluginProviderRegistration,
PluginControlUiDescriptorRegistryRegistration,
PluginRuntimeLifecycleRegistryRegistration,
PluginRecord,
PluginRegistry,
PluginRegistryParams,
PluginReloadRegistration,
PluginSecurityAuditCollectorRegistration,
PluginServiceRegistration,
PluginSessionExtensionRegistryRegistration,
PluginTextTransformsRegistration,
PluginToolMetadataRegistryRegistration,
PluginTrustedToolPolicyRegistryRegistration,
PluginToolRegistration,
PluginSpeechProviderRegistration,
PluginRealtimeTranscriptionProviderRegistration,
PluginRealtimeVoiceProviderRegistration,
PluginMediaUnderstandingProviderRegistration,
PluginImageGenerationProviderRegistration,
PluginVideoGenerationProviderRegistration,
PluginMusicGenerationProviderRegistration,
PluginWebFetchProviderRegistration,
PluginWebSearchProviderRegistration,
} from "./registry-types.js";
type PluginTypedHookPolicy = {
allowPromptInjection?: boolean;
allowConversationAccess?: boolean;
};
const constrainLegacyPromptInjectionHook = (
handler: PluginHookHandlerMap["before_agent_start"],
): PluginHookHandlerMap["before_agent_start"] => {
return (event, ctx) => {
const result = handler(event, ctx);
if (result && typeof result === "object" && "then" in result) {
return Promise.resolve(result).then((resolved) =>
stripPromptMutationFieldsFromLegacyHookResult(resolved),
);
}
return stripPromptMutationFieldsFromLegacyHookResult(result);
};
};
export { createEmptyPluginRegistry } from "./registry-empty.js";
export function resolvePluginPath(input: string, rootDir: string | undefined): string {
const trimmed = input.trim();
if (!trimmed || path.isAbsolute(trimmed) || trimmed.startsWith("~")) {
return resolveUserPath(input);
}
return rootDir ? path.resolve(rootDir, trimmed) : resolveUserPath(input);
}
const ACTIVE_PLUGIN_HOOK_REGISTRATIONS_KEY = Symbol.for("openclaw.activePluginHookRegistrations");
const activePluginHookRegistrations = resolveGlobalSingleton<
Map<string, Array<{ event: string; handler: Parameters<typeof registerInternalHook>[1] }>>
>(ACTIVE_PLUGIN_HOOK_REGISTRATIONS_KEY, () => new Map());
type HookRegistration = { event: string; handler: Parameters<typeof registerInternalHook>[1] };
type HookRollbackEntry = { name: string; previousRegistrations: HookRegistration[] };
type PluginRegistrationCapabilities = {
/** Broad registry writes that discovery and live activation both need. */
capabilityHandlers: boolean;
/** Runtime channel registration is suppressed for setup-only metadata loads. */
runtimeChannel: boolean;
};
/**
* Keep mode decoding centralized. PluginRegistrationMode is the public label;
* registry code should consume these booleans instead of duplicating string
* checks across individual registration handlers.
*/
function resolvePluginRegistrationCapabilities(
mode: PluginRegistrationMode,
): PluginRegistrationCapabilities {
return {
capabilityHandlers: mode === "full" || mode === "discovery",
runtimeChannel: mode !== "setup-only",
};
}
export function createPluginRegistry(registryParams: PluginRegistryParams) {
const registry = createEmptyPluginRegistry();
const coreGatewayMethods = new Set([
...(registryParams.coreGatewayMethodNames ?? []),
...Object.keys(registryParams.coreGatewayHandlers ?? {}),
]);
const pluginHookRollback = new Map<string, HookRollbackEntry[]>();
const pluginsWithChannelRegistrationConflict = new Set<string>();
const pushDiagnostic = (diag: PluginDiagnostic) => {
registry.diagnostics.push(diag);
};
const throwRegistrationError = (message: string): never => {
throw new Error(message);
};
const requireRegistrationValue = (value: string | undefined, message: string): string => {
if (!value) {
throw new Error(message);
}
return value;
};
const registerCodexAppServerExtensionFactory = (
record: PluginRecord,
factory: Parameters<OpenClawPluginApi["registerCodexAppServerExtensionFactory"]>[0],
) => {
if (record.origin !== "bundled") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "only bundled plugins can register Codex app-server extension factories",
});
return;
}
if (
!(record.contracts?.embeddedExtensionFactories ?? []).includes(
CODEX_APP_SERVER_EXTENSION_RUNTIME_ID,
)
) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message:
'plugin must declare contracts.embeddedExtensionFactories: ["codex-app-server"] to register Codex app-server extension factories',
});
return;
}
if (typeof (factory as unknown) !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "codex app-server extension factory must be a function",
});
return;
}
if (
registry.codexAppServerExtensionFactories.some(
(entry) => entry.pluginId === record.id && entry.rawFactory === factory,
)
) {
return;
}
const safeFactory: CodexAppServerExtensionFactory = async (codex) => {
try {
await factory(codex);
} catch (error) {
const detail = error instanceof Error ? error.message : String(error);
registryParams.logger.warn(
`[plugins] codex app-server extension factory failed for ${record.id}: ${detail}`,
);
}
};
registry.codexAppServerExtensionFactories.push({
pluginId: record.id,
pluginName: record.name,
rawFactory: factory,
factory: safeFactory,
source: record.source,
rootDir: record.rootDir,
});
};
const registerAgentToolResultMiddleware = (
record: PluginRecord,
handler: Parameters<OpenClawPluginApi["registerAgentToolResultMiddleware"]>[0],
options: Parameters<OpenClawPluginApi["registerAgentToolResultMiddleware"]>[1],
) => {
if (record.origin !== "bundled") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "only bundled plugins can register agent tool result middleware",
});
return;
}
if (typeof (handler as unknown) !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "agent tool result middleware must be a function",
});
return;
}
const runtimes = normalizeAgentToolResultMiddlewareRuntimes(options);
if (runtimes.length === 0) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "agent tool result middleware must target at least one supported runtime",
});
return;
}
const declared = normalizeAgentToolResultMiddlewareRuntimeIds(
record.contracts?.agentToolResultMiddleware,
);
const missing = runtimes.filter((runtime) => !declared.includes(runtime));
if (missing.length > 0) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `plugin must declare contracts.agentToolResultMiddleware for: ${missing.join(", ")}`,
});
return;
}
const existing = registry.agentToolResultMiddlewares.find(
(entry) => entry.pluginId === record.id && entry.rawHandler === handler,
);
if (existing) {
existing.runtimes = [...new Set([...existing.runtimes, ...runtimes])];
return;
}
const safeHandler: AgentToolResultMiddleware = async (event, ctx) => {
try {
return await handler(event, ctx);
} catch (error) {
registryParams.logger.warn(
`[plugins] agent tool result middleware failed for ${record.id}`,
);
throw error;
}
};
registry.agentToolResultMiddlewares.push({
pluginId: record.id,
pluginName: record.name,
rawHandler: handler,
handler: safeHandler,
runtimes,
source: record.source,
rootDir: record.rootDir,
});
};
const registerTool = (
record: PluginRecord,
tool: AnyAgentTool | OpenClawPluginToolFactory,
opts?: { name?: string; names?: string[]; optional?: boolean },
) => {
if (pluginsWithChannelRegistrationConflict.has(record.id)) {
return;
}
const names = opts?.names ?? (opts?.name ? [opts.name] : []);
const optional = opts?.optional === true;
const factory: OpenClawPluginToolFactory =
typeof tool === "function" ? tool : (_ctx: OpenClawPluginToolContext) => tool;
if (typeof tool !== "function") {
names.push(tool.name);
}
const normalized = names.map((name) => name.trim()).filter(Boolean);
if (normalized.length > 0) {
record.toolNames.push(...normalized);
}
registry.tools.push({
pluginId: record.id,
pluginName: record.name,
factory,
names: normalized,
optional,
source: record.source,
rootDir: record.rootDir,
});
};
const registerHook = (
record: PluginRecord,
events: string | string[],
handler: Parameters<typeof registerInternalHook>[1],
opts: OpenClawPluginHookOptions | undefined,
config: OpenClawPluginApi["config"],
pluginConfig: unknown,
) => {
const eventList = Array.isArray(events) ? events : [events];
const normalizedEvents = eventList.map((event) => event.trim()).filter(Boolean);
const entry = opts?.entry ?? null;
const hookName = requireRegistrationValue(
entry?.hook.name ?? opts?.name?.trim(),
"hook registration missing name",
);
const existingHook = registry.hooks.find((entry) => entry.entry.hook.name === hookName);
if (existingHook) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `hook already registered: ${hookName} (${existingHook.pluginId})`,
});
return;
}
const description = entry?.hook.description ?? opts?.description ?? "";
const hookEntry: HookEntry = entry
? {
...entry,
hook: {
...entry.hook,
name: hookName,
description,
source: "openclaw-plugin",
pluginId: record.id,
},
metadata: {
...entry.metadata,
events: normalizedEvents,
},
}
: {
hook: {
name: hookName,
description,
source: "openclaw-plugin",
pluginId: record.id,
filePath: record.source,
baseDir: path.dirname(record.source),
handlerPath: record.source,
},
frontmatter: {},
metadata: { events: normalizedEvents },
invocation: { enabled: true },
};
record.hookNames.push(hookName);
registry.hooks.push({
pluginId: record.id,
entry: hookEntry,
events: normalizedEvents,
source: record.source,
});
const hookSystemEnabled = config?.hooks?.internal?.enabled !== false;
if (
!registryParams.activateGlobalSideEffects ||
!hookSystemEnabled ||
opts?.register === false
) {
return;
}
const previousRegistrations = activePluginHookRegistrations.get(hookName) ?? [];
for (const registration of previousRegistrations) {
unregisterInternalHook(registration.event, registration.handler);
}
const nextRegistrations: Array<{
event: string;
handler: Parameters<typeof registerInternalHook>[1];
}> = [];
for (const event of normalizedEvents) {
const wrappedHandler: typeof handler = async (evt) => {
// Shallow-copy to avoid mutating the shared event object
// passed to all handlers sequentially by triggerInternalHook
return handler({ ...evt, context: { ...evt.context, pluginConfig } });
};
registerInternalHook(event, wrappedHandler);
nextRegistrations.push({ event, handler: wrappedHandler });
}
activePluginHookRegistrations.set(hookName, nextRegistrations);
const rollbackEntries = pluginHookRollback.get(record.id) ?? [];
rollbackEntries.push({
name: hookName,
previousRegistrations: [...previousRegistrations],
});
pluginHookRollback.set(record.id, rollbackEntries);
};
const registerGatewayMethod = (
record: PluginRecord,
method: string,
handler: GatewayRequestHandler,
opts?: { scope?: OperatorScope },
) => {
const trimmed = method.trim();
if (!trimmed) {
return;
}
if (coreGatewayMethods.has(trimmed) || registry.gatewayHandlers[trimmed]) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `gateway method already registered: ${trimmed}`,
});
return;
}
registry.gatewayHandlers[trimmed] = handler;
const normalizedScope = normalizePluginGatewayMethodScope(trimmed, opts?.scope);
if (normalizedScope.coercedToReservedAdmin) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message: `gateway method scope coerced to operator.admin for reserved core namespace: ${trimmed}`,
});
}
const effectiveScope = normalizedScope.scope;
if (effectiveScope) {
registry.gatewayMethodScopes ??= {};
registry.gatewayMethodScopes[trimmed] = effectiveScope;
}
record.gatewayMethods.push(trimmed);
};
const describeHttpRouteOwner = (entry: PluginHttpRouteRegistration): string => {
const plugin = normalizeOptionalString(entry.pluginId) || "unknown-plugin";
const source = normalizeOptionalString(entry.source) || "unknown-source";
return `${plugin} (${source})`;
};
const registerHttpRoute = (record: PluginRecord, params: OpenClawPluginHttpRouteParams) => {
const normalizedPath = normalizePluginHttpPath(params.path);
if (!normalizedPath) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message: "http route registration missing path",
});
return;
}
if (params.auth !== "gateway" && params.auth !== "plugin") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `http route registration missing or invalid auth: ${normalizedPath}`,
});
return;
}
const match = params.match ?? "exact";
const overlappingRoute = findOverlappingPluginHttpRoute(registry.httpRoutes, {
path: normalizedPath,
match,
});
if (overlappingRoute && overlappingRoute.auth !== params.auth) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message:
`http route overlap rejected: ${normalizedPath} (${match}, ${params.auth}) ` +
`overlaps ${overlappingRoute.path} (${overlappingRoute.match}, ${overlappingRoute.auth}) ` +
`owned by ${describeHttpRouteOwner(overlappingRoute)}`,
});
return;
}
const existingIndex = registry.httpRoutes.findIndex(
(entry) => entry.path === normalizedPath && entry.match === match,
);
if (existingIndex >= 0) {
const existing = registry.httpRoutes[existingIndex];
if (!existing) {
return;
}
if (!params.replaceExisting && existing.pluginId !== record.id) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `http route already registered: ${normalizedPath} (${match}) by ${describeHttpRouteOwner(existing)}`,
});
return;
}
if (existing.pluginId && existing.pluginId !== record.id) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `http route replacement rejected: ${normalizedPath} (${match}) owned by ${describeHttpRouteOwner(existing)}`,
});
return;
}
registry.httpRoutes[existingIndex] = {
pluginId: record.id,
path: normalizedPath,
handler: params.handler,
auth: params.auth,
match,
...(params.gatewayRuntimeScopeSurface
? { gatewayRuntimeScopeSurface: params.gatewayRuntimeScopeSurface }
: {}),
source: record.source,
};
return;
}
record.httpRoutes += 1;
registry.httpRoutes.push({
pluginId: record.id,
path: normalizedPath,
handler: params.handler,
auth: params.auth,
match,
...(params.gatewayRuntimeScopeSurface
? { gatewayRuntimeScopeSurface: params.gatewayRuntimeScopeSurface }
: {}),
source: record.source,
});
};
const registerChannel = (
record: PluginRecord,
registration: OpenClawPluginChannelRegistration | ChannelPlugin,
mode: PluginRegistrationMode = "full",
) => {
const registrationCapabilities = resolvePluginRegistrationCapabilities(mode);
const normalized =
typeof (registration as OpenClawPluginChannelRegistration).plugin === "object"
? (registration as OpenClawPluginChannelRegistration)
: { plugin: registration as ChannelPlugin };
const plugin = normalizeRegisteredChannelPlugin({
pluginId: record.id,
source: record.source,
plugin: normalized.plugin,
pushDiagnostic,
});
if (!plugin) {
return;
}
const id = plugin.id;
const existingRuntime = registry.channels.find((entry) => entry.plugin.id === id);
if (registrationCapabilities.runtimeChannel && existingRuntime) {
if (existingRuntime.pluginId === record.id) {
existingRuntime.plugin = plugin;
existingRuntime.pluginName = record.name;
existingRuntime.source = record.source;
existingRuntime.rootDir = record.rootDir;
const existingSetup = registry.channelSetups.find((entry) => entry.plugin.id === id);
if (existingSetup) {
existingSetup.plugin = plugin;
existingSetup.pluginName = record.name;
existingSetup.source = record.source;
existingSetup.enabled = record.enabled;
existingSetup.rootDir = record.rootDir;
}
return;
}
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `channel already registered: ${id} (${existingRuntime.pluginId})`,
});
pluginsWithChannelRegistrationConflict.add(record.id);
return;
}
const existingSetup = registry.channelSetups.find((entry) => entry.plugin.id === id);
if (existingSetup) {
if (existingSetup.pluginId === record.id) {
existingSetup.plugin = plugin;
existingSetup.pluginName = record.name;
existingSetup.source = record.source;
existingSetup.enabled = record.enabled;
existingSetup.rootDir = record.rootDir;
return;
}
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `channel setup already registered: ${id} (${existingSetup.pluginId})`,
});
pluginsWithChannelRegistrationConflict.add(record.id);
return;
}
record.channelIds.push(id);
registry.channelSetups.push({
pluginId: record.id,
pluginName: record.name,
plugin,
source: record.source,
enabled: record.enabled,
rootDir: record.rootDir,
});
if (!registrationCapabilities.runtimeChannel) {
return;
}
registry.channels.push({
pluginId: record.id,
pluginName: record.name,
plugin,
source: record.source,
rootDir: record.rootDir,
});
};
const registerProvider = (record: PluginRecord, provider: ProviderPlugin) => {
const normalizedProvider = normalizeRegisteredProvider({
pluginId: record.id,
source: record.source,
provider,
pushDiagnostic,
});
if (!normalizedProvider) {
return;
}
const id = normalizedProvider.id;
const existing = registry.providers.find((entry) => entry.provider.id === id);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `provider already registered: ${id} (${existing.pluginId})`,
});
return;
}
record.providerIds.push(id);
registry.providers.push({
pluginId: record.id,
pluginName: record.name,
provider: normalizedProvider,
source: record.source,
rootDir: record.rootDir,
});
};
const registerAgentHarness = (record: PluginRecord, harness: AgentHarness) => {
const id = normalizeOptionalString((harness as Partial<AgentHarness> | undefined)?.id) ?? "";
if (!id) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "agent harness registration missing id",
});
return;
}
if (typeof harness.supports !== "function" || typeof harness.runAttempt !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `agent harness "${id}" registration missing required runtime methods`,
});
return;
}
const existing =
registryParams.activateGlobalSideEffects === false
? registry.agentHarnesses.find((entry) => entry.harness.id === id)
: getRegisteredAgentHarness(id);
if (existing) {
const ownerPluginId =
"ownerPluginId" in existing
? existing.ownerPluginId
: "pluginId" in existing
? existing.pluginId
: undefined;
const ownerDetail = ownerPluginId ? ` (owner: ${ownerPluginId})` : "";
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `agent harness already registered: ${id}${ownerDetail}`,
});
return;
}
const normalizedHarness = {
...harness,
id,
pluginId: harness.pluginId ?? record.id,
};
if (registryParams.activateGlobalSideEffects !== false) {
registerGlobalAgentHarness(normalizedHarness, { ownerPluginId: record.id });
}
record.agentHarnessIds.push(id);
registry.agentHarnesses.push({
pluginId: record.id,
pluginName: record.name,
harness: normalizedHarness,
source: record.source,
rootDir: record.rootDir,
});
};
const registerCliBackend = (record: PluginRecord, backend: CliBackendPlugin) => {
const id = backend.id.trim();
if (!id) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "cli backend registration missing id",
});
return;
}
const existing = (registry.cliBackends ?? []).find((entry) => entry.backend.id === id);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `cli backend already registered: ${id} (${existing.pluginId})`,
});
return;
}
(registry.cliBackends ??= []).push({
pluginId: record.id,
pluginName: record.name,
backend: {
...backend,
id,
},
source: record.source,
rootDir: record.rootDir,
});
record.cliBackendIds.push(id);
};
const registerTextTransforms = (
record: PluginRecord,
transforms: PluginTextTransformsRegistration["transforms"],
) => {
if (
(!transforms.input || transforms.input.length === 0) &&
(!transforms.output || transforms.output.length === 0)
) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message: "text transform registration has no input or output replacements",
});
return;
}
registry.textTransforms.push({
pluginId: record.id,
pluginName: record.name,
transforms,
source: record.source,
rootDir: record.rootDir,
});
};
const registerUniqueProviderLike = <T extends { id: string }>(params: {
record: PluginRecord;
provider: T;
kindLabel: string;
registrations: Array<PluginOwnedProviderRegistration<T>>;
ownedIds: string[];
}) => {
const id = params.provider.id.trim();
const { record, kindLabel } = params;
const missingLabel = `${kindLabel} registration missing id`;
const duplicateLabel = `${kindLabel} already registered: ${id}`;
if (!id) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: missingLabel,
});
return;
}
const existing = params.registrations.find((entry) => entry.provider.id === id);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `${duplicateLabel} (${existing.pluginId})`,
});
return;
}
params.ownedIds.push(id);
params.registrations.push({
pluginId: record.id,
pluginName: record.name,
provider: params.provider,
source: record.source,
rootDir: record.rootDir,
});
};
const registerSpeechProvider = (record: PluginRecord, provider: SpeechProviderPlugin) => {
registerUniqueProviderLike({
record,
provider,
kindLabel: "speech provider",
registrations: registry.speechProviders,
ownedIds: record.speechProviderIds,
});
};
const registerRealtimeTranscriptionProvider = (
record: PluginRecord,
provider: RealtimeTranscriptionProviderPlugin,
) => {
registerUniqueProviderLike({
record,
provider,
kindLabel: "realtime transcription provider",
registrations: registry.realtimeTranscriptionProviders,
ownedIds: record.realtimeTranscriptionProviderIds,
});
};
const registerRealtimeVoiceProvider = (
record: PluginRecord,
provider: RealtimeVoiceProviderPlugin,
) => {
registerUniqueProviderLike({
record,
provider,
kindLabel: "realtime voice provider",
registrations: registry.realtimeVoiceProviders,
ownedIds: record.realtimeVoiceProviderIds,
});
};
const registerMediaUnderstandingProvider = (
record: PluginRecord,
provider: MediaUnderstandingProviderPlugin,
) => {
registerUniqueProviderLike({
record,
provider,
kindLabel: "media provider",
registrations: registry.mediaUnderstandingProviders,
ownedIds: record.mediaUnderstandingProviderIds,
});
};
const registerImageGenerationProvider = (
record: PluginRecord,
provider: ImageGenerationProviderPlugin,
) => {
registerUniqueProviderLike({
record,
provider,
kindLabel: "image-generation provider",
registrations: registry.imageGenerationProviders,
ownedIds: record.imageGenerationProviderIds,
});
};
const registerVideoGenerationProvider = (
record: PluginRecord,
provider: VideoGenerationProviderPlugin,
) => {
registerUniqueProviderLike({
record,
provider,
kindLabel: "video-generation provider",
registrations: registry.videoGenerationProviders,
ownedIds: record.videoGenerationProviderIds,
});
};
const registerMusicGenerationProvider = (
record: PluginRecord,
provider: MusicGenerationProviderPlugin,
) => {
registerUniqueProviderLike({
record,
provider,
kindLabel: "music-generation provider",
registrations: registry.musicGenerationProviders,
ownedIds: record.musicGenerationProviderIds,
});
};
const registerWebFetchProvider = (record: PluginRecord, provider: WebFetchProviderPlugin) => {
registerUniqueProviderLike({
record,
provider,
kindLabel: "web fetch provider",
registrations: registry.webFetchProviders,
ownedIds: record.webFetchProviderIds,
});
};
const registerWebSearchProvider = (record: PluginRecord, provider: WebSearchProviderPlugin) => {
registerUniqueProviderLike({
record,
provider,
kindLabel: "web search provider",
registrations: registry.webSearchProviders,
ownedIds: record.webSearchProviderIds,
});
};
const registerMigrationProvider = (record: PluginRecord, provider: MigrationProviderPlugin) => {
registerUniqueProviderLike({
record,
provider,
kindLabel: "migration provider",
registrations: registry.migrationProviders,
ownedIds: record.migrationProviderIds,
});
};
const registerCli = (
record: PluginRecord,
registrar: OpenClawPluginCliRegistrar,
opts?: { commands?: string[]; descriptors?: OpenClawPluginCliCommandDescriptor[] },
) => {
const normalizeCommandRoot = (raw: string, source: "command" | "descriptor") => {
const normalized = normalizeCommandDescriptorName(raw);
if (!normalized) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `invalid cli ${source} name: ${JSON.stringify(raw.trim())}`,
});
}
return normalized;
};
const descriptors = (opts?.descriptors ?? [])
.map((descriptor) => {
const name = normalizeCommandRoot(descriptor.name, "descriptor");
const description = sanitizeCommandDescriptorDescription(descriptor.description);
return name && description
? {
name,
description,
hasSubcommands: descriptor.hasSubcommands,
}
: null;
})
.filter(
(descriptor): descriptor is OpenClawPluginCliCommandDescriptor => descriptor !== null,
);
const commands = [
...(opts?.commands ?? []),
...descriptors.map((descriptor) => descriptor.name),
]
.map((cmd) => normalizeCommandRoot(cmd, "command"))
.filter((command): command is string => command !== null);
if (commands.length === 0) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "cli registration missing explicit commands metadata",
});
return;
}
const existing = registry.cliRegistrars.find((entry) =>
entry.commands.some((command) => commands.includes(command)),
);
if (existing) {
const overlap = commands.find((command) => existing.commands.includes(command));
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `cli command already registered: ${overlap ?? commands[0]} (${existing.pluginId})`,
});
return;
}
record.cliCommands.push(...commands);
registry.cliRegistrars.push({
pluginId: record.id,
pluginName: record.name,
register: registrar,
commands,
descriptors,
source: record.source,
rootDir: record.rootDir,
});
};
const reservedNodeHostCommands = new Set<string>([
...NODE_SYSTEM_RUN_COMMANDS,
...NODE_EXEC_APPROVALS_COMMANDS,
NODE_SYSTEM_NOTIFY_COMMAND,
]);
const registerReload = (record: PluginRecord, registration: OpenClawPluginReloadRegistration) => {
const normalize = (values?: string[]) =>
(values ?? []).map((value) => value.trim()).filter(Boolean);
const normalized: OpenClawPluginReloadRegistration = {
restartPrefixes: normalize(registration.restartPrefixes),
hotPrefixes: normalize(registration.hotPrefixes),
noopPrefixes: normalize(registration.noopPrefixes),
};
if (
(normalized.restartPrefixes?.length ?? 0) === 0 &&
(normalized.hotPrefixes?.length ?? 0) === 0 &&
(normalized.noopPrefixes?.length ?? 0) === 0
) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message: "reload registration missing prefixes",
});
return;
}
registry.reloads ??= [];
registry.reloads.push({
pluginId: record.id,
pluginName: record.name,
registration: normalized,
source: record.source,
rootDir: record.rootDir,
});
};
const registerNodeHostCommand = (
record: PluginRecord,
nodeCommand: OpenClawPluginNodeHostCommand,
) => {
const command = nodeCommand.command.trim();
if (!command) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "node host command registration missing command",
});
return;
}
if (reservedNodeHostCommands.has(command)) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `node host command reserved by core: ${command}`,
});
return;
}
registry.nodeHostCommands ??= [];
const existing = registry.nodeHostCommands.find((entry) => entry.command.command === command);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `node host command already registered: ${command} (${existing.pluginId})`,
});
return;
}
registry.nodeHostCommands.push({
pluginId: record.id,
pluginName: record.name,
command: {
...nodeCommand,
command,
cap: normalizeOptionalString(nodeCommand.cap),
},
source: record.source,
rootDir: record.rootDir,
});
};
const registerNodeInvokePolicy = (
record: PluginRecord,
policy: OpenClawPluginNodeInvokePolicy,
pluginConfig?: Record<string, unknown>,
) => {
const commands = Array.isArray(policy.commands)
? policy.commands.map((command) => command.trim()).filter(Boolean)
: [];
if (commands.length === 0) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "node invoke policy registration missing commands",
});
return;
}
if (typeof policy.handle !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `node invoke policy registration missing handler: ${commands.join(", ")}`,
});
return;
}
registry.nodeInvokePolicies ??= [];
for (const command of commands) {
const existing = registry.nodeInvokePolicies.find((entry) =>
entry.policy.commands.includes(command),
);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `node invoke policy already registered for ${command} (${existing.pluginId})`,
});
return;
}
}
registry.nodeInvokePolicies.push({
pluginId: record.id,
pluginName: record.name,
policy: { ...policy, commands },
pluginConfig,
source: record.source,
rootDir: record.rootDir,
});
};
const registerSecurityAuditCollector = (
record: PluginRecord,
collector: OpenClawPluginSecurityAuditCollector,
) => {
registry.securityAuditCollectors ??= [];
registry.securityAuditCollectors.push({
pluginId: record.id,
pluginName: record.name,
collector,
source: record.source,
rootDir: record.rootDir,
});
};
const registerService = (record: PluginRecord, service: OpenClawPluginService) => {
const id = service.id.trim();
if (!id) {
return;
}
const existing = registry.services.find((entry) => entry.service.id === id);
if (existing) {
// Idempotent: the same plugin can hit registration twice across snapshot vs
// activating loads (see #62033). Keep the first registration.
if (existing.pluginId === record.id) {
return;
}
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `service already registered: ${id} (${existing.pluginId})`,
});
return;
}
record.services.push(id);
registry.services.push({
pluginId: record.id,
pluginName: record.name,
service,
source: record.source,
origin: record.origin,
rootDir: record.rootDir,
});
};
const registerGatewayDiscoveryService = (
record: PluginRecord,
service: OpenClawGatewayDiscoveryService,
) => {
const id = service.id.trim();
if (!id) {
return;
}
const existing = registry.gatewayDiscoveryServices.find((entry) => entry.service.id === id);
if (existing) {
if (existing.pluginId === record.id) {
return;
}
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `gateway discovery service already registered: ${id} (${existing.pluginId})`,
});
return;
}
record.gatewayDiscoveryServiceIds.push(id);
registry.gatewayDiscoveryServices.push({
pluginId: record.id,
pluginName: record.name,
service,
source: record.source,
rootDir: record.rootDir,
});
};
const registerCommand = (record: PluginRecord, command: OpenClawPluginCommandDefinition) => {
const name = command.name.trim();
if (!name) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "command registration missing name",
});
return;
}
const allowReservedCommandNames = command.ownership === "reserved";
if (allowReservedCommandNames && record.origin !== "bundled") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `only bundled plugins can claim reserved command ownership: ${name}`,
});
return;
}
if (allowReservedCommandNames && !isReservedCommandName(name)) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `reserved command ownership requires a reserved command name: ${name}`,
});
return;
}
if (allowReservedCommandNames && record.id !== normalizeLowercaseStringOrEmpty(name)) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `command registration failed: Reserved command ownership requires plugin id "${record.id}" to match reserved command name "${normalizeLowercaseStringOrEmpty(name)}"`,
});
return;
}
// For snapshot (non-activating) loads, record the command locally without touching the
// global plugin command registry so running gateway commands stay intact.
// We still validate the command definition so diagnostics match the real activation path.
// NOTE: cross-plugin duplicate command detection is intentionally skipped here because
// snapshot registries are isolated and never write to the global command table. Conflicts
// will surface when the plugin is loaded via the normal activation path at gateway startup.
if (!registryParams.activateGlobalSideEffects) {
const validationError = validatePluginCommandDefinition(command, {
allowReservedCommandNames,
});
if (validationError) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `command registration failed: ${validationError}`,
});
return;
}
} else {
const { ownership: _ownership, ...commandForRegistration } = command;
void _ownership;
const result = registerPluginCommand(
record.id,
allowReservedCommandNames ? commandForRegistration : command,
{
pluginName: record.name,
pluginRoot: record.rootDir,
allowReservedCommandNames,
},
);
if (!result.ok) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `command registration failed: ${result.error}`,
});
return;
}
if (allowReservedCommandNames) {
const registeredCommand = pluginCommands.get(`/${name.toLowerCase()}`);
if (registeredCommand?.pluginId === record.id) {
registeredCommand.ownership = "reserved";
}
}
}
record.commands.push(name);
registry.commands.push({
pluginId: record.id,
pluginName: record.name,
command,
source: record.source,
rootDir: record.rootDir,
});
};
const normalizeHostHookString = (value: unknown): string =>
typeof value === "string" ? normalizePluginHostHookId(value) : "";
const normalizeOptionalHostHookString = (value: unknown): string | undefined => {
if (value === undefined) {
return undefined;
}
if (typeof value !== "string") {
return "";
}
return value.trim();
};
const normalizeHostHookStringList = (value: unknown): string[] | undefined | null => {
if (value === undefined) {
return undefined;
}
if (!Array.isArray(value)) {
return null;
}
const normalized = value.map((item) => normalizeOptionalHostHookString(item));
if (normalized.some((item) => !item)) {
return null;
}
return normalized as string[];
};
const controlUiSurfaces = new Set<PluginControlUiDescriptor["surface"]>([
"session",
"tool",
"run",
"settings",
]);
const registerSessionExtension = (
record: PluginRecord,
extension: PluginSessionExtensionRegistration,
) => {
const namespace = normalizeHostHookString(extension.namespace);
const description = normalizeHostHookString(extension.description);
const project = extension.project;
let invalidMessage: string | undefined;
if (!namespace || !description) {
invalidMessage = "session extension registration requires namespace and description";
} else if (project !== undefined && typeof project !== "function") {
invalidMessage = "session extension projector must be a function";
} else if (project?.constructor?.name === "AsyncFunction") {
invalidMessage = "session extension projector must be synchronous";
} else if (extension.cleanup !== undefined && typeof extension.cleanup !== "function") {
invalidMessage = "session extension cleanup must be a function";
}
if (invalidMessage) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: invalidMessage,
});
return;
}
const existing = (registry.sessionExtensions ?? []).find(
(entry) => entry.pluginId === record.id && entry.extension.namespace === namespace,
);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `session extension already registered: ${namespace}`,
});
return;
}
(registry.sessionExtensions ??= []).push({
pluginId: record.id,
pluginName: record.name,
extension: {
...extension,
namespace,
description,
},
source: record.source,
rootDir: record.rootDir,
});
};
const registerTrustedToolPolicy = (
record: PluginRecord,
policy: PluginTrustedToolPolicyRegistration,
) => {
if (record.origin !== "bundled") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "only bundled plugins can register trusted tool policies",
});
return;
}
const id = normalizeHostHookString(policy.id);
const description = normalizeHostHookString(policy.description);
if (!id || !description || typeof policy.evaluate !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "trusted tool policy registration requires id, description, and evaluate()",
});
return;
}
const existing = (registry.trustedToolPolicies ?? []).find((entry) => entry.policy.id === id);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `trusted tool policy already registered: ${id} (${existing.pluginId})`,
});
return;
}
(registry.trustedToolPolicies ??= []).push({
pluginId: record.id,
pluginName: record.name,
policy: {
...policy,
id,
description,
},
source: record.source,
rootDir: record.rootDir,
});
};
const registerToolMetadata = (record: PluginRecord, metadata: PluginToolMetadataRegistration) => {
const toolName = normalizeHostHookString(metadata.toolName);
if (!toolName) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "tool metadata registration missing toolName",
});
return;
}
// Uniqueness is scoped to (pluginId + toolName): different plugins may each
// register metadata under the same toolName for their own tools, but a given
// plugin may not register the same toolName twice. At projection time
// (tools-effective-inventory.ts, tools-catalog.ts) the metadata is matched
// back to the tool's owning pluginId so plugin-X cannot decorate plugin-Y's
// tool (or a core tool) by registering metadata with the same name.
const existing = (registry.toolMetadata ?? []).find(
(entry) => entry.pluginId === record.id && entry.metadata.toolName === toolName,
);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `tool metadata already registered: ${toolName} (${existing.pluginId})`,
});
return;
}
const displayName = normalizeOptionalHostHookString(metadata.displayName);
const description = normalizeOptionalHostHookString(metadata.description);
const tags = normalizeHostHookStringList(metadata.tags);
if (
displayName === "" ||
description === "" ||
tags === null ||
(metadata.risk !== undefined && !["low", "medium", "high"].includes(metadata.risk))
) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `tool metadata registration has invalid metadata: ${toolName}`,
});
return;
}
(registry.toolMetadata ??= []).push({
pluginId: record.id,
pluginName: record.name,
metadata: {
...metadata,
toolName,
...(displayName !== undefined ? { displayName } : {}),
...(description !== undefined ? { description } : {}),
...(tags !== undefined ? { tags } : {}),
},
source: record.source,
rootDir: record.rootDir,
});
};
const registerControlUiDescriptor = (
record: PluginRecord,
descriptor: PluginControlUiDescriptor,
) => {
const id = normalizeHostHookString(descriptor.id);
const label = normalizeHostHookString(descriptor.label);
const description = normalizeOptionalHostHookString(descriptor.description);
const placement = normalizeOptionalHostHookString(descriptor.placement);
const requiredScopes = normalizeHostHookStringList(descriptor.requiredScopes);
const surface = typeof descriptor.surface === "string" ? descriptor.surface : "";
if (
!id ||
!label ||
!controlUiSurfaces.has(surface as PluginControlUiDescriptor["surface"]) ||
description === "" ||
placement === "" ||
requiredScopes === null
) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message:
"control UI descriptor registration requires id, surface, label, and valid optional fields",
});
return;
}
// Validate each requiredScope against the known OperatorScope set so untyped
// (JS) plugins cannot project arbitrary strings to clients as if they were
// valid operator scopes.
if (requiredScopes !== undefined) {
const unknownScope = requiredScopes.find((scope) => !isOperatorScope(scope));
if (unknownScope !== undefined) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `control UI descriptor requiredScopes contains unknown operator scope: ${unknownScope}`,
});
return;
}
}
if (descriptor.schema !== undefined && !isPluginJsonValue(descriptor.schema)) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `control UI descriptor schema must be JSON-compatible: ${id}`,
});
return;
}
const existing = (registry.controlUiDescriptors ?? []).find(
(entry) => entry.pluginId === record.id && entry.descriptor.id === id,
);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `control UI descriptor already registered: ${id}`,
});
return;
}
(registry.controlUiDescriptors ??= []).push({
pluginId: record.id,
pluginName: record.name,
descriptor: {
...descriptor,
id,
surface: surface as PluginControlUiDescriptor["surface"],
label,
...(description !== undefined ? { description } : {}),
...(placement !== undefined ? { placement } : {}),
...(requiredScopes !== undefined
? { requiredScopes: requiredScopes as OperatorScope[] }
: {}),
},
source: record.source,
rootDir: record.rootDir,
});
};
const registerRuntimeLifecycle = (
record: PluginRecord,
lifecycle: PluginRuntimeLifecycleRegistration,
) => {
const id = normalizePluginHostHookId(lifecycle.id);
if (!id) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "runtime lifecycle registration missing id",
});
return;
}
const existing = (registry.runtimeLifecycles ?? []).find(
(entry) => entry.pluginId === record.id && entry.lifecycle.id === id,
);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `runtime lifecycle already registered: ${id}`,
});
return;
}
if (lifecycle.cleanup !== undefined && typeof lifecycle.cleanup !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `runtime lifecycle cleanup must be a function: ${id}`,
});
return;
}
(registry.runtimeLifecycles ??= []).push({
pluginId: record.id,
pluginName: record.name,
lifecycle: { ...lifecycle, id },
source: record.source,
rootDir: record.rootDir,
});
};
const registerAgentEventSubscription = (
record: PluginRecord,
subscription: PluginAgentEventSubscriptionRegistration,
) => {
const id = normalizePluginHostHookId(subscription.id);
if (!id || typeof subscription.handle !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "agent event subscription registration requires id and handle",
});
return;
}
const streams = normalizeHostHookStringList(subscription.streams);
if (streams === null) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `agent event subscription streams must be an array of strings: ${id}`,
});
return;
}
const existing = (registry.agentEventSubscriptions ?? []).find(
(entry) => entry.pluginId === record.id && entry.subscription.id === id,
);
if (existing) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `agent event subscription already registered: ${id}`,
});
return;
}
(registry.agentEventSubscriptions ??= []).push({
pluginId: record.id,
pluginName: record.name,
subscription: { ...subscription, id, ...(streams !== undefined ? { streams } : {}) },
source: record.source,
rootDir: record.rootDir,
});
};
const registerSessionSchedulerJob = (
record: PluginRecord,
job: PluginSessionSchedulerJobRegistration,
) => {
const jobId = normalizeHostHookString(job.id);
const sessionKey = normalizeHostHookString(job.sessionKey);
const kind = normalizeHostHookString(job.kind);
if (
jobId &&
(registry.sessionSchedulerJobs ?? []).some(
(entry) => entry.pluginId === record.id && entry.job.id === jobId,
)
) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `session scheduler job already registered: ${jobId}`,
});
return undefined;
}
if (!jobId || !sessionKey || !kind) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "session scheduler job registration requires unique id, sessionKey, and kind",
});
return undefined;
}
if (job.cleanup !== undefined && typeof job.cleanup !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `session scheduler job cleanup must be a function: ${jobId}`,
});
return undefined;
}
if (registryParams.activateGlobalSideEffects === false) {
(registry.sessionSchedulerJobs ??= []).push({
pluginId: record.id,
pluginName: record.name,
job: { ...job, id: jobId, sessionKey, kind },
source: record.source,
rootDir: record.rootDir,
});
return { id: jobId, pluginId: record.id, sessionKey, kind };
}
const handle = registerPluginSessionSchedulerJob({
pluginId: record.id,
pluginName: record.name,
job: { ...job, id: jobId, sessionKey, kind },
});
if (!handle) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "session scheduler job registration requires unique id, sessionKey, and kind",
});
return undefined;
}
(registry.sessionSchedulerJobs ??= []).push({
pluginId: record.id,
pluginName: record.name,
job: { ...job, id: handle.id, sessionKey: handle.sessionKey, kind: handle.kind },
generation: getPluginSessionSchedulerJobGeneration({
pluginId: record.id,
jobId: handle.id,
sessionKey: handle.sessionKey,
}),
source: record.source,
rootDir: record.rootDir,
});
return handle;
};
const registerTypedHook = <K extends PluginHookName>(
record: PluginRecord,
hookName: K,
handler: PluginHookHandlerMap[K],
opts?: { priority?: number; timeoutMs?: number },
policy?: PluginTypedHookPolicy,
) => {
if (!isPluginHookName(hookName)) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message: `unknown typed hook "${String(hookName)}" ignored`,
});
return;
}
let effectiveHandler = handler;
if (policy?.allowPromptInjection === false && isPromptInjectionHookName(hookName)) {
if (hookName !== "before_agent_start") {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message: `typed hook "${hookName}" blocked by plugins.entries.${record.id}.hooks.allowPromptInjection=false`,
});
return;
}
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message: `typed hook "${hookName}" prompt fields constrained by plugins.entries.${record.id}.hooks.allowPromptInjection=false`,
});
effectiveHandler = constrainLegacyPromptInjectionHook(
handler as PluginHookHandlerMap["before_agent_start"],
) as PluginHookHandlerMap[K];
}
if (isConversationHookName(hookName)) {
const explicitConversationAccess = policy?.allowConversationAccess;
if (record.origin !== "bundled" && explicitConversationAccess !== true) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message:
`typed hook "${hookName}" blocked because non-bundled plugins must set ` +
`plugins.entries.${record.id}.hooks.allowConversationAccess=true`,
});
return;
}
if (record.origin === "bundled" && explicitConversationAccess === false) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message: `typed hook "${hookName}" blocked by plugins.entries.${record.id}.hooks.allowConversationAccess=false`,
});
return;
}
}
record.hookCount += 1;
registry.typedHooks.push({
pluginId: record.id,
hookName,
handler: effectiveHandler,
priority: opts?.priority,
...(opts?.timeoutMs !== undefined ? { timeoutMs: opts.timeoutMs } : {}),
source: record.source,
} as TypedPluginHookRegistration);
};
const registerConversationBindingResolvedHandler = (
record: PluginRecord,
handler: (event: PluginConversationBindingResolvedEvent) => void | Promise<void>,
) => {
registry.conversationBindingResolvedHandlers.push({
pluginId: record.id,
pluginName: record.name,
pluginRoot: record.rootDir,
handler,
source: record.source,
rootDir: record.rootDir,
});
};
const normalizeLogger = (logger: PluginLogger): PluginLogger => ({
info: logger.info,
warn: logger.warn,
error: logger.error,
debug: logger.debug,
});
const pluginRuntimeById = new Map<string, PluginRuntime>();
const pluginRuntimeRecordById = new Map<string, PluginRecord>();
const resolvePluginRuntime = (pluginId: string): PluginRuntime => {
const cached = pluginRuntimeById.get(pluginId);
if (cached) {
return cached;
}
const runtime = new Proxy(registryParams.runtime, {
get(target, prop, receiver) {
if (prop === "state") {
const baseState = Reflect.get(target, prop, receiver);
return {
...baseState,
openKeyedStore: <T>(options: OpenKeyedStoreOptions): PluginStateKeyedStore<T> => {
const record =
pluginRuntimeRecordById.get(pluginId) ??
registry.plugins.find((entry) => entry.id === pluginId);
if (record?.origin !== "bundled") {
throw new Error(
"openKeyedStore is only available for bundled plugins in this release.",
);
}
return createPluginStateKeyedStore<T>(pluginId, options);
},
} satisfies PluginRuntime["state"];
}
if (prop !== "subagent") {
return Reflect.get(target, prop, receiver);
}
const subagent = Reflect.get(target, prop, receiver);
return {
run: (params) => withPluginRuntimePluginIdScope(pluginId, () => subagent.run(params)),
waitForRun: (params) =>
withPluginRuntimePluginIdScope(pluginId, () => subagent.waitForRun(params)),
getSessionMessages: (params) =>
withPluginRuntimePluginIdScope(pluginId, () => subagent.getSessionMessages(params)),
getSession: (params) =>
withPluginRuntimePluginIdScope(pluginId, () => subagent.getSession(params)),
deleteSession: (params) =>
withPluginRuntimePluginIdScope(pluginId, () => subagent.deleteSession(params)),
} satisfies PluginRuntime["subagent"];
},
});
pluginRuntimeById.set(pluginId, runtime);
return runtime;
};
const createApi = (
record: PluginRecord,
params: {
config: OpenClawPluginApi["config"];
pluginConfig?: Record<string, unknown>;
hookPolicy?: PluginTypedHookPolicy;
registrationMode?: PluginRegistrationMode;
},
): OpenClawPluginApi => {
const registrationMode = params.registrationMode ?? "full";
const registrationCapabilities = resolvePluginRegistrationCapabilities(registrationMode);
pluginRuntimeRecordById.set(record.id, record);
return buildPluginApi({
id: record.id,
name: record.name,
version: record.version,
description: record.description,
source: record.source,
rootDir: record.rootDir,
registrationMode,
config: params.config,
pluginConfig: params.pluginConfig,
runtime: resolvePluginRuntime(record.id),
logger: normalizeLogger(registryParams.logger),
resolvePath: (input: string) => resolvePluginPath(input, record.rootDir),
handlers: {
...(registrationCapabilities.capabilityHandlers
? {
registerTool: (tool, opts) => registerTool(record, tool, opts),
registerHook: (events, handler, opts) =>
registerHook(record, events, handler, opts, params.config, params.pluginConfig),
registerHttpRoute: (routeParams) => registerHttpRoute(record, routeParams),
registerProvider: (provider) => registerProvider(record, provider),
registerAgentHarness: (harness) => registerAgentHarness(record, harness),
registerDetachedTaskRuntime: (runtime) => {
const existing = getDetachedTaskLifecycleRuntimeRegistration();
if (existing && existing.pluginId !== record.id) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `detached task runtime already registered by ${existing.pluginId}`,
});
return;
}
registerDetachedTaskLifecycleRuntime(record.id, runtime);
},
registerSpeechProvider: (provider) => registerSpeechProvider(record, provider),
registerRealtimeTranscriptionProvider: (provider) =>
registerRealtimeTranscriptionProvider(record, provider),
registerRealtimeVoiceProvider: (provider) =>
registerRealtimeVoiceProvider(record, provider),
registerMediaUnderstandingProvider: (provider) =>
registerMediaUnderstandingProvider(record, provider),
registerImageGenerationProvider: (provider) =>
registerImageGenerationProvider(record, provider),
registerVideoGenerationProvider: (provider) =>
registerVideoGenerationProvider(record, provider),
registerMusicGenerationProvider: (provider) =>
registerMusicGenerationProvider(record, provider),
registerWebFetchProvider: (provider) => registerWebFetchProvider(record, provider),
registerWebSearchProvider: (provider) => registerWebSearchProvider(record, provider),
registerMigrationProvider: (provider) => registerMigrationProvider(record, provider),
registerGatewayMethod: (method, handler, opts) =>
registerGatewayMethod(record, method, handler, opts),
registerService: (service) => registerService(record, service),
registerGatewayDiscoveryService: (service) =>
registerGatewayDiscoveryService(record, service),
registerCliBackend: (backend) => registerCliBackend(record, backend),
registerTextTransforms: (transforms) => registerTextTransforms(record, transforms),
registerReload: (registration) => registerReload(record, registration),
registerNodeHostCommand: (command) => registerNodeHostCommand(record, command),
registerNodeInvokePolicy: (policy) =>
registerNodeInvokePolicy(record, policy, params.pluginConfig),
registerSecurityAuditCollector: (collector) =>
registerSecurityAuditCollector(record, collector),
registerInteractiveHandler: (registration) => {
const result = registerPluginInteractiveHandler(record.id, registration, {
pluginName: record.name,
pluginRoot: record.rootDir,
});
if (!result.ok) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message: result.error ?? "interactive handler registration failed",
});
}
},
onConversationBindingResolved: (handler) =>
registerConversationBindingResolvedHandler(record, handler),
registerCommand: (command) => registerCommand(record, command),
registerContextEngine: (id, factory) => {
const normalizedId = normalizeOptionalString(id) ?? "";
if (!normalizedId) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "context engine registration missing id",
});
return;
}
if (typeof factory !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `context engine "${normalizedId}" registration missing factory`,
});
return;
}
if (normalizedId === defaultSlotIdForKey("contextEngine")) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `context engine id reserved by core: ${normalizedId}`,
});
return;
}
const result = registerContextEngineForOwner(
normalizedId,
factory,
`plugin:${record.id}`,
{
allowSameOwnerRefresh: true,
},
);
if (!result.ok) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `context engine already registered: ${normalizedId} (${result.existingOwner})`,
});
return;
}
if (!record.contextEngineIds?.includes(normalizedId)) {
record.contextEngineIds = [...(record.contextEngineIds ?? []), normalizedId];
}
},
registerCompactionProvider: (
provider: Parameters<OpenClawPluginApi["registerCompactionProvider"]>[0],
) => {
const id = normalizeOptionalString(
(
provider as Partial<
Parameters<OpenClawPluginApi["registerCompactionProvider"]>[0]
> | null
)?.id,
);
if (!id) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "compaction provider registration missing id",
});
return;
}
if (typeof provider?.summarize !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `compaction provider "${id}" registration missing summarize`,
});
return;
}
const existing = getRegisteredCompactionProvider(id);
if (existing) {
const ownerDetail = existing.ownerPluginId
? ` (owner: ${existing.ownerPluginId})`
: "";
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `compaction provider already registered: ${id}${ownerDetail}`,
});
return;
}
registerCompactionProvider(provider, { ownerPluginId: record.id });
},
registerCodexAppServerExtensionFactory: (factory) => {
registerCodexAppServerExtensionFactory(record, factory);
},
registerAgentToolResultMiddleware: (handler, options) => {
registerAgentToolResultMiddleware(record, handler, options);
},
registerSessionExtension: (extension) => registerSessionExtension(record, extension),
enqueueNextTurnInjection: (injection) => {
if (params.hookPolicy?.allowPromptInjection === false) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message: `next-turn injection blocked by plugins.entries.${record.id}.hooks.allowPromptInjection=false`,
});
return Promise.resolve({
enqueued: false,
id: "",
sessionKey: injection.sessionKey,
});
}
return enqueuePluginNextTurnInjection({
cfg: registryParams.runtime.config.current() as OpenClawConfig,
pluginId: record.id,
pluginName: record.name,
injection,
});
},
registerTrustedToolPolicy: (policy) => registerTrustedToolPolicy(record, policy),
registerToolMetadata: (metadata) => registerToolMetadata(record, metadata),
registerControlUiDescriptor: (descriptor) =>
registerControlUiDescriptor(record, descriptor),
registerRuntimeLifecycle: (lifecycle) => registerRuntimeLifecycle(record, lifecycle),
registerAgentEventSubscription: (subscription) =>
registerAgentEventSubscription(record, subscription),
setRunContext: (patch) => setPluginRunContext({ pluginId: record.id, patch }),
getRunContext: (get) => getPluginRunContext({ pluginId: record.id, get }),
clearRunContext: (params) =>
clearPluginRunContext({
pluginId: record.id,
runId: params.runId,
namespace: params.namespace,
}),
registerSessionSchedulerJob: (job) => registerSessionSchedulerJob(record, job),
registerMemoryCapability: (capability) => {
if (!hasKind(record.kind, "memory")) {
throwRegistrationError("only memory plugins can register a memory capability");
}
if (
Array.isArray(record.kind) &&
record.kind.length > 1 &&
!record.memorySlotSelected
) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message:
"dual-kind plugin not selected for memory slot; skipping memory capability registration",
});
return;
}
registerMemoryCapability(record.id, capability);
},
registerMemoryPromptSection: (builder) => {
if (!hasKind(record.kind, "memory")) {
throwRegistrationError(
"only memory plugins can register a memory prompt section",
);
}
if (
Array.isArray(record.kind) &&
record.kind.length > 1 &&
!record.memorySlotSelected
) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message:
"dual-kind plugin not selected for memory slot; skipping memory prompt section registration",
});
return;
}
registerMemoryPromptSection(builder);
},
registerMemoryPromptSupplement: (builder) => {
if (typeof builder !== "function") {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: "memory prompt supplement registration missing builder",
});
return;
}
registerMemoryPromptSupplement(record.id, builder);
},
registerMemoryCorpusSupplement: (supplement) => {
registerMemoryCorpusSupplement(record.id, supplement);
},
registerMemoryFlushPlan: (resolver) => {
if (!hasKind(record.kind, "memory")) {
throwRegistrationError("only memory plugins can register a memory flush plan");
}
if (
Array.isArray(record.kind) &&
record.kind.length > 1 &&
!record.memorySlotSelected
) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message:
"dual-kind plugin not selected for memory slot; skipping memory flush plan registration",
});
return;
}
registerMemoryFlushPlanResolver(resolver);
},
registerMemoryRuntime: (runtime) => {
if (!hasKind(record.kind, "memory")) {
throwRegistrationError("only memory plugins can register a memory runtime");
}
if (
Array.isArray(record.kind) &&
record.kind.length > 1 &&
!record.memorySlotSelected
) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message:
"dual-kind plugin not selected for memory slot; skipping memory runtime registration",
});
return;
}
registerMemoryRuntime(runtime);
},
registerMemoryEmbeddingProvider: (adapter) => {
if (hasKind(record.kind, "memory")) {
if (
Array.isArray(record.kind) &&
record.kind.length > 1 &&
!record.memorySlotSelected
) {
pushDiagnostic({
level: "warn",
pluginId: record.id,
source: record.source,
message:
"dual-kind plugin not selected for memory slot; skipping memory embedding provider registration",
});
return;
}
} else if (
!(record.contracts?.memoryEmbeddingProviders ?? []).includes(adapter.id)
) {
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `plugin must own memory slot or declare contracts.memoryEmbeddingProviders for adapter: ${adapter.id}`,
});
return;
}
const existing = getRegisteredMemoryEmbeddingProvider(adapter.id);
if (existing) {
const ownerDetail = existing.ownerPluginId
? ` (owner: ${existing.ownerPluginId})`
: "";
pushDiagnostic({
level: "error",
pluginId: record.id,
source: record.source,
message: `memory embedding provider already registered: ${adapter.id}${ownerDetail}`,
});
return;
}
registerMemoryEmbeddingProvider(adapter, {
ownerPluginId: record.id,
});
registry.memoryEmbeddingProviders.push({
pluginId: record.id,
pluginName: record.name,
provider: adapter,
source: record.source,
rootDir: record.rootDir,
});
},
on: (hookName, handler, opts) =>
registerTypedHook(record, hookName, handler, opts, params.hookPolicy),
}
: {}),
// Allow setup-only/setup-runtime paths to surface parse-time CLI metadata
// without opting into the wider full-registration surface.
registerCli: (registrar, opts) => registerCli(record, registrar, opts),
registerChannel: (registration) => registerChannel(record, registration, registrationMode),
},
});
};
const rollbackPluginGlobalSideEffects = (pluginId: string) => {
if (registryParams.activateGlobalSideEffects === false) {
return;
}
clearPluginCommandsForPlugin(pluginId);
clearPluginInteractiveHandlersForPlugin(pluginId);
clearContextEnginesForOwner(`plugin:${pluginId}`);
const hookRollbackEntries = pluginHookRollback.get(pluginId) ?? [];
for (const entry of hookRollbackEntries.toReversed()) {
const activeRegistrations = activePluginHookRegistrations.get(entry.name) ?? [];
for (const registration of activeRegistrations) {
unregisterInternalHook(registration.event, registration.handler);
}
if (entry.previousRegistrations.length === 0) {
activePluginHookRegistrations.delete(entry.name);
continue;
}
for (const registration of entry.previousRegistrations) {
registerInternalHook(registration.event, registration.handler);
}
activePluginHookRegistrations.set(entry.name, [...entry.previousRegistrations]);
}
pluginHookRollback.delete(pluginId);
};
return {
registry,
createApi,
rollbackPluginGlobalSideEffects,
pushDiagnostic,
registerTool,
registerChannel,
registerProvider,
registerAgentHarness,
registerCliBackend,
registerTextTransforms,
registerSpeechProvider,
registerRealtimeTranscriptionProvider,
registerRealtimeVoiceProvider,
registerMediaUnderstandingProvider,
registerImageGenerationProvider,
registerVideoGenerationProvider,
registerMusicGenerationProvider,
registerWebSearchProvider,
registerMigrationProvider,
registerGatewayMethod,
registerCli,
registerReload,
registerNodeHostCommand,
registerSecurityAuditCollector,
registerService,
registerCommand,
registerSessionExtension,
registerTrustedToolPolicy,
registerToolMetadata,
registerControlUiDescriptor,
registerRuntimeLifecycle,
registerAgentEventSubscription,
registerSessionSchedulerJob,
registerHook,
registerTypedHook,
};
}