import os from "node:os"; import { resolveGatewayPort } from "../config/paths.js"; import type { OpenClawConfig } from "../config/types.js"; import { normalizeSecretInputString, resolveSecretInputRef } from "../config/types.secrets.js"; import { secretRefKey } from "../secrets/ref-contract.js"; import { resolveSecretRefValues } from "../secrets/resolve.js"; import { resolveGatewayBindUrl } from "../shared/gateway-bind-url.js"; import { isCarrierGradeNatIpv4Address, isRfc1918Ipv4Address } from "../shared/net/ip.js"; import { resolveTailnetHostWithRunner } from "../shared/tailscale-status.js"; export type PairingSetupPayload = { url: string; token?: string; password?: string; }; export type PairingSetupCommandResult = { code: number | null; stdout: string; stderr?: string; }; export type PairingSetupCommandRunner = ( argv: string[], opts: { timeoutMs: number }, ) => Promise; export type ResolvePairingSetupOptions = { env?: NodeJS.ProcessEnv; publicUrl?: string; preferRemoteUrl?: boolean; forceSecure?: boolean; runCommandWithTimeout?: PairingSetupCommandRunner; networkInterfaces?: () => ReturnType; }; export type PairingSetupResolution = | { ok: true; payload: PairingSetupPayload; authLabel: "token" | "password"; urlSource: string; } | { ok: false; error: string; }; type ResolveUrlResult = { url?: string; source?: string; error?: string; }; type ResolveAuthResult = { token?: string; password?: string; label?: "token" | "password"; error?: string; }; function normalizeUrl(raw: string, schemeFallback: "ws" | "wss"): string | null { const trimmed = raw.trim(); if (!trimmed) { return null; } try { const parsed = new URL(trimmed); const scheme = parsed.protocol.replace(":", ""); if (!scheme) { return null; } const resolvedScheme = scheme === "http" ? "ws" : scheme === "https" ? "wss" : scheme; if (resolvedScheme !== "ws" && resolvedScheme !== "wss") { return null; } const host = parsed.hostname; if (!host) { return null; } const port = parsed.port ? `:${parsed.port}` : ""; return `${resolvedScheme}://${host}${port}`; } catch { // Fall through to host:port parsing. } const withoutPath = trimmed.split("/")[0] ?? ""; if (!withoutPath) { return null; } return `${schemeFallback}://${withoutPath}`; } function resolveScheme( cfg: OpenClawConfig, opts?: { forceSecure?: boolean; }, ): "ws" | "wss" { if (opts?.forceSecure) { return "wss"; } return cfg.gateway?.tls?.enabled === true ? "wss" : "ws"; } function isPrivateIPv4(address: string): boolean { return isRfc1918Ipv4Address(address); } function isTailnetIPv4(address: string): boolean { return isCarrierGradeNatIpv4Address(address); } function pickIPv4Matching( networkInterfaces: () => ReturnType, matches: (address: string) => boolean, ): string | null { const nets = networkInterfaces(); for (const entries of Object.values(nets)) { if (!entries) { continue; } for (const entry of entries) { const family = entry?.family; const isIpv4 = family === "IPv4"; if (!entry || entry.internal || !isIpv4) { continue; } const address = entry.address?.trim() ?? ""; if (!address) { continue; } if (matches(address)) { return address; } } } return null; } function pickLanIPv4( networkInterfaces: () => ReturnType, ): string | null { return pickIPv4Matching(networkInterfaces, isPrivateIPv4); } function pickTailnetIPv4( networkInterfaces: () => ReturnType, ): string | null { return pickIPv4Matching(networkInterfaces, isTailnetIPv4); } function resolveAuth(cfg: OpenClawConfig, env: NodeJS.ProcessEnv): ResolveAuthResult { const mode = cfg.gateway?.auth?.mode; const token = env.OPENCLAW_GATEWAY_TOKEN?.trim() || env.CLAWDBOT_GATEWAY_TOKEN?.trim() || cfg.gateway?.auth?.token?.trim(); const password = env.OPENCLAW_GATEWAY_PASSWORD?.trim() || env.CLAWDBOT_GATEWAY_PASSWORD?.trim() || normalizeSecretInputString(cfg.gateway?.auth?.password); if (mode === "password") { if (!password) { return { error: "Gateway auth is set to password, but no password is configured." }; } return { password, label: "password" }; } if (mode === "token") { if (!token) { return { error: "Gateway auth is set to token, but no token is configured." }; } return { token, label: "token" }; } if (token) { return { token, label: "token" }; } if (password) { return { password, label: "password" }; } return { error: "Gateway auth is not configured (no token or password)." }; } async function resolveGatewayPasswordSecretRef( cfg: OpenClawConfig, env: NodeJS.ProcessEnv, ): Promise { const authPassword = cfg.gateway?.auth?.password; const { ref } = resolveSecretInputRef({ value: authPassword, defaults: cfg.secrets?.defaults, }); if (!ref) { return cfg; } const hasPasswordEnvCandidate = Boolean( env.OPENCLAW_GATEWAY_PASSWORD?.trim() || env.CLAWDBOT_GATEWAY_PASSWORD?.trim(), ); if (hasPasswordEnvCandidate) { return cfg; } const mode = cfg.gateway?.auth?.mode; if (mode === "token" || mode === "none" || mode === "trusted-proxy") { return cfg; } if (mode !== "password") { const hasTokenCandidate = Boolean(env.OPENCLAW_GATEWAY_TOKEN?.trim() || env.CLAWDBOT_GATEWAY_TOKEN?.trim()) || Boolean(cfg.gateway?.auth?.token?.trim()); if (hasTokenCandidate) { return cfg; } } const resolved = await resolveSecretRefValues([ref], { config: cfg, env, }); const value = resolved.get(secretRefKey(ref)); if (typeof value !== "string" || value.trim().length === 0) { throw new Error("gateway.auth.password resolved to an empty or non-string value."); } return { ...cfg, gateway: { ...cfg.gateway, auth: { ...cfg.gateway?.auth, password: value.trim(), }, }, }; } async function resolveGatewayUrl( cfg: OpenClawConfig, opts: { env: NodeJS.ProcessEnv; publicUrl?: string; preferRemoteUrl?: boolean; forceSecure?: boolean; runCommandWithTimeout?: PairingSetupCommandRunner; networkInterfaces: () => ReturnType; }, ): Promise { const scheme = resolveScheme(cfg, { forceSecure: opts.forceSecure }); const port = resolveGatewayPort(cfg, opts.env); if (typeof opts.publicUrl === "string" && opts.publicUrl.trim()) { const url = normalizeUrl(opts.publicUrl, scheme); if (url) { return { url, source: "plugins.entries.device-pair.config.publicUrl" }; } return { error: "Configured publicUrl is invalid." }; } const remoteUrlRaw = cfg.gateway?.remote?.url; const remoteUrl = typeof remoteUrlRaw === "string" && remoteUrlRaw.trim() ? normalizeUrl(remoteUrlRaw, scheme) : null; if (opts.preferRemoteUrl && remoteUrl) { return { url: remoteUrl, source: "gateway.remote.url" }; } const tailscaleMode = cfg.gateway?.tailscale?.mode ?? "off"; if (tailscaleMode === "serve" || tailscaleMode === "funnel") { const host = await resolveTailnetHostWithRunner(opts.runCommandWithTimeout); if (!host) { return { error: "Tailscale Serve is enabled, but MagicDNS could not be resolved." }; } return { url: `wss://${host}`, source: `gateway.tailscale.mode=${tailscaleMode}` }; } if (remoteUrl) { return { url: remoteUrl, source: "gateway.remote.url" }; } const bindResult = resolveGatewayBindUrl({ bind: cfg.gateway?.bind, customBindHost: cfg.gateway?.customBindHost, scheme, port, pickTailnetHost: () => pickTailnetIPv4(opts.networkInterfaces), pickLanHost: () => pickLanIPv4(opts.networkInterfaces), }); if (bindResult) { return bindResult; } return { error: "Gateway is only bound to loopback. Set gateway.bind=lan, enable tailscale serve, or configure plugins.entries.device-pair.config.publicUrl.", }; } export function encodePairingSetupCode(payload: PairingSetupPayload): string { const json = JSON.stringify(payload); const base64 = Buffer.from(json, "utf8").toString("base64"); return base64.replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/g, ""); } export async function resolvePairingSetupFromConfig( cfg: OpenClawConfig, options: ResolvePairingSetupOptions = {}, ): Promise { const env = options.env ?? process.env; const cfgForAuth = await resolveGatewayPasswordSecretRef(cfg, env); const auth = resolveAuth(cfgForAuth, env); if (auth.error) { return { ok: false, error: auth.error }; } const urlResult = await resolveGatewayUrl(cfgForAuth, { env, publicUrl: options.publicUrl, preferRemoteUrl: options.preferRemoteUrl, forceSecure: options.forceSecure, runCommandWithTimeout: options.runCommandWithTimeout, networkInterfaces: options.networkInterfaces ?? os.networkInterfaces, }); if (!urlResult.url) { return { ok: false, error: urlResult.error ?? "Gateway URL unavailable." }; } if (!auth.label) { return { ok: false, error: "Gateway auth is not configured (no token or password)." }; } return { ok: true, payload: { url: urlResult.url, token: auth.token, password: auth.password, }, authLabel: auth.label, urlSource: urlResult.source ?? "unknown", }; }