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  /**73   * Entry type. As of v2.11.0 passkeys are stored on `type:"login"` entries74   * via the `passkey` sub-object — `"passkey"` here is a legacy value still75   * accepted on read but rewritten to `"login"` on next vault save.76   */77  type?: "login" | "note" | "passkey" | "card";78  title: string;79  username?: string; // only for login entries80  email?: string; // separate email address — for sites that require both a username and an email81  password?: string; // only for login entries82  url?: string; // only for login entries83  /**84   * Additional sites this entry should match for autofill. Login entries only.85   * Each value is a full origin or URL (e.g. `https://login.foo.com`).86   * The vault domain index keys against the hostname of every entry in this87   * list, in addition to `url`.88   */89  additionalUrls?: string[];90  totp?: string; // base32 seed, stored encrypted — only for login entries91  notes?: string;92  breach?: number; // HIBP exposure count; 0 or undefined = clean — only for login entries93  /**94   * When the password field was last changed. Set on first-write of `password`95   * and refreshed on every subsequent change. Defaults to `createdAt` when96   * legacy entries are read by the advanced health analyser.97   */98  passwordChangedAt?: number;99  /**100   * Previously-used passwords for this entry, newest first. A snapshot of the101   * old password is pushed here automatically whenever the password changes102   * (see `updateEntry` in vault.ts). Capped at PASSWORD_HISTORY_MAX. Lets the103   * user reveal, copy, or restore a password they used before — handy when a104   * site rejects a rotation or an old credential resurfaces.105   */106  passwordHistory?: PasswordHistoryItem[];107  canary?: Canary;108  createdAt: number; // Date.now()109  modifiedAt: number;110  deletedAt?: number;111  tags?: string[];112  /** Passkey credential attached to this entry, if any. */113  passkey?: PasskeyData;114  // ── Legacy passkey flat fields (pre-v2.11.0). Populated by vault read115  // migration so that the old import/sanitize paths keep typing; new code116  // should always read `entry.passkey?.*` instead. The migration drops these117  // on next vault save. Do not introduce new readers of these fields.118  rpId?: string;119  rpName?: string;120  credentialId?: string;121  publicKeyCose?: string;122  privateKeyJwk?: JsonWebKey;123  userHandle?: string;124  userName?: string;125  userDisplayName?: string;126  algorithm?: -7 | -8;127  signCount?: number;128  aaguid?: string;129  backupEligible?: boolean;130  backupState?: boolean;131  lastUsedAt?: number;132  browser?: "chrome" | "firefox";133  transports?: string[];134  // Card entry fields135  cardholderName?: string;136  cardNumber?: string;       // full PAN, stored encrypted in vault137  expMonth?: string;138  expYear?: string;139  cvc?: string;140  cardNickname?: string;141  network?: CardNetwork;142  last4?: string;143}144145/**146 * Returns true when an entry has a passkey credential attached. After v2.11.0147 * migration this is the canonical check; pre-migration entries with a flat148 * `rpId`/`credentialId` shape get rewritten by the vault read pass before149 * any consumer sees them.150 */151export function hasPasskey(entry: VaultEntry): boolean {152  return entry.passkey !== undefined && entry.passkey.credentialId.length > 0;153}154155/**156 * Returns true when an entry is "passkey-only" — has a passkey credential157 * but no password to fill into a form. Login fields hide for these entries158 * and the inline autofill selector filters them out (signing in via the159 * passkey is a separate WebAuthn flow). Username may still be populated160 * (the migration mirrors passkey.userName onto the entry's username so the161 * domain-index/search keep working) and is not part of this discriminator.162 */163export function isPasskeyOnly(entry: VaultEntry): boolean {164  // An entry is "passkey only" when it holds SOLELY a passkey credential —165  // no password, no TOTP, and no dedicated email. Username is intentionally166  // excluded (the migration copies passkey.userName onto username for search).167  // Entries with passkey + TOTP or passkey + email are NOT passkey-only: they168  // carry fillable credentials and must show the full login-fields UI.169  return hasPasskey(entry) && !entry.password && !entry.totp && !entry.email;170}171172export interface LegacyVaultEntry {173  id: string;174  title: string;175  username: string;176  password: string;177  url: string;178  totp?: string;179  notes?: string;180  breach?: number;181  created: number;182  updated: number;183  deletedAt?: number;184}185186export interface CardEntry extends VaultEntry {187  type: "card";188  cardholderName: string;189  cardNumber: string;190  expMonth: string;191  expYear: string;192  cvc: string;193}194195196export interface PendingPasskeyRequest {197  requestId: number;198  type: "create" | "get";199  rpId: string;200  rpName: string;201  userName: string;202  userDisplayName?: string;203  /**204   * Firefox path: when present, the popup performs the navigator.credentials205   * call itself rather than completing a chrome.webAuthenticationProxy206   * request. Absent for Chrome (the existing webAuthenticationProxy flow).207   */208  browser?: "chrome" | "firefox";209  /** Firefox create: base64url challenge minted by the popup-context flow. */210  challenge?: string;211  /** Firefox create: base64url user handle. Generated if absent. */212  userHandle?: string;213}214215export interface PasskeyProviderState {216  supported: boolean;217  enabled: boolean;218  attached: boolean;219  browserLabel: string;220  statusLabel: string;221  conflict?: string;222}223224export interface StoredVault {225  version: 1; // AAD for AES-GCM --- prevents downgrade226  salt: string; // hex --- 16 bytes, CSPRNG, stored not secret227  nonce: string; // hex --- 12 bytes, CSPRNG, fresh per write228  ciphertext: string; // hex --- AES-256-GCM output229  tag: string; // hex --- 16-byte GCM auth tag230  // Recovery escrow: root key wrapped under recovery words via AES-256-GCM.231  // Absent on vaults created before v2.12 (migrateToRecovery adds them on first unlock).232  recovery_salt?: string; // hex --- 16 bytes, CSPRNG, HKDF salt for recovery key233  recovery_wrapped_root_key?: string; // hex --- AES-256-GCM ciphertext of 32-byte root key234  recovery_nonce?: string; // hex --- 12 bytes, fresh nonce for the above235  recovery_tag?: string; // hex --- 16-byte GCM auth tag for the above236  // Second wrapping of the same root key under the password-derived key.237  // Lets unlock() recover the rootKey bytes without the user's recovery238  // words, so GET_RECOVERY_WORDS works across lock/unlock cycles. Refreshed239  // on every password change so the words stay valid (H2/COR-006).240  pw_root_ciphertext?: string; // hex --- AES-256-GCM ciphertext of 32-byte root key (hex-encoded)241  pw_root_nonce?: string; // hex --- 12-byte nonce242  pw_root_tag?: string; // hex --- 16-byte GCM auth tag243}244245// Background-bound message types — sent from popup/content scripts,246// handled in src/background/messages.ts. Everything in this group must247// have a matching case in that file's switch statement.248export type MessageType =249  | "GET_SYNC_ALERTS"250  | "CLEAR_CLIPBOARD"251  | "UNLOCK"252  | "LOCK"253  | "IS_UNLOCKED"254  | "HAS_VAULT"255  | "GET_ENTRIES"256  | "ADD_ENTRY"257  | "BATCH_ADD_ENTRIES"258  | "RESTORE_ENTRIES"259  | "CLEAR_VAULT_ENTRIES"260  | "UPDATE_ENTRY"261  | "ADD_ADDITIONAL_URL"262  | "DELETE_ENTRY"263  | "AUTOFILL_QUERY"264  | "COPY"265  | "CREATE_VAULT"266  | "GET_ENTRY_FOR_FILL"267  | "GET_ENTRY_FOR_EDIT"268  | "CHECK_ALL_BREACHES"269  | "GET_SETTINGS"270  | "UPDATE_SETTINGS"271  | "FIRE_CANARY_PING"272  | "ACTIVATE_LICENSE"273  | "GET_LICENSE"274  | "GET_LICENSE_KEY"275  | "IS_DURESS_ENABLED"276  | "SETUP_DURESS"277  | "DISABLE_DURESS"278  | "VERIFY_MAIN_PASSWORD"279  | "CHANGE_PASSWORD"280  | "GET_SITE_PASSWORD_POLICY"281  | "CHIRP_GET_LOCAL_IDENTITY"282  | "CHIRP_COMPLETE_PAIRING"283  | "CHIRP_LIST_PAIRED_DEVICES"284  | "CHIRP_UNPAIR_DEVICE"285  | "CHIRP_RENAME_LOCAL_DEVICE"286  | "TRIGGER_SYNC"287  | "GET_SYNC_STATE"288  | "GET_PENDING_PASSKEY"289  | "APPROVE_PASSKEY"290  | "DENY_PASSKEY"291  | "GET_PASSKEY_PROVIDER_STATE"292  | "SET_PASSKEY_PROVIDER_ENABLED"293  | "GET_DELETED_ENTRIES"294  | "RESTORE_ENTRY"295  | "PURGE_ENTRY"296  | "PURGE_EXPIRED_TRASH"297  | "GET_VAULT_HISTORY"298  | "RESTORE_VAULT_SNAPSHOT"299  | "COUNT_DUPLICATES"300  | "DEDUPLICATE_ENTRIES"301  | "RECORD_MANUAL_SUMMON"302  | "DECLINE_CARD_SAVE"303  | "IS_CARD_DECLINED"304  | "SUBMIT_FEEDBACK"305  | "GET_VAULT_STATUS"306  | "GET_ADVANCED_HEALTH_REPORT"307  | "DEACTIVATE_LICENSE"308  | "GET_IDENTITIES"309  | "DESTROY_VAULT"310  | "INITIATE_FIREFOX_PASSKEY_CREATE"311  | "COMPLETE_FIREFOX_PASSKEY_CREATE"312  | "PASSKEY_OFFER_DECLINE"313  | "GET_PASSKEY_OFFER_DECLINED"314  | "GET_PASSKEY_FOR_DOMAIN"315  // Firefox content-script proxy path (v2.12.0). Sent FROM the page-world316  // monkey-patch through the extension-world relay TO the background. See317  // src/shared/passkey-flags.ts for removal conditions.318  | "PASSKEY_HAS_CREDENTIALS"319  | "PASSKEY_CREATE"320  | "PASSKEY_GET"321  // Android / iOS message types — activate only when Capacitor.isNativePlatform() is true.322  | "UNLOCK_WITH_KEY"323  | "GET_DERIVED_KEY"324  // Recovery word messages325  | "VALIDATE_RECOVERY_WORDS"326  | "RECOVER_WITH_WORDS"327  | "GET_RECOVERY_WORDS"328  | "GET_IDENTITY_SUGGESTIONS"329  | "TOUCH_AUTO_LOCK"330  | "POPULATE_INLINE_VAULT"331  | "SAVE_NOTE"332  | "DELETE_NOTE"333  | "GET_NOTES"334  | "SEARCH_VAULT"335  | "ML_INIT"336  | "ML_PREDICT_BATCH"337  // Content-script-bound message types — sent BY the background TO content338  // scripts. They never reach messages.ts's switch. Kept in this union so339  // existing call sites type-check; do not add cases for them in the340  // background handler.341  | "PING"            // background → content: liveness probe342  | "SUMMON_AUTOFILL" // background → content: open the in-page palette343  | "VAULT_LOCKED"    // background → content/popup: vault just locked344  | "VAULT_UNLOCKED"  // background → content/popup: vault just unlocked345  | "PRO_GATE_TRIGGERED" // background → popup: a Pro feature was attempted on free346  | "PASSKEY_PRO_GATE" // background → content: show passkey Pro gate in inline popup347  | "OPEN_PRO_GATE" // content → background: open popup and navigate to License section348  | "OPEN_POPUP" // content → background: open the extension popup (e.g. to unlock)349  | "SHOW_PASSKEY_TOAST"    // background → content tab: show passkey auth toast350  | "DISMISS_PASSKEY_TOAST" // background → content tab: dismiss passkey auth toast351  | "PASSKEY_AUTH_RESPONSE" // content → background: user approved or denied the toast352  | "SHOULD_PLAY_CELEBRATION"353  | "MARK_CELEBRATION_PLAYED"354  // Peach Codex (v2.42.0). Generation runs in the popup — the SW only355  // sources vault data and applies the restored slots.356  | "GET_CODEX_VAULT_DATA"357  | "ESTIMATE_CODEX_PAGES"358  | "GENERATE_CODEX"359  | "RESTORE_FROM_CODEX";360361export type ProFeature =362  | "sync"363  | "passkeys"364  | "advanced_health"365  | "ios_app"366  | "codex"367  | "canary_entry"368  | "duress_vault";369370/**371 * License export shape included in PeachScript and encrypted JSON backups.372 * `celebrationPlayed` is intentionally absent — a new device deserves the moment.373 */374export interface PeachLicenseExport {375  key: string;376  activatedAt?: number;377}378379export interface AdvancedHealthEntryReport {380  id: string;381  title: string;382  domain: string;383  url?: string;384  score: number;385  ageDays: number;386  reasons: string[];387  factors: {388    breached: boolean;389    breachCount: number;390    reused: boolean;391    aged: boolean;392    weak: boolean;393    missingTotpOnSensitive: boolean;394  };395}396397export interface AdvancedHealthReport {398  vaultScore: number;399  generatedAt: number;400  entryCount: number;401  reusedGroups: number;402  agedCount: number;403  remediation: AdvancedHealthEntryReport[];404}405406export const ACCENT_COLORS = [407  { name: "peach",    hex: "#F49C70" },408  { name: "rose",     hex: "#FF8AA6" },409  { name: "plum",     hex: "#D597F2" },410  { name: "lavender", hex: "#A6A8FF" },411  { name: "sky",      hex: "#5BC8EE" },412  { name: "mint",     hex: "#5EE0B0" },413  { name: "sage",     hex: "#B5D870" },414  { name: "butter",   hex: "#FFD45A" },415  { name: "sand",     hex: "#EDBC85" },416  { name: "clay",     hex: "#F08660" },417  { name: "slate",    hex: "#80BEDE" },418  { name: "stone",    hex: "#C8B8A8" },419] as const;420421export type AccentColorName = typeof ACCENT_COLORS[number]["name"];422423export interface SavedIdentity {424  value: string;425  type: "email" | "username";426  lastUsed: number;427  useCount: number;428  exampleDomain?: string;429}430431export interface PasswordPolicy {432  minLength?: number;433  maxLength?: number;434  requiresUppercase?: boolean;435  requiresLowercase?: boolean;436  requiresNumbers?: boolean;437  requiresSymbols?: boolean;438  forbidsSymbols?: boolean;439  allowedSymbols?: string;440  /** Characters the site explicitly disallows. Filtered from every pool before generation. */441  forbiddenChars?: string;442}443444/**445 * A single vault history snapshot. The `vault_a` and `vault_b` fields are the446 * raw encrypted blobs from chrome.storage.local — already AES-256-GCM447 * protected by the master password, so storing them in history adds no448 * security surface.449 *450 * Snapshots are taken BEFORE every vault write so the saved blob represents451 * what is about to be lost, not what was just written. The reason field452 * documents the trigger so the UI can render "saved" / "synced" / "imported"453 * / "restored" labels next to each row.454 */455export interface VaultSnapshot {456  id: string;457  savedAt: number;458  reason: "local_save" | "sync_received" | "import" | "restore";459  vault_a: string;460  vault_b: string;461  /** Active entry count when the snapshot was taken; null if vault was locked. */462  entryCount: number | null;463}464465export interface VaultHistory {466  /** Newest first; capped at HISTORY_MAX (10). */467  snapshots: VaultSnapshot[];468}469470export interface Message {471  type: MessageType;472  payload?: unknown;473}474475// Canonical snake_case error codes returned by message handlers. Keep this476// union the authoritative catalogue — new handlers must reuse an entry or477// add one here. Free-form strings still appear (network/operation failures478// surface their raw .message), so error stays string at runtime; the union479// is the documented set callers should switch on.480export type ErrorCode =481  | "vault_locked"482  | "vault_corrupted"483  | "no_vault"484  | "entry_not_found"485  | "invalid_payload"486  | "invalid_message"487  | "invalid_sender"488  | "wrong_passphrase"489  | "incorrect_current_password"490  | "recovery_not_setup"491  | "android_only"492  | "not_available"493  | "pro_required"494  | "pairing_not_verified"495  | "sync_rejected_unpaired_initiator"496  | "vault_not_applied"497  | "url_required"498  | "domain_required"499  | "rpid_required"500  | "rpid_and_username_required"501  | "publickeyhex_required"502  | "missing_payload"503  | "login_entries_only"504  | "passkey_not_fillable"505  | "invalid_webhook_url"506  | "invalid_feedback_endpoint"507  | "message_empty"508  | "network_error"509  | "operation_failed"510  | "unknown_message_type";511512export interface MessageResponse {513  ok: boolean;514  data?: unknown;515  error?: string;516  unlocked?: boolean;517  // Set on UNLOCK responses when the vault decrypted but failed schema518  // validation (M7/COR-007). The popup may offer a history-restore flow.519  canRestoreFromHistory?: boolean;520}