Mceliece-nist NPM

mceliece-nist

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

Installation should work as usual:

npm i mceliece-nist

Example

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')}`);

API

The package exports a single class, McEliece.

Class `McEliece`

`new McEliece(algorithm)`

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

`McEliece.supportedAlgorithms`

This static field is an array of all supported algorithms.

`instance.keySize`

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

`instance.encryptedKeySize`

The size of the encapsulated key in bytes.

`instance.publicKeySize`

The size of the public key in bytes.

`instance.privateKeySize`

The size of the private key in bytes.

`instance.keypair([callback])`

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.