SM2 (bus-all 5.6.6 API)

java.lang.Object
- org.aoju.bus.crypto.asymmetric.Keys<T>
- - org.aoju.bus.crypto.asymmetric.Safety<SM2>
  - - org.aoju.bus.crypto.asymmetric.SM2

```
public class SM2
extends Safety<SM2>
```
国密SM2算法实现，基于BC库 SM2算法只支持公钥加密，私钥解密

Since:

JDK 1.8+

Version:

5.6.6

Author:

Kimi Liu

Field Summary

Fields
Modifier and Type Field and Description

protected SM2Engine engine

protected org.bouncycastle.crypto.signers.SM2Signer signer
- Fields inherited from class org.aoju.bus.crypto.asymmetric.Keys
  algorithm, lock, privateKey, publicKey

Fields
Modifier and Type	Field and Description
`protected SM2Engine`	`engine`
`protected org.bouncycastle.crypto.signers.SM2Signer`	`signer`

Constructor Summary

Constructors
Constructor and Description
`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)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`decrypt(byte[] data, KeyType keyType)` 解密
`byte[]`	`encrypt(byte[] data, KeyType keyType)` 加密，SM2非对称加密的结果由C1,C2,C3三部分组成，其中：
`SM2`	`init()` 初始化私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密（签名）或者解密（校验）
`SM2`	`initKeys()` 生成公钥和私钥
`SM2`	`setMode(SM2Engine.SM2Mode mode)` 设置加密类型
`SM2`	`setPrivateKey(PrivateKey privateKey)` 设置私钥
`SM2`	`setPublicKey(PublicKey publicKey)` 设置公钥
`byte[]`	`sign(byte[] data)` 用私钥对信息生成数字签名
`byte[]`	`sign(byte[] data, byte[] id)` 用私钥对信息生成数字签名
`boolean`	`verify(byte[] data, byte[] sign)` 用公钥检验数字签名的合法性
`boolean`	`verify(byte[] data, byte[] sign, byte[] id)` 用公钥检验数字签名的合法性

Methods inherited from class org.aoju.bus.crypto.asymmetric.Safety
decrypt, decrypt, decryptFromBcd, decryptFromBcd, decryptStr, decryptStr, decryptStrFromBcd, decryptStrFromBcd, encrypt, encrypt, encrypt, encrypt, encryptBase64, encryptBase64, encryptBase64, encryptBase64, encryptBcd, encryptBcd, encryptHex, encryptHex, encryptHex, encryptHex

Methods inherited from class org.aoju.bus.crypto.asymmetric.Keys
getKeyByType, getPrivateKey, getPrivateKeyBase64, getPublicKey, getPublicKeyBase64, init, setKey

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - engine
```
protected SM2Engine engine
```
  - signer
```
protected org.bouncycastle.crypto.signers.SM2Signer signer
```
- Constructor Detail
  - SM2
```
public SM2()
```
    构造，生成新的私钥公钥对
  - SM2
```
public SM2(String privateKeyStr,
           String publicKeyStr)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKeyStr - 私钥Hex或Base64表示
    
    publicKeyStr - 公钥Hex或Base64表示
  - SM2
```
public SM2(byte[] privateKey,
           byte[] publicKey)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKey - 私钥
    
    publicKey - 公钥
  - SM2
```
public SM2(PrivateKey privateKey,
           PublicKey publicKey)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKey - 私钥
    
    publicKey - 公钥
  - SM2
```
public SM2(String privateKeyHex,
           String publicKeyPointXHex,
           String publicKeyPointYHex)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKeyHex - 私钥16进制
    
    publicKeyPointXHex - 公钥X16进制
    
    publicKeyPointYHex - 公钥Y16进制
  - SM2
```
public SM2(byte[] privateKey,
           byte[] publicKeyPointX,
           byte[] publicKeyPointY)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKey - 私钥
    
    publicKeyPointX - 公钥X
    
    publicKeyPointY - 公钥Y
  - SM2
