SM2 (hutool-crypto 5.5.6 API)

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 org.bouncycastle.crypto.engines.SM2Engine engine

protected org.bouncycastle.crypto.signers.SM2Signer signer
- 从类继承的字段 cn.hutool.crypto.asymmetric.BaseAsymmetric
  algorithm, lock, privateKey, publicKey

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

构造器概要

构造器
构造器和说明
`SM2()` 构造，生成新的私钥公钥对
`SM2(byte[] privateKey, byte[] publicKey)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`SM2(byte[] privateKey, byte[] publicKeyPointX, byte[] publicKeyPointY)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`SM2(org.bouncycastle.crypto.params.ECPrivateKeyParameters privateKeyParams, org.bouncycastle.crypto.params.ECPublicKeyParameters publicKeyParams)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`SM2(PrivateKey privateKey, PublicKey publicKey)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`SM2(String privateKeyStr, String publicKeyStr)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`SM2(String privateKeyHex, String publicKeyPointXHex, String publicKeyPointYHex)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`byte[]`	`decrypt(byte[] data, org.bouncycastle.crypto.CipherParameters privateKeyParameters)` 解密
`byte[]`	`decrypt(byte[] data, KeyType keyType)` 解密
`byte[]`	`encrypt(byte[] data, org.bouncycastle.crypto.CipherParameters pubKeyParameters)` 加密，SM2非对称加密的结果由C1,C2,C3三部分组成，其中： C1 生成随机数的计算出的椭圆曲线点 C2 密文数据 C3 SM3的摘要值
`byte[]`	`encrypt(byte[] data, KeyType keyType)` 加密，SM2非对称加密的结果由C1,C2,C3三部分组成，其中： C1 生成随机数的计算出的椭圆曲线点 C2 密文数据 C3 SM3的摘要值
`SM2`	`init()` 初始化私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密（签名）或者解密（校验）
`SM2`	`initKeys()` 生成公钥和私钥
`SM2`	`setDigest(org.bouncycastle.crypto.Digest digest)` 设置Hash算法
`SM2`	`setEncoding(org.bouncycastle.crypto.signers.DSAEncoding encoding)` 设置DSA signatures的编码
`SM2`	`setMode(org.bouncycastle.crypto.engines.SM2Engine.Mode mode)` 设置SM2模式，旧版是C1C2C3，新版本是C1C3C2
`SM2`	`setPrivateKey(PrivateKey privateKey)` 设置私钥
`SM2`	`setPrivateKeyParams(org.bouncycastle.crypto.params.ECPrivateKeyParameters privateKeyParams)` 设置私钥参数
`SM2`	`setPublicKey(PublicKey publicKey)` 设置公钥
`SM2`	`setPublicKeyParams(org.bouncycastle.crypto.params.ECPublicKeyParameters publicKeyParams)` 设置公钥参数
`byte[]`	`sign(byte[] data)` 用私钥对信息生成数字签名
`byte[]`	`sign(byte[] data, byte[] id)` 用私钥对信息生成数字签名
`String`	`signHex(String dataHex)` 用私钥对信息生成数字签名
`String`	`signHex(String dataHex, String idHex)` 用私钥对信息生成数字签名
`SM2`	`usePlainEncoding()` 设置DSA signatures的编码为PlainDSAEncoding
`boolean`	`verify(byte[] data, byte[] sign)` 用公钥检验数字签名的合法性
`boolean`	`verify(byte[] data, byte[] sign, byte[] id)` 用公钥检验数字签名的合法性
`boolean`	`verifyHex(String dataHex, String signHex)` 用公钥检验数字签名的合法性
`boolean`	`verifyHex(String dataHex, String signHex, String idHex)` 用公钥检验数字签名的合法性

从类继承的方法 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, init, setKey

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - engine
```
protected org.bouncycastle.crypto.engines.SM2Engine engine
```
  - signer
```
protected org.bouncycastle.crypto.signers.SM2Signer signer
```
- 构造器详细资料
  - SM2
```
public SM2()
```
    构造，生成新的私钥公钥对
  - SM2
```
public SM2(String privateKeyStr,
           String publicKeyStr)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    参数:
    
    privateKeyStr - 私钥Hex或Base64表示
    
    publicKeyStr - 公钥Hex或Base64表示
  - SM2
```
public SM2(byte[] privateKey,
           byte[] publicKey)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    参数:
    
    privateKey - 私钥
    
    publicKey - 公钥
  - SM2
