@hpke/core
    Preparing search index...

    Interface EncryptionContext

    The encryption context interface for a recipient and a sender.

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

    Hierarchy (View Summary)

    Index

    Methods

    export open seal

    Methods

    • Exports a secret using a variable-length pseudorandom function.

      If the error occurred, throws ExportError.

      Parameters

      • exporterContext: ArrayBuffer

        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.

      ExportError

    • Decrypts data.

      If the error occurred, throws OpenError.

      Parameters

      • data: ArrayBuffer

        An encrypted text as bytes to be decrypted.

      • Optionalaad: ArrayBuffer

        Additional authenticated data as bytes fed by an application.

      Returns Promise<ArrayBuffer>

      A decrypted plain text as bytes.

      OpenError

    • Encrypts data.

      If the error occurred, throws SealError | MessageLimitReachedError.

      Parameters

      • data: ArrayBuffer

        A plain text as bytes to be encrypted.

      • Optionalaad: ArrayBuffer

        Additional authenticated data as bytes fed by an application.

      Returns Promise<ArrayBuffer>

      A cipher text as bytes.

      MessageLimitReachedError, SealError

    Settings

    Member Visibility

    On This Page

    Methods