Technical reference
Superficie delle credenziali SecretRef
Questa pagina definisce la superficie canonica delle credenziali SecretRef: quali campi delle credenziali accettano un SecretRef (un riferimento basato su env/file/exec) anziché un valore segreto non elaborato.
Ambito:
- Incluso nell'ambito: esclusivamente credenziali fornite dall'utente che OpenClaw non genera né ruota.
- Escluso dall'ambito: credenziali generate in fase di esecuzione o soggette a rotazione, materiale di aggiornamento OAuth e artefatti assimilabili a sessioni.
Gli elenchi seguenti sono generati dal registro delle destinazioni nel codice sorgente e verificati rispetto a docs/reference/secretref-user-supplied-credentials-matrix.json nella CI; non modificare manualmente le voci.
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.*.apiKeytalk.realtime.providers.*.apiKeymessages.tts.providers.*.apiKeytools.web.fetch.firecrawl.apiKeyplugins.entries.acpx.config.mcpServers.*.env.*plugins.entries.brave.config.webSearch.apiKeyplugins.entries.codex.config.appServer.authTokenplugins.entries.codex.config.appServer.headers.*plugins.entries.exa.config.webSearch.apiKeyplugins.entries.google-meet.config.realtime.providers.*.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.parallel.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.*.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.relay.authTokenchannels.slack.userTokenchannels.slack.signingSecretchannels.slack.accounts.*.botTokenchannels.slack.accounts.*.appTokenchannels.slack.accounts.*.relay.authTokenchannels.slack.accounts.*.userTokenchannels.slack.accounts.*.signingSecretchannels.sms.authTokenchannels.sms.accounts.*.authTokenchannels.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.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 di pari livelloserviceAccountRef(eccezione di compatibilità)channels.googlechat.accounts.*.serviceAccounttramite il campo di pari livelloserviceAccountRef(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 hanno come destinazioneprofiles.*.key/profiles.*.tokene scrivono i riferimenti di pari livello (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 utilizzare oggetti strutturati come{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}. Le stringhe marcatore obsoletesecretref-env:<ENV_VAR>vengono rifiutate nei percorsi delle credenziali SecretRef; eseguireopenclaw doctor --fixper migrare i marcatori validi. - Vincolo dei criteri OAuth:
auth.profiles.<id>.mode = "oauth"non può essere combinato con input SecretRef per quel profilo. L'avvio/ricaricamento e la risoluzione del profilo di autenticazione terminano immediatamente con un errore quando questo criterio viene violato. - Per i provider di modelli gestiti tramite SecretRef, le voci generate in
agents/*/agent/models.jsonconservano marcatori non segreti (non i valori segreti risolti) per le superficiapiKey/intestazioni. La persistenza dei marcatori è determinata dalla fonte: OpenClaw scrive i marcatori dall'istantanea della configurazione sorgente attiva (prima della risoluzione), non dai valori segreti risolti in fase di esecuzione. - Per la ricerca sul Web: in modalità provider esplicito (con
tools.web.search.providerimpostato), è attiva solo la chiave del provider selezionato. In modalità automatica (contools.web.search.providernon impostato), è attiva solo la prima chiave del provider risolta in base alla precedenza e i riferimenti dei provider non selezionati vengono considerati inattivi finché non sono selezionati. I percorsi obsoleti dei providertools.web.search.*continuano a essere risolti durante il periodo di compatibilità, ma la superficie SecretRef canonica èplugins.entries.<plugin>.config.webSearch.*.
Credenziali non supportate
Queste credenziali appartengono a categorie generate, soggette a rotazione, associate a sessioni o persistenti tramite OAuth, che non sono compatibili con la risoluzione esterna di SecretRef in sola lettura:
commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
Argomenti correlati
Was this useful?