bigint-crypto-utils
Advanced tools
Utils for working with cryptography using native JS (stage 3) implementation of BigInt. It includes arbitrary precision modular arithmetics, cryptographically secure random numbers and strong probable prime generation/testing.
Utils for working with cryptography using native JS (stage 3) implementation of BigInt. It includes some extra functions to work with modular arithmetics along with secure random numbers and a fast strong probable prime generator/tester (parallelised multi-threaded Miller-Rabin primality test). It can be used by any Web Browser or webview supporting BigInt and with Node.js (>=10.4.0). In the latter case, for multi-threaded primality tests, you should use Node.js 11 or enable at runtime with node --experimental-worker with Node.js >=10.5.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.
bigint-crypto-utils is distributed for web browsers and/or webviews supporting BigInt as an ES6 module or an IIFE file; and for Node.js (>=10.4.0), as a CJS module.
bigint-crypto-utils can be imported to your project with npm:
npm install bigint-crypto-utils
NPM installation defaults to the ES6 module for browsers and the CJS one for Node.js.
For web browsers, you can also directly download the minimised version of the IIFE file or the ES6 module from GitHub.
With node js:
const bigintCryptoUtils = require('bigint-crypto-utils');
/* Stage 3 BigInts with value 666 can be declared as BigInt('666')
or the shorter new no-so-linter-friendly syntax 666n.
Notice that you can also pass a number, e.g. BigInt(666), but it is not
recommended since values over 2**53 - 1 won't be safe but no warning will
be raised.
*/
let a = BigInt('5');
let b = BigInt('2');
let n = BigInt('19');
console.log(bigintCryptoUtils.modPow(a, b, n)); // prints 6
console.log(bigintCryptoUtils.modInv(BigInt('2'), BigInt('5'))); // prints 3
console.log(bigintCryptoUtils.modInv(BigInt('3'), BigInt('5'))); // prints 2
// Generation of a probable prime of 2048 bits
const prime = await bigintCryptoUtils.prime(2048);
// Testing if a prime is a probable prime (Miller-Rabin)
if ( await bigintCryptoUtils.isProbablyPrime(prime) )
// code if is prime
// Get a cryptographically secure random number between 1 and 2**256 bits.
const rnd = bigintCryptoUtils.randBetween(BigInt(2) ** BigInt(256));
From a browser, you can just load the module in a html page as:
<script type="module">
import * as bigintCryptoUtils from 'bigint-utils-latest.browser.mod.min.js';
let a = BigInt('5');
let b = BigInt('2');
let n = BigInt('19');
console.log(bigintCryptoUtils.modPow(a, b, n)); // prints 6
console.log(bigintCryptoUtils.modInv(BigInt('2'), BigInt('5'))); // prints 3
console.log(bigintCryptoUtils.modInv(BigInt('3'), BigInt('5'))); // prints 2
(async function () {
// Generation of a probable prime of 2018 bits
const p = await bigintCryptoUtils.prime(2048);
// Testing if a prime is a probable prime (Miller-Rabin)
const isPrime = await bigintCryptoUtils.isProbablyPrime(p);
alert(p.toString() + '\nIs prime?\n' + isPrime);
// Get a cryptographically secure random number between 1 and 2**256 bits.
const rnd = bigintCryptoUtils.randBetween(BigInt(2) ** BigInt(256));
alert(rnd);
})();
</script>
bigintAbsolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
numberReturns the bitlength of a number
egcdReturnAn iterative implementation of the extended euclidean algorithm or extended greatest common divisor algorithm. Take positive integers a, b as input, and return a triple (g, x, y), such that ax + by = g = gcd(a, b).
bigintGreatest-common divisor of two integers based on the iterative binary algorithm.
PromiseThe 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)
bigintThe least common multiple computed as abs(a*b)/gcd(a,b)
bigintMaximum. max(a,b)==a if a>=b. max(a,b)==b if a<=b
bigintMinimum. min(a,b)==b if a>=b. min(a,b)==a if a<=b
bigintModular inverse.
bigintModular exponentiation b**e mod n. Currently using the right-to-left binary method
PromiseA probably-prime (Miller-Rabin), cryptographically-secure, random-number generator. The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI main process, and it can be much faster (if several cores or cpu are available). The node version can also use worker_threads if they are available (enabled by default with Node 11 and and can be enabled at runtime executing node --experimental-worker with node >=10.5.0).
bigintA probably-prime (Miller-Rabin), cryptographically-secure, random-number generator. The sync version is NOT RECOMMENDED since it won't use workers and thus it'll be slower and may freeze thw window in browser's javascript. Please consider using prime() instead.
bigintReturns a cryptographically secure random integer between [min,max]
Buffer | Uint8ArraySecure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
PromiseSecure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
Buffer | Uint8ArraySecure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
bigintFinds the smallest positive element that is congruent to a in modulo n
ObjectA triple (g, x, y), such that ax + by = g = gcd(a, b).
bigintAbsolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
Kind: global function
Returns: bigint - the absolute value of a
| Param | Type |
|---|---|
| a | number | bigint |
numberReturns the bitlength of a number
Kind: global function
Returns: number - - the bit length
| Param | Type |
|---|---|
| a | number | bigint |
egcdReturnAn iterative implementation of the extended euclidean algorithm or extended greatest common divisor algorithm. Take positive integers a, b as input, and return a triple (g, x, y), such that ax + by = g = gcd(a, b).
Kind: global function
Returns: egcdReturn - A triple (g, x, y), such that ax + by = g = gcd(a, b).
| Param | Type |
|---|---|
| a | number | bigint |
| b | number | bigint |
bigintGreatest-common divisor of two integers based on the iterative binary algorithm.
Kind: global function
Returns: bigint - The greatest common divisor of a and b
| Param | Type |
|---|---|
| a | number | bigint |
| b | number | bigint |
PromiseThe 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 resolves to a boolean that is either true (a probably prime number) or false (definitely composite)
| Param | Type | Description |
|---|---|---|
| w | number | bigint | An integer to be tested for primality |
| iterations | number | The number of iterations for the primality test. The value shall be consistent with Table C.1, C.2 or C.3 |
bigintThe least common multiple computed as abs(a*b)/gcd(a,b)
Kind: global function
Returns: bigint - The least common multiple of a and b
| Param | Type |
|---|---|
| a | number | bigint |
| b | number | bigint |
bigintMaximum. max(a,b)==a if a>=b. max(a,b)==b if a<=b
Kind: global function
Returns: bigint - maximum of numbers a and b
| Param | Type |
|---|---|
| a | number | bigint |
| b | number | bigint |
bigintMinimum. min(a,b)==b if a>=b. min(a,b)==a if a<=b
Kind: global function
Returns: bigint - minimum of numbers a and b
| Param | Type |
|---|---|
| a | number | bigint |
| b | number | bigint |
bigintModular inverse.
Kind: global function
Returns: bigint - the inverse modulo n or NaN if it does not exist
| Param | Type | Description |
|---|---|---|
| a | number | bigint | The number to find an inverse for |
| n | number | bigint | The modulo |
bigintModular exponentiation b**e mod n. Currently using the right-to-left binary method
Kind: global function
Returns: bigint - b**e mod n
| Param | Type | Description |
|---|---|---|
| b | number | bigint | base |
| e | number | bigint | exponent |
| n | number | bigint | modulo |
PromiseA probably-prime (Miller-Rabin), cryptographically-secure, random-number generator. The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI main process, and it can be much faster (if several cores or cpu are available). The node version can also use worker_threads if they are available (enabled by default with Node 11 and and can be enabled at runtime executing node --experimental-worker with node >=10.5.0).
Kind: global function
Returns: Promise - A promise that resolves to a bigint probable prime of bitLength bits.
| Param | Type | Description |
|---|---|---|
| bitLength | number | The required bit length for the generated prime |
| iterations | number | The number of iterations for the Miller-Rabin Probabilistic Primality Test |
| sync | boolean | NOT RECOMMENDED. Invoke the function synchronously. It won't use workers so it'll be slower and may freeze thw window in browser's javascript. |
bigintA probably-prime (Miller-Rabin), cryptographically-secure, random-number generator. The sync version is NOT RECOMMENDED since it won't use workers and thus it'll be slower and may freeze thw window in browser's javascript. Please consider using prime() instead.
Kind: global function
Returns: bigint - A bigint probable prime of bitLength bits.
| Param | Type | Description |
|---|---|---|
| bitLength | number | The required bit length for the generated prime |
| iterations | number | The number of iterations for the Miller-Rabin Probabilistic Primality Test |
bigintReturns a cryptographically secure random integer between [min,max]
Kind: global function
Returns: bigint - A cryptographically secure random bigint between [min,max]
| Param | Type | Description |
|---|---|---|
| max | bigint | Returned value will be <= max |
| min | bigint | Returned value will be >= min |
Buffer | Uint8ArraySecure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
Kind: global function
Returns: Buffer | Uint8Array - A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits
| Param | Type | Description |
|---|---|---|
| bitLength | number | The desired number of random bits |
| forceLength | boolean | If we want to force the output to have a specific bit length. It basically forces the msb to be 1 |
PromiseSecure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
Kind: global function
Returns: Promise - A promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes
| Param | Type | Description |
|---|---|---|
| byteLength | number | The desired number of random bytes |
| forceLength | boolean | If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 |
Buffer | Uint8ArraySecure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
Kind: global function
Returns: Buffer | Uint8Array - A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes
| Param | Type | Description |
|---|---|---|
| byteLength | number | The desired number of random bytes |
| forceLength | boolean | If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 |
bigintFinds the smallest positive element that is congruent to a in modulo n
Kind: global function
Returns: bigint - The smallest positive representation of a in modulo n
| Param | Type | Description |
|---|---|---|
| a | number | bigint | An integer |
| n | number | bigint | The modulo |
ObjectA triple (g, x, y), such that ax + by = g = gcd(a, b).
Kind: global typedef
Properties
| Name | Type |
|---|---|
| g | bigint |
| x | bigint |
| y | bigint |
FAQs
Arbitrary precision modular arithmetic, cryptographically secure random numbers and strong probable prime generation/testing. It works in modern browsers, Angular, React, Node.js, etc. since it uses the native JS implementation of BigInt
The npm package bigint-crypto-utils receives a total of 53,993 weekly downloads. As such, bigint-crypto-utils popularity was classified as popular.
We found that bigint-crypto-utils demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.