メインコンテンツへスキップ

SecretRef認証情報サーフェス

このページでは、正規のSecretRef認証情報サーフェスを定義します。 スコープの意図:
  • 対象内: OpenClawが発行またはローテーションしない、厳密にユーザー提供の認証情報。
  • 対象外: ランタイムで発行またはローテーションされる認証情報、OAuthリフレッシュ情報、セッション類似アーティファクト。

サポートされる認証情報

openclaw.json 対象(secrets configure + secrets apply + secrets audit

  • 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[].memorySearch.remote.apiKey
  • talk.providers.*.apiKey
  • messages.tts.providers.*.apiKey
  • tools.web.fetch.firecrawl.apiKey
  • plugins.entries.brave.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
  • 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.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.bluebubbles.password
  • channels.bluebubbles.accounts.*.password
  • channels.feishu.appSecret
  • channels.feishu.encryptKey
  • channels.feishu.verificationToken
  • channels.feishu.accounts.*.appSecret
  • channels.feishu.accounts.*.encryptKey
  • channels.feishu.accounts.*.verificationToken
  • 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 は兄弟 serviceAccountRef 経由(互換性例外)
  • channels.googlechat.accounts.*.serviceAccount は兄弟 serviceAccountRef 経由(互換性例外)

auth-profiles.json 対象(secrets configure + secrets apply + secrets audit

  • profiles.*.keyReftype: "api_key"; auth.profiles.<id>.mode = "oauth" の場合は非サポート)
  • profiles.*.tokenReftype: "token"; auth.profiles.<id>.mode = "oauth" の場合は非サポート)
注記:
  • Auth-profile plan対象には agentId が必要です。
  • Planエントリは profiles.*.key / profiles.*.token を対象にし、兄弟ref(keyRef / tokenRef)を書き込みます。
  • Auth-profile ref はランタイム解決および監査カバレッジに含まれます。
  • OAuthポリシーガード: auth.profiles.<id>.mode = "oauth" は、そのプロファイルに対するSecretRef入力と組み合わせることはできません。このポリシーに違反した場合、起動/リロードおよびauth-profile解決は即座に失敗します。
  • SecretRef管理のモデルプロバイダーでは、生成される agents/*/agent/models.json エントリは、apiKey/headerサーフェスに対して秘密値の代わりに非シークレットのマーカーを永続化します(解決済みのシークレット値は保存しません)。
  • マーカー永続化はソースを正として行われます: OpenClawは、解決済みランタイムシークレット値からではなく、アクティブなソース設定スナップショット(解決前)からマーカーを書き込みます。
  • Web検索について:
    • 明示的プロバイダーモード(tools.web.search.provider が設定されている)では、選択されたプロバイダーキーのみがアクティブです。
    • 自動モード(tools.web.search.provider が未設定)では、優先順位で解決される最初のプロバイダーキーのみがアクティブです。
    • 自動モードでは、非選択のプロバイダーrefは選択されるまで非アクティブとして扱われます。
    • レガシーな tools.web.search.* プロバイダーパスは互換期間中は引き続き解決されますが、正規のSecretRefサーフェスは plugins.entries.<plugin>.config.webSearch.* です。

サポートされない認証情報

対象外の認証情報には次が含まれます:
  • 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
理由:
  • これらの認証情報は、発行される、ローテーションされる、セッションを保持する、またはOAuthの永続クラスに属しており、読み取り専用の外部SecretRef解決には適合しません。