From c246ef34f2324439417e18364d25df40caf7403b Mon Sep 17 00:00:00 2001 From: juanelas Date: Tue, 21 Apr 2020 10:06:04 +0200 Subject: [PATCH] JSDoc throws. API is now sorted by function name --- README.md | 122 +++++++++++++++++++------------ build/build.docs.js | 23 +++--- lib/index.browser.bundle.iife.js | 2 +- lib/index.browser.bundle.mod.js | 2 +- lib/index.browser.mod.js | 21 +++++- lib/index.node.js | 21 +++++- src/js/index.js | 21 +++++- types/index.d.ts | 18 ++++- 8 files changed, 166 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index a458999..0fbca80 100644 --- a/README.md +++ b/README.md @@ -135,6 +135,10 @@ Take positive integers a, b as input, and return a triple (g, x, y), such that a
gcd(a, b) ⇒ bigint

Greatest-common divisor of two integers based on the iterative binary algorithm.

+
isProbablyPrime(w, [iterations], [disableWorkers]) ⇒ Promise.<boolean>
+

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)

+
lcm(a, b) ⇒ bigint

The least common multiple computed as abs(a*b)/gcd(a,b)

@@ -150,13 +154,6 @@ Take positive integers a, b as input, and return a triple (g, x, y), such that a
modPow(b, e, n) ⇒ bigint

Modular exponentiation b**e mod n. Currently using the right-to-left binary method

-
toZn(a, n) ⇒ bigint
-

Finds the smallest positive element that is congruent to a in modulo n

-
-
isProbablyPrime(w, [iterations], [disableWorkers]) ⇒ Promise.<boolean>
-

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.<bigint>

A 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 @@ -183,6 +180,9 @@ The sync version is NOT RECOMMENDED since it won't use workers and thus it&#

randBytesSync(byteLength, [forceLength]) ⇒ Buffer | Uint8Array

Secure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()

+
toZn(a, n) ⇒ bigint
+

Finds the smallest positive element that is congruent to a in modulo n

