Symmetric (bus-crypto 6.1.8 API)

java.lang.Object
- org.aoju.bus.crypto.symmetric.Symmetric

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

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

Since:

JDK 1.8+

Version:

6.1.8

Author:

Kimi Liu

See Also:

Serialized Form

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`decrypt(byte[] bytes)` 解密
`byte[]`	`decrypt(InputStream data)` 解密，不会关闭流
`byte[]`	`decrypt(String data)` 解密Hex(16进制)或Base64表示的字符串
`String`	`decryptStr(byte[] bytes)` 解密为字符串，默认UTF-8编码
`String`	`decryptStr(byte[] bytes, Charset charset)` 解密为字符串
`String`	`decryptStr(InputStream data)` 解密
`String`	`decryptStr(InputStream data, Charset charset)` 解密，不会关闭流
`String`	`decryptStr(String data)` 解密Hex表示的字符串，默认UTF-8编码
`String`	`decryptStr(String data, Charset charset)` 解密Hex(16进制)或Base64表示的字符串
`byte[]`	`encrypt(byte[] data)` 加密
`byte[]`	`encrypt(InputStream data)` 加密
`byte[]`	`encrypt(String data)` 加密，使用UTF-8编码
`byte[]`	`encrypt(String data, Charset charset)` 加密
`byte[]`	`encrypt(String data, String charset)` 加密
`String`	`encryptBase64(byte[] data)` 加密
`String`	`encryptBase64(InputStream data)` 加密
`String`	`encryptBase64(String data)` 加密，使用UTF-8编码
`String`	`encryptBase64(String data, Charset charset)` 加密
`String`	`encryptBase64(String data, String charset)` 加密
`String`	`encryptHex(byte[] data)` 加密
`String`	`encryptHex(InputStream data)` 加密
`String`	`encryptHex(String data)` 加密，使用UTF-8编码
`String`	`encryptHex(String data, Charset charset)` 加密
`String`	`encryptHex(String data, String charset)` 加密
`Cipher`	`getCipher()` 获得加密或解密器
`SecretKey`	`getSecretKey()` 获得对称密钥
`Symmetric`	`init(String algorithm, SecretKey key)` 初始化
`Symmetric`	`setIv(byte[] iv)` 设置偏移向量
`Symmetric`	`setIv(IvParameterSpec iv)` 设置偏移向量
`Symmetric`	`setParams(AlgorithmParameterSpec params)` 设置 `AlgorithmParameterSpec`，通常用于加盐或偏移向量

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

- Constructor Detail
  - Symmetric
```
public Symmetric(String algorithm)
```
    构造，使用随机密钥
    
    Parameters:
    
    algorithm - 算法，可以是"algorithm/mode/padding"或者"algorithm"
  - Symmetric
```
public Symmetric(String algorithm,
                 byte[] key)
```
    构造
    
    Parameters:
    
    algorithm - 算法
    
    key - 密钥
  - Symmetric
```
public Symmetric(String algorithm,
                 SecretKey key)
```
    构造
    
    Parameters:
    
    algorithm - 算法
    
    key - 密钥
  - Symmetric
```
public Symmetric(String algorithm,
                 SecretKey key,
                 AlgorithmParameterSpec paramsSpec)
```
    构造
    
    Parameters:
    
    algorithm - 算法
    
    key - 密钥
    
    paramsSpec - 算法参数，例如加盐等
- Method Detail
  - init
```
public Symmetric init(String algorithm,
                      SecretKey key)
```
    初始化
    
    Parameters:
    
    algorithm - 算法
    
    key - 密钥，如果为null自动生成一个key
    
    Returns:
    
    Symmetric的子对象，即子对象自身
  - setParams
```
public Symmetric setParams(AlgorithmParameterSpec params)
```
    设置 AlgorithmParameterSpec，通常用于加盐或偏移向量
    
    Parameters:
    
    params - AlgorithmParameterSpec
    
    Returns:
    
    自身
  - setIv
```
public Symmetric setIv(IvParameterSpec iv)
```
    设置偏移向量
    
    Parameters:
    
    iv - IvParameterSpec偏移向量
    
    Returns:
    
    自身
  - setIv
```
public Symmetric setIv(byte[] iv)
```
    设置偏移向量
    
    Parameters:
    
    iv - 偏移向量，加盐
    
    Returns:
    
    自身
  - encrypt
```
public byte[] encrypt(byte[] data)
```
    加密
    
    Parameters:
    
    data - 被加密的bytes
    
    Returns:
    
    加密后的bytes
  - encryptHex
```
public String encryptHex(byte[] data)
```
    加密
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    加密后的Hex
  - encryptBase64
```
public String encryptBase64(byte[] data)
```
    加密
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    加密后的Base64
  - encrypt
```
public byte[] encrypt(String data,
                      String charset)
```
    加密
    
    Parameters:
    
    data - 被加密的字符串
    
    charset - 编码
    
    Returns:
    
    加密后的bytes
  - encrypt
```
public byte[] encrypt(String data,
                      Charset charset)
```
    加密
    
    Parameters:
    
    data - 被加密的字符串
    
    charset - 编码
    
    Returns:
    
    加密后的bytes
  - encryptHex
