org.dromara.hutool.crypto.bc

Class BCCipher

java.lang.Object

org.dromara.hutool.crypto.bc.BCCipher

All Implemented Interfaces:

Wrapper<Object>, Cipher

public class BCCipher
extends Object
implements Cipher, Wrapper<Object>

基于BouncyCastle库封装的加密解密实现，包装包括：

• BufferedBlockCipher
• BlockCipher
• StreamCipher
• AEADBlockCipher

Author:

Looly, changhr2013

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BCCipher.BCParameters BouncyCastle库的CipherParameters封装

Nested classes/interfaces inherited from interface org.dromara.hutool.crypto.Cipher

Cipher.Parameters

Constructor Summary

Constructors

Constructor and Description
BCCipher(org.bouncycastle.crypto.modes.AEADBlockCipher aeadBlockCipher) 构造
BCCipher(org.bouncycastle.crypto.BlockCipher blockCipher) 构造
BCCipher(org.bouncycastle.crypto.BufferedBlockCipher bufferedBlockCipher) 构造
BCCipher(org.bouncycastle.crypto.StreamCipher streamCipher) 构造

Method Summary

Modifier and Type	Method and Description
int	doFinal(byte[] out, int outOff) 处理最后一块数据 当Cipher.process(byte[], int, int, byte[], int)处理完数据后非完整块数据，此方法用于处理块中剩余的bytes 如加密数据要求128bit，即16byes的整数，单数处理数据后为15bytes，此时根据padding方式不同，可填充剩余1byte为指定值（如填充0） 当对数据进行分段加密时，需要首先多次执行process方法，在最后一块数据处理完后执行此方法。
String	getAlgorithmName() 获取算法名称
int	getBlockSize() 获取块大小，当为Stream方式加密时返回0
int	getOutputSize(int len) 返回输出缓冲区为了保存下一个update或doFinal操作的结果所需的长度（以字节为单位） 下一个update或doFinal调用的实际输出长度可能小于此方法返回的长度。
Object	getRaw() 获取原始对象
void	init(CipherMode mode, Cipher.Parameters parameters) 初始化模式和参数
int	process(byte[] in, int inOff, int len, byte[] out, int outOff) 执行运算，可以是加密运算或解密运算 此方法主要处理一块数据，一块数据处理完毕后，应调用Cipher.doFinal(byte[], int)处理padding等剩余数据。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dromara.hutool.crypto.Cipher

processFinal, processFinal

Constructor Detail

BCCipher

public BCCipher(org.bouncycastle.crypto.BufferedBlockCipher bufferedBlockCipher)

构造

Parameters:

bufferedBlockCipher - BufferedBlockCipher

BCCipher

public BCCipher(org.bouncycastle.crypto.BlockCipher blockCipher)

构造

Parameters:

blockCipher - BlockCipher

BCCipher

public BCCipher(org.bouncycastle.crypto.modes.AEADBlockCipher aeadBlockCipher)

构造

Parameters:

aeadBlockCipher - AEADBlockCipher

BCCipher

public BCCipher(org.bouncycastle.crypto.StreamCipher streamCipher)

构造

Parameters:

streamCipher - StreamCipher

Method Detail

getRaw

public Object getRaw()

Description copied from interface: Wrapper

获取原始对象

Specified by:

getRaw in interface Wrapper<Object>

Returns:

原始对象

getAlgorithmName

public String getAlgorithmName()

Description copied from interface: Cipher

获取算法名称

Specified by:

getAlgorithmName in interface Cipher

Returns:

算法名称

getBlockSize

public int getBlockSize()

Description copied from interface: Cipher

获取块大小，当为Stream方式加密时返回0

Specified by:

getBlockSize in interface Cipher

Returns:

块大小，-1表示非块加密

init

public void init(CipherMode mode,
                 Cipher.Parameters parameters)

Description copied from interface: Cipher

初始化模式和参数

Specified by:

init in interface Cipher

Parameters:

mode - 模式，如加密模式或解密模式

parameters - Cipher所需参数，包括Key、Random、IV等信息

getOutputSize

public int getOutputSize(int len)

Description copied from interface: Cipher

返回输出缓冲区为了保存下一个update或doFinal操作的结果所需的长度（以字节为单位）
下一个update或doFinal调用的实际输出长度可能小于此方法返回的长度。
一般为块大小对应的输出大小

Specified by:

getOutputSize in interface Cipher

Parameters:

len - 输入长度

Returns:

输出长度，-1表示非块加密

process

public int process(byte[] in,
                   int inOff,
                   int len,
                   byte[] out,
                   int outOff)

Description copied from interface: Cipher

执行运算，可以是加密运算或解密运算
此方法主要处理一块数据，一块数据处理完毕后，应调用Cipher.doFinal(byte[], int)处理padding等剩余数据。

Specified by:

process in interface Cipher

Parameters:

in - 输入数据

inOff - 输入数据开始位置

len - 被处理数据长度

out - 输出数据

outOff - 输出数据开始位置

Returns:

处理长度

doFinal

public int doFinal(byte[] out,
                   int outOff)

Description copied from interface: Cipher

处理最后一块数据
当Cipher.process(byte[], int, int, byte[], int)处理完数据后非完整块数据，此方法用于处理块中剩余的bytes
如加密数据要求128bit，即16byes的整数，单数处理数据后为15bytes，此时根据padding方式不同，可填充剩余1byte为指定值（如填充0）
当对数据进行分段加密时，需要首先多次执行process方法，在最后一块数据处理完后执行此方法。

Specified by:

doFinal in interface Cipher

Parameters:

out - 经过process执行过运算的结果数据

outOff - 数据处理开始位置

Returns:

处理长度