Class X25519Session

constructor

• new X25519Session(secretSeed?, prng?): X25519Session

• Parameters

  • OptionalsecretSeed: Uint8Array
  • Optionalprng: RandomSource

  Returns X25519Session

ReadonlyacceptMessageLength

ReadonlyofferMessageLength

ReadonlysavedStateLength

ReadonlysharedKeyLength

accept

• accept(offerMsg): Uint8Array

• Accept offer message and return new accept message, which should be sent back to the offering party.

  Also derives shared key, so the accepting party can call getSharedKey() right after calling accept.

  Parameters

  • offerMsg: Uint8Array

  Returns Uint8Array

clean

• clean(): void

• Cleans the temporary instance data.

  Returns void

finish

• finish(acceptMsg): this

• Offering party finishes key agreement by receiving accept message and passing it to finish(). After calling finish(), offering party can call sharedKey() to get shared key.

  Parameters

  • acceptMsg: Uint8Array

  Returns this

getSessionKeys

• getSessionKeys(): SessionKeys

• Returns SessionKeys

getSharedKey

• getSharedKey(): Uint8Array

• Returns the agreed shared key.

  • Offering party should call this after finish().
  • Accepting party should call this after accept().

  Returns Uint8Array

offer

• offer(): Uint8Array

• Offer returns a new offer message, which should be send to the accepting party.

  Returns Uint8Array

restoreState

• restoreState(savedState): this

• Restores offering party's state.

  Parameters

  • savedState: Uint8Array

  Returns this

saveState

• saveState(): Uint8Array

• Serializes secret offering party state into byte array.

  This function should be called after offer() if the offering party cannot keep KeyAgreement instance in memory. When it receives accept message, it can create a new instance and call restoreState() on it with the serialized state to recover to continue the agreement.

  Returns Uint8Array