```
public String encryptHex(String data,
                         String charset)
```
    加密
    
    Parameters:
    
    data - 被加密的字符串
    
    charset - 编码
    
    Returns:
    
    加密后的Hex
  - encryptHex
```
public String encryptHex(String data,
                         Charset charset)
```
    加密
    
    Parameters:
    
    data - 被加密的字符串
    
    charset - 编码
    
    Returns:
    
    加密后的Hex
  - encryptBase64
```
public String encryptBase64(String data,
                            String charset)
```
    加密
    
    Parameters:
    
    data - 被加密的字符串
    
    charset - 编码
    
    Returns:
    
    加密后的Base64
  - encryptBase64
```
public String encryptBase64(String data,
                            Charset charset)
```
    加密
    
    Parameters:
    
    data - 被加密的字符串
    
    charset - 编码
    
    Returns:
    
    加密后的Base64
  - encrypt
```
public byte[] encrypt(String data)
```
    加密，使用UTF-8编码
    
    Parameters:
    
    data - 被加密的字符串
    
    Returns:
    
    加密后的bytes
  - encryptHex
```
public String encryptHex(String data)
```
    加密，使用UTF-8编码
    
    Parameters:
    
    data - 被加密的字符串
    
    Returns:
    
    加密后的Hex
  - encryptBase64
```
public String encryptBase64(String data)
```
    加密，使用UTF-8编码
    
    Parameters:
    
    data - 被加密的字符串
    
    Returns:
    
    加密后的Base64
  - encrypt
```
public byte[] encrypt(InputStream data)
               throws org.aoju.bus.core.lang.exception.InstrumentException
```
    加密
    
    Parameters:
    
    data - 被加密的字符串
    
    Returns:
    
    加密后的bytes
    
    Throws:
    
    org.aoju.bus.core.lang.exception.InstrumentException - IO异常
  - encryptHex
```
public String encryptHex(InputStream data)
```
    加密
    
    Parameters:
    
    data - 被加密的字符串
    
    Returns:
    
    加密后的Hex
  - encryptBase64
```
public String encryptBase64(InputStream data)
```
    加密
    
    Parameters:
    
    data - 被加密的字符串
    
    Returns:
    
    加密后的Base64
  - decrypt
```
public byte[] decrypt(byte[] bytes)
```
    解密
    
    Parameters:
    
    bytes - 被解密的bytes
    
    Returns:
    
    解密后的bytes
  - decryptStr
```
public String decryptStr(byte[] bytes,
                         Charset charset)
```
    解密为字符串
    
    Parameters:
    
    bytes - 被解密的bytes
    
    charset - 解密后的charset
    
    Returns:
    
    解密后的String
  - decryptStr
```
public String decryptStr(byte[] bytes)
```
    解密为字符串，默认UTF-8编码
    
    Parameters:
    
    bytes - 被解密的bytes
    
    Returns:
    
    解密后的String
  - decrypt
```
public byte[] decrypt(String data)
```
    解密Hex(16进制)或Base64表示的字符串
    
    Parameters:
    
    data - 被解密的String，必须为16进制字符串或Base64表示形式
    
    Returns:
    
    解密后的bytes
  - decryptStr
```
public String decryptStr(String data,
                         Charset charset)
```
    解密Hex(16进制)或Base64表示的字符串
    
    Parameters:
    
    data - 被解密的String
    
    charset - 解密后的charset
    
    Returns:
    
    解密后的String
  - decryptStr
```
public String decryptStr(String data)
```
    解密Hex表示的字符串，默认UTF-8编码
    
    Parameters:
    
    data - 被解密的String
    
    Returns:
    
    解密后的String
  - decrypt
```
public byte[] decrypt(InputStream data)
               throws org.aoju.bus.core.lang.exception.InstrumentException
```
    解密，不会关闭流
    
    Parameters:
    
    data - 被解密的bytes
    
    Returns:
    
    解密后的bytes
    
    Throws:
    
    org.aoju.bus.core.lang.exception.InstrumentException - IO异常
  - decryptStr
```
public String decryptStr(InputStream data,
                         Charset charset)
```
    解密，不会关闭流
    
    Parameters:
    
    data - 被解密的InputStream
    
    charset - 解密后的charset
    
    Returns:
    
    解密后的String
  - decryptStr
```
public String decryptStr(InputStream data)
```
    解密
    
    Parameters:
    
    data - 被解密的InputStream
    
    Returns:
    
    解密后的String
  - getSecretKey
```
public SecretKey getSecretKey()
```
    获得对称密钥
    
    Returns:
    
    获得对称密钥
  - getCipher
```
public Cipher getCipher()
```
    获得加密或解密器
    
    Returns:
    
    加密或解密

Class Symmetric

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Symmetric

Symmetric

Symmetric

Symmetric

Method Detail

init

setParams

setIv

setIv

encrypt

encryptHex

encryptBase64

encrypt

encrypt

encryptHex

encryptHex

encryptBase64

encryptBase64

encrypt

encryptHex

encryptBase64

encrypt

encryptHex

encryptBase64

decrypt

decryptStr

decryptStr

decrypt

decryptStr

decryptStr

decrypt

decryptStr

decryptStr

getSecretKey

getCipher