Interface AEAD

AEAD is a common interface for authenticated encryption with associated Data.

interface AEAD {
    nonceLength: number;
    tagLength: number;
    clean(): this;
    open(nonce: Uint8Array, ciphertext: Uint8Array, associatedData?: Uint8Array, dst?: Uint8Array): null | Uint8Array;
    seal(nonce: Uint8Array, plaintext: Uint8Array, associatedData?: Uint8Array, dst?: Uint8Array): Uint8Array;
}

Implemented by

    Properties

    nonceLength tagLength

    Methods

    clean open seal

    Properties

    nonceLength

    nonceLength: number

    Byte length of nonce that is used with this AEAD.

    tagLength

    tagLength: number

    Byte length of authentication tag included in the sealed ciphertext. Result of seal() will be longer than plaintext for this number of bytes.

    Methods

    clean

    • clean(): this

    • Wipes state from memory. Doesn't wipe the underlying block cipher state.

      Returns this

    open

    • open(nonce, ciphertext, associatedData?, dst?): null | Uint8Array

    • Authenticates ciphertext (which includes authentication tag) and associated data, decrypts ciphertext, and returns decrypted plaintext.

      If authentication fails, it returns null.

      If dst is given (it must be of ciphertext length minus tag length), the result will be put into it. Dst and plaintext must not overlap.

      Parameters

      • nonce: Uint8Array
      • ciphertext: Uint8Array
      • OptionalassociatedData: Uint8Array
      • Optionaldst: Uint8Array

      Returns null | Uint8Array

    seal

    • seal(nonce, plaintext, associatedData?, dst?): Uint8Array

    • Encrypts and authenticates plaintext, authenticates associated data, and returns ciphertext, which includes authentication tag.

      If dst is given (it must be the size of plaintext + the size of tag length) the result will be put into it. Dst and plaintext must not overlap.

      Parameters

      • nonce: Uint8Array
      • plaintext: Uint8Array
      • OptionalassociatedData: Uint8Array
      • Optionaldst: Uint8Array

      Returns Uint8Array

    Settings

    Member Visibility

    On This Page

    Properties
    Methods