Saltar al contenido principal

Superficie de credenciales SecretRef

Esta página define la superficie canónica de credenciales SecretRef. Intención del alcance:
  • En alcance: credenciales estrictamente proporcionadas por el usuario que OpenClaw no emite ni rota.
  • Fuera de alcance: credenciales emitidas en tiempo de ejecución o rotativas, material de actualización de OAuth y artefactos similares a sesiones.

Credenciales compatibles

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[].memorySearch.remote.apiKey
  • talk.providers.*.apiKey
  • messages.tts.providers.*.apiKey
  • tools.web.fetch.firecrawl.apiKey
  • plugins.entries.firecrawl.config.webFetch.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 mediante el serviceAccountRef relacionado (excepción de compatibilidad)
  • channels.googlechat.accounts.*.serviceAccount mediante el serviceAccountRef relacionado (excepción de compatibilidad)

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

  • profiles.*.keyRef (type: "api_key"; no compatible cuando auth.profiles.<id>.mode = "oauth")
  • profiles.*.tokenRef (type: "token"; no compatible cuando auth.profiles.<id>.mode = "oauth")
Notas:
  • Los destinos del plan de perfil de autenticación requieren agentId.
  • Las entradas del plan apuntan a profiles.*.key / profiles.*.token y escriben referencias relacionadas (keyRef / tokenRef).
  • Las referencias de perfil de autenticación se incluyen en la resolución en tiempo de ejecución y en la cobertura de auditoría.
  • Protección de política de OAuth: auth.profiles.<id>.mode = "oauth" no puede combinarse con entradas de SecretRef para ese perfil. El inicio/la recarga y la resolución del perfil de autenticación fallan rápidamente cuando se viola esta política.
  • Para los proveedores de modelos administrados por SecretRef, las entradas generadas de agents/*/agent/models.json conservan marcadores no secretos (no valores secretos resueltos) para las superficies de apiKey/encabezados.
  • La persistencia de marcadores es autoritativa según la fuente: OpenClaw escribe marcadores desde la instantánea activa de la configuración de origen (antes de la resolución), no desde los valores secretos resueltos en tiempo de ejecución.
  • Para la búsqueda web:
    • En el modo de proveedor explícito (tools.web.search.provider establecido), solo la clave del proveedor seleccionado está activa.
    • En el modo automático (tools.web.search.provider no establecido), solo está activa la primera clave de proveedor que se resuelve por precedencia.
    • En el modo automático, las referencias de proveedores no seleccionados se tratan como inactivas hasta que se seleccionan.
    • Las rutas heredadas de proveedor tools.web.search.* todavía se resuelven durante la ventana de compatibilidad, pero la superficie canónica de SecretRef es plugins.entries.<plugin>.config.webSearch.*.

Credenciales no compatibles

Las credenciales fuera de alcance incluyen:
  • 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
Justificación:
  • Estas credenciales pertenecen a clases emitidas, rotativas, portadoras de sesión o duraderas de OAuth que no encajan con la resolución externa de SecretRef de solo lectura.