Skip to content

feat(hooks): add sender identity and session context to plugin hook agent context#15

Closed
zeroaltitude wants to merge 17 commits intomainfrom
feat/hook-agent-identity-context
Closed

feat(hooks): add sender identity and session context to plugin hook agent context#15
zeroaltitude wants to merge 17 commits intomainfrom
feat/hook-agent-identity-context

Conversation

@zeroaltitude
Copy link
Copy Markdown
Owner

Upstream: openclaw#33914

Part 1/3 of hooks split. See upstream PR for full description.

[claude, human developer oversight]

@zeroaltitude zeroaltitude force-pushed the feat/hook-agent-identity-context branch 4 times, most recently from 90c25aa to 83702cc Compare March 7, 2026 17:57
…gent context

Enrich PluginHookAgentContext with security-relevant sender identity
fields that enable plugins to make trust decisions based on who
triggered an agent run:

- sourceProvider: original message source before channel routing
- senderId: platform-specific sender ID (Discord, Slack, etc.)
- senderName: sender's display name
- senderIsOwner: whether sender is a configured owner
- groupId: group/channel ID for group chats (null for DMs)
- spawnedBy: parent session key for sub-agent sessions

Also adds sessionKey to PluginHookMessageContext for message hooks.

Consolidates inline hook context objects in attempt.ts to use a
single hookCtx variable, ensuring all hook call sites receive the
full identity context consistently.

These fields are consumed by security plugins like openclaw-provenance
for taint classification and trust-level assignment. Follows the
pattern established in openclaw#28623 (trigger/channelId) and openclaw#26394
(sessionKey for session hooks).

[claude, human developer oversight]
…, forward sourceProvider

- toPluginMessageContext now passes sessionKey from canonical context
- Added sessionKey to CanonicalInboundMessageHookContext
- Nullable fields (senderId, senderName, groupId, spawnedBy) now
  preserve null instead of converting to undefined via ??
- Forward sourceProvider in agent-runner-execution.ts followup path

Note: codex-connector P1 about hookCtx scope for llm_output is a
false positive — hookCtx is defined inside the same try block.

Addresses greptile + codex-connector review on PR openclaw#33914.
…attempts

run.ts was passing spawnedBy and senderIsOwner but not the other
identity fields, so hookCtx would see them as undefined.

Addresses codex-connector P1 on PR openclaw#33914.
Pass ctx.SessionKey from FinalizedMsgContext into the canonical
inbound hook context so toPluginMessageContext can surface it.
Previously the field existed on the type but was never populated.

Addresses greptile review on PR openclaw#33914.
… outbound hooks

- sourceProvider now prefers ctx.Provider (current inbound context) over
  sessionCtx.Provider for cross-channel/relayed scenarios
- Add sessionKey to CanonicalSentMessageHookContext and pass it through
  from deliver.ts so message_sent hooks can correlate to sessions

Addresses Codex P2 review comments.
Multiple hook context objects are built at different points in the pipeline:
1. Early hooks (before_model_resolve, before_agent_start) in run.ts
2. Attempt hooks (llm_input, context_assembled, etc.) in attempt.ts
3. Message hooks (message_sending, message_sent) in deliver.ts

Previously we only added identity fields to attempt.ts hookCtx. This commit:
- Adds sourceProvider, senderId, senderName, senderIsOwner, groupId, spawnedBy
  to the early hookCtx in run.ts (fixes before_model_resolve trust decisions)
- Adds sessionKey to applyMessageSendingHook params and context
  (fixes message_sending session correlation)

Addresses recurring Codex P2 findings about field plumbing gaps.
Add senderId and senderName to CompactEmbeddedPiSessionParams and forward
them through compactEmbeddedPiSessionDirect. Without this, identity fields
are lost after auto-compaction and subsequent hook calls see undefined
sender identity.

Also forwards these fields in the overflow compaction retry path in run.ts.
Adds senderId, senderName, senderIsOwner, groupId, spawnedBy to the
hookCtx built in compactEmbeddedPiSessionDirect so before_compaction
and after_compaction hooks see the same identity context as agent hooks.
hooks.identity-context.test.ts (5 tests):
- Identity fields passed to before_agent_start handlers
- Identity fields passed to before_tool_call handlers
- Null identity fields for anonymous/system (heartbeat, cron) contexts
- sourceProvider vs messageProvider distinction
- sessionKey propagation for outbound message hooks
…eation

