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

public Class AsconEngine

extends Object
implements AEADCipher
Class Inheritance
All Implemented Interfaces
org.bouncycastle.crypto.modes.AEADCipher
Imports
org.bouncycastle.crypto.CipherParameters, .CryptoServicesRegistrar, .DataLengthException, .InvalidCipherTextException, .OutputLengthException, org.bouncycastle.crypto.constraints.DefaultServiceProperties, org.bouncycastle.crypto.modes.AEADCipher, org.bouncycastle.crypto.params.AEADParameters, .KeyParameter, .ParametersWithIV, org.bouncycastle.util.Arrays, .Longs, .Pack
ASCON AEAD v1.2, https://ascon.iaik.tugraz.at/ https://csrc.nist.gov/CSRC/media/Projects/lightweight-cryptography/documents/finalist-round/updated-spec-doc/ascon-spec-final.pdf

ASCON AEAD v1.2 with reference to C Reference Impl from: https://github.com/ascon/ascon-c

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
AsconEngine.AsconParameters

private static enum
AsconEngine.State

Field Summary

Modifier and TypeField and Description
private final String
algorithmName

private final int
ASCON_AEAD_RATE

private final long
ASCON_IV

private final AsconEngine.AsconParameters
asconParameters

private final int
CRYPTO_ABYTES

private final int
CRYPTO_KEYBYTES

private byte[]
initialAssociatedText

private long
K0

private long
K1

private long
K2

private final byte[]
m_buf

private final int
m_bufferSizeDecrypt

private int
m_bufPos

private AsconEngine.State
m_state

private byte[]
mac

private long
N0

private long
N1

private final int
nr

private long
x0

private long
x1

private long
x2

private long
x3

private long
x4

Constructor Summary

AccessConstructor and Description
public
AsconEngine(AsconEngine.AsconParameters asconParameters)

Method Summary

Modifier and TypeMethod and Description
private void
ascon_aeadinit()

private void
checkAAD()

private boolean
checkData()

