SymmetricCrypto (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.crypto.symmetric.SymmetricCrypto

All Implemented Interfaces:

SymmetricDecryptor, SymmetricEncryptor, Serializable

Direct Known Subclasses:

AES, ChaCha20, DES, DESede, SM4, ZUC
```
public class SymmetricCrypto
extends Object
implements SymmetricEncryptor, SymmetricDecryptor, Serializable
```
对称加密算法
在对称加密算法中，数据发信方将明文（原始数据）和加密密钥一起经过特殊加密算法处理后，使其变成复杂的加密密文发送出去。
收信方收到密文后，若想解读原文，则需要使用加密用过的密钥及相同算法的逆算法对密文进行解密，才能使其恢复成可读明文。
在对称加密算法中，使用的密钥只有一个，发收信双方都使用这个密钥对数据进行加密和解密，这就要求解密方事先必须知道加密密钥。

Author:

Looly

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`SymmetricCrypto(String algorithm)` 构造，使用随机密钥
`SymmetricCrypto(String algorithm, byte[] key)` 构造
`SymmetricCrypto(String algorithm, SecretKey key)` 构造
`SymmetricCrypto(String algorithm, SecretKey key, AlgorithmParameterSpec paramsSpec)` 构造
`SymmetricCrypto(SymmetricAlgorithm algorithm)` 构造，使用随机密钥
`SymmetricCrypto(SymmetricAlgorithm algorithm, byte[] key)` 构造
`SymmetricCrypto(SymmetricAlgorithm algorithm, SecretKey key)` 构造

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`decrypt(byte[] bytes)` 解密
`void`	`decrypt(InputStream data, OutputStream out, boolean isClose)` 解密，针对大数据量，结束后不关闭流
`byte[]`	`encrypt(byte[] data)` 加密
`void`	`encrypt(InputStream data, OutputStream out, boolean isClose)` 加密，针对大数据量，可选结束后是否关闭流
`Cipher`	`getCipher()` 获得加密或解密器
`SecretKey`	`getSecretKey()` 获得对称密钥
`SymmetricCrypto`	`init(String algorithm, SecretKey key)` 初始化
`SymmetricCrypto`	`setIv(byte[] iv)` 设置偏移向量
`SymmetricCrypto`	`setIv(IvParameterSpec iv)` 设置偏移向量
`SymmetricCrypto`	`setMode(CipherMode mode)` 初始化模式并清空数据
`SymmetricCrypto`	`setParams(AlgorithmParameterSpec params)` 设置 `AlgorithmParameterSpec`，通常用于加盐或偏移向量
`SymmetricCrypto`	`setRandom(SecureRandom random)` 设置随机数生成器，可自定义随机数种子
`byte[]`	`update(byte[] data)` 更新数据，分组加密中间结果可以当作随机数第一次更新数据前需要调用`setMode(CipherMode)`初始化加密或解密模式，然后每次更新数据都是累加模式
`String`	`updateHex(byte[] data)` 更新数据，分组加密中间结果可以当作随机数第一次更新数据前需要调用`setMode(CipherMode)`初始化加密或解密模式，然后每次更新数据都是累加模式

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

Methods inherited from interface cn.hutool.crypto.symmetric.SymmetricEncryptor
encrypt, encrypt, encrypt, encrypt, encryptBase64, encryptBase64, encryptBase64, encryptBase64, encryptBase64, encryptHex, encryptHex, encryptHex, encryptHex, encryptHex

Methods inherited from interface cn.hutool.crypto.symmetric.SymmetricDecryptor
decrypt, decrypt, decryptStr, decryptStr, decryptStr, decryptStr, decryptStr, decryptStr

- Constructor Detail
  - SymmetricCrypto
```
public SymmetricCrypto(SymmetricAlgorithm algorithm)
```
    构造，使用随机密钥
    
    Parameters:
    
    algorithm - SymmetricAlgorithm
  - SymmetricCrypto
```
public SymmetricCrypto(String algorithm)
```
    构造，使用随机密钥
    
    Parameters:
    
    algorithm - 算法，可以是"algorithm/mode/padding"或者"algorithm"
  - SymmetricCrypto
```
public SymmetricCrypto(SymmetricAlgorithm algorithm,
                       byte[] key)
```
    构造
    
    Parameters:
    
    algorithm - 算法 SymmetricAlgorithm
    
    key - 自定义KEY
  - SymmetricCrypto
```
public SymmetricCrypto(SymmetricAlgorithm algorithm,
                       SecretKey key)
```
    构造
    
    Parameters:
    
    algorithm - 算法 SymmetricAlgorithm
    
    key - 自定义KEY
    
    Since:
    
    3.1.2
  - SymmetricCrypto
```
public SymmetricCrypto(String algorithm,
                       byte[] key)
```
    构造
    
    Parameters:
    
    algorithm - 算法
    
    key - 密钥
  - SymmetricCrypto
```
public SymmetricCrypto(String algorithm,
                       SecretKey key)
```
    构造
    
    Parameters:
    
    algorithm - 算法
    
    key - 密钥
    
    Since:
    
    3.1.2
  - SymmetricCrypto
```
public SymmetricCrypto(String algorithm,
                       SecretKey key,
                       AlgorithmParameterSpec paramsSpec)
```
    构造
    
    Parameters:
    
    algorithm - 算法
    
    key - 密钥
    
    paramsSpec - 算法参数，例如加盐等
    
    Since:
    
    3.3.0
- Method Detail
  - init
```
public SymmetricCrypto init(String algorithm,
                            SecretKey key)
```
    初始化
    
    Parameters:
    
    algorithm - 算法
    
    key - 密钥，如果为null自动生成一个key
    
    Returns:
    
    SymmetricCrypto的子对象，即子对象自身
  - getSecretKey
```
public SecretKey getSecretKey()
```
    获得对称密钥
    
    Returns:
    
    获得对称密钥
  - getCipher
```
public Cipher getCipher()
```
    获得加密或解密器
    
    Returns:
    
    加密或解密
  - setIv
```
public SymmetricCrypto setIv(byte[] iv)
```
    设置偏移向量
    
    Parameters:
    
    iv - 偏移向量，加盐
    
    Returns:
    
    自身
  - setIv
```
public SymmetricCrypto setIv(IvParameterSpec iv)
```
    设置偏移向量
    
    Parameters:
    
    iv - IvParameterSpec偏移向量
    
    Returns:
    
    自身
  - setParams
```
public SymmetricCrypto setParams(AlgorithmParameterSpec params)
```
    设置 AlgorithmParameterSpec，通常用于加盐或偏移向量
    
    Parameters:
    
    params - AlgorithmParameterSpec
    
    Returns:
    
    自身
  - setRandom
```
public SymmetricCrypto setRandom(SecureRandom random)
```
    设置随机数生成器，可自定义随机数种子
    
    Parameters:
    
    random - 随机数生成器，可自定义随机数种子
    
    Returns:
    
    this
    
    Since:
    
    5.7.17
  - setMode
```
public SymmetricCrypto setMode(CipherMode mode)
```
    初始化模式并清空数据
    
    Parameters:
    
    mode - 模式枚举
    
    Returns:
    
    this
    
    Since:
    
    5.7.12
  - update
```
public byte[] update(byte[] data)
```
    更新数据，分组加密中间结果可以当作随机数
    第一次更新数据前需要调用setMode(CipherMode)初始化加密或解密模式，然后每次更新数据都是累加模式
    
    Parameters:
    
    data - 被加密的bytes
    
    Returns:
    
    update之后的bytes
    
    Since:
    
    5.6.8
  - updateHex
```
public String updateHex(byte[] data)
```
    更新数据，分组加密中间结果可以当作随机数
    第一次更新数据前需要调用setMode(CipherMode)初始化加密或解密模式，然后每次更新数据都是累加模式
    
    Parameters:
    
    data - 被加密的bytes
    
    Returns:
    
    update之后的hex数据
    
    Since:
    
    5.6.8
  - encrypt
```
public byte[] encrypt(byte[] data)
```
    Description copied from interface: SymmetricEncryptor
    
    加密
    
    Specified by:
    
    encrypt in interface SymmetricEncryptor
    
    Parameters:
    
    data - 被加密的bytes
    
    Returns:
    
    加密后的bytes
  - encrypt
```
public void encrypt(InputStream data,
                    OutputStream out,
                    boolean isClose)
             throws IORuntimeException
```
    Description copied from interface: SymmetricEncryptor
    
    加密，针对大数据量，可选结束后是否关闭流
    
    Specified by:
    
    encrypt in interface SymmetricEncryptor
    
    Parameters:
    
    data - 被加密的字符串
    
    out - 输出流，可以是文件或网络位置
    
    isClose - 是否关闭流
    
    Throws:
    
    IORuntimeException - IO异常
  - decrypt
```
public byte[] decrypt(byte[] bytes)
```
    Description copied from interface: SymmetricDecryptor
    
    解密
    
    Specified by:
    
    decrypt in interface SymmetricDecryptor
    
    Parameters:
    
    bytes - 被解密的bytes
    
    Returns:
    
    解密后的bytes
  - decrypt
```
public void decrypt(InputStream data,
                    OutputStream out,
                    boolean isClose)
             throws IORuntimeException
```
    Description copied from interface: SymmetricDecryptor
    
    解密，针对大数据量，结束后不关闭流
    
    Specified by:
    
    decrypt in interface SymmetricDecryptor
    
    Parameters:
    
    data - 加密的字符串
    
    out - 输出流，可以是文件或网络位置
    
    isClose - 是否关闭流，包括输入和输出流
    
    Throws:
    
    IORuntimeException - IO异常

Class SymmetricCrypto

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface cn.hutool.crypto.symmetric.SymmetricEncryptor

Methods inherited from interface cn.hutool.crypto.symmetric.SymmetricDecryptor

Constructor Detail

SymmetricCrypto

SymmetricCrypto

SymmetricCrypto

SymmetricCrypto

SymmetricCrypto

SymmetricCrypto

SymmetricCrypto

Method Detail

init

getSecretKey

getCipher

setIv

setIv

setParams

setRandom

setMode

update

updateHex

encrypt

encrypt

decrypt

decrypt