Closes the context-propagation gap identified by Brian and confirmed by
greptile: sourceProvider was added to PluginHookAgentContext but dropped
in the overflow compaction path and not passed to createOpenClawCodingTools.

Changes:
- Add sourceProvider to CompactEmbeddedPiSessionParams
- Thread sourceProvider into compaction hookCtx
- Pass sourceProvider from compact params to createOpenClawCodingTools
- Add sourceProvider to createOpenClawCodingTools options type
- Pass sourceProvider in the main attempt.ts tool creation call
The followup payload builder captured sourceProvider but never set
spawnedBy from the session entry. Sub-agent sessions with queued/continued
runs therefore lost parent linkage, causing hooks to receive spawnedBy
as undefined and breaking parent-session trust inheritance.

Fix: read spawnedBy from sessionEntry (same source used by
commands-system-prompt.ts and commands-compact.ts).
senderId and senderName used ?? undefined in the early hookCtx (run.ts)
but ?? null in attempt.ts and compact.ts. The PluginHookAgentContext type
declares these as string | null, so plugins checking ctx.senderId === null
would never match on the run.ts path. Now consistent across all paths.

sourceProvider in createOpenClawCodingTools is forward-compatible plumbing:
the field is available in options for when resolveGroupToolPolicy or future
policy resolvers need platform origin for trust decisions. Not currently
consumed but intentionally part of the options surface.
sourceProvider is dead code in the tool creation path — it's not consumed
by resolveGroupToolPolicy or any other policy resolver. Hooks receive
sourceProvider through their own hookCtx path (run.ts, attempt.ts,
compact.ts), so tool creation doesn't need it.

Removes the field from createOpenClawCodingTools options type and the
call site in attempt.ts. Keeps sourceProvider in hookCtx objects and
CompactEmbeddedPiSessionParams where it feeds hook contexts.
…hannel

In relayed/cross-channel scenarios, ctx.Provider reflects the active
channel (e.g. 'webchat') not the originating platform (e.g. 'telegram').
OriginatingChannel already models the true origin in the routing layer.

Prefer OriginatingChannel → Provider → sessionCtx.Provider fallback,
matching the origin-resolution pattern used by resolveOriginMessageProvider.

Without this, security plugins applying trust policies based on
sourceProvider would mislabel cross-channel traffic.
@zeroaltitude zeroaltitude force-pushed the feat/hook-agent-identity-context branch from 83702cc to 3b18d32 Compare March 7, 2026 19:49
zeroaltitude pushed a commit that referenced this pull request Apr 2, 2026
* feat: add QQ Bot channel extension

* fix(qqbot): add setupWizard to runtime plugin for onboard re-entry

* fix: fix review

* fix: fix review

* chore: sync lockfile and config-docs baseline for qqbot extension

* refactor: 移除图床服务器相关代码

* fix

* docs: 新增 QQ Bot 插件文档并修正链接路径

* refactor: remove credential backup functionality and update setup logic

- Deleted the credential backup module to streamline the codebase.
- Updated the setup surface to handle client secrets more robustly, allowing for configured secret inputs.
- Simplified slash commands by removing unused hot upgrade compatibility checks and related functions.
- Adjusted types to use SecretInput for client secrets in QQBot configuration.
- Modified bundled plugin metadata to allow additional properties in the config schema.

* feat: 添加本地媒体路径解析功能,修正 QQBot 媒体路径处理

* feat: 添加本地媒体路径解析功能,修正 QQBot 媒体路径处理

* feat: remove qqbot-media and qqbot-remind skills, add tests for config and setup

- Deleted the qqbot-media and qqbot-remind skills documentation files.
- Added unit tests for qqbot configuration and setup processes, ensuring proper handling of SecretRef-backed credentials and account configurations.
- Implemented tests for local media path remapping, verifying correct resolution of media file paths.
- Removed obsolete channel and remind tools, streamlining the codebase.

* feat: 更新 QQBot 配置模式,添加音频格式和账户定义

* feat: 添加 QQBot 频道管理和定时提醒技能,更新媒体路径解析功能

* fix

* feat: 添加 /bot-upgrade 指令以查看 QQBot 插件升级指引

