Class AbstractKeysAbstract

constructor

• new AbstractKeys(opts: KeyArgs): AbstractKeys

  Parameters

  • opts: KeyArgs

  Returns AbstractKeys

DID

exchangeKey

hasPersisted

isSessionOnly

writeKey

Static_instance

StaticEXCHANGE_KEY_NAME

StaticWRITE_KEY_NAME

deviceName

• get deviceName(): Promise<string>

  The machine-readable name for this keypair.

  Returns Promise<string>

privateExchangeKey

• get privateExchangeKey(): CryptoKey

  Returns CryptoKey

privateWriteKey

• get privateWriteKey(): CryptoKey

  Returns CryptoKey

publicExchangeKey

• get publicExchangeKey(): CryptoKey & {
      asString: (format?: SupportedEncodings) => Promise<string>;
  }

  Returns CryptoKey & { asString: (format?: SupportedEncodings) => Promise<string> }

publicWriteKey

• get publicWriteKey(): CryptoKey & {
      asString: (format?: SupportedEncodings) => Promise<string>;
  }

  Returns CryptoKey & { asString: (format?: SupportedEncodings) => Promise<string> }

Abstractdecrypt

• decrypt(
      msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>,
      publicKeyOrKeysize?: string | CryptoKey | SymmKeyLength | null,
      aesAlgorithm?: string | null,
  ): Promise<ArrayBuffer | Uint8Array<ArrayBufferLike>>

  Parameters

  • msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>
  • OptionalpublicKeyOrKeysize: string | CryptoKey | SymmKeyLength | null
  • OptionalaesAlgorithm: string | null

  Returns Promise<ArrayBuffer | Uint8Array<ArrayBufferLike>>

AbstractdecryptAsString

• decryptAsString(
      msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>,
      publicKeyOrKeysize?: string | CryptoKey | SymmKeyLength | null,
      aesAlgorithm?: string | null,
  ): Promise<string>

  Parameters

  • msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>
  • OptionalpublicKeyOrKeysize: string | CryptoKey | SymmKeyLength | null
  • OptionalaesAlgorithm: string | null

  Returns Promise<string>

delete

• delete(): Promise<void>

  Delete the keys stored in indexedDB.

  Returns Promise<void>

Abstractencrypt

• encrypt(
      content: string | Uint8Array<ArrayBufferLike>,
      recipient?: string | CryptoKey | null,
      aesKeyOrInfo?: string | Uint8Array<ArrayBufferLike> | CryptoKey | null,
      keysizeOrAesKey?:
          | string
          | Uint8Array<ArrayBufferLike>
          | CryptoKey
          | SymmKeyLength
          | null,
      keysize?: SymmKeyLength | null,
  ): Promise<Uint8Array<ArrayBufferLike>>

  By default, encrypt the given data to yourself, as a "note to self".

  Parameters

  • content: string | Uint8Array<ArrayBufferLike>
  • Optionalrecipient: string | CryptoKey | null
  • OptionalaesKeyOrInfo: string | Uint8Array<ArrayBufferLike> | CryptoKey | null
  • OptionalkeysizeOrAesKey: string | Uint8Array<ArrayBufferLike> | CryptoKey | SymmKeyLength | null
  • Optionalkeysize: SymmKeyLength | null

  Returns Promise<Uint8Array<ArrayBufferLike>>

AbstractencryptAsString

• encryptAsString(
      content: string | Uint8Array<ArrayBufferLike>,
      recipient?: string | CryptoKey | null,
      aesKeyOrInfo?: string | Uint8Array<ArrayBufferLike> | CryptoKey | null,
      keysizeOrAesKey?:
          | string
          | Uint8Array<ArrayBufferLike>
          | CryptoKey
          | SymmKeyLength
          | null,
      keysize?: SymmKeyLength | null,
  ): Promise<string>

  Parameters

  • content: string | Uint8Array<ArrayBufferLike>
  • Optionalrecipient: string | CryptoKey | null
  • OptionalaesKeyOrInfo: string | Uint8Array<ArrayBufferLike> | CryptoKey | null
  • OptionalkeysizeOrAesKey: string | Uint8Array<ArrayBufferLike> | CryptoKey | SymmKeyLength | null
  • Optionalkeysize: SymmKeyLength | null

  Returns Promise<string>

AbstractgetAesKey

