Package org.bouncycastle.crypto.engines
Class ElephantEngine
- java.lang.Object
-
- org.bouncycastle.crypto.engines.ElephantEngine
-
- All Implemented Interfaces:
AEADCipher
public class ElephantEngine extends java.lang.Object
Elephant AEAD v2, based on the current round 3 submission, https://www.esat.kuleuven.be/cosic/elephant/ Reference C implementation: https://github.com/TimBeyne/Elephant Specification: https://csrc.nist.gov/CSRC/media/Projects/lightweight-cryptography/documents/finalist-round/updated-spec-doc/elephant-spec-final.pdf
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ElephantEngine.ElephantParameters
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
algorithmName
protected boolean
forEncryption
protected byte[]
initialAssociatedText
protected int
IV_SIZE
protected int
KEY_SIZE
protected byte[]
mac
protected int
MAC_SIZE
-
Constructor Summary
Constructors Constructor Description ElephantEngine(ElephantEngine.ElephantParameters parameters)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
doFinal(byte[] output, int outOff)
Finish the operation either appending or verifying the MAC at the end of the data.java.lang.String
getAlgorithmName()
Return the name of the algorithm.int
getBlockSize()
int
getIVBytesSize()
int
getKeyBytesSize()
byte[]
getMac()
Return the value of the MAC associated with the last stream processed.int
getOutputSize(int len)
return the size of the output buffer required for a processBytes plus a doFinal with an input of len bytes.int
getUpdateOutputSize(int len)
return the size of the output buffer required for a processBytes an input of len bytes.void
init(boolean forEncryption, CipherParameters params)
initialise the underlying cipher.protected void
init(byte[] k, byte[] iv)
void
processAADByte(byte input)
Add a single byte to the associated data check.void
processAADBytes(byte[] input, int inOff, int len)
Add a sequence of bytes to the associated data check.int
processByte(byte in, byte[] out, int outOff)
encrypt/decrypt a single byte.int
processBytes(byte[] input, int inOff, int len, byte[] output, int outOff)
process a block of bytes from in putting the result into out.void
reset()
Reset the cipher.protected void
reset(boolean clearMac)
-
-
-
Constructor Detail
-
ElephantEngine
public ElephantEngine(ElephantEngine.ElephantParameters parameters)
-
-
Method Detail
-
init
protected void init(byte[] k, byte[] iv) throws java.lang.IllegalArgumentException
- Throws:
java.lang.IllegalArgumentException
-
processAADByte
public void processAADByte(byte input)
Description copied from interface:AEADCipher
Add a single byte to the associated data check.
If the implementation supports it, this will be an online operation and will not retain the associated data.- Parameters:
input
- the byte to be processed.
-
processAADBytes
public void processAADBytes(byte[] input, int inOff, int len)
Description copied from interface:AEADCipher
Add a sequence of bytes to the associated data check.
If the implementation supports it, this will be an online operation and will not retain the associated data.- Parameters:
input
- 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.
-
processBytes
public int processBytes(byte[] input, int inOff, int len, byte[] output, int outOff) throws DataLengthException
Description copied from interface:AEADCipher
process a block of bytes from in putting the result into out.- Parameters:
input
- 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.output
- 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.
-
doFinal
public int doFinal(byte[] output, int outOff) throws java.lang.IllegalStateException, InvalidCipherTextException
Description copied from interface:AEADCipher
Finish the operation either appending or verifying the MAC at the end of the data.- Parameters:
output
- space for any resulting output data.outOff
- offset into out to start copying the data at.- Returns:
- number of bytes written into out.
- Throws:
java.lang.IllegalStateException
- if the cipher is in an inappropriate state.InvalidCipherTextException
- if the MAC fails to match.
-
getUpdateOutputSize
public int getUpdateOutputSize(int len)
Description copied from interface:AEADCipher
return the size of the output buffer required for a processBytes an input of len bytes.The returned size may be dependent on the initialisation of this cipher and may not be accurate once subsequent input data is processed - this method should be invoked immediately prior to input data being processed.
- Parameters:
len
- the length of the input.- Returns:
- the space required to accommodate a call to processBytes with len bytes of input.
-
getOutputSize
public int getOutputSize(int len)
Description copied from interface:AEADCipher
return the size of the output buffer required for a processBytes plus a doFinal with an input of len bytes.The returned size may be dependent on the initialisation of this cipher and may not be accurate once subsequent input data is processed - this method should be invoked immediately prior to a call to final processing of input data and a call to
AEADCipher.doFinal(byte[], int)
.- Parameters:
len
- the length of the input.- Returns:
- the space required to accommodate a call to processBytes and doFinal with len bytes of input.
-
reset
protected void reset(boolean clearMac)
-
getBlockSize
public int getBlockSize()
-
getAlgorithmName
public java.lang.String getAlgorithmName()
Description copied from interface:AEADCipher
Return the name of the algorithm.- Specified by:
getAlgorithmName
in interfaceAEADCipher
- Returns:
- the algorithm name.
-
getKeyBytesSize
public int getKeyBytesSize()
-
getIVBytesSize
public int getIVBytesSize()
-
getMac
public byte[] getMac()
Description copied from interface:AEADCipher
Return the value of the MAC associated with the last stream processed.- Specified by:
getMac
in interfaceAEADCipher
- Returns:
- MAC for plaintext data.
-
reset
public void reset()
Description copied from interface:AEADCipher
Reset the cipher. After resetting the cipher is in the same state as it was after the last init (if there was one).- Specified by:
reset
in interfaceAEADCipher
-
processByte
public int processByte(byte in, byte[] out, int outOff) throws DataLengthException
Description copied from interface:AEADCipher
encrypt/decrypt a single byte.- Specified by:
processByte
in interfaceAEADCipher
- 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.
-
init
public void init(boolean forEncryption, CipherParameters params)
Description copied from interface:AEADCipher
initialise the underlying cipher. Parameter can either be an AEADParameters or a ParametersWithIV object.- Specified by:
init
in interfaceAEADCipher
- Parameters:
forEncryption
- true if we are setting up for encryption, false otherwise.params
- the necessary parameters for the underlying cipher to be initialised.
-
-