test-firefox-passkeys.mjs

1#!/usr/bin/env node23// PB-26-210: mandatory Firefox release browser gate.4// Tests the PB-26-209 exportFunction privileged passkey bridge in real Firefox.5//6// If Firefox/Marionette cannot launch, this script exits non-zero — the gate7// FAILS rather than silently skipping.8//9// Security properties verified:10// 1. navigator.credentials.create is wrapped by exportFunction (not native).11// 2. navigator.credentials.get is wrapped by exportFunction (not native).12// 3. No forgeable PEACH_PASSKEY_RESPONSE postMessage channel exists.13// 4. The bridge falls through to native when vault is locked (no crash/hang).14// 5. The page cannot forge the extension's response via postMessage.1516import { execFile } from "node:child_process";17import { promisify } from "node:util";18import { cp, mkdtemp, mkdir, readFile, rm, writeFile } from "node:fs/promises";19import { existsSync } from "node:fs";20import { createServer as createHttpServer } from "node:http";21import { tmpdir } from "node:os";22import { join, resolve } from "node:path";23import net from "node:net";24import { start } from "geckodriver";2526const execFileAsync = promisify(execFile);27const ROOT = resolve(new URL("..", import.meta.url).pathname);28const DIST = join(ROOT, "dist-firefox");29const WEB_EXT = join(ROOT, "node_modules/.bin/web-ext");30const TEST_BACKGROUND = join(ROOT, "tests/fixtures/firefox-passkey-background.js");31const CONTEXT_PROBE = join(ROOT, "tests/fixtures/firefox-passkey-context-probe.js");32const SENDER_PROBE = join(ROOT, "tests/fixtures/firefox-sender-probe.js");33const CREATE_CREDENTIAL_ID = "AQIDBA";34const GET_CREDENTIAL_ID = "BQYHCA";35const EXTENSION_ID = "[email protected]";3637function findFirefoxBinary() {38  const candidates = [39    process.env.PEACH_FIREFOX_BINARY,40    process.env.FIREFOX_BIN,41    "/usr/bin/firefox",42    "/usr/local/bin/firefox",43    "/Applications/Firefox.app/Contents/MacOS/firefox",44    "/Applications/Firefox Nightly.app/Contents/MacOS/firefox",45  ].filter(Boolean);46  return candidates.find((c) => existsSync(c));47}4849function findFreePort() {50  return new Promise((resolvePort, reject) => {51    const server = net.createServer();52    server.once("error", reject);53    server.listen(0, "127.0.0.1", () => {54      const address = server.address();55      if (!address || typeof address === "string") {56        server.close();57        reject(new Error("Could not allocate a WebDriver port"));58        return;59      }60      server.close(() => resolvePort(address.port));61    });62  });63}6465async function waitForDriver(port) {66  const deadline = Date.now() + 30_000;67  while (Date.now() < deadline) {68    try {69      const response = await fetchWithTimeout(`http://127.0.0.1:${port}/status`, {}, 5000);70      if (response.ok && (await response.json()).value?.ready) return;71    } catch {72      // geckodriver is still starting.73    }74    await new Promise((r) => setTimeout(r, 250));75  }76  throw new Error("geckodriver did not become ready within 30 seconds");77}7879async function fetchWithTimeout(url, options, timeoutMs) {80  const controller = new AbortController();81  let timeoutId;82  const timeout = new Promise((_, reject) => {83    timeoutId = setTimeout(() => reject(new Error(`Request timed out after ${timeoutMs}ms`)), timeoutMs);84  });85  try {86    return await Promise.race([87      fetch(url, { ...options, signal: controller.signal }),88      timeout,89    ]);90  } finally {91    clearTimeout(timeoutId);92    controller.abort();93  }94}9596async function webdriverRequest(port, path, options = {}) {97  const response = await fetchWithTimeout(`http://127.0.0.1:${port}${path}`, {98    ...options,99    headers: { "content-type": "application/json", ...(options.headers ?? {}) },100  }, 10_000);101  const body = await response.json();102  if (!response.ok || body.value?.error) {103    throw new Error(`WebDriver ${options.method ?? "GET"} ${path} failed: ${JSON.stringify(body)}`);104  }105  return body.value;106}107108async function stopDriver(driver) {109  if (!driver || driver.exitCode !== null || driver.signalCode !== null) return;110  const exited = new Promise((resolveExit) => driver.once("exit", resolveExit));111  driver.kill("SIGTERM");112  let timeoutId;113  const stopped = await Promise.race([114    exited.then(() => true),115    new Promise((resolveTimeout) => {116      timeoutId = setTimeout(() => resolveTimeout(false), 5000);117    }),118  ]);119  clearTimeout(timeoutId);120  if (!stopped && driver.exitCode === null && driver.signalCode === null) {121    driver.kill("SIGKILL");122    await exited;123  }124}125126async function buildTestExtension(tempRoot) {127  const sourceDir = join(tempRoot, "extension");128  const artifactsDir = join(tempRoot, "artifacts");129  await cp(DIST, sourceDir, { recursive: true });130  await mkdir(artifactsDir, { recursive: true });131  await cp(TEST_BACKGROUND, join(sourceDir, "firefox-passkey-background.js"));132  await cp(CONTEXT_PROBE, join(sourceDir, "firefox-passkey-context-probe.js"));133  await cp(SENDER_PROBE, join(sourceDir, "firefox-sender-probe.js"));134135  const manifestPath = join(sourceDir, "manifest.json");136  const manifest = JSON.parse(await readFile(manifestPath, "utf8"));137  manifest.background.scripts = [138    "firefox-passkey-background.js",139    ...manifest.background.scripts,140  ];141  manifest.content_scripts.push({142    matches: ["<all_urls>"],143    js: ["firefox-passkey-context-probe.js"],144    run_at: "document_start",145  });146  manifest.content_scripts.push({147    matches: ["<all_urls>"],148    js: ["firefox-sender-probe.js"],149    run_at: "document_start",150    all_frames: false,151  });152  await writeFile(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`);153154  await execFileAsync(WEB_EXT, [155    "build",156    "--source-dir", sourceDir,157    "--artifacts-dir", artifactsDir,158    "--filename", "peach-firefox-passkey-matrix.xpi",159    "--overwrite-dest",160    "--no-input",161  ], { cwd: ROOT });162  return join(artifactsDir, "peach-firefox-passkey-matrix.xpi");163}164165const PROBE_SCRIPT = `166  const done = arguments[arguments.length - 1];167  void (async () => {168169  // Verify no PEACH_PASSKEY_REQUEST postMessage is used by the bridge.170  //    We check the page for any existing listeners that post PEACH_PASSKEY_REQUEST.171  const pageSourceHasRelay = document.documentElement.innerHTML.includes("PEACH_PASSKEY_REQUEST");172173  const passkeyMessages = [];174  window.addEventListener("message", (event) => {175    if (event.data?.type === "PEACH_PASSKEY_REQUEST" || event.data?.type === "PEACH_PASSKEY_RESPONSE") {176      passkeyMessages.push(event.data.type);177    }178  });179180  const senderSource = "peach-firefox-sender-probe";181  const sendSenderMessage = (message) => new Promise((resolve) => {182    const id = crypto.randomUUID();183    const timer = setTimeout(() => {184      window.removeEventListener("message", onResponse);185      resolve({ ok: false, error: "probe_timeout" });186    }, 5000);187    function onResponse(event) {188      let response;189      try {190        response = JSON.parse(event.data);191      } catch {192        return;193      }194      if (response?.source !== senderSource + ":response" || response.id !== id) return;195      clearTimeout(timer);196      window.removeEventListener("message", onResponse);197      resolve(response.response);198    }199    window.addEventListener("message", onResponse);200    window.postMessage(JSON.stringify({ source: senderSource, id, message }), "*");201  });202203  // 4. Exercise both wrappers against the test-only background responder.204  //    Abort quickly if the native authenticator receives either request.205  const createAbort = new AbortController();206  const createTimer = setTimeout(() => createAbort.abort(), 2000);207  let createResult = null;208  let createError = null;209  try {210    const credential = await navigator.credentials.create({211      signal: createAbort.signal,212      publicKey: {213        rp: { id: "127.0.0.1", name: "Test" },214        user: { id: new Uint8Array(16), name: "test", displayName: "Test" },215        challenge: new Uint8Array(16),216        pubKeyCredParams: [{ alg: -7, type: "public-key" }],217      },218    });219    createResult = credential ? { id: credential.id, type: credential.type } : null;220  } catch (e) {221    createError = { name: e?.name ?? "Error", message: e?.message ?? String(e), stack: e?.stack ?? null };222  } finally {223    clearTimeout(createTimer);224  }225226  const getAbort = new AbortController();227  const getTimer = setTimeout(() => getAbort.abort(), 2000);228  let getResult = null;229  let getError = null;230  try {231    const credential = await navigator.credentials.get({232      signal: getAbort.signal,233      publicKey: {234        rpId: "127.0.0.1",235        challenge: new Uint8Array(16),236        allowCredentials: [{ id: new Uint8Array(32), type: "public-key" }],237      },238    });239    getResult = credential ? { id: credential.id, type: credential.type } : null;240  } catch (e) {241    getError = { name: e?.name ?? "Error", message: e?.message ?? String(e), stack: e?.stack ?? null };242  } finally {243    clearTimeout(getTimer);244  }245246  const [allowedSender, entriesSender, recoverySender, storageSender] = await Promise.all([247    sendSenderMessage({ type: "GET_SETTINGS" }),248    sendSenderMessage({ type: "GET_ENTRIES" }),249    sendSenderMessage({ type: "GET_RECOVERY_WORDS" }),250    sendSenderMessage({ type: "STORAGE_SESSION" }),251  ]);252253  done({254    pageOrigin: location.origin,255    context: JSON.parse(document.documentElement.dataset.peachFirefoxPasskeyContext ?? "null"),256    pageSourceHasRelay,257    createResult,258    createError,259    getResult,260    getError,261    passkeyMessages,262    senderProbeReady: document.documentElement.dataset.peachFirefoxSenderProbe ?? null,263    allowedSender,264    entriesSender,265    recoverySender,266    storageSender,267  });268  })().catch((error) => done({269    probeError: error?.stack ?? error?.message ?? String(error),270  }));271`;272273async function run() {274  if (!existsSync(DIST)) throw new Error("dist-firefox is missing; run npm run build:firefox first");275  if (!existsSync(WEB_EXT)) throw new Error("web-ext is missing; run bun install first");276277  const tempRoot = await mkdtemp(join(tmpdir(), "peach-firefox-passkey-"));278  let driver;279  let driverPort;280  let sessionId;281  let fixtureServer;282  try {283    const xpiPath = await buildTestExtension(tempRoot);284    const firefoxBinary = findFirefoxBinary();285    const port = await findFreePort();286    driverPort = port;287    driver = await start({288      host: "127.0.0.1",289      port,290      geckoDriverVersion: "0.37.1",291      ...(firefoxBinary ? { binary: firefoxBinary } : {}),292      log: "error",293    });294    await waitForDriver(port);295296    const capabilities = {297      browserName: "firefox",298      acceptInsecureCerts: true,299      "moz:firefoxOptions": {300        args: ["-headless", "-remote-allow-system-access"],301        ...(firefoxBinary ? { binary: firefoxBinary } : {}),302        prefs: {303          "browser.shell.checkDefaultBrowser": false,304          "browser.startup.page": 0,305          "browser.startup.homepage": "about:blank",306          "remote.system-access-check.enabled": false,307        },308      },309    };310    const session = await webdriverRequest(port, "/session", {311      method: "POST",312      body: JSON.stringify({ capabilities: { alwaysMatch: capabilities } }),313    });314    sessionId = session.sessionId;315316    fixtureServer = createHttpServer((_request, response) => {317      response.writeHead(200, { "content-type": "text/html; charset=utf-8" });318      response.end("<!doctype html><html><head><title>Peach passkey test</title></head><body></body></html>");319    });320    await new Promise((resolveListen, rejectListen) => {321      fixtureServer.once("error", rejectListen);322      fixtureServer.listen(0, "127.0.0.1", resolveListen);323    });324    const fixtureAddress = fixtureServer.address();325    if (!fixtureAddress || typeof fixtureAddress === "string") {326      throw new Error("Could not allocate the Firefox fixture server port");327    }328    const fixtureOrigin = `http://127.0.0.1:${fixtureAddress.port}`;329330    // Install the temporary add-on.331    const install = await webdriverRequest(port, `/session/${sessionId}/moz/addon/install`, {332      method: "POST",333      body: JSON.stringify({334        path: xpiPath,335        temporary: true,336      }),337    });338    if (install?.id && install.id !== EXTENSION_ID) {339      throw new Error(`Unexpected Firefox add-on id: ${install.id}`);340    }341342    await webdriverRequest(port, `/session/${sessionId}/moz/context`, {343      method: "POST",344      body: JSON.stringify({ context: "chrome" }),345    });346    const addonInfo = await webdriverRequest(port, `/session/${sessionId}/execute/async`, {347      method: "POST",348      body: JSON.stringify({349        script: `350          const done = arguments[arguments.length - 1];351          const { AddonManager } = ChromeUtils.importESModule("resource://gre/modules/AddonManager.sys.mjs");352          const { ExtensionPermissions } = ChromeUtils.importESModule("resource://gre/modules/ExtensionPermissions.sys.mjs");353          AddonManager.getAddonByID(arguments[0]).then(async (addon) => {354            if (!addon) return null;355            const policy = WebExtensionPolicy.getByID(addon.id);356            await ExtensionPermissions.add(357              addon.id,358              { permissions: [], origins: ["<all_urls>"] },359              policy.extension,360            );361            await addon.reload();362            const reloadedAddon = await AddonManager.getAddonByID(addon.id);363            const reloadedPolicy = WebExtensionPolicy.getByID(addon.id);364            return {365              id: reloadedAddon.id,366              active: reloadedAddon.isActive,367              permissions: await ExtensionPermissions.get(addon.id),368              allowedOrigins: reloadedPolicy.allowedOrigins.patterns.map((pattern) => pattern.pattern),369            };370          }).then(done, (error) => done({ error: String(error), stack: error?.stack }));371        `,372        args: [EXTENSION_ID],373      }),374    });375    await webdriverRequest(port, `/session/${sessionId}/moz/context`, {376      method: "POST",377      body: JSON.stringify({ context: "content" }),378    });379    if (!addonInfo?.active || !addonInfo.permissions?.origins?.includes("<all_urls>")) {380      throw new Error(`Firefox add-on host permission was not granted: ${JSON.stringify(addonInfo)}`);381    }382383    // Navigate to a test page and wait for the content script to install.384    await webdriverRequest(port, `/session/${sessionId}/url`, {385      method: "POST",386      body: JSON.stringify({ url: `${fixtureOrigin}/` }),387    });388    // Give the content script time to run at document_start.389    await new Promise((r) => setTimeout(r, 2000));390391    const result = await webdriverRequest(port, `/session/${sessionId}/execute/async`, {392      method: "POST",393      body: JSON.stringify({ script: PROBE_SCRIPT, args: [] }),394    });395396    if (result.pageOrigin !== fixtureOrigin) {397      throw new Error(`Unexpected page origin: ${result.pageOrigin}`);398    }399400    const failures = [];401402    if (result.probeError) {403      failures.push(`page probe failed: ${result.probeError}`);404    }405406    if (result.context?.exportFunctionType !== "function" || result.context?.cloneIntoType !== "function") {407      failures.push(`Firefox privileged bridge APIs were unavailable: ${JSON.stringify(result.context)}`);408    }409410    if (result.context?.installGuard !== true) {411      failures.push(`Firefox passkey bridge did not install: ${JSON.stringify(result.context)}`);412    }413414    // No PEACH_PASSKEY_REQUEST in page source.415    if (result.pageSourceHasRelay) {416      failures.push("PEACH_PASSKEY_REQUEST found in page source — the old relay may still be present");417    }418419    if (result.createResult?.id !== CREATE_CREDENTIAL_ID || result.createResult?.type !== "public-key") {420      failures.push(`navigator.credentials.create did not return the extension credential: ${JSON.stringify({ result: result.createResult, error: result.createError })}`);421    }422423    if (result.getResult?.id !== GET_CREDENTIAL_ID || result.getResult?.type !== "public-key") {424      failures.push(`navigator.credentials.get did not return the extension credential: ${JSON.stringify({ result: result.getResult, error: result.getError })}`);425    }426427    if (result.passkeyMessages?.length > 0) {428      failures.push(`page observed passkey postMessage traffic: ${JSON.stringify(result.passkeyMessages)}`);429    }430431    if (result.senderProbeReady !== "ready") {432      failures.push(`Firefox sender-context probe did not execute: ${JSON.stringify(result)}`);433    }434    if (Object.hasOwn(result.storageSender ?? {}, "peach_session_dk")) {435      failures.push(`Firefox content script accessed the session escrow key: ${JSON.stringify(result.storageSender)}`);436    }437    if (result.allowedSender?.error === "invalid_sender") {438      failures.push("Content-script-allowed GET_SETTINGS was rejected");439    }440    for (const [name, response] of [441      ["GET_ENTRIES", result.entriesSender],442      ["GET_RECOVERY_WORDS", result.recoverySender],443    ]) {444      if (response?.error !== "invalid_sender") {445        failures.push(`${name} was not rejected from the real Firefox content-script sender: ${JSON.stringify(response)}`);446      }447    }448449    if (failures.length > 0) {450      throw new Error(`Firefox passkey matrix failures:\n  - ${failures.join("\n  - ")}\n  Context: ${JSON.stringify(result.context)}\n  Add-on: ${JSON.stringify(addonInfo)}`);451    }452453    console.log("Firefox security matrix passed: sender authorization and storage isolation held; exportFunction returned extension credentials with no forgeable passkey postMessage traffic.");454  } finally {455    if (driver && sessionId) {456      try {457        await webdriverRequest(driverPort, `/session/${sessionId}`, { method: "DELETE" });458      } catch {459        // Browser may already have exited.460      }461    }462    if (fixtureServer) {463      await new Promise((resolveClose) => fixtureServer.close(resolveClose));464    }465    await stopDriver(driver);466    await rm(tempRoot, { recursive: true, force: true });467  }468}469470run().catch((error) => {471  console.error(error instanceof Error ? error.message : error);472  process.exitCode = 1;473});