This package provides Node.js bindings for the reference implementation that is part of the NIST submission by Bernstein et al.

This version is based on the round-4 submission mceliece-20221023. See deps/mceliece.

Installation should work as usual:

npm i mceliece-nist

const { McEliece } = require('mceliece-nist');

const kem = new McEliece('mceliece8192128');
const { publicKey, privateKey } = kem.keypair();

const { key, encryptedKey } = kem.generateKey(publicKey);
console.log(`Bob is using the key ${key.toString('hex')}`);

const receivedKey = kem.decryptKey(privateKey, encryptedKey);
console.log(`Alice is using the key ${receivedKey.toString('hex')}`);

The package exports a single class, McEliece.

Creates a new instance using the specified algorithm. algorithm must be one of the values contained in McEliece.supportedAlgorithms.

This static field is an array of all supported algorithms.

The (maximum) key size in bytes that this instance can encapsulate.

The size of the encapsulated key in bytes.

The size of the public key in bytes.

The size of the private key in bytes.

Creates and returns a new key pair { publicKey, privateKey }. Both keys will be returned as Buffers.

If callback is a function, keypair immediately returns undefined and calls callback(err, { publicKey, privateKey }) as soon as a new keypair has been generated.

Generates a new symmetric key and encrypts it using the given publicKey. Returns { key, encryptedKey }, both objects will be Buffers.

Decrypts the encryptedKey that was returned by instance.generateKey(publicKey) and returns the decrypted key as a Buffer.

If callback is a function, decryptKey immediately returns undefined and calls callback(err, key) as soon as the key has been decrypted.

This project is distributed under the ISC license.