Class MlKem768

Represents the MlKem768 class, which extends the MlKemBase class.

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

Deprecated

Use createMlKem768 instead. This async class-based API will be removed in a future release.

Remarks

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

Example

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

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

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

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

Hierarchy

MlKemBase
- MlKem768

Constructors

constructor

new MlKem768(): MlKem768
Returns MlKem768
Overrides MlKemBase.constructor
- Defined in src/mlKem768.ts:46

Properties

`Protected`_api

_api: Crypto = undefined

`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`_noiseVecs

_noiseVecs: Int16Array<ArrayBufferLike>[]

`Protected`_pkSize

_pkSize: number = 0

`Protected`_skSize

_skSize: number = 0

Methods

`Protected`_compressU

_compressU(r: Uint8Array, u: Int16Array<ArrayBufferLike>[]): Uint8Array
Compresses the given array of coefficients into a Uint8Array.
Parameters
- r: Uint8Array
  The output Uint8Array.
- u: Int16Array<ArrayBufferLike>[]
  The array of coefficients.
Returns Uint8Array
The compressed Uint8Array.
Inherited from MlKemBase._compressU
- Defined in src/mlKemBase.ts:631

`Protected`_compressV

_compressV(r: Uint8Array, v: Int16Array): Uint8Array
Compresses the given array of numbers into a Uint8Array.
Parameters
- r: Uint8Array
  The Uint8Array to store the compressed values.
- v: Int16Array
  The array of numbers to compress.
Returns Uint8Array
The compressed Uint8Array.
Inherited from MlKemBase._compressV
- Defined in src/mlKemBase.ts:664

`Protected`_decapCore

_decapCore(ct: Uint8Array, sk: Uint8Array): Uint8Array
Parameters
- ct: Uint8Array
- sk: Uint8Array
Returns Uint8Array
Inherited from MlKemBase._decapCore
- Defined in src/mlKemBase.ts:298

`Protected`_decompressU

_decompressU(a: Uint8Array): Int16Array<ArrayBufferLike>[]
Decompresses a Uint8Array into a two-dimensional array of numbers.
Parameters
- a: Uint8Array
  The Uint8Array to decompress.
Returns Int16Array<ArrayBufferLike>[]
The decompressed two-dimensional array.
Inherited from MlKemBase._decompressU
- Defined in src/mlKemBase.ts:689

`Protected`_decompressV

_decompressV(a: Uint8Array): Int16Array
Decompresses a Uint8Array into an array of numbers.
Parameters
- a: Uint8Array
  The Uint8Array to decompress.
Returns Int16Array
An array of numbers.
Inherited from MlKemBase._decompressV
- Defined in src/mlKemBase.ts:723

`Protected`_deriveKeyPairCore

_deriveKeyPairCore(
seed: Uint8Array,
): [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]
Parameters
- seed: Uint8Array
Returns [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]
Inherited from MlKemBase._deriveKeyPairCore
- Defined in src/mlKemBase.ts:269

`Protected`_encapCore

_encapCore(
pk: Uint8Array,
seed?: Uint8Array,
): [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]
Parameters
- pk: Uint8Array
- Optionalseed: Uint8Array
Returns [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]
Inherited from MlKemBase._encapCore
- Defined in src/mlKemBase.ts:280

`Protected`_generateKeyPairCore

_generateKeyPairCore(): [
Uint8Array<ArrayBufferLike>,
Uint8Array<ArrayBufferLike>,
]
Returns [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]
Inherited from MlKemBase._generateKeyPairCore
- Defined in src/mlKemBase.ts:259

`Protected`_initPool

_initPool(): void
Returns void
Inherited from MlKemBase._initPool
- Defined in src/mlKemBase.ts:98

`Protected`_prf1

_prf1(sigma: Uint8Array, nonce: number): Uint8Array
Parameters
- sigma: Uint8Array
- nonce: number
Returns Uint8Array
Inherited from MlKemBase._prf1
- Defined in src/mlKemBase.ts:242

`Protected`_sampleNoise1

_sampleNoise1(
    sigma: Uint8Array,
    offset: number,
    size: number,
): Int16Array<ArrayBufferLike>[]
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 Int16Array<ArrayBufferLike>[]
The generated 2D array of noise samples.
Inherited from MlKemBase._sampleNoise1
- Defined in src/mlKemBase.ts:572

`Protected`_sampleNoise2

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

`Protected`_setup

_setup(): Promise<void>
Sets up the MlKemBase instance by loading the necessary crypto library. If the crypto library is already loaded, this method does nothing.

Returns Promise<void>
A promise that resolves when the setup is complete.
Inherited from MlKemBase._setup
- Defined in src/mlKemBase.ts:336

`Protected`_zeroPool

_zeroPool(): void
Returns void
Inherited from MlKemBase._zeroPool
- Defined in src/mlKemBase.ts:141

decap

decap(ct: Uint8Array, sk: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>
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<ArrayBufferLike>>
A shared secret.

Throws
MlKemError
- Defined in src/mlKem768.ts:124

deriveKeyPair

deriveKeyPair(
seed: Uint8Array,
): 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
  A 64-octet seed for the deterministic key generation.
Returns Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>]>
A kaypair [publicKey, privateKey].

Throws
MlKemError
- Defined in src/mlKem768.ts:81

encap

encap(
pk: Uint8Array,
seed?: Uint8Array,
): 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
  A public key.
- Optionalseed: Uint8Array
  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
- Defined in src/mlKem768.ts:102

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
- Defined in src/mlKem768.ts:63

Class MlKem768

Deprecated

Remarks

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MlKem768

Properties

Protected_api

Protected_compressedUSize

Protected_compressedVSize

_du

_dv

_eta1

_eta2

_k

Protected_noiseVecs

Protected_pkSize

Protected_skSize

Methods

Protected_compressU

Parameters

Returns Uint8Array

Protected_compressV

Parameters

Returns Uint8Array

Protected_decapCore

Parameters

Returns Uint8Array

Protected_decompressU

Parameters

Returns Int16Array<ArrayBufferLike>[]

Protected_decompressV

Parameters

Returns Int16Array

Protected_deriveKeyPairCore

Parameters

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

Protected_encapCore

Parameters

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

Protected_generateKeyPairCore

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

Protected_initPool

Returns void

Protected_prf1

Parameters

Returns Uint8Array

Protected_sampleNoise1

Parameters

Returns Int16Array<ArrayBufferLike>[]

Protected_sampleNoise2

Parameters

Returns Int16Array<ArrayBufferLike>[]

Protected_setup

Returns Promise<void>

Protected_zeroPool

Returns void

decap

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

Throws

deriveKeyPair

Parameters

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

Throws

encap

Parameters

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

Throws

generateKeyPair

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

Throws

Settings

On This Page

`Protected`_api

`Protected`_compressedUSize

`Protected`_compressedVSize

`Protected`_noiseVecs

`Protected`_pkSize

`Protected`_skSize

`Protected`_compressU

`Protected`_compressV

`Protected`_decapCore

`Protected`_decompressU

`Protected`_decompressV

`Protected`_deriveKeyPairCore

`Protected`_encapCore

`Protected`_generateKeyPairCore

`Protected`_initPool

`Protected`_prf1

`Protected`_sampleNoise1

`Protected`_sampleNoise2

`Protected`_setup

`Protected`_zeroPool