public int
doFinal(byte[]
space for any resulting output data.
outBytes, 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.
private void
finishAAD(AsconEngine.State nextState)

private void
finishData(AsconEngine.State nextState)

public String
getAlgorithmName()

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

Return the name of the algorithm.
public String
getAlgorithmVersion()

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.
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
P(int nr)

private long
PAD(int i)

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

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

Add a single byte to the associated data check.
public void
processAADBytes(byte[]
the input byte array.
inBytes, 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.
private void
processBufferAAD(byte[] buffer, int inOff)

private void
processBufferDecrypt(byte[] buffer, int bufOff, byte[] output, int outOff)

private void
processBufferEncrypt(byte[] buffer, int bufOff, byte[] output, int outOff)

public int
processByte(byte
the byte to be processed.
in, byte[]
the output buffer the processed byte goes into.
out, 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.
inBytes, 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.
outBytes, 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.
private void
processFinalDecrypt(byte[] input, int inOff, int inLen, byte[] output, int outOff)

private void
processFinalEncrypt(byte[] input, int inOff, int inLen, byte[] output, int outOff)

public void
reset()

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

Reset the cipher.
private void
reset(boolean clearMac)

private void
ROUND(long C)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

algorithmNameback to summary
private final String algorithmName
ASCON_AEAD_RATEback to summary
private final int ASCON_AEAD_RATE
ASCON_IVback to summary
private final long ASCON_IV
asconParametersback to summary
private final AsconEngine.AsconParameters asconParameters
CRYPTO_ABYTESback to summary
private final int CRYPTO_ABYTES
CRYPTO_KEYBYTESback to summary
private final int CRYPTO_KEYBYTES
initialAssociatedTextback to summary
private byte[] initialAssociatedText
K0back to summary
private long K0
K1back to summary
private long K1
K2back to summary
private long K2
m_bufback to summary
private final byte[] m_buf
m_bufferSizeDecryptback to summary
private final int m_bufferSizeDecrypt
m_bufPosback to summary
private int m_bufPos
m_stateback to summary
private AsconEngine.State m_state
macback to summary
private byte[] mac
N0back to summary
private long N0
N1back to summary
private long N1
nrback to summary
private final int nr
x0back to summary
private long x0
x1back to summary
private long x1
x2back to summary
private long x2
x3back to summary
private long x3
x4back to summary
private long x4

Constructor Detail

AsconEngineback to summary
public AsconEngine(AsconEngine.AsconParameters asconParameters)

Method Detail

ascon_aeadinitback to summary
private void ascon_aeadinit()
checkAADback to summary
private void checkAAD()
checkDataback to summary
private boolean checkData()
doFinalback to summary
public int doFinal(byte[] outBytes, int outOff) throws IllegalStateException, InvalidCipherTextException, DataLengthException

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
outBytes: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.

Exceptions
IllegalStateException:
if the cipher is in an inappropriate state.
InvalidCipherTextException:
if the MAC fails to match.
finishAADback to summary
private void finishAAD(AsconEngine.State nextState)
finishDataback to summary
private void finishData(AsconEngine.State nextState)
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.

getAlgorithmVersionback to summary
public String getAlgorithmVersion()
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.

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.

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.

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.

Exceptions
IllegalArgumentException:
if the params argument is inappropriate.
Pback to summary
private void P(int nr)
PADback to summary
private long PAD(int i)
processAADByteback to summary
public void processAADByte(byte in)

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

the byte to be processed.

processAADBytesback to summary
public void processAADBytes(byte[] inBytes, 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
inBytes: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.

processBufferAADback to summary
private void processBufferAAD(byte[] buffer, int inOff)
processBufferDecryptback to summary
private void processBufferDecrypt(byte[] buffer, int bufOff, byte[] output, int outOff)
processBufferEncryptback to summary
private void processBufferEncrypt(byte[] buffer, int bufOff, byte[] output, int outOff)
processByteback to summary
public int processByte(byte in, byte[] out, 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
in:byte

the byte to be processed.

out: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.

Exceptions
DataLengthException:
if the output buffer is too small.
processBytesback to summary
public int processBytes(byte[] inBytes, int inOff, int len, byte[] outBytes, 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
inBytes: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.

outBytes: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.

Exceptions
DataLengthException:
if the output buffer is too small.
processFinalDecryptback to summary
private void processFinalDecrypt(byte[] input, int inOff, int inLen, byte[] output, int outOff)
processFinalEncryptback to summary
private void processFinalEncrypt(byte[] input, int inOff, int inLen, byte[] output, int outOff)
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).

resetback to summary
private void reset(boolean clearMac)
ROUNDback to summary
private void ROUND(long C)
org.bouncycastle.crypto.engines back to summary

public final Enum AsconEngine.AsconParameters

extends Enum<AsconEngine.AsconParameters>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final AsconEngine.AsconParameters
ascon128

public static final AsconEngine.AsconParameters
ascon128a

public static final AsconEngine.AsconParameters
ascon80pq

Constructor Summary

AccessConstructor and Description
private
AsconParameters()

Method Summary

Modifier and TypeMethod and Description
public static AsconEngine.AsconParameters
valueOf(String name)

public static AsconEngine.AsconParameters[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ascon128back to summary
public static final AsconEngine.AsconParameters ascon128
ascon128aback to summary
public static final AsconEngine.AsconParameters ascon128a
ascon80pqback to summary
public static final AsconEngine.AsconParameters ascon80pq

Constructor Detail

AsconParametersback to summary
private AsconParameters()

Method Detail

valueOfback to summary
public static AsconEngine.AsconParameters valueOf(String name)
valuesback to summary
public static AsconEngine.AsconParameters[] values()
org.bouncycastle.crypto.engines back to summary

private final Enum AsconEngine.State

extends Enum<AsconEngine.State>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final AsconEngine.State
DecAad

public static final AsconEngine.State
DecData

public static final AsconEngine.State
DecFinal

public static final AsconEngine.State
DecInit

public static final AsconEngine.State
EncAad

public static final AsconEngine.State
EncData

public static final AsconEngine.State
EncFinal

public static final AsconEngine.State
EncInit

public static final AsconEngine.State
Uninitialized

Constructor Summary

AccessConstructor and Description
private
State()

Method Summary

Modifier and TypeMethod and Description
public static AsconEngine.State
valueOf(String name)

public static AsconEngine.State[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DecAadback to summary
public static final AsconEngine.State DecAad
DecDataback to summary
public static final AsconEngine.State DecData
DecFinalback to summary
public static final AsconEngine.State DecFinal
DecInitback to summary
public static final AsconEngine.State DecInit
EncAadback to summary
public static final AsconEngine.State EncAad
EncDataback to summary
public static final AsconEngine.State EncData
EncFinalback to summary
public static final AsconEngine.State EncFinal
EncInitback to summary
public static final AsconEngine.State EncInit
Uninitializedback to summary
public static final AsconEngine.State Uninitialized

Constructor Detail

Stateback to summary
private State()

Method Detail

valueOfback to summary
public static AsconEngine.State valueOf(String name)
valuesback to summary
public static AsconEngine.State[] values()