* 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>
281 lines
9.1 KiB
TypeScript
281 lines
9.1 KiB
TypeScript
import { resolveBrowserConfig } from "../browser/config.js";
|
|
import { loadConfig, type OpenClawConfig } from "../config/config.js";
|
|
import { normalizeSecretInputString, resolveSecretInputRef } from "../config/types.secrets.js";
|
|
import { GatewayClient } from "../gateway/client.js";
|
|
import { loadOrCreateDeviceIdentity } from "../infra/device-identity.js";
|
|
import type { SkillBinTrustEntry } from "../infra/exec-approvals.js";
|
|
import { resolveExecutableFromPathEnv } from "../infra/executable-path.js";
|
|
import { getMachineDisplayName } from "../infra/machine-name.js";
|
|
import {
|
|
NODE_BROWSER_PROXY_COMMAND,
|
|
NODE_EXEC_APPROVALS_COMMANDS,
|
|
NODE_SYSTEM_RUN_COMMANDS,
|
|
} from "../infra/node-commands.js";
|
|
import { ensureOpenClawCliOnPath } from "../infra/path-env.js";
|
|
import { secretRefKey } from "../secrets/ref-contract.js";
|
|
import { resolveSecretRefValues } from "../secrets/resolve.js";
|
|
import { GATEWAY_CLIENT_MODES, GATEWAY_CLIENT_NAMES } from "../utils/message-channel.js";
|
|
import { VERSION } from "../version.js";
|
|
import { ensureNodeHostConfig, saveNodeHostConfig, type NodeHostGatewayConfig } from "./config.js";
|
|
import {
|
|
coerceNodeInvokePayload,
|
|
handleInvoke,
|
|
type SkillBinsProvider,
|
|
buildNodeInvokeResultParams,
|
|
} from "./invoke.js";
|
|
|
|
export { buildNodeInvokeResultParams };
|
|
|
|
type NodeHostRunOptions = {
|
|
gatewayHost: string;
|
|
gatewayPort: number;
|
|
gatewayTls?: boolean;
|
|
gatewayTlsFingerprint?: string;
|
|
nodeId?: string;
|
|
displayName?: string;
|
|
};
|
|
|
|
const DEFAULT_NODE_PATH = "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin";
|
|
|
|
function resolveExecutablePathFromEnv(bin: string, pathEnv: string): string | null {
|
|
if (bin.includes("/") || bin.includes("\\")) {
|
|
return null;
|
|
}
|
|
return resolveExecutableFromPathEnv(bin, pathEnv) ?? null;
|
|
}
|
|
|
|
function resolveSkillBinTrustEntries(bins: string[], pathEnv: string): SkillBinTrustEntry[] {
|
|
const trustEntries: SkillBinTrustEntry[] = [];
|
|
const seen = new Set<string>();
|
|
for (const bin of bins) {
|
|
const name = bin.trim();
|
|
if (!name) {
|
|
continue;
|
|
}
|
|
const resolvedPath = resolveExecutablePathFromEnv(name, pathEnv);
|
|
if (!resolvedPath) {
|
|
continue;
|
|
}
|
|
const key = `${name}\u0000${resolvedPath}`;
|
|
if (seen.has(key)) {
|
|
continue;
|
|
}
|
|
seen.add(key);
|
|
trustEntries.push({ name, resolvedPath });
|
|
}
|
|
return trustEntries.toSorted(
|
|
(left, right) =>
|
|
left.name.localeCompare(right.name) || left.resolvedPath.localeCompare(right.resolvedPath),
|
|
);
|
|
}
|
|
|
|
class SkillBinsCache implements SkillBinsProvider {
|
|
private bins: SkillBinTrustEntry[] = [];
|
|
private lastRefresh = 0;
|
|
private readonly ttlMs = 90_000;
|
|
private readonly fetch: () => Promise<string[]>;
|
|
private readonly pathEnv: string;
|
|
|
|
constructor(fetch: () => Promise<string[]>, pathEnv: string) {
|
|
this.fetch = fetch;
|
|
this.pathEnv = pathEnv;
|
|
}
|
|
|
|
async current(force = false): Promise<SkillBinTrustEntry[]> {
|
|
if (force || Date.now() - this.lastRefresh > this.ttlMs) {
|
|
await this.refresh();
|
|
}
|
|
return this.bins;
|
|
}
|
|
|
|
private async refresh() {
|
|
try {
|
|
const bins = await this.fetch();
|
|
this.bins = resolveSkillBinTrustEntries(bins, this.pathEnv);
|
|
this.lastRefresh = Date.now();
|
|
} catch {
|
|
if (!this.lastRefresh) {
|
|
this.bins = [];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function ensureNodePathEnv(): string {
|
|
ensureOpenClawCliOnPath({ pathEnv: process.env.PATH ?? "" });
|
|
const current = process.env.PATH ?? "";
|
|
if (current.trim()) {
|
|
return current;
|
|
}
|
|
process.env.PATH = DEFAULT_NODE_PATH;
|
|
return DEFAULT_NODE_PATH;
|
|
}
|
|
|
|
async function resolveNodeHostSecretInputString(params: {
|
|
config: OpenClawConfig;
|
|
value: unknown;
|
|
path: string;
|
|
env: NodeJS.ProcessEnv;
|
|
}): Promise<string | undefined> {
|
|
const defaults = params.config.secrets?.defaults;
|
|
const { ref } = resolveSecretInputRef({
|
|
value: params.value,
|
|
defaults,
|
|
});
|
|
if (!ref) {
|
|
return normalizeSecretInputString(params.value);
|
|
}
|
|
let resolved: Map<string, unknown>;
|
|
try {
|
|
resolved = await resolveSecretRefValues([ref], {
|
|
config: params.config,
|
|
env: params.env,
|
|
});
|
|
} catch (error) {
|
|
const detail = error instanceof Error ? error.message : String(error);
|
|
throw new Error(`${params.path} secret reference could not be resolved: ${detail}`, {
|
|
cause: error,
|
|
});
|
|
}
|
|
const resolvedValue = normalizeSecretInputString(resolved.get(secretRefKey(ref)));
|
|
if (!resolvedValue) {
|
|
throw new Error(`${params.path} resolved to an empty or non-string value.`);
|
|
}
|
|
return resolvedValue;
|
|
}
|
|
|
|
export async function resolveNodeHostGatewayCredentials(params: {
|
|
config: OpenClawConfig;
|
|
env?: NodeJS.ProcessEnv;
|
|
}): Promise<{ token?: string; password?: string }> {
|
|
const env = params.env ?? process.env;
|
|
const isRemoteMode = params.config.gateway?.mode === "remote";
|
|
const authMode = params.config.gateway?.auth?.mode;
|
|
const tokenPath = isRemoteMode ? "gateway.remote.token" : "gateway.auth.token";
|
|
const passwordPath = isRemoteMode ? "gateway.remote.password" : "gateway.auth.password";
|
|
const configuredToken = isRemoteMode
|
|
? params.config.gateway?.remote?.token
|
|
: params.config.gateway?.auth?.token;
|
|
const configuredPassword = isRemoteMode
|
|
? params.config.gateway?.remote?.password
|
|
: params.config.gateway?.auth?.password;
|
|
|
|
const token =
|
|
normalizeSecretInputString(env.OPENCLAW_GATEWAY_TOKEN) ??
|
|
(await resolveNodeHostSecretInputString({
|
|
config: params.config,
|
|
value: configuredToken,
|
|
path: tokenPath,
|
|
env,
|
|
}));
|
|
const tokenCanWin = Boolean(token);
|
|
const localPasswordCanWin =
|
|
authMode === "password" ||
|
|
(authMode !== "token" && authMode !== "none" && authMode !== "trusted-proxy" && !tokenCanWin);
|
|
const shouldResolveConfiguredPassword =
|
|
!normalizeSecretInputString(env.OPENCLAW_GATEWAY_PASSWORD) &&
|
|
!tokenCanWin &&
|
|
(isRemoteMode || localPasswordCanWin);
|
|
const password =
|
|
normalizeSecretInputString(env.OPENCLAW_GATEWAY_PASSWORD) ??
|
|
(shouldResolveConfiguredPassword
|
|
? await resolveNodeHostSecretInputString({
|
|
config: params.config,
|
|
value: configuredPassword,
|
|
path: passwordPath,
|
|
env,
|
|
})
|
|
: normalizeSecretInputString(configuredPassword));
|
|
|
|
return { token, password };
|
|
}
|
|
|
|
export async function runNodeHost(opts: NodeHostRunOptions): Promise<void> {
|
|
const config = await ensureNodeHostConfig();
|
|
const nodeId = opts.nodeId?.trim() || config.nodeId;
|
|
if (nodeId !== config.nodeId) {
|
|
config.nodeId = nodeId;
|
|
}
|
|
const displayName =
|
|
opts.displayName?.trim() || config.displayName || (await getMachineDisplayName());
|
|
config.displayName = displayName;
|
|
|
|
const gateway: NodeHostGatewayConfig = {
|
|
host: opts.gatewayHost,
|
|
port: opts.gatewayPort,
|
|
tls: opts.gatewayTls ?? loadConfig().gateway?.tls?.enabled ?? false,
|
|
tlsFingerprint: opts.gatewayTlsFingerprint,
|
|
};
|
|
config.gateway = gateway;
|
|
await saveNodeHostConfig(config);
|
|
|
|
const cfg = loadConfig();
|
|
const resolvedBrowser = resolveBrowserConfig(cfg.browser, cfg);
|
|
const browserProxyEnabled =
|
|
cfg.nodeHost?.browserProxy?.enabled !== false && resolvedBrowser.enabled;
|
|
const { token, password } = await resolveNodeHostGatewayCredentials({
|
|
config: cfg,
|
|
env: process.env,
|
|
});
|
|
|
|
const host = gateway.host ?? "127.0.0.1";
|
|
const port = gateway.port ?? 18789;
|
|
const scheme = gateway.tls ? "wss" : "ws";
|
|
const url = `${scheme}://${host}:${port}`;
|
|
const pathEnv = ensureNodePathEnv();
|
|
// eslint-disable-next-line no-console
|
|
console.log(`node host PATH: ${pathEnv}`);
|
|
|
|
const client = new GatewayClient({
|
|
url,
|
|
token: token || undefined,
|
|
password: password || undefined,
|
|
instanceId: nodeId,
|
|
clientName: GATEWAY_CLIENT_NAMES.NODE_HOST,
|
|
clientDisplayName: displayName,
|
|
clientVersion: VERSION,
|
|
platform: process.platform,
|
|
mode: GATEWAY_CLIENT_MODES.NODE,
|
|
role: "node",
|
|
scopes: [],
|
|
caps: ["system", ...(browserProxyEnabled ? ["browser"] : [])],
|
|
commands: [
|
|
...NODE_SYSTEM_RUN_COMMANDS,
|
|
...NODE_EXEC_APPROVALS_COMMANDS,
|
|
...(browserProxyEnabled ? [NODE_BROWSER_PROXY_COMMAND] : []),
|
|
],
|
|
pathEnv,
|
|
permissions: undefined,
|
|
deviceIdentity: loadOrCreateDeviceIdentity(),
|
|
tlsFingerprint: gateway.tlsFingerprint,
|
|
onEvent: (evt) => {
|
|
if (evt.event !== "node.invoke.request") {
|
|
return;
|
|
}
|
|
const payload = coerceNodeInvokePayload(evt.payload);
|
|
if (!payload) {
|
|
return;
|
|
}
|
|
void handleInvoke(payload, client, skillBins);
|
|
},
|
|
onConnectError: (err) => {
|
|
// keep retrying (handled by GatewayClient)
|
|
// eslint-disable-next-line no-console
|
|
console.error(`node host gateway connect failed: ${err.message}`);
|
|
},
|
|
onClose: (code, reason) => {
|
|
// eslint-disable-next-line no-console
|
|
console.error(`node host gateway closed (${code}): ${reason}`);
|
|
},
|
|
});
|
|
|
|
const skillBins = new SkillBinsCache(async () => {
|
|
const res = await client.request<{ bins: Array<unknown> }>("skills.bins", {});
|
|
const bins = Array.isArray(res?.bins) ? res.bins.map((bin) => String(bin)) : [];
|
|
return bins;
|
|
}, pathEnv);
|
|
|
|
client.start();
|
|
await new Promise(() => {});
|
|
}
|