dchest/mldsa-wasm
ML-DSA-65 postquantum signatures in WebAssembly
mldsa-wasm
ML-DSA-65, a post-quantum digital signature algorithm in WebAssembly.
This package provides a WebAssembly-based implementation of ML-DSA-65, based on PQClean. It exposes a modern, WebCrypto-compatible API for key generation, signing, and verification, all bundled in a single JavaScript file with the WASM module inlined.
Features
- API compatible with the WebCrypto API draft for modern algorithms (when it ships, replace
mldsawithcrypto.subtleand burn this package). - All code and WASM are bundled into a single
dist/mldsa.jsES module (no external.wasmfiles needed). - Works in browsers and Node.js, and should work everywhere WebAssembly is supported.
- Smallish: 63 KB unminified .js (21 KB gzipped / 17 KB brotlied).
- Fast: signing at 2800 ops/sec, verifying at 10500 ops/sec on MacBook Air M1.
- A single, most common ML-DSA-65 algorithm, so there's no need to choose between 44, 65, and 87!
Use it as a stopgap solution until the WebCrypto API supports ML-DSA natively.
Demo: https://dchest.github.io/mldsa-wasm/
Caution
Beta version. CONTAINS CRYPTOGRAPHY! Use at your own risk.
Limitations
- The
CryptoKeyreturned by this module'sgenerateKeyandimportKeyhas the same prototype as WebCrypto'sCryptoKey, but cannot be cloned withstructuredClone, so you cannot, for example, save them to IndexedDB, pass them to a worker, or usewrapKeyon them, without exporting. You can only use them with this library's methods. Cloning is deliberately disabled to prevent compatibility issues with the future WebCrypto API (e.g., you saved anmldsa-wasmkey to IndexedDB, and then switched to the native WebCrypto API, which has its own internal key format and cannot deserialize it). - Key material is not accessible from outside of the module (that is, you should not be able to get raw key data without exporting), but is somewhere in JavaScript memory until garbage collected. The module takes care to wipe key data from memory during garbage collection, but JavaScript runtimes may optimize this cleanup away.
- Operations, while asynchronous on the surface (all functions are
asyncto be compatible and to be able to load the WASM module without a separate initialization call), are done synchronously, instead of being fully asynchronous like in the WebCrypto API. You may consider it an improvement. - Base64 encoding and decoding for JWK is not constant-time (not sure if it is in other implementations except BoringSSL, though).
pkcs8import only supports the seed format of private keys (as nature intended).
Installation
npm install mldsa-wasmUsage Example
Signing and verifying
import mldsa from "mldsa-wasm";
// Generate key pair
const keyPair = await mldsa.generateKey({ name: "ML-DSA-65" }, true, [
"sign",
"verify",
]);
const { publicKey, privateKey } = keyPair;
// Sign a message
const message = new TextEncoder().encode("Hello, world!");
const signature = await mldsa.sign({ name: "ML-DSA-65" }, privateKey, message);
// Verify a signature
const isValid = await mldsa.verify(
{ name: "ML-DSA-65" },
publicKey,
signature,
message
);
console.log("Signature is valid:", isValid); // true
// Sign a message with context (maximum 255 bytes)
const context = new TextEncoder().encode("MyApp v1.0");
const signatureWithContext = await mldsa.sign(
{ name: "ML-DSA-65", context },
privateKey,
message
);
// Verify a signature with context
const isValidWithContext = await mldsa.verify(
{ name: "ML-DSA-65", context },
publicKey,
signatureWithContext,
message
);Exporting and importing keys
You can export and import ML-DSA keys in several formats. Here are some examples:
Exporting a public key (raw format)
// Export public key as raw bytes
const rawPublicKey = await mldsa.exportKey("raw-public", publicKey);
// rawPublicKey is an ArrayBufferExporting a private key (seed format)
// Export private key as a seed
const rawSeed = await mldsa.exportKey("raw-seed", privateKey);
// rawSeed is an ArrayBufferExporting a key as JWK
// Export public key as JWK
const jwkPublic = await mldsa.exportKey("jwk", publicKey);
// jwkPublic is a JsonWebKey objectImporting a public key (raw format)
// Import a public key from raw bytes
const importedPublicKey = await mldsa.importKey(
"raw-public",
rawPublicKey,
{ name: "ML-DSA-65" },
true, // extractable
["verify"]
);Importing a private key (seed format)
// Import a private key from seed
const importedPrivateKey = await mldsa.importKey(
"raw-seed",
rawSeed,
{ name: "ML-DSA-65" },
false, // not extractable
["sign"]
);Importing a key from JWK
// Import a public key from JWK
const importedJwkPublicKey = await mldsa.importKey(
"jwk",
jwkPublic,
{ name: "ML-DSA-65" },
false,
["verify"]
);SPKI and PKCS8 formats are also supported.
API Reference
All API methods are asynchronous and return Promises. See Modern Algorithms in the Web Cryptography API for details.
mldsa.generateKey(algorithm, extractable, usages)
- algorithm:
{ name: "ML-DSA-65" }or"ML-DSA-65" - extractable:
boolean(for private key) - usages: array of usages:
"sign","verify" - Returns:
{ publicKey, privateKey }(both areCryptoKey)
mldsa.exportKey(format, key)
- format:
"raw-public","raw-seed","jwk","pkcs8"or"spki" - key:
CryptoKey - Returns:
ArrayBufferorJsonWebKey
mldsa.importKey(format, keyData, algorithm, extractable, usages)
- format:
"raw-public","raw-seed","jwk","pkcs8"or"spki" - keyData:
ArrayBuffer, typed array, orJsonWebKey - algorithm:
{ name: "ML-DSA-65" }or"ML-DSA-65" - extractable:
boolean - usages: array of usages
- Returns:
CryptoKey
mldsa.sign(algorithm, key, data)
- algorithm:
{ name: "ML-DSA-65", context? }or"ML-DSA-65" - key: private
CryptoKey - data:
ArrayBufferor typed array (data to sign) - Returns:
ArrayBuffer(signature)
mldsa.verify(algorithm, key, signature, data)
- algorithm:
{ name: "ML-DSA-65", context? }or"ML-DSA-65" - key: public
CryptoKey - signature:
ArrayBufferor typed array - data:
ArrayBufferor typed array (original data) - Returns:
boolean(true if signature is valid)
mldsa.getPublicKey(key, usages)
- key: private
CryptoKey - usages: array of usages for the returned public key (
"verify") - Returns: public
CryptoKey
mldsa._isSupportedCryptoKey(key)
Non-spec method to check if a CryptoKey was created by this library.
You can use it to distinguish WebCrypto's native keys from mldsa-wasm keys.
- key:
CryptoKey - Returns:
boolean
Types
CryptoKey: Internal key object, not compatible with WebCrypto'sCryptoKey.- Usages:
"sign","verify" - Formats:
"raw-public","raw-seed","jwk","pkcs8","spki"
When WebCrypto API ships
Once the WebCrypto API supports ML-DSA natively (assuming the draft ships as-is), just switch mldsa to crypto.subtle and use the native API directly.
Spec changes
Since the WebCrypto API draft is still evolving, this library may need updates to keep up with changes in the spec. The updates are not guaranteed (but I will try to keep up), and they may break compatibility with previous versions.
Build Instructions
Prerequisites
- Emscripten (for building WASM)
npm installto install dev dependencies (esbuild,typescript, andvitest).
Build
- Run:
npm run build
- This uses Emscripten to compile C sources, which puts the result into
src/build/wasm-module.js(WASM inlined as base64). - Creates a single distributable file by combining
src/build/wasm-module.jsandsrc/mldsa.tsusingesbuild, resulting indist/mldsa.js. - Creates TypeScript types in
types/mldsa.d.tsby runningtsc.
Note: we have an internal copy of PQClean's ml-dsa-65 implementation, modified to accept
seeds instead of calling randombytes(). We generate seeds using crypto.getRandomValues()
and pass them to WebAssembly for key generation and signing.
Distribution
- The entire library is distributed as a single-file ES module:
dist/mldsa.js. - The WASM module is inlined as base64, so no external files are needed.
- TypeScript types are in
types/mldsa.d.ts.
License
- WASM wrapper: MIT License
- PQClean: See pqclean/LICENSE (Public Domain)