From 3c79883c6e35847b7c7901c5f31e48b16e5ec508 Mon Sep 17 00:00:00 2001 From: Sun Yimin Date: Tue, 23 Apr 2024 16:47:05 +0800 Subject: [PATCH] update README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b4adc3..c2fd84f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -# sm2js +# sm2js (jsrsasign-sm) [![SM2JS CI](https://github.com/emmansun/sm2js/actions/workflows/ci.yml/badge.svg)](https://github.com/emmansun/sm2js/actions/workflows/ci.yml) [![npm version](https://badge.fury.io/js/gmsm-sm2js.svg)](https://badge.fury.io/js/gmsm-sm2js) [![NPM Downloads][npm-downloads-image]][npm-url] **sm2js is a pure Javascript implementation of the GM-Standards SM2 (also support sm3/sm4) based on [jsrsasign](https://github.com/kjur/jsrsasign).** +您也可以参考另外一个实现：[sjcl-sm](https://github.com/emmansun/sm4js)。 + ## SM2 - sign/verify functions (Passed integration test with ALI KMS) @@ -20,7 +22,7 @@ For usage, please reference [sm2_test.js](https://github.com/emmansun/sm2js/blob **SM3**使用比较简单，请参考[cryptojs_sm3_test.js](https://github.com/emmansun/sm2js/blob/master/src/cryptojs_sm3_test.js "cryptojs_sm3_test.js")。单独的**SM3**实现，可以参考[gmsm-sm3js](https://github.com/emmansun/sm3js)。 ## SM4 -[jsrsasign](https://github.com/kjur/jsrsasign) 内嵌了[crypto-js](https://github.com/brix/crypto-js)的剪裁版本，只支持默认的**CBC**模式和**PKCS7填充**模式（本实现为了测试，添加了ECB模式和无填充填充模式）。本**SM4**实现同时实现了[sjcl](https://github.com/bitwiseshiftleft/sjcl)所需方法，所以可以和sjcl支持的加密模式一起使用。具体使用方法，请参考[cryptojs_sm4_test.js](https://github.com/emmansun/sm2js/blob/master/src/cryptojs_sm4_test.js "cryptojs_sm4_test.js")。当然，把本**SM4**实现和独立的[crypto-js](https://github.com/brix/crypto-js)结合使用也是可以的。单独的**SM4**实现，可以参考[gmsm-sm4js](https://github.com/emmansun/sm4js)。 +[jsrsasign](https://github.com/kjur/jsrsasign) 内嵌了[crypto-js](https://github.com/brix/crypto-js)的剪裁版本，只支持默认的**CBC**模式和**PKCS7填充**模式（本实现为了测试，添加了ECB模式和无填充填充模式）。本**SM4**实现同时实现了[sjcl](https://github.com/bitwiseshiftleft/sjcl)所需方法，所以可以和sjcl支持的加密模式一起使用。具体使用方法，请参考[cryptojs_sm4_test.js](https://github.com/emmansun/sm2js/blob/master/src/cryptojs_sm4_test.js "cryptojs_sm4_test.js")。当然，把本**SM4**实现和独立的[crypto-js](https://github.com/brix/crypto-js)结合使用也是可以的。 在NodeJS环境下，修改过的```KJUR.crypto.Cipher.encrypt```和```KJUR.crypto.Cipher.decrypt```会优先使用NodeJS Native实现，这两个方法目前只支持以下模式： - aes128-CBC