Technical reference
سطح اعتبارنامه SecretRef
این صفحه سطح معتبر اعتبارنامهی SecretRef را تعریف میکند.
قصد دامنه:
- در دامنه: صرفاً اعتبارنامههای ارائهشده توسط کاربر که OpenClaw آنها را صادر یا چرخش نمیکند.
- خارج از دامنه: اعتبارنامههای صادرشده در زمان اجرا یا دارای چرخش، مواد refresh مربوط به OAuth، و مصنوعات شبیه نشست.
اعتبارنامههای پشتیبانیشده
هدفهای 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.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 به
agentIdنیاز دارند. - ورودیهای طرح
profiles.*.key/profiles.*.tokenرا هدف میگیرند و refهای همتا (keyRef/tokenRef) را مینویسند. - refهای auth-profile در تفکیک زمان اجرا و پوشش audit گنجانده میشوند.
- در
openclaw.json، SecretRefها باید از شیءهای ساختیافته مانند{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}استفاده کنند. رشتههای نشانگر قدیمیsecretref-env:<ENV_VAR>در مسیرهای اعتبارنامهی SecretRef رد میشوند؛ برای مهاجرت نشانگرهای معتبر،openclaw doctor --fixرا اجرا کنید. - نگهبان سیاست OAuth:
auth.profiles.<id>.mode = "oauth"نمیتواند با ورودیهای SecretRef برای همان profile ترکیب شود. startup/reload و تفکیک auth-profile وقتی این سیاست نقض شود سریعاً شکست میخورند. - برای ارائهدهندگان مدل مدیریتشده با SecretRef، ورودیهای تولیدشدهی
agents/*/agent/models.jsonنشانگرهای غیرمحرمانه (نه مقدارهای محرمانهی تفکیکشده) را برای سطحهایapiKey/header نگه میدارند. - پایداری نشانگر بر اساس منبع معتبر است: OpenClaw نشانگرها را از snapshot پیکربندی منبع فعال (پیش از تفکیک) مینویسد، نه از مقدارهای محرمانهی تفکیکشده در زمان اجرا.
- برای جستوجوی وب:
- در حالت ارائهدهندهی صریح (
tools.web.search.providerتنظیم شده)، فقط کلید ارائهدهندهی انتخابشده فعال است. - در حالت خودکار (
tools.web.search.providerتنظیم نشده)، فقط نخستین کلید ارائهدهندهای که بر اساس تقدم تفکیک میشود فعال است. - در حالت خودکار، refهای ارائهدهندههای انتخابنشده تا زمان انتخاب غیرفعال تلقی میشوند.
- مسیرهای قدیمی ارائهدهندهی
tools.web.search.*همچنان در پنجرهی سازگاری تفکیک میشوند، اما سطح معتبر SecretRef برابر باplugins.entries.<plugin>.config.webSearch.*است.
- در حالت ارائهدهندهی صریح (
اعتبارنامههای پشتیبانینشده
اعتبارنامههای خارج از دامنه شامل موارد زیر هستند:
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 خارجی فقطخواندنی سازگار نیستند.