Top Description Inners Fields Constructors Methods
org.bouncycastle.crypto.engines

public Class XoodyakEngine

extends Object
implements AEADCipher
Class Inheritance
All Implemented Interfaces
org.bouncycastle.crypto.modes.AEADCipher
Imports
java.io.ByteArrayOutputStream, org.bouncycastle.crypto.CipherParameters, .CryptoServicesRegistrar, .DataLengthException, .InvalidCipherTextException, .OutputLengthException, org.bouncycastle.crypto.constraints.DefaultServiceProperties, org.bouncycastle.crypto.modes.AEADCipher, org.bouncycastle.crypto.params.KeyParameter, .ParametersWithIV, org.bouncycastle.util.Arrays, .Pack
Xoodyak v1, https://csrc.nist.gov/CSRC/media/Projects/lightweight-cryptography/documents/finalist-round/updated-spec-doc/xoodyak-spec-final.pdf

Xoodyak with reference to C Reference Impl from: https://github.com/XKCP/XKCP

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static enum
XoodyakEngine.MODE

Field Summary

Modifier and TypeField and Description
private final ByteArrayOutputStream
aadData

private boolean
aadFinished

private boolean
encrypted

private final int
f_bPrime

private boolean
forEncryption

private boolean
initialised

private byte[]
iv

private byte[]
K

private final int
MAXROUNDS

private final ByteArrayOutputStream
message

private XoodyakEngine.MODE
mode

private final int
NCOLUMS

private final int
NLANES

private final int
NROWS

private int
phase

private final int
PhaseDown

private final int
PhaseUp

private int
Rabsorb

private final int[]
RC

pack-priv final int
Rkin

private final int
Rkout

private byte[]
state

private byte[]
tag

private final int
TAGLEN

Constructor Summary

AccessConstructor and Description
public
XoodyakEngine()

Method Summary

Modifier and TypeMethod and Description
private void
AbsorbAny(byte[] X, int Xoff, int XLen, int r, int Cd)

public int
doFinal(byte[]
space for any resulting output data.
output, int
offset into out to start copying the data at.
outOff)

Implements org.bouncycastle.crypto.modes.AEADCipher.doFinal.

Finish the operation either appending or verifying the MAC at the end of the data.
pack-priv void
Down(byte[] Xi, int XiOff, int XiLen, int Cd)

private int
encrypt(byte[] input, int inOff, int len, byte[] output, int outOff)

public String
getAlgorithmName()

Implements org.bouncycastle.crypto.modes.AEADCipher.getAlgorithmName.

Return the name of the algorithm.
public int
getBlockSize()

public int
getIVBytesSize()

public int
getKeyBytesSize()

public byte[]
getMac()

Implements org.bouncycastle.crypto.modes.AEADCipher.getMac.

Return the value of the MAC associated with the last stream processed.
public int
getOutputSize(int
the length of the input.
len)

Implements org.bouncycastle.crypto.modes.AEADCipher.getOutputSize.

return the size of the output buffer required for a processBytes plus a doFinal with an input of len bytes.
public int
getUpdateOutputSize(int
the length of the input.
len)

Implements org.bouncycastle.crypto.modes.AEADCipher.getUpdateOutputSize.

return the size of the output buffer required for a processBytes an input of len bytes.
private int
index(int x, int y)

public void
init(boolean
true if we are setting up for encryption, false otherwise.
forEncryption, CipherParameters
the necessary parameters for the underlying cipher to be initialised.
params)

Implements org.bouncycastle.crypto.modes.AEADCipher.init.

initialise the underlying cipher.
private void
processAAD()

public void
processAADByte(byte
the byte to be processed.
input)

Implements org.bouncycastle.crypto.modes.AEADCipher.processAADByte.

Add a single byte to the associated data check.
public void
processAADBytes(byte[]
the input byte array.
input, int
the offset into the in array where the data to be processed starts.
inOff, int
the number of bytes to be processed.
len)

Implements org.bouncycastle.crypto.modes.AEADCipher.processAADBytes.

Add a sequence of bytes to the associated data check.
public int
processByte(byte
the byte to be processed.
input, byte[]
the output buffer the processed byte goes into.
output, int
the offset into the output byte array the processed data starts at.
outOff)

Implements org.bouncycastle.crypto.modes.AEADCipher.processByte.

encrypt/decrypt a single byte.
public int
processBytes(byte[]
the input byte array.
input, int
the offset into the in array where the data to be processed starts.
inOff, int
the number of bytes to be processed.
len, byte[]
the output buffer the processed bytes go into.
output, int
the offset into the output byte array the processed data starts at.
outOff)

Implements org.bouncycastle.crypto.modes.AEADCipher.processBytes.

process a block of bytes from in putting the result into out.
public void
reset()

Implements org.bouncycastle.crypto.modes.AEADCipher.reset.

Reset the cipher.
private void
reset(boolean clearMac)

private int
ROTL32(int a, int offset)

private void
Up(byte[] Yi, int YiLen, int Cu)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

aadDataback to summary
private final ByteArrayOutputStream aadData
aadFinishedback to summary
private boolean aadFinished
encryptedback to summary
private boolean encrypted
f_bPrimeback to summary
private final int f_bPrime
forEncryptionback to summary
private boolean forEncryption
initialisedback to summary
private boolean initialised
ivback to summary
private byte[] iv
Kback to summary
private byte[] K
MAXROUNDSback to summary
private final int MAXROUNDS
messageback to summary
private final ByteArrayOutputStream message
modeback to summary
private XoodyakEngine.MODE mode
NCOLUMSback to summary
private final int NCOLUMS
NLANESback to summary
private final int NLANES
NROWSback to summary
private final int NROWS
phaseback to summary
private int phase
PhaseDownback to summary
private final int PhaseDown
PhaseUpback to summary
private final int PhaseUp
Rabsorbback to summary
private int Rabsorb
RCback to summary
private final int[] RC
Rkinback to summary
pack-priv final int Rkin
Rkoutback to summary
private final int Rkout
stateback to summary
private byte[] state
tagback to summary
private byte[] tag
TAGLENback to summary
private final int TAGLEN

Constructor Detail

XoodyakEngineback to summary
public XoodyakEngine()

Method Detail

AbsorbAnyback to summary
private void AbsorbAny(byte[] X, int Xoff, int XLen, int r, int Cd)
doFinalback to summary
public int doFinal(byte[] output, int outOff) throws IllegalStateException, InvalidCipherTextException

Implements org.bouncycastle.crypto.modes.AEADCipher.doFinal.

Doc from org.bouncycastle.crypto.modes.AEADCipher.doFinal.

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

Parameters
output:byte[]

space for any resulting output data.

outOff:int

offset into out to start copying the data at.

Returns:int

number of bytes written into out.

Annotations
@Override
Exceptions
IllegalStateException:
if the cipher is in an inappropriate state.
InvalidCipherTextException:
if the MAC fails to match.
Downback to summary
pack-priv void Down(byte[] Xi, int XiOff, int XiLen, int Cd)
encryptback to summary
private int encrypt(byte[] input, int inOff, int len, byte[] output, int outOff)
getAlgorithmNameback to summary
public String getAlgorithmName()

Implements org.bouncycastle.crypto.modes.AEADCipher.getAlgorithmName.

Doc from org.bouncycastle.crypto.modes.AEADCipher.getAlgorithmName.

Return the name of the algorithm.

Returns:String

the algorithm name.

Annotations
@Override
getBlockSizeback to summary
public int getBlockSize()
getIVBytesSizeback to summary
public int getIVBytesSize()
getKeyBytesSizeback to summary
public int getKeyBytesSize()
getMacback to summary
public byte[] getMac()

Implements org.bouncycastle.crypto.modes.AEADCipher.getMac.

Doc from org.bouncycastle.crypto.modes.AEADCipher.getMac.

Return the value of the MAC associated with the last stream processed.

Returns:byte[]

MAC for plaintext data.

Annotations
@Override
getOutputSizeback to summary
public int getOutputSize(int len)

Implements org.bouncycastle.crypto.modes.AEADCipher.getOutputSize.

Doc from org.bouncycastle.crypto.modes.AEADCipher.getOutputSize.

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 doFinal(byte[], int).

Parameters
len:int

the length of the input.

Returns:int

the space required to accommodate a call to processBytes and doFinal with len bytes of input.

Annotations
@Override
getUpdateOutputSizeback to summary
public int getUpdateOutputSize(int len)

Implements org.bouncycastle.crypto.modes.AEADCipher.getUpdateOutputSize.

Doc from org.bouncycastle.crypto.modes.AEADCipher.getUpdateOutputSize.

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:int

the length of the input.

Returns:int

the space required to accommodate a call to processBytes with len bytes of input.

Annotations
@Override
indexback to summary
private int index(int x, int y)
initback to summary
public void init(boolean forEncryption, CipherParameters params) throws IllegalArgumentException

Implements org.bouncycastle.crypto.modes.AEADCipher.init.

Doc from org.bouncycastle.crypto.modes.AEADCipher.init.

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

Parameters
forEncryption:boolean

true if we are setting up for encryption, false otherwise.

params:CipherParameters

the necessary parameters for the underlying cipher to be initialised.

Annotations
@Override
Exceptions
IllegalArgumentException:
if the params argument is inappropriate.
processAADback to summary
private void processAAD()
processAADByteback to summary
public void processAADByte(byte input)

Implements org.bouncycastle.crypto.modes.AEADCipher.processAADByte.

Doc from org.bouncycastle.crypto.modes.AEADCipher.processAADByte.

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:byte

the byte to be processed.

Annotations
@Override
processAADBytesback to summary
public void processAADBytes(byte[] input, int inOff, int len)

Implements org.bouncycastle.crypto.modes.AEADCipher.processAADBytes.

Doc from org.bouncycastle.crypto.modes.AEADCipher.processAADBytes.

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:byte[]

the input byte array.

inOff:int

the offset into the in array where the data to be processed starts.

len:int

the number of bytes to be processed.

Annotations
@Override
processByteback to summary
public int processByte(byte input, byte[] output, int outOff) throws DataLengthException

Implements org.bouncycastle.crypto.modes.AEADCipher.processByte.

Doc from org.bouncycastle.crypto.modes.AEADCipher.processByte.

encrypt/decrypt a single byte.

Parameters
input:byte

the byte to be processed.

output:byte[]

the output buffer the processed byte goes into.

outOff:int

the offset into the output byte array the processed data starts at.

Returns:int

the number of bytes written to out.

Annotations
@Override
Exceptions
DataLengthException:
if the output buffer is too small.
processBytesback to summary
public int processBytes(byte[] input, int inOff, int len, byte[] output, int outOff) throws DataLengthException

Implements org.bouncycastle.crypto.modes.AEADCipher.processBytes.

Doc from org.bouncycastle.crypto.modes.AEADCipher.processBytes.

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

Parameters
input:byte[]

the input byte array.

inOff:int

the offset into the in array where the data to be processed starts.

len:int

the number of bytes to be processed.

output:byte[]

the output buffer the processed bytes go into.

outOff:int

the offset into the output byte array the processed data starts at.

Returns:int

the number of bytes written to out.

Annotations
@Override
Exceptions
DataLengthException:
if the output buffer is too small.
resetback to summary
public void reset()

Implements org.bouncycastle.crypto.modes.AEADCipher.reset.

Doc from org.bouncycastle.crypto.modes.AEADCipher.reset.

Reset the cipher. After resetting the cipher is in the same state as it was after the last init (if there was one).

Annotations
@Override
resetback to summary
private void reset(boolean clearMac)
ROTL32back to summary
private int ROTL32(int a, int offset)
Upback to summary
private void Up(byte[] Yi, int YiLen, int Cu)
org.bouncycastle.crypto.engines back to summary

pack-priv final Enum XoodyakEngine.MODE

extends Enum<XoodyakEngine.MODE>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final XoodyakEngine.MODE
ModeHash

public static final XoodyakEngine.MODE
ModeKeyed

Constructor Summary

AccessConstructor and Description
private
MODE()

Method Summary

Modifier and TypeMethod and Description
public static XoodyakEngine.MODE
valueOf(String name)

public static XoodyakEngine.MODE[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ModeHashback to summary
public static final XoodyakEngine.MODE ModeHash
ModeKeyedback to summary
public static final XoodyakEngine.MODE ModeKeyed

Constructor Detail

MODEback to summary
private MODE()

Method Detail

valueOfback to summary
public static XoodyakEngine.MODE valueOf(String name)
valuesback to summary
public static XoodyakEngine.MODE[] values()