bigint-secrets
IMPORTANT! This package has been superseded by bigint-crypto-utils. Please install that package instead.
Secure random numbers and probable prime (Miller-Rabin primality test) generation/testing using native JS (stage 3) implementation of BigInt. It can be used by any Web Browser or webview supporting BigInt and with Node.js (>=10.4.0).
The operations supported on BigInts are not constant time. BigInt can be therefore unsuitable for use in cryptography. Many platforms provide native support for cryptography, such as Web Cryptography API or Node.js Crypto.
Installation
bigint-secrets is distributed for web browsers and/or webviews supporting BigInt as an ES6 module; and for Node.js (>=10.4.0), as a CJS module.
bigint-secrets can be imported to your project with npm
:
npm install bigint-secrets
NPM installation defaults to the ES6 module for browsers and the CJS one for Node.js.
For web browsers, you can also download the bundle from GitHub.
Usage example
With node js:
const secrets = ; // Generation of a probable prime of 2048 bitsconst prime = await secrets; // Testing if a prime is a probable prime (Miller-Rabin)if await secrets return true; // Get a cryptographically secure random number between 1 and 2**256 bits.const rnd = secrets;
From a browser, you can just load the module in a html page as:
bigint-secrets JS Doc
Functions
- randBytes(byteLength, forceLength) ⇒
Promise
Secure random bytes for both node and browsers. Browser implementation uses WebWorkers in order to not lock the main process
- randBetween(max, min) ⇒
Promise
Returns a cryptographically secure random integer between [min,max]
- isProbablyPrime(w, iterations) ⇒
Promise
The test first tries if any of the first 250 small primes are a factor of the input number and then passes several iterations of Miller-Rabin Probabilistic Primality Test (FIPS 186-4 C.3.1)
- prime(bitLength, iterations) ⇒
Promise
A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator
Promise
randBytes(byteLength, forceLength) ⇒ Secure random bytes for both node and browsers. Browser implementation uses WebWorkers in order to not lock the main process
Kind: global function
Returns: Promise
- A promise that resolves to a Buffer/UInt8Array filled with cryptographically secure random bytes
Param | Type | Default | Description |
---|---|---|---|
byteLength | number |
The desired number of random bytes | |
forceLength | boolean |
false |
If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 |
Promise
randBetween(max, min) ⇒ Returns a cryptographically secure random integer between [min,max]
Kind: global function
Returns: Promise
- A promise that resolves to a cryptographically secure random bigint between [min,max]
Param | Type | Default | Description |
---|---|---|---|
max | bigint |
Returned value will be <= max | |
min | bigint |
1 |
Returned value will be >= min |
Promise
isProbablyPrime(w, iterations) ⇒ The test first tries if any of the first 250 small primes are a factor of the input number and then passes several iterations of Miller-Rabin Probabilistic Primality Test (FIPS 186-4 C.3.1)
Kind: global function
Returns: Promise
- A promise that resolve to a boolean that is either true (a probably prime number) or false (definitely composite)
Param | Type | Default | Description |
---|---|---|---|
w | bigint |
An integer to be tested for primality | |
iterations | number |
16 |
The number of iterations for the primality test. The value shall be consistent with Table C.1, C.2 or C.3 |
Promise
prime(bitLength, iterations) ⇒ A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator
Kind: global function
Returns: Promise
- A promise that resolves to a bigint probable prime of bitLength bits
Param | Type | Default | Description |
---|---|---|---|
bitLength | number |
The required bit length for the generated prime | |
iterations | number |
16 |
The number of iterations for the Miller-Rabin Probabilistic Primality Test |