packages/shared/lib/interfaces/Key.ts

   1 import type { PrivateKeyReference, PublicKeyReference } from '@proton/crypto';
   2
   3 import type { RequireSome } from './utils';
   4
   5 export interface KeyWithRecoverySecret extends Key {
   6     RecoverySecret: string;
   7     RecoverySecretSignature: string;
   8 }
   9
  10 export interface Key {
  11     ID: string;
  12     Primary: 1 | 0;
  13     Active: 1 | 0;
  14     Flags?: number; // Only available for address keys
  15     Fingerprint: string;
  16     Fingerprints: string[];
  17     PublicKey: string; // armored key
  18     Version: number;
  19     Activation?: string;
  20     PrivateKey: string; // armored key
  21     Token?: string;
  22     Signature?: string; // Only available for address keys
  23     RecoverySecret?: string | null; // Only available for user keys
  24     RecoverySecretSignature?: string | null; // Only available for user keys
  25     AddressForwardingID?: string | null; // Only available for address keys
  26 }
  27
  28 export type AddressKey = RequireSome<Key, 'Flags' | 'Signature' | 'AddressForwardingID'>;
  29 export type UserKey = RequireSome<Key, 'RecoverySecret' | 'RecoverySecretSignature'>;
  30
  31 export interface KeyPair {
  32     privateKey: PrivateKeyReference;
  33     publicKey: PublicKeyReference;
  34 }
  35
  36 export interface KeysPair {
  37     privateKeys: PrivateKeyReference[];
  38     publicKeys: PublicKeyReference[];
  39 }
  40
  41 export interface DecryptedKey extends KeyPair {
  42     ID: string;
  43 }
  44
  45 export interface DecryptedAddressKey extends KeyPair {
  46     ID: string;
  47     Flags: number;
  48     Primary: 1 | 0;
  49 }
  50
  51 export interface InactiveKey {
  52     Key: Key;
  53     fingerprint?: string;
  54 }
  55
  56 export interface ActiveKey extends DecryptedKey {
  57     fingerprint: string;
  58     flags: number;
  59     primary: 1 | 0;
  60     sha256Fingerprints: string[];
  61 }