sm-crypto-v2 1.2.2 → 1.3.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.3.0](https://github.com/Cubelrti/sm-crypto-v2/compare/v1.2.2...v1.3.0) (2023-06-07)
+
+
+### Features
+
+* **sm2:** add benchmark and optimize rng pooling ([b162377](https://github.com/Cubelrti/sm-crypto-v2/commit/b1623774cc4374deea61499f13790c5e8b17041a))
+
 ### [1.2.2](https://github.com/Cubelrti/sm-crypto-v2/compare/v1.2.1...v1.2.2) (2023-06-07)
 
 

package/README.md

@@ -37,10 +37,12 @@ privateKey = keypair.privateKey // 私钥
 const compressedPublicKey = sm2.compressPublicKeyHex(publicKey) // compressedPublicKey 和 publicKey 等价
 sm2.comparePublicKeyHex(publicKey, compressedPublicKey) // 判断公钥是否等价
 
-// 自定义随机数，参数会直接透传给 jsbn 库的 BigInteger 构造器
+// 自定义随机数，参数会直接透传给 BigInt 构造器
 // 注意：开发者使用自定义随机数，需要自行确保传入的随机数符合密码学安全
 let keypair2 = sm2.generateKeyPairHex('123123123123123')
-let keypair3 = sm2.generateKeyPairHex(256, SecureRandom)
+
+// 初始化随机数池，在某些场景下可能会用到
+await sm2.initRNGPool()
 
 let verifyResult = sm2.verifyPublicKey(publicKey) // 验证公钥
 verifyResult = sm2.verifyPublicKey(compressedPublicKey) // 验证公钥
@@ -168,6 +170,30 @@ let decryptData = sm4.decrypt(encryptData, key, {mode: 'cbc', iv: 'fedcba9876543
 * java 实现（感谢 @antherd 提供）：[https://github.com/antherd/sm-crypto](https://github.com/antherd/sm-crypto)
 * dart 实现（感谢 @luckykellan 提供）：[https://github.com/luckykellan/dart_sm](https://github.com/luckykellan/dart_sm)
 
+## 性能
+
+CPU: Apple M1 Pro
+
+```
+❯ npm run bench
+
+> benchmark@0.1.0 bench
+> node index.js
+
+Benchmarking
+
+=== sm-crypto ===
+sm2 generateKeyPair x 134 ops/sec @ 7ms/op ± 4.12% (min: 6ms, max: 21ms)
+sm2 encrypt x 71 ops/sec @ 14ms/op
+sm2 sign x 139 ops/sec @ 7ms/op
+sm2 verify x 70 ops/sec @ 14ms/op
+=== sm-crypto-v2 ===
+sm2 generateKeyPair x 2,835 ops/sec @ 352μs/op ± 6.34% (min: 286μs, max: 1ms)
+sm2 encrypt x 253 ops/sec @ 3ms/op ± 2.11% (min: 3ms, max: 24ms)
+sm2 sign x 3,186 ops/sec @ 313μs/op ± 1.26% (min: 277μs, max: 854μs)
+sm2 verify x 258 ops/sec @ 3ms/op
+```
+
 ## 协议
 
 MIT

package/benchmark/index.js

@@ -0,0 +1,29 @@
+import { run, mark, utils } from 'micro-bmark';
+import * as sm from 'sm-crypto'
+import * as smV2 from 'sm-crypto-v2'
+
+const msg = 'Hello world~!'
+
+const keypair = smV2.sm2.generateKeyPairHex('12345678901234567890')
+
+run(async () => {
+  await smV2.sm2.initRNGPool()
+  const sig = smV2.sm2.doSignature(msg, keypair.privateKey, { publicKey: keypair.publicKey})
+
+  const RAM = false
+  console.log();
+  if (RAM) utils.logMem();
+  console.log('=== sm-crypto ===')
+  await mark('sm2 generateKeyPair', 100, () => sm.sm2.generateKeyPairHex())
+  await mark('sm2 encrypt', 500, () => sm.sm2.doEncrypt(msg, keypair.publicKey));
+  await mark('sm2 sign', 500, () => sm.sm2.doSignature(msg, keypair.privateKey, { publicKey: keypair.publicKey}));
+  await mark('sm2 verify', 500, () => sm.sm2.doVerifySignature(msg, sig, keypair.publicKey));
+  if (RAM) utils.logMem();
+  if (RAM) utils.logMem();
+  console.log('=== sm-crypto-v2 ===')
+  await mark('sm2 generateKeyPair', 100, () => smV2.sm2.generateKeyPairHex())
+  await mark('sm2 encrypt', 500, () => smV2.sm2.doEncrypt(msg, keypair.publicKey));
+  await mark('sm2 sign', 500, () => smV2.sm2.doSignature(msg, keypair.privateKey, { publicKey: keypair.publicKey}));
+  await mark('sm2 verify', 500, () => smV2.sm2.doVerifySignature(msg, sig, keypair.publicKey));
+  if (RAM) utils.logMem();
+});

package/benchmark/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "benchmark",
+  "private": true,
+  "version": "0.1.0",
+  "description": "benchmarks",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "bench": "node index.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "micro-bmark": "^0.3.1",
+    "sm-crypto": "^0.3.12",
+    "sm-crypto-v2": "^1.2.2"
+  }
+}

package/benchmark/pnpm-lock.yaml

@@ -0,0 +1,28 @@
+lockfileVersion: '6.0'
+
+dependencies:
+  micro-bmark:
+    specifier: ^0.3.1
+    version: 0.3.1
+  sm-crypto:
+    specifier: ^0.3.12
+    version: 0.3.12
+  sm-crypto-v2:
+    specifier: ^1.2.2
+    version: link:..
+
+packages:
+
+  /jsbn@1.1.0:
+    resolution: {integrity: sha512-4bYVV3aAMtDTTu4+xsDYa6sy9GyJ69/amsu9sYF2zqjiEoZA5xJi3BrfX3uY+/IekIu7MwdObdbDWpoZdBv3/A==}
+    dev: false
+
+  /micro-bmark@0.3.1:
+    resolution: {integrity: sha512-bNaKObD4yPAAPrpEqp5jO6LJ2sEFgLoFSmRjEY809mJ62+2AehI/K3+RlVpN3Oo92RHpgC2RQhj6b1Tb4dmo+w==}
+    dev: false
+
+  /sm-crypto@0.3.12:
+    resolution: {integrity: sha512-272PBzB4PYaBdeGa41TH9ZlMGLPVRmS36Gs4FjmHwXIdihQypAbhhFWZTaa/3de69q2KfMme1M5O2W5+spAdrg==}
+    dependencies:
+      jsbn: 1.1.0
+    dev: false

package/dist/index.d.ts

@@ -39,6 +39,8 @@ declare function verifyPublicKey(publicKey: string): boolean;
 declare function comparePublicKeyHex(publicKey1: string, publicKey2: string): boolean;
 declare function concatArray(...arrays: Uint8Array[]): Uint8Array;
 
+declare function initRNGPool(): Promise<void>;
+
 /**
  * 加密
  */
@@ -100,6 +102,7 @@ declare const index$2_doVerifySignature: typeof doVerifySignature;
 declare const index$2_getHash: typeof getHash;
 declare const index$2_getPublicKeyFromPrivateKey: typeof getPublicKeyFromPrivateKey;
 declare const index$2_getPoint: typeof getPoint;
+declare const index$2_initRNGPool: typeof initRNGPool;
 declare const index$2_generateKeyPairHex: typeof generateKeyPairHex;
 declare const index$2_compressPublicKeyHex: typeof compressPublicKeyHex;
 declare const index$2_utf8ToHex: typeof utf8ToHex;
@@ -120,6 +123,7 @@ declare namespace index$2 {
     index$2_getHash as getHash,
     index$2_getPublicKeyFromPrivateKey as getPublicKeyFromPrivateKey,
     index$2_getPoint as getPoint,
+    index$2_initRNGPool as initRNGPool,
     index$2_generateKeyPairHex as generateKeyPairHex,
     index$2_compressPublicKeyHex as compressPublicKeyHex,
     index$2_utf8ToHex as utf8ToHex,

package/dist/index.js

@@ -49,6 +49,7 @@ __export(sm2_exports, {
   getPoint: () => getPoint,
   getPublicKeyFromPrivateKey: () => getPublicKeyFromPrivateKey,
   hexToArray: () => hexToArray,
+  initRNGPool: () => initRNGPool,
   leftPad: () => leftPad2,
   utf8ToHex: () => utf8ToHex,
   verifyPublicKey: () => verifyPublicKey
@@ -359,11 +360,14 @@ function sm32(input, options) {
 }
 
 // src/sm2/ec.ts
-var DEFAULT_PRNG_POOL_SIZE = 4096;
+var DEFAULT_PRNG_POOL_SIZE = 16384;
 var prngPool = new Uint8Array(0);
-async function FillPRNGPoolIfNeeded() {
-  if ("crypto" in globalThis)
+var _syncCrypto;
+async function initRNGPool() {
+  if ("crypto" in globalThis) {
+    _syncCrypto = globalThis.crypto;
     return;
+  }
   if (prngPool.length > DEFAULT_PRNG_POOL_SIZE / 2)
     return;
   if ("wx" in globalThis) {
@@ -381,29 +385,30 @@ async function FillPRNGPoolIfNeeded() {
         /* webpackIgnore: true */
         "crypto"
       );
+      _syncCrypto = crypto.webcrypto;
       const array = new Uint8Array(DEFAULT_PRNG_POOL_SIZE);
-      crypto.webcrypto.getRandomValues(array);
+      _syncCrypto.getRandomValues(array);
       prngPool = array;
     } catch (error) {
       throw new Error("no available csprng, abort.");
     }
   }
 }
-FillPRNGPoolIfNeeded();
+initRNGPool();
 function consumePool(length) {
   if (prngPool.length > length) {
     const prng = prngPool.slice(0, length);
     prngPool = prngPool.slice(length);
-    FillPRNGPoolIfNeeded();
+    initRNGPool();
     return prng;
   } else {
-    throw new Error("random number pool is insufficient, prevent getting too long random values or too often.");
+    throw new Error("random number pool is not ready or insufficient, prevent getting too long random values or too often.");
   }
 }
 function randomBytes(length = 0) {
   const array = new Uint8Array(length);
-  if ("crypto" in globalThis) {
-    return globalThis.crypto.getRandomValues(array);
+  if (_syncCrypto) {
+    return _syncCrypto.getRandomValues(array);
   } else {
     const result = consumePool(length);
     return result;

package/dist/index.mjs

@@ -21,6 +21,7 @@ __export(sm2_exports, {
   getPoint: () => getPoint,
   getPublicKeyFromPrivateKey: () => getPublicKeyFromPrivateKey,
   hexToArray: () => hexToArray,
+  initRNGPool: () => initRNGPool,
   leftPad: () => leftPad2,
   utf8ToHex: () => utf8ToHex,
   verifyPublicKey: () => verifyPublicKey
@@ -331,11 +332,14 @@ function sm32(input, options) {
 }
 
 // src/sm2/ec.ts
-var DEFAULT_PRNG_POOL_SIZE = 4096;
+var DEFAULT_PRNG_POOL_SIZE = 16384;
 var prngPool = new Uint8Array(0);
-async function FillPRNGPoolIfNeeded() {
-  if ("crypto" in globalThis)
+var _syncCrypto;
+async function initRNGPool() {
+  if ("crypto" in globalThis) {
+    _syncCrypto = globalThis.crypto;
     return;
+  }
   if (prngPool.length > DEFAULT_PRNG_POOL_SIZE / 2)
     return;
   if ("wx" in globalThis) {
@@ -353,29 +357,30 @@ async function FillPRNGPoolIfNeeded() {
         /* webpackIgnore: true */
         "crypto"
       );
+      _syncCrypto = crypto.webcrypto;
       const array = new Uint8Array(DEFAULT_PRNG_POOL_SIZE);
-      crypto.webcrypto.getRandomValues(array);
+      _syncCrypto.getRandomValues(array);
       prngPool = array;
     } catch (error) {
       throw new Error("no available csprng, abort.");
     }
   }
 }
-FillPRNGPoolIfNeeded();
+initRNGPool();
 function consumePool(length) {
   if (prngPool.length > length) {
     const prng = prngPool.slice(0, length);
     prngPool = prngPool.slice(length);
-    FillPRNGPoolIfNeeded();
+    initRNGPool();
     return prng;
   } else {
-    throw new Error("random number pool is insufficient, prevent getting too long random values or too often.");
+    throw new Error("random number pool is not ready or insufficient, prevent getting too long random values or too often.");
   }
 }
 function randomBytes(length = 0) {
   const array = new Uint8Array(length);
-  if ("crypto" in globalThis) {
-    return globalThis.crypto.getRandomValues(array);
+  if (_syncCrypto) {
+    return _syncCrypto.getRandomValues(array);
   } else {
     const result = consumePool(length);
     return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sm-crypto-v2",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "sm-crypto-v2",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/sm2/ec.ts

@@ -19,11 +19,14 @@ declare module wx {
   }): void;
 }
 
-const DEFAULT_PRNG_POOL_SIZE = 4096
+const DEFAULT_PRNG_POOL_SIZE = 16384
 let prngPool = new Uint8Array(0)
-
-async function FillPRNGPoolIfNeeded() {
-  if ('crypto' in globalThis) return // no need to use pooling
+let _syncCrypto: typeof import('crypto')['webcrypto']
+export async function initRNGPool() {
+  if ('crypto' in globalThis) {
+    _syncCrypto = globalThis.crypto
+    return // no need to use pooling
+  }
   if (prngPool.length > DEFAULT_PRNG_POOL_SIZE / 2) return // there is sufficient number
   // we always populate full pool size
   // since numbers may be consumed during micro tasks.
@@ -40,8 +43,9 @@ async function FillPRNGPoolIfNeeded() {
     // check if node, use webcrypto if available
     try {
       const crypto = await import(/* webpackIgnore: true */ 'crypto');
+      _syncCrypto = crypto.webcrypto
       const array = new Uint8Array(DEFAULT_PRNG_POOL_SIZE);
-      crypto.webcrypto.getRandomValues(array);
+      _syncCrypto.getRandomValues(array);
       prngPool = array;
     } catch (error) {
       throw new Error('no available csprng, abort.');
@@ -49,24 +53,25 @@ async function FillPRNGPoolIfNeeded() {
   }
 }
 
-FillPRNGPoolIfNeeded()
+initRNGPool()
 
 function consumePool(length: number): Uint8Array {
   if (prngPool.length > length) {
     const prng = prngPool.slice(0, length)
     prngPool = prngPool.slice(length)
-    FillPRNGPoolIfNeeded()
+    initRNGPool()
     return prng
   } else {
-    throw new Error('random number pool is insufficient, prevent getting too long random values or too often.')
+    throw new Error('random number pool is not ready or insufficient, prevent getting too long random values or too often.')
   }
 }
 
 export function randomBytes(length = 0): Uint8Array {
   const array = new Uint8Array(length);
-  if ('crypto' in globalThis) {
-    return globalThis.crypto.getRandomValues(array);
+  if (_syncCrypto) {
+    return _syncCrypto.getRandomValues(array);
   } else {
+    // no sync crypto available, use async pool
     const result = consumePool(length)
     return result
   }

package/src/sm2/index.ts

@@ -2,12 +2,14 @@
 import { encodeDer, decodeDer } from './asn1'
 import { arrayToHex, arrayToUtf8, concatArray, generateKeyPairHex, hexToArray, leftPad, utf8ToHex } from './utils'
 import { sm3 } from './sm3'
-export * from './utils'
 import * as mod from '@noble/curves/abstract/modular';
 import * as utils from '@noble/curves/abstract/utils';
 import { sm2Curve } from './ec';
 import { ONE, ZERO } from './bn';
 
+export * from './utils'
+export { initRNGPool } from './ec'
+
 // const { G, curve, n } = generateEcparam()
 const C1C2C3 = 0