Superfície de credenciais do SecretRef

Esta página define a superfície canônica de credenciais SecretRef.

Intenção de escopo:

• No escopo: credenciais estritamente fornecidas pelo usuário que o OpenClaw não emite nem alterna.
• Fora do escopo: credenciais emitidas em tempo de execução ou rotativas, material de atualização OAuth e artefatos semelhantes a sessões.

# Credenciais compatíveis

# Destinos de 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[].tts.providers.*.apiKey
• agents.list[].memorySearch.remote.apiKey
• talk.providers.*.apiKey
• messages.tts.providers.*.apiKey
• tools.web.fetch.firecrawl.apiKey
• plugins.entries.acpx.config.mcpServers.*.env.*
• plugins.entries.brave.config.webSearch.apiKey
• plugins.entries.exa.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
• plugins.entries.voice-call.config.realtime.providers.*.apiKey
• plugins.entries.voice-call.config.streaming.providers.*.apiKey
• plugins.entries.voice-call.config.tts.providers.*.apiKey
• plugins.entries.voice-call.config.twilio.authToken
• 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.qqbot.clientSecret
• channels.qqbot.accounts.*.clientSecret
• 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 via serviceAccountRef irmão (exceção de compatibilidade)
• channels.googlechat.accounts.*.serviceAccount via serviceAccountRef irmão (exceção de compatibilidade)

# Destinos de auth-profiles.json (secrets configure + secrets apply + secrets audit)

• profiles.*.keyRef (type: "api_key"; sem suporte quando auth.profiles.<id>.mode = "oauth")
• profiles.*.tokenRef (type: "token"; sem suporte quando auth.profiles.<id>.mode = "oauth")

Observações:

• Destinos de plano de perfil de autenticação exigem agentId.
• Entradas de plano apontam para profiles.*.key / profiles.*.token e gravam referências irmãs (keyRef / tokenRef).
• Referências de perfil de autenticação são incluídas na resolução em tempo de execução e na cobertura de auditoria.
• Em openclaw.json, SecretRefs devem usar objetos estruturados como {"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}. Strings marcadoras legadas secretref-env:<ENV_VAR> são rejeitadas em caminhos de credenciais SecretRef; execute openclaw doctor --fix para migrar marcadores válidos.
• Proteção da política OAuth: auth.profiles.<id>.mode = "oauth" não pode ser combinado com entradas SecretRef para esse perfil. Inicialização/recarregamento e resolução de perfil de autenticação falham rapidamente quando essa política é violada.
• Para provedores de modelo gerenciados por SecretRef, as entradas geradas de agents/*/agent/models.json persistem marcadores não secretos (não valores secretos resolvidos) para superfícies apiKey/cabeçalho.
• A persistência de marcadores é autoritativa pela fonte: o OpenClaw grava marcadores a partir do snapshot de configuração da fonte ativa (pré-resolução), não a partir de valores secretos resolvidos em tempo de execução.
• Para busca na Web:
  • No modo de provedor explícito (tools.web.search.provider definido), somente a chave do provedor selecionado fica ativa.
  • No modo automático (tools.web.search.provider não definido), somente a primeira chave de provedor que resolve por precedência fica ativa.
  • No modo automático, referências de provedores não selecionados são tratadas como inativas até serem selecionadas.
  • Caminhos legados de provedor tools.web.search.* ainda são resolvidos durante a janela de compatibilidade, mas a superfície canônica SecretRef é plugins.entries.<plugin>.config.webSearch.*.

# Credenciais sem suporte

Credenciais fora do escopo incluem:

• 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

Justificativa:

• Essas credenciais pertencem a classes emitidas, rotativas, portadoras de sessão ou duráveis de OAuth que não se ajustam à resolução externa somente leitura de SecretRef.

# Relacionado

• Gerenciamento de segredos
• Semântica de credenciais de autenticação