diff --git a/README.md b/README.md index 9064928..7fa4d06 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # bigint-crypto-utils -Utils for working with cryptography using native JS ([ES-2020](https://tc39.es/ecma262/#sec-bigint-objects)) implementation of BigInt. It includes some extra functions to work with modular arithmetic along with secure random numbers and a fast strong probable prime generator/tester (parallelized multi-threaded Miller-Rabin primality test). It can be used by any [Web Browser or webview supporting BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#Browser_compatibility) and with Node.js (>=10.4.0). In the latter case, for multi-threaded primality tests, you should use Node.js v11 or newer or enable at runtime with `node --experimental-worker` with Node.js version >= 10.5.0 and < 11. +Utils for working with cryptography using native JS ([ES-2020](https://tc39.es/ecma262/#sec-bigint-objects)) implementation of BigInt. It includes some extra functions to work with modular arithmetic along with secure random numbers and a fast strong probable prime generator/tester (parallelized multi-threaded Miller-Rabin primality tests if workers are supported). It can be used by any [Web Browser or webview supporting BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#Browser_compatibility) 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](https://www.chosenplaintext.ca/articles/beginners-guide-constant-time-cryptography.html).** Many platforms provide native support for cryptography, such as [Web Cryptography API](https://w3c.github.io/webcrypto/) or [Node.js Crypto](https://nodejs.org/dist/latest/docs/api/crypto.html). @@ -56,14 +56,14 @@ Import your module as : ``` -And you could use it like in the following: +An example of usage could be: ```javascript -/* 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. +/* A BigInt with value 666 can be declared calling the bigint constructor as +BigInt('666') or with the shorter 666n. +Notice that you can also pass a number to the constructor, e.g. BigInt(666). +However, it is not recommended since values over 2**53 - 1 won't be safe but +no warning will be raised. */ const a = BigInt('5') const b = BigInt('2') @@ -95,6 +95,9 @@ primeTesting() ``` +You can find examples in the [examples folder of the repository](https://github.com/juanelas/bigint-crypto-utils/tree/master/examples). + + ## API reference documentation ### Functions diff --git a/build/rollup.tests.config.js b/build/rollup.tests.config.js index b5da420..8c5dda5 100644 --- a/build/rollup.tests.config.js +++ b/build/rollup.tests.config.js @@ -23,12 +23,12 @@ const dstFileName = path.join(dstDir, 'index.html') const template = fs.readFileSync(templatePath, 'utf-8') const bundleFile = path.join(rootDir, pkgJson.directories.lib, 'index.browser.bundle.mod.js') const testsJs = ` - ` + ` fs.writeFileSync(dstFileName, template.replace(/{{TESTS}}/g, testsJs).replace(/{{PKG_NAME}}/g, pkgName).replace(/{{MOCHA_VERSION}}/g, mochaVersion).replace(/{{CHAI_VERSION}}/g, chaiVersion) diff --git a/lib/index.browser.bundle.iife.js b/lib/index.browser.bundle.iife.js index be267e3..e73d0e8 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 r(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)return NaN;let r=0n,e=1n,i=1n,o=0n;for(;0n!==n;){const s=t/n,a=t%n,c=r-i*s,u=e-o*s;t=n,n=a,r=i,e=o,i=c,o=u}return{b:t,x:r,y:e}}function i(n,r){if(n=t(n),r=t(r),0n===n)return r;if(0n===r)return n;let e=0n;for(;!(1n&(n|r));)n>>=1n,r>>=1n,e++;for(;!(1n&n);)n>>=1n;do{for(;!(1n&r);)r>>=1n;if(n>r){const t=n;n=r,r=t}r-=n}while(r);return n<0;)r%2n===1n&&(i=i*n%e),r/=2n,n=n**2n%e;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){return"number"==typeof n&&(n=BigInt(n)),new Promise((r,e)=>{const i=new Worker(m());i.onmessage=n=>{i.terminate(),r(n.data.isPrime)},i.onmessageerror=n=>{e(n)},i.postMessage({rnd:n,iterations:t,id:0})})}function u(n,t=1n){if(n<=t)throw new Error("max must be > min");const e=n-t,i=r(e);let o;do{o=l(f(i))}while(o>e);return o+t}function f(n,t=!1){if(n<1)throw new RangeError(`bitLength MUST be > 0 and it is ${n}`);const r=d(Math.ceil(n/8),!1),e=n%8;if(e&&(r[0]=r[0]&2**e-1),t){const n=e?2**(e-1):128;r[0]=r[0]|n}return r}function g(n,t=!1){if(n<1)throw new RangeError(`byteLength MUST be > 0 and it is ${n}`);return new Promise((function(r){const e=new Uint8Array(n);self.crypto.getRandomValues(e),t&&(e[0]=128|e[0]),r(e)}))}function d(n,t=!1){if(n<1)throw new RangeError(`byteLength MUST be > 0 and it is ${n}`);{const r=new Uint8Array(n);return self.crypto.getRandomValues(r),t&&(r[0]=128|r[0]),r}}function l(n){let t=0n;for(const r of n.values()){const n=BigInt(r);t=(t< {${n}})()`;const t=new Blob([n],{type:"text/javascript"});return window.URL.createObjectURL(t)}(n)}function w(n,t=16){if(2n===n)return!0;if(0n===(1n&n)||1n===n)return!1;const r=[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 and it is ${n}`);return new Promise(r=>{const e=[],i=(i,o)=>{if(i.isPrime){for(let n=0;ni(n.data,t),e.push(t)}}for(let r=0;r 0 and it is ${n}`);let r=0n;do{r=l(f(n,!0))}while(!w(r,t));return r},n.randBetween=u,n.randBits=async function(n,t=!1){if(n<1)throw new RangeError(`bitLength MUST be > 0 and it is ${n}`);const r=Math.ceil(n/8),e=n%8,i=await g(r,!1);if(e&&(i[0]=i[0]&2**e-1),t){const n=e?2**(e-1):128;i[0]=i[0]|n}return i},n.randBitsSync=f,n.randBytes=g,n.randBytesSync=d,n.toZn=a,n}({}); +var bigintCryptoUtils=function(n){"use strict";function t(n){return(n=BigInt(n))>=0n?n:-n}function r(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)return NaN;let r=0n,e=1n,i=1n,o=0n;for(;0n!==n;){const s=t/n,a=t%n,c=r-i*s,u=e-o*s;t=n,n=a,r=i,e=o,i=c,o=u}return{b:t,x:r,y:e}}function i(n,r){if(n=t(n),r=t(r),0n===n)return r;if(0n===r)return n;let e=0n;for(;!(1n&(n|r));)n>>=1n,r>>=1n,e++;for(;!(1n&n);)n>>=1n;do{for(;!(1n&r);)r>>=1n;if(n>r){const t=n;n=r,r=t}r-=n}while(r);return n<0;)r%2n===1n&&(i=i*n%e),r/=2n,n=n**2n%e;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){return"number"==typeof n&&(n=BigInt(n)),new Promise((r,e)=>{const i=new Worker(w());i.onmessage=n=>{i.terminate(),r(n.data.isPrime)},i.onmessageerror=n=>{e(n)},i.postMessage({rnd:n,iterations:t,id:0})})}function u(n,t=1n){if(n<=t)throw new Error("max must be > min");const e=n-t,i=r(e);let o;do{o=l(f(i))}while(o>e);return o+t}function f(n,t=!1){if(n<1)throw new RangeError(`bitLength MUST be > 0 and it is ${n}`);const r=d(Math.ceil(n/8),!1),e=n%8;if(e&&(r[0]=r[0]&2**e-1),t){const n=e?2**(e-1):128;r[0]=r[0]|n}return r}function g(n,t=!1){if(n<1)throw new RangeError(`byteLength MUST be > 0 and it is ${n}`);return new Promise((function(r){const e=new Uint8Array(n);crypto.getRandomValues(e),t&&(e[0]=128|e[0]),r(e)}))}function d(n,t=!1){if(n<1)throw new RangeError(`byteLength MUST be > 0 and it is ${n}`);{const r=new Uint8Array(n);return crypto.getRandomValues(r),t&&(r[0]=128|r[0]),r}}function l(n){let t=0n;for(const r of n.values()){const n=BigInt(r);t=(t< {${n}})()`;const t=new Blob([n],{type:"text/javascript"});return window.URL.createObjectURL(t)}(n)}function m(n,t=16){if(2n===n)return!0;if(0n===(1n&n)||1n===n)return!1;const r=[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 and it is ${n}`);if(!h){let r=0n;do{r=l(f(n,!0))}while(!m(r,t));return new Promise(n=>{n(r)})}return new Promise(r=>{const e=[],i=(i,o)=>{if(i.isPrime){for(let n=0;ni(n.data,t),e.push(t)}}for(let r=0;r 0 and it is ${n}`);let r=0n;do{r=l(f(n,!0))}while(!m(r,t));return r},n.randBetween=u,n.randBits=async function(n,t=!1){if(n<1)throw new RangeError(`bitLength MUST be > 0 and it is ${n}`);const r=Math.ceil(n/8),e=n%8,i=await g(r,!1);if(e&&(i[0]=i[0]&2**e-1),t){const n=e?2**(e-1):128;i[0]=i[0]|n}return i},n.randBitsSync=f,n.randBytes=g,n.randBytesSync=d,n.toZn=a,n}({}); diff --git a/lib/index.browser.bundle.mod.js b/lib/index.browser.bundle.mod.js index 9a762b1..a7bb7e3 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)return NaN;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{b: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){const r=e(u(n,t),t);return 1n!==r.b?NaN:u(r.x,t)}function c(t,e,r){if(0n===(r=BigInt(r)))return NaN;if(1n===r)return 0n;if(t=u(t,r),(e=BigInt(e))<0n)return a(c(t,n(e),r),r);let i=1n;for(;e>0;)e%2n===1n&&(i=i*t%r),e/=2n,t=t**2n%r;return i}function u(n,t){return(t=BigInt(t))<=0?NaN:(n=BigInt(n)%t)<0?n+t:n}function f(n,t=16){return"number"==typeof n&&(n=BigInt(n)),new Promise((e,r)=>{const i=new Worker(B());i.onmessage=n=>{i.terminate(),e(n.data.isPrime)},i.onmessageerror=n=>{r(n)},i.postMessage({rnd:n,iterations:t,id:0})})}function g(n,t=16){if(n<1)throw new RangeError(`bitLength MUST be > 0 and it is ${n}`);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 and it is ${n}`);let e=0n;do{e=b(h(n,!0))}while(!I(e,t));return e}function d(n,e=1n){if(n<=e)throw new Error("max must be > min");const r=n-e,i=t(r);let o;do{o=b(h(i))}while(o>r);return o+e}async function w(n,t=!1){if(n<1)throw new RangeError(`bitLength MUST be > 0 and it is ${n}`);const e=Math.ceil(n/8),r=n%8,i=await m(e,!1);if(r&&(i[0]=i[0]&2**r-1),t){const n=r?2**(r-1):128;i[0]=i[0]|n}return i}function h(n,t=!1){if(n<1)throw new RangeError(`bitLength MUST be > 0 and it is ${n}`);const e=$(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 and it is ${n}`);return new Promise((function(e){const r=new Uint8Array(n);self.crypto.getRandomValues(r),t&&(r[0]=128|r[0]),e(r)}))}function $(n,t=!1){if(n<1)throw new RangeError(`byteLength MUST be > 0 and it is ${n}`);{const e=new Uint8Array(n);return self.crypto.getRandomValues(e),t&&(e[0]=128|e[0]),e}}function b(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 I(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)return NaN;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{b: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){const r=e(u(n,t),t);return 1n!==r.b?NaN:u(r.x,t)}function c(t,e,r){if(0n===(r=BigInt(r)))return NaN;if(1n===r)return 0n;if(t=u(t,r),(e=BigInt(e))<0n)return a(c(t,n(e),r),r);let i=1n;for(;e>0;)e%2n===1n&&(i=i*t%r),e/=2n,t=t**2n%r;return i}function u(n,t){return(t=BigInt(t))<=0?NaN:(n=BigInt(n)%t)<0?n+t:n}function f(n,t=16){return"number"==typeof n&&(n=BigInt(n)),new Promise((e,r)=>{const i=new Worker(B());i.onmessage=n=>{i.terminate(),e(n.data.isPrime)},i.onmessageerror=n=>{r(n)},i.postMessage({rnd:n,iterations:t,id:0})})}function g(n,t=16){if(n<1)throw new RangeError(`bitLength MUST be > 0 and it is ${n}`);if(!S){let e=0n;do{e=b(h(n,!0))}while(!I(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 and it is ${n}`);let e=0n;do{e=b(h(n,!0))}while(!I(e,t));return e}function w(n,e=1n){if(n<=e)throw new Error("max must be > min");const r=n-e,i=t(r);let o;do{o=b(h(i))}while(o>r);return o+e}async function d(n,t=!1){if(n<1)throw new RangeError(`bitLength MUST be > 0 and it is ${n}`);const e=Math.ceil(n/8),r=n%8,i=await m(e,!1);if(r&&(i[0]=i[0]&2**r-1),t){const n=r?2**(r-1):128;i[0]=i[0]|n}return i}function h(n,t=!1){if(n<1)throw new RangeError(`bitLength MUST be > 0 and it is ${n}`);const e=$(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 and it is ${n}`);return new Promise((function(e){const r=new Uint8Array(n);crypto.getRandomValues(r),t&&(r[0]=128|r[0]),e(r)}))}function $(n,t=!1){if(n<1)throw new RangeError(`byteLength MUST be > 0 and it is ${n}`);{const e=new Uint8Array(n);return crypto.getRandomValues(e),t&&(e[0]=128|e[0]),e}}function b(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 I(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 and it is ${bitLength}`) } + + if (!_useWorkers) { // If there is no support for workers + let rnd = 0n + do { + rnd = fromBuffer(randBitsSync(bitLength, true)) + } while (!_isProbablyPrime(rnd, iterations)) + return new Promise((resolve) => { resolve(rnd) }) + } return new Promise((resolve) => { const workerList = [] const _onmessage = (msg, newWorker) => { @@ -318,7 +326,7 @@ function prime (bitLength, iterations = 16) { * @returns {bigint} A bigint probable prime of bitLength bits. */ function primeSync (bitLength, iterations = 16) { - if (bitLength < 1) { throw new RangeError(`bitLength MUST be > 0 and it is ${bitLength}`) } + if (bitLength < 1) throw new RangeError(`bitLength MUST be > 0 and it is ${bitLength}`) let rnd = 0n do { rnd = fromBuffer(randBitsSync(bitLength, true)) @@ -417,9 +425,9 @@ function randBytes (byteLength, forceLength = false) { { // browser return new Promise(function (resolve) { const buf = new Uint8Array(byteLength) - self.crypto.getRandomValues(buf) + crypto.getRandomValues(buf) // If fixed length is required we put the first bit to 1 -> to get the necessary bitLength - if (forceLength) { buf[0] = buf[0] | 128 } + if (forceLength) buf[0] = buf[0] | 128 resolve(buf) }) } @@ -440,7 +448,7 @@ function randBytesSync (byteLength, forceLength = false) { /* eslint-disable no-lone-blocks */ { // browser const buf = new Uint8Array(byteLength) - self.crypto.getRandomValues(buf) + crypto.getRandomValues(buf) // If fixed length is required we put the first bit to 1 -> to get the necessary bitLength if (forceLength) { buf[0] = buf[0] | 128 } return buf @@ -489,7 +497,8 @@ function _isProbablyPrime (w, iterations = 16) { PREFILTERING. Even values but 2 are not primes, so don't test. 1 is not a prime and the M-R algorithm needs w>1. */ - if (w === 2n) { return true } else if ((w & 1n) === 0n || w === 1n) { return false } + if (w === 2n) return true + else if ((w & 1n) === 0n || w === 1n) return false /* Test if any of the first 250 small primes are a factor of w. 2 is not tested because it was already tested above. @@ -749,11 +758,8 @@ function _isProbablyPrime (w, iterations = 16) { for (let i = 0; i < firstPrimes.length && (firstPrimes[i] <= w); i++) { const p = firstPrimes[i] - if (w === p) { - return true - } else if (w % p === 0n) { - return false - } + if (w === p) return true + else if (w % p === 0n) return false } /* @@ -785,38 +791,27 @@ function _isProbablyPrime (w, iterations = 16) { const m = d / (2n ** a) - // /* eslint-disable no-labels */ - // loop: do { - // const b = randBetween(w - 1n, 2n) - // let z = modPow(b, m, w) - // if (z === 1n || z === w - 1n) { continue } - // for (let j = 1; j < a; j++) { - // z = modPow(z, 2n, w) - // if (z === w - 1n) { continue loop } - // if (z === 1n) { break } - // } - // return false - // } while (--iterations) - // /* eslint-enable no-labels */ - - // return true - do { const b = randBetween(d, 2n) let z = modPow(b, m, w) - if (z === 1n || z === d) { continue } + if (z === 1n || z === d) continue let j = 1 while (j < a) { z = modPow(z, 2n, w) - if (z === d) { break } - if (z === 1n) { return false } + if (z === d) break + if (z === 1n) return false j++ } - if (z !== d) { - return false - } + if (z !== d) return false } while (--iterations) + return true } +let _useWorkers = false // The following is just to check whether we can use workers +/* eslint-disable no-lone-blocks */ +{ // Native JS + if (self.Worker) _useWorkers = true +} + export { abs, bitLength, eGcd, gcd, isProbablyPrime, lcm, max, min, modInv, modPow, prime, primeSync, randBetween, randBits, randBitsSync, randBytes, randBytesSync, toZn } diff --git a/lib/index.node.js b/lib/index.node.js index 61b25c4..be044dd 100644 --- a/lib/index.node.js +++ b/lib/index.node.js @@ -271,7 +271,7 @@ function isProbablyPrime (w, iterations = 16) { function prime (bitLength, iterations = 16) { if (bitLength < 1) { throw new RangeError(`bitLength MUST be > 0 and it is ${bitLength}`) } - if (!_useWorkers) { + if (!_useWorkers) { // If there is no support for workers let rnd = 0n do { rnd = fromBuffer(randBitsSync(bitLength, true)) @@ -337,7 +337,7 @@ function prime (bitLength, iterations = 16) { * @returns {bigint} A bigint probable prime of bitLength bits. */ function primeSync (bitLength, iterations = 16) { - if (bitLength < 1) { throw new RangeError(`bitLength MUST be > 0 and it is ${bitLength}`) } + if (bitLength < 1) throw new RangeError(`bitLength MUST be > 0 and it is ${bitLength}`) let rnd = 0n do { rnd = fromBuffer(randBitsSync(bitLength, true)) @@ -438,7 +438,7 @@ function randBytes (byteLength, forceLength = false) { const buf = Buffer.alloc(byteLength) return crypto.randomFill(buf, function (resolve) { // If fixed length is required we put the first bit to 1 -> to get the necessary bitLength - if (forceLength) { buf[0] = buf[0] | 128 } + if (forceLength) buf[0] = buf[0] | 128 resolve(buf) }) } @@ -484,7 +484,8 @@ function _isProbablyPrime (w, iterations = 16) { PREFILTERING. Even values but 2 are not primes, so don't test. 1 is not a prime and the M-R algorithm needs w>1. */ - if (w === 2n) { return true } else if ((w & 1n) === 0n || w === 1n) { return false } + if (w === 2n) return true + else if ((w & 1n) === 0n || w === 1n) return false /* Test if any of the first 250 small primes are a factor of w. 2 is not tested because it was already tested above. @@ -744,11 +745,8 @@ function _isProbablyPrime (w, iterations = 16) { for (let i = 0; i < firstPrimes.length && (firstPrimes[i] <= w); i++) { const p = firstPrimes[i] - if (w === p) { - return true - } else if (w % p === 0n) { - return false - } + if (w === p) return true + else if (w % p === 0n) return false } /* @@ -780,55 +778,36 @@ function _isProbablyPrime (w, iterations = 16) { const m = d / (2n ** a) - // /* eslint-disable no-labels */ - // loop: do { - // const b = randBetween(w - 1n, 2n) - // let z = modPow(b, m, w) - // if (z === 1n || z === w - 1n) { continue } - // for (let j = 1; j < a; j++) { - // z = modPow(z, 2n, w) - // if (z === w - 1n) { continue loop } - // if (z === 1n) { break } - // } - // return false - // } while (--iterations) - // /* eslint-enable no-labels */ - - // return true - do { const b = randBetween(d, 2n) let z = modPow(b, m, w) - if (z === 1n || z === d) { continue } + if (z === 1n || z === d) continue let j = 1 while (j < a) { z = modPow(z, 2n, w) - if (z === d) { break } - if (z === 1n) { return false } + if (z === d) break + if (z === 1n) return false j++ } - if (z !== d) { - return false - } + if (z !== d) return false } while (--iterations) + return true } -let _useWorkers = true // The following is just to check whether Node.js can use workers +let _useWorkers = false // The following is just to check whether we can use workers /* eslint-disable no-lone-blocks */ { // Node.js - _useWorkers = (function _workers () { - try { - require.resolve('worker_threads') - return true - } catch (e) { - console.log(`[bigint-crypto-utils] WARNING: + try { + require.resolve('worker_threads') + _useWorkers = true + } catch (e) { + console.log(`[bigint-crypto-utils] WARNING: This node version doesn't support worker_threads. You should enable them in order to greatly speedup the generation of big prime numbers. - · With Node >=11 it is enabled by default (consider upgrading). - · With Node 10, starting with 10.5.0, you can enable worker_threads at runtime executing node --experimental-worker `) - return false - } - })() + · With Node >=11 it is enabled by default (consider upgrading). + · With Node 10, starting with 10.5.0, you can enable worker_threads at runtime executing node --experimental-worker `) + _useWorkers = true + } } /* eslint-enable no-lone-blocks */ diff --git a/package.json b/package.json index 1a9d24c..e3188ff 100644 --- a/package.json +++ b/package.json @@ -47,6 +47,7 @@ "BigInt", "Blob", "postMessage", + "crypto", "self", "Worker" ], diff --git a/src/doc/readme-template.md b/src/doc/readme-template.md index f01a3aa..0d03fcf 100644 --- a/src/doc/readme-template.md +++ b/src/doc/readme-template.md @@ -2,7 +2,7 @@ # bigint-crypto-utils -Utils for working with cryptography using native JS ([ES-2020](https://tc39.es/ecma262/#sec-bigint-objects)) implementation of BigInt. It includes some extra functions to work with modular arithmetic along with secure random numbers and a fast strong probable prime generator/tester (parallelized multi-threaded Miller-Rabin primality test). It can be used by any [Web Browser or webview supporting BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#Browser_compatibility) and with Node.js (>=10.4.0). In the latter case, for multi-threaded primality tests, you should use Node.js v11 or newer or enable at runtime with `node --experimental-worker` with Node.js version >= 10.5.0 and < 11. +Utils for working with cryptography using native JS ([ES-2020](https://tc39.es/ecma262/#sec-bigint-objects)) implementation of BigInt. It includes some extra functions to work with modular arithmetic along with secure random numbers and a fast strong probable prime generator/tester (parallelized multi-threaded Miller-Rabin primality tests if workers are supported). It can be used by any [Web Browser or webview supporting BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#Browser_compatibility) 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](https://www.chosenplaintext.ca/articles/beginners-guide-constant-time-cryptography.html).** Many platforms provide native support for cryptography, such as [Web Cryptography API](https://w3c.github.io/webcrypto/) or [Node.js Crypto](https://nodejs.org/dist/latest/docs/api/crypto.html). @@ -56,14 +56,14 @@ Import your module as : ``` -And you could use it like in the following: +An example of usage could be: ```javascript -/* 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. +/* A BigInt with value 666 can be declared calling the bigint constructor as +BigInt('666') or with the shorter 666n. +Notice that you can also pass a number to the constructor, e.g. BigInt(666). +However, it is not recommended since values over 2**53 - 1 won't be safe but +no warning will be raised. */ const a = BigInt('5') const b = BigInt('2') @@ -95,6 +95,9 @@ primeTesting() ``` +You can find examples in the [examples folder of the repository](https://github.com/juanelas/bigint-crypto-utils/tree/master/examples). + + ## API reference documentation {{>main}} diff --git a/src/js/index.js b/src/js/index.js index 713e7a7..9fb9476 100644 --- a/src/js/index.js +++ b/src/js/index.js @@ -78,7 +78,7 @@ export function isProbablyPrime (w, iterations = 16) { export function prime (bitLength, iterations = 16) { if (bitLength < 1) { throw new RangeError(`bitLength MUST be > 0 and it is ${bitLength}`) } - if (!process.browser && !_useWorkers) { + if (!_useWorkers) { // If there is no support for workers let rnd = 0n do { rnd = fromBuffer(randBitsSync(bitLength, true)) @@ -151,7 +151,7 @@ export function prime (bitLength, iterations = 16) { * @returns {bigint} A bigint probable prime of bitLength bits. */ export function primeSync (bitLength, iterations = 16) { - if (bitLength < 1) { throw new RangeError(`bitLength MUST be > 0 and it is ${bitLength}`) } + if (bitLength < 1) throw new RangeError(`bitLength MUST be > 0 and it is ${bitLength}`) let rnd = 0n do { rnd = fromBuffer(randBitsSync(bitLength, true)) @@ -252,15 +252,15 @@ export function randBytes (byteLength, forceLength = false) { const buf = Buffer.alloc(byteLength) return crypto.randomFill(buf, function (resolve) { // If fixed length is required we put the first bit to 1 -> to get the necessary bitLength - if (forceLength) { buf[0] = buf[0] | 128 } + if (forceLength) buf[0] = buf[0] | 128 resolve(buf) }) } else { // browser return new Promise(function (resolve) { const buf = new Uint8Array(byteLength) - self.crypto.getRandomValues(buf) + crypto.getRandomValues(buf) // If fixed length is required we put the first bit to 1 -> to get the necessary bitLength - if (forceLength) { buf[0] = buf[0] | 128 } + if (forceLength) buf[0] = buf[0] | 128 resolve(buf) }) } @@ -288,7 +288,7 @@ export function randBytesSync (byteLength, forceLength = false) { return buf } else { // browser const buf = new Uint8Array(byteLength) - self.crypto.getRandomValues(buf) + crypto.getRandomValues(buf) // If fixed length is required we put the first bit to 1 -> to get the necessary bitLength if (forceLength) { buf[0] = buf[0] | 128 } return buf @@ -337,7 +337,8 @@ function _isProbablyPrime (w, iterations = 16) { PREFILTERING. Even values but 2 are not primes, so don't test. 1 is not a prime and the M-R algorithm needs w>1. */ - if (w === 2n) { return true } else if ((w & 1n) === 0n || w === 1n) { return false } + if (w === 2n) return true + else if ((w & 1n) === 0n || w === 1n) return false /* Test if any of the first 250 small primes are a factor of w. 2 is not tested because it was already tested above. @@ -597,11 +598,8 @@ function _isProbablyPrime (w, iterations = 16) { for (let i = 0; i < firstPrimes.length && (firstPrimes[i] <= w); i++) { const p = firstPrimes[i] - if (w === p) { - return true - } else if (w % p === 0n) { - return false - } + if (w === p) return true + else if (w % p === 0n) return false } /* @@ -633,55 +631,38 @@ function _isProbablyPrime (w, iterations = 16) { const m = d / (2n ** a) - // /* eslint-disable no-labels */ - // loop: do { - // const b = randBetween(w - 1n, 2n) - // let z = modPow(b, m, w) - // if (z === 1n || z === w - 1n) { continue } - // for (let j = 1; j < a; j++) { - // z = modPow(z, 2n, w) - // if (z === w - 1n) { continue loop } - // if (z === 1n) { break } - // } - // return false - // } while (--iterations) - // /* eslint-enable no-labels */ - - // return true - do { const b = randBetween(d, 2n) let z = modPow(b, m, w) - if (z === 1n || z === d) { continue } + if (z === 1n || z === d) continue let j = 1 while (j < a) { z = modPow(z, 2n, w) - if (z === d) { break } - if (z === 1n) { return false } + if (z === d) break + if (z === 1n) return false j++ } - if (z !== d) { - return false - } + if (z !== d) return false } while (--iterations) + return true } -let _useWorkers = true // The following is just to check whether Node.js can use workers +let _useWorkers = false // The following is just to check whether we can use workers /* eslint-disable no-lone-blocks */ if (!process.browser) { // Node.js - _useWorkers = (function _workers () { - try { - require.resolve('worker_threads') - return true - } catch (e) { - console.log(`[bigint-crypto-utils] WARNING: + try { + require.resolve('worker_threads') + _useWorkers = true + } catch (e) { + console.log(`[bigint-crypto-utils] WARNING: This node version doesn't support worker_threads. You should enable them in order to greatly speedup the generation of big prime numbers. - · With Node >=11 it is enabled by default (consider upgrading). - · With Node 10, starting with 10.5.0, you can enable worker_threads at runtime executing node --experimental-worker `) - return false - } - })() + · With Node >=11 it is enabled by default (consider upgrading). + · With Node 10, starting with 10.5.0, you can enable worker_threads at runtime executing node --experimental-worker `) + _useWorkers = true + } +} else { // Native JS + if (self.Worker) _useWorkers = true } /* eslint-enable no-lone-blocks */ diff --git a/test/browser/index.html b/test/browser/index.html index 140cb87..c1041c7 100644 --- a/test/browser/index.html +++ b/test/browser/index.html @@ -12,12 +12,12 @@
- + \ No newline at end of file diff --git a/test/browser/index.iife.html b/test/browser/index.iife.html deleted file mode 100644 index 19cf4c7..0000000 --- a/test/browser/index.iife.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - Primes - - - - -
result of primeSync() will show up here
-
result of prime() will show up here
- - - - - - \ No newline at end of file