mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-08 23:08:28 +00:00
fix(security): centralize owner-only tool gating and scope maps
This commit is contained in:
Peter Steinberger
@@ -186,95 +186,153 @@ export function buildGatewayConnectionDetails(
|
||||
};
|
||||
}
|
||||
|
||||
async function callGatewayWithScopes<T = Record<string, unknown>>(
|
||||
opts: CallGatewayBaseOptions,
|
||||
scopes: OperatorScope[],
|
||||
): Promise<T> {
|
||||
const timeoutMs =
|
||||
typeof opts.timeoutMs === "number" && Number.isFinite(opts.timeoutMs) ? opts.timeoutMs : 10_000;
|
||||
const safeTimerTimeoutMs = Math.max(1, Math.min(Math.floor(timeoutMs), 2_147_483_647));
|
||||
const config = opts.config ?? loadConfig();
|
||||
const isRemoteMode = config.gateway?.mode === "remote";
|
||||
const remote = isRemoteMode ? config.gateway?.remote : undefined;
|
||||
const urlOverride =
|
||||
typeof opts.url === "string" && opts.url.trim().length > 0 ? opts.url.trim() : undefined;
|
||||
const explicitAuth = resolveExplicitGatewayAuth({ token: opts.token, password: opts.password });
|
||||
ensureExplicitGatewayAuth({
|
||||
urlOverride,
|
||||
auth: explicitAuth,
|
||||
errorHint: "Fix: pass --token or --password (or gatewayToken in tools).",
|
||||
configPath: opts.configPath ?? resolveConfigPath(process.env, resolveStateDir(process.env)),
|
||||
});
|
||||
const remoteUrl =
|
||||
typeof remote?.url === "string" && remote.url.trim().length > 0 ? remote.url.trim() : undefined;
|
||||
if (isRemoteMode && !urlOverride && !remoteUrl) {
|
||||
const configPath =
|
||||
opts.configPath ?? resolveConfigPath(process.env, resolveStateDir(process.env));
|
||||
throw new Error(
|
||||
[
|
||||
"gateway remote mode misconfigured: gateway.remote.url missing",
|
||||
`Config: ${configPath}`,
|
||||
"Fix: set gateway.remote.url, or set gateway.mode=local.",
|
||||
].join("\n"),
|
||||
);
|
||||
type GatewayRemoteSettings = {
|
||||
url?: string;
|
||||
token?: string;
|
||||
password?: string;
|
||||
tlsFingerprint?: string;
|
||||
};
|
||||
|
||||
type ResolvedGatewayCallContext = {
|
||||
config: OpenClawConfig;
|
||||
configPath: string;
|
||||
isRemoteMode: boolean;
|
||||
remote?: GatewayRemoteSettings;
|
||||
urlOverride?: string;
|
||||
remoteUrl?: string;
|
||||
explicitAuth: ExplicitGatewayAuth;
|
||||
};
|
||||
|
||||
function trimToUndefined(value: unknown): string | undefined {
|
||||
if (typeof value !== "string") {
|
||||
return undefined;
|
||||
}
|
||||
const authToken = config.gateway?.auth?.token;
|
||||
const authPassword = config.gateway?.auth?.password;
|
||||
const connectionDetails = buildGatewayConnectionDetails({
|
||||
config,
|
||||
url: urlOverride,
|
||||
...(opts.configPath ? { configPath: opts.configPath } : {}),
|
||||
});
|
||||
const url = connectionDetails.url;
|
||||
const useLocalTls =
|
||||
config.gateway?.tls?.enabled === true && !urlOverride && !remoteUrl && url.startsWith("wss://");
|
||||
const tlsRuntime = useLocalTls ? await loadGatewayTlsRuntime(config.gateway?.tls) : undefined;
|
||||
const remoteTlsFingerprint =
|
||||
isRemoteMode && !urlOverride && remoteUrl && typeof remote?.tlsFingerprint === "string"
|
||||
? remote.tlsFingerprint.trim()
|
||||
: undefined;
|
||||
const overrideTlsFingerprint =
|
||||
typeof opts.tlsFingerprint === "string" ? opts.tlsFingerprint.trim() : undefined;
|
||||
const tlsFingerprint =
|
||||
overrideTlsFingerprint ||
|
||||
remoteTlsFingerprint ||
|
||||
(tlsRuntime?.enabled ? tlsRuntime.fingerprintSha256 : undefined);
|
||||
const trimmed = value.trim();
|
||||
return trimmed.length > 0 ? trimmed : undefined;
|
||||
}
|
||||
|
||||
function resolveGatewayCallTimeout(timeoutValue: unknown): {
|
||||
timeoutMs: number;
|
||||
safeTimerTimeoutMs: number;
|
||||
} {
|
||||
const timeoutMs =
|
||||
typeof timeoutValue === "number" && Number.isFinite(timeoutValue) ? timeoutValue : 10_000;
|
||||
const safeTimerTimeoutMs = Math.max(1, Math.min(Math.floor(timeoutMs), 2_147_483_647));
|
||||
return { timeoutMs, safeTimerTimeoutMs };
|
||||
}
|
||||
|
||||
function resolveGatewayCallContext(opts: CallGatewayBaseOptions): ResolvedGatewayCallContext {
|
||||
const config = opts.config ?? loadConfig();
|
||||
const configPath =
|
||||
opts.configPath ?? resolveConfigPath(process.env, resolveStateDir(process.env));
|
||||
const isRemoteMode = config.gateway?.mode === "remote";
|
||||
const remote = isRemoteMode
|
||||
? (config.gateway?.remote as GatewayRemoteSettings | undefined)
|
||||
: undefined;
|
||||
const urlOverride = trimToUndefined(opts.url);
|
||||
const remoteUrl = trimToUndefined(remote?.url);
|
||||
const explicitAuth = resolveExplicitGatewayAuth({ token: opts.token, password: opts.password });
|
||||
return { config, configPath, isRemoteMode, remote, urlOverride, remoteUrl, explicitAuth };
|
||||
}
|
||||
|
||||
function ensureRemoteModeUrlConfigured(context: ResolvedGatewayCallContext): void {
|
||||
if (!context.isRemoteMode || context.urlOverride || context.remoteUrl) {
|
||||
return;
|
||||
}
|
||||
throw new Error(
|
||||
[
|
||||
"gateway remote mode misconfigured: gateway.remote.url missing",
|
||||
`Config: ${context.configPath}`,
|
||||
"Fix: set gateway.remote.url, or set gateway.mode=local.",
|
||||
].join("\n"),
|
||||
);
|
||||
}
|
||||
|
||||
function resolveGatewayCredentials(context: ResolvedGatewayCallContext): {
|
||||
token?: string;
|
||||
password?: string;
|
||||
} {
|
||||
const authToken = context.config.gateway?.auth?.token;
|
||||
const authPassword = context.config.gateway?.auth?.password;
|
||||
const token =
|
||||
explicitAuth.token ||
|
||||
(!urlOverride
|
||||
? isRemoteMode
|
||||
? typeof remote?.token === "string" && remote.token.trim().length > 0
|
||||
? remote.token.trim()
|
||||
: undefined
|
||||
: process.env.OPENCLAW_GATEWAY_TOKEN?.trim() ||
|
||||
process.env.CLAWDBOT_GATEWAY_TOKEN?.trim() ||
|
||||
(typeof authToken === "string" && authToken.trim().length > 0
|
||||
? authToken.trim()
|
||||
: undefined)
|
||||
context.explicitAuth.token ||
|
||||
(!context.urlOverride
|
||||
? context.isRemoteMode
|
||||
? trimToUndefined(context.remote?.token)
|
||||
: trimToUndefined(process.env.OPENCLAW_GATEWAY_TOKEN) ||
|
||||
trimToUndefined(process.env.CLAWDBOT_GATEWAY_TOKEN) ||
|
||||
trimToUndefined(authToken)
|
||||
: undefined);
|
||||
const password =
|
||||
explicitAuth.password ||
|
||||
(!urlOverride
|
||||
? process.env.OPENCLAW_GATEWAY_PASSWORD?.trim() ||
|
||||
process.env.CLAWDBOT_GATEWAY_PASSWORD?.trim() ||
|
||||
(isRemoteMode
|
||||
? typeof remote?.password === "string" && remote.password.trim().length > 0
|
||||
? remote.password.trim()
|
||||
: undefined
|
||||
: typeof authPassword === "string" && authPassword.trim().length > 0
|
||||
? authPassword.trim()
|
||||
: undefined)
|
||||
context.explicitAuth.password ||
|
||||
(!context.urlOverride
|
||||
? trimToUndefined(process.env.OPENCLAW_GATEWAY_PASSWORD) ||
|
||||
trimToUndefined(process.env.CLAWDBOT_GATEWAY_PASSWORD) ||
|
||||
(context.isRemoteMode
|
||||
? trimToUndefined(context.remote?.password)
|
||||
: trimToUndefined(authPassword))
|
||||
: undefined);
|
||||
return { token, password };
|
||||
}
|
||||
|
||||
const formatCloseError = (code: number, reason: string) => {
|
||||
const reasonText = reason?.trim() || "no close reason";
|
||||
const hint =
|
||||
code === 1006 ? "abnormal closure (no close frame)" : code === 1000 ? "normal closure" : "";
|
||||
const suffix = hint ? ` ${hint}` : "";
|
||||
return `gateway closed (${code}${suffix}): ${reasonText}\n${connectionDetails.message}`;
|
||||
};
|
||||
const formatTimeoutError = () =>
|
||||
`gateway timeout after ${timeoutMs}ms\n${connectionDetails.message}`;
|
||||
async function resolveGatewayTlsFingerprint(params: {
|
||||
opts: CallGatewayBaseOptions;
|
||||
context: ResolvedGatewayCallContext;
|
||||
url: string;
|
||||
}): Promise<string | undefined> {
|
||||
const { opts, context, url } = params;
|
||||
const useLocalTls =
|
||||
context.config.gateway?.tls?.enabled === true &&
|
||||
!context.urlOverride &&
|
||||
!context.remoteUrl &&
|
||||
url.startsWith("wss://");
|
||||
const tlsRuntime = useLocalTls
|
||||
? await loadGatewayTlsRuntime(context.config.gateway?.tls)
|
||||
: undefined;
|
||||
const overrideTlsFingerprint = trimToUndefined(opts.tlsFingerprint);
|
||||
const remoteTlsFingerprint =
|
||||
context.isRemoteMode && !context.urlOverride && context.remoteUrl
|
||||
? trimToUndefined(context.remote?.tlsFingerprint)
|
||||
: undefined;
|
||||
return (
|
||||
overrideTlsFingerprint ||
|
||||
remoteTlsFingerprint ||
|
||||
(tlsRuntime?.enabled ? tlsRuntime.fingerprintSha256 : undefined)
|
||||
);
|
||||
}
|
||||
|
||||
function formatGatewayCloseError(
|
||||
code: number,
|
||||
reason: string,
|
||||
connectionDetails: GatewayConnectionDetails,
|
||||
): string {
|
||||
const reasonText = reason?.trim() || "no close reason";
|
||||
const hint =
|
||||
code === 1006 ? "abnormal closure (no close frame)" : code === 1000 ? "normal closure" : "";
|
||||
const suffix = hint ? ` ${hint}` : "";
|
||||
return `gateway closed (${code}${suffix}): ${reasonText}\n${connectionDetails.message}`;
|
||||
}
|
||||
|
||||
function formatGatewayTimeoutError(
|
||||
timeoutMs: number,
|
||||
connectionDetails: GatewayConnectionDetails,
|
||||
): string {
|
||||
return `gateway timeout after ${timeoutMs}ms\n${connectionDetails.message}`;
|
||||
}
|
||||
|
||||
async function executeGatewayRequestWithScopes<T>(params: {
|
||||
opts: CallGatewayBaseOptions;
|
||||
scopes: OperatorScope[];
|
||||
url: string;
|
||||
token?: string;
|
||||
password?: string;
|
||||
tlsFingerprint?: string;
|
||||
timeoutMs: number;
|
||||
safeTimerTimeoutMs: number;
|
||||
connectionDetails: GatewayConnectionDetails;
|
||||
}): Promise<T> {
|
||||
const { opts, scopes, url, token, password, tlsFingerprint, timeoutMs, safeTimerTimeoutMs } =
|
||||
params;
|
||||
return await new Promise<T>((resolve, reject) => {
|
||||
let settled = false;
|
||||
let ignoreClose = false;
|
||||
@@ -327,20 +385,54 @@ async function callGatewayWithScopes<T = Record<string, unknown>>(
|
||||
}
|
||||
ignoreClose = true;
|
||||
client.stop();
|
||||
stop(new Error(formatCloseError(code, reason)));
|
||||
stop(new Error(formatGatewayCloseError(code, reason, params.connectionDetails)));
|
||||
},
|
||||
});
|
||||
|
||||
const timer = setTimeout(() => {
|
||||
ignoreClose = true;
|
||||
client.stop();
|
||||
stop(new Error(formatTimeoutError()));
|
||||
stop(new Error(formatGatewayTimeoutError(timeoutMs, params.connectionDetails)));
|
||||
}, safeTimerTimeoutMs);
|
||||
|
||||
client.start();
|
||||
});
|
||||
}
|
||||
|
||||
async function callGatewayWithScopes<T = Record<string, unknown>>(
|
||||
opts: CallGatewayBaseOptions,
|
||||
scopes: OperatorScope[],
|
||||
): Promise<T> {
|
||||
const { timeoutMs, safeTimerTimeoutMs } = resolveGatewayCallTimeout(opts.timeoutMs);
|
||||
const context = resolveGatewayCallContext(opts);
|
||||
ensureExplicitGatewayAuth({
|
||||
urlOverride: context.urlOverride,
|
||||
auth: context.explicitAuth,
|
||||
errorHint: "Fix: pass --token or --password (or gatewayToken in tools).",
|
||||
configPath: context.configPath,
|
||||
});
|
||||
ensureRemoteModeUrlConfigured(context);
|
||||
const connectionDetails = buildGatewayConnectionDetails({
|
||||
config: context.config,
|
||||
url: context.urlOverride,
|
||||
...(opts.configPath ? { configPath: opts.configPath } : {}),
|
||||
});
|
||||
const url = connectionDetails.url;
|
||||
const tlsFingerprint = await resolveGatewayTlsFingerprint({ opts, context, url });
|
||||
const { token, password } = resolveGatewayCredentials(context);
|
||||
return await executeGatewayRequestWithScopes<T>({
|
||||
opts,
|
||||
scopes,
|
||||
url,
|
||||
token,
|
||||
password,
|
||||
tlsFingerprint,
|
||||
timeoutMs,
|
||||
safeTimerTimeoutMs,
|
||||
connectionDetails,
|
||||
});
|
||||
}
|
||||
|
||||
export async function callGatewayScoped<T = Record<string, unknown>>(
|
||||
opts: CallGatewayScopedOptions,
|
||||
): Promise<T> {
|
||||
|
||||
Reference in New Issue
Block a user