mirror of
https://github.com/openclaw/openclaw.git
synced 2026-03-13 11:00:50 +00:00
806803b7ef
* feat(secrets): expand secret target coverage and gateway tooling * docs(secrets): align gateway and CLI secret docs * chore(protocol): regenerate swift gateway models for secrets methods * fix(config): restore talk apiKey fallback and stabilize runner test * ci(windows): reduce test worker count for shard stability * ci(windows): raise node heap for test shard stability * test(feishu): make proxy env precedence assertion windows-safe * fix(gateway): resolve auth password SecretInput refs for clients * fix(gateway): resolve remote SecretInput credentials for clients * fix(secrets): skip inactive refs in command snapshot assignments * fix(secrets): scope gateway.remote refs to effective auth surfaces * fix(secrets): ignore memory defaults when enabled agents disable search * fix(secrets): honor Google Chat serviceAccountRef inheritance * fix(secrets): address tsgo errors in command and gateway collectors * fix(secrets): avoid auth-store load in providers-only configure * fix(gateway): defer local password ref resolution by precedence * fix(secrets): gate telegram webhook secret refs by webhook mode * fix(secrets): gate slack signing secret refs to http mode * fix(secrets): skip telegram botToken refs when tokenFile is set * fix(secrets): gate discord pluralkit refs by enabled flag * fix(secrets): gate discord voice tts refs by voice enabled * test(secrets): make runtime fixture modes explicit * fix(cli): resolve local qr password secret refs * fix(cli): fail when gateway leaves command refs unresolved * fix(gateway): fail when local password SecretRef is unresolved * fix(gateway): fail when required remote SecretRefs are unresolved * fix(gateway): resolve local password refs only when password can win * fix(cli): skip local password SecretRef resolution on qr token override * test(gateway): cast SecretRef fixtures to OpenClawConfig * test(secrets): activate mode-gated targets in runtime coverage fixture * fix(cron): support SecretInput webhook tokens safely * fix(bluebubbles): support SecretInput passwords across config paths * fix(msteams): make appPassword SecretInput-safe in onboarding/token paths * fix(bluebubbles): align SecretInput schema helper typing * fix(cli): clarify secrets.resolve version-skew errors * refactor(secrets): return structured inactive paths from secrets.resolve * refactor(gateway): type onboarding secret writes as SecretInput * chore(protocol): regenerate swift models for secrets.resolve * feat(secrets): expand extension credential secretref support * fix(secrets): gate web-search refs by active provider * fix(onboarding): detect SecretRef credentials in extension status * fix(onboarding): allow keeping existing ref in secret prompt * fix(onboarding): resolve gateway password SecretRefs for probe and tui * fix(onboarding): honor secret-input-mode for local gateway auth * fix(acp): resolve gateway SecretInput credentials * fix(secrets): gate gateway.remote refs to remote surfaces * test(secrets): cover pattern matching and inactive array refs * docs(secrets): clarify secrets.resolve and remote active surfaces * fix(bluebubbles): keep existing SecretRef during onboarding * fix(tests): resolve CI type errors in new SecretRef coverage * fix(extensions): replace raw fetch with SSRF-guarded fetch * test(secrets): mark gateway remote targets active in runtime coverage * test(infra): normalize home-prefix expectation across platforms * fix(cli): only resolve local qr password refs in password mode * test(cli): cover local qr token mode with unresolved password ref * docs(cli): clarify local qr password ref resolution behavior * refactor(extensions): reuse sdk SecretInput helpers * fix(wizard): resolve onboarding env-template secrets before plaintext * fix(cli): surface secrets.resolve diagnostics in memory and qr * test(secrets): repair post-rebase runtime and fixtures * fix(gateway): skip remote password ref resolution when token wins * fix(secrets): treat tailscale remote gateway refs as active * fix(gateway): allow remote password fallback when token ref is unresolved * fix(gateway): ignore stale local password refs for none and trusted-proxy * fix(gateway): skip remote secret ref resolution on local call paths * test(cli): cover qr remote tailscale secret ref resolution * fix(secrets): align gateway password active-surface with auth inference * fix(cli): resolve inferred local gateway password refs in qr * fix(gateway): prefer resolvable remote password over token ref pre-resolution * test(gateway): cover none and trusted-proxy stale password refs * docs(secrets): sync qr and gateway active-surface behavior * fix: restore stability blockers from pre-release audit * Secrets: fix collector/runtime precedence contradictions * docs: align secrets and web credential docs * fix(rebase): resolve integration regressions after main rebase * fix(node-host): resolve gateway secret refs for auth * fix(secrets): harden secretinput runtime readers * gateway: skip inactive auth secretref resolution * cli: avoid gateway preflight for inactive secret refs * extensions: allow unresolved refs in onboarding status * tests: fix qr-cli module mock hoist ordering * Security: align audit checks with SecretInput resolution * Gateway: resolve local-mode remote fallback secret refs * Node host: avoid resolving inactive password secret refs * Secrets runtime: mark Slack appToken inactive for HTTP mode * secrets: keep inactive gateway remote refs non-blocking * cli: include agent memory secret targets in runtime resolution * docs(secrets): sync docs with active-surface and web search behavior * fix(secrets): keep telegram top-level token refs active for blank account tokens * fix(daemon): resolve gateway password secret refs for probe auth * fix(secrets): skip IRC NickServ ref resolution when NickServ is disabled * fix(secrets): align token inheritance and exec timeout defaults * docs(secrets): clarify active-surface notes in cli docs * cli: require secrets.resolve gateway capability * gateway: log auth secret surface diagnostics * secrets: remove dead provider resolver module * fix(secrets): restore gateway auth precedence and fallback resolution * fix(tests): align plugin runtime mock typings --------- Co-authored-by: Peter Steinberger <steipete@gmail.com>
107 lines
3.3 KiB
Markdown
107 lines
3.3 KiB
Markdown
---
|
|
summary: "Contract for `secrets apply` plans: target validation, path matching, and `auth-profiles.json` target scope"
|
|
read_when:
|
|
- Generating or reviewing `openclaw secrets apply` plans
|
|
- Debugging `Invalid plan target path` errors
|
|
- Understanding target type and path validation behavior
|
|
title: "Secrets Apply Plan Contract"
|
|
---
|
|
|
|
# Secrets apply plan contract
|
|
|
|
This page defines the strict contract enforced by `openclaw secrets apply`.
|
|
|
|
If a target does not match these rules, apply fails before mutating configuration.
|
|
|
|
## Plan file shape
|
|
|
|
`openclaw secrets apply --from <plan.json>` expects a `targets` array of plan targets:
|
|
|
|
```json5
|
|
{
|
|
version: 1,
|
|
protocolVersion: 1,
|
|
targets: [
|
|
{
|
|
type: "models.providers.apiKey",
|
|
path: "models.providers.openai.apiKey",
|
|
pathSegments: ["models", "providers", "openai", "apiKey"],
|
|
providerId: "openai",
|
|
ref: { source: "env", provider: "default", id: "OPENAI_API_KEY" },
|
|
},
|
|
{
|
|
type: "auth-profiles.api_key.key",
|
|
path: "profiles.openai:default.key",
|
|
pathSegments: ["profiles", "openai:default", "key"],
|
|
agentId: "main",
|
|
ref: { source: "env", provider: "default", id: "OPENAI_API_KEY" },
|
|
},
|
|
],
|
|
}
|
|
```
|
|
|
|
## Supported target scope
|
|
|
|
Plan targets are accepted for supported credential paths in:
|
|
|
|
- [SecretRef Credential Surface](/reference/secretref-credential-surface)
|
|
|
|
## Target type behavior
|
|
|
|
General rule:
|
|
|
|
- `target.type` must be recognized and must match the normalized `target.path` shape.
|
|
|
|
Compatibility aliases remain accepted for existing plans:
|
|
|
|
- `models.providers.apiKey`
|
|
- `skills.entries.apiKey`
|
|
- `channels.googlechat.serviceAccount`
|
|
|
|
## Path validation rules
|
|
|
|
Each target is validated with all of the following:
|
|
|
|
- `type` must be a recognized target type.
|
|
- `path` must be a non-empty dot path.
|
|
- `pathSegments` can be omitted. If provided, it must normalize to exactly the same path as `path`.
|
|
- Forbidden segments are rejected: `__proto__`, `prototype`, `constructor`.
|
|
- The normalized path must match the registered path shape for the target type.
|
|
- If `providerId` or `accountId` is set, it must match the id encoded in the path.
|
|
- `auth-profiles.json` targets require `agentId`.
|
|
- When creating a new `auth-profiles.json` mapping, include `authProfileProvider`.
|
|
|
|
## Failure behavior
|
|
|
|
If a target fails validation, apply exits with an error like:
|
|
|
|
```text
|
|
Invalid plan target path for models.providers.apiKey: models.providers.openai.baseUrl
|
|
```
|
|
|
|
No writes are committed for an invalid plan.
|
|
|
|
## Runtime and audit scope notes
|
|
|
|
- Ref-only `auth-profiles.json` entries (`keyRef`/`tokenRef`) are included in runtime resolution and audit coverage.
|
|
- `secrets apply` writes supported `openclaw.json` targets, supported `auth-profiles.json` targets, and optional scrub targets.
|
|
|
|
## Operator checks
|
|
|
|
```bash
|
|
# Validate plan without writes
|
|
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --dry-run
|
|
|
|
# Then apply for real
|
|
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json
|
|
```
|
|
|
|
If apply fails with an invalid target path message, regenerate the plan with `openclaw secrets configure` or fix the target path to a supported shape above.
|
|
|
|
## Related docs
|
|
|
|
- [Secrets Management](/gateway/secrets)
|
|
- [CLI `secrets`](/cli/secrets)
|
|
- [SecretRef Credential Surface](/reference/secretref-credential-surface)
|
|
- [Configuration Reference](/gateway/configuration-reference)
|