```
public SM2(PrivateKey privateKey,
           PublicKey publicKey)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    参数:
    
    privateKey - 私钥
    
    publicKey - 公钥
  - SM2
```
public SM2(String privateKeyHex,
           String publicKeyPointXHex,
           String publicKeyPointYHex)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    参数:
    
    privateKeyHex - 私钥16进制
    
    publicKeyPointXHex - 公钥X16进制
    
    publicKeyPointYHex - 公钥Y16进制
    
    从以下版本开始:
    
    5.2.0
  - SM2
```
public SM2(byte[] privateKey,
           byte[] publicKeyPointX,
           byte[] publicKeyPointY)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    参数:
    
    privateKey - 私钥
    
    publicKeyPointX - 公钥X
    
    publicKeyPointY - 公钥Y
    
    从以下版本开始:
    
    5.2.0
  - SM2
```
public SM2(org.bouncycastle.crypto.params.ECPrivateKeyParameters privateKeyParams,
           org.bouncycastle.crypto.params.ECPublicKeyParameters publicKeyParams)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    参数:
    
    privateKeyParams - 私钥
    
    publicKeyParams - 公钥
- 方法详细资料
  - init
```
public SM2 init()
```
    初始化
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密（签名）或者解密（校验）
    
    返回:
    
    this
  - initKeys
```
public SM2 initKeys()
```
    从类复制的说明: BaseAsymmetric
    
    生成公钥和私钥
    
    覆盖:
    
    initKeys 在类中 BaseAsymmetric<SM2>
    
    返回:
    
    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的包装异常
  - encrypt
```
public byte[] encrypt(byte[] data,
                      org.bouncycastle.crypto.CipherParameters pubKeyParameters)
               throws CryptoException
```
    加密，SM2非对称加密的结果由C1,C2,C3三部分组成，其中：
```
 C1 生成随机数的计算出的椭圆曲线点
 C2 密文数据
 C3 SM3的摘要值
 
```
    参数:
    
    data - 被加密的bytes
    
    pubKeyParameters - 公钥参数
    
    返回:
    
    加密后的bytes
    
    抛出:
    
    CryptoException - 包括InvalidKeyException和InvalidCipherTextException的包装异常
    
    从以下版本开始:
    
    5.1.6
  - decrypt
```
public byte[] decrypt(byte[] data,
                      KeyType keyType)
               throws CryptoException
```
    解密
    
    指定者:
    
    decrypt 在类中 AbstractAsymmetricCrypto<SM2>
    
    参数:
    
    data - SM2密文，实际包含三部分：ECC公钥、真正的密文、公钥和原文的SM3-HASH值
    
    keyType - 私钥或公钥 KeyType
    
    返回:
    
    加密后的bytes
    
    抛出:
    
    CryptoException - 包括InvalidKeyException和InvalidCipherTextException的包装异常
  - decrypt
```
public byte[] decrypt(byte[] data,
                      org.bouncycastle.crypto.CipherParameters privateKeyParameters)
               throws CryptoException
```
    解密
    
    参数:
    
    data - SM2密文，实际包含三部分：ECC公钥、真正的密文、公钥和原文的SM3-HASH值
    
    privateKeyParameters - 私钥参数
    
    返回:
    
    加密后的bytes
    
    抛出:
    
    CryptoException - 包括InvalidKeyException和InvalidCipherTextException的包装异常
    
    从以下版本开始:
    
    5.1.6
  - signHex
```
public String signHex(String dataHex)
```
    用私钥对信息生成数字签名
    
    参数:
    
    dataHex - 被签名的数据数据
    
    返回:
    
    签名
  - sign
```
public byte[] sign(byte[] data)
```
    用私钥对信息生成数字签名
    
    参数:
    
    data - 加密数据
    
    返回:
    
    签名
  - signHex
```
public String signHex(String dataHex,
                      String idHex)
```
    用私钥对信息生成数字签名
    
    参数:
    
    dataHex - 被签名的数据数据
    
    idHex - 可以为null，若为null，则默认withId为字节数组:"1234567812345678".getBytes()
    
    返回:
    
    签名
  - sign
