cn.hutool.crypto.asymmetric

类 SM2

java.lang.Object

cn.hutool.crypto.asymmetric.BaseAsymmetric<T>

cn.hutool.crypto.asymmetric.AbstractAsymmetricCrypto<SM2>

cn.hutool.crypto.asymmetric.SM2

public class SM2
extends AbstractAsymmetricCrypto<SM2>

国密SM2算法实现，基于BC库
SM2算法只支持公钥加密，私钥解密
参考：https://blog.csdn.net/pridas/article/details/86118774

从以下版本开始:

4.3.2

作者:

looly

字段概要

字段

限定符和类型	字段和说明
protected SM2Engine	engine
protected org.bouncycastle.crypto.signers.SM2Signer	signer

从类继承的字段 cn.hutool.crypto.asymmetric.BaseAsymmetric

algorithm, lock, privateKey, publicKey

构造器概要

构造器

构造器和说明
SM2() 构造，生成新的私钥公钥对
SM2(byte[] privateKey, byte[] publicKey) 构造 私钥和公钥同时为空时生成一对新的私钥和公钥 私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
SM2(java.security.PrivateKey privateKey, java.security.PublicKey publicKey) 构造 私钥和公钥同时为空时生成一对新的私钥和公钥 私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
SM2(java.lang.String privateKeyStr, java.lang.String publicKeyStr) 构造 私钥和公钥同时为空时生成一对新的私钥和公钥 私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密

方法概要

方法

限定符和类型	方法和说明
byte[]	decrypt(byte[] data, KeyType keyType) 解密
byte[]	encrypt(byte[] data, KeyType keyType) 加密，SM2非对称加密的结果由C1,C2,C3三部分组成，其中： C1 生成随机数的计算出的椭圆曲线点 C2 密文数据 C3 SM3的摘要值
SM2	init(java.security.PrivateKey privateKey, java.security.PublicKey publicKey) 初始化 私钥和公钥同时为空时生成一对新的私钥和公钥 私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密（签名）或者解密（校验）
protected SM2	init(java.lang.String algorithm, java.security.PrivateKey privateKey, java.security.PublicKey publicKey) 初始化 私钥和公钥同时为空时生成一对新的私钥和公钥 私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密（签名）或者解密（校验）
SM2	setMode(SM2Engine.SM2Mode mode) 设置加密类型
byte[]	sign(byte[] data) 用私钥对信息生成数字签名
byte[]	sign(byte[] data, byte[] id) 用私钥对信息生成数字签名
boolean	verify(byte[] data, byte[] sign) 用公钥检验数字签名的合法性
boolean	verify(byte[] data, byte[] sign, byte[] id) 用公钥检验数字签名的合法性

从类继承的方法 cn.hutool.crypto.asymmetric.AbstractAsymmetricCrypto

decrypt, decrypt, decryptFromBcd, decryptFromBcd, decryptStr, decryptStr, decryptStrFromBcd, decryptStrFromBcd, encrypt, encrypt, encrypt, encrypt, encryptBase64, encryptBase64, encryptBase64, encryptBase64, encryptBcd, encryptBcd, encryptHex, encryptHex, encryptHex, encryptHex

从类继承的方法 cn.hutool.crypto.asymmetric.BaseAsymmetric

getKeyByType, getPrivateKey, getPrivateKeyBase64, getPublicKey, getPublicKeyBase64, initKeys, setPrivateKey, setPublicKey

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

engine

protected SM2Engine engine

signer

protected org.bouncycastle.crypto.signers.SM2Signer signer

构造器详细资料

SM2

public SM2()

构造，生成新的私钥公钥对

SM2

public SM2(java.lang.String privateKeyStr,
   java.lang.String publicKeyStr)

构造
私钥和公钥同时为空时生成一对新的私钥和公钥
私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密

参数:

privateKeyStr - 私钥Hex或Base64表示

publicKeyStr - 公钥Hex或Base64表示

SM2

public SM2(byte[] privateKey,
   byte[] publicKey)

构造
私钥和公钥同时为空时生成一对新的私钥和公钥
私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密

参数:

privateKey - 私钥

publicKey - 公钥

SM2

public SM2(java.security.PrivateKey privateKey,
   java.security.PublicKey publicKey)

构造
私钥和公钥同时为空时生成一对新的私钥和公钥
私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密

参数:

privateKey - 私钥

publicKey - 公钥

方法详细资料

init

public SM2 init(java.security.PrivateKey privateKey,
       java.security.PublicKey publicKey)

初始化
私钥和公钥同时为空时生成一对新的私钥和公钥
私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密（签名）或者解密（校验）

参数:

privateKey - 私钥

publicKey - 公钥

返回:

this

init

protected SM2 init(java.lang.String algorithm,
       java.security.PrivateKey privateKey,
       java.security.PublicKey publicKey)

从类复制的说明: BaseAsymmetric

初始化
私钥和公钥同时为空时生成一对新的私钥和公钥
私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密（签名）或者解密（校验）

覆盖:

init 在类中 BaseAsymmetric<SM2>

参数:

algorithm - 算法

privateKey - 私钥

publicKey - 公钥

返回:

this

encrypt

public byte[] encrypt(byte[] data,
             KeyType keyType)
               throws CryptoException

加密，SM2非对称加密的结果由C1,C2,C3三部分组成，其中：

 C1 生成随机数的计算出的椭圆曲线点
 C2 密文数据
 C3 SM3的摘要值
 

指定者:

encrypt 在类中 AbstractAsymmetricCrypto<SM2>

参数:

data - 被加密的bytes

keyType - 私钥或公钥 KeyType

返回:

加密后的bytes

抛出:

CryptoException - 包括InvalidKeyException和InvalidCipherTextException的包装异常

decrypt

public byte[] decrypt(byte[] data,
             KeyType keyType)
               throws CryptoException

解密

指定者:

decrypt 在类中 AbstractAsymmetricCrypto<SM2>

参数:

data - SM2密文，实际包含三部分：ECC公钥、真正的密文、公钥和原文的SM3-HASH值

keyType - 私钥或公钥 KeyType

返回:

加密后的bytes

抛出:

CryptoException - 包括InvalidKeyException和InvalidCipherTextException的包装异常

sign

public byte[] sign(byte[] data)

用私钥对信息生成数字签名

参数:

data - 加密数据

返回:

签名

sign

public byte[] sign(byte[] data,
          byte[] id)

用私钥对信息生成数字签名

参数:

data - 加密数据

id - 可以为null，若为null，则默认withId为字节数组:"1234567812345678".getBytes()

返回:

签名

verify

public boolean verify(byte[] data,
             byte[] sign)

用公钥检验数字签名的合法性

参数:

data - 数据

sign - 签名

返回:

是否验证通过

verify

public boolean verify(byte[] data,
             byte[] sign,
             byte[] id)

用公钥检验数字签名的合法性

参数:

data - 数据

sign - 签名

id - 可以为null，若为null，则默认withId为字节数组:"1234567812345678".getBytes()

返回:

是否验证通过

setMode

public SM2 setMode(SM2Engine.SM2Mode mode)

设置加密类型

参数:

mode - SM2Engine.SM2Mode

返回:

this