Class MlKem768

Represents the MlKem768 class, which extends the MlKemBase class.

This class extends the MlKemBase class and provides specific implementation for MlKem768.

Remarks

MlKem768 is a specific implementation of the ML-KEM key encapsulation mechanism.

Example

// Using jsr:
import { MlKem768 } from "@dajiaji/mlkem";
// Using npm:
// import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

const recipient = new MlKem768();
const [pkR, skR] = await recipient.generateKeyPair();

const sender = new MlKem768();
const [ct, ssS] = await sender.encap(pkR);

const ssR = await recipient.decap(ct, skR);
// ssS === ssR

Hierarchy

  • MlKemBase
    • MlKem768

Constructors

constructor

Properties

_compressedUSize _compressedVSize _du _dv _eta1 _eta2 _k _pkSize _skSize

Methods

_compressU _compressV _decompressU _decompressV _sampleNoise1 _sampleNoise2 decap deriveKeyPair encap generateKeyPair

Constructors

constructor

Properties

Protected_compressedUSize

_compressedUSize: number = 0

Protected_compressedVSize

_compressedVSize: number = 0

_du

_du: number = 10

_dv

_dv: number = 4

_eta1

_eta1: number = 2

_eta2

_eta2: number = 2

_k

_k: number = 3

Protected_pkSize

_pkSize: number = 0

Protected_skSize

_skSize: number = 0

Methods

Protected_compressU

  • _compressU(
        r: Uint8Array<ArrayBufferLike>,
        u: number[][],
    ): Uint8Array<ArrayBufferLike>

  • Compresses the given array of coefficients into a Uint8Array.

    Parameters

    • r: Uint8Array<ArrayBufferLike>

      The output Uint8Array.

    • u: number[][]

      The array of coefficients.

    Returns Uint8Array<ArrayBufferLike>

    The compressed Uint8Array.

Protected_compressV

  • _compressV(
        r: Uint8Array<ArrayBufferLike>,
        v: number[],
    ): Uint8Array<ArrayBufferLike>

  • Compresses the given array of numbers into a Uint8Array.

    Parameters

    • r: Uint8Array<ArrayBufferLike>

      The Uint8Array to store the compressed values.

    • v: number[]

      The array of numbers to compress.

    Returns Uint8Array<ArrayBufferLike>

    The compressed Uint8Array.

Protected_decompressU

  • _decompressU(a: Uint8Array<ArrayBufferLike>): number[][]

  • Decompresses a Uint8Array into a two-dimensional array of numbers.

    Parameters

    • a: Uint8Array<ArrayBufferLike>

      The Uint8Array to decompress.

    Returns number[][]

    The decompressed two-dimensional array.

Protected_decompressV

  • _decompressV(a: Uint8Array<ArrayBufferLike>): number[]

  • Decompresses a Uint8Array into an array of numbers.

    Parameters

    • a: Uint8Array<ArrayBufferLike>

      The Uint8Array to decompress.

    Returns number[]

    An array of numbers.

Protected_sampleNoise1

  • _sampleNoise1(
        sigma: Uint8Array<ArrayBufferLike>,
        offset: number,
        size: number,
    ): number[][]

  • Generates a 2D array of noise samples.

    Parameters

    • sigma: Uint8Array<ArrayBufferLike>

      The noise parameter.

    • offset: number

      The offset value.

    • size: number

      The size of the array.

    Returns number[][]

    The generated 2D array of noise samples.

Protected_sampleNoise2

  • _sampleNoise2(
        sigma: Uint8Array<ArrayBufferLike>,
        offset: number,
        size: number,
    ): number[][]

  • Generates a 2-dimensional array of noise samples.

    Parameters

    • sigma: Uint8Array<ArrayBufferLike>

      The noise parameter.

    • offset: number

      The offset value.

    • size: number

      The size of the array.

    Returns number[][]

    The generated 2-dimensional array of noise samples.

decap

  • decap(
        ct: Uint8Array<ArrayBufferLike>,
        sk: Uint8Array<ArrayBufferLike>,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Generates a ciphertext for the public key and a shared secret.

    If an error occurred, throws MlKemError.

    Parameters

    • ct: Uint8Array<ArrayBufferLike>

      A ciphertext generated by encap.

    • sk: Uint8Array<ArrayBufferLike>

      A private key.

    Returns Promise<Uint8Array<ArrayBufferLike>>

    A shared secret.

    Throws

    MlKemError

    Example: The {@link MlKem768} decapsulation.

    // Using jsr:
    import { MlKem768 } from "@dajiaji/mlkem";
    // Using npm:
    // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

    const kyber = new MlKem768();
    const [pk, sk] = await kyber.generateKeyPair();
    const [ct, ssS] = await kyber.encap(pk);
    const ssR = await kyber.decap(ct, sk);
    // ssS === ssR

deriveKeyPair

  • deriveKeyPair(
        seed: Uint8Array<ArrayBufferLike>,
    ): Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]>

  • Derives a keypair [publicKey, privateKey] deterministically from a 64-octet seed.

    If an error occurred, throws MlKemError.

    Parameters

    • seed: Uint8Array<ArrayBufferLike>

      A 64-octet seed for the deterministic key generation.

    Returns Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]>

    A kaypair [publicKey, privateKey].

    Throws

    MlKemError

    Example: Derives a {@link MlKem768} keypair deterministically.

    // Using jsr:
    import { MlKem768 } from "@dajiaji/mlkem";
    // Using npm:
    // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

    const kyber = new MlKem768();
    const seed = new Uint8Array(64);
    globalThis.crypto.getRandomValues(seed);
    const [pk, sk] = await kyber.deriveKeyPair(seed);

encap

  • encap(
        pk: Uint8Array<ArrayBufferLike>,
        seed?: Uint8Array<ArrayBufferLike>,
    ): Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]>

  • Generates a shared secret from the encapsulated ciphertext and the private key.

    If an error occurred, throws MlKemError.

    Parameters

    • pk: Uint8Array<ArrayBufferLike>

      A public key.

    • Optionalseed: Uint8Array<ArrayBufferLike>

      An optional 32-octet seed for the deterministic shared secret generation.

    Returns Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]>

    A ciphertext (encapsulated public key) and a shared secret.

    Throws

    MlKemError

    Example: The {@link MlKem768} encapsulation.

    // Using jsr:
    import { MlKem768 } from "@dajiaji/mlkem";
    // Using npm:
    // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

    const kyber = new MlKem768();
    const [pk, sk] = await kyber.generateKeyPair();
    const [ct, ss] = await kyber.encap(pk);

generateKeyPair

  • generateKeyPair(): Promise<
        [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>],
    >

  • Generates a keypair [publicKey, privateKey].

    If an error occurred, throws MlKemError.

    Returns Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]>

    A kaypair [publicKey, privateKey].

    Throws

    MlKemError

    Example: Generates a {@link MlKem768} keypair.

    // Using jsr:
    import { MlKem768 } from "@dajiaji/mlkem";
    // Using npm:
    // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

    const kyber = new MlKem768();
    const [pk, sk] = await kyber.generateKeyPair();

Settings

Member Visibility

On This Page

Constructors
Properties
Methods