+
### Typedefs @@ -231,6 +231,20 @@ Take positive integers a, b as input, and return a triple (g, x, y), such that a | a | number \| bigint | | b | number \| bigint | + + +### egcdReturn : Object +A triple (g, x, y), such that ax + by = g = gcd(a, b). + +**Kind**: global typedef +**Properties** + +| Name | Type | +| --- | --- | +| g | bigint | +| x | bigint | +| y | bigint | + ### gcd(a, b) ⇒ bigint @@ -244,6 +258,25 @@ Greatest-common divisor of two integers based on the iterative binary algorithm. | a | number \| bigint | | b | number \| bigint | + + +### isProbablyPrime(w, [iterations], [disableWorkers]) ⇒ Promise.<boolean> +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.<boolean> - A promise that resolves to a boolean that is either true (a probably prime number) or false (definitely composite) +**Throws**: + +- RangeError w MUST be >= 0 + + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| w | number \| bigint | | A positive 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 | +| [disableWorkers] | boolean | false | Disable the use of workers for the primality test | + ### lcm(a, b) ⇒ bigint @@ -310,34 +343,6 @@ Modular exponentiation b**e mod n. Currently using the right-to-left binary meth | e | number \| bigint | exponent | | n | number \| bigint | modulo | - - -### toZn(a, n) ⇒ bigint -Finds 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 | - - - -### isProbablyPrime(w, [iterations], [disableWorkers]) ⇒ Promise.<boolean> -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.<boolean> - A promise that resolves to a boolean that is either true (a probably prime number) or false (definitely composite) - -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| w | number \| 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 | -| [disableWorkers] | boolean | false | Disable the use of workers for the primality test | - ### prime(bitLength, [iterations]) ⇒ Promise.<bigint> @@ -349,6 +354,10 @@ and can be enabled at runtime executing node --experimental-worker with node >=1 **Kind**: global function **Returns**: Promise.<bigint> - A promise that resolves to a bigint probable prime of bitLength bits. +**Throws**: + +- RangeError bitLength MUST be > 0 + | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -363,6 +372,10 @@ The sync version is NOT RECOMMENDED since it won't use workers and thus it'll be **Kind**: global function **Returns**: bigint - A bigint probable prime of bitLength bits. +**Throws**: + +- RangeError bitLength MUST be > 0 + | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -376,6 +389,10 @@ Returns a cryptographically secure random integer between [min,max]. Both number **Kind**: global function **Returns**: bigint - A cryptographically secure random bigint between [min,max] +**Throws**: + +- RangeError Arguments MUST be: max > 0 && min >=0 && max > min + | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -389,6 +406,10 @@ Secure random bits for both node and browsers. Node version uses crypto.randomFi **Kind**: global function **Returns**: Promise.<(Buffer\|Uint8Array)> - A Promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits +**Throws**: + +- RangeError bitLength MUST be > 0 + | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -402,6 +423,10 @@ Secure random bits for both node and browsers. Node version uses crypto.randomFi **Kind**: global function **Returns**: Buffer \| Uint8Array - A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits +**Throws**: + +- RangeError bitLength MUST be > 0 + | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -415,6 +440,10 @@ Secure random bytes for both node and browsers. Node version uses crypto.randomB **Kind**: global function **Returns**: Promise.<(Buffer\|Uint8Array)> - A promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes +**Throws**: + +- RangeError byteLength MUST be > 0 + | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -428,23 +457,26 @@ Secure random bytes for both node and browsers. Node version uses crypto.randomF **Kind**: global function **Returns**: Buffer \| Uint8Array - A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes +**Throws**: + +- RangeError byteLength MUST be > 0 + | 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 | - + -### egcdReturn : Object -A triple (g, x, y), such that ax + by = g = gcd(a, b). +### toZn(a, n) ⇒ bigint +Finds the smallest positive element that is congruent to a in modulo n -**Kind**: global typedef -**Properties** +**Kind**: global function +**Returns**: bigint - The smallest positive representation of a in modulo n -| Name | Type | -| --- | --- | -| g | bigint | -| x | bigint | -| y | bigint | +| Param | Type | Description | +| --- | --- | --- | +| a | number \| bigint | An integer | +| n | number \| bigint | The modulo | diff --git a/build/build.docs.js b/build/build.docs.js index 3544b68..131ebea 100644 --- a/build/build.docs.js +++ b/build/build.docs.js @@ -53,18 +53,21 @@ const input1 = path.join(rootDir, 'node_modules', 'bigint-mod-arith', pkgJson.br const input2 = path.join(rootDir, pkgJson.browser) // this module // Let us replace bigint literals by standard numbers to avoid issues with bigint -const source1 = fs.readFileSync(input1, { encoding: 'UTF-8' }).replace(/([0-9]+)n([,\s\n)])/g, '$1$2') -const source2 = fs.readFileSync(input2, { encoding: 'UTF-8' }).replace(/([0-9]+)n([,\s\n)])/g, '$1$2') -const source = (source1 + '\n' + source2).replace(/^.*bigint-mod-arith.*$/mg, '') // remove import/export of bigint-mod-arith - -const options = { - source, - template, - 'heading-depth': 3 // The initial heading depth. For example, with a value of 2 the top-level markdown headings look like "## The heading" - // 'global-index-format': 'none' // none, grouped, table, dl. -} +const source1 = fs.readFileSync(input1, { encoding: 'UTF-8' }) +const source2 = fs.readFileSync(input2, { encoding: 'UTF-8' }) +const source = (source1 + '\n' + source2) + .replace(/^.*bigint-mod-arith.*$/mg, '') // remove import/export of bigint-mod-arith + .replace(/([0-9]+)n([,\s\n)])/g, '$1$2') // replace bigint literals by standard numbers to avoid issues with bigint jsdoc2md.clear().then(() => { + const data = jsdoc2md.getTemplateDataSync({ source }) + data.sort((fn1, fn2) => (fn1.id > fn2.id) ? 1 : -1) + const options = { + data, + template, + 'heading-depth': 3 // The initial heading depth. For example, with a value of 2 the top-level markdown headings look like "## The heading" + // 'global-index-format': 'none' // none, grouped, table, dl. + } const readmeContents = jsdoc2md.renderSync(options) const readmeFile = path.join(rootDir, 'README.md') diff --git a/lib/index.browser.bundle.iife.js b/lib/index.browser.bundle.iife.js index d75a602..73d1906 100644 --- a/lib/index.browser.bundle.iife.js +++ b/lib/index.browser.bundle.iife.js @@ -1 +1 @@ -var bigintCryptoUtils=function(n){"use strict";function t(n){return(n=BigInt(n))>=0n?n:-n}function e(n){if(1n===(n=BigInt(n)))return 1;let t=1;do{t++}while((n>>=1n)>1n);return t}function r(n,t){if((n=BigInt(n))<=0n|(t=BigInt(t))<=0n)throw new RangeError("a and b MUST be > 0");let e=0n,r=1n,i=1n,o=0n;for(;0n!==n;){const s=t/n,a=t%n,c=e-i*s,u=r-o*s;t=n,n=a,e=i,r=o,i=c,o=u}return{g:t,x:e,y:r}}function i(n,e){if(n=t(n),e=t(e),0n===n)return e;if(0n===e)return n;let r=0n;for(;!(1n&(n|e));)n>>=1n,e>>=1n,r++;for(;!(1n&n);)n>>=1n;do{for(;!(1n&e);)e>>=1n;if(n>e){const t=n;n=e,e=t}e-=n}while(e);return n<0;)e%2n===1n&&(i=i*n%r),e/=2n,n=n**2n%r;return i}function a(n,t){return(t=BigInt(t))<=0?NaN:(n=BigInt(n)%t)<0?n+t:n}function c(n,t=16,e=!1){return"number"==typeof n&&(n=BigInt(n)),new Promise((e,r)=>{const i=new Worker(m());i.onmessage=n=>{i.terminate(),e(n.data.isPrime)},i.onmessageerror=n=>{r(n)},i.postMessage({rnd:n,iterations:t,id:0})})}function u(n,t=1n){if(n<=0n||t<0n||n<=t)throw new RangeError("inputs should be max > 0, min >= 0; max > min");const r=n-t,i=e(r);let o;do{o=w(g(i))}while(o>r);return o+t}function f(n,t=!1){if(n<1)throw new RangeError("bitLength MUST be > 0");const e=Math.ceil(n/8),r=n%8;return new Promise(n=>{l(e,!1).then((function(e){if(r&&(e[0]=e[0]&2**r-1),t){const n=r?2**(r-1):128;e[0]=e[0]|n}n(e)}))})}function g(n,t=!1){if(n<1)throw new RangeError("bitLength MUST be > 0");const e=d(Math.ceil(n/8),!1),r=n%8;if(r&&(e[0]=e[0]&2**r-1),t){const n=r?2**(r-1):128;e[0]=e[0]|n}return e}function l(n,t=!1){if(n<1)throw new RangeError("byteLength MUST be > 0");return new Promise((function(e,r){{const r=new Uint8Array(n);self.crypto.getRandomValues(r),t&&(r[0]=128|r[0]),e(r)}}))}function d(n,t=!1){if(n<1)throw new RangeError("byteLength MUST be > 0");{const e=new Uint8Array(n);return self.crypto.getRandomValues(e),t&&(e[0]=128|e[0]),e}}function w(n){let t=0n;for(const e of n.values()){const n=BigInt(e);t=(t< {${n}})()`;const t=new Blob([n],{type:"text/javascript"});return window.URL.createObjectURL(t)}(n)}function h(n,t=16){if(2n===n)return!0;if(0n===(1n&n)||1n===n)return!1;const e=[3n,5n,7n,11n,13n,17n,19n,23n,29n,31n,37n,41n,43n,47n,53n,59n,61n,67n,71n,73n,79n,83n,89n,97n,101n,103n,107n,109n,113n,127n,131n,137n,139n,149n,151n,157n,163n,167n,173n,179n,181n,191n,193n,197n,199n,211n,223n,227n,229n,233n,239n,241n,251n,257n,263n,269n,271n,277n,281n,283n,293n,307n,311n,313n,317n,331n,337n,347n,349n,353n,359n,367n,373n,379n,383n,389n,397n,401n,409n,419n,421n,431n,433n,439n,443n,449n,457n,461n,463n,467n,479n,487n,491n,499n,503n,509n,521n,523n,541n,547n,557n,563n,569n,571n,577n,587n,593n,599n,601n,607n,613n,617n,619n,631n,641n,643n,647n,653n,659n,661n,673n,677n,683n,691n,701n,709n,719n,727n,733n,739n,743n,751n,757n,761n,769n,773n,787n,797n,809n,811n,821n,823n,827n,829n,839n,853n,857n,859n,863n,877n,881n,883n,887n,907n,911n,919n,929n,937n,941n,947n,953n,967n,971n,977n,983n,991n,997n,1009n,1013n,1019n,1021n,1031n,1033n,1039n,1049n,1051n,1061n,1063n,1069n,1087n,1091n,1093n,1097n,1103n,1109n,1117n,1123n,1129n,1151n,1153n,1163n,1171n,1181n,1187n,1193n,1201n,1213n,1217n,1223n,1229n,1231n,1237n,1249n,1259n,1277n,1279n,1283n,1289n,1291n,1297n,1301n,1303n,1307n,1319n,1321n,1327n,1361n,1367n,1373n,1381n,1399n,1409n,1423n,1427n,1429n,1433n,1439n,1447n,1451n,1453n,1459n,1471n,1481n,1483n,1487n,1489n,1493n,1499n,1511n,1523n,1531n,1543n,1549n,1553n,1559n,1567n,1571n,1579n,1583n,1597n];for(let t=0;t=(t=BigInt(t))?n:t},n.min=function(n,t){return(n=BigInt(n))>=(t=BigInt(t))?t:n},n.modInv=o,n.modPow=s,n.prime=function(n,t=16){if(n<1)throw new RangeError("bitLength MUST be > 0");if(!B){let e=0n;do{e=w(g(n,!0))}while(!h(e,t));return new Promise(n=>{n(e)})}return new Promise(e=>{const r=[],i=(i,o)=>{if(i.isPrime){for(let n=0;ni(n.data,t),r.push(t)}}for(let e=0;e 0");let e=0n;do{e=w(g(n,!0))}while(!h(e,t));return e},n.randBetween=u,n.randBits=f,n.randBitsSync=g,n.randBytes=l,n.randBytesSync=d,n.toZn=a,n}({}); +var bigintCryptoUtils=function(n){"use strict";function t(n){return(n=BigInt(n))>=0n?n:-n}function e(n){if(1n===(n=BigInt(n)))return 1;let t=1;do{t++}while((n>>=1n)>1n);return t}function r(n,t){if((n=BigInt(n))<=0n|(t=BigInt(t))<=0n)throw new RangeError("a and b MUST be > 0");let e=0n,r=1n,o=1n,i=0n;for(;0n!==n;){const s=t/n,a=t%n,c=e-o*s,u=r-i*s;t=n,n=a,e=o,r=i,o=c,i=u}return{g:t,x:e,y:r}}function o(n,e){if(n=t(n),e=t(e),0n===n)return e;if(0n===e)return n;let r=0n;for(;!(1n&(n|e));)n>>=1n,e>>=1n,r++;for(;!(1n&n);)n>>=1n;do{for(;!(1n&e);)e>>=1n;if(n>e){const t=n;n=e,e=t}e-=n}while(e);return n<0;)e%2n===1n&&(o=o*n%r),e/=2n,n=n**2n%r;return o}function a(n,t){return(t=BigInt(t))<=0?NaN:(n=BigInt(n)%t)<0?n+t:n}function c(n,t=16,e=!1){if("number"==typeof n&&(n=BigInt(n)),n<0)throw RangeError("w MUST be >= 0");return new Promise((e,r)=>{const o=new Worker(d());o.onmessage=n=>{o.terminate(),e(n.data.isPrime)},o.onmessageerror=n=>{r(n)},o.postMessage({rnd:n,iterations:t,id:0})})}function u(n,t=1n){if(n<=0n||t<0n||n<=t)throw new RangeError("Arguments MUST be: max > 0 && min >=0 && max > min");const r=n-t,o=e(r);let i;do{i=m(g(o))}while(i>r);return i+t}function f(n,t=!1){if(n<1)throw new RangeError("bitLength MUST be > 0");const e=Math.ceil(n/8),r=n%8;return new Promise(n=>{l(e,!1).then((function(e){if(r&&(e[0]=e[0]&2**r-1),t){const n=r?2**(r-1):128;e[0]=e[0]|n}n(e)}))})}function g(n,t=!1){if(n<1)throw new RangeError("bitLength MUST be > 0");const e=w(Math.ceil(n/8),!1),r=n%8;if(r&&(e[0]=e[0]&2**r-1),t){const n=r?2**(r-1):128;e[0]=e[0]|n}return e}function l(n,t=!1){if(n<1)throw new RangeError("byteLength MUST be > 0");return new Promise((function(e,r){{const r=new Uint8Array(n);self.crypto.getRandomValues(r),t&&(r[0]=128|r[0]),e(r)}}))}function w(n,t=!1){if(n<1)throw new RangeError("byteLength MUST be > 0");{const e=new Uint8Array(n);return self.crypto.getRandomValues(e),t&&(e[0]=128|e[0]),e}}function m(n){let t=0n;for(const e of n.values()){const n=BigInt(e);t=(t< {${n}})()`;const t=new Blob([n],{type:"text/javascript"});return window.URL.createObjectURL(t)}(n)}function h(n,t=16){if(2n===n)return!0;if(0n===(1n&n)||1n===n)return!1;const e=[3n,5n,7n,11n,13n,17n,19n,23n,29n,31n,37n,41n,43n,47n,53n,59n,61n,67n,71n,73n,79n,83n,89n,97n,101n,103n,107n,109n,113n,127n,131n,137n,139n,149n,151n,157n,163n,167n,173n,179n,181n,191n,193n,197n,199n,211n,223n,227n,229n,233n,239n,241n,251n,257n,263n,269n,271n,277n,281n,283n,293n,307n,311n,313n,317n,331n,337n,347n,349n,353n,359n,367n,373n,379n,383n,389n,397n,401n,409n,419n,421n,431n,433n,439n,443n,449n,457n,461n,463n,467n,479n,487n,491n,499n,503n,509n,521n,523n,541n,547n,557n,563n,569n,571n,577n,587n,593n,599n,601n,607n,613n,617n,619n,631n,641n,643n,647n,653n,659n,661n,673n,677n,683n,691n,701n,709n,719n,727n,733n,739n,743n,751n,757n,761n,769n,773n,787n,797n,809n,811n,821n,823n,827n,829n,839n,853n,857n,859n,863n,877n,881n,883n,887n,907n,911n,919n,929n,937n,941n,947n,953n,967n,971n,977n,983n,991n,997n,1009n,1013n,1019n,1021n,1031n,1033n,1039n,1049n,1051n,1061n,1063n,1069n,1087n,1091n,1093n,1097n,1103n,1109n,1117n,1123n,1129n,1151n,1153n,1163n,1171n,1181n,1187n,1193n,1201n,1213n,1217n,1223n,1229n,1231n,1237n,1249n,1259n,1277n,1279n,1283n,1289n,1291n,1297n,1301n,1303n,1307n,1319n,1321n,1327n,1361n,1367n,1373n,1381n,1399n,1409n,1423n,1427n,1429n,1433n,1439n,1447n,1451n,1453n,1459n,1471n,1481n,1483n,1487n,1489n,1493n,1499n,1511n,1523n,1531n,1543n,1549n,1553n,1559n,1567n,1571n,1579n,1583n,1597n];for(let t=0;t=(t=BigInt(t))?n:t},n.min=function(n,t){return(n=BigInt(n))>=(t=BigInt(t))?t:n},n.modInv=i,n.modPow=s,n.prime=function(n,t=16){if(n<1)throw new RangeError("bitLength MUST be > 0");if(!B){let e=0n;do{e=m(g(n,!0))}while(!h(e,t));return new Promise(n=>{n(e)})}return new Promise(e=>{const r=[],o=(o,i)=>{if(o.isPrime){for(let n=0;no(n.data,t),r.push(t)}}for(let e=0;e 0");let e=0n;do{e=m(g(n,!0))}while(!h(e,t));return e},n.randBetween=u,n.randBits=f,n.randBitsSync=g,n.randBytes=l,n.randBytesSync=w,n.toZn=a,n}({}); diff --git a/lib/index.browser.bundle.mod.js b/lib/index.browser.bundle.mod.js index 9dc25ce..5079fc9 100644 --- a/lib/index.browser.bundle.mod.js +++ b/lib/index.browser.bundle.mod.js @@ -1 +1 @@ -function n(n){return(n=BigInt(n))>=0n?n:-n}function t(n){if(1n===(n=BigInt(n)))return 1;let t=1;do{t++}while((n>>=1n)>1n);return t}function e(n,t){if((n=BigInt(n))<=0n|(t=BigInt(t))<=0n)throw new RangeError("a and b MUST be > 0");let e=0n,r=1n,o=1n,i=0n;for(;0n!==n;){const s=t/n,c=t%n,u=e-o*s,a=r-i*s;t=n,n=c,e=o,r=i,o=u,i=a}return{g:t,x:e,y:r}}function r(t,e){if(t=n(t),e=n(e),0n===t)return e;if(0n===e)return t;let r=0n;for(;!(1n&(t|e));)t>>=1n,e>>=1n,r++;for(;!(1n&t);)t>>=1n;do{for(;!(1n&e);)e>>=1n;if(t>e){const n=t;t=e,e=n}e-=t}while(e);return t<=(t=BigInt(t))?n:t}function s(n,t){return(n=BigInt(n))>=(t=BigInt(t))?t:n}function c(n,t){try{const r=e(a(n,t),t);return 1n!==r.g?NaN:a(r.x,t)}catch(n){return NaN}}function u(t,e,r){if(0n===(r=BigInt(r)))return NaN;if(1n===r)return BigInt(0);if(t=a(t,r),(e=BigInt(e))<0n)return c(u(t,n(e),r),r);let o=1n;for(;e>0;)e%2n===1n&&(o=o*t%r),e/=2n,t=t**2n%r;return o}function a(n,t){return(t=BigInt(t))<=0?NaN:(n=BigInt(n)%t)<0?n+t:n}function f(n,t=16,e=!1){return"number"==typeof n&&(n=BigInt(n)),new Promise((e,r)=>{const o=new Worker(I());o.onmessage=n=>{o.terminate(),e(n.data.isPrime)},o.onmessageerror=n=>{r(n)},o.postMessage({rnd:n,iterations:t,id:0})})}function g(n,t=16){if(n<1)throw new RangeError("bitLength MUST be > 0");if(!S){let e=0n;do{e=$(d(n,!0))}while(!b(e,t));return new Promise(n=>{n(e)})}return new Promise(e=>{const r=[],o=(o,i)=>{if(o.isPrime){for(let n=0;no(n.data,t),r.push(t)}}for(let e=0;e 0");let e=0n;do{e=$(d(n,!0))}while(!b(e,t));return e}function w(n,e=1n){if(n<=0n||e<0n||n<=e)throw new RangeError("inputs should be max > 0, min >= 0; max > min");const r=n-e,o=t(r);let i;do{i=$(d(o))}while(i>r);return i+e}function h(n,t=!1){if(n<1)throw new RangeError("bitLength MUST be > 0");const e=Math.ceil(n/8),r=n%8;return new Promise(n=>{m(e,!1).then((function(e){if(r&&(e[0]=e[0]&2**r-1),t){const n=r?2**(r-1):128;e[0]=e[0]|n}n(e)}))})}function d(n,t=!1){if(n<1)throw new RangeError("bitLength MUST be > 0");const e=B(Math.ceil(n/8),!1),r=n%8;if(r&&(e[0]=e[0]&2**r-1),t){const n=r?2**(r-1):128;e[0]=e[0]|n}return e}function m(n,t=!1){if(n<1)throw new RangeError("byteLength MUST be > 0");return new Promise((function(e,r){{const r=new Uint8Array(n);self.crypto.getRandomValues(r),t&&(r[0]=128|r[0]),e(r)}}))}function B(n,t=!1){if(n<1)throw new RangeError("byteLength MUST be > 0");{const e=new Uint8Array(n);return self.crypto.getRandomValues(e),t&&(e[0]=128|e[0]),e}}function $(n){let t=0n;for(const e of n.values()){const n=BigInt(e);t=(t< {${n}})()`;const t=new Blob([n],{type:"text/javascript"});return window.URL.createObjectURL(t)}(n)}function b(n,t=16){if(2n===n)return!0;if(0n===(1n&n)||1n===n)return!1;const e=[3n,5n,7n,11n,13n,17n,19n,23n,29n,31n,37n,41n,43n,47n,53n,59n,61n,67n,71n,73n,79n,83n,89n,97n,101n,103n,107n,109n,113n,127n,131n,137n,139n,149n,151n,157n,163n,167n,173n,179n,181n,191n,193n,197n,199n,211n,223n,227n,229n,233n,239n,241n,251n,257n,263n,269n,271n,277n,281n,283n,293n,307n,311n,313n,317n,331n,337n,347n,349n,353n,359n,367n,373n,379n,383n,389n,397n,401n,409n,419n,421n,431n,433n,439n,443n,449n,457n,461n,463n,467n,479n,487n,491n,499n,503n,509n,521n,523n,541n,547n,557n,563n,569n,571n,577n,587n,593n,599n,601n,607n,613n,617n,619n,631n,641n,643n,647n,653n,659n,661n,673n,677n,683n,691n,701n,709n,719n,727n,733n,739n,743n,751n,757n,761n,769n,773n,787n,797n,809n,811n,821n,823n,827n,829n,839n,853n,857n,859n,863n,877n,881n,883n,887n,907n,911n,919n,929n,937n,941n,947n,953n,967n,971n,977n,983n,991n,997n,1009n,1013n,1019n,1021n,1031n,1033n,1039n,1049n,1051n,1061n,1063n,1069n,1087n,1091n,1093n,1097n,1103n,1109n,1117n,1123n,1129n,1151n,1153n,1163n,1171n,1181n,1187n,1193n,1201n,1213n,1217n,1223n,1229n,1231n,1237n,1249n,1259n,1277n,1279n,1283n,1289n,1291n,1297n,1301n,1303n,1307n,1319n,1321n,1327n,1361n,1367n,1373n,1381n,1399n,1409n,1423n,1427n,1429n,1433n,1439n,1447n,1451n,1453n,1459n,1471n,1481n,1483n,1487n,1489n,1493n,1499n,1511n,1523n,1531n,1543n,1549n,1553n,1559n,1567n,1571n,1579n,1583n,1597n];for(let t=0;t=0n?n:-n}function t(n){if(1n===(n=BigInt(n)))return 1;let t=1;do{t++}while((n>>=1n)>1n);return t}function e(n,t){if((n=BigInt(n))<=0n|(t=BigInt(t))<=0n)throw new RangeError("a and b MUST be > 0");let e=0n,r=1n,o=1n,i=0n;for(;0n!==n;){const s=t/n,a=t%n,c=e-o*s,u=r-i*s;t=n,n=a,e=o,r=i,o=c,i=u}return{g:t,x:e,y:r}}function r(t,e){if(t=n(t),e=n(e),0n===t)return e;if(0n===e)return t;let r=0n;for(;!(1n&(t|e));)t>>=1n,e>>=1n,r++;for(;!(1n&t);)t>>=1n;do{for(;!(1n&e);)e>>=1n;if(t>e){const n=t;t=e,e=n}e-=t}while(e);return t<=(t=BigInt(t))?n:t}function s(n,t){return(n=BigInt(n))>=(t=BigInt(t))?t:n}function a(n,t){try{const r=e(u(n,t),t);return 1n!==r.g?NaN:u(r.x,t)}catch(n){return NaN}}function c(t,e,r){if(0n===(r=BigInt(r)))return NaN;if(1n===r)return BigInt(0);if(t=u(t,r),(e=BigInt(e))<0n)return a(c(t,n(e),r),r);let o=1n;for(;e>0;)e%2n===1n&&(o=o*t%r),e/=2n,t=t**2n%r;return o}function u(n,t){return(t=BigInt(t))<=0?NaN:(n=BigInt(n)%t)<0?n+t:n}function f(n,t=16,e=!1){if("number"==typeof n&&(n=BigInt(n)),n<0)throw RangeError("w MUST be >= 0");return new Promise((e,r)=>{const o=new Worker($());o.onmessage=n=>{o.terminate(),e(n.data.isPrime)},o.onmessageerror=n=>{r(n)},o.postMessage({rnd:n,iterations:t,id:0})})}function g(n,t=16){if(n<1)throw new RangeError("bitLength MUST be > 0");if(!I){let e=0n;do{e=S(m(n,!0))}while(!b(e,t));return new Promise(n=>{n(e)})}return new Promise(e=>{const r=[],o=(o,i)=>{if(o.isPrime){for(let n=0;no(n.data,t),r.push(t)}}for(let e=0;e 0");let e=0n;do{e=S(m(n,!0))}while(!b(e,t));return e}function w(n,e=1n){if(n<=0n||e<0n||n<=e)throw new RangeError("Arguments MUST be: max > 0 && min >=0 && max > min");const r=n-e,o=t(r);let i;do{i=S(m(o))}while(i>r);return i+e}function h(n,t=!1){if(n<1)throw new RangeError("bitLength MUST be > 0");const e=Math.ceil(n/8),r=n%8;return new Promise(n=>{d(e,!1).then((function(e){if(r&&(e[0]=e[0]&2**r-1),t){const n=r?2**(r-1):128;e[0]=e[0]|n}n(e)}))})}function m(n,t=!1){if(n<1)throw new RangeError("bitLength MUST be > 0");const e=B(Math.ceil(n/8),!1),r=n%8;if(r&&(e[0]=e[0]&2**r-1),t){const n=r?2**(r-1):128;e[0]=e[0]|n}return e}function d(n,t=!1){if(n<1)throw new RangeError("byteLength MUST be > 0");return new Promise((function(e,r){{const r=new Uint8Array(n);self.crypto.getRandomValues(r),t&&(r[0]=128|r[0]),e(r)}}))}function B(n,t=!1){if(n<1)throw new RangeError("byteLength MUST be > 0");{const e=new Uint8Array(n);return self.crypto.getRandomValues(e),t&&(e[0]=128|e[0]),e}}function S(n){let t=0n;for(const e of n.values()){const n=BigInt(e);t=(t< {${n}})()`;const t=new Blob([n],{type:"text/javascript"});return window.URL.createObjectURL(t)}(n)}function b(n,t=16){if(2n===n)return!0;if(0n===(1n&n)||1n===n)return!1;const e=[3n,5n,7n,11n,13n,17n,19n,23n,29n,31n,37n,41n,43n,47n,53n,59n,61n,67n,71n,73n,79n,83n,89n,97n,101n,103n,107n,109n,113n,127n,131n,137n,139n,149n,151n,157n,163n,167n,173n,179n,181n,191n,193n,197n,199n,211n,223n,227n,229n,233n,239n,241n,251n,257n,263n,269n,271n,277n,281n,283n,293n,307n,311n,313n,317n,331n,337n,347n,349n,353n,359n,367n,373n,379n,383n,389n,397n,401n,409n,419n,421n,431n,433n,439n,443n,449n,457n,461n,463n,467n,479n,487n,491n,499n,503n,509n,521n,523n,541n,547n,557n,563n,569n,571n,577n,587n,593n,599n,601n,607n,613n,617n,619n,631n,641n,643n,647n,653n,659n,661n,673n,677n,683n,691n,701n,709n,719n,727n,733n,739n,743n,751n,757n,761n,769n,773n,787n,797n,809n,811n,821n,823n,827n,829n,839n,853n,857n,859n,863n,877n,881n,883n,887n,907n,911n,919n,929n,937n,941n,947n,953n,967n,971n,977n,983n,991n,997n,1009n,1013n,1019n,1021n,1031n,1033n,1039n,1049n,1051n,1061n,1063n,1069n,1087n,1091n,1093n,1097n,1103n,1109n,1117n,1123n,1129n,1151n,1153n,1163n,1171n,1181n,1187n,1193n,1201n,1213n,1217n,1223n,1229n,1231n,1237n,1249n,1259n,1277n,1279n,1283n,1289n,1291n,1297n,1301n,1303n,1307n,1319n,1321n,1327n,1361n,1367n,1373n,1381n,1399n,1409n,1423n,1427n,1429n,1433n,1439n,1447n,1451n,1453n,1459n,1471n,1481n,1483n,1487n,1489n,1493n,1499n,1511n,1523n,1531n,1543n,1549n,1553n,1559n,1567n,1571n,1579n,1583n,1597n];for(let t=0;t= 0 + * * @returns {Promise} A promise that resolves to a boolean that is either true (a probably prime number) or false (definitely composite) */ function isProbablyPrime (w, iterations = 16, disableWorkers = false) { if (typeof w === 'number') { w = BigInt(w) } + if (w < 0) throw RangeError('w MUST be >= 0') /* eslint-disable no-lone-blocks */ { // browser return new Promise((resolve, reject) => { @@ -49,6 +52,8 @@ function isProbablyPrime (w, iterations = 16, disableWorkers = false) { * @param {number} bitLength The required bit length for the generated prime * @param {number} [iterations = 16] The number of iterations for the Miller-Rabin Probabilistic Primality Test * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Promise} A promise that resolves to a bigint probable prime of bitLength bits. */ function prime (bitLength, iterations = 16) { @@ -118,6 +123,8 @@ function prime (bitLength, iterations = 16) { * @param {number} bitLength The required bit length for the generated prime * @param {number} [iterations = 16] The number of iterations for the Miller-Rabin Probabilistic Primality Test * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {bigint} A bigint probable prime of bitLength bits. */ function primeSync (bitLength, iterations = 16) { @@ -134,10 +141,12 @@ function primeSync (bitLength, iterations = 16) { * @param {bigint} max Returned value will be <= max * @param {bigint} [min = BigInt(1)] Returned value will be >= min * + * @throws {RangeError} Arguments MUST be: max > 0 && min >=0 && max > min + * * @returns {bigint} A cryptographically secure random bigint between [min,max] */ function randBetween (max, min = 1n) { - if (max <= 0n || min < 0n || max <= min) throw new RangeError('inputs should be max > 0, min >= 0; max > min') + if (max <= 0n || min < 0n || max <= min) throw new RangeError('Arguments MUST be: max > 0 && min >=0 && max > min') const interval = max - min const bitLen = bitLength(interval) let rnd @@ -154,6 +163,8 @@ function randBetween (max, min = 1n) { * @param {number} bitLength The desired number of random bits * @param {boolean} [forceLength = false] If we want to force the output to have a specific bit length. It basically forces the msb to be 1 * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Promise} A Promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits */ function randBits (bitLength, forceLength = false) { @@ -182,6 +193,8 @@ function randBits (bitLength, forceLength = false) { * @param {number} bitLength The desired number of random bits * @param {boolean} [forceLength = false] If we want to force the output to have a specific bit length. It basically forces the msb to be 1 * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Buffer | Uint8Array} A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits */ function randBitsSync (bitLength, forceLength = false) { @@ -207,6 +220,8 @@ function randBitsSync (bitLength, forceLength = false) { * @param {number} byteLength The desired number of random bytes * @param {boolean} [forceLength = false] If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 * + * @throws {RangeError} byteLength MUST be > 0 + * * @returns {Promise} A promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes */ function randBytes (byteLength, forceLength = false) { @@ -231,6 +246,8 @@ function randBytes (byteLength, forceLength = false) { * @param {number} byteLength The desired number of random bytes * @param {boolean} [forceLength = false] If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 * + * @throws {RangeError} byteLength MUST be > 0 + * * @returns {Buffer | Uint8Array} A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes */ function randBytesSync (byteLength, forceLength = false) { diff --git a/lib/index.node.js b/lib/index.node.js index 3b67dfb..9bbb8ed 100644 --- a/lib/index.node.js +++ b/lib/index.node.js @@ -6,16 +6,19 @@ var bigintModArith = require('bigint-mod-arith') * 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) * - * @param {number | bigint} w An integer to be tested for primality + * @param {number | bigint} w A positive integer to be tested for primality * @param {number} [iterations = 16] The number of iterations for the primality test. The value shall be consistent with Table C.1, C.2 or C.3 * @param {boolean} [disableWorkers = false] Disable the use of workers for the primality test * + * @throws {RangeError} w MUST be >= 0 + * * @returns {Promise} A promise that resolves to a boolean that is either true (a probably prime number) or false (definitely composite) */ function isProbablyPrime (w, iterations = 16, disableWorkers = false) { if (typeof w === 'number') { w = BigInt(w) } + if (w < 0) throw RangeError('w MUST be >= 0') /* eslint-disable no-lone-blocks */ { // Node.js /* istanbul ignore else */ @@ -56,6 +59,8 @@ function isProbablyPrime (w, iterations = 16, disableWorkers = false) { * @param {number} bitLength The required bit length for the generated prime * @param {number} [iterations = 16] The number of iterations for the Miller-Rabin Probabilistic Primality Test * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Promise} A promise that resolves to a bigint probable prime of bitLength bits. */ function prime (bitLength, iterations = 16) { @@ -126,6 +131,8 @@ function prime (bitLength, iterations = 16) { * @param {number} bitLength The required bit length for the generated prime * @param {number} [iterations = 16] The number of iterations for the Miller-Rabin Probabilistic Primality Test * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {bigint} A bigint probable prime of bitLength bits. */ function primeSync (bitLength, iterations = 16) { @@ -142,10 +149,12 @@ function primeSync (bitLength, iterations = 16) { * @param {bigint} max Returned value will be <= max * @param {bigint} [min = BigInt(1)] Returned value will be >= min * + * @throws {RangeError} Arguments MUST be: max > 0 && min >=0 && max > min + * * @returns {bigint} A cryptographically secure random bigint between [min,max] */ function randBetween (max, min = 1n) { - if (max <= 0n || min < 0n || max <= min) throw new RangeError('inputs should be max > 0, min >= 0; max > min') + if (max <= 0n || min < 0n || max <= min) throw new RangeError('Arguments MUST be: max > 0 && min >=0 && max > min') const interval = max - min const bitLen = bigintModArith.bitLength(interval) let rnd @@ -162,6 +171,8 @@ function randBetween (max, min = 1n) { * @param {number} bitLength The desired number of random bits * @param {boolean} [forceLength = false] If we want to force the output to have a specific bit length. It basically forces the msb to be 1 * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Promise} A Promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits */ function randBits (bitLength, forceLength = false) { @@ -190,6 +201,8 @@ function randBits (bitLength, forceLength = false) { * @param {number} bitLength The desired number of random bits * @param {boolean} [forceLength = false] If we want to force the output to have a specific bit length. It basically forces the msb to be 1 * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Buffer | Uint8Array} A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits */ function randBitsSync (bitLength, forceLength = false) { @@ -215,6 +228,8 @@ function randBitsSync (bitLength, forceLength = false) { * @param {number} byteLength The desired number of random bytes * @param {boolean} [forceLength = false] If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 * + * @throws {RangeError} byteLength MUST be > 0 + * * @returns {Promise} A promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes */ function randBytes (byteLength, forceLength = false) { @@ -242,6 +257,8 @@ function randBytes (byteLength, forceLength = false) { * @param {number} byteLength The desired number of random bytes * @param {boolean} [forceLength = false] If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 * + * @throws {RangeError} byteLength MUST be > 0 + * * @returns {Buffer | Uint8Array} A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes */ function randBytesSync (byteLength, forceLength = false) { diff --git a/src/js/index.js b/src/js/index.js index e59217f..da4d27c 100644 --- a/src/js/index.js +++ b/src/js/index.js @@ -6,16 +6,19 @@ export { abs, bitLength, eGcd, gcd, lcm, max, min, modInv, modPow, toZn } from ' * 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) * - * @param {number | bigint} w An integer to be tested for primality + * @param {number | bigint} w A positive integer to be tested for primality * @param {number} [iterations = 16] The number of iterations for the primality test. The value shall be consistent with Table C.1, C.2 or C.3 * @param {boolean} [disableWorkers = false] Disable the use of workers for the primality test * + * @throws {RangeError} w MUST be >= 0 + * * @returns {Promise} A promise that resolves to a boolean that is either true (a probably prime number) or false (definitely composite) */ export function isProbablyPrime (w, iterations = 16, disableWorkers = false) { if (typeof w === 'number') { w = BigInt(w) } + if (w < 0) throw RangeError('w MUST be >= 0') /* eslint-disable no-lone-blocks */ if (!process.browser) { // Node.js /* istanbul ignore else */ @@ -75,6 +78,8 @@ export function isProbablyPrime (w, iterations = 16, disableWorkers = false) { * @param {number} bitLength The required bit length for the generated prime * @param {number} [iterations = 16] The number of iterations for the Miller-Rabin Probabilistic Primality Test * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Promise} A promise that resolves to a bigint probable prime of bitLength bits. */ export function prime (bitLength, iterations = 16) { @@ -152,6 +157,8 @@ export function prime (bitLength, iterations = 16) { * @param {number} bitLength The required bit length for the generated prime * @param {number} [iterations = 16] The number of iterations for the Miller-Rabin Probabilistic Primality Test * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {bigint} A bigint probable prime of bitLength bits. */ export function primeSync (bitLength, iterations = 16) { @@ -168,10 +175,12 @@ export function primeSync (bitLength, iterations = 16) { * @param {bigint} max Returned value will be <= max * @param {bigint} [min = BigInt(1)] Returned value will be >= min * + * @throws {RangeError} Arguments MUST be: max > 0 && min >=0 && max > min + * * @returns {bigint} A cryptographically secure random bigint between [min,max] */ export function randBetween (max, min = 1n) { - if (max <= 0n || min < 0n || max <= min) throw new RangeError('inputs should be max > 0, min >= 0; max > min') + if (max <= 0n || min < 0n || max <= min) throw new RangeError('Arguments MUST be: max > 0 && min >=0 && max > min') const interval = max - min const bitLen = bitLength(interval) let rnd @@ -188,6 +197,8 @@ export function randBetween (max, min = 1n) { * @param {number} bitLength The desired number of random bits * @param {boolean} [forceLength = false] If we want to force the output to have a specific bit length. It basically forces the msb to be 1 * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Promise} A Promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits */ export function randBits (bitLength, forceLength = false) { @@ -216,6 +227,8 @@ export function randBits (bitLength, forceLength = false) { * @param {number} bitLength The desired number of random bits * @param {boolean} [forceLength = false] If we want to force the output to have a specific bit length. It basically forces the msb to be 1 * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Buffer | Uint8Array} A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits */ export function randBitsSync (bitLength, forceLength = false) { @@ -241,6 +254,8 @@ export function randBitsSync (bitLength, forceLength = false) { * @param {number} byteLength The desired number of random bytes * @param {boolean} [forceLength = false] If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 * + * @throws {RangeError} byteLength MUST be > 0 + * * @returns {Promise} A promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes */ export function randBytes (byteLength, forceLength = false) { @@ -274,6 +289,8 @@ export function randBytes (byteLength, forceLength = false) { * @param {number} byteLength The desired number of random bytes * @param {boolean} [forceLength = false] If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 * + * @throws {RangeError} byteLength MUST be > 0 + * * @returns {Buffer | Uint8Array} A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes */ export function randBytesSync (byteLength, forceLength = false) { diff --git a/types/index.d.ts b/types/index.d.ts index 9dd2bd3..9da986a 100644 --- a/types/index.d.ts +++ b/types/index.d.ts @@ -2,10 +2,12 @@ * 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) * - * @param {number | bigint} w An integer to be tested for primality + * @param {number | bigint} w A positive integer to be tested for primality * @param {number} [iterations = 16] The number of iterations for the primality test. The value shall be consistent with Table C.1, C.2 or C.3 * @param {boolean} [disableWorkers = false] Disable the use of workers for the primality test * + * @throws {RangeError} w MUST be >= 0 + * * @returns {Promise} A promise that resolves to a boolean that is either true (a probably prime number) or false (definitely composite) */ export function isProbablyPrime(w: number | bigint, iterations?: number, disableWorkers?: boolean): Promise; @@ -19,6 +21,8 @@ export function isProbablyPrime(w: number | bigint, iterations?: number, disable * @param {number} bitLength The required bit length for the generated prime * @param {number} [iterations = 16] The number of iterations for the Miller-Rabin Probabilistic Primality Test * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Promise} A promise that resolves to a bigint probable prime of bitLength bits. */ export function prime(bitLength: number, iterations?: number): Promise; @@ -29,6 +33,8 @@ export function prime(bitLength: number, iterations?: number): Promise; * @param {number} bitLength The required bit length for the generated prime * @param {number} [iterations = 16] The number of iterations for the Miller-Rabin Probabilistic Primality Test * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {bigint} A bigint probable prime of bitLength bits. */ export function primeSync(bitLength: number, iterations?: number): bigint; @@ -37,6 +43,8 @@ export function primeSync(bitLength: number, iterations?: number): bigint; * @param {bigint} max Returned value will be <= max * @param {bigint} [min = BigInt(1)] Returned value will be >= min * + * @throws {RangeError} Arguments MUST be: max > 0 && min >=0 && max > min + * * @returns {bigint} A cryptographically secure random bigint between [min,max] */ export function randBetween(max: bigint, min?: bigint): bigint; @@ -46,6 +54,8 @@ export function randBetween(max: bigint, min?: bigint): bigint; * @param {number} bitLength The desired number of random bits * @param {boolean} [forceLength = false] If we want to force the output to have a specific bit length. It basically forces the msb to be 1 * + * @throws {RangeError} bitLength MUST be > 0 + * * @returns {Promise} A Promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits */ export function randBits(bitLength: number, forceLength?: boolean): Promise; @@ -54,6 +64,8 @@ export function randBits(bitLength: number, forceLength?: boolean): Promise 0 + * * @returns {Buffer | Uint8Array} A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits */ export function randBitsSync(bitLength: number, forceLength?: boolean): Uint8Array | Buffer; @@ -63,6 +75,8 @@ export function randBitsSync(bitLength: number, forceLength?: boolean): Uint8Arr * @param {number} byteLength The desired number of random bytes * @param {boolean} [forceLength = false] If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 * + * @throws {RangeError} byteLength MUST be > 0 + * * @returns {Promise} A promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes */ export function randBytes(byteLength: number, forceLength?: boolean): Promise; @@ -72,6 +86,8 @@ export function randBytes(byteLength: number, forceLength?: boolean): Promise 0 + * * @returns {Buffer | Uint8Array} A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes */ export function randBytesSync(byteLength: number, forceLength?: boolean): Uint8Array | Buffer;