paired-devices.ts

1// Paired-device registry — v3 sync.2//3// Long-term records live in `chrome.storage.local`. Keys must not leave4// the device via a third-party sync service — `longTermPublicKeyHex` and5// `signingPublicKeyHex` are cryptographic keys; routing them through6// Google's or Mozilla's sync back-end violates the local-only trust model.7//8// `lastKnownIp` is network-specific and also lives in `chrome.storage.local`,9// keyed by `longTermPublicKeyHex` (not on the device record itself) so10// network-specific addresses don't roam across profiles.11//12// `deviceId` is the canonical primary key (UUID v4, stable for the13// lifetime of the installation). `longTermPublicKeyHex` is also unique14// per device but rotates if the user reinstalls before re-pairing, so we15// key on deviceId and update the key in place during re-pair.16//17// The registry has only ever lived in `chrome.storage.local` for released18// builds, so no cross-profile evacuation path is needed — the public keys19// never leave the device via a third-party sync back-end. Unpairing is20// local-only; Noise KK rejection on the next connection is the security21// boundary (see removePairedDeviceById).2223import type { DeviceRevocation, PairedDevice } from "../shared/sync-types";24import { constantTimeEqualHex } from "../shared/constant-time";25import { clampSyncTimestamp } from "../shared/sync-limits";26import type { SyncOutcome } from "../shared/sync-outcome";2728const REGISTRY_KEY = "peach_paired_devices_v3";29const REVOCATIONS_KEY = "peach_device_revocations_v1";30/** Bound the list so a hostile peer cannot grow storage without limit. */31const MAX_REVOCATIONS = 500;32const LAST_IP_KEY_PREFIX = "peach_last_known_ip_v3:";33const LAST_SYNC_AT_KEY = "peach_last_sync_at";34const LAST_SYNC_RESULT_KEY = "peach_last_sync_result";3536export async function listPairedDevices(): Promise<PairedDevice[]> {37  try {38    const result = await chrome.storage.local.get(REGISTRY_KEY);39    const devices = (result as Record<string, unknown>)[REGISTRY_KEY];40    if (Array.isArray(devices)) return devices.filter(isPairedDevice);41    return [];42  } catch {43    return [];44  }45}4647export async function findPairedDeviceById(deviceId: string): Promise<PairedDevice | null> {48  const devices = await listPairedDevices();49  return devices.find((d) => d.deviceId === deviceId) ?? null;50}5152export async function findPairedDeviceByPubkey(pubkeyHex: string): Promise<PairedDevice | null> {53  const devices = await listPairedDevices();54  return devices.find((d) =>55    d.longTermPublicKeyHex !== undefined &&56    constantTimeEqualHex(d.longTermPublicKeyHex, pubkeyHex)57  ) ?? null;58}5960/**61 * Add or update a device by `deviceId`. On re-pair the new pubkey62 * silently replaces the old one; the deviceId is stable across the63 * other device's reinstall.64 */65export async function upsertPairedDevice(device: PairedDevice): Promise<void> {66  if (!device.deviceId) throw new Error("device.deviceId is required");67  if (!device.longTermPublicKeyHex) throw new Error("device.longTermPublicKeyHex is required");68  if (!device.deviceName) throw new Error("device.deviceName is required");69  if (!device.deviceType) throw new Error("device.deviceType is required");7071  const devices = await listPairedDevices();72  const idx = devices.findIndex((d) => d.deviceId === device.deviceId);73  if (idx >= 0) {74    devices[idx] = { ...devices[idx], ...device };75  } else {76    devices.push(device);77  }78  await chrome.storage.local.set({ [REGISTRY_KEY]: devices });79  // The device-list-changed sync trigger fires from the messages.ts handlers80  // (IMPORT_PAIRED_DEVICE / CONFIRM_VOUCHED_DEVICE / UNPAIR_DEVICE) — they81  // own the post-mutation contract and have the full payload available. Firing82  // here would race with the test setup pattern (setSyncRunner AFTER upsert).83}8485/**86 * Move every existing pair to the user-selected mesh relay.87 *88 * Reconnect prefers the relay stored on each pair over the global fallback, so89 * changing only the setting would leave established devices on the old relay.90 */91export async function setRelayUrlForAllPairedDevices(92  relayUrl: string,93): Promise<void> {94  const devices = await listPairedDevices();95  if (devices.length === 0) return;96  await chrome.storage.local.set({97    [REGISTRY_KEY]: devices.map((device) => ({ ...device, relayUrl })),98  });99  // A relay change is mesh state — the next alarm tick or popup open will dial100  // with the new relay. No fire-and-forget trigger here; the in-flight guard101  // would just drop it on the burst of upserts that often follows.102}103104/**105 * Removes the device from the LOCAL paired-devices registry only, leaving no106 * record behind. Prefer `revokeDeviceById` for anything the user would call107 * "remove this device" — a plain removal is silently undone the next time any108 * peer vouches the device back through a manifest.109 *110 * SECURITY NOTE (MV-8): this does NOT prevent the removed device from111 * syncing with OTHER peers in the device graph, and the device RETAINS112 * its copy of the vault root key (syncMasterKey) — it can still decrypt113 * anything it already holds and anything other peers send it. For a114 * lost or stolen device, removal is insufficient: use "Rotate sync115 * identity" (vault.ts rotateSyncIdentity), which re-keys the vault so116 * the old device's key material is useless.117 */118export async function removePairedDeviceById(deviceId: string): Promise<void> {119  const devices = await listPairedDevices();120  const filtered = devices.filter((d) => d.deviceId !== deviceId);121  // Unpairing is local-only — there is no remote unpair RPC. The remote122  // device retains this device in its own registry. Noise KK rejection on123  // the next connection attempt is the security boundary.124  await chrome.storage.local.set({ [REGISTRY_KEY]: filtered });125  // Also clear the per-network IP cache for this device.126  const device = devices.find((d) => d.deviceId === deviceId);127  if (device?.longTermPublicKeyHex) {128    await chrome.storage.local.remove(LAST_IP_KEY_PREFIX + device.longTermPublicKeyHex);129  }130  // The device-list-changed sync trigger fires from the messages.ts UNPAIR_DEVICE131  // handler — see upsertPairedDevice for why this lives there, not here.132}133134// ---------------------------------------------------------------------------135// Device revocation (Part 5 §C) — a removal that propagates and stays removed.136// ---------------------------------------------------------------------------137138export async function listDeviceRevocations(): Promise<DeviceRevocation[]> {139  try {140    const result = await chrome.storage.local.get(REVOCATIONS_KEY);141    const value = (result as Record<string, unknown>)[REVOCATIONS_KEY];142    if (Array.isArray(value)) return value.filter(isDeviceRevocation);143    return [];144  } catch {145    return [];146  }147}148149/**150 * True when either the id or the long-term key is under a terminal revocation.151 *152 * `deviceId` is a self-asserted string in a manifest, so keying terminality on153 * it alone is bypassed by re-vouching a revoked device's key under a fresh id.154 * The key is the thing a revoked device actually still holds, so it is the155 * thing terminality has to follow.156 */157export async function isDeviceRevoked(158  deviceId: string,159  longTermPublicKeyHex?: string,160): Promise<boolean> {161  // The all-zero sentinel stands for "we never stored a key for this device"162  // (see revokeDeviceById) and must not match a real one.163  const key = longTermPublicKeyHex?.toLowerCase();164  const keyIsRevocable = key !== undefined && key !== "0".repeat(64);165  return (await listDeviceRevocations()).some(166    (r) =>167      r.deviceId === deviceId ||168      (keyIsRevocable && r.longTermPublicKeyHex.toLowerCase() === key),169  );170}171172/**173 * Revoke a device: record it locally, then drop it from the registry. The174 * record rides out in every manifest this device signs from now on, and blocks175 * the device being vouched back in. A stale entry may survive in the176 * pending-vouch queue; the confirm handler re-checks revocation before177 * promoting anything out of it.178 */179export async function revokeDeviceById(180  deviceId: string,181  revokedByDeviceId: string,182  options: { now?: number } = {},183): Promise<DeviceRevocation | null> {184  const device = await findPairedDeviceById(deviceId);185  const existing = await listDeviceRevocations();186  if (existing.some((r) => r.deviceId === deviceId)) {187    // A direct re-pair in older builds could restore the paired row without188    // clearing its terminal revocation. "Remove" then returned early here and189    // left the row visible forever. Idempotency applies to the revocation190    // record, not to removing any stale live row that overlaps it.191    if (device) await removePairedDeviceById(deviceId);192    return null;193  }194195  const record: DeviceRevocation = {196    deviceId,197    // A device with no stored key was never usable as a sync peer; the198    // all-zero key keeps the record well-formed on the wire without199    // pretending to name a key we never saw.200    longTermPublicKeyHex: device?.longTermPublicKeyHex ?? "0".repeat(64),201    revokedAt: options.now ?? Date.now(),202    revokedByDeviceId,203  };204  await storeRevocations([...existing, record]);205  await removePairedDeviceById(deviceId);206  return record;207}208209/**210 * Merge revocations learned from a peer's manifest. Returns the deviceIds that211 * were newly revoked, so the caller can evict them.212 *213 * `revokedAt` is peer-supplied and is NOT used for ordering — revocation is214 * terminal, so the timestamp is display metadata only and cannot be used to215 * win or lose a race (HOLE 2).216 */217export async function mergeDeviceRevocations(218  incoming: DeviceRevocation[],219): Promise<string[]> {220  const existing = await listDeviceRevocations();221  const known = new Set(existing.map((r) => r.deviceId));222  const fresh = incoming223    .filter((r) => !known.has(r.deviceId))224    // Clamped for display sanity only — a year-9999 revokedAt would render as225    // nonsense. The protection against ordering games is that revocation is226    // terminal, not this clamp (HOLE 2 audit in sync-limits.ts).227    .map((r) => ({ ...r, revokedAt: clampSyncTimestamp(r.revokedAt) }));228  if (fresh.length === 0) return [];229  await storeRevocations([...existing, ...fresh].slice(-MAX_REVOCATIONS));230  return fresh.map((r) => r.deviceId);231}232233/**234 * Clear a revocation. The ONLY legitimate caller is a direct, SAS-confirmed235 * re-pair: a physically present user on both devices is a stronger consent236 * signal than whatever created the original pairing. Never call this from a237 * path a remote peer can reach.238 */239export async function clearDeviceRevocation(deviceId: string): Promise<void> {240  const existing = await listDeviceRevocations();241  const filtered = existing.filter((r) => r.deviceId !== deviceId);242  if (filtered.length === existing.length) return;243  await storeRevocations(filtered);244}245246async function storeRevocations(records: DeviceRevocation[]): Promise<void> {247  await chrome.storage.local.set({ [REVOCATIONS_KEY]: records });248}249250function isDeviceRevocation(x: unknown): x is DeviceRevocation {251  if (typeof x !== "object" || x === null) return false;252  const r = x as Record<string, unknown>;253  return (254    typeof r.deviceId === "string" &&255    !!r.deviceId &&256    typeof r.longTermPublicKeyHex === "string" &&257    typeof r.revokedAt === "number" &&258    typeof r.revokedByDeviceId === "string"259  );260}261262export async function clearPairedDevices(): Promise<void> {263  await chrome.storage.local.remove(REGISTRY_KEY);264}265266export async function markLastSyncedAt(deviceId: string, when: number): Promise<void> {267  const devices = await listPairedDevices();268  const idx = devices.findIndex((d) => d.deviceId === deviceId);269  if (idx < 0) return;270  devices[idx] = { ...devices[idx], lastSyncedAt: when };271  await chrome.storage.local.set({ [REGISTRY_KEY]: devices });272}273274export async function getLastKnownIp(pubkeyHex: string): Promise<string | null> {275  try {276    const key = LAST_IP_KEY_PREFIX + pubkeyHex;277    const result = await chrome.storage.local.get(key);278    const value = (result as Record<string, unknown>)[key];279    return typeof value === "string" ? value : null;280  } catch {281    return null;282  }283}284285export async function setLastKnownIp(pubkeyHex: string, ip: string): Promise<void> {286  await chrome.storage.local.set({ [LAST_IP_KEY_PREFIX + pubkeyHex]: ip });287}288289export async function clearLastKnownIp(pubkeyHex: string): Promise<void> {290  await chrome.storage.local.remove(LAST_IP_KEY_PREFIX + pubkeyHex);291}292293export async function getLastSyncAt(): Promise<number | null> {294  try {295    const result = await chrome.storage.local.get(LAST_SYNC_AT_KEY);296    const value = (result as Record<string, unknown>)[LAST_SYNC_AT_KEY];297    if (typeof value === "number") return value;298    if (typeof value === "string" && value !== "") {299      const n = Number.parseInt(value, 10);300      return Number.isFinite(n) ? n : null;301    }302    return null;303  } catch {304    return null;305  }306}307308export async function setLastSyncAt(when: number): Promise<void> {309  await chrome.storage.local.set({ [LAST_SYNC_AT_KEY]: when });310}311312/**313 * The last sync ATTEMPT, not just the last success. A 3-second flash in the314 * popup is useless for debugging a real phone, so every terminating path315 * writes this and Settings reads it back after the fact — including across an316 * MV3 service-worker restart.317 */318export interface SyncResult {319  outcome: SyncOutcome;320  detail?: string;321  /** When the attempt finished, success or not. */322  at: number;323  entriesReceived: number;324  entriesSent: number;325}326327export async function getLastSyncResult(): Promise<SyncResult | null> {328  try {329    const result = await chrome.storage.local.get(LAST_SYNC_RESULT_KEY);330    const value = (result as Record<string, unknown>)[LAST_SYNC_RESULT_KEY];331    if (332      value &&333      typeof value === "object" &&334      typeof (value as Record<string, unknown>).outcome === "string" &&335      typeof (value as Record<string, unknown>).at === "number" &&336      typeof (value as Record<string, unknown>).entriesReceived === "number" &&337      typeof (value as Record<string, unknown>).entriesSent === "number"338    ) {339      return value as SyncResult;340    }341    return null;342  } catch {343    return null;344  }345}346347export async function setLastSyncResult(result: SyncResult): Promise<void> {348  await chrome.storage.local.set({ [LAST_SYNC_RESULT_KEY]: result });349}350351function isPairedDevice(x: unknown): x is PairedDevice {352  if (typeof x !== "object" || x === null) return false;353  const r = x as Record<string, unknown>;354  if (typeof r.deviceId !== "string" || !r.deviceId) return false;355  if (typeof r.pairedAt !== "number") return false;356  if (357    r.rendezvousSecretHex !== undefined &&358    (typeof r.rendezvousSecretHex !== "string" || !/^[0-9a-f]{64}$/.test(r.rendezvousSecretHex))359  ) {360    return false;361  }362  if (r.relayUrl !== undefined) {363    if (typeof r.relayUrl !== "string") return false;364    try {365      if (new URL(r.relayUrl).protocol !== "wss:") return false;366    } catch {367      return false;368    }369  }370  return true;371}