> ## Documentation Index
> Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 密鑰套用計畫契約

本頁定義由 `openclaw secrets apply` 強制執行的嚴格契約。若目標不符合這些規則，套用作業會在變更任何檔案之前失敗。

## 計畫檔案需求

`openclaw secrets apply --from <plan.json>` 接受最大 16 MiB（16,777,216 位元組）的一般檔案。此限制適用於完整的序列化檔案，包括空白字元。目錄、FIFO、裝置檔案，以及超過限制的檔案，都會在解析 JSON 或驗證目標之前遭到拒絕。

`openclaw secrets configure --plan-out <plan.json>` 會在建立檔案之前，對 UTF-8 序列化輸出強制執行相同限制。手寫計畫和外部計畫產生器也必須確保序列化檔案不超過此界限。

## 計畫檔案格式

`openclaw secrets apply --from <plan.json>` 預期一個由計畫目標組成的 `targets` 陣列：

```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  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" },
    },
  ],
}
```

`openclaw secrets configure` 會產生此格式的計畫。你也可以手寫或編輯計畫。

## 提供者新增或更新與刪除

計畫也可以包含兩個選用的頂層欄位，在逐一寫入目標的同時變更 `secrets.providers` 對應：

* `providerUpserts` -- 以提供者別名為鍵的物件。每個值都是提供者定義（格式與 `openclaw.json` 中 `secrets.providers.<alias>` 所接受的格式相同，例如 `exec` 或 `file` 提供者）。
* `providerDeletes` -- 要移除的提供者別名陣列。

`providerUpserts` 會在 `targets` 之前執行，因此 `target.ref.provider` 可以參照同一份計畫在 `providerUpserts` 中新增的提供者別名。若沒有此順序，參照尚未在 `openclaw.json` 中設定之別名的計畫，會因 `provider "<alias>" is not configured` 而失敗。

```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  version: 1,
  protocolVersion: 1,
  providerUpserts: {
    onepassword_anthropic: {
      source: "exec",
      command: "/usr/bin/op",
      args: ["read", "op://Vault/Anthropic/credential"],
    },
  },
  providerDeletes: ["legacy_unused_alias"],
  targets: [
    {
      type: "models.providers.apiKey",
      path: "models.providers.anthropic.apiKey",
      pathSegments: ["models", "providers", "anthropic", "apiKey"],
      providerId: "anthropic",
      ref: { source: "exec", provider: "onepassword_anthropic", id: "credential" },
    },
  ],
}
```

透過 `providerUpserts` 新增的 exec 提供者，仍受[執行提供者同意行為](#exec-provider-consent-behavior)中的 exec 同意規則約束：包含 exec 提供者的計畫在寫入模式下需要 `--allow-exec`。

## 支援的目標範圍

計畫目標可用於 [SecretRef 認證資訊介面](/zh-TW/reference/secretref-credential-surface)中支援的認證資訊路徑。

## 目標類型行為

`target.type` 必須是可識別的目標類型，且正規化後的 `target.path` 必須符合該類型已註冊的路徑格式。

除了標準類型名稱之外，部分目標類型也接受 `target.type` 作為現有計畫的相容性別名：

| 標準類型                                 | 接受的別名                                           |
| ------------------------------------ | ----------------------------------------------- |
| `models.providers.apiKey`            | `models.providers.*.apiKey`                     |
| `skills.entries.apiKey`              | `skills.entries.*.apiKey`                       |
| `channels.googlechat.serviceAccount` | `channels.googlechat.accounts.*.serviceAccount` |

## 路徑驗證規則

每個目標都會依照下列所有規則進行驗證：

* `type` 必須是可識別的目標類型。
* `path` 必須是非空白的點號路徑。
* `pathSegments` 可以省略。若有提供，正規化後必須與 `path` 的路徑完全相同。
* 禁止的區段會遭到拒絕：`__proto__`、`prototype`、`constructor`。
* 正規化後的路徑必須符合目標類型已註冊的路徑格式。
* 若已設定 `providerId` 或 `accountId`，其值必須符合路徑中編碼的 ID。
* `auth-profiles.json` 目標需要 `agentId`。
* 建立新的 `auth-profiles.json` 對應時，請包含 `authProfileProvider`。

## 失敗行為

若目標驗證失敗，套用作業會結束並顯示類似以下的錯誤：

```text theme={"theme":{"light":"min-light","dark":"min-dark"}}
models.providers.apiKey 的計畫目標路徑無效：models.providers.openai.baseUrl
```

無效的計畫不會提交任何寫入：在接觸任何檔案之前，系統會先執行目標解析和路徑驗證。另外，有效計畫開始寫入後，套用作業會先建立每個受影響檔案的快照；若同一次執行中的後續寫入失敗，便會還原這些快照，因此局部寫入絕不會造成設定、驗證設定檔或環境狀態不同步。

## 執行提供者同意行為

* `--dry-run` 預設會略過 exec SecretRef 檢查。
* 在寫入模式下，除非已設定 `--allow-exec`，否則包含 exec SecretRef／提供者的計畫會遭到拒絕。
* 驗證或套用包含 exec 的計畫時，請在試執行和寫入命令中都傳入 `--allow-exec`。

## 執行階段與稽核範圍注意事項

* 僅含參照的 `auth-profiles.json` 項目（`keyRef`／`tokenRef`）會納入執行階段認證資訊解析與稽核涵蓋範圍。
* `secrets apply` 會寫入支援的 `openclaw.json` 目標、支援的 `auth-profiles.json` 目標，以及三個選用的清除階段；每個階段預設都會啟用：`scrubEnv`（從有效狀態和使用中設定目錄內的 `.env` 檔案移除已遷移的純文字值）、`scrubAuthProfilesForProviderTargets`（針對計畫剛遷移的提供者，清除 `auth-profiles.json` 中的純文字／未使用參照殘留項目），以及 `scrubLegacyAuthJson`（從舊版 `auth.json` 儲存區移除已遷移的 `api_key` 項目）。在計畫中將 `options.scrubEnv`、`options.scrubAuthProfilesForProviderTargets`、`options.scrubLegacyAuthJson` 中的任一項設為 `false`，即可略過對應階段。

## 操作人員檢查

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
# 在不寫入的情況下驗證計畫
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --dry-run

# 接著實際套用
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json

# 對於包含 exec 的計畫，請在兩種模式中明確選擇加入
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --dry-run --allow-exec
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --allow-exec
```

若套用作業失敗並顯示目標路徑無效訊息，請使用 `openclaw secrets configure` 重新產生計畫，或將目標路徑修正為上述支援的格式。

## 相關文件

* [密鑰管理](/zh-TW/gateway/secrets)
* [命令列介面 `secrets`](/zh-TW/cli/secrets)
* [SecretRef 認證資訊介面](/zh-TW/reference/secretref-credential-surface)
* [設定參考](/zh-TW/gateway/configuration-reference)