Class DefaultIdentityKeyManager

constructor

• new DefaultIdentityKeyManager(
      sodium?: SodiumPlus,
      sk?: Ed25519SecretKey,
      pk?: Ed25519PublicKey,
  ): DefaultIdentityKeyManager

• Parameters

  • Optionalsodium: SodiumPlus
  • Optionalsk: Ed25519SecretKey
  • Optionalpk: Ed25519PublicKey

  Returns DefaultIdentityKeyManager

OptionalidentityPublic

OptionalidentitySecret

OptionalmyIdentityString

oneTimeKeys

OptionalpreKey

Optionalsodium

fetchAndWipeOneTimeSecretKey

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

• 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<X25519SecretKey>

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).

  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>

getSodium

• getSodium(): Promise<SodiumPlus>

• Get the instance of libsodium.

  Returns Promise<SodiumPlus>

loadIdentityKeypair

• loadIdentityKeypair(filePath?: string): Promise<IdentityKeyPair>

• Load an Ed25519 keypair from the filesystem.

  Parameters

  • OptionalfilePath: string

  Returns Promise<IdentityKeyPair>

persistOneTimeKeys

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

• Store one-time keys in memory.

  Parameters

  • bundle: Keypair[]

  Returns Promise<void>

saveIdentityKeypair

• saveIdentityKeypair(
      identitySecret: Ed25519SecretKey,
      filePath?: string,
  ): Promise<void>

• Save a given identity keypair (Ed25519) to the filesystem.

  Parameters

  • identitySecret: Ed25519SecretKey
  • OptionalfilePath: string

  Returns Promise<void>

setIdentityKeypair

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

• Sets the identity keys stored in this object.

  Parameters

  • identitySecret: Ed25519SecretKey
  • OptionalidentityPublic: Ed25519PublicKey

  Returns Promise<DefaultIdentityKeyManager>

setMyIdentityString

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

• Parameters

  • id: string

  Returns Promise<void>