Package org.bouncycastle.crypto.modes
Class CFBBlockCipher
- java.lang.Object
-
- org.bouncycastle.crypto.DefaultMultiBlockCipher
-
- org.bouncycastle.crypto.StreamBlockCipher
-
- org.bouncycastle.crypto.modes.CFBBlockCipher
-
- All Implemented Interfaces:
BlockCipher,CFBModeCipher,MultiBlockCipher,StreamCipher
public class CFBBlockCipher extends StreamBlockCipher implements CFBModeCipher
implements a Cipher-FeedBack (CFB) mode on top of a simple cipher.
-
-
Constructor Summary
Constructors Constructor Description CFBBlockCipher(BlockCipher cipher, int bitBlockSize)Deprecated.use the equivalent CFBBlockCipher.newInstance() static method.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected bytecalculateByte(byte in)intdecryptBlock(byte[] in, int inOff, byte[] out, int outOff)Do the appropriate processing for CFB mode decryption.intencryptBlock(byte[] in, int inOff, byte[] out, int outOff)Do the appropriate processing for CFB mode encryption.java.lang.StringgetAlgorithmName()return the algorithm name and mode.intgetBlockSize()return the block size we are operating at.byte[]getCurrentIV()Return the current state of the initialisation vector.voidinit(boolean encrypting, CipherParameters params)Initialise the cipher and, possibly, the initialisation vector (IV).static CFBModeCiphernewInstance(BlockCipher cipher, int blockSize)Return a new CFB mode cipher based on the passed in base cipherintprocessBlock(byte[] in, int inOff, byte[] out, int outOff)Process one block of input from the array in and write it to the out array.voidreset()reset the chaining vector back to the IV and reset the underlying cipher.-
Methods inherited from class org.bouncycastle.crypto.StreamBlockCipher
getUnderlyingCipher, processBytes, returnByte
-
Methods inherited from class org.bouncycastle.crypto.DefaultMultiBlockCipher
getMultiBlockSize, processBlocks
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.bouncycastle.crypto.MultiBlockCipher
getMultiBlockSize, processBlocks
-
Methods inherited from interface org.bouncycastle.crypto.StreamCipher
processBytes, returnByte
-
-
-
-
Constructor Detail
-
CFBBlockCipher
public CFBBlockCipher(BlockCipher cipher, int bitBlockSize)
Deprecated.use the equivalent CFBBlockCipher.newInstance() static method.Basic constructor.- Parameters:
cipher- the block cipher to be used as the basis of the feedback mode.bitBlockSize- the block size in bits (note: a multiple of 8)
-
-
Method Detail
-
newInstance
public static CFBModeCipher newInstance(BlockCipher cipher, int blockSize)
Return a new CFB mode cipher based on the passed in base cipher- Parameters:
cipher- the base cipher for the CFB mode.blockSize- the block size (in bits) used for the CFB mode.
-
init
public void init(boolean encrypting, CipherParameters params) throws java.lang.IllegalArgumentExceptionInitialise the cipher and, possibly, the initialisation vector (IV). If an IV isn't passed as part of the parameter, the IV will be all zeros. An IV which is too short is handled in FIPS compliant fashion.- Specified by:
initin interfaceBlockCipher- Specified by:
initin interfaceStreamCipher- Parameters:
encrypting- if true the cipher is initialised for encryption, if false for decryption.params- the key and other data required by the cipher.- Throws:
java.lang.IllegalArgumentException- if the params argument is inappropriate.
-
getAlgorithmName
public java.lang.String getAlgorithmName()
return the algorithm name and mode.- Specified by:
getAlgorithmNamein interfaceBlockCipher- Specified by:
getAlgorithmNamein interfaceStreamCipher- Returns:
- the name of the underlying algorithm followed by "/CFB" and the block size in bits.
-
calculateByte
protected byte calculateByte(byte in) throws DataLengthException, java.lang.IllegalStateException- Specified by:
calculateBytein classStreamBlockCipher- Throws:
DataLengthExceptionjava.lang.IllegalStateException
-
getBlockSize
public int getBlockSize()
return the block size we are operating at.- Specified by:
getBlockSizein interfaceBlockCipher- Returns:
- the block size we are operating at (in bytes).
-
processBlock
public int processBlock(byte[] in, int inOff, byte[] out, int outOff) throws DataLengthException, java.lang.IllegalStateExceptionProcess one block of input from the array in and write it to the out array.- Specified by:
processBlockin interfaceBlockCipher- 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.java.lang.IllegalStateException- if the cipher isn't initialised.
-
encryptBlock
public int encryptBlock(byte[] in, int inOff, byte[] out, int outOff) throws DataLengthException, java.lang.IllegalStateExceptionDo the appropriate processing for CFB mode encryption.- Parameters:
in- the array containing the data to be encrypted.inOff- offset into the in array the data starts at.out- the array the encrypted 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.java.lang.IllegalStateException- if the cipher isn't initialised.
-
decryptBlock
public int decryptBlock(byte[] in, int inOff, byte[] out, int outOff) throws DataLengthException, java.lang.IllegalStateExceptionDo the appropriate processing for CFB mode decryption.- Parameters:
in- the array containing the data to be decrypted.inOff- offset into the in array the data starts at.out- the array the encrypted 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.java.lang.IllegalStateException- if the cipher isn't initialised.
-
getCurrentIV
public byte[] getCurrentIV()
Return the current state of the initialisation vector.- Returns:
- current IV
-
reset
public void reset()
reset the chaining vector back to the IV and reset the underlying cipher.- Specified by:
resetin interfaceBlockCipher- Specified by:
resetin interfaceStreamCipher
-
-