Bouncy Castle Cryptography 1.11 API Specification: Class PaddedBufferedBlockCipher
|
Bouncy Castle Cryptography 1.11 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.bouncycastle.crypto.BufferedBlockCipher | +--org.bouncycastle.crypto.paddings.PaddedBufferedBlockCipher
A wrapper class that allows block ciphers to be used to process data in a piecemeal fashion with padding. The PaddedBufferedBlockCipher 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 default padding mechanism used is the one outlined in PKCS5/PKCS7.
Fields inherited from class org.bouncycastle.crypto.BufferedBlockCipher |
buf, bufOff, cipher, forEncryption, partialBlockOkay |
Constructor Summary | |
PaddedBufferedBlockCipher(BlockCipher cipher)
Create a buffered block cipher PKCS7 padding |
|
PaddedBufferedBlockCipher(BlockCipher cipher,
BlockCipherPadding padding)
Create a buffered block cipher with the desired padding. |
Method Summary | |
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. |
void |
init(boolean forEncryption,
CipherParameters params)
initialise the cipher. |
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. |
Methods inherited from class org.bouncycastle.crypto.BufferedBlockCipher |
getBlockSize, getUnderlyingCipher, reset |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PaddedBufferedBlockCipher(BlockCipher cipher, BlockCipherPadding padding)
cipher
- the underlying block cipher this buffering object wraps.padding
- the padding type.public PaddedBufferedBlockCipher(BlockCipher cipher)
cipher
- the underlying block cipher this buffering object wraps.Method Detail |
public void init(boolean forEncryption, CipherParameters params) throws java.lang.IllegalArgumentException
init
in class BufferedBlockCipher
forEncryption
- if true the cipher is initialised for
encryption, if false for decryption.param
- the key and other data required by the cipher.java.lang.IllegalArgumentException
- if the params argument is
inappropriate.public int getOutputSize(int len)
getOutputSize
in class BufferedBlockCipher
len
- the length of the input.public int getUpdateOutputSize(int len)
getUpdateOutputSize
in class BufferedBlockCipher
len
- the length of the input.public int processByte(byte in, byte[] out, int outOff) throws DataLengthException, java.lang.IllegalStateException
processByte
in class BufferedBlockCipher
in
- the input byte.out
- the space for any output that might be produced.outOff
- the offset from which the output will be copied.DataLengthException
- if there isn't enough space in out.java.lang.IllegalStateException
- if the cipher isn't initialised.public int processBytes(byte[] in, int inOff, int len, byte[] out, int outOff) throws DataLengthException, java.lang.IllegalStateException
processBytes
in class BufferedBlockCipher
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.DataLengthException
- if there isn't enough space in out.java.lang.IllegalStateException
- if the cipher isn't initialised.public int doFinal(byte[] out, int outOff) throws DataLengthException, java.lang.IllegalStateException, InvalidCipherTextException
doFinal
in class BufferedBlockCipher
out
- the array the block currently being held is copied into.outOff
- the offset at which the copying starts.DataLengthException
- if there is insufficient space in out for
the output or we are decrypting and the input is not block size aligned.java.lang.IllegalStateException
- if the underlying cipher is not
initialised.InvalidCipherTextException
- if padding is expected and not found.
|
Bouncy Castle Cryptography 1.11 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |