Summary: Methods | [Expand All]
public interface

BlockCipher

org.bouncycastle.crypto.BlockCipher
Known Indirect Subclasses

Class Overview

Block cipher engines are expected to conform to this interface.

Summary

Public Methods
abstract String getAlgorithmName()
Return the name of the algorithm the cipher implements.
abstract int getBlockSize()
Return the block size for this cipher (in bytes).
abstract void init(boolean forEncryption, CipherParameters params)
Initialise the cipher.
abstract int processBlock(byte[] in, int inOff, byte[] out, int outOff)
Process one block of input from the array in and write it to the out array.
abstract void reset()
Reset the cipher.

Public Methods

public abstract String getAlgorithmName ()

Return the name of the algorithm the cipher implements.

Returns
  • the name of the algorithm the cipher implements.

public abstract int getBlockSize ()

Return the block size for this cipher (in bytes).

Returns
  • the block size for this cipher in bytes.

public abstract void init (boolean forEncryption, CipherParameters params)

Initialise the cipher.

Parameters
forEncryption if true the cipher is initialised for encryption, if false for decryption.
params the key and other data required by the cipher.
Throws
IllegalArgumentException if the params argument is inappropriate.

public abstract int processBlock (byte[] in, int inOff, byte[] out, int outOff)

Process one block of input from the array in and write it to the out array.

Parameters
in the array containing the input data.
inOff offset into the in array the data starts at.
out the array the output data will be copied into.
outOff the offset into the out array the output will start at.
Returns
  • the number of bytes processed and produced.
Throws
DataLengthException if there isn't enough data in in, or space in out.
IllegalStateException if the cipher isn't initialised.

public abstract void reset ()

Reset the cipher. After resetting the cipher is in the same state as it was after the last init (if there was one).