Class MlKem1024

The ML-KEM-1024 for HPKE KEM implementing KemInterface.

The instance of this class can be specified to the CipherSuiteParams as follows:

Example

import { Aes256Gcm, CipherSuite, HkdfSha512 } from "@hpke/core";
import { MlKem1024 } from "@hpke/ml-kem";
const suite = new CipherSuite({
  kem: new MlKem1024(),
  kdf: new HkdfSha512(),
  aead: new Aes256Gcm(),
});

Hierarchy

  • MlKemBase
    • MlKem1024

Constructors

constructor

Properties

_prim auth encSize id name privateKeySize publicKeySize secretSize

Methods

decap deriveKeyPair deserializePrivateKey deserializePublicKey encap generateKeyPair importKey serializePrivateKey serializePublicKey

Constructors

constructor

Properties

_prim

_prim: MlKemInterface = undefined

auth

auth: boolean = false

encSize

encSize: number = 1568

id

id: KemId = KemId.MlKem1024

name

name: string = "ML-KEM-1024"

privateKeySize

privateKeySize: number = 64

publicKeySize

publicKeySize: number = 1568

secretSize

secretSize: number = 32

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    • params: RecipientContextParams

      A set of parameters for the recipient context.

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      An input keying material.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Throws

    DeriveKeyPairError

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

    If the error occurred, throws EncapError.

    Parameters

    • params: SenderContextParams

      A set of parameters for the sender context.

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A shared secret and an encapsulated key as the output of the encapsulation step.

    Throws

    EncapError

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a key pair.

    If the error occurred, throws NotSupportedError.

    Returns Promise<CryptoKeyPair>

    A key pair generated.

    Throws

    NotSupportedError

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    Basically, this is a thin wrapper function of SubtleCrypto.importKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • format: "raw" | "jwk"

      For now, 'raw' and 'jwk' are supported.

    • key: ArrayBuffer | JsonWebKeyExtended

      A byte string of a raw key or A JsonWebKey object.

    • isPublic: boolean = true

      The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

    Returns Promise<CryptoKey>

    A public or private CryptoKey.

    Throws

    DeserializeError

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

Settings

Member Visibility

On This Page

Constructors
Properties
Methods