types.ts

1/**2 * types.ts — cross-boundary types and the `MessageType` union.3 *4 * `MessageType` mixes background-bound and content-script-bound messages.5 * Background-bound types have a case in `src/background/messages.ts`.6 * Content-script-bound types (PING, SUMMON_AUTOFILL, VAULT_LOCKED,7 * RESTART_AUTO_LOCK, etc.) are sent *to* content scripts or the popup and8 * have no handler in messages.ts by design — that absence is not a missing9 * handler. Add new cross-boundary types here, not inline in call sites.10 */1112export interface ManualSummonRecord {13  firstSummonedAt: number;14  summonCount: number;15  lastSummonedAt: number;16}1718export interface Canary {19  webhookUrl: string;20  label?: string;21  lastPinged?: number;22  pingCount?: number;23}2425export type CardNetwork = "visa" | "mastercard" | "amex" | "discover" | "unknown";2627/**28 * Passkey credential data attached to a VaultEntry. New in v2.11.0 — passkeys29 * are no longer a separate entry type; instead they hang off any login entry.30 * A passkey-only entry is a `type:"login"` entry with no username/password31 * but a `passkey` sub-object set. A login that ALSO has a passkey is just a32 * normal login with `passkey` populated.33 *34 * privateKeyJwk is present only on Chrome-created passkeys, where Peach is35 * the authenticator. Firefox-created passkeys delegate to the platform36 * authenticator, so the field is absent — `browser` distinguishes the two.37 */38export interface PasskeyData {39  rpId: string;40  rpName: string;41  credentialId: string;42  publicKeyCose: string;43  privateKeyJwk?: JsonWebKey;44  userHandle: string;45  userName: string;46  userDisplayName: string;47  algorithm: -7 | -8;48  signCount: number;49  aaguid: string;50  backupEligible: boolean;51  backupState: boolean;52  lastUsedAt?: number;53  browser?: "chrome" | "firefox";54  transports?: string[];55  /** When the credential was first registered with Peach. */56  createdAt: number;57}5859/** One past password kept in an entry's {@link VaultEntry.passwordHistory}. */60export interface PasswordHistoryItem {61  /** The old password value, replaced by a newer one. */62  password: string;63  /**64   * When this password stopped being current — i.e. the `passwordChangedAt`65   * (or `createdAt`) it carried at the moment it was swapped out.66   */67  changedAt: number;68}6970export interface VaultEntry {71  id: string; // crypto.randomUUID()72  /** Entry type. Passkey credentials are carried in the nested `passkey` field. */73  type?: "login" | "note" | "passkey" | "card";74  title: string;75  username?: string; // only for login entries76  email?: string; // separate email address — for sites that require both a username and an email77  password?: string; // only for login entries78  url?: string; // only for login entries79  /**80   * Additional sites this entry should match for autofill. Login entries only.81   * Each value is a full origin or URL (e.g. `https://login.foo.com`).82   * The vault domain index keys against the hostname of every entry in this83   * list, in addition to `url`.84   */85  additionalUrls?: string[];86  totp?: string; // base32 seed, stored encrypted — only for login entries87  /**88   * Optional TOTP parameters parsed from an otpauth:// URI. Absent fields fall89   * back to RFC defaults (SHA-1 / 6 digits / 30-second period). Login entries only.90   */91  totpAlgorithm?: "SHA1" | "SHA256" | "SHA512";92  totpDigits?: number;93  totpPeriod?: number;94  notes?: string;95  breach?: number; // HIBP exposure count; 0 or undefined = clean — only for login entries96  /**97   * When the password field was last changed. Set on first-write of `password`98   * and refreshed on every subsequent change.99   */100  passwordChangedAt?: number;101  /**102   * Previously-used passwords for this entry, newest first. A snapshot of the103   * old password is pushed here automatically whenever the password changes104   * (see `updateEntry` in vault.ts). Capped at PASSWORD_HISTORY_MAX. Lets the105   * user reveal, copy, or restore a password they used before — handy when a106   * site rejects a rotation or an old credential resurfaces.107   */108  passwordHistory?: PasswordHistoryItem[];109  canary?: Canary;110  createdAt: number; // Date.now()111  modifiedAt: number;112  deletedAt?: number;113  tags?: string[];114  /** Passkey credential attached to this entry, if any. */115  passkey?: PasskeyData;116  // Card entry fields117  cardholderName?: string;118  cardNumber?: string;       // full PAN, stored encrypted in vault119  expMonth?: string;120  expYear?: string;121  cvc?: string;122  cardNickname?: string;123  network?: CardNetwork;124  last4?: string;125}126127/** Returns true when an entry has a passkey credential attached. */128export function hasPasskey(entry: VaultEntry): boolean {129  return entry.passkey !== undefined && entry.passkey.credentialId.length > 0;130}131132/** Returns true when an entry is passkey-only and has no password to fill. */133export function isPasskeyOnly(entry: VaultEntry): boolean {134  // An entry is "passkey only" when it holds SOLELY a passkey credential —135  // no password, no TOTP, and no dedicated email. Username is intentionally136  // excluded because it is useful for searching passkey credentials.137  // Entries with passkey + TOTP or passkey + email are NOT passkey-only: they138  // carry fillable credentials and must show the full login-fields UI.139  return hasPasskey(entry) && !entry.password && !entry.totp && !entry.email;140}141142export interface PendingPasskeyRequest {143  requestId: number;144  type: "create" | "get";145  rpId: string;146  rpName: string;147  userName: string;148  userDisplayName?: string;149  /** Originating tab and frame binding for content-script approval responses. */150  tabId?: number;151  origin?: string;152  /**153   * Firefox path: when present, the popup performs the navigator.credentials154   * call itself rather than completing a chrome.webAuthenticationProxy155   * request. Absent for Chrome (the existing webAuthenticationProxy flow).156   */157  browser?: "chrome" | "firefox";158  /** Firefox create: base64url challenge minted by the popup-context flow. */159  challenge?: string;160  /** Firefox create: base64url user handle. Generated if absent. */161  userHandle?: string;162}163164export interface PasskeyProviderState {165  supported: boolean;166  enabled: boolean;167  attached: boolean;168  browserLabel: string;169  statusLabel: string;170  conflict?: string;171}172173export interface StoredVault {174  // Not authenticated as AAD — the actual AES-GCM AAD is the slot's constant175  // aadTag string (see background/aes.ts). The version field is unauthenticated176  // metadata; downgrade prevention does not rest on it.177  version: 1;178  salt: string; // hex --- 16 bytes, CSPRNG, stored not secret179  nonce: string; // hex --- 12 bytes, CSPRNG, fresh per write180  ciphertext: string; // hex --- AES-256-GCM output181  tag: string; // hex --- 16-byte GCM auth tag182  // Recovery escrow: root key wrapped under recovery words via AES-256-GCM.183  recovery_salt?: string; // hex --- 16 bytes, CSPRNG, HKDF salt for recovery key184  recovery_wrapped_root_key?: string; // hex --- AES-256-GCM ciphertext of 32-byte root key185  recovery_nonce?: string; // hex --- 12 bytes, fresh nonce for the above186  recovery_tag?: string; // hex --- 16-byte GCM auth tag for the above187  // Second wrapping of the same root key under the password-derived key.188  // Lets unlock() recover the rootKey bytes without the user's recovery189  // words, so GET_RECOVERY_WORDS works across lock/unlock cycles. Refreshed190  // on every password change so the words stay valid (H2/COR-006).191  pw_root_ciphertext?: string; // hex --- AES-256-GCM ciphertext of 32-byte root key (hex-encoded)192  pw_root_nonce?: string; // hex --- 12-byte nonce193  pw_root_tag?: string; // hex --- 16-byte GCM auth tag194}195196// Background-bound message types — sent from popup/content scripts,197// handled in src/background/messages.ts. Everything in this group must198// have a matching case in that file's switch statement.199export type MessageType =200  | "GET_SYNC_ALERTS"201  | "CLEAR_CLIPBOARD"202  | "GET_PENDING_VOUCHED_DEVICES"203  | "CONFIRM_VOUCHED_DEVICE"204  | "REJECT_VOUCHED_DEVICE"205  | "VOUCHED_DEVICE_PENDING"206  | "ROTATE_SYNC_IDENTITY"207  | "DEVICE_KEY_ROTATED"208  | "UNLOCK"209  | "UNLOCK_WITH_PIN"210  | "GET_PIN_STATUS"211  | "LOCK"212  | "IS_UNLOCKED"213  | "HAS_VAULT"214  | "GET_ENTRIES"215  | "EXPORT_ENTRIES"216  | "ADD_ENTRY"217  | "BATCH_ADD_ENTRIES"218  | "RESTORE_ENTRIES"219  | "CLEAR_VAULT_ENTRIES"220  | "UPDATE_ENTRY"221  | "ADD_ADDITIONAL_URL"222  | "REQUEST_REMEMBER_SITE"223  | "DELETE_ENTRY"224  | "AUTOFILL_QUERY"225  | "COPY"226  | "CREATE_VAULT"227  | "CREATE_VAULT_FROM_ROOT_KEY"228  | "GET_ENTRY_FOR_FILL"229  | "GET_ENTRY_FOR_EDIT"230  | "CHECK_ALL_BREACHES"231  | "GET_SETTINGS"232  | "UPDATE_SETTINGS"233  | "SETUP_PIN"234  | "DISABLE_PIN"235  | "FIRE_CANARY_PING"236  | "ACTIVATE_LICENSE"237  | "GET_LICENSE"238  | "GET_LICENSE_KEY"239  | "IS_DURESS_ENABLED"240  | "SETUP_DURESS"241  | "DISABLE_DURESS"242  | "VERIFY_MAIN_PASSWORD"243  | "CHANGE_PASSWORD"244  | "GET_SITE_PASSWORD_POLICY"245  | "GET_LOCAL_IDENTITY"246  | "LIST_PAIRED_DEVICES"247  | "RENAME_PAIRED_DEVICE"248  | "UNPAIR_DEVICE"249  | "RENAME_LOCAL_DEVICE"250  // Relay pairing. START/CONFIRM/CANCEL are popup→bg requests handled in the251  // switch; ADOPTION_SOURCE_SAS / ADOPTION_SOURCE_RESULT are bg→popup pushes.252  | "START_ADOPTION_SOURCE"253  | "START_ADOPTION_RECEIVER"254  | "LIST_PENDING_ADOPTION_HOLDERS"255  | "REMOVE_PENDING_ADOPTION_HOLDER"256  | "CANCEL_ADOPTION_SOURCE"257  | "SOURCE_SAS_DECISION"258  | "RECEIVER_SAS_DECISION"259  | "ADOPTION_SOURCE_SAS"260  | "ADOPTION_SOURCE_RESULT"261  | "TRIGGER_SYNC"262  | "GET_SYNC_STATE"263  | "GET_SYNC_SETTINGS"264  | "SET_SYNC_SETTINGS"265  | "GET_PENDING_PASSKEY"266  | "APPROVE_PASSKEY"267  | "DENY_PASSKEY"268  | "GET_PASSKEY_PROVIDER_STATE"269  | "SET_PASSKEY_PROVIDER_ENABLED"270  | "GET_DELETED_ENTRIES"271  | "RESTORE_ENTRY"272  | "PURGE_ENTRY"273  | "PURGE_EXPIRED_TRASH"274  | "GET_VAULT_HISTORY"275  | "RESTORE_VAULT_SNAPSHOT"276  | "COUNT_DUPLICATES"277  | "DEDUPLICATE_ENTRIES"278  | "RECORD_MANUAL_SUMMON"279  | "DECLINE_CARD_SAVE"280  | "IS_CARD_DECLINED"281  | "GET_VAULT_STATUS"282  | "GET_ADVANCED_HEALTH_REPORT"283  | "DEACTIVATE_LICENSE"284  | "GET_IDENTITIES"285  | "DESTROY_VAULT"286  | "INITIATE_FIREFOX_PASSKEY_CREATE"287  | "COMPLETE_FIREFOX_PASSKEY_CREATE"288  | "PASSKEY_OFFER_DECLINE"289  | "GET_PASSKEY_OFFER_DECLINED"290  | "GET_PASSKEY_FOR_DOMAIN"291  | "MARK_PASSKEY_BANNER_SHOWN"292  // Firefox content-script proxy path (v2.12.0). Sent FROM the page-world293  // monkey-patch through the extension-world relay TO the background. See294  // src/shared/passkey-flags.ts for removal conditions.295  | "PASSKEY_HAS_CREDENTIALS"296  | "PASSKEY_CREATE"297  | "PASSKEY_GET"298  // Recovery word messages299  | "VALIDATE_RECOVERY_WORDS"300  | "RECOVER_WITH_WORDS"301  | "GET_RECOVERY_WORDS"302  | "GET_RECOVERY_CONFIRM_PENDING"303  | "SET_RECOVERY_CONFIRM_PENDING"304  | "CLEAR_RECOVERY_CONFIRM_PENDING"305  | "GET_IDENTITY_SUGGESTIONS"306  | "TOUCH_AUTO_LOCK"307  | "SAVE_NOTE"308  | "DELETE_NOTE"309  | "GET_NOTES"310  | "SEARCH_VAULT"311  | "ML_INIT"312  | "ML_PREDICT_BATCH"313  // Content-script-bound message types — sent BY the background TO content314  // scripts. They never reach messages.ts's switch. Kept in this union so315  // existing call sites type-check; do not add cases for them in the316  // background handler.317  | "PING"            // background → content: liveness probe318  | "SUMMON_AUTOFILL" // background → content: open the in-page palette319  | "VAULT_LOCKED"    // background → content/popup: vault just locked320  | "VAULT_UNLOCKED"  // background → content/popup: vault just unlocked321  | "PRO_GATE_TRIGGERED" // background → popup: a Pro feature was attempted on free322  | "PASSKEY_PRO_GATE" // background → content: show passkey Pro gate in inline popup323  | "OPEN_PRO_GATE" // content → background: open popup and navigate to License section324  | "OPEN_POPUP" // content → background: open the extension popup (e.g. to unlock)325  | "REQUEST_REMEMBER_SITE" // content → background: queue "use this entry on this site" for the popup to confirm326  | "OPEN_DETACHED_POPUP" // popup → background: open the popup HTML in a standalone window (file-picker flows)327  | "SHOW_PASSKEY_TOAST"    // background → content tab: show passkey auth toast328  | "DISMISS_PASSKEY_TOAST" // background → content tab: dismiss passkey auth toast329  | "PASSKEY_AUTH_RESPONSE" // content → background: user approved or denied the toast330  | "SHOULD_PLAY_CELEBRATION"331  | "MARK_CELEBRATION_PLAYED"332  // Peach Codex (v2.42.0). Generation runs in the popup — the SW only333  // sources vault data and applies the restored slots.334  | "GET_CODEX_VAULT_DATA"335  | "ESTIMATE_CODEX_PAGES"336  | "GENERATE_CODEX"337  | "RESTORE_FROM_CODEX";338339export type ProFeature =340  | "sync"341  | "passkeys"342  | "advanced_health"343  | "ios_app"344  | "codex"345  | "canary_entry"346  | "duress_vault";347348/**349 * License export shape included in PeachScript and encrypted JSON backups.350 * `celebrationPlayed` is intentionally absent — a new device deserves the moment.351 */352export interface PeachLicenseExport {353  key: string;354  activatedAt?: number;355}356357export interface AdvancedHealthEntryReport {358  id: string;359  title: string;360  domain: string;361  url?: string;362  score: number;363  ageDays: number;364  reasons: string[];365  factors: {366    breached: boolean;367    breachCount: number;368    reused: boolean;369    aged: boolean;370    weak: boolean;371    missingTotpOnSensitive: boolean;372  };373}374375export interface AdvancedHealthReport {376  vaultScore: number;377  generatedAt: number;378  entryCount: number;379  reusedGroups: number;380  agedCount: number;381  remediation: AdvancedHealthEntryReport[];382}383384export const ACCENT_COLORS = [385  { name: "peach",    hex: "#F49C70" },386  { name: "rose",     hex: "#FF8AA6" },387  { name: "plum",     hex: "#D597F2" },388  { name: "lavender", hex: "#A6A8FF" },389  { name: "sky",      hex: "#5BC8EE" },390  { name: "mint",     hex: "#5EE0B0" },391  { name: "sage",     hex: "#B5D870" },392  { name: "butter",   hex: "#FFD45A" },393  { name: "sand",     hex: "#EDBC85" },394  { name: "clay",     hex: "#F08660" },395  { name: "slate",    hex: "#80BEDE" },396  { name: "stone",    hex: "#C8B8A8" },397] as const;398399export type AccentColorName = typeof ACCENT_COLORS[number]["name"];400401export interface SavedIdentity {402  value: string;403  type: "email" | "username";404  lastUsed: number;405  useCount: number;406  exampleDomain?: string;407}408409export interface PasswordPolicy {410  minLength?: number;411  maxLength?: number;412  requiresUppercase?: boolean;413  requiresLowercase?: boolean;414  requiresNumbers?: boolean;415  requiresSymbols?: boolean;416  forbidsSymbols?: boolean;417  allowedSymbols?: string;418  /** Characters the site explicitly disallows. Filtered from every pool before generation. */419  forbiddenChars?: string;420}421422/**423 * A single vault history snapshot. The `vault_a` and `vault_b` fields are the424 * raw encrypted blobs from chrome.storage.local — already AES-256-GCM425 * protected by the master password, so storing them in history adds no426 * security surface.427 *428 * Snapshots are taken BEFORE every vault write so the saved blob represents429 * what is about to be lost, not what was just written. The reason field430 * documents the trigger so the UI can render "saved" / "synced" / "imported"431 * / "restored" labels next to each row.432 */433export interface VaultSnapshot {434  id: string;435  savedAt: number;436  reason: "local_save" | "sync_received" | "import" | "restore";437  vault_a: string;438  vault_b: string;439  /**440   * Coarse size bucket (ceiling) of active entries when the snapshot was taken;441   * null if vault was locked or in decoy mode. PCH-01-023: bucketed, not exact,442   * so the plaintext value cannot leak vault size or per-write deltas. UI should443   * render it as "up to N", never as an exact count.444   */445  entryCount: number | null;446}447448export interface VaultHistory {449  /** Newest first; capped at HISTORY_MAX (10). */450  snapshots: VaultSnapshot[];451}452453export interface Message {454  type: MessageType;455  payload?: unknown;456}457458export interface MessageResponse {459  ok: boolean;460  data?: unknown;461  error?: string;462  vaultId?: string;463  unlocked?: boolean;464  // Set on UNLOCK responses when the vault decrypted but failed schema465  // validation (M7/COR-007). The popup may offer a history-restore flow.466  canRestoreFromHistory?: boolean;467  // Set on COPY responses: the effective clipboard auto-clear delay in seconds,468  // so the content script's TOTP toast can advertise the real configured time.469  clearSeconds?: number;470}