* feat: update reminder and qq channel skills

* feat: 更新remind工具投递目标地址格式

* feat: Refactor QQBot payload handling and improve code documentation

- Simplified and clarified the structure of payload interfaces for Cron reminders and media messages.
- Enhanced the parsing function to provide clearer error messages and improved validation.
- Updated platform utility functions for better cross-platform compatibility and clearer documentation.
- Improved text parsing utilities for better readability and consistency in emoji representation.
- Optimized upload cache management with clearer comments and reduced redundancy.
- Integrated QQBot plugin into the bundled channel plugins and updated metadata for installation.

* OK apps/macos/Sources/OpenClaw/HostEnvSecurityPolicy.generated.swift

> openclaw@2026.3.26 check:bundled-channel-config-metadata /Users/yuehuali/code/PR/openclaw
> node --import tsx scripts/generate-bundled-channel-config-metadata.ts --check

[bundled-channel-config-metadata] stale generated output at src/config/bundled-channel-config-metadata.generated.ts
 ELIFECYCLE  Command failed with exit code 1.
 ELIFECYCLE  Command failed with exit code 1.

* feat: 添加 QQBot 渠道配置及相关账户设置

* fix(qqbot): resolve 14 high-priority bugs from PR openclaw#52986 review

DM routing (7 fixes):
- #1: DM slash-command replies use sendDmMessage(guildId) instead of sendC2CMessage(senderId)
- #2: DM qualifiedTarget uses qqbot:dm:${guildId} instead of qqbot:c2c:${senderId}
- #3: sendTextChunks adds DM branch
- #4: sendMarkdownReply adds DM branch for text and Base64 images
- #5: parseAndSendMediaTags maps DM to targetType:dm + guildId
- #6: sendTextToTarget DM branch uses sendDmMessage; MessageTarget adds guildId field
- #7: handleImage/Audio/Video/FilePayload add DM branches

Other high-priority fixes:
- #8: Fix sendC2CVoiceMessage/sendGroupVoiceMessage parameter misalignment
- #9: broadcastMessage uses groupOpenid instead of member_openid for group users
- #10: Unify KnownUser storage - proactive.ts delegates to known-users.ts
- #11: Remove invalid recordKnownUser calls for guild/DM users
- #12: sendGroupMessage uses sendAndNotify to trigger onMessageSent hook
- #13: sendPhoto channel unsupported returns error field
- #14: sendTextAfterMedia adds channel and dm branches

Type fixes:
- DeliverEventContext adds guildId field
- MediaTargetContext.targetType adds dm variant
- sendPlainTextReply imgMediaTarget adds DM branch

* fix(qqbot): resolve 2 blockers + 7 medium-priority bugs from PR openclaw#52986 review

Blocker-1: Remove unused dmPolicy config knob
- dmPolicy was declared in schema/types/plugin.json but never consumed at runtime
- Removed from config-schema.ts, types.ts, and openclaw.plugin.json
- allowFrom remains active (already wired into framework command-auth)

Blocker-2: Gate sensitive slash commands with allowFrom authorization
- SlashCommand interface adds requireAuth?: boolean
- SlashCommandContext adds commandAuthorized: boolean
- /bot-logs set to requireAuth: true (reads local log files)
- matchSlashCommand rejects unauthorized senders for requireAuth commands
- trySlashCommandOrEnqueue computes commandAuthorized from allowFrom config

Medium-priority fixes:
- #15: Strip non-HTTP/non-local markdown image tags to prevent path leakage
- #16: applyQQBotAccountConfig clears clientSecret when setting clientSecretFile and vice versa
- #17: getAdminMarkerFile sanitizes accountId to prevent path traversal
- #18: URGENT_COMMANDS uses exact match instead of startsWith prefix match
- #19: isCronExpression validates each token starts with a cron-valid character
- openclaw#20: --token format validation rejects malformed input without colon separator
- openclaw#21: resolveDefaultQQBotAccountId checks QQBOT_APP_ID environment variable

* test(qqbot): add focused tests for slash command authorization path

- Unauthorized sender rejected for /bot-logs (requireAuth: true)
- Authorized sender allowed for /bot-logs
- Non-requireAuth commands (/bot-ping, /bot-help, /bot-version) work for all senders
- Unknown slash commands return null (passthrough)
- Non-slash messages return null
- Usage query (/bot-logs ?) also gated by auth check

