Class DefaultSessionKeyManager

constructor

• new DefaultSessionKeyManager(sodium?: SodiumPlus): DefaultSessionKeyManager

• Parameters

  • Optionalsodium: SodiumPlus

  Returns DefaultSessionKeyManager

assocData

sessions

Optionalsodium

destroySessionKey

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

• Delete the session.

  Parameters

  • id: string

  Returns Promise<void>

getAssocData

• getAssocData(id: string): Promise<string>

• Parameters

  • id: string

  Returns Promise<string>

getEncryptionKey

• getEncryptionKey(id: string, recipient?: boolean): Promise<CryptographyKey>

• Get the encryption key for a given message.

  !!!! IMPORTANT !!!! This is a very rough proof-of-concept that doesn't support out-of-order messages.

  Instead, it derives a 512-bit hash from the current key, then updates the session key with the leftmost 256 bits of that hash, and returns the rightmost 256 bits as the encryption key.

  You should design your session key management protocol more appropriately for your use case.

  Parameters

  • id: string
  • Optionalrecipient: boolean

  Returns Promise<CryptographyKey>

getSodium

• getSodium(): Promise<SodiumPlus>

• Returns Promise<SodiumPlus>

listSessionIds

• listSessionIds(): Promise<string[]>

• Returns Promise<string[]>

setAssocData

• setAssocData(id: string, assocData: string): Promise<void>

• Parameters

  • id: string
  • assocData: string

  Returns Promise<void>

setSessionKey

• setSessionKey(
      id: string,
      key: CryptographyKey,
      recipient?: boolean,
  ): Promise<void>

• Override the session key for a given participation partner.

  Note that the actual sending/receiving keys will be derived from a BLAKE2b hash with domain separation (sending vs receiving) to ensure that messages sent/received are encrypted under different keys.

  Parameters

  • id: string

    Participant ID.
  • key: CryptographyKey

    Incoming key.
  • Optionalrecipient: boolean

    Are we the recipient? (Default: No.)

  Returns Promise<void>

symmetricRatchet

• symmetricRatchet(inKey: CryptographyKey): Promise<CryptographyKey[]>

• This is a very basic symmetric ratchet based on BLAKE2b-512.

  The first 256 bits of the output are stored as the future ratcheting key.

  The remaining bits are returned as the encryption key.

  Parameters

  • inKey: CryptographyKey

  Returns Promise<CryptographyKey[]>