Class DefaultIdentityKeyManager

constructor

• new DefaultIdentityKeyManager(
      identitySecret?: CryptoKey,
      identityPublic?: CryptoKey,
  ): DefaultIdentityKeyManager

  Parameters

  • OptionalidentitySecret: CryptoKey
  • OptionalidentityPublic: CryptoKey

  Returns DefaultIdentityKeyManager

OptionalidentityPublic

OptionalidentitySecret

OptionalmyIdentityString

oneTimeKeys

OptionalpreKey

exportIdentityKeypair

• exportIdentityKeypair(
      identitySecret: CryptoKey,
  ): Promise<{ pk: string; sk: string }>

  Export identity keypair data for storage. Returns an object with hex-encoded keys that can be stored by the application. Uses raw format for better browser compatibility.

  Parameters

  • identitySecret: CryptoKey

  Returns Promise<{ pk: string; sk: string }>

fetchAndWipeOneTimeSecretKey

• fetchAndWipeOneTimeSecretKey(pk: string): Promise<CryptoKey>

  Search the one-time-keys pool for a given X25519 public key. Return the corresponding secret key (and delete it from the pool).

  Parameters

  • pk: string

  Returns Promise<CryptoKey>

generateIdentityKeypair

• generateIdentityKeypair(): Promise<IdentityKeyPair>

  Generates an identity keypair (Ed25519).

  Returns Promise<IdentityKeyPair>

generatePreKeypair

• generatePreKeypair(): Promise<PreKeyPair>

  Get (and generate, if it doesn't exist) the pre-key keypair.

  This only returns the X25519 keys. It doesn't include the Ed25519 signature.

  Returns Promise<PreKeyPair>

getIdentityKeypair

• getIdentityKeypair(): Promise<IdentityKeyPair>

  Get the stored identity keypair (Ed25519). If no identity keys are set, this will generate new ones.

  Returns Promise<IdentityKeyPair>

getMyIdentityString

• getMyIdentityString(): Promise<string>

  Returns Promise<string>

getPreKeypair

• getPreKeypair(): Promise<PreKeyPair>

  Get (and generate, if it doesn't exist) the pre-key keypair.

  This only returns the X25519 keys. It doesn't include the Ed25519 signature.

  Returns Promise<PreKeyPair>

loadIdentityKeypair

• loadIdentityKeypair(
      storedData?: { pk: string; sk: string },
  ): Promise<IdentityKeyPair>

  Load an Ed25519 keypair from stored data. This method now expects the user to provide the stored data directly.

  Parameters

  • OptionalstoredData: { pk: string; sk: string }

    Object with 'sk' and 'pk' hex strings

  Returns Promise<IdentityKeyPair>

persistOneTimeKeys

• persistOneTimeKeys(bundle: Keypair[]): Promise<void>

  Store one-time keys in memory.

  Parameters

  • bundle: Keypair[]

  Returns Promise<void>

setIdentityKeypair

• setIdentityKeypair(
      identitySecret: CryptoKey,
      identityPublic?: CryptoKey,
  ): Promise<DefaultIdentityKeyManager>

  Sets the identity keys stored in this object.

  Parameters

  • identitySecret: CryptoKey
  • OptionalidentityPublic: CryptoKey

  Returns Promise<DefaultIdentityKeyManager>

setMyIdentityString

• setMyIdentityString(id: string): Promise<void>

  Parameters

  • id: string

  Returns Promise<void>