• getAesKey(
      publicKey?: string | CryptoKey | null,
      info?: string | null,
  ): Promise<CryptoKey>

  Get the relevant AES key.

  • if this is an ECC keypair, then use DHKE with the given public key
  • if this is RSA, use your private key to decrypt the given AES key

  Parameters

  • OptionalpublicKey: string | CryptoKey | null
  • Optionalinfo: string | null

  Returns Promise<CryptoKey>

getDeviceName

• getDeviceName(): Promise<string>

  Return a 32-character, DNS friendly hash of the public signing key.

  Returns Promise<string>

persist

• persist(): Promise<void>

  Save this keys instance to indexedDB.

  Returns Promise<void>

publicExchangeKeyAsString

• publicExchangeKeyAsString(format?: SupportedEncodings): Promise<string>

  Parameters

  • Optionalformat: SupportedEncodings

  Returns Promise<string>

publicWriteKeyAsString

• publicWriteKeyAsString(format?: SupportedEncodings): Promise<string>

  Parameters

  • Optionalformat: SupportedEncodings

  Returns Promise<string>

Abstractsign

• sign(msg: Msg, charsize?: CharSize): Promise<Uint8Array<ArrayBufferLike>>

  Parameters

  • msg: Msg
  • Optionalcharsize: CharSize

  Returns Promise<Uint8Array<ArrayBufferLike>>

AbstractsignAsString

• signAsString(msg: string, charsize?: CharSize): Promise<string>

  Parameters

  • msg: string
  • Optionalcharsize: CharSize

  Returns Promise<string>

AbstracttoJson

• toJson(
      format?: SupportedEncodings,
  ): Promise<{ DID: `did:key:z${string}`; publicExchangeKey: string }>

  Parameters

  • Optionalformat: SupportedEncodings

  Returns Promise<{ DID: `did:key:z${string}`; publicExchangeKey: string }>

Static_createExchangeKeys

• _createExchangeKeys(_extractable?: boolean): Promise<CryptoKeyPair>

  Parameters

  • Optional_extractable: boolean

  Returns Promise<CryptoKeyPair>

Static_createWriteKeys

• _createWriteKeys(_extractable?: boolean): Promise<CryptoKeyPair>

  Parameters

  • Optional_extractable: boolean

  Returns Promise<CryptoKeyPair>

Staticcreate

• create<T extends AbstractKeys>(
      this: ChildKeys,
      session?: boolean,
      extractable?: boolean,
      keys?: {
          exchangeKeys?: CryptoKeyPair | null;
          writeKeys?: CryptoKeyPair | null;
      },
  ): Promise<T>

  Type Parameters

  • T extends AbstractKeys

  Parameters

  • this: ChildKeys
  • Optionalsession: boolean
  • Optionalextractable: boolean
  • Optionalkeys: { exchangeKeys?: CryptoKeyPair | null; writeKeys?: CryptoKeyPair | null }

  Returns Promise<T>

StaticdeviceName

• deviceName(did: `did:key:z${string}`): Promise<string>

  Return a 32-character, DNS-friendly hash of the given DID.

  Parameters

  • did: `did:key:z${string}`

    A DID format string

  Returns Promise<string>

  32 character, base32 hash of the DID

Staticexist

• exist(
      opts?: { encryptionKeyName?: string; writeKeyName?: string },
  ): Promise<boolean>

  Parameters

  • opts: { encryptionKeyName?: string; writeKeyName?: string } = {}

  Returns Promise<boolean>

Staticload

• load<T extends AbstractKeys = AbstractKeys>(
      this: ChildKeys<AbstractKeys> & typeof AbstractKeys,
      opts?: Partial<
          {
              encryptionKeyName: string;
              extractable: boolean;
              session: boolean;
              writeKeyName: string;
          },
      >,
  ): Promise<T>

  Restore some keys from indexedDB, or create a new keypair if it doesn't exist yet.

  Type Parameters

  • T extends AbstractKeys = AbstractKeys

  Parameters

  • this: ChildKeys<AbstractKeys> & typeof AbstractKeys
  • opts: Partial<
        {
            encryptionKeyName: string;
            extractable: boolean;
            session: boolean;
            writeKeyName: string;
        },
    > = ...

    Strings to use as keys in indexedDB, and a session boolean, is this in memory only? Or can it be persisted.

  Returns Promise<T>