@alfe.ai/openclaw-remote 0.0.0 → 0.0.2

package/dist/index.cjs

@@ -1,2 +1,7 @@
-const require_plugin = require("./plugin.cjs");
-module.exports = require_plugin;
+Object.defineProperties(exports, {
+	__esModule: { value: true },
+	[Symbol.toStringTag]: { value: "Module" }
+});
+const require_plugin = require("./plugin2.cjs");
+exports.buildIsNavigationAllowed = require_plugin.buildIsNavigationAllowed;
+exports.default = require_plugin.plugin;

package/dist/index.d.cts

@@ -1,2 +1,45 @@
 import { n as RemotePluginConfig, t as plugin } from "./plugin.cjs";
-export { type RemotePluginConfig, plugin as default };
+
+//#region src/ssrf.d.ts
+
+/**
+ * SSRF navigation guard for the shared co-browse surface.
+ *
+ * Builds the `isNavigationAllowed` predicate that `BrowserSurface` consults
+ * before the AGENT's `browser_navigate` tool drives a `page.goto` (see
+ * @alfe.ai/browser `BrowserAutomation.navigate`). v1 is a synchronous
+ * hostname / IP-literal check: it blocks navigation to private, loopback,
+ * link-local, `.internal`, and cloud-metadata (169.254.169.254) hosts UNLESS
+ * the integration's SSRF policy explicitly allows the private network
+ * (`dangerouslyAllowPrivateNetwork`). The policy is the same one the `alfe`
+ * integration exposes under `browser.ssrfPolicy` and threads into runtime
+ * config.
+ *
+ * SCOPE — what this guard does and does NOT cover:
+ *   - GATES the AGENT's `browser_navigate` tool (the only path through
+ *     `automation.navigate`).
+ *   - Does NOT gate HUMAN navigation during a takeover: the human types URLs
+ *     into the live browser and those never pass through this predicate.
+ *     Blocking that requires CDP-level request interception
+ *     (`Fetch.enable` / `Network.requestIntercept`) inside the surface —
+ *     deferred (follow-up).
+ *   - Does NOT defend against DNS rebinding: we deliberately do not resolve
+ *     hostnames to IPs here (no async DNS in a sync predicate). A public
+ *     hostname that resolves to a private IP at goto-time is NOT caught in v1
+ *     — also a follow-up (resolve-and-recheck, or CDP-level enforcement).
+ */
+interface SsrfPolicy {
+  /** When true, disables the private-network block entirely (allow-all). */
+  dangerouslyAllowPrivateNetwork?: boolean;
+}
+/**
+ * Build the navigation predicate for a given SSRF policy. When
+ * `dangerouslyAllowPrivateNetwork` is true the predicate is allow-all
+ * (matching the `alfe` integration's current default); otherwise it blocks
+ * the reserved ranges above and any non-http(s) scheme.
+ */
+declare function buildIsNavigationAllowed(policy: SsrfPolicy | undefined, log?: {
+  warn(msg: string): void;
+}): (url: string) => boolean;
+//#endregion
+export { type RemotePluginConfig, type SsrfPolicy, buildIsNavigationAllowed, plugin as default };

package/dist/index.d.ts

@@ -1,2 +1,45 @@
 import { n as RemotePluginConfig, t as plugin } from "./plugin.js";
-export { type RemotePluginConfig, plugin as default };
+
+//#region src/ssrf.d.ts
+
+/**
+ * SSRF navigation guard for the shared co-browse surface.
+ *
+ * Builds the `isNavigationAllowed` predicate that `BrowserSurface` consults
+ * before the AGENT's `browser_navigate` tool drives a `page.goto` (see
+ * @alfe.ai/browser `BrowserAutomation.navigate`). v1 is a synchronous
+ * hostname / IP-literal check: it blocks navigation to private, loopback,
+ * link-local, `.internal`, and cloud-metadata (169.254.169.254) hosts UNLESS
+ * the integration's SSRF policy explicitly allows the private network
+ * (`dangerouslyAllowPrivateNetwork`). The policy is the same one the `alfe`
+ * integration exposes under `browser.ssrfPolicy` and threads into runtime
+ * config.
+ *
+ * SCOPE — what this guard does and does NOT cover:
+ *   - GATES the AGENT's `browser_navigate` tool (the only path through
+ *     `automation.navigate`).
+ *   - Does NOT gate HUMAN navigation during a takeover: the human types URLs
+ *     into the live browser and those never pass through this predicate.
+ *     Blocking that requires CDP-level request interception
+ *     (`Fetch.enable` / `Network.requestIntercept`) inside the surface —
+ *     deferred (follow-up).
+ *   - Does NOT defend against DNS rebinding: we deliberately do not resolve
+ *     hostnames to IPs here (no async DNS in a sync predicate). A public
+ *     hostname that resolves to a private IP at goto-time is NOT caught in v1
+ *     — also a follow-up (resolve-and-recheck, or CDP-level enforcement).
+ */
+interface SsrfPolicy {
+  /** When true, disables the private-network block entirely (allow-all). */
+  dangerouslyAllowPrivateNetwork?: boolean;
+}
+/**
+ * Build the navigation predicate for a given SSRF policy. When
+ * `dangerouslyAllowPrivateNetwork` is true the predicate is allow-all
+ * (matching the `alfe` integration's current default); otherwise it blocks
+ * the reserved ranges above and any non-http(s) scheme.
+ */
+declare function buildIsNavigationAllowed(policy: SsrfPolicy | undefined, log?: {
+  warn(msg: string): void;
+}): (url: string) => boolean;
+//#endregion
+export { type RemotePluginConfig, type SsrfPolicy, buildIsNavigationAllowed, plugin as default };

