mirror of
https://github.com/moltbot/moltbot.git
synced 2026-05-09 01:05:44 +00:00
Adds `openclaw proxy validate` for operator-managed proxy preflight checks, including allowed/denied destination validation, CLI output, tests, docs, and changelog coverage. Maintainer follow-ups before landing: - validate custom allowed URLs before probing; - use a temporary loopback canary for default denied checks and fail custom denied transport errors as unverifiable; - redact proxy URL userinfo, query strings, and fragments from text/JSON validation output. Validation: - `pnpm test src/infra/net/proxy/proxy-validation.test.ts src/cli/proxy-cli.runtime.test.ts src/cli/proxy-cli.test.ts -- --reporter=verbose` - `pnpm exec oxfmt --check --threads=1 CHANGELOG.md src/cli/proxy-cli.ts src/cli/proxy-cli.runtime.ts src/cli/proxy-cli.test.ts src/cli/proxy-cli.runtime.test.ts src/infra/net/proxy/proxy-validation.ts src/infra/net/proxy/proxy-validation.test.ts docs/cli/proxy.md docs/security/network-proxy.md` - `pnpm exec oxlint src/cli/proxy-cli.runtime.ts src/cli/proxy-cli.runtime.test.ts` - `git diff --check` - Testbox `pnpm install && OPENCLAW_TESTBOX=1 pnpm check:changed` on `tbx_01kqgz68ff20n3dtrgq0j1mykt` - GitHub CI success on `321b3aaf2b8be27dec6ce2ac5e4007ed064218b5`
298 lines
8.9 KiB
TypeScript
298 lines
8.9 KiB
TypeScript
import { spawn } from "node:child_process";
|
|
import { randomUUID } from "node:crypto";
|
|
import process from "node:process";
|
|
import { getRuntimeConfig } from "../config/config.js";
|
|
import {
|
|
runProxyValidation,
|
|
type ProxyValidationResult,
|
|
} from "../infra/net/proxy/proxy-validation.js";
|
|
import { ensureDebugProxyCa } from "../proxy-capture/ca.js";
|
|
import { buildDebugProxyCoverageReport } from "../proxy-capture/coverage.js";
|
|
import { resolveDebugProxySettings, applyDebugProxyEnv } from "../proxy-capture/env.js";
|
|
import { startDebugProxyServer } from "../proxy-capture/proxy-server.js";
|
|
import {
|
|
finalizeDebugProxyCapture,
|
|
initializeDebugProxyCapture,
|
|
} from "../proxy-capture/runtime.js";
|
|
import {
|
|
closeDebugProxyCaptureStore,
|
|
getDebugProxyCaptureStore,
|
|
} from "../proxy-capture/store.sqlite.js";
|
|
import type { CaptureQueryPreset } from "../proxy-capture/types.js";
|
|
|
|
export async function runDebugProxyStartCommand(opts: { host?: string; port?: number }) {
|
|
const settings = resolveDebugProxySettings();
|
|
const store = getDebugProxyCaptureStore(settings.dbPath, settings.blobDir);
|
|
store.upsertSession({
|
|
id: settings.sessionId,
|
|
startedAt: Date.now(),
|
|
mode: "proxy-start",
|
|
sourceScope: "openclaw",
|
|
sourceProcess: "openclaw",
|
|
proxyUrl: settings.proxyUrl,
|
|
dbPath: settings.dbPath,
|
|
blobDir: settings.blobDir,
|
|
});
|
|
initializeDebugProxyCapture("proxy-start", settings);
|
|
const ca = await ensureDebugProxyCa(settings.certDir);
|
|
const server = await startDebugProxyServer({
|
|
host: opts.host,
|
|
port: opts.port,
|
|
settings,
|
|
});
|
|
process.stdout.write(`Debug proxy: ${server.proxyUrl}\n`);
|
|
process.stdout.write(`CA cert: ${ca.certPath}\n`);
|
|
process.stdout.write(`Capture DB: ${settings.dbPath}\n`);
|
|
process.stdout.write("Press Ctrl+C to stop.\n");
|
|
const shutdown = async () => {
|
|
process.off("SIGINT", onSignal);
|
|
process.off("SIGTERM", onSignal);
|
|
await server.stop();
|
|
if (settings.enabled) {
|
|
finalizeDebugProxyCapture(settings);
|
|
} else {
|
|
store.endSession(settings.sessionId);
|
|
closeDebugProxyCaptureStore();
|
|
}
|
|
process.exit(0);
|
|
};
|
|
const onSignal = () => {
|
|
void shutdown();
|
|
};
|
|
process.on("SIGINT", onSignal);
|
|
process.on("SIGTERM", onSignal);
|
|
await new Promise(() => undefined);
|
|
}
|
|
|
|
export async function runDebugProxyRunCommand(opts: {
|
|
host?: string;
|
|
port?: number;
|
|
commandArgs: string[];
|
|
}) {
|
|
if (opts.commandArgs.length === 0) {
|
|
throw new Error("proxy run requires a command after --");
|
|
}
|
|
const sessionId = randomUUID();
|
|
const baseSettings = resolveDebugProxySettings();
|
|
const settings = {
|
|
...baseSettings,
|
|
sessionId,
|
|
};
|
|
getDebugProxyCaptureStore(settings.dbPath, settings.blobDir).upsertSession({
|
|
id: sessionId,
|
|
startedAt: Date.now(),
|
|
mode: "proxy-run",
|
|
sourceScope: "openclaw",
|
|
sourceProcess: "openclaw",
|
|
proxyUrl: undefined,
|
|
dbPath: settings.dbPath,
|
|
blobDir: settings.blobDir,
|
|
});
|
|
const server = await startDebugProxyServer({
|
|
host: opts.host,
|
|
port: opts.port,
|
|
settings,
|
|
});
|
|
const [command, ...args] = opts.commandArgs;
|
|
const childEnv = applyDebugProxyEnv(process.env, {
|
|
proxyUrl: server.proxyUrl,
|
|
sessionId,
|
|
dbPath: settings.dbPath,
|
|
blobDir: settings.blobDir,
|
|
certDir: settings.certDir,
|
|
});
|
|
try {
|
|
await new Promise<void>((resolve, reject) => {
|
|
const child = spawn(command, args, {
|
|
stdio: "inherit",
|
|
env: childEnv,
|
|
cwd: process.cwd(),
|
|
});
|
|
child.once("error", reject);
|
|
child.once("exit", (code, signal) => {
|
|
process.exitCode = signal ? 1 : (code ?? 1);
|
|
resolve();
|
|
});
|
|
});
|
|
} finally {
|
|
await server.stop();
|
|
getDebugProxyCaptureStore(settings.dbPath, settings.blobDir).endSession(sessionId);
|
|
}
|
|
}
|
|
|
|
function redactProxyUrl(value: string | undefined): string | undefined {
|
|
if (!value) {
|
|
return undefined;
|
|
}
|
|
try {
|
|
const url = new URL(value);
|
|
if (url.username || url.password) {
|
|
url.username = "redacted";
|
|
url.password = "redacted";
|
|
}
|
|
url.search = "";
|
|
url.hash = "";
|
|
return url.toString();
|
|
} catch {
|
|
return "<invalid proxy URL>";
|
|
}
|
|
}
|
|
|
|
function redactProxyValidationResult(result: ProxyValidationResult): ProxyValidationResult {
|
|
return {
|
|
...result,
|
|
config: {
|
|
...result.config,
|
|
proxyUrl: redactProxyUrl(result.config.proxyUrl),
|
|
},
|
|
};
|
|
}
|
|
|
|
function formatProxyCheckLine(check: ProxyValidationResult["checks"][number]): string {
|
|
const icon = check.ok ? "✓" : "✗";
|
|
const paddedKind = check.kind.padEnd(7, " ");
|
|
const status = check.status === undefined ? "" : ` HTTP ${check.status}`;
|
|
return ` ${icon} ${paddedKind} ${check.url}${status}`;
|
|
}
|
|
|
|
function formatProxyValidationNextSteps(result: ProxyValidationResult): string[] {
|
|
if (result.ok) {
|
|
return [];
|
|
}
|
|
if (result.config.errors.some((error) => error.includes("proxy.enabled"))) {
|
|
return [
|
|
"Enable proxy.enabled with proxy.proxyUrl or OPENCLAW_PROXY_URL, or pass --proxy-url for an explicit one-off validation.",
|
|
];
|
|
}
|
|
if (result.config.errors.length > 0) {
|
|
return [
|
|
"Fix proxy.proxyUrl, OPENCLAW_PROXY_URL, or --proxy-url so it uses a reachable http:// proxy.",
|
|
];
|
|
}
|
|
if (result.checks.some((check) => !check.ok && check.kind === "allowed")) {
|
|
return [
|
|
"Confirm the proxy is reachable from this deployment context and permits the allowed destinations.",
|
|
];
|
|
}
|
|
if (result.checks.some((check) => !check.ok && check.kind === "denied")) {
|
|
return [
|
|
"Update the proxy ACL so denied destinations are blocked, or pass the expected --denied-url values.",
|
|
];
|
|
}
|
|
return [
|
|
"Review the failed checks above and update proxy configuration or validation destinations.",
|
|
];
|
|
}
|
|
|
|
function formatProxyValidationText(result: ProxyValidationResult): string {
|
|
const redactedProxyUrl = redactProxyUrl(result.config.proxyUrl);
|
|
const lines = [
|
|
`Proxy validation ${result.ok ? "passed" : "failed"}`,
|
|
"",
|
|
"Proxy",
|
|
` Source: ${result.config.source}`,
|
|
` URL: ${redactedProxyUrl ?? "not configured"}`,
|
|
];
|
|
|
|
if (result.config.errors.length > 0) {
|
|
lines.push("", "Problems");
|
|
for (const error of result.config.errors) {
|
|
lines.push(` - ${error}`);
|
|
}
|
|
}
|
|
|
|
if (result.checks.length > 0) {
|
|
lines.push("", "Checks");
|
|
for (const check of result.checks) {
|
|
lines.push(formatProxyCheckLine(check));
|
|
if (check.error) {
|
|
lines.push(` ${check.error}`);
|
|
}
|
|
}
|
|
}
|
|
|
|
const nextSteps = formatProxyValidationNextSteps(result);
|
|
if (nextSteps.length > 0) {
|
|
lines.push("", "Next steps");
|
|
for (const nextStep of nextSteps) {
|
|
lines.push(` ${nextStep}`);
|
|
}
|
|
}
|
|
|
|
return `${lines.join("\n")}\n`;
|
|
}
|
|
|
|
export async function runProxyValidateCommand(opts: {
|
|
json?: boolean;
|
|
proxyUrl?: string;
|
|
allowedUrls?: string[];
|
|
deniedUrls?: string[];
|
|
timeoutMs?: number;
|
|
}) {
|
|
const config = getRuntimeConfig();
|
|
const result = await runProxyValidation({
|
|
config: config?.proxy,
|
|
env: process.env,
|
|
proxyUrlOverride: opts.proxyUrl,
|
|
allowedUrls: opts.allowedUrls,
|
|
deniedUrls: opts.deniedUrls,
|
|
timeoutMs: opts.timeoutMs,
|
|
});
|
|
const outputResult = redactProxyValidationResult(result);
|
|
process.stdout.write(
|
|
opts.json === true
|
|
? `${JSON.stringify(outputResult, null, 2)}\n`
|
|
: formatProxyValidationText(outputResult),
|
|
);
|
|
if (!result.ok) {
|
|
process.exitCode = 1;
|
|
}
|
|
}
|
|
|
|
export async function runDebugProxySessionsCommand(opts: { limit?: number }) {
|
|
const settings = resolveDebugProxySettings();
|
|
const sessions = getDebugProxyCaptureStore(settings.dbPath, settings.blobDir).listSessions(
|
|
opts.limit ?? 20,
|
|
);
|
|
process.stdout.write(`${JSON.stringify(sessions, null, 2)}\n`);
|
|
closeDebugProxyCaptureStore();
|
|
}
|
|
|
|
export async function runDebugProxyQueryCommand(opts: {
|
|
preset: CaptureQueryPreset;
|
|
sessionId?: string;
|
|
}) {
|
|
const settings = resolveDebugProxySettings();
|
|
const rows = getDebugProxyCaptureStore(settings.dbPath, settings.blobDir).queryPreset(
|
|
opts.preset,
|
|
opts.sessionId,
|
|
);
|
|
process.stdout.write(`${JSON.stringify(rows, null, 2)}\n`);
|
|
closeDebugProxyCaptureStore();
|
|
}
|
|
|
|
export async function runDebugProxyCoverageCommand() {
|
|
process.stdout.write(`${JSON.stringify(buildDebugProxyCoverageReport(), null, 2)}\n`);
|
|
closeDebugProxyCaptureStore();
|
|
}
|
|
|
|
export async function runDebugProxyPurgeCommand() {
|
|
const settings = resolveDebugProxySettings();
|
|
const result = getDebugProxyCaptureStore(settings.dbPath, settings.blobDir).purgeAll();
|
|
process.stdout.write(`${JSON.stringify(result, null, 2)}\n`);
|
|
closeDebugProxyCaptureStore();
|
|
}
|
|
|
|
export async function readDebugProxyBlobCommand(opts: { blobId: string }) {
|
|
const settings = resolveDebugProxySettings();
|
|
const content = getDebugProxyCaptureStore(settings.dbPath, settings.blobDir).readBlob(
|
|
opts.blobId,
|
|
);
|
|
if (content == null) {
|
|
closeDebugProxyCaptureStore();
|
|
throw new Error(`Unknown blob: ${opts.blobId}`);
|
|
}
|
|
process.stdout.write(content);
|
|
closeDebugProxyCaptureStore();
|
|
}
|