SecretRef認証情報サーフェス
このページでは、正規のSecretRef認証情報サーフェスを定義します。 スコープの意図:- スコープ内: OpenClawが生成もローテーションもしない、厳密にユーザー提供の認証情報。
- スコープ外: ランタイムで生成される、またはローテーションされる認証情報、OAuth refresh素材、およびセッション類似のアーティファクト。
サポートされる認証情報
openclaw.json の対象(secrets configure + secrets apply + secrets audit)
models.providers.*.apiKeymodels.providers.*.headers.*models.providers.*.request.auth.tokenmodels.providers.*.request.auth.valuemodels.providers.*.request.headers.*models.providers.*.request.proxy.tls.camodels.providers.*.request.proxy.tls.certmodels.providers.*.request.proxy.tls.keymodels.providers.*.request.proxy.tls.passphrasemodels.providers.*.request.tls.camodels.providers.*.request.tls.certmodels.providers.*.request.tls.keymodels.providers.*.request.tls.passphraseskills.entries.*.apiKeyagents.defaults.memorySearch.remote.apiKeyagents.list[].memorySearch.remote.apiKeytalk.providers.*.apiKeymessages.tts.providers.*.apiKeytools.web.fetch.firecrawl.apiKeyplugins.entries.firecrawl.config.webFetch.apiKeyplugins.entries.brave.config.webSearch.apiKeyplugins.entries.google.config.webSearch.apiKeyplugins.entries.xai.config.webSearch.apiKeyplugins.entries.moonshot.config.webSearch.apiKeyplugins.entries.perplexity.config.webSearch.apiKeyplugins.entries.firecrawl.config.webSearch.apiKeyplugins.entries.minimax.config.webSearch.apiKeyplugins.entries.tavily.config.webSearch.apiKeytools.web.search.apiKeygateway.auth.passwordgateway.auth.tokengateway.remote.tokengateway.remote.passwordcron.webhookTokenchannels.telegram.botTokenchannels.telegram.webhookSecretchannels.telegram.accounts.*.botTokenchannels.telegram.accounts.*.webhookSecretchannels.slack.botTokenchannels.slack.appTokenchannels.slack.userTokenchannels.slack.signingSecretchannels.slack.accounts.*.botTokenchannels.slack.accounts.*.appTokenchannels.slack.accounts.*.userTokenchannels.slack.accounts.*.signingSecretchannels.discord.tokenchannels.discord.pluralkit.tokenchannels.discord.voice.tts.providers.*.apiKeychannels.discord.accounts.*.tokenchannels.discord.accounts.*.pluralkit.tokenchannels.discord.accounts.*.voice.tts.providers.*.apiKeychannels.irc.passwordchannels.irc.nickserv.passwordchannels.irc.accounts.*.passwordchannels.irc.accounts.*.nickserv.passwordchannels.bluebubbles.passwordchannels.bluebubbles.accounts.*.passwordchannels.feishu.appSecretchannels.feishu.encryptKeychannels.feishu.verificationTokenchannels.feishu.accounts.*.appSecretchannels.feishu.accounts.*.encryptKeychannels.feishu.accounts.*.verificationTokenchannels.msteams.appPasswordchannels.mattermost.botTokenchannels.mattermost.accounts.*.botTokenchannels.matrix.accessTokenchannels.matrix.passwordchannels.matrix.accounts.*.accessTokenchannels.matrix.accounts.*.passwordchannels.nextcloud-talk.botSecretchannels.nextcloud-talk.apiPasswordchannels.nextcloud-talk.accounts.*.botSecretchannels.nextcloud-talk.accounts.*.apiPasswordchannels.zalo.botTokenchannels.zalo.webhookSecretchannels.zalo.accounts.*.botTokenchannels.zalo.accounts.*.webhookSecretchannels.googlechat.serviceAccount(兄弟serviceAccountRef経由。互換性例外)channels.googlechat.accounts.*.serviceAccount(兄弟serviceAccountRef経由。互換性例外)
auth-profiles.json の対象(secrets configure + secrets apply + secrets audit)
profiles.*.keyRef(type: "api_key"。auth.profiles.<id>.mode = "oauth"の場合は非対応)profiles.*.tokenRef(type: "token"。auth.profiles.<id>.mode = "oauth"の場合は非対応)
- Auth-profileのplan targetには
agentIdが必要です。 - Plan entryは
profiles.*.key/profiles.*.tokenを対象とし、兄弟参照(keyRef/tokenRef)を書き込みます。 - Auth-profile参照は、ランタイム解決とaudit対象範囲に含まれます。
- OAuthポリシーガード:
auth.profiles.<id>.mode = "oauth"は、そのprofileに対するSecretRef入力と組み合わせられません。このポリシーに違反すると、startup/reloadおよびauth-profile解決は即座に失敗します。 - SecretRef管理のmodel providerでは、生成される
agents/*/agent/models.json項目は、apiKey/headerサーフェスに対して非シークレットのmarker(解決済みsecret値ではない)を永続化します。 - Markerの永続化はソース権威型です。OpenClawは、解決済みランタイムsecret値からではなく、アクティブなソースconfig snapshot(解決前)からmarkerを書き込みます。
- web searchについて:
- 明示的provider mode(
tools.web.search.providerが設定されている)では、選択されたprovider keyだけがアクティブです。 - auto mode(
tools.web.search.providerが未設定)では、優先順位に従って最初に解決されたprovider keyだけがアクティブです。 - auto modeでは、選択されなかったprovider参照は選択されるまで非アクティブとして扱われます。
- レガシーの
tools.web.search.*provider pathは互換期間中は引き続き解決されますが、正規のSecretRefサーフェスはplugins.entries.<plugin>.config.webSearch.*です。
- 明示的provider mode(
サポートされない認証情報
スコープ外の認証情報には次が含まれます。commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
- これらの認証情報は、生成されるもの、ローテーションされるもの、セッション保持型のもの、またはOAuth永続クラスであり、読み取り専用の外部SecretRef解決には適合しません。