mlkem / crystals-kyber-js

This module is based on
ntontutoveanu/crystals-kyber-javascript,
but includes the following improvements:

- ✅ Written in TypeScript.
- ✅ Available on various JavaScript runtimes: Browsers, Node.js, Deno,
Cloudflare Workers, etc.
- ✅ Deterministic key generation support.
- ✅ Constant-time validation for ciphertext.
- ✅ Better performance: 1.4 to 1.8 times faster than the original
implementation.
- ✅ No dependencies on other libraries.
- ✅ Tree-shaking friendly.
- ✅ Fix KyberSlash vulnerability.
- ✅ ML-KEM (NIST FIPS 203)
support.
- ✅ Passed all the tests published by:
- post-quantum-cryptography/KAT/MLKEM
- C2SP/CCTV/ML-KEM
- pq-crystals/kyber (10000
consecutive tests)

This repository has the following packages:

| package | registry | description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| crystals-kyber-js |  | v1.x implements CRYSTALS-KYBER, and v2.x- implements ML-KEM (NIST FIPS 203). crystals-kyber-js may become deprecated in the near future. Instead, we recommend switching to the following mlkem or @dajiaji/mlkem. |
| mlkem |  | Implements only ML-KEM (NIST FIPS 203). It is an alias for the above crystals-kyber-js starting from v2 onwards. We recommend using this package going forward. |
| @dajiaji/mlkem |  | Implements only ML-KEM (NIST FIPS 203). It is an ML-KEM package for jsr.io. The above mlkem is an npm package of @dajiaji/mlkem, which has been converted using @deno/dnt. |

For Node.js, you can install mlkem or crystals-kyber-js via npm, yarn or
pnpm:

``sh


RECOMMENTED using mlkem

crystals-kyber-js is still available for use, but it may become deprecated in the near future.

`ts
import { MlKem768 } from "mlkem"; // or from "crystals-kyber-js"

async function doMlKem() {
// A recipient generates a key pair.
const recipient = new MlKem768(); // MlKem512 and MlKem1024 are also available.
const [pkR, skR] = await recipient.generateKeyPair();
//// Deterministic key generation is also supported
// const seed = new Uint8Array(64);
// globalThis.crypto.getRandomValues(seed); // node >= 19
// const [pkR, skR] = await recipient.deriveKeyPair(seed);

// A sender generates a ciphertext and a shared secret with pkR.
const sender = new MlKem768();
const [ct, ssS] = await sender.encap(pkR);

// The recipient decapsulates the ciphertext and generates the same shared secret with skR.
const ssR = await recipient.decap(ct, skR);

// ssS === ssR
return;
}

try {
doMlKem();
} catch (err: unknown) {
console.log("failed:", (err as Error).message);
}
`

Index

- Installation
- Node.js
- Deno
- Cloudflare Workers
- Bun
- Web Browsers
- Usage
- Contributing

Installation

$3

`sh


Using npm:

Starting from version 2.0.0, @dajiaji/mlkem is available from the
jsr.io. From this version onwards, please use JSR import
instead of HTTPS import in Deno.

JSR import (>=2.0.0):

Add @dajiaji/mlkem package using the commands below:

`sh
deno add @dajiaji/mlkem
`

Then, you can use the module from code like this:

`ts
import { MlKem1024, MlKem512, MlKem768 } from "@dajiaji/mlkem";
`

HTTPS import (deprecated):

`ts
import {
Kyber1024,
Kyber512,
Kyber768,
} from "https://deno.land/x/crystals_kyber@/mod.ts";
`

$3

`sh


Using npm:

`ts
import { MlKem1024, MlKem512, MlKem768 } from "@dajiaji/mlkem";
`

$3

`sh


Using npm:

`ts
import { MlKem1024, MlKem512, MlKem768 } from "@dajiaji/mlkem";
`

$3

Followings are how to use this module with typical CDNs. Other CDNs can be used
as well.

`html


`

Usage

This section shows some typical usage examples.

$3

`js
import { MlKem768 } from "mlkem";
// const { MlKem768 } = require("mlkem");

async function doMlKem() {
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
return;
}

try {
doMlKem();
} catch (err) {
console.log("failed: ", err.message);
}
`

$3

`ts
import { MlKem512 } from "@dajiaji/mlkem";

async function doMlKem() {
const recipient = new MlKem512();
const [pkR, skR] = await recipient.generateKeyPair();

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

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

// ssS === ssR
return;
}

try {
doMlKem();
} catch (err: unknown) {
console.log("failed:", (err as Error).message);
}
`

$3

`html




do CRYSTALS-KYBER


``

Contributing

We welcome all kind of contributions, filing issues, suggesting new features or
sending PRs.