Technical reference
Superficie delle credenziali SecretRef
Questa pagina definisce la superficie canonica delle credenziali SecretRef.
Intento dell'ambito:
- Incluso nell'ambito: credenziali rigorosamente fornite dall'utente che OpenClaw non emette né ruota.
- Fuori ambito: credenziali emesse o ruotate in fase di esecuzione, materiale di aggiornamento OAuth e artefatti simili a sessioni.
Credenziali supportate
Destinazioni di 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[].tts.providers.*.apiKeyagents.list[].memorySearch.remote.apiKeytalk.providers.*.apiKeymessages.tts.providers.*.apiKeytools.web.fetch.firecrawl.apiKeyplugins.entries.acpx.config.mcpServers.*.env.*plugins.entries.brave.config.webSearch.apiKeyplugins.entries.exa.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.apiKeyplugins.entries.voice-call.config.realtime.providers.*.apiKeyplugins.entries.voice-call.config.streaming.providers.*.apiKeyplugins.entries.voice-call.config.tts.providers.*.apiKeyplugins.entries.voice-call.config.twilio.authTokentools.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.qqbot.clientSecretchannels.qqbot.accounts.*.clientSecretchannels.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.serviceAccounttramite il campo adiacenteserviceAccountRef(eccezione di compatibilità)channels.googlechat.accounts.*.serviceAccounttramite il campo adiacenteserviceAccountRef(eccezione di compatibilità)
Destinazioni di auth-profiles.json (secrets configure + secrets apply + secrets audit)
profiles.*.keyRef(type: "api_key"; non supportato quandoauth.profiles.<id>.mode = "oauth")profiles.*.tokenRef(type: "token"; non supportato quandoauth.profiles.<id>.mode = "oauth")
Note:
- Le destinazioni del piano dei profili di autenticazione richiedono
agentId. - Le voci del piano puntano a
profiles.*.key/profiles.*.tokene scrivono i riferimenti adiacenti (keyRef/tokenRef). - I riferimenti dei profili di autenticazione sono inclusi nella risoluzione in fase di esecuzione e nella copertura di audit.
- In
openclaw.json, i SecretRef devono usare oggetti strutturati come{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}. Le stringhe marker legacysecretref-env:<ENV_VAR>sono rifiutate nei percorsi delle credenziali SecretRef; eseguiopenclaw doctor --fixper migrare i marker validi. - Guardia della policy OAuth:
auth.profiles.<id>.mode = "oauth"non può essere combinato con input SecretRef per quel profilo. Avvio/ricaricamento e risoluzione dei profili di autenticazione falliscono rapidamente quando questa policy viene violata. - Per i provider di modelli gestiti da SecretRef, le voci
agents/*/agent/models.jsongenerate mantengono marker non segreti (non valori segreti risolti) per le superficiapiKey/header. - La persistenza dei marker è autorevole rispetto alla sorgente: OpenClaw scrive i marker dallo snapshot di configurazione sorgente attivo (prima della risoluzione), non dai valori segreti risolti in fase di esecuzione.
- Per la ricerca web:
- In modalità provider esplicita (
tools.web.search.providerimpostato), è attiva solo la chiave del provider selezionato. - In modalità automatica (
tools.web.search.providernon impostato), è attiva solo la prima chiave provider risolta in base alla precedenza. - In modalità automatica, i riferimenti dei provider non selezionati sono trattati come inattivi finché non vengono selezionati.
- I percorsi provider legacy
tools.web.search.*vengono ancora risolti durante la finestra di compatibilità, ma la superficie SecretRef canonica èplugins.entries.<plugin>.config.webSearch.*.
- In modalità provider esplicita (
Credenziali non supportate
Le credenziali fuori ambito includono:
commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
Motivazione:
- Queste credenziali appartengono a classi emesse, ruotate, portatrici di sessione o durevoli OAuth che non si adattano alla risoluzione SecretRef esterna in sola lettura.