* fix(qqbot): align global TTS fallback with framework config resolution

- Extract isGlobalTTSAvailable to utils/audio-convert.ts, mirroring core
  resolveTtsConfig logic: check auto !== 'off', fall back to legacy
  enabled boolean, default to off when neither is set.
- Add pre-check in reply-dispatcher before calling globalTextToSpeech to
  avoid unnecessary TTS calls and noisy error logs when TTS is not
  configured.
- Remove inline as any casts; use OpenClawConfig type throughout.
- Refactor handleAudioPayload into flat early-return structure with
  unified send path (plugin TTS → global fallback → send).

* fix(qqbot): break ESM circular dependency causing multi-account startup crash

The bundled gateway chunk had a circular static import on the channel
chunk (gateway -> outbound-deliver -> channel, while channel dynamically
imports gateway). When two accounts start concurrently via Promise.all,
the first dynamic import triggers module graph evaluation; the circular
reference causes api exports (including runDiagnostics) to resolve as
undefined before the module finishes evaluating.

Fix: extract chunkText and TEXT_CHUNK_LIMIT from channel.ts into a new
text-utils.ts leaf module. outbound-deliver.ts now imports from
text-utils.ts, breaking the cycle. channel.ts re-exports for backward
compatibility.

* fix(qqbot): serialize gateway module import to prevent multi-account startup race

When multiple accounts start concurrently via Promise.all, each calls
await import('./gateway.js') independently. Due to ESM circular
dependencies in the bundled output, the first import can resolve
transitive exports as undefined before module evaluation completes.

Fix: cache the dynamic import promise in a module-level variable so all
concurrent startAccount calls share the same import, ensuring the
gateway module is fully evaluated before any account uses it.

* refactor(qqbot): remove startup greeting logic

Remove getStartupGreetingPlan and related startup greeting delivery:
- Delete startup-greeting.ts (greeting plan, marker persistence)
- Delete admin-resolver.ts (admin resolution, greeting dispatch)
- Remove startup greeting calls from gateway READY/RESUMED handlers
- Remove isFirstReadyGlobal flag and adminCtx

* fix(qqbot): skip octal escape decoding for Windows local paths

Windows paths like C:\Users\1\file.txt contain backslash-digit sequences
that were incorrectly matched as octal escape sequences and decoded,
corrupting the file path. Detect Windows local paths (drive letter or UNC
prefix) and skip the octal decoding step for them.

* fix bot issue

* feat: 支持 TTS 自动开关并清理配置中的 clientSecretFile

* docs: 添加 QQBot 配置和消息处理的设计说明

* rebase

* fix(qqbot): align slash-command auth with shared command-auth model

Route requireAuth:true slash commands (e.g. /bot-logs) through the
framework's api.registerCommand() so resolveCommandAuthorization()
applies commands.allowFrom.qqbot precedence and qqbot: prefix
normalization before any handler runs.

- slash-commands.ts: registerCommand() now auto-routes by requireAuth
  into two maps (commands / frameworkCommands); getFrameworkCommands()
  exports the auth-required set for framework registration; bot-help
  lists both maps
- index.ts: registerFull() iterates getFrameworkCommands() and calls
  api.registerCommand() for each; handler derives msgType from ctx.from,
  sends file attachments via sendDocument, supports multi-account via
  ctx.accountId
- gateway.ts (inbound): replace raw allowFrom string comparison with
  qqbotPlugin.config.formatAllowFrom() to strip qqbot: prefix and
  uppercase before matching event.senderId
- gateway.ts (pre-dispatch): remove stale auth computation; commandAuthorized
  is true (requireAuth:true commands never reach matchSlashCommand)
- command-auth.test.ts: add regression tests for qqbot: prefix
  normalization in the inbound commandAuthorized computation
- slash-commands.test.ts: update /bot-logs tests to expect null
  (command routed to framework, not in local registry)

* rebase and solve conflict

* fix(qqbot): preserve mixed env setup credentials

---------

Co-authored-by: yuehuali <yuehuali@tencent.com>
Co-authored-by: walli <walli@tencent.com>
Co-authored-by: WideLee <limkuan24@gmail.com>
Co-authored-by: Frank Yang <frank.ekn@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant