feat(secrets): expand SecretRef coverage across user-supplied credentials (#29580)

* feat(secrets): expand secret target coverage and gateway tooling

* docs(secrets): align gateway and CLI secret docs

* chore(protocol): regenerate swift gateway models for secrets methods

* fix(config): restore talk apiKey fallback and stabilize runner test

* ci(windows): reduce test worker count for shard stability

* ci(windows): raise node heap for test shard stability

* test(feishu): make proxy env precedence assertion windows-safe

* fix(gateway): resolve auth password SecretInput refs for clients

* fix(gateway): resolve remote SecretInput credentials for clients

* fix(secrets): skip inactive refs in command snapshot assignments

* fix(secrets): scope gateway.remote refs to effective auth surfaces

* fix(secrets): ignore memory defaults when enabled agents disable search

* fix(secrets): honor Google Chat serviceAccountRef inheritance

* fix(secrets): address tsgo errors in command and gateway collectors

* fix(secrets): avoid auth-store load in providers-only configure

* fix(gateway): defer local password ref resolution by precedence

* fix(secrets): gate telegram webhook secret refs by webhook mode

* fix(secrets): gate slack signing secret refs to http mode

* fix(secrets): skip telegram botToken refs when tokenFile is set

* fix(secrets): gate discord pluralkit refs by enabled flag

* fix(secrets): gate discord voice tts refs by voice enabled

* test(secrets): make runtime fixture modes explicit

* fix(cli): resolve local qr password secret refs

* fix(cli): fail when gateway leaves command refs unresolved

* fix(gateway): fail when local password SecretRef is unresolved

* fix(gateway): fail when required remote SecretRefs are unresolved

* fix(gateway): resolve local password refs only when password can win

* fix(cli): skip local password SecretRef resolution on qr token override

* test(gateway): cast SecretRef fixtures to OpenClawConfig

* test(secrets): activate mode-gated targets in runtime coverage fixture

* fix(cron): support SecretInput webhook tokens safely

* fix(bluebubbles): support SecretInput passwords across config paths

* fix(msteams): make appPassword SecretInput-safe in onboarding/token paths

* fix(bluebubbles): align SecretInput schema helper typing

* fix(cli): clarify secrets.resolve version-skew errors

* refactor(secrets): return structured inactive paths from secrets.resolve

* refactor(gateway): type onboarding secret writes as SecretInput

* chore(protocol): regenerate swift models for secrets.resolve

* feat(secrets): expand extension credential secretref support

* fix(secrets): gate web-search refs by active provider

* fix(onboarding): detect SecretRef credentials in extension status

* fix(onboarding): allow keeping existing ref in secret prompt

* fix(onboarding): resolve gateway password SecretRefs for probe and tui

* fix(onboarding): honor secret-input-mode for local gateway auth

* fix(acp): resolve gateway SecretInput credentials

* fix(secrets): gate gateway.remote refs to remote surfaces

* test(secrets): cover pattern matching and inactive array refs

* docs(secrets): clarify secrets.resolve and remote active surfaces

* fix(bluebubbles): keep existing SecretRef during onboarding

* fix(tests): resolve CI type errors in new SecretRef coverage

* fix(extensions): replace raw fetch with SSRF-guarded fetch

* test(secrets): mark gateway remote targets active in runtime coverage

* test(infra): normalize home-prefix expectation across platforms

* fix(cli): only resolve local qr password refs in password mode

* test(cli): cover local qr token mode with unresolved password ref

* docs(cli): clarify local qr password ref resolution behavior

* refactor(extensions): reuse sdk SecretInput helpers

* fix(wizard): resolve onboarding env-template secrets before plaintext

* fix(cli): surface secrets.resolve diagnostics in memory and qr

* test(secrets): repair post-rebase runtime and fixtures

* fix(gateway): skip remote password ref resolution when token wins

* fix(secrets): treat tailscale remote gateway refs as active

* fix(gateway): allow remote password fallback when token ref is unresolved

* fix(gateway): ignore stale local password refs for none and trusted-proxy

* fix(gateway): skip remote secret ref resolution on local call paths

* test(cli): cover qr remote tailscale secret ref resolution

* fix(secrets): align gateway password active-surface with auth inference

* fix(cli): resolve inferred local gateway password refs in qr

* fix(gateway): prefer resolvable remote password over token ref pre-resolution

* test(gateway): cover none and trusted-proxy stale password refs

* docs(secrets): sync qr and gateway active-surface behavior

* fix: restore stability blockers from pre-release audit

* Secrets: fix collector/runtime precedence contradictions

* docs: align secrets and web credential docs

* fix(rebase): resolve integration regressions after main rebase

* fix(node-host): resolve gateway secret refs for auth

* fix(secrets): harden secretinput runtime readers

* gateway: skip inactive auth secretref resolution

* cli: avoid gateway preflight for inactive secret refs

* extensions: allow unresolved refs in onboarding status

* tests: fix qr-cli module mock hoist ordering

* Security: align audit checks with SecretInput resolution

* Gateway: resolve local-mode remote fallback secret refs

* Node host: avoid resolving inactive password secret refs

* Secrets runtime: mark Slack appToken inactive for HTTP mode

* secrets: keep inactive gateway remote refs non-blocking

* cli: include agent memory secret targets in runtime resolution

* docs(secrets): sync docs with active-surface and web search behavior

* fix(secrets): keep telegram top-level token refs active for blank account tokens

* fix(daemon): resolve gateway password secret refs for probe auth

* fix(secrets): skip IRC NickServ ref resolution when NickServ is disabled

* fix(secrets): align token inheritance and exec timeout defaults

* docs(secrets): clarify active-surface notes in cli docs

* cli: require secrets.resolve gateway capability

* gateway: log auth secret surface diagnostics

* secrets: remove dead provider resolver module

* fix(secrets): restore gateway auth precedence and fallback resolution

* fix(tests): align plugin runtime mock typings

---------

Co-authored-by: Peter Steinberger <steipete@gmail.com>
This commit is contained in:
Josh Avant
2026-03-02 20:58:20 -06:00
committed by GitHub
parent f212351aed
commit 806803b7ef
236 changed files with 16810 additions and 2861 deletions

View File

@@ -0,0 +1,374 @@
import type { OpenClawConfig } from "../config/config.js";
import { collectTtsApiKeyAssignments } from "./runtime-config-collectors-tts.js";
import { evaluateGatewayAuthSurfaceStates } from "./runtime-gateway-auth-surfaces.js";
import {
collectSecretInputAssignment,
type ResolverContext,
type SecretDefaults,
} from "./runtime-shared.js";
import { isRecord } from "./shared.js";
type ProviderLike = {
apiKey?: unknown;
enabled?: unknown;
};
type SkillEntryLike = {
apiKey?: unknown;
enabled?: unknown;
};
function collectModelProviderAssignments(params: {
providers: Record<string, ProviderLike>;
defaults: SecretDefaults | undefined;
context: ResolverContext;
}): void {
for (const [providerId, provider] of Object.entries(params.providers)) {
collectSecretInputAssignment({
value: provider.apiKey,
path: `models.providers.${providerId}.apiKey`,
expected: "string",
defaults: params.defaults,
context: params.context,
active: provider.enabled !== false,
inactiveReason: "provider is disabled.",
apply: (value) => {
provider.apiKey = value;
},
});
}
}
function collectSkillAssignments(params: {
entries: Record<string, SkillEntryLike>;
defaults: SecretDefaults | undefined;
context: ResolverContext;
}): void {
for (const [skillKey, entry] of Object.entries(params.entries)) {
collectSecretInputAssignment({
value: entry.apiKey,
path: `skills.entries.${skillKey}.apiKey`,
expected: "string",
defaults: params.defaults,
context: params.context,
active: entry.enabled !== false,
inactiveReason: "skill entry is disabled.",
apply: (value) => {
entry.apiKey = value;
},
});
}
}
function collectAgentMemorySearchAssignments(params: {
config: OpenClawConfig;
defaults: SecretDefaults | undefined;
context: ResolverContext;
}): void {
const agents = params.config.agents as Record<string, unknown> | undefined;
if (!isRecord(agents)) {
return;
}
const defaultsConfig = isRecord(agents.defaults) ? agents.defaults : undefined;
const defaultsMemorySearch = isRecord(defaultsConfig?.memorySearch)
? defaultsConfig.memorySearch
: undefined;
const defaultsEnabled = defaultsMemorySearch?.enabled !== false;
const list = Array.isArray(agents.list) ? agents.list : [];
let hasEnabledAgentWithoutOverride = false;
for (const rawAgent of list) {
if (!isRecord(rawAgent)) {
continue;
}
if (rawAgent.enabled === false) {
continue;
}
const memorySearch = isRecord(rawAgent.memorySearch) ? rawAgent.memorySearch : undefined;
if (memorySearch?.enabled === false) {
continue;
}
if (!memorySearch || !Object.prototype.hasOwnProperty.call(memorySearch, "remote")) {
hasEnabledAgentWithoutOverride = true;
continue;
}
const remote = isRecord(memorySearch.remote) ? memorySearch.remote : undefined;
if (!remote || !Object.prototype.hasOwnProperty.call(remote, "apiKey")) {
hasEnabledAgentWithoutOverride = true;
continue;
}
}
if (defaultsMemorySearch && isRecord(defaultsMemorySearch.remote)) {
const remote = defaultsMemorySearch.remote;
collectSecretInputAssignment({
value: remote.apiKey,
path: "agents.defaults.memorySearch.remote.apiKey",
expected: "string",
defaults: params.defaults,
context: params.context,
active: defaultsEnabled && (hasEnabledAgentWithoutOverride || list.length === 0),
inactiveReason: hasEnabledAgentWithoutOverride
? undefined
: "all enabled agents override memorySearch.remote.apiKey.",
apply: (value) => {
remote.apiKey = value;
},
});
}
list.forEach((rawAgent, index) => {
if (!isRecord(rawAgent)) {
return;
}
const memorySearch = isRecord(rawAgent.memorySearch) ? rawAgent.memorySearch : undefined;
if (!memorySearch) {
return;
}
const remote = isRecord(memorySearch.remote) ? memorySearch.remote : undefined;
if (!remote || !Object.prototype.hasOwnProperty.call(remote, "apiKey")) {
return;
}
const enabled = rawAgent.enabled !== false && memorySearch.enabled !== false;
collectSecretInputAssignment({
value: remote.apiKey,
path: `agents.list.${index}.memorySearch.remote.apiKey`,
expected: "string",
defaults: params.defaults,
context: params.context,
active: enabled,
inactiveReason: "agent or memorySearch override is disabled.",
apply: (value) => {
remote.apiKey = value;
},
});
});
}
function collectTalkAssignments(params: {
config: OpenClawConfig;
defaults: SecretDefaults | undefined;
context: ResolverContext;
}): void {
const talk = params.config.talk as Record<string, unknown> | undefined;
if (!isRecord(talk)) {
return;
}
collectSecretInputAssignment({
value: talk.apiKey,
path: "talk.apiKey",
expected: "string",
defaults: params.defaults,
context: params.context,
apply: (value) => {
talk.apiKey = value;
},
});
const providers = talk.providers;
if (!isRecord(providers)) {
return;
}
for (const [providerId, providerConfig] of Object.entries(providers)) {
if (!isRecord(providerConfig)) {
continue;
}
collectSecretInputAssignment({
value: providerConfig.apiKey,
path: `talk.providers.${providerId}.apiKey`,
expected: "string",
defaults: params.defaults,
context: params.context,
apply: (value) => {
providerConfig.apiKey = value;
},
});
}
}
function collectGatewayAssignments(params: {
config: OpenClawConfig;
defaults: SecretDefaults | undefined;
context: ResolverContext;
}): void {
const gateway = params.config.gateway as Record<string, unknown> | undefined;
if (!isRecord(gateway)) {
return;
}
const auth = isRecord(gateway.auth) ? gateway.auth : undefined;
const remote = isRecord(gateway.remote) ? gateway.remote : undefined;
const gatewaySurfaceStates = evaluateGatewayAuthSurfaceStates({
config: params.config,
env: params.context.env,
defaults: params.defaults,
});
if (auth) {
collectSecretInputAssignment({
value: auth.password,
path: "gateway.auth.password",
expected: "string",
defaults: params.defaults,
context: params.context,
active: gatewaySurfaceStates["gateway.auth.password"].active,
inactiveReason: gatewaySurfaceStates["gateway.auth.password"].reason,
apply: (value) => {
auth.password = value;
},
});
}
if (remote) {
collectSecretInputAssignment({
value: remote.token,
path: "gateway.remote.token",
expected: "string",
defaults: params.defaults,
context: params.context,
active: gatewaySurfaceStates["gateway.remote.token"].active,
inactiveReason: gatewaySurfaceStates["gateway.remote.token"].reason,
apply: (value) => {
remote.token = value;
},
});
collectSecretInputAssignment({
value: remote.password,
path: "gateway.remote.password",
expected: "string",
defaults: params.defaults,
context: params.context,
active: gatewaySurfaceStates["gateway.remote.password"].active,
inactiveReason: gatewaySurfaceStates["gateway.remote.password"].reason,
apply: (value) => {
remote.password = value;
},
});
}
}
function collectMessagesTtsAssignments(params: {
config: OpenClawConfig;
defaults: SecretDefaults | undefined;
context: ResolverContext;
}): void {
const messages = params.config.messages as Record<string, unknown> | undefined;
if (!isRecord(messages) || !isRecord(messages.tts)) {
return;
}
collectTtsApiKeyAssignments({
tts: messages.tts,
pathPrefix: "messages.tts",
defaults: params.defaults,
context: params.context,
});
}
function collectToolsWebSearchAssignments(params: {
config: OpenClawConfig;
defaults: SecretDefaults | undefined;
context: ResolverContext;
}): void {
const tools = params.config.tools as Record<string, unknown> | undefined;
if (!isRecord(tools) || !isRecord(tools.web) || !isRecord(tools.web.search)) {
return;
}
const search = tools.web.search;
const searchEnabled = search.enabled !== false;
const rawProvider =
typeof search.provider === "string" ? search.provider.trim().toLowerCase() : "";
const selectedProvider =
rawProvider === "brave" ||
rawProvider === "gemini" ||
rawProvider === "grok" ||
rawProvider === "kimi" ||
rawProvider === "perplexity"
? rawProvider
: undefined;
const paths = [
"apiKey",
"gemini.apiKey",
"grok.apiKey",
"kimi.apiKey",
"perplexity.apiKey",
] as const;
for (const path of paths) {
const [scope, field] = path.includes(".") ? path.split(".", 2) : [undefined, path];
const target = scope ? search[scope] : search;
if (!isRecord(target)) {
continue;
}
const active = scope
? searchEnabled && (selectedProvider === undefined || selectedProvider === scope)
: searchEnabled && (selectedProvider === undefined || selectedProvider === "brave");
const inactiveReason = !searchEnabled
? "tools.web.search is disabled."
: scope
? selectedProvider === undefined
? undefined
: `tools.web.search.provider is "${selectedProvider}".`
: selectedProvider === undefined
? undefined
: `tools.web.search.provider is "${selectedProvider}".`;
collectSecretInputAssignment({
value: target[field],
path: `tools.web.search.${path}`,
expected: "string",
defaults: params.defaults,
context: params.context,
active,
inactiveReason,
apply: (value) => {
target[field] = value;
},
});
}
}
function collectCronAssignments(params: {
config: OpenClawConfig;
defaults: SecretDefaults | undefined;
context: ResolverContext;
}): void {
const cron = params.config.cron as Record<string, unknown> | undefined;
if (!isRecord(cron)) {
return;
}
collectSecretInputAssignment({
value: cron.webhookToken,
path: "cron.webhookToken",
expected: "string",
defaults: params.defaults,
context: params.context,
apply: (value) => {
cron.webhookToken = value;
},
});
}
export function collectCoreConfigAssignments(params: {
config: OpenClawConfig;
defaults: SecretDefaults | undefined;
context: ResolverContext;
}): void {
const providers = params.config.models?.providers as Record<string, ProviderLike> | undefined;
if (providers) {
collectModelProviderAssignments({
providers,
defaults: params.defaults,
context: params.context,
});
}
const skillEntries = params.config.skills?.entries as Record<string, SkillEntryLike> | undefined;
if (skillEntries) {
collectSkillAssignments({
entries: skillEntries,
defaults: params.defaults,
context: params.context,
});
}
collectAgentMemorySearchAssignments(params);
collectTalkAssignments(params);
collectGatewayAssignments(params);
collectMessagesTtsAssignments(params);
collectToolsWebSearchAssignments(params);
collectCronAssignments(params);
}