mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-05 21:40:21 +00:00
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
247
src/secrets/runtime-gateway-auth-surfaces.ts
Normal file
247
src/secrets/runtime-gateway-auth-surfaces.ts
Normal file
@@ -0,0 +1,247 @@
|
||||
import type { OpenClawConfig } from "../config/config.js";
|
||||
import { coerceSecretRef, hasConfiguredSecretInput } from "../config/types.secrets.js";
|
||||
import type { SecretDefaults } from "./runtime-shared.js";
|
||||
import { isRecord } from "./shared.js";
|
||||
|
||||
const GATEWAY_TOKEN_ENV_KEYS = ["OPENCLAW_GATEWAY_TOKEN", "CLAWDBOT_GATEWAY_TOKEN"] as const;
|
||||
const GATEWAY_PASSWORD_ENV_KEYS = [
|
||||
"OPENCLAW_GATEWAY_PASSWORD",
|
||||
"CLAWDBOT_GATEWAY_PASSWORD",
|
||||
] as const;
|
||||
|
||||
export const GATEWAY_AUTH_SURFACE_PATHS = [
|
||||
"gateway.auth.password",
|
||||
"gateway.remote.token",
|
||||
"gateway.remote.password",
|
||||
] as const;
|
||||
|
||||
export type GatewayAuthSurfacePath = (typeof GATEWAY_AUTH_SURFACE_PATHS)[number];
|
||||
|
||||
export type GatewayAuthSurfaceState = {
|
||||
path: GatewayAuthSurfacePath;
|
||||
active: boolean;
|
||||
reason: string;
|
||||
hasSecretRef: boolean;
|
||||
};
|
||||
|
||||
export type GatewayAuthSurfaceStateMap = Record<GatewayAuthSurfacePath, GatewayAuthSurfaceState>;
|
||||
|
||||
function readNonEmptyEnv(env: NodeJS.ProcessEnv, names: readonly string[]): string | undefined {
|
||||
for (const name of names) {
|
||||
const raw = env[name];
|
||||
if (typeof raw !== "string") {
|
||||
continue;
|
||||
}
|
||||
const trimmed = raw.trim();
|
||||
if (trimmed.length > 0) {
|
||||
return trimmed;
|
||||
}
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
function formatAuthMode(mode: string | undefined): string {
|
||||
return mode ?? "unset";
|
||||
}
|
||||
|
||||
function describeRemoteConfiguredSurface(parts: {
|
||||
remoteMode: boolean;
|
||||
remoteUrlConfigured: boolean;
|
||||
tailscaleRemoteExposure: boolean;
|
||||
}): string {
|
||||
const reasons: string[] = [];
|
||||
if (parts.remoteMode) {
|
||||
reasons.push('gateway.mode is "remote"');
|
||||
}
|
||||
if (parts.remoteUrlConfigured) {
|
||||
reasons.push("gateway.remote.url is configured");
|
||||
}
|
||||
if (parts.tailscaleRemoteExposure) {
|
||||
reasons.push('gateway.tailscale.mode is "serve" or "funnel"');
|
||||
}
|
||||
return reasons.join("; ");
|
||||
}
|
||||
|
||||
function createState(params: {
|
||||
path: GatewayAuthSurfacePath;
|
||||
active: boolean;
|
||||
reason: string;
|
||||
hasSecretRef: boolean;
|
||||
}): GatewayAuthSurfaceState {
|
||||
return {
|
||||
path: params.path,
|
||||
active: params.active,
|
||||
reason: params.reason,
|
||||
hasSecretRef: params.hasSecretRef,
|
||||
};
|
||||
}
|
||||
|
||||
export function evaluateGatewayAuthSurfaceStates(params: {
|
||||
config: OpenClawConfig;
|
||||
env: NodeJS.ProcessEnv;
|
||||
defaults?: SecretDefaults;
|
||||
}): GatewayAuthSurfaceStateMap {
|
||||
const defaults = params.defaults ?? params.config.secrets?.defaults;
|
||||
const gateway = params.config.gateway as Record<string, unknown> | undefined;
|
||||
if (!isRecord(gateway)) {
|
||||
return {
|
||||
"gateway.auth.password": createState({
|
||||
path: "gateway.auth.password",
|
||||
active: false,
|
||||
reason: "gateway configuration is not set.",
|
||||
hasSecretRef: false,
|
||||
}),
|
||||
"gateway.remote.token": createState({
|
||||
path: "gateway.remote.token",
|
||||
active: false,
|
||||
reason: "gateway configuration is not set.",
|
||||
hasSecretRef: false,
|
||||
}),
|
||||
"gateway.remote.password": createState({
|
||||
path: "gateway.remote.password",
|
||||
active: false,
|
||||
reason: "gateway configuration is not set.",
|
||||
hasSecretRef: false,
|
||||
}),
|
||||
};
|
||||
}
|
||||
const auth = isRecord(gateway?.auth) ? gateway.auth : undefined;
|
||||
const remote = isRecord(gateway?.remote) ? gateway.remote : undefined;
|
||||
const authMode = auth && typeof auth.mode === "string" ? auth.mode : undefined;
|
||||
|
||||
const hasAuthPasswordRef = coerceSecretRef(auth?.password, defaults) !== null;
|
||||
const hasRemoteTokenRef = coerceSecretRef(remote?.token, defaults) !== null;
|
||||
const hasRemotePasswordRef = coerceSecretRef(remote?.password, defaults) !== null;
|
||||
|
||||
const envToken = readNonEmptyEnv(params.env, GATEWAY_TOKEN_ENV_KEYS);
|
||||
const envPassword = readNonEmptyEnv(params.env, GATEWAY_PASSWORD_ENV_KEYS);
|
||||
const localTokenConfigured = hasConfiguredSecretInput(auth?.token, defaults);
|
||||
const localPasswordConfigured = hasConfiguredSecretInput(auth?.password, defaults);
|
||||
const remoteTokenConfigured = hasConfiguredSecretInput(remote?.token, defaults);
|
||||
|
||||
const localTokenCanWin =
|
||||
authMode !== "password" && authMode !== "none" && authMode !== "trusted-proxy";
|
||||
const tokenCanWin = Boolean(envToken || localTokenConfigured || remoteTokenConfigured);
|
||||
const passwordCanWin =
|
||||
authMode === "password" ||
|
||||
(authMode !== "token" && authMode !== "none" && authMode !== "trusted-proxy" && !tokenCanWin);
|
||||
|
||||
const remoteMode = gateway?.mode === "remote";
|
||||
const remoteUrlConfigured = typeof remote?.url === "string" && remote.url.trim().length > 0;
|
||||
const tailscale =
|
||||
isRecord(gateway?.tailscale) && typeof gateway.tailscale.mode === "string"
|
||||
? gateway.tailscale
|
||||
: undefined;
|
||||
const tailscaleRemoteExposure = tailscale?.mode === "serve" || tailscale?.mode === "funnel";
|
||||
const remoteEnabled = remote?.enabled !== false;
|
||||
const remoteConfiguredSurface = remoteMode || remoteUrlConfigured || tailscaleRemoteExposure;
|
||||
const remoteTokenFallbackActive = localTokenCanWin && !envToken && !localTokenConfigured;
|
||||
const remoteTokenActive = remoteEnabled && (remoteConfiguredSurface || remoteTokenFallbackActive);
|
||||
const remotePasswordFallbackActive = !envPassword && !localPasswordConfigured && passwordCanWin;
|
||||
const remotePasswordActive =
|
||||
remoteEnabled && (remoteConfiguredSurface || remotePasswordFallbackActive);
|
||||
|
||||
const authPasswordReason = (() => {
|
||||
if (!auth) {
|
||||
return "gateway.auth is not configured.";
|
||||
}
|
||||
if (passwordCanWin) {
|
||||
return authMode === "password"
|
||||
? 'gateway.auth.mode is "password".'
|
||||
: "no token source can win, so password auth can win.";
|
||||
}
|
||||
if (authMode === "token" || authMode === "none" || authMode === "trusted-proxy") {
|
||||
return `gateway.auth.mode is "${authMode}".`;
|
||||
}
|
||||
if (envToken) {
|
||||
return "gateway token env var is configured.";
|
||||
}
|
||||
if (localTokenConfigured) {
|
||||
return "gateway.auth.token is configured.";
|
||||
}
|
||||
if (remoteTokenConfigured) {
|
||||
return "gateway.remote.token is configured.";
|
||||
}
|
||||
return "token auth can win.";
|
||||
})();
|
||||
|
||||
const remoteSurfaceReason = describeRemoteConfiguredSurface({
|
||||
remoteMode,
|
||||
remoteUrlConfigured,
|
||||
tailscaleRemoteExposure,
|
||||
});
|
||||
|
||||
const remoteTokenReason = (() => {
|
||||
if (!remote) {
|
||||
return "gateway.remote is not configured.";
|
||||
}
|
||||
if (!remoteEnabled) {
|
||||
return "gateway.remote.enabled is false.";
|
||||
}
|
||||
if (remoteConfiguredSurface) {
|
||||
return `remote surface is active: ${remoteSurfaceReason}.`;
|
||||
}
|
||||
if (remoteTokenFallbackActive) {
|
||||
return "local token auth can win and no env/auth token is configured.";
|
||||
}
|
||||
if (!localTokenCanWin) {
|
||||
return `token auth cannot win with gateway.auth.mode="${formatAuthMode(authMode)}".`;
|
||||
}
|
||||
if (envToken) {
|
||||
return "gateway token env var is configured.";
|
||||
}
|
||||
if (localTokenConfigured) {
|
||||
return "gateway.auth.token is configured.";
|
||||
}
|
||||
return "remote token fallback is not active.";
|
||||
})();
|
||||
|
||||
const remotePasswordReason = (() => {
|
||||
if (!remote) {
|
||||
return "gateway.remote is not configured.";
|
||||
}
|
||||
if (!remoteEnabled) {
|
||||
return "gateway.remote.enabled is false.";
|
||||
}
|
||||
if (remoteConfiguredSurface) {
|
||||
return `remote surface is active: ${remoteSurfaceReason}.`;
|
||||
}
|
||||
if (remotePasswordFallbackActive) {
|
||||
return "password auth can win and no env/auth password is configured.";
|
||||
}
|
||||
if (!passwordCanWin) {
|
||||
if (authMode === "token" || authMode === "none" || authMode === "trusted-proxy") {
|
||||
return `password auth cannot win with gateway.auth.mode="${authMode}".`;
|
||||
}
|
||||
return "a token source can win, so password auth cannot win.";
|
||||
}
|
||||
if (envPassword) {
|
||||
return "gateway password env var is configured.";
|
||||
}
|
||||
if (localPasswordConfigured) {
|
||||
return "gateway.auth.password is configured.";
|
||||
}
|
||||
return "remote password fallback is not active.";
|
||||
})();
|
||||
|
||||
return {
|
||||
"gateway.auth.password": createState({
|
||||
path: "gateway.auth.password",
|
||||
active: passwordCanWin,
|
||||
reason: authPasswordReason,
|
||||
hasSecretRef: hasAuthPasswordRef,
|
||||
}),
|
||||
"gateway.remote.token": createState({
|
||||
path: "gateway.remote.token",
|
||||
active: remoteTokenActive,
|
||||
reason: remoteTokenReason,
|
||||
hasSecretRef: hasRemoteTokenRef,
|
||||
}),
|
||||
"gateway.remote.password": createState({
|
||||
path: "gateway.remote.password",
|
||||
active: remotePasswordActive,
|
||||
reason: remotePasswordReason,
|
||||
hasSecretRef: hasRemotePasswordRef,
|
||||
}),
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user