AEADBlockCipher
| org.bouncycastle.crypto.modes.AEADBlockCipher |
 Known Indirect Subclasses
|
Class Overview
A block cipher mode that includes authenticated encryption with a streaming mode and optional associated data.
See Also
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Finish the operation either appending or verifying the MAC at the end of the data.
| |||||||||||
Return the name of the algorithm.
| |||||||||||
Return the value of the MAC associated with the last stream processed.
| |||||||||||
return the size of the output buffer required for a processBytes plus a
doFinal with an input of len bytes.
| |||||||||||
return the cipher this object wraps.
| |||||||||||
return the size of the output buffer required for a processBytes
an input of len bytes.
| |||||||||||
initialise the underlying cipher.
| |||||||||||
encrypt/decrypt a single byte.
| |||||||||||
process a block of bytes from in putting the result into out.
| |||||||||||
Reset the cipher.
| |||||||||||
Public Methods
public abstract int doFinal (byte[] out, int outOff)
Finish the operation either appending or verifying the MAC at the end of the data.
Parameters
| out | space for any resulting output data. |
|---|---|
| outOff | offset into out to start copying the data at. |
Returns
- number of bytes written into out.
Throws
| IllegalStateException | if the cipher is in an inappropriate state. |
|---|---|
| InvalidCipherTextException | if the MAC fails to match. |
public abstract String getAlgorithmName ()
Return the name of the algorithm.
Returns
- the algorithm name.
public abstract byte[] getMac ()
Return the value of the MAC associated with the last stream processed.
Returns
- MAC for plaintext data.
public abstract int getOutputSize (int len)
return the size of the output buffer required for a processBytes 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 processBytes and doFinal with len bytes of input.
public abstract BlockCipher getUnderlyingCipher ()
return the cipher this object wraps.
Returns
- the cipher this object wraps.
public abstract int getUpdateOutputSize (int len)
return the size of the output buffer required for a processBytes an input of len bytes.
Parameters
| len | the length of the input. |
|---|
Returns
- the space required to accommodate a call to processBytes with len bytes of input.
public abstract void init (boolean forEncryption, CipherParameters params)
initialise the underlying cipher. Parameter can either be an AEADParameters or a ParametersWithIV object.
Parameters
| forEncryption | true if we are setting up for encryption, false otherwise. |
|---|---|
| params | the necessary parameters for the underlying cipher to be initialised. |
Throws
| IllegalArgumentException | if the params argument is inappropriate. |
|---|
public abstract int processByte (byte in, byte[] out, int outOff)
encrypt/decrypt a single byte.
Parameters
| in | the byte to be processed. |
|---|---|
| out | the output buffer the processed byte goes into. |
| outOff | the offset into the output byte array the processed data starts at. |
Returns
- the number of bytes written to out.
Throws
| DataLengthException | if the output buffer is too small. |
|---|
public abstract int processBytes (byte[] in, int inOff, int len, byte[] out, int outOff)
process a block of bytes from in putting the result into out.
Parameters
| in | the input byte array. |
|---|---|
| inOff | the offset into the in array where the data to be processed starts. |
| len | the number of bytes to be processed. |
| out | the output buffer the processed bytes go into. |
| outOff | the offset into the output byte array the processed data starts at. |
Returns
- the number of bytes written to out.
Throws
| DataLengthException | if the output buffer is too small. |
|---|
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).