Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • KeyAgreement

Implemented by

Index

Properties

acceptMessageLength

acceptMessageLength: number

Accept message length in bytes

offerMessageLength

offerMessageLength: number

Offer message length in bytes

savedStateLength

savedStateLength: number

Saved state length in bytes

sharedKeyLength

sharedKeyLength: number

Shared key length in bytes

Methods

accept

  • accept(offerMsg: Uint8Array): 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

finish

  • finish(acceptMsg: Uint8Array): 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

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

restoreState

  • restoreState(serializedState: Uint8Array): 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

Generated using TypeDoc