Technical reference
سطح اعتبارنامه SecretRef
این صفحه سطح اعتبارنامه استاندارد SecretRef را تعریف میکند.
هدف دامنه:
- در دامنه: صرفاً اعتبارنامههای ارائهشده توسط کاربر که OpenClaw آنها را صادر یا چرخش نمیدهد.
- خارج از دامنه: اعتبارنامههای صادرشده یا چرخشی در زمان اجرا، مواد نوسازی 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.*.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.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"پشتیبانی نمیشود)
یادداشتها:
- اهداف طرح نمایه احراز هویت به
agentIdنیاز دارند. - ورودیهای طرح،
profiles.*.key/profiles.*.tokenرا هدف میگیرند و ارجاعهای همسطح (keyRef/tokenRef) را مینویسند. - ارجاعهای نمایه احراز هویت در پوشش حلوفصل زمان اجرا و ممیزی گنجانده شدهاند.
- در
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 برای همان نمایه ترکیب شود. راهاندازی/بارگذاری مجدد و حلوفصل نمایه احراز هویت هنگام نقض این سیاست سریع شکست میخورند. - برای ارائهدهندگان مدل مدیریتشده با SecretRef، ورودیهای تولیدشده
agents/*/agent/models.jsonنشانگرهای غیرمحرمانه (نه مقادیر محرمانه حلشده) را برای سطحهایapiKey/header پایدار میکنند. - پایداری نشانگر از نظر منبع معتبر است: OpenClaw نشانگرها را از اسنپشات پیکربندی منبع فعال (پیش از حلوفصل) مینویسد، نه از مقادیر محرمانه حلشده در زمان اجرا.
- برای جستجوی وب:
- در حالت ارائهدهنده صریح (
tools.web.search.providerتنظیم شده)، فقط کلید ارائهدهنده انتخابشده فعال است. - در حالت خودکار (
tools.web.search.providerتنظیم نشده)، فقط نخستین کلید ارائهدهنده که بر اساس تقدم حل میشود فعال است. - در حالت خودکار، ارجاعهای ارائهدهنده انتخابنشده تا زمان انتخاب، غیرفعال در نظر گرفته میشوند.
- مسیرهای ارائهدهنده قدیمی
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 سازگار نیستند.
مرتبط
Was this useful?