Class X3DH

constructor

• new X3DH(
      keys: X3DHKeys,
      identityString: string,
      kdf?: KeyDerivationFunction,
  ): X3DH

  Parameters

  • keys: X3DHKeys
  • identityString: string
  • Optionalkdf: KeyDerivationFunction

  Returns X3DH

identityString

kdf

keys

oneTimeKeys

generateOneTimeKeys

• generateOneTimeKeys(numKeys?: number): Promise<SignedBundle>

  Generates and signs a bundle of one-time keys. Stores them locally for later use.

  Parameters

  • OptionalnumKeys: number = 100

  Returns Promise<SignedBundle>

initReceive

• initReceive(req: InitSenderInfo): Promise<InitReceiveResult>

  Receive and process an initial X3DH handshake message. Returns the shared secret and sender's identity.

  Parameters

  • req: InitSenderInfo

  Returns Promise<InitReceiveResult>

initSend

• initSend(
      recipientIdentity: string,
      recipientKeys: InitServerInfo,
  ): Promise<InitSendResult>

  Initiate X3DH key exchange as the sender. Returns the shared secret and handshake data to send to recipient.

  Parameters

  • recipientIdentity: string
  • recipientKeys: InitServerInfo

  Returns Promise<InitSendResult>

setIdentityString

• setIdentityString(id: string): void

  Sets the identity string for the current user.

  Parameters

  • id: string

  Returns void

signPreKey

• signPreKey(signingKey: CryptoKey, preKey: CryptoKey): Promise<string>

  Sign a pre-key with the identity key. This is what should be used for signed pre-keys in X3DH.

  Parameters

  • signingKey: CryptoKey
  • preKey: CryptoKey

  Returns Promise<string>

Staticprekeys

• prekeys(): Promise<CryptoKeyPair>

  Returns Promise<CryptoKeyPair>

StaticX3DHKeys

• X3DHKeys(
      idKeys: { privateWriteKey: CryptoKey; publicWriteKey: CryptoKey },
      preKeypair: { privateKey: CryptoKey; publicKey: CryptoKey },
  ): X3DHKeys

  Parameters

  • idKeys: { privateWriteKey: CryptoKey; publicWriteKey: CryptoKey }
  • preKeypair: { privateKey: CryptoKey; publicKey: CryptoKey }

  Returns X3DHKeys