```
public byte[] sign(byte[] data,
                   byte[] id)
```
    用私钥对信息生成数字签名
    
    参数:
    
    data - 被签名的数据数据
    
    id - 可以为null，若为null，则默认withId为字节数组:"1234567812345678".getBytes()
    
    返回:
    
    签名
  - verifyHex
```
public boolean verifyHex(String dataHex,
                         String signHex)
```
    用公钥检验数字签名的合法性
    
    参数:
    
    dataHex - 数据签名后的数据
    
    signHex - 签名
    
    返回:
    
    是否验证通过
    
    从以下版本开始:
    
    5.2.0
  - verify
```
public boolean verify(byte[] data,
                      byte[] sign)
```
    用公钥检验数字签名的合法性
    
    参数:
    
    data - 签名后的数据
    
    sign - 签名
    
    返回:
    
    是否验证通过
  - verifyHex
```
public boolean verifyHex(String dataHex,
                         String signHex,
                         String idHex)
```
    用公钥检验数字签名的合法性
    
    参数:
    
    dataHex - 数据签名后的数据的Hex值
    
    signHex - 签名的Hex值
    
    idHex - ID的Hex值
    
    返回:
    
    是否验证通过
    
    从以下版本开始:
    
    5.2.0
  - verify
```
public boolean verify(byte[] data,
                      byte[] sign,
                      byte[] id)
```
    用公钥检验数字签名的合法性
    
    参数:
    
    data - 数据签名后的数据
    
    sign - 签名
    
    id - 可以为null，若为null，则默认withId为字节数组:"1234567812345678".getBytes()
    
    返回:
    
    是否验证通过
  - setPrivateKey
```
public SM2 setPrivateKey(PrivateKey privateKey)
```
    从类复制的说明: BaseAsymmetric
    
    设置私钥
    
    覆盖:
    
    setPrivateKey 在类中 BaseAsymmetric<SM2>
    
    参数:
    
    privateKey - 私钥
    
    返回:
    
    this
  - setPrivateKeyParams
```
public SM2 setPrivateKeyParams(org.bouncycastle.crypto.params.ECPrivateKeyParameters privateKeyParams)
```
    设置私钥参数
    
    参数:
    
    privateKeyParams - 私钥参数
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.2.0
  - setPublicKey
```
public SM2 setPublicKey(PublicKey publicKey)
```
    从类复制的说明: BaseAsymmetric
    
    设置公钥
    
    覆盖:
    
    setPublicKey 在类中 BaseAsymmetric<SM2>
    
    参数:
    
    publicKey - 公钥
    
    返回:
    
    this
  - setPublicKeyParams
```
public SM2 setPublicKeyParams(org.bouncycastle.crypto.params.ECPublicKeyParameters publicKeyParams)
```
    设置公钥参数
    
    参数:
    
    publicKeyParams - 公钥参数
    
    返回:
    
    this
  - usePlainEncoding
```
public SM2 usePlainEncoding()
```
    设置DSA signatures的编码为PlainDSAEncoding
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.3.1
  - setEncoding
```
public SM2 setEncoding(org.bouncycastle.crypto.signers.DSAEncoding encoding)
```
    设置DSA signatures的编码
    
    参数:
    
    encoding - DSAEncoding实现
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.3.1
  - setDigest
```
public SM2 setDigest(org.bouncycastle.crypto.Digest digest)
```
    设置Hash算法
    
    参数:
    
    digest - Digest实现
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.3.1
  - setMode
```
public SM2 setMode(org.bouncycastle.crypto.engines.SM2Engine.Mode mode)
```
    设置SM2模式，旧版是C1C2C3，新版本是C1C3C2
    
    参数:
    
    mode - SM2Engine.Mode
    
    返回:
    
    this

类 SM2

字段概要

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

构造器概要

方法概要

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

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

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

字段详细资料

engine

signer

构造器详细资料

SM2

SM2

SM2

SM2

SM2

SM2

SM2

方法详细资料

init

initKeys

encrypt

encrypt

decrypt

decrypt

signHex

sign

signHex

sign

verifyHex

verify

verifyHex

verify

setPrivateKey

setPrivateKeyParams

setPublicKey

setPublicKeyParams

usePlainEncoding

setEncoding

setDigest

setMode