AMPB Route Helper
', 'Set Up Transport
', 'AMPB needs to start a local transport before opening this route.
', ' ', ' ', ' ', ' ', ' ', "from __future__ import annotations from dataclasses import dataclass from dataclasses import replace import json import os from pathlib import Path import secrets import signal import shlex import socket import subprocess import sys import time from urllib.parse import urlparse from .adapters import adapter_for from .config import AppConfig, default_config from .plan import BrowsePlan, plan_url BROKER_PROFILE = "broker" ROUTE_HELPER_EXTENSION_ID = "ampb-route-helper@such.software" HELPER_URL_PLACEHOLDER = "__AMPB_ROUTE_HELPER_URL__" HELPER_TOKEN_PLACEHOLDER = "__AMPB_ROUTE_HELPER_TOKEN__" PROFILE_SESSION_NAME = "ampb-session.json" @dataclass(frozen=True) class ProfileAsset: path: str content: str @dataclass(frozen=True) class RouteHelperLaunch: status: str endpoint: str = "-" token: str = "-" pid: int = 0 watch_pid: int = 0 command: tuple[str, ...] = () message: str = "-" @dataclass(frozen=True) class BrowserLaunchSpec: runtime_path: str profile_path: str user_js_path: str command: tuple[str, ...] prefs: tuple[str, ...] broker: bool = False extension_path: str = "-" extension_assets: tuple[ProfileAsset, ...] = () @dataclass(frozen=True) class OpenPlan: browse_plan: BrowsePlan status: str dry_run: bool consent_granted: bool profile_path: str proxy: str setup_steps: tuple[str, ...] message: str broker: bool = False launch_spec: BrowserLaunchSpec | None = None browser_pid: int = 0 setup_prompt_title: str = "-" setup_prompt_body: str = "-" setup_prompt_approve_label: str = "-" setup_prompt_approval_command: str = "-" transport_setup_status: str = "-" transport_setup_provider: str = "-" transport_setup_provider_source: str = "-" transport_setup_owned: bool = False transport_setup_pid: int = 0 transport_setup_endpoint: str = "-" transport_setup_message: str = "-" route_helper_status: str = "-" route_helper_endpoint: str = "-" route_helper_pid: int = 0 route_helper_message: str = "-" def prepare_open( raw_url: str, *, consent: bool = False, dry_run: bool = True, config: AppConfig | None = None, platform: str | None = None, broker: bool = False, route_aware: bool = False, ) -> OpenPlan: config = config or default_config() browse_plan = plan_url(raw_url, config=config, platform=platform) broker = broker or route_aware if broker and browse_plan.route.transport != "clearnet": return OpenPlan( browse_plan=browse_plan, status="blocked", dry_run=dry_run, consent_granted=consent, profile_path=config.profile_path(BROKER_PROFILE), proxy="-", setup_steps=(), message="broker entry URLs must use clearnet; alternate routes open in their isolated profile", broker=True, ) profile_name = ( BROKER_PROFILE if broker else browse_plan.route.profile ) profile_path = config.profile_path(profile_name) proxy = _proxy_for(browse_plan) launch_spec = _launch_spec_for(browse_plan, config=config, profile_path=profile_path, broker=broker) if browse_plan.action.startswith("blocked"): return OpenPlan( browse_plan=browse_plan, status="blocked", dry_run=dry_run, consent_granted=consent, profile_path=profile_path, proxy=proxy, setup_steps=(), message=browse_plan.action, broker=broker, launch_spec=launch_spec, ) if browse_plan.requires_consent: setup_steps = _setup_steps(browse_plan) setup_prompt = _setup_prompt(browse_plan, setup_steps) if not consent: return OpenPlan( browse_plan=browse_plan, status="consent-required", dry_run=dry_run, consent_granted=False, profile_path=profile_path, proxy=proxy, setup_steps=setup_steps, message=browse_plan.prompt, broker=broker, launch_spec=launch_spec, setup_prompt_title=setup_prompt.title, setup_prompt_body=setup_prompt.body, setup_prompt_approve_label=setup_prompt.approve_label, setup_prompt_approval_command=setup_prompt.approval_command, ) return OpenPlan( browse_plan=browse_plan, status="setup-approved", dry_run=dry_run, consent_granted=True, profile_path=profile_path, proxy=proxy, setup_steps=setup_steps, message="first-use setup approved; browser launch waits for transport readiness", broker=broker, launch_spec=launch_spec, setup_prompt_title=setup_prompt.title, setup_prompt_body=setup_prompt.body, setup_prompt_approve_label=setup_prompt.approve_label, setup_prompt_approval_command=setup_prompt.approval_command, ) return OpenPlan( browse_plan=browse_plan, status="ready", dry_run=dry_run, consent_granted=consent, profile_path=profile_path, proxy=proxy, setup_steps=(), message="ready to open with isolated profile", broker=broker, launch_spec=launch_spec, ) def execute_open( open_plan: OpenPlan, *, root: Path | None = None, config: AppConfig | None = None, ) -> OpenPlan: root = root or Path.cwd() spec = open_plan.launch_spec if spec is None: return replace( open_plan, dry_run=False, status="launch-unsupported", message=f"no browser launch path for {open_plan.browse_plan.route.transport}", ) if open_plan.status != "ready": return replace( open_plan, dry_run=False, message=f"not launched: {open_plan.message}", ) runtime_path = _path_from(root, spec.runtime_path) if not runtime_path.exists(): return replace( open_plan, dry_run=False, status="runtime-missing", message=f"browser runtime not found: {spec.runtime_path}", ) active_pid = _active_profile_session(root, spec) if active_pid: return _open_existing_profile(open_plan, root=root, spec=spec, active_pid=active_pid) config_path = Path(config.config_path) if config and config.config_path else None route_helper = ( _route_helper_launch_plan(root, config_path=config_path) if spec.broker else RouteHelperLaunch("disabled") ) _write_profile(root, spec, route_helper=route_helper) launch_spec = replace(spec, command=_execution_command(root, spec)) process = subprocess.Popen(launch_spec.command, cwd=str(root), start_new_session=True) # noqa: S603 if spec.broker: route_helper = _start_route_helper( root, planned=route_helper, watch_pid=process.pid, config_path=config_path, ) exit_code = _immediate_exit_code(process) if exit_code is not None: helper_status = route_helper.status helper_message = route_helper.message if spec.broker: helper_status = _stop_route_helper(route_helper) helper_message = "stopped route helper after browser exited immediately" return replace( open_plan, dry_run=False, launch_spec=launch_spec, status="browser-exited", browser_pid=process.pid, message=f"browser exited immediately with code {exit_code}", route_helper_status=helper_status, route_helper_endpoint=route_helper.endpoint, route_helper_pid=route_helper.pid, route_helper_message=helper_message, ) _record_profile_session(root, spec, process.pid) message = "launched bundled browser" if spec.broker: message = f"launched isolated transport broker with route helper {route_helper.status}" return replace( open_plan, dry_run=False, launch_spec=launch_spec, status="launched", browser_pid=process.pid, message=message, route_helper_status=route_helper.status, route_helper_endpoint=route_helper.endpoint, route_helper_pid=route_helper.pid, route_helper_message=route_helper.message, ) def _proxy_for(browse_plan: BrowsePlan) -> str: if browse_plan.route.transport in {"tor", "i2p"} and browse_plan.status: return browse_plan.status.endpoint return "-" def _setup_steps(browse_plan: BrowsePlan) -> tuple[str, ...]: if not browse_plan.status: return () adapter = adapter_for(browse_plan.route.transport) if not adapter: return () steps: list[str] = [] platform = browse_plan.platform_capability.platform if platform == "android" and not browse_plan.status.installed: steps.append(f"install or enable Android {browse_plan.route.transport} provider") steps.extend(adapter.setup_steps(installed=True, platform=platform)) return tuple(steps) if platform == "ios" and not browse_plan.status.installed: if browse_plan.route.transport == "tor": steps.append("enable bundled iOS Arti Tor runtime") else: steps.append(f"enable foreground iOS {browse_plan.route.transport} session") steps.extend(adapter.setup_steps(installed=True, platform=platform)) return tuple(steps) steps.extend(adapter.setup_steps(installed=browse_plan.status.installed, platform=platform)) return tuple(steps) @dataclass(frozen=True) class _SetupPrompt: title: str body: str approve_label: str approval_command: str def _setup_prompt(browse_plan: BrowsePlan, setup_steps: tuple[str, ...]) -> _SetupPrompt: transport = browse_plan.route.transport label = _transport_label(transport) platform = browse_plan.platform_capability.platform endpoint = browse_plan.status.endpoint if browse_plan.status else "-" setup_summary = "; ".join(setup_steps) if setup_steps else "prepare the transport" if browse_plan.status and not browse_plan.status.installed: availability = f"{label} is not installed or running." else: availability = f"{label} is not running." if platform == "desktop": management = f"AMPB can start a managed {label} session and keep its state isolated." elif platform == "android": management = f"AMPB can start a visible Android foreground {label} session." elif platform == "ios": management = f"AMPB can start a foreground-only in-app {label} session." else: management = f"AMPB can prepare {label} for this platform." body = ( f"{availability} {management} The browser will use {endpoint} for " f"{browse_plan.route.normalized}. Setup plan: {setup_summary}." ) approval_args = ["ampbrowser", "open", browse_plan.route.normalized, "--yes", "--launch"] approval_command = shlex.join(approval_args) return _SetupPrompt( title=f"Set up {label}?", body=body, approve_label=f"Start {label} and open", approval_command=approval_command, ) def _transport_label(transport: str) -> str: labels = { "tor": "Tor", "i2p": "I2P", "ipfs": "IPFS", "gemini": "Gemini", "reticulum": "Reticulum", } return labels.get(transport, transport) def _launch_spec_for( browse_plan: BrowsePlan, *, config: AppConfig, profile_path: str, broker: bool = False, ) -> BrowserLaunchSpec | None: if browse_plan.route.transport not in {"clearnet", "tor", "i2p"}: return None runtime_path = _runtime_path(config) user_js_path = str(Path(profile_path) / "user.js") command = (runtime_path, "--new-instance", "--profile", profile_path, browse_plan.route.normalized) prefs = _prefs_for(browse_plan, broker=broker) extension_path = str(Path(profile_path) / "extensions" / ROUTE_HELPER_EXTENSION_ID) if broker else "-" extension_assets = _route_helper_extension_assets(extension_path) if broker else () return BrowserLaunchSpec( runtime_path=runtime_path, profile_path=profile_path, user_js_path=user_js_path, command=command, prefs=prefs, broker=broker, extension_path=extension_path, extension_assets=extension_assets, ) def _runtime_path(config: AppConfig) -> str: if config.runtime_path: return config.runtime_path env_path = os.environ.get("AMPB_BROWSER_BIN") if env_path: return env_path build_root = Path(os.environ.get("AMPB_BROWSER_BUILD_ROOT", "/tmp/ampb-browser-build")) for candidate in _runtime_candidates(build_root): if candidate.exists(): return str(candidate) return str(_runtime_candidates(build_root)[0]) def _runtime_candidates(build_root: Path) -> tuple[Path, ...]: return ( build_root / "obj/gecko-desktop-source/dist/Nightly.app/Contents/MacOS/firefox", build_root / "obj/gecko-desktop-source/dist/bin/firefox", build_root / "obj/gecko-desktop-artifact/dist/Nightly.app/Contents/MacOS/firefox", build_root / "obj/gecko-desktop-artifact/dist/bin/firefox", ) def _prefs_for(browse_plan: BrowsePlan, *, broker: bool = False) -> tuple[str, ...]: prefs: list[tuple[str, str | int | bool]] = [ ("browser.shell.checkDefaultBrowser", False), ("datareporting.policy.dataSubmissionEnabled", False), ("toolkit.telemetry.enabled", False), ("network.dns.disablePrefetch", True), ("network.predictor.enabled", False), ] if broker: prefs.extend( [ ("network.proxy.type", 0), ("extensions.autoDisableScopes", 0), ("extensions.enabledScopes", 5), ("xpinstall.signatures.required", False), ] ) return tuple(_format_pref(name, value) for name, value in prefs) transport = browse_plan.route.transport if transport == "tor" and browse_plan.status: host, port = _endpoint_host_port(browse_plan.status.endpoint) prefs.extend( [ ("network.proxy.type", 1), ("network.proxy.socks", host), ("network.proxy.socks_port", port), ("network.proxy.socks_version", 5), ("network.proxy.socks_remote_dns", True), ("network.proxy.no_proxies_on", ""), ] ) elif transport == "i2p" and browse_plan.status: host, port = _endpoint_host_port(browse_plan.status.endpoint) prefs.extend( [ ("network.proxy.type", 1), ("network.proxy.http", host), ("network.proxy.http_port", port), ("network.proxy.ssl", host), ("network.proxy.ssl_port", port), ("network.proxy.no_proxies_on", ""), ] ) else: prefs.append(("network.proxy.type", 0)) return tuple(_format_pref(name, value) for name, value in prefs) def _route_helper_extension_assets(extension_path: str) -> tuple[ProfileAsset, ...]: base = Path(extension_path) return ( ProfileAsset(str(base / "manifest.json"), _route_helper_manifest()), ProfileAsset(str(base / "background.js"), _route_helper_background_js()), ProfileAsset(str(base / "setup.html"), _route_helper_setup_html()), ProfileAsset(str(base / "setup.js"), _route_helper_setup_js()), ProfileAsset(str(base / "setup.css"), _route_helper_setup_css()), ProfileAsset(str(base / "handoff.html"), _route_helper_handoff_html()), ProfileAsset(str(base / "handoff.js"), _route_helper_handoff_js()), ) def _route_helper_manifest() -> str: return json.dumps( { "manifest_version": 2, "name": "AMPB Route Helper", "version": "0.1.0", "description": "Hands alternate-network links to isolated AMPB transport profiles.", "applications": {"gecko": {"id": ROUTE_HELPER_EXTENSION_ID}}, "permissions": [ "tabs", "webRequest", "webRequestBlocking", "http://*.onion/*", "https://*.onion/*", "ws://*.onion/*", "wss://*.onion/*", "http://*.i2p/*", "https://*.i2p/*", "ws://*.i2p/*", "wss://*.i2p/*", "http://127.0.0.1/*", ], "background": {"scripts": ["background.js"]}, }, indent=2, sort_keys=True, ) + "\n" def _route_helper_background_js() -> str: return "\n".join( ( '"use strict";', "", f'const HELPER_URL = "{HELPER_URL_PLACEHOLDER}";', f'const HELPER_TOKEN = "{HELPER_TOKEN_PLACEHOLDER}";', "const pendingByTab = new Map();", "", "function transportForUrl(rawUrl) {", " try {", " const parsed = new URL(rawUrl);", " const host = parsed.hostname.toLowerCase().replace(/\\.$/, '');", " if (host.endsWith('.onion')) return 'tor';", " if (host.endsWith('.i2p')) return 'i2p';", " } catch (_error) {}", " return '';", "}", "", "async function helper(action, transport, url, consent = false) {", " const response = await fetch(HELPER_URL, {", " method: 'POST',", " headers: {", " 'Content-Type': 'application/json',", " 'X-AMPB-Token': HELPER_TOKEN,", " },", " body: JSON.stringify({ action, transport, url, consent }),", " });", " return response.json();", "}", "", "function internalUrl(page, transport, url, result) {", " const installCommand = Array.isArray(result.install_command) ? result.install_command.join(' ') : '';", " const params = new URLSearchParams({", " transport,", " url,", " message: result.message || '',", " hint: result.setup_hint || '',", " install: installCommand,", " });", " return browser.runtime.getURL(`${page}.html?${params.toString()}`);", "}", "", "async function handoff(details, transport) {", " let result;", " try {", " result = await helper('open', transport, details.url, false);", " } catch (error) {", " result = { ok: false, launched: false, message: String(error) };", " }", " const page = result.launched ? 'handoff' : 'setup';", " try {", " await browser.tabs.update(details.tabId, { url: internalUrl(page, transport, details.url, result) });", " } finally {", " pendingByTab.delete(details.tabId);", " }", "}", "", "function interceptRequest(details) {", " const transport = transportForUrl(details.url);", " if (!transport) return {};", " if (details.type !== 'main_frame' || details.tabId < 0) return { cancel: true };", " if (pendingByTab.get(details.tabId) === details.url) return { cancel: true };", " pendingByTab.set(details.tabId, details.url);", " void handoff(details, transport);", " return { cancel: true };", "}", "", "browser.webRequest.onBeforeRequest.addListener(", " interceptRequest,", " { urls: ['http://*.onion/*', 'https://*.onion/*', 'ws://*.onion/*', 'wss://*.onion/*', 'http://*.i2p/*', 'https://*.i2p/*', 'ws://*.i2p/*', 'wss://*.i2p/*'] },", " ['blocking']", ");", "", "browser.runtime.onMessage.addListener((message) => {", " if (!message || message.type !== 'ampb-open') return false;", " return helper('open', message.transport, message.url, message.consent === true);", "});", "", ) ) def _route_helper_setup_html() -> str: return "\n".join( ( "", '', "
", ' ', ' ', "AMPB Route Helper
', 'AMPB needs to start a local transport before opening this route.
', ' ', ' ', ' ', ' ', ' ', "AMPB Transport Broker
', 'The destination is open in its isolated transport profile.
', ' ', "