package/dist/index.js

@@ -1,2 +1,2 @@
-import plugin from "./plugin.js";
-export { plugin as default };
+import { n as buildIsNavigationAllowed, t as plugin } from "./plugin2.js";
+export { buildIsNavigationAllowed, plugin as default };

package/dist/plugin.cjs

@@ -1,304 +1,2 @@
-let _alfe_ai_config = require("@alfe.ai/config");
-let _alfe_ai_agent_api_client = require("@alfe.ai/agent-api-client");
-let _alfe_ai_remote = require("@alfe.ai/remote");
-let _alfe_ai_browser = require("@alfe.ai/browser");
-let _alfe_ai_terminal = require("@alfe.ai/terminal");
-//#region src/plugin.ts
-/**
-* @alfe.ai/openclaw-remote — OpenClaw plugin for the interactive remote-control
-* relay. Owns one outbound WS to the relay and routes per-session frames to the
-* browser co-browse surface (@alfe.ai/browser) or the web terminal surface
-* (@alfe.ai/terminal). Registers the agent-callable browser tools, including
-* `request_browser_takeover` ("help me complete these").
-*
-* Follows the established Alfe plugin shape (see @alfe.ai/openclaw-webhooks):
-* tools register on every activate(); the long-lived connection is guarded and
-* created inside registerService.start.
-*/
-const pkg = (0, require("node:module").createRequire)(require("url").pathToFileURL(__filename).href)("../package.json");
-const ACTIVATED_KEY = "__alfeRemotePluginActivated";
-const DEFAULT_HANDOFF_TIMEOUT_MS = 600 * 1e3;
-const DEFAULT_CHROME_PATH = "/usr/bin/google-chrome-stable";
-let remoteClient = null;
-let browserSurface = null;
-let terminalSurface = null;
-let apiClient = null;
-let handoffTimeoutMs = DEFAULT_HANDOFF_TIMEOUT_MS;
-const sessionSurfaces = /* @__PURE__ */ new Map();
-function g() {
-	return globalThis;
-}
-/** Coerce an unknown tool param to a string (empty if not a string). */
-function asStr(v) {
-	return typeof v === "string" ? v : "";
-}
-/** Coerce an unknown tool param to a string or undefined. */
-function optStr(v) {
-	return typeof v === "string" ? v : void 0;
-}
-/** Route an inbound relay frame to the owning surface by session. */
-function dispatchFrame(frame, log) {
-	if (frame.type === _alfe_ai_remote.RemoteFrameType.SESSION_OPEN) {
-		const open = (0, _alfe_ai_remote.decodeJson)(frame.payload);
-		if (!open) return;
-		const handler = open.surface === "terminal" ? terminalSurface : browserSurface;
-		if (!handler) {
-			log.warn(`No handler for surface ${open.surface}`);
-			return;
-		}
-		sessionSurfaces.set(frame.sessionId, open.surface);
-		Promise.resolve(handler.openSession(frame.sessionId, open)).catch((err) => {
-			log.warn(`openSession failed: ${err.message}`);
-		});
-		return;
-	}
-	const surface = sessionSurfaces.get(frame.sessionId);
-	const handler = surface === "terminal" ? terminalSurface : surface === "browser" ? browserSurface : null;
-	if (!handler) return;
-	if (frame.type === _alfe_ai_remote.RemoteFrameType.SESSION_CLOSE) {
-		handler.closeSession(frame.sessionId);
-		sessionSurfaces.delete(frame.sessionId);
-		return;
-	}
-	handler.handleFrame(frame);
-}
-function startService(pluginConfig, workspaceDir, log) {
-	if (g()[ACTIVATED_KEY] === true) {
-		log.debug("Alfe Remote plugin already activated — skipping duplicate");
-		return;
-	}
-	g()[ACTIVATED_KEY] = true;
-	let alfeConfig = null;
-	try {
-		alfeConfig = (0, _alfe_ai_config.resolveConfig)();
-	} catch {
-		log.info("Could not resolve Alfe config — remote plugin idle");
-	}
-	const wsUrl = pluginConfig.remoteWsUrl;
-	const apiKey = alfeConfig?.apiKey;
-	const apiUrl = alfeConfig?.apiUrl;
-	if (!wsUrl || !apiKey || !apiUrl) {
-		log.info("Remote relay URL or credentials not configured — plugin running without relay");
-		g()[ACTIVATED_KEY] = false;
-		return;
-	}
-	handoffTimeoutMs = pluginConfig.handoffTimeoutMs ?? DEFAULT_HANDOFF_TIMEOUT_MS;
-	apiClient = new _alfe_ai_agent_api_client.AgentApiClient({
-		apiKey,
-		apiUrl
-	});
-	const sendFrame = (buf) => {
-		remoteClient?.sendFrame(buf);
-	};
-	browserSurface = new _alfe_ai_browser.BrowserSurface({
-		executablePath: pluginConfig.browserExecutablePath ?? DEFAULT_CHROME_PATH,
-		headless: pluginConfig.browserHeadless ?? true,
-		noSandbox: pluginConfig.browserNoSandbox ?? true,
-		userDataDir: `${workspaceDir ?? alfeConfig?.workspacePath ?? "."}/.alfe-browser-profile`,
-		logger: log
-	}, sendFrame);
-	terminalSurface = new _alfe_ai_terminal.TerminalSurface({
-		cwd: workspaceDir ?? alfeConfig?.workspacePath,
-		logger: log
-	}, sendFrame);
-	remoteClient = new _alfe_ai_remote.RemoteServiceClient({
-		wsUrl,
-		apiKey,
-		onFrame: (frame) => {
-			dispatchFrame(frame, log);
-		},
-		onConnectionChange: (connected) => {
-			log.info(`Remote relay connection: ${connected ? "connected" : "disconnected"}`);
-		},
-		logger: log
-	});
-	remoteClient.start();
-	log.info(`Remote plugin started — relay ${wsUrl}`);
-}
-function stopService(log) {
-	g()[ACTIVATED_KEY] = false;
-	remoteClient?.stop();
-	remoteClient = null;
-	browserSurface?.shutdown();
-	browserSurface = null;
-	terminalSurface?.shutdown();
-	terminalSurface = null;
-	apiClient = null;
-	sessionSurfaces.clear();
-	log.info("Remote plugin stopped");
-}
-function registerTools(api) {
-	const needBrowser = () => {
-		if (!browserSurface) throw new Error("Browser surface not available (remote relay not connected)");
-		return browserSurface;
-	};
-	api.registerTool({
-		name: "browser_navigate",
-		label: "browser_navigate",
-		description: "Navigate the shared browser to a URL. Returns the final URL and page title.",
-		parameters: {
-			type: "object",
-			properties: { url: {
-				type: "string",
-				description: "The URL to open"
-			} },
-			required: ["url"]
-		},
-		execute: async (_id, params) => needBrowser().automation.navigate(asStr(params.url))
-	});
-	api.registerTool({
-		name: "browser_click",
-		label: "browser_click",
-		description: "Click an element in the shared browser by CSS selector.",
-		parameters: {
-			type: "object",
-			properties: { selector: {
-				type: "string",
-				description: "CSS selector to click"
-			} },
-			required: ["selector"]
-		},
-		execute: async (_id, params) => {
-			await needBrowser().automation.click(asStr(params.selector));
-			return { ok: true };
-		}
-	});
-	api.registerTool({
-		name: "browser_type",
-		label: "browser_type",
-		description: "Type text into an element in the shared browser by CSS selector.",
-		parameters: {
-			type: "object",
-			properties: {
-				selector: {
-					type: "string",
-					description: "CSS selector of the input"
-				},
-				text: {
-					type: "string",
-					description: "Text to type"
-				}
-			},
-			required: ["selector", "text"]
-		},
-		execute: async (_id, params) => {
-			await needBrowser().automation.type(asStr(params.selector), asStr(params.text));
-			return { ok: true };
-		}
-	});
-	api.registerTool({
-		name: "browser_wait_for",
-		label: "browser_wait_for",
-		description: "Wait for a selector to appear, a URL substring to match, or a fixed delay.",
-		parameters: {
-			type: "object",
-			properties: {
-				selector: { type: "string" },
-				urlPattern: { type: "string" },
-				ms: { type: "number" }
-			}
-		},
-		execute: async (_id, params) => {
-			await needBrowser().automation.waitFor({
-				selector: optStr(params.selector),
-				urlPattern: optStr(params.urlPattern),
-				ms: typeof params.ms === "number" ? params.ms : void 0
-			});
-			return { ok: true };
-		}
-	});
-	api.registerTool({
-		name: "browser_screenshot",
-		label: "browser_screenshot",
-		description: "Capture a JPEG screenshot of the shared browser's current page (base64).",
-		parameters: {
-			type: "object",
-			properties: {}
-		},
-		execute: async () => ({ imageBase64: await needBrowser().automation.screenshot() })
-	});
-	api.registerTool({
-		name: "browser_evaluate",
-		label: "browser_evaluate",
-		description: "Evaluate a JavaScript expression in the shared browser page and return the result.",
-		parameters: {
-			type: "object",
-			properties: { expression: {
-				type: "string",
-				description: "JS expression to evaluate"
-			} },
-			required: ["expression"]
-		},
-		execute: async (_id, params) => ({ result: await needBrowser().automation.evaluate(asStr(params.expression)) })
-	});
-	api.registerTool({
-		name: "request_browser_takeover",
-		label: "request_browser_takeover",
-		description: "Ask a human to take over the browser you're currently looking at and complete a step you can't do yourself — logging in, solving a captcha, or clicking through a manual flow. The human sees your current live page, completes the instructions, and hands control back; you then resume on the same authenticated page. Blocks until the human is done or the request times out.",
-		parameters: {
-			type: "object",
-			properties: {
-				instructions: {
-					type: "string",
-					description: "What you need the human to do, e.g. 'Log in with the saved credentials and complete the 2FA prompt, then click Continue.'"
-				},
-				url: {
-					type: "string",
-					description: "Optional: the page you're stuck on (display only — the human sees your live page)."
-				},
-				conversationId: {
-					type: "string",
-					description: "Optional: the chat conversation to surface the request in."
-				}
-			},
-			required: ["instructions"]
-		},
-		execute: async (_id, params) => {
-			const surface = needBrowser();
-			if (!apiClient) throw new Error("Remote plugin not connected");
-			const { sessionId } = await apiClient.requestBrowserTakeover({
-				instructions: asStr(params.instructions),
-				url: optStr(params.url),
-				conversationId: optStr(params.conversationId)
-			});
-			try {
-				return {
-					sessionId,
-					...await surface.requestHandoff(handoffTimeoutMs)
-				};
-			} finally {
-				await apiClient.completeRemoteSession(sessionId).catch(() => {});
-			}
-		}
-	});
-}
-const plugin = {
-	id: "@alfe.ai/openclaw-remote",
-	name: "Remote",
-	description: "Interactive remote control — browser co-browse takeover and web terminal",
-	version: pkg.version,
-	activate(api) {
-		const log = api.logger;
-		const pluginConfig = api.config?.plugins?.entries?.["@alfe.ai/openclaw-remote"]?.config ?? {};
-		pluginConfig.browserExecutablePath ??= api.config?.browser?.executablePath;
-		pluginConfig.browserHeadless ??= api.config?.browser?.headless;
-		pluginConfig.browserNoSandbox ??= api.config?.browser?.noSandbox;
-		registerTools(api);
-		api.registerService({
-			id: "alfe-remote",
-			start: (ctx) => {
-				startService(pluginConfig, ctx.workspaceDir, log);
-			},
-			stop: () => {
-				stopService(log);
-			}
-		});
-		log.info("Alfe Remote plugin activated");
-	},
-	deactivate(api) {
-		stopService(api.logger);
-		api.logger.info("Alfe Remote plugin deactivated");
-	}
-};
-//#endregion
-module.exports = plugin;
+const require_plugin = require("./plugin2.cjs");
+module.exports = require_plugin.plugin;

package/dist/plugin.d.cts

@@ -37,6 +37,10 @@ interface OpenClawConfig {
     executablePath?: string;
     headless?: boolean;
     noSandbox?: boolean;
+    /** SSRF policy the `alfe` integration writes; consumed by the nav guard. */
+    ssrfPolicy?: {
+      dangerouslyAllowPrivateNetwork?: boolean;
+    };
     [key: string]: unknown;
   };
   [key: string]: unknown;

package/dist/plugin.d.ts

@@ -37,6 +37,10 @@ interface OpenClawConfig {
     executablePath?: string;
     headless?: boolean;
     noSandbox?: boolean;
+    /** SSRF policy the `alfe` integration writes; consumed by the nav guard. */
+    ssrfPolicy?: {
+      dangerouslyAllowPrivateNetwork?: boolean;
+    };
     [key: string]: unknown;
   };
   [key: string]: unknown;