```
public SM2(org.bouncycastle.crypto.params.ECPrivateKeyParameters privateKeyParams,
           org.bouncycastle.crypto.params.ECPublicKeyParameters publicKeyParams)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKeyParams - 私钥
    
    publicKeyParams - 公钥
- Method Detail
  - init
```
public SM2 init()
```
    初始化私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密（签名）或者解密（校验）
    
    Returns:
    
    this
  - initKeys
```
public SM2 initKeys()
```
    Description copied from class: Keys
    
    生成公钥和私钥
    
    Overrides:
    
    initKeys in class Keys<SM2>
    
    Returns:
    
    this
  - encrypt
```
public byte[] encrypt(byte[] data,
                      KeyType keyType)
               throws InstrumentException
```
    加密，SM2非对称加密的结果由C1,C2,C3三部分组成，其中：
```
 C1 生成随机数的计算出的椭圆曲线点
 C2 密文数据
 C3 SM3的摘要值
 
```
    Specified by:
    
    encrypt in class Safety<SM2>
    
    Parameters:
    
    data - 被加密的bytes
    
    keyType - 私钥或公钥 KeyType
    
    Returns:
    
    加密后的bytes
    
    Throws:
    
    InstrumentException - 包括InvalidKeyException和InvalidCipherTextException的包装异常
  - decrypt
```
public byte[] decrypt(byte[] data,
                      KeyType keyType)
               throws InstrumentException
```
    解密
    
    Specified by:
    
    decrypt in class Safety<SM2>
    
    Parameters:
    
    data - SM2密文，实际包含三部分：ECC公钥、真正的密文、公钥和原文的SM3-HASH值
    
    keyType - 私钥或公钥 KeyType
    
    Returns:
    
    加密后的bytes
    
    Throws:
    
    InstrumentException - 包括InvalidKeyException和InvalidCipherTextException的包装异常
  - sign
```
public byte[] sign(byte[] data)
```
    用私钥对信息生成数字签名
    
    Parameters:
    
    data - 加密数据
    
    Returns:
    
    签名
  - sign
```
public byte[] sign(byte[] data,
                   byte[] id)
```
    用私钥对信息生成数字签名
    
    Parameters:
    
    data - 加密数据
    
    id - 可以为null，若为null，则默认withId为字节数组:"1234567812345678".getBytes()
    
    Returns:
    
    签名
  - verify
```
public boolean verify(byte[] data,
                      byte[] sign)
```
    用公钥检验数字签名的合法性
    
    Parameters:
    
    data - 数据
    
    sign - 签名
    
    Returns:
    
    是否验证通过
  - verify
```
public boolean verify(byte[] data,
                      byte[] sign,
                      byte[] id)
```
    用公钥检验数字签名的合法性
    
    Parameters:
    
    data - 数据
    
    sign - 签名
    
    id - 可以为null，若为null，则默认withId为字节数组:"1234567812345678".getBytes()
    
    Returns:
    
    是否验证通过
  - setPrivateKey
```
public SM2 setPrivateKey(PrivateKey privateKey)
```
    Description copied from class: Keys
    
    设置私钥
    
    Overrides:
    
    setPrivateKey in class Keys<SM2>
    
    Parameters:
    
    privateKey - 私钥
    
    Returns:
    
    this
  - setPublicKey
```
public SM2 setPublicKey(PublicKey publicKey)
```
    Description copied from class: Keys
    
    设置公钥
    
    Overrides:
    
    setPublicKey in class Keys<SM2>
    
    Parameters:
    
    publicKey - 公钥
    
    Returns:
    
    this
  - setMode
```
public SM2 setMode(SM2Engine.SM2Mode mode)
```
    设置加密类型
    
    Parameters:
    
    mode - SM2Engine.SM2Mode
    
    Returns:
    
    this

Class SM2

Field Summary

Fields inherited from class org.aoju.bus.crypto.asymmetric.Keys

Constructor Summary

Method Summary

Methods inherited from class org.aoju.bus.crypto.asymmetric.Safety

Methods inherited from class org.aoju.bus.crypto.asymmetric.Keys

Methods inherited from class java.lang.Object

Field Detail

engine

signer

Constructor Detail

SM2

SM2

SM2

SM2

SM2

SM2

SM2

Method Detail

init

initKeys

encrypt

decrypt

sign

sign

verify

verify

setPrivateKey

setPublicKey

setMode