Class MlKem1024

Represents the MlKem1024 class, which extends the MlKemBase class.

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

Remarks

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

Example

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

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

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

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

Hierarchy

MlKemBase
- MlKem1024

Index

Constructors

constructor

new MlKem1024(): MlKem1024
Constructs a new instance of the MlKem1024 class.

Returns MlKem1024
Overrides MlKemBase.constructor
- Defined in src/mlKem1024.ts:47

Properties

`Protected`_compressedUSize

_compressedUSize: number = 0

`Protected`_compressedVSize

_compressedVSize: number = 0

_du

_du: number = 11

_dv

_dv: number = 5

_eta1

_eta1: number = 2

_eta2

_eta2: number = 2

_k

_k: number = 4

`Protected`_pkSize

_pkSize: number = 0

`Protected`_skSize

_skSize: number = 0

Methods

`Protected`_compressU

_compressU(r: Uint8Array, u: number[][]): Uint8Array
Lossily compresses and serializes a vector of polynomials.
Parameters
- r: Uint8Array
- u: number[][]
  The vector of polynomials to compress.
Returns Uint8Array
The compressed and serialized data as a Uint8Array.
Overrides MlKemBase._compressU
- Defined in src/mlKem1024.ts:63

`Protected`_compressV

_compressV(r: Uint8Array, v: number[]): Uint8Array
Lossily compresses and serializes a polynomial.
Parameters
- r: Uint8Array
  The output buffer to store the compressed data.
- v: number[]
  The polynomial to compress.
Returns Uint8Array
The compressed and serialized data as a Uint8Array.
Overrides MlKemBase._compressV
- Defined in src/mlKem1024.ts:101

`Protected`_decompressU

_decompressU(a: Uint8Array): number[][]
Deserializes and decompresses a vector of polynomials. This is the approximate inverse of the _compressU method. Since compression is lossy, the decompressed data may not match the original vector of polynomials.
Parameters
- a: Uint8Array
  The compressed and serialized data as a Uint8Array.
Returns number[][]
The decompressed vector of polynomials.
Overrides MlKemBase._decompressU
- Defined in src/mlKem1024.ts:130

`Protected`_decompressV

_decompressV(a: Uint8Array): number[]
Decompresses a given polynomial, representing the approximate inverse of compress2, in Uint8Array into an array of numbers.

Note that compression is lossy, and thus decompression will not match the original input.
Parameters
- a: Uint8Array
  The Uint8Array to decompress.
Returns number[]
An array of numbers obtained from the decompression process.
Overrides MlKemBase._decompressV
- Defined in src/mlKem1024.ts:172

`Protected`_sampleNoise1

_sampleNoise1(sigma: Uint8Array, offset: number, size: number): number[][]
Generates a 2D array of noise samples.
Parameters
- sigma: Uint8Array
  The noise parameter.
- offset: number
  The offset value.
- size: number
  The size of the array.
Returns number[][]
The generated 2D array of noise samples.
Inherited from MlKemBase._sampleNoise1
- Defined in src/mlKemBase.ts:500

`Protected`_sampleNoise2

_sampleNoise2(sigma: Uint8Array, offset: number, size: number): number[][]
Generates a 2-dimensional array of noise samples.
Parameters
- sigma: Uint8Array
  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.
Inherited from MlKemBase._sampleNoise2
- Defined in src/mlKemBase.ts:521

decap

decap(ct: Uint8Array, sk: Uint8Array): Promise<Uint8Array>
Generates a ciphertext for the public key and a shared secret.

If an error occurred, throws MlKemError.
Parameters
- ct: Uint8Array
  A ciphertext generated by encap.
- sk: Uint8Array
  A private key.
Returns Promise<Uint8Array>
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
```
Inherited from MlKemBase.decap
- Defined in src/mlKemBase.ts:214

deriveKeyPair

deriveKeyPair(seed: Uint8Array): Promise<[Uint8Array, Uint8Array]>
Derives a keypair [publicKey, privateKey] deterministically from a 64-octet seed.

If an error occurred, throws MlKemError.
Parameters
- seed: Uint8Array
  A 64-octet seed for the deterministic key generation.
Returns Promise<[Uint8Array, Uint8Array]>
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);
```
Inherited from MlKemBase.deriveKeyPair
- Defined in src/mlKemBase.ts:131

encap

encap(pk: Uint8Array, seed?: Uint8Array): Promise<[Uint8Array, Uint8Array]>
Generates a shared secret from the encapsulated ciphertext and the private key.

If an error occurred, throws MlKemError.
Parameters
- pk: Uint8Array
  A public key.
- Optionalseed: Uint8Array
  An optional 32-octet seed for the deterministic shared secret generation.
Returns Promise<[Uint8Array, Uint8Array]>
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);
```
Inherited from MlKemBase.encap
- Defined in src/mlKemBase.ts:169

generateKeyPair

generateKeyPair(): Promise<[Uint8Array, Uint8Array]>
Generates a keypair [publicKey, privateKey].

If an error occurred, throws MlKemError.

Returns Promise<[Uint8Array, Uint8Array]>
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();
```
Inherited from MlKemBase.generateKeyPair
- Defined in src/mlKemBase.ts:96

Class MlKem1024

Remarks

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MlKem1024

Properties

Protected_compressedUSize

Protected_compressedVSize

_du

_dv

_eta1

_eta2

_k

Protected_pkSize

Protected_skSize

Methods

Protected_compressU

Parameters

Returns Uint8Array

Protected_compressV

Parameters

Returns Uint8Array

Protected_decompressU

Parameters

Returns number[][]

Protected_decompressV

Parameters

Returns number[]

Protected_sampleNoise1

Parameters

Returns number[][]

Protected_sampleNoise2

Parameters

Returns number[][]

decap

Parameters

Returns Promise<Uint8Array>

Throws

Example: The {@link MlKem768} decapsulation.

deriveKeyPair

Parameters

Returns Promise<[Uint8Array, Uint8Array]>

Throws

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

encap

Parameters

Returns Promise<[Uint8Array, Uint8Array]>

Throws

Example: The {@link MlKem768} encapsulation.

generateKeyPair

Returns Promise<[Uint8Array, Uint8Array]>

Throws

Example: Generates a {@link MlKem768} keypair.

Settings

On This Page

`Protected`_compressedUSize

`Protected`_compressedVSize

`Protected`_pkSize

`Protected`_skSize

`Protected`_compressU

`Protected`_compressV

`Protected`_decompressU

`Protected`_decompressV

`Protected`_sampleNoise1

`Protected`_sampleNoise2