Interface AeadInterface

The AEAD interface.

interface AeadInterface {
    id: AeadId;
    keySize: number;
    nonceSize: number;
    tagSize: number;
    createEncryptionContext(key: ArrayBuffer): AeadEncryptionContext;
}

Index

Properties

id keySize nonceSize tagSize

Methods

createEncryptionContext

Properties

`Readonly`id

The KDF identifier.

`Readonly`keySize

keySize: number

The length in bytes of an AEAD key (Nk).

`Readonly`nonceSize

nonceSize: number

The length in bytes of an AEAD nonce (Nn).

`Readonly`tagSize

tagSize: number

The length in bytes of an AEAD authentication tag (Nt).

Methods

createEncryptionContext

createEncryptionContext(key: ArrayBuffer): AeadEncryptionContext
Creates an AEAD encryption context which has seal/open operation.
Parameters
- key: ArrayBuffer
  A byte string of the raw key.
Returns AeadEncryptionContext
An AEAD encryption context.
- Defined in node_modules/@hpke/common/esm/src/interfaces/aeadInterface.d.ts:21