Package org.bouncycastle.crypto.engines

Class SparkleEngine

java.lang.Object

org.bouncycastle.crypto.engines.SparkleEngine

All Implemented Interfaces:

AEADCipher

public class SparkleEngine
extends Object
implements AEADCipher

Sparkle v1.2, based on the current round 3 submission, https://sparkle-lwc.github.io/ Reference C implementation: https://github.com/cryptolu/sparkle Specification: https://csrc.nist.gov/CSRC/media/Projects/lightweight-cryptography/documents/finalist-round/updated-spec-doc/sparkle-spec-final.pdf

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SparkleEngine.SparkleParameters

Constructor Summary

Constructors

Constructor	Description
SparkleEngine(SparkleEngine.SparkleParameters sparkleParameters)

Method Summary

Modifier and Type	Method	Description
int	doFinal(byte[] out, int outOff)	Finish the operation either appending or verifying the MAC at the end of the data.
String	getAlgorithmName()	Return the name of the algorithm.
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.
void	processAADByte(byte in)	Add a single byte to the associated data check.
void	processAADBytes(byte[] in, 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[] in, int inOff, int len, byte[] out, int outOff)	process a block of bytes from in putting the result into out.
void	reset()	Reset the cipher.
static void	sparkle_opt12(SparkleDigest.Friend friend, int[] state, int steps)
static void	sparkle_opt16(SparkleDigest.Friend friend, int[] state, int steps)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SparkleEngine

public SparkleEngine(SparkleEngine.SparkleParameters sparkleParameters)

Method Details

getKeyBytesSize

public int getKeyBytesSize()

getIVBytesSize

public int getIVBytesSize()

getAlgorithmName

public String getAlgorithmName()

Description copied from interface: AEADCipher

Return the name of the algorithm.

Specified by:

getAlgorithmName in interface AEADCipher

Returns:

the algorithm name.

init

public void init(boolean forEncryption,
 CipherParameters params)
          throws IllegalArgumentException

Description copied from interface: AEADCipher

initialise the underlying cipher. Parameter can either be an AEADParameters or a ParametersWithIV object.

Specified by:

init in interface AEADCipher

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.

processAADByte

public void processAADByte(byte in)

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.

Specified by:

processAADByte in interface AEADCipher

Parameters:

in - the byte to be processed.

processAADBytes

public void processAADBytes(byte[] in,
 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.

Specified by:

processAADBytes in interface AEADCipher

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.

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 interface AEADCipher

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.

processBytes

public int processBytes(byte[] in,
 int inOff,
 int len,
 byte[] out,
 int outOff)
                 throws DataLengthException

Description copied from interface: AEADCipher

process a block of bytes from in putting the result into out.

Specified by:

processBytes in interface AEADCipher

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.

doFinal

public int doFinal(byte[] out,
 int outOff)
            throws IllegalStateException,
InvalidCipherTextException

Description copied from interface: AEADCipher

Finish the operation either appending or verifying the MAC at the end of the data.

Specified by:

doFinal in interface AEADCipher

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.

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 interface AEADCipher

Returns:

MAC for plaintext data.

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.

Specified by:

getUpdateOutputSize in interface AEADCipher

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).

Specified by:

getOutputSize in interface AEADCipher

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

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 interface AEADCipher

sparkle_opt12

public static void sparkle_opt12(SparkleDigest.Friend friend,
 int[] state,
 int steps)

sparkle_opt16

public static void sparkle_opt16(SparkleDigest.Friend friend,
 int[] state,
 int steps)