fix: sm2 sign/verify function hash=true by default

Author: junrangao

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.0
+
+* sm2 签名/验签函数参数 `hash` 默认为 `true`
+
 ## 0.3.14
 
 * 完善 sm2 解密和验签时的逻辑

README.md

@@ -51,13 +51,19 @@ decryptData = sm2.doDecrypt(encryptData, privateKey, cipherMode, {output: 'array
 ### 签名验签
 
 > ps：理论上来说，只做纯签名是最快的。
+> 
+> ps：`hash` 参数默认为 `true`，即默认会做 sm3 杂凑。如需纯签名（不做杂凑），请显式传入 `hash: false`。
 
 ```js
 const sm2 = require('sm-crypto').sm2
 
-// 纯签名 + 生成椭圆曲线点
-let sigValueHex = sm2.doSignature(msg, privateKey) // 签名
-let verifyResult = sm2.doVerifySignature(msg, sigValueHex, publicKey) // 验签结果
+// 纯签名 + 生成椭圆曲线点（不做sm3杂凑）
+let sigValueHex = sm2.doSignature(msg, privateKey, {
+    hash: false,
+}) // 签名
+let verifyResult = sm2.doVerifySignature(msg, sigValueHex, publicKey, {
+    hash: false,
+}) // 验签结果
 
 // 纯签名
 let sigValueHex2 = sm2.doSignature(msg, privateKey, {
@@ -73,33 +79,23 @@ let verifyResult3 = sm2.doVerifySignature(msg, sigValueHex3, publicKey, {
     der: true,
 }) // 验签结果
 
-// 纯签名 + 生成椭圆曲线点 + sm3杂凑
-let sigValueHex4 = sm2.doSignature(msg, privateKey, {
-    hash: true,
-}) // 签名
-let verifyResult4 = sm2.doVerifySignature(msg, sigValueHex4, publicKey, {
-    hash: true,
-}) // 验签结果
+// sm3杂凑（默认行为）
+let sigValueHex4 = sm2.doSignature(msg, privateKey)
+let verifyResult4 = sm2.doVerifySignature(msg, sigValueHex4, publicKey) // 验签结果
 
-// 纯签名 + 生成椭圆曲线点 + sm3杂凑（不做公钥推导）
+// sm3杂凑（不做公钥推导）
 let sigValueHex5 = sm2.doSignature(msg, privateKey, {
-    hash: true,
-    publicKey, // 传入公钥的话，可以去掉sm3杂凑中推导公钥的过程，速度会比纯签名 + 生成椭圆曲线点 + sm3杂凑快
-})
-let verifyResult5 = sm2.doVerifySignature(msg, sigValueHex5, publicKey, {
-    hash: true,
-    publicKey,
+    publicKey, // 传入公钥的话，可以去掉sm3杂凑中推导公钥的过程，速度更快
 })
+let verifyResult5 = sm2.doVerifySignature(msg, sigValueHex5, publicKey)
 
-// 纯签名 + 生成椭圆曲线点 + sm3杂凑 + 不做公钥推 + 添加 userId（长度小于 8192）
+// sm3杂凑 + 不做公钥推导 + 添加 userId（长度小于 8192）
 // 默认 userId 值为 1234567812345678
 let sigValueHex6 = sm2.doSignature(msgString, privateKey, {
-    hash: true,
     publicKey,
     userId: 'testUserId',
 })
 let verifyResult6 = sm2.doVerifySignature(msgString, sigValueHex6, publicKey, {
-    hash: true,
     userId: 'testUserId',
 })
 ```

dist/sm2.js

@@ -1,6 +1,6 @@
 {
   "name": "sm-crypto",
-  "version": "0.3.14",
+  "version": "0.4.0",
   "description": "sm-crypto",
   "main": "src/index.js",
   "scripts": {

package.json

@@ -116,7 +116,7 @@ function doDecrypt(encryptData, privateKey, cipherMode = 1, {
  * 签名
  */
 function doSignature(msg, privateKey, {
-  pointPool, der, hash, publicKey, userId
+  pointPool, der, hash = true, publicKey, userId
 } = {}) {
   let hashHex = typeof msg === 'string' ? _.utf8ToHex(msg) : _.arrayToHex(msg)
 
@@ -160,7 +160,7 @@ function doSignature(msg, privateKey, {
 /**
  * 验签
  */
-function doVerifySignature(msg, signHex, publicKey, {der, hash, userId} = {}) {
+function doVerifySignature(msg, signHex, publicKey, {der, hash = true, userId} = {}) {
   let hashHex = typeof msg === 'string' ? _.utf8ToHex(msg) : _.arrayToHex(msg)
 
   if (hash) {