SmUtil (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.crypto.SmUtil

```
public class SmUtil
extends Object
```
SM国密算法工具类
此工具类依赖org.bouncycastle:bcprov-jdk15to18
封装包括：
- SM2 椭圆曲线非对称加密和签名
- SM3 杂凑算法
- SM4 对称加密
Since:

4.3.2

Author:

looly

Field Summary

Fields
Modifier and Type	Field and Description
`static org.bouncycastle.asn1.ASN1ObjectIdentifier`	`ID_SM2_PUBLIC_KEY_PARAM` SM2国密算法公钥参数的Oid标识
`static String`	`SM2_CURVE_NAME` SM2默认曲线
`static org.bouncycastle.crypto.params.ECDomainParameters`	`SM2_DOMAIN_PARAMS` SM2推荐曲线参数（来自https://github.com/ZZMarquis/gmhelper）

Constructor Summary

Constructors
Constructor and Description

SmUtil()

Constructors
Constructor and Description
`SmUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static byte[]`	`changeC1C2C3ToC1C3C2(byte[] c1c2c3, org.bouncycastle.crypto.params.ECDomainParameters ecDomainParameters)` bc加解密使用旧标c1\|\|c2\|\|c3，此方法在加密后调用，将结果转化为c1\|\|c3\|\|c2
`static byte[]`	`changeC1C3C2ToC1C2C3(byte[] c1c3c2, org.bouncycastle.crypto.params.ECDomainParameters ecDomainParameters)` bc加解密使用旧标c1\|\|c3\|\|c2，此方法在解密前调用，将密文转化为c1\|\|c2\|\|c3再去解密
`static MacEngine`	`createHmacSm3Engine(byte[] key)` 创建HmacSM3算法的`MacEngine`
`static HMac`	`hmacSm3(byte[] key)` HmacSM3算法实现
`static byte[]`	`rsAsn1ToPlain(byte[] rsDer)` BC的SM3withSM2签名得到的结果的rs是asn1格式的，这个方法转化成直接拼接r\|\|s
`static byte[]`	`rsPlainToAsn1(byte[] sign)` BC的SM3withSM2验签需要的rs是asn1格式的，这个方法将直接拼接r\|\|s的字节数组转化成asn1格式
`static SM2`	`sm2()` 创建SM2算法对象生成新的私钥公钥对
`static SM2`	`sm2(byte[] privateKey, byte[] publicKey)` 创建SM2算法对象私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`static SM2`	`sm2(org.bouncycastle.crypto.params.ECPrivateKeyParameters privateKeyParams, org.bouncycastle.crypto.params.ECPublicKeyParameters publicKeyParams)` 创建SM2算法对象私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`static SM2`	`sm2(PrivateKey privateKey, PublicKey publicKey)` 创建SM2算法对象私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`static SM2`	`sm2(String privateKeyStr, String publicKeyStr)` 创建SM2算法对象私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`static SM3`	`sm3()` SM3加密例： SM3加密：sm3().digest(data) SM3加密并转为16进制字符串：sm3().digestHex(data)
`static String`	`sm3(File dataFile)` SM3加密文件，生成16进制SM3字符串
`static String`	`sm3(InputStream data)` SM3加密，生成16进制SM3字符串
`static String`	`sm3(String data)` SM3加密，生成16进制SM3字符串
`static SM3`	`sm3WithSalt(byte[] salt)` SM3加密，可以传入盐
`static SM4`	`sm4()` SM4加密，生成随机KEY。
`static SM4`	`sm4(byte[] key)` SM4加密例： SM4加密：sm4(key).encrypt(data) SM4解密：sm4(key).decrypt(data)

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

- Field Detail
  - SM2_CURVE_NAME
```
public static final String SM2_CURVE_NAME
```
    SM2默认曲线
    
    See Also:
    
    Constant Field Values
  - SM2_DOMAIN_PARAMS
```
public static final org.bouncycastle.crypto.params.ECDomainParameters SM2_DOMAIN_PARAMS
```
    SM2推荐曲线参数（来自https://github.com/ZZMarquis/gmhelper）
  - ID_SM2_PUBLIC_KEY_PARAM
```
public static final org.bouncycastle.asn1.ASN1ObjectIdentifier ID_SM2_PUBLIC_KEY_PARAM
```
    SM2国密算法公钥参数的Oid标识
- Constructor Detail
  - SmUtil
```
public SmUtil()
```
- Method Detail
  - sm2
```
public static SM2 sm2()
```
    创建SM2算法对象
    生成新的私钥公钥对
    
    Returns:
    
    SM2
  - sm2
```
public static SM2 sm2(String privateKeyStr,
                      String publicKeyStr)
```
    创建SM2算法对象
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKeyStr - 私钥Hex或Base64表示
    
    publicKeyStr - 公钥Hex或Base64表示
    
    Returns:
    
    SM2
  - sm2
```
public static SM2 sm2(byte[] privateKey,
                      byte[] publicKey)
```
    创建SM2算法对象
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKey - 私钥，必须使用PKCS#8规范
    
    publicKey - 公钥，必须使用X509规范
    
    Returns:
    
    SM2
  - sm2
```
public static SM2 sm2(PrivateKey privateKey,
                      PublicKey publicKey)
```
    创建SM2算法对象
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKey - 私钥
    
    publicKey - 公钥
    
    Returns:
    
    SM2
    
    Since:
    
    5.5.9
  - sm2
```
public static SM2 sm2(org.bouncycastle.crypto.params.ECPrivateKeyParameters privateKeyParams,
                      org.bouncycastle.crypto.params.ECPublicKeyParameters publicKeyParams)
```
    创建SM2算法对象
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKeyParams - 私钥参数
    
    publicKeyParams - 公钥参数
    
    Returns:
    
    SM2
    
    Since:
    
    5.5.9
  - sm3
```
public static SM3 sm3()
```
    SM3加密
    例：
    SM3加密：sm3().digest(data)
    SM3加密并转为16进制字符串：sm3().digestHex(data)
    
    Returns:
    
    SM3
  - sm3WithSalt
```
public static SM3 sm3WithSalt(byte[] salt)
```
    SM3加密，可以传入盐
    
    Parameters:
    
    salt - 加密盐
    
    Returns:
    
    SM3
    
    Since:
    
    5.7.16
  - sm3
```
public static String sm3(String data)
```
    SM3加密，生成16进制SM3字符串
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    SM3字符串
  - sm3
```
public static String sm3(InputStream data)
```
    SM3加密，生成16进制SM3字符串
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    SM3字符串
  - sm3
```
public static String sm3(File dataFile)
```
    SM3加密文件，生成16进制SM3字符串
    
    Parameters:
    
    dataFile - 被加密文件
    
    Returns:
    
    SM3字符串
  - sm4
```
public static SM4 sm4()
```
    SM4加密，生成随机KEY。注意解密时必须使用相同 SymmetricCrypto对象或者使用相同KEY
    例：
```
 SM4加密：sm4().encrypt(data)
 SM4解密：sm4().decrypt(data)
 
```
    Returns:
    
    SymmetricCrypto
  - sm4
```
public static SM4 sm4(byte[] key)
```
    SM4加密
    例：
```
 SM4加密：sm4(key).encrypt(data)
 SM4解密：sm4(key).decrypt(data)
 
```
    Parameters:
    
    key - 密钥
    
    Returns:
    
    SM4
  - changeC1C2C3ToC1C3C2
```
public static byte[] changeC1C2C3ToC1C3C2(byte[] c1c2c3,
                                          org.bouncycastle.crypto.params.ECDomainParameters ecDomainParameters)
```
    bc加解密使用旧标c1||c2||c3，此方法在加密后调用，将结果转化为c1||c3||c2
    
    Parameters:
    
    c1c2c3 - 加密后的bytes，顺序为C1C2C3
    
    ecDomainParameters - ECDomainParameters
    
    Returns:
    
    加密后的bytes，顺序为C1C3C2
  - changeC1C3C2ToC1C2C3
```
public static byte[] changeC1C3C2ToC1C2C3(byte[] c1c3c2,
                                          org.bouncycastle.crypto.params.ECDomainParameters ecDomainParameters)
```
    bc加解密使用旧标c1||c3||c2，此方法在解密前调用，将密文转化为c1||c2||c3再去解密
    
    Parameters:
    
    c1c3c2 - 加密后的bytes，顺序为C1C3C2
    
    ecDomainParameters - ECDomainParameters
    
    Returns:
    
    c1c2c3 加密后的bytes，顺序为C1C2C3
  - rsAsn1ToPlain
```
public static byte[] rsAsn1ToPlain(byte[] rsDer)
```
    BC的SM3withSM2签名得到的结果的rs是asn1格式的，这个方法转化成直接拼接r||s
    
    Parameters:
    
    rsDer - rs in asn1 format
    
    Returns:
    
    sign result in plain byte array
    
    Since:
    
    4.5.0
  - rsPlainToAsn1
```
public static byte[] rsPlainToAsn1(byte[] sign)
```
    BC的SM3withSM2验签需要的rs是asn1格式的，这个方法将直接拼接r||s的字节数组转化成asn1格式
    
    Parameters:
    
    sign - in plain byte array
    
    Returns:
    
    rs result in asn1 format
    
    Since:
    
    4.5.0
  - createHmacSm3Engine
```
public static MacEngine createHmacSm3Engine(byte[] key)
```
    创建HmacSM3算法的MacEngine
    
    Parameters:
    
    key - 密钥
    
    Returns:
    
    MacEngine
    
    Since:
    
    4.5.13
  - hmacSm3
```
public static HMac hmacSm3(byte[] key)
```
    HmacSM3算法实现
    
    Parameters:
    
    key - 密钥
    
    Returns:
    
    HMac 对象，调用digestXXX即可
    
    Since:
    
    4.5.13

Class SmUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SM2_CURVE_NAME

SM2_DOMAIN_PARAMS

ID_SM2_PUBLIC_KEY_PARAM

Constructor Detail

SmUtil

Method Detail

sm2

sm2

sm2

sm2

sm2

sm3

sm3WithSalt

sm3

sm3

sm3

sm4

sm4

changeC1C2C3ToC1C3C2

changeC1C3C2ToC1C2C3

rsAsn1ToPlain

rsPlainToAsn1

createHmacSm3Engine

hmacSm3