public class

PaddedBlockCipher

extends BufferedBlockCipher
java.lang.Object
   ↳ org.bouncycastle.crypto.BufferedBlockCipher
     ↳ org.bouncycastle.crypto.modes.PaddedBlockCipher

This class is deprecated.
use org.bouncycastle.crypto.paddings.PaddedBufferedBlockCipher instead.

Class Overview

A wrapper class that allows block ciphers to be used to process data in a piecemeal fashion with PKCS5/PKCS7 padding. The PaddedBlockCipher outputs a block only when the buffer is full and more data is being added, or on a doFinal (unless the current block in the buffer is a pad block). The padding mechanism used is the one outlined in PKCS5/PKCS7.

Summary

[Expand]
Inherited Fields
From class org.bouncycastle.crypto.BufferedBlockCipher
Public Constructors
PaddedBlockCipher(BlockCipher cipher)
Create a buffered block cipher with, or without, padding.
Public Methods
int doFinal(byte[] out, int outOff)
Process the last block in the buffer.
int getOutputSize(int len)
return the size of the output buffer required for an update plus a doFinal with an input of len bytes.
int getUpdateOutputSize(int len)
return the size of the output buffer required for an update an input of len bytes.
int processByte(byte in, byte[] out, int outOff)
process a single byte, producing an output block if neccessary.
int processBytes(byte[] in, int inOff, int len, byte[] out, int outOff)
process an array of bytes, producing output if necessary.
[Expand]
Inherited Methods
From class org.bouncycastle.crypto.BufferedBlockCipher
From class java.lang.Object

Public Constructors

public PaddedBlockCipher (BlockCipher cipher)

Create a buffered block cipher with, or without, padding.

Parameters
cipher the underlying block cipher this buffering object wraps.

Public Methods

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

Process the last block in the buffer. If the buffer is currently full and padding needs to be added a call to doFinal will produce 2 * getBlockSize() bytes.

Parameters
out the array the block currently being held is copied into.
outOff the offset at which the copying starts.
Returns
  • the number of output bytes copied to out.
Throws
DataLengthException if there is insufficient space in out for the output or we are decrypting and the input is not block size aligned.
IllegalStateException if the underlying cipher is not initialised.
InvalidCipherTextException if padding is expected and not found.

public int getOutputSize (int len)

return the size of the output buffer required for an update plus a doFinal with an input of len bytes.

Parameters
len the length of the input.
Returns
  • the space required to accommodate a call to update and doFinal with len bytes of input.

public int getUpdateOutputSize (int len)

return the size of the output buffer required for an update an input of len bytes.

Parameters
len the length of the input.
Returns
  • the space required to accommodate a call to update with len bytes of input.

public int processByte (byte in, byte[] out, int outOff)

process a single byte, producing an output block if neccessary.

Parameters
in the input byte.
out the space for any output that might be produced.
outOff the offset from which the output will be copied.
Returns
  • the number of output bytes copied to out.
Throws
DataLengthException if there isn't enough space in out.
IllegalStateException if the cipher isn't initialised.

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

process an array of bytes, producing output if necessary.

Parameters
in the input byte array.
inOff the offset at which the input data starts.
len the number of bytes to be copied out of the input array.
out the space for any output that might be produced.
outOff the offset from which the output will be copied.
Returns
  • the number of output bytes copied to out.
Throws
DataLengthException if there isn't enough space in out.
IllegalStateException if the cipher isn't initialised.