Chuyển đến nội dung chính

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Trang này định nghĩa bề mặt thông tin xác thực SecretRef chuẩn. Ý định về phạm vi:
  • Trong phạm vi: chỉ các thông tin xác thực do người dùng cung cấp mà OpenClaw không cấp phát hoặc xoay vòng.
  • Ngoài phạm vi: thông tin xác thực được cấp phát trong thời gian chạy hoặc được xoay vòng, dữ liệu làm mới OAuth, và các hiện vật giống phiên.

Thông tin xác thực được hỗ trợ

Mục tiêu 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[].tts.providers.*.apiKey
  • agents.list[].memorySearch.remote.apiKey
  • talk.providers.*.apiKey
  • messages.tts.providers.*.apiKey
  • tools.web.fetch.firecrawl.apiKey
  • plugins.entries.acpx.config.mcpServers.*.env.*
  • plugins.entries.brave.config.webSearch.apiKey
  • plugins.entries.exa.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
  • plugins.entries.voice-call.config.tts.providers.*.apiKey
  • plugins.entries.voice-call.config.twilio.authToken
  • 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 qua serviceAccountRef cùng cấp (ngoại lệ tương thích)
  • channels.googlechat.accounts.*.serviceAccount qua serviceAccountRef cùng cấp (ngoại lệ tương thích)

Mục tiêu auth-profiles.json (secrets configure + secrets apply + secrets audit)

  • profiles.*.keyRef (type: "api_key"; không được hỗ trợ khi auth.profiles.<id>.mode = "oauth")
  • profiles.*.tokenRef (type: "token"; không được hỗ trợ khi auth.profiles.<id>.mode = "oauth")
Ghi chú:
  • Mục tiêu kế hoạch auth-profile yêu cầu agentId.
  • Mục nhập kế hoạch nhắm tới profiles.*.key / profiles.*.token và ghi các ref cùng cấp (keyRef / tokenRef).
  • Ref auth-profile được đưa vào phạm vi phân giải thời gian chạy và kiểm tra audit.
  • Trong openclaw.json, SecretRef phải dùng các đối tượng có cấu trúc như {"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}. Chuỗi đánh dấu cũ secretref-env:<ENV_VAR> bị từ chối trên đường dẫn thông tin xác thực SecretRef; chạy openclaw doctor --fix để di chuyển các marker hợp lệ.
  • Chốt chặn chính sách OAuth: không thể kết hợp auth.profiles.<id>.mode = "oauth" với đầu vào SecretRef cho hồ sơ đó. Khởi động/tải lại và phân giải auth-profile sẽ fail fast khi chính sách này bị vi phạm.
  • Đối với nhà cung cấp mô hình do SecretRef quản lý, các mục agents/*/agent/models.json được tạo sẽ lưu các marker không bí mật (không phải giá trị bí mật đã phân giải) cho các bề mặt apiKey/header.
  • Việc lưu marker lấy nguồn làm thẩm quyền: OpenClaw ghi marker từ ảnh chụp cấu hình nguồn đang hoạt động (trước khi phân giải), không phải từ giá trị bí mật thời gian chạy đã phân giải.
  • Đối với tìm kiếm web:
    • Trong chế độ nhà cung cấp rõ ràng (đã đặt tools.web.search.provider), chỉ khóa của nhà cung cấp đã chọn là hoạt động.
    • Trong chế độ tự động (chưa đặt tools.web.search.provider), chỉ khóa nhà cung cấp đầu tiên phân giải được theo thứ tự ưu tiên là hoạt động.
    • Trong chế độ tự động, ref của nhà cung cấp không được chọn được coi là không hoạt động cho đến khi được chọn.
    • Các đường dẫn nhà cung cấp tools.web.search.* cũ vẫn phân giải trong khoảng thời gian tương thích, nhưng bề mặt SecretRef chuẩn là plugins.entries.<plugin>.config.webSearch.*.

Thông tin xác thực không được hỗ trợ

Thông tin xác thực ngoài phạm vi bao gồm:
  • 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
Lý do:
  • Các thông tin xác thực này thuộc các lớp được cấp phát, xoay vòng, mang phiên, hoặc bền vững theo OAuth, nên không phù hợp với phân giải SecretRef bên ngoài chỉ đọc.

Liên quan