跳到內容

掌握 openclaw secrets:讓你的金鑰管理更安全、更簡單

你是否曾經在程式碼或設定檔中翻找過期或寫死的 API 金鑰?或者在更新金鑰後,卻發現服務還在抓舊的資料?管理金鑰最怕的就是明文外洩,或是設定檔散落在各處導致維護困難。這類問題不僅讓開發流程變慢,更可能造成嚴重的安全隱患。

openclaw secrets 就是為了幫你解決這些煩惱而設計的,它能幫你管理 SecretRefs,並確保 Gateway 的 runtime 狀態保持健康。

  • 已經安裝並可執行的 OpenClaw 環境
  • 具備 TTY 互動終端機(執行 configure 時需要)
  • 基本的 openclaw.json 與 auth-profiles.json 設定權限

如果你想快速上手,可以按照這個建議的操作流程走一遍:

Terminal window
# 1. 檢查是否有明文或錯誤
openclaw secrets audit --check
# 2. 啟動互動式配置
openclaw secrets configure
# 3. 先測試看看(Dry-run)
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --dry-run
# 4. 正式套用變更
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json
# 5. 再次稽核確保乾淨
openclaw secrets audit --check
# 6. 重新載入 Gateway 狀態
openclaw secrets reload

audit 功能會掃描你的 OpenClaw 狀態,找出以下問題:

  • 儲存在設定中的明文金鑰
  • 尚未解析的 SecretRefs
  • 優先級衝突(例如 auth-profiles.json 覆蓋了 openclaw.json 的設定)
  • 殘留在 agents/*/agent/models.json 中的敏感資訊
  • 舊版的 auth.json 殘留物

如果你在 CI 流程中使用,--check 參數非常有用。當發現問題時它會回傳 1,若有未解析的 refs 則會回傳 2。

Terminal window
openclaw secrets audit --check

這是一個互動式的規劃工具,會帶你一步步完成設定。流程包含:

  • Provider 設定:新增、編輯或移除 secrets.providers。
  • Credential 映射:選擇欄位並指派 {source, provider, id}。
  • Preflight 檢查:在正式套用前進行驗證。

常用參數:

  • --providers-only:只設定 provider,跳過憑證映射。
  • --skip-provider-setup:跳過 provider 設定,直接對應到現有的 provider。
  • --agent <id>:將範圍限制在特定的 agent。

注意:這項指令需要互動式 TTY 環境。如果你在 Windows 上且無法驗證 ACL,OpenClaw 會為了安全而停止運作,此時你可能需要對特定 provider 設定 allowInsecurePath: true。

當你透過 configure 產生計畫檔案後,就可以使用 apply 來執行。它會更新 openclaw.json、auth-profiles.json 並清除舊有的明文殘留。

Terminal window
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json

為什麼沒有備份還原功能? secrets apply 故意不寫入包含舊明文值的備份檔。安全保障來自於嚴格的 preflight 檢查,以及失敗時盡力嘗試的記憶體內還原機制。

當你完成所有設定後,使用 reload 透過 RPC 方法 secrets.reload 觸發 Gateway。它會重新解析所有 refs 並原子化地切換 runtime 快照。如果解析失敗,Gateway 會保留最後一個正常的快照,確保服務不中斷。

Terminal window
openclaw secrets reload
  • Audit 回傳非零狀態碼:代表掃描到了明文或未解析的 refs。請根據回報的路徑更新設定後重新執行。
  • Reload 失敗:Gateway 會回傳錯誤訊息,並包含 warningCount。此時會繼續使用舊的快照,請檢查 provider 連線是否正常。
  • Exec Provider 安全錯誤:如果你使用 Homebrew 安裝的 binary(路徑通常在 /opt/homebrew/bin/*),請確保設定了 allowSymlinkCommand: true 並搭配 trustedDirs 使用。

如果你在設定過程中遇到困難,可以隨時諮詢 AI Setup Assistant。

OpenClaw

OpenClaw Expert

還是卡住了?

如果這篇文件沒有解決你的情境,直接問 OpenClaw Expert,拿到可執行步驟。