mirror of
https://github.com/openclaw/openclaw.git
synced 2026-06-06 14:01:24 +08:00
db7d70ae4d
- New extensions/parallel package modeled on extensions/exa
- Wires Parallel's POST /v1/search through the generic web_search contract,
exposing Parallel's recommended {objective, search_queries} shape (plus
optional count, session_id, client_model) so the model can supply both the
natural-language goal and 2-3 short keyword queries as Parallel docs advise
- client_model lets the model report its own slug so Parallel can tailor
optimizations for the consuming model's capabilities; partitions the cache
by client_model so different models do not silently share ranked excerpts
- Honors top-level tools.web.search.{maxResults,timeoutSeconds,cacheTtlMinutes}
via the shared SDK helpers (mergeScopedSearchConfig, withTrustedWebSearchEndpoint,
buildSearchCacheKey, read/writeCachedSearchPayload)
- Auto-detect order 75; auth via PARALLEL_API_KEY or
plugins.entries.parallel.config.webSearch.apiKey
- Optional baseUrl override for proxies (e.g. Cloudflare AI Gateway)
- Threads caller-supplied session_id through follow-up calls; strips
auto-generated session_id from the shared cache to avoid cross-task leaks
- Always sends advanced_settings.max_results so result volume matches the
OpenClaw web_search default (5) instead of Parallel's default (10)
- Identifies the plugin via User-Agent header built from package version
- Runtime accepts the generic `query` arg as a fallback so the operator
CLI (openclaw capability web.search) keeps working when Parallel is the
active provider: it is promoted into the lone `search_queries` entry.
`objective` stays optional and is never synthesized from a keyword
query (Parallel documents it as natural-language intent). Agent callers
using the native objective+search_queries shape take precedence; the
schema still advertises only the native keys
- Updates the agent tool-display extractor (src/agents/tool-display-common.ts)
to recognize Parallel's objective+search_queries shape so calls render with
query context in CLI progress and Codex activity metadata
- Adds /tools/parallel-search docs page, web.md provider listing, docs nav,
labeler entry, per-plugin registration contract test, and minimal core
touch-points (legacy migrate, registration cases, providers contract list,
runtime bundled list, vitest extension paths)
163 lines
7.0 KiB
Markdown
163 lines
7.0 KiB
Markdown
---
|
|
summary: "Canonical supported vs unsupported SecretRef credential surface"
|
|
read_when:
|
|
- Verifying SecretRef credential coverage
|
|
- Auditing whether a credential is eligible for `secrets configure` or `secrets apply`
|
|
- Verifying why a credential is outside the supported surface
|
|
title: "SecretRef credential surface"
|
|
---
|
|
|
|
This page defines the canonical SecretRef credential surface.
|
|
|
|
Scope intent:
|
|
|
|
- In scope: strictly user-supplied credentials that OpenClaw does not mint or rotate.
|
|
- Out of scope: runtime-minted or rotating credentials, OAuth refresh material, and session-like artifacts.
|
|
|
|
## Supported credentials
|
|
|
|
### `openclaw.json` targets (`secrets configure` + `secrets apply` + `secrets audit`)
|
|
|
|
[//]: # "secretref-supported-list-start"
|
|
|
|
- `models.providers.*.apiKey`
|
|
- `models.providers.*.headers.*`
|
|
- `models.providers.*.request.auth.token`
|
|
- `models.providers.*.request.auth.value`
|
|
- `models.providers.*.request.headers.*`
|
|
- `models.providers.*.request.proxy.tls.ca`
|
|
- `models.providers.*.request.proxy.tls.cert`
|
|
- `models.providers.*.request.proxy.tls.key`
|
|
- `models.providers.*.request.proxy.tls.passphrase`
|
|
- `models.providers.*.request.tls.ca`
|
|
- `models.providers.*.request.tls.cert`
|
|
- `models.providers.*.request.tls.key`
|
|
- `models.providers.*.request.tls.passphrase`
|
|
- `skills.entries.*.apiKey`
|
|
- `agents.defaults.memorySearch.remote.apiKey`
|
|
- `agents.list[].tts.providers.*.apiKey`
|
|
- `agents.list[].memorySearch.remote.apiKey`
|
|
- `talk.providers.*.apiKey`
|
|
- `messages.tts.providers.*.apiKey`
|
|
- `tools.web.fetch.firecrawl.apiKey`
|
|
- `plugins.entries.acpx.config.mcpServers.*.env.*`
|
|
- `plugins.entries.brave.config.webSearch.apiKey`
|
|
- `plugins.entries.exa.config.webSearch.apiKey`
|
|
- `plugins.entries.google.config.webSearch.apiKey`
|
|
- `plugins.entries.xai.config.webSearch.apiKey`
|
|
- `plugins.entries.moonshot.config.webSearch.apiKey`
|
|
- `plugins.entries.perplexity.config.webSearch.apiKey`
|
|
- `plugins.entries.firecrawl.config.webSearch.apiKey`
|
|
- `plugins.entries.minimax.config.webSearch.apiKey`
|
|
- `plugins.entries.tavily.config.webSearch.apiKey`
|
|
- `plugins.entries.parallel.config.webSearch.apiKey`
|
|
- `plugins.entries.voice-call.config.realtime.providers.*.apiKey`
|
|
- `plugins.entries.voice-call.config.streaming.providers.*.apiKey`
|
|
- `plugins.entries.voice-call.config.tts.providers.*.apiKey`
|
|
- `plugins.entries.voice-call.config.twilio.authToken`
|
|
- `tools.web.search.*.apiKey`
|
|
- `tools.web.search.apiKey`
|
|
- `gateway.auth.password`
|
|
- `gateway.auth.token`
|
|
- `gateway.remote.token`
|
|
- `gateway.remote.password`
|
|
- `cron.webhookToken`
|
|
- `channels.telegram.botToken`
|
|
- `channels.telegram.webhookSecret`
|
|
- `channels.telegram.accounts.*.botToken`
|
|
- `channels.telegram.accounts.*.webhookSecret`
|
|
- `channels.slack.botToken`
|
|
- `channels.slack.appToken`
|
|
- `channels.slack.userToken`
|
|
- `channels.slack.signingSecret`
|
|
- `channels.slack.accounts.*.botToken`
|
|
- `channels.slack.accounts.*.appToken`
|
|
- `channels.slack.accounts.*.userToken`
|
|
- `channels.slack.accounts.*.signingSecret`
|
|
- `channels.sms.authToken`
|
|
- `channels.sms.accounts.*.authToken`
|
|
- `channels.discord.token`
|
|
- `channels.discord.pluralkit.token`
|
|
- `channels.discord.voice.tts.providers.*.apiKey`
|
|
- `channels.discord.accounts.*.token`
|
|
- `channels.discord.accounts.*.pluralkit.token`
|
|
- `channels.discord.accounts.*.voice.tts.providers.*.apiKey`
|
|
- `channels.irc.password`
|
|
- `channels.irc.nickserv.password`
|
|
- `channels.irc.accounts.*.password`
|
|
- `channels.irc.accounts.*.nickserv.password`
|
|
- `channels.feishu.appSecret`
|
|
- `channels.feishu.encryptKey`
|
|
- `channels.feishu.verificationToken`
|
|
- `channels.feishu.accounts.*.appSecret`
|
|
- `channels.feishu.accounts.*.encryptKey`
|
|
- `channels.feishu.accounts.*.verificationToken`
|
|
- `channels.qqbot.clientSecret`
|
|
- `channels.qqbot.accounts.*.clientSecret`
|
|
- `channels.msteams.appPassword`
|
|
- `channels.mattermost.botToken`
|
|
- `channels.mattermost.accounts.*.botToken`
|
|
- `channels.matrix.accessToken`
|
|
- `channels.matrix.password`
|
|
- `channels.matrix.accounts.*.accessToken`
|
|
- `channels.matrix.accounts.*.password`
|
|
- `channels.nextcloud-talk.botSecret`
|
|
- `channels.nextcloud-talk.apiPassword`
|
|
- `channels.nextcloud-talk.accounts.*.botSecret`
|
|
- `channels.nextcloud-talk.accounts.*.apiPassword`
|
|
- `channels.zalo.botToken`
|
|
- `channels.zalo.webhookSecret`
|
|
- `channels.zalo.accounts.*.botToken`
|
|
- `channels.zalo.accounts.*.webhookSecret`
|
|
- `channels.googlechat.serviceAccount` via sibling `serviceAccountRef` (compatibility exception)
|
|
- `channels.googlechat.accounts.*.serviceAccount` via sibling `serviceAccountRef` (compatibility exception)
|
|
|
|
### `auth-profiles.json` targets (`secrets configure` + `secrets apply` + `secrets audit`)
|
|
|
|
- `profiles.*.keyRef` (`type: "api_key"`; unsupported when `auth.profiles.<id>.mode = "oauth"`)
|
|
- `profiles.*.tokenRef` (`type: "token"`; unsupported when `auth.profiles.<id>.mode = "oauth"`)
|
|
|
|
[//]: # "secretref-supported-list-end"
|
|
|
|
Notes:
|
|
|
|
- Auth-profile plan targets require `agentId`.
|
|
- Plan entries target `profiles.*.key` / `profiles.*.token` and write sibling refs (`keyRef` / `tokenRef`).
|
|
- Auth-profile refs are included in runtime resolution and audit coverage.
|
|
- In `openclaw.json`, SecretRefs must use structured objects such as `{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}`. Legacy `secretref-env:<ENV_VAR>` marker strings are rejected on SecretRef credential paths; run `openclaw doctor --fix` to migrate valid markers.
|
|
- OAuth policy guard: `auth.profiles.<id>.mode = "oauth"` cannot be combined with SecretRef inputs for that profile. Startup/reload and auth-profile resolution fail fast when this policy is violated.
|
|
- For SecretRef-managed model providers, generated `agents/*/agent/models.json` entries persist non-secret markers (not resolved secret values) for `apiKey`/header surfaces.
|
|
- Marker persistence is source-authoritative: OpenClaw writes markers from the active source config snapshot (pre-resolution), not from resolved runtime secret values.
|
|
- For web search:
|
|
- In explicit provider mode (`tools.web.search.provider` set), only the selected provider key is active.
|
|
- In auto mode (`tools.web.search.provider` unset), only the first provider key that resolves by precedence is active.
|
|
- In auto mode, non-selected provider refs are treated as inactive until selected.
|
|
- Legacy `tools.web.search.*` provider paths still resolve during the compatibility window, but the canonical SecretRef surface is `plugins.entries.<plugin>.config.webSearch.*`.
|
|
|
|
## Unsupported credentials
|
|
|
|
Out-of-scope credentials include:
|
|
|
|
[//]: # "secretref-unsupported-list-start"
|
|
|
|
- `commands.ownerDisplaySecret`
|
|
- `hooks.token`
|
|
- `hooks.gmail.pushToken`
|
|
- `hooks.mappings[].sessionKey`
|
|
- `auth-profiles.oauth.*`
|
|
- `channels.discord.threadBindings.webhookToken`
|
|
- `channels.discord.accounts.*.threadBindings.webhookToken`
|
|
- `channels.whatsapp.creds.json`
|
|
- `channels.whatsapp.accounts.*.creds.json`
|
|
|
|
[//]: # "secretref-unsupported-list-end"
|
|
|
|
Rationale:
|
|
|
|
- These credentials are minted, rotated, session-bearing, or OAuth-durable classes that do not fit read-only external SecretRef resolution.
|
|
|
|
## Related
|
|
|
|
- [Secrets management](/gateway/secrets)
|
|
- [Auth credential semantics](/auth-credential-semantics)
|