SecureUtil (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.crypto.SecureUtil

```
public class SecureUtil
extends Object
```
安全相关工具类
加密分为三种：
1、对称加密（symmetric），例如：AES、DES等
2、非对称加密（asymmetric），例如：RSA、DSA等
3、摘要加密（digest），例如：MD5、SHA-1、SHA-256、HMAC等

Author:

Looly, Gsealy

Field Summary

Fields
Modifier and Type Field and Description

static String HUTOOL_CRYPTO_DECODE_HEX
Hutool自定义系统属性：是否解码Hex字符 issue#I90M9D

Fields
Modifier and Type	Field and Description
`static String`	`HUTOOL_CRYPTO_DECODE_HEX` Hutool自定义系统属性：是否解码Hex字符 issue#I90M9D

Constructor Summary

Constructors
Constructor and Description

SecureUtil()

Constructors
Constructor and Description
`SecureUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addProvider(Provider provider)` 增加加密解密的算法提供者，默认优先使用，例如： addProvider(new org.bouncycastle.jce.provider.BouncyCastleProvider());
`static AES`	`aes()` AES加密，生成随机KEY。
`static AES`	`aes(byte[] key)` AES加密例： AES加密：aes(key).encrypt(data) AES解密：aes(key).decrypt(data)
`static Cipher`	`createCipher(String algorithm)` 创建`Cipher` 当provider为`null`时，使用`GlobalProviderFactory`查找提供方，找不到使用JDK默认提供方。
`static MessageDigest`	`createJdkMessageDigest(String algorithm)` 创建`MessageDigest`，使用JDK默认的Provider
`static Mac`	`createMac(String algorithm)` 创建`Mac`
`static MessageDigest`	`createMessageDigest(String algorithm, Provider provider)` 创建`MessageDigest` 当provider为`null`时，使用`GlobalProviderFactory`查找提供方，找不到使用JDK默认提供方。
`static byte[]`	`decode(String key)` 解码字符串密钥，可支持的编码如下： 1.
`static DES`	`des()` DES加密，生成随机KEY。
`static DES`	`des(byte[] key)` DES加密例： DES加密：des(key).encrypt(data) DES解密：des(key).decrypt(data)
`static DESede`	`desede()` DESede加密（又名3DES、TripleDES），生成随机KEY。
`static DESede`	`desede(byte[] key)` DESede加密（又名3DES、TripleDES） Java中默认实现为：DESede/ECB/PKCS5Padding 例： DESede加密：desede(key).encrypt(data) DESede解密：desede(key).decrypt(data)
`static void`	`disableCustomProvider()` 强制关闭自定义`Provider`的使用，如Bouncy Castle库，全局有效
`static FPE`	`fpe(FPE.FPEMode mode, byte[] key, org.bouncycastle.crypto.AlphabetMapper mapper, byte[] tweak)` FPE(Format Preserving Encryption)实现，支持FF1和FF3-1模式。
`static String`	`generateAlgorithm(AsymmetricAlgorithm asymmetricAlgorithm, DigestAlgorithm digestAlgorithm)` 生成算法，格式为XXXwithXXX
`static HMac`	`hmac(HmacAlgorithm algorithm, byte[] key)` 创建HMac对象，调用digest方法可获得hmac值
`static HMac`	`hmac(HmacAlgorithm algorithm, SecretKey key)` 创建HMac对象，调用digest方法可获得hmac值
`static HMac`	`hmac(HmacAlgorithm algorithm, String key)` 创建HMac对象，调用digest方法可获得hmac值
`static HMac`	`hmacMd5()` HmacMD5加密器，生成随机KEY 例： HmacMD5加密：hmacMd5().digest(data) HmacMD5加密并转为16进制字符串：hmacMd5().digestHex(data)
`static HMac`	`hmacMd5(byte[] key)` HmacMD5加密器例： HmacMD5加密：hmacMd5(key).digest(data) HmacMD5加密并转为16进制字符串：hmacMd5(key).digestHex(data)
`static HMac`	`hmacMd5(String key)` HmacMD5加密器例： HmacMD5加密：hmacMd5(key).digest(data) HmacMD5加密并转为16进制字符串：hmacMd5(key).digestHex(data)
`static HMac`	`hmacSha1()` HmacSHA1加密器，生成随机KEY 例： HmacSHA1加密：hmacSha1().digest(data) HmacSHA1加密并转为16进制字符串：hmacSha1().digestHex(data)
`static HMac`	`hmacSha1(byte[] key)` HmacSHA1加密器例： HmacSHA1加密：hmacSha1(key).digest(data) HmacSHA1加密并转为16进制字符串：hmacSha1(key).digestHex(data)
`static HMac`	`hmacSha1(String key)` HmacSHA1加密器例： HmacSHA1加密：hmacSha1(key).digest(data) HmacSHA1加密并转为16进制字符串：hmacSha1(key).digestHex(data)
`static HMac`	`hmacSha256()` HmacSHA256加密器，生成随机KEY 例： HmacSHA256加密：hmacSha256().digest(data) HmacSHA256加密并转为16进制字符串：hmacSha256().digestHex(data)
`static HMac`	`hmacSha256(byte[] key)` HmacSHA256加密器例： HmacSHA256加密：hmacSha256(key).digest(data) HmacSHA256加密并转为16进制字符串：hmacSha256(key).digestHex(data)
`static HMac`	`hmacSha256(String key)` HmacSHA256加密器例： HmacSHA256加密：hmacSha256(key).digest(data) HmacSHA256加密并转为16进制字符串：hmacSha256(key).digestHex(data)
`static MD5`	`md5()` MD5加密例： MD5加密：md5().digest(data) MD5加密并转为16进制字符串：md5().digestHex(data)
`static String`	`md5(File dataFile)` MD5加密文件，生成16进制MD5字符串
`static String`	`md5(InputStream data)` MD5加密，生成16进制MD5字符串
`static String`	`md5(String data)` MD5加密，生成16进制MD5字符串
`static String`	`pbkdf2(char[] password, byte[] salt)` PBKDF2加密密码
`static SymmetricCrypto`	`rc4(byte[] key)` RC4算法
`static RSA`	`rsa()` 创建RSA算法对象生成新的私钥公钥对
`static RSA`	`rsa(byte[] privateKey, byte[] publicKey)` 创建RSA算法对象私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`static RSA`	`rsa(String privateKeyBase64, String publicKeyBase64)` 创建RSA算法对象私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`static Digester`	`sha1()` SHA1加密例： SHA1加密：sha1().digest(data) SHA1加密并转为16进制字符串：sha1().digestHex(data)
`static String`	`sha1(File dataFile)` SHA1加密文件，生成16进制SHA1字符串
`static String`	`sha1(InputStream data)` SHA1加密，生成16进制SHA1字符串
`static String`	`sha1(String data)` SHA1加密，生成16进制SHA1字符串
`static Digester`	`sha256()` SHA256加密例： SHA256加密：sha256().digest(data) SHA256加密并转为16进制字符串：sha256().digestHex(data)
`static String`	`sha256(File dataFile)` SHA256加密文件，生成16进制SHA256字符串
`static String`	`sha256(InputStream data)` SHA256加密，生成16进制SHA256字符串
`static String`	`sha256(String data)` SHA256加密，生成16进制SHA256字符串
`static ZUC`	`zuc128(byte[] key, byte[] iv)` 祖冲之算法集（ZUC-128算法）实现，基于BouncyCastle实现。
`static ZUC`	`zuc256(byte[] key, byte[] iv)` 祖冲之算法集（ZUC-256算法）实现，基于BouncyCastle实现。

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

- Field Detail
  - HUTOOL_CRYPTO_DECODE_HEX
```
public static String HUTOOL_CRYPTO_DECODE_HEX
```
    Hutool自定义系统属性：是否解码Hex字符 issue#I90M9D
- Constructor Detail
  - SecureUtil
```
public SecureUtil()
```
- Method Detail
  - generateAlgorithm
```
public static String generateAlgorithm(AsymmetricAlgorithm asymmetricAlgorithm,
                                       DigestAlgorithm digestAlgorithm)
```
    生成算法，格式为XXXwithXXX
    
    Parameters:
    
    asymmetricAlgorithm - 非对称算法
    
    digestAlgorithm - 摘要算法
    
    Returns:
    
    算法
    
    Since:
    
    4.4.1
  - aes
```
public static AES aes()
```
    AES加密，生成随机KEY。注意解密时必须使用相同 AES对象或者使用相同KEY
    例：
```
 AES加密：aes().encrypt(data)
 AES解密：aes().decrypt(data)
 
```
    Returns:
    
    AES
  - aes
```
public static AES aes(byte[] key)
```
    AES加密
    例：
```
 AES加密：aes(key).encrypt(data)
 AES解密：aes(key).decrypt(data)
 
```
    Parameters:
    
    key - 密钥
    
    Returns:
    
    SymmetricCrypto
  - des
```
public static DES des()
```
    DES加密，生成随机KEY。注意解密时必须使用相同 DES对象或者使用相同KEY
    例：
```
 DES加密：des().encrypt(data)
 DES解密：des().decrypt(data)
 
```
    Returns:
    
    DES
  - des
```
public static DES des(byte[] key)
```
    DES加密
    例：
```
 DES加密：des(key).encrypt(data)
 DES解密：des(key).decrypt(data)
 
```
    Parameters:
    
    key - 密钥
    
    Returns:
    
    DES
  - desede
```
public static DESede desede()
```
    DESede加密（又名3DES、TripleDES），生成随机KEY。注意解密时必须使用相同 DESede对象或者使用相同KEY
    Java中默认实现为：DESede/ECB/PKCS5Padding
    例：
```
 DESede加密：desede().encrypt(data)
 DESede解密：desede().decrypt(data)
 
```
    Returns:
    
    DESede
    
    Since:
    
    3.3.0
  - desede
```
public static DESede desede(byte[] key)
```
    DESede加密（又名3DES、TripleDES）
    Java中默认实现为：DESede/ECB/PKCS5Padding
    例：
```
 DESede加密：desede(key).encrypt(data)
 DESede解密：desede(key).decrypt(data)
 
```
    Parameters:
    
    key - 密钥
    
    Returns:
    
    DESede
    
    Since:
    
    3.3.0
  - md5
```
public static MD5 md5()
```
    MD5加密
    例：
```
 MD5加密：md5().digest(data)
 MD5加密并转为16进制字符串：md5().digestHex(data)
 
```
    Returns:
    
    Digester
  - md5
```
public static String md5(String data)
```
    MD5加密，生成16进制MD5字符串
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    MD5字符串
  - md5
```
public static String md5(InputStream data)
```
    MD5加密，生成16进制MD5字符串
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    MD5字符串
  - md5
```
public static String md5(File dataFile)
```
    MD5加密文件，生成16进制MD5字符串
    
    Parameters:
    
    dataFile - 被加密文件
    
    Returns:
    
    MD5字符串
  - sha1
```
public static Digester sha1()
```
    SHA1加密
    例：
    SHA1加密：sha1().digest(data)
    SHA1加密并转为16进制字符串：sha1().digestHex(data)
    
    Returns:
    
    Digester
  - sha1
```
public static String sha1(String data)
```
    SHA1加密，生成16进制SHA1字符串
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    SHA1字符串
  - sha1
```
public static String sha1(InputStream data)
```
    SHA1加密，生成16进制SHA1字符串
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    SHA1字符串
  - sha1
```
public static String sha1(File dataFile)
```
    SHA1加密文件，生成16进制SHA1字符串
    
    Parameters:
    
    dataFile - 被加密文件
    
    Returns:
    
    SHA1字符串
  - sha256
```
public static Digester sha256()
```
    SHA256加密
    例：
    SHA256加密：sha256().digest(data)
    SHA256加密并转为16进制字符串：sha256().digestHex(data)
    
    Returns:
    
    Digester
    
    Since:
    
    4.3.2
  - sha256
```
public static String sha256(String data)
```
    SHA256加密，生成16进制SHA256字符串
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    SHA256字符串
    
    Since:
    
    4.3.2
  - sha256
```
public static String sha256(InputStream data)
```
    SHA256加密，生成16进制SHA256字符串
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    SHA1字符串
    
    Since:
    
    4.3.2
  - sha256
```
public static String sha256(File dataFile)
```
    SHA256加密文件，生成16进制SHA256字符串
    
    Parameters:
    
    dataFile - 被加密文件
    
    Returns:
    
    SHA256字符串
    
    Since:
    
    4.3.2
  - hmac
```
public static HMac hmac(HmacAlgorithm algorithm,
                        String key)
```
    创建HMac对象，调用digest方法可获得hmac值
    
    Parameters:
    
    algorithm - HmacAlgorithm
    
    key - 密钥，如果为null生成随机密钥
    
    Returns:
    
    HMac
    
    Since:
    
    3.3.0
  - hmac
```
public static HMac hmac(HmacAlgorithm algorithm,
                        byte[] key)
```
    创建HMac对象，调用digest方法可获得hmac值
    
    Parameters:
    
    algorithm - HmacAlgorithm
    
    key - 密钥，如果为null生成随机密钥
    
    Returns:
    
    HMac
    
    Since:
    
    3.0.3
  - hmac
```
public static HMac hmac(HmacAlgorithm algorithm,
                        SecretKey key)
```
    创建HMac对象，调用digest方法可获得hmac值
    
    Parameters:
    
    algorithm - HmacAlgorithm
    
    key - 密钥SecretKey，如果为null生成随机密钥
    
    Returns:
    
    HMac
    
    Since:
    
    3.0.3
  - hmacMd5
```
public static HMac hmacMd5(String key)
```
    HmacMD5加密器
    例：
    HmacMD5加密：hmacMd5(key).digest(data)
    HmacMD5加密并转为16进制字符串：hmacMd5(key).digestHex(data)
    
    Parameters:
    
    key - 加密密钥，如果为null生成随机密钥
    
    Returns:
    
    HMac
    
    Since:
    
    3.3.0
  - hmacMd5
```
public static HMac hmacMd5(byte[] key)
```
    HmacMD5加密器
    例：
    HmacMD5加密：hmacMd5(key).digest(data)
    HmacMD5加密并转为16进制字符串：hmacMd5(key).digestHex(data)
    
    Parameters:
    
    key - 加密密钥，如果为null生成随机密钥
    
    Returns:
    
    HMac
  - hmacMd5
```
public static HMac hmacMd5()
```
    HmacMD5加密器，生成随机KEY
    例：
    HmacMD5加密：hmacMd5().digest(data)
    HmacMD5加密并转为16进制字符串：hmacMd5().digestHex(data)
    
    Returns:
    
    HMac
  - hmacSha1
```
public static HMac hmacSha1(String key)
```
    HmacSHA1加密器
    例：
    HmacSHA1加密：hmacSha1(key).digest(data)
    HmacSHA1加密并转为16进制字符串：hmacSha1(key).digestHex(data)
    
    Parameters:
    
    key - 加密密钥，如果为null生成随机密钥
    
    Returns:
    
    HMac
    
    Since:
    
    3.3.0
  - hmacSha1
```
public static HMac hmacSha1(byte[] key)
```
    HmacSHA1加密器
    例：
    HmacSHA1加密：hmacSha1(key).digest(data)
    HmacSHA1加密并转为16进制字符串：hmacSha1(key).digestHex(data)
    
    Parameters:
    
    key - 加密密钥，如果为null生成随机密钥
    
    Returns:
    
    HMac
  - hmacSha1
```
public static HMac hmacSha1()
```
    HmacSHA1加密器，生成随机KEY
    例：
    HmacSHA1加密：hmacSha1().digest(data)
    HmacSHA1加密并转为16进制字符串：hmacSha1().digestHex(data)
    
    Returns:
    
    HMac
  - hmacSha256
```
public static HMac hmacSha256(String key)
```
    HmacSHA256加密器
    例：
    HmacSHA256加密：hmacSha256(key).digest(data)
    HmacSHA256加密并转为16进制字符串：hmacSha256(key).digestHex(data)
    
    Parameters:
    
    key - 加密密钥，如果为null生成随机密钥
    
    Returns:
    
    HMac
    
    Since:
    
    5.6.0
  - hmacSha256
```
public static HMac hmacSha256(byte[] key)
```
    HmacSHA256加密器
    例：
    HmacSHA256加密：hmacSha256(key).digest(data)
    HmacSHA256加密并转为16进制字符串：hmacSha256(key).digestHex(data)
    
    Parameters:
    
    key - 加密密钥，如果为null生成随机密钥
    
    Returns:
    
    HMac
    
    Since:
    
    5.6.0
  - hmacSha256
```
public static HMac hmacSha256()
```
    HmacSHA256加密器，生成随机KEY
    例：
    HmacSHA256加密：hmacSha256().digest(data)
    HmacSHA256加密并转为16进制字符串：hmacSha256().digestHex(data)
    
    Returns:
    
    HMac
    
    Since:
    
    5.6.0
  - rsa
```
public static RSA rsa()
```
    创建RSA算法对象
    生成新的私钥公钥对
    
    Returns:
    
    RSA
    
    Since:
    
    3.0.5
  - rsa
```
public static RSA rsa(String privateKeyBase64,
                      String publicKeyBase64)
```
    创建RSA算法对象
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKeyBase64 - 私钥Base64
    
    publicKeyBase64 - 公钥Base64
    
    Returns:
    
    RSA
    
    Since:
    
    3.0.5
  - rsa
```
public static RSA rsa(byte[] privateKey,
                      byte[] publicKey)
```
    创建RSA算法对象
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    privateKey - 私钥
    
    publicKey - 公钥
    
    Returns:
    
    RSA
    
    Since:
    
    3.0.5
  - addProvider
```
public static void addProvider(Provider provider)
```
    增加加密解密的算法提供者，默认优先使用，例如：
```
 addProvider(new org.bouncycastle.jce.provider.BouncyCastleProvider());
 
```
    Parameters:
    
    provider - 算法提供者
    
    Since:
    
    4.1.22
  - decode
```
public static byte[] decode(String key)
```
    解码字符串密钥，可支持的编码如下：
```
 1. Hex（16进制）编码
 1. Base64编码
 
```
    Parameters:
    
    key - 被解码的密钥字符串
    
    Returns:
    
    密钥
    
    Since:
    
    4.3.3
  - createCipher
```
public static Cipher createCipher(String algorithm)
```
    创建Cipher
    当provider为null时，使用GlobalProviderFactory查找提供方，找不到使用JDK默认提供方。
    
    Parameters:
    
    algorithm - 算法
    
    Returns:
    
    Cipher
    
    Since:
    
    4.5.2
  - createMessageDigest
```
public static MessageDigest createMessageDigest(String algorithm,
                                                Provider provider)
```
    创建MessageDigest
    当provider为null时，使用GlobalProviderFactory查找提供方，找不到使用JDK默认提供方。
    
    Parameters:
    
    algorithm - 算法
    
    provider - 算法提供方，null表示使用GlobalProviderFactory找到的提供方。
    
    Returns:
    
    MessageDigest
  - createJdkMessageDigest
```
public static MessageDigest createJdkMessageDigest(String algorithm)
```
    创建MessageDigest，使用JDK默认的Provider
    
    Parameters:
    
    algorithm - 算法
    
    Returns:
    
    MessageDigest
  - createMac
```
public static Mac createMac(String algorithm)
```
    创建Mac
    
    Parameters:
    
    algorithm - 算法
    
    Returns:
    
    Mac
    
    Since:
    
    4.5.13
  - rc4
```
public static SymmetricCrypto rc4(byte[] key)
```
    RC4算法
    
    Parameters:
    
    key - 密钥
    
    Returns:
    
    SymmetricCrypto
  - disableCustomProvider
```
public static void disableCustomProvider()
```
    强制关闭自定义Provider的使用，如Bouncy Castle库，全局有效
  - pbkdf2
```
public static String pbkdf2(char[] password,
                            byte[] salt)
```
    PBKDF2加密密码
    
    Parameters:
    
    password - 密码
    
    salt - 盐
    
    Returns:
    
    盐，一般为16位
    
    Since:
    
    5.6.0
  - fpe
```
public static FPE fpe(FPE.FPEMode mode,
                      byte[] key,
                      org.bouncycastle.crypto.AlphabetMapper mapper,
                      byte[] tweak)
```
    FPE(Format Preserving Encryption)实现，支持FF1和FF3-1模式。
    
    Parameters:
    
    mode - FPE模式枚举，可选FF1或FF3-1
    
    key - 密钥，null表示随机密钥，长度必须是16bit、24bit或32bit
    
    mapper - Alphabet字典映射，被加密的字符范围和这个映射必须一致，例如手机号、银行卡号等字段可以采用数字字母字典表
    
    tweak - Tweak是为了解决因局部加密而导致结果冲突问题，通常情况下将数据的不可变部分作为Tweak
    
    Returns:
    
    FPE
    
    Since:
    
    5.7.12
  - zuc128
```
public static ZUC zuc128(byte[] key,
                         byte[] iv)
```
    祖冲之算法集（ZUC-128算法）实现，基于BouncyCastle实现。
    
    Parameters:
    
    key - 密钥
    
    iv - 加盐，长度16bytes，null是随机加盐
    
    Returns:
    
    ZUC
    
    Since:
    
    5.7.12
  - zuc256
```
public static ZUC zuc256(byte[] key,
                         byte[] iv)
```
    祖冲之算法集（ZUC-256算法）实现，基于BouncyCastle实现。
    
    Parameters:
    
    key - 密钥
    
    iv - 加盐，长度25bytes，null是随机加盐
    
    Returns:
    
    ZUC
    
    Since:
    
    5.7.12

Class SecureUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HUTOOL_CRYPTO_DECODE_HEX

Constructor Detail

SecureUtil

Method Detail

generateAlgorithm

aes

aes

des

des

desede

desede

md5

md5

md5

md5

sha1

sha1

sha1

sha1

sha256

sha256

sha256

sha256

hmac

hmac

hmac

hmacMd5

hmacMd5

hmacMd5

hmacSha1

hmacSha1

hmacSha1

hmacSha256

hmacSha256

hmacSha256

rsa

rsa

rsa

addProvider

decode

createCipher

createMessageDigest

createJdkMessageDigest

createMac

rc4

disableCustomProvider

pbkdf2

fpe

zuc128

zuc256