Interface EncryptionContext

The encryption context interface for a recipient and a sender.

interface EncryptionContext {
    export(
        exporterContext: ArrayBufferLike | ArrayBufferView,
        len: number,
    ): Promise<ArrayBuffer>;
    open(
        data: ArrayBufferLike | ArrayBufferView,
        aad?: ArrayBufferLike | ArrayBufferView,
    ): Promise<ArrayBuffer>;
    seal(
        data: ArrayBufferLike | ArrayBufferView,
        aad?: ArrayBufferLike | ArrayBufferView,
    ): Promise<ArrayBuffer>;
}

Hierarchy (View Summary)

Exporter
- EncryptionContext
  - SenderContext

Index

Methods

export open seal

Methods

export

export(
exporterContext: ArrayBufferLike | ArrayBufferView,
len: number,
): Promise<ArrayBuffer>
Exports a secret using a variable-length pseudorandom function.

If the error occurred, throws ExportError.
Parameters
- exporterContext: ArrayBufferLike | ArrayBufferView
  An exporter context string as bytes. The maximum length is 128 bytes.
- len: number
  A desired length in bytes of the output secret.
Returns Promise<ArrayBuffer>
A secret string as bytes.

Throws
ExportError
Inherited from Exporter.export
- Defined in node_modules/@hpke/core/esm/src/interfaces/exporter.d.ts:15

open

open(
data: ArrayBufferLike | ArrayBufferView,
aad?: ArrayBufferLike | ArrayBufferView,
): Promise<ArrayBuffer>
Decrypts data.

If the error occurred, throws OpenError.
Parameters
- data: ArrayBufferLike | ArrayBufferView
  An encrypted text as bytes to be decrypted.
- Optionalaad: ArrayBufferLike | ArrayBufferView
  Additional authenticated data as bytes fed by an application.
Returns Promise<ArrayBuffer>
A decrypted plain text as bytes.

Throws
OpenError
- Defined in node_modules/@hpke/core/esm/src/interfaces/encryptionContext.d.ts:27

seal

seal(
data: ArrayBufferLike | ArrayBufferView,
aad?: ArrayBufferLike | ArrayBufferView,
): Promise<ArrayBuffer>
Encrypts data.

If the error occurred, throws SealError | MessageLimitReachedError.
Parameters
- data: ArrayBufferLike | ArrayBufferView
  A plain text as bytes to be encrypted.
- Optionalaad: ArrayBufferLike | ArrayBufferView
  Additional authenticated data as bytes fed by an application.
Returns Promise<ArrayBuffer>
A cipher text as bytes.

Throws
MessageLimitReachedError, SealError
- Defined in node_modules/@hpke/core/esm/src/interfaces/encryptionContext.d.ts:16