AsconAEAD128Engine
for future implementations.public class AsconEngine
extends java.lang.Object
AsconEngine
class provides an implementation of ASCON AEAD version 1.2,
based on the official specification available at:
https://ascon.iaik.tugraz.at/ and the
updated specification document from the NIST competition:
ASCON Specification (Finalist Round)
.
This version references the C reference implementation provided by NIST, available at: ASCON C Reference Implementation (NIST Round 2) .
Modifier and Type | Class and Description |
---|---|
protected static class |
AsconBaseEngine.State |
static class |
AsconEngine.AsconParameters
Deprecated.
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
algorithmName |
protected int |
ASCON_AEAD_RATE |
protected long |
ASCON_IV |
protected long |
dsep |
protected boolean |
forEncryption |
protected byte[] |
initialAssociatedText |
protected int |
IV_SIZE |
protected long |
K0 |
protected long |
K1 |
protected int |
KEY_SIZE |
protected byte[] |
m_buf |
protected int |
m_bufferSizeDecrypt |
protected int |
m_bufPos |
protected AsconBaseEngine.State |
m_state |
protected byte[] |
mac |
protected int |
MAC_SIZE |
protected long |
N0 |
protected long |
N1 |
protected int |
nr |
protected long |
x0 |
protected long |
x1 |
protected long |
x2 |
protected long |
x3 |
protected long |
x4 |
Constructor and Description |
---|
AsconEngine(AsconEngine.AsconParameters asconParameters)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
protected void |
ascon_aeadinit()
Deprecated.
|
protected void |
checkAAD() |
protected boolean |
checkData() |
int |
doFinal(byte[] outBytes,
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.
|
java.lang.String |
getAlgorithmVersion()
Deprecated.
|
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[] key,
byte[] iv)
Deprecated.
|
protected long |
loadBytes(byte[] in,
int inOff)
Deprecated.
|
protected void |
p(int nr) |
protected long |
pad(int i)
Deprecated.
|
void |
processAADByte(byte in)
Add a single byte to the associated data check.
|
void |
processAADBytes(byte[] inBytes,
int inOff,
int len)
Add a sequence of bytes to the associated data check.
|
protected void |
processBufferAAD(byte[] buffer,
int inOff) |
protected void |
processBufferDecrypt(byte[] buffer,
int bufOff,
byte[] output,
int outOff) |
protected void |
processBufferEncrypt(byte[] buffer,
int bufOff,
byte[] output,
int outOff) |
int |
processByte(byte in,
byte[] out,
int outOff)
encrypt/decrypt a single byte.
|
int |
processBytes(byte[] inBytes,
int inOff,
int len,
byte[] outBytes,
int outOff)
process a block of bytes from in putting the result into out.
|
protected void |
processFinalAadBlock()
Deprecated.
|
protected void |
processFinalDecrypt(byte[] input,
int inLen,
byte[] output,
int outOff)
Deprecated.
|
protected void |
processFinalEncrypt(byte[] input,
int inLen,
byte[] output,
int outOff)
Deprecated.
|
void |
reset()
Reset the cipher.
|
protected void |
reset(boolean clearMac) |
protected void |
setBytes(long n,
byte[] bs,
int off)
Deprecated.
|
protected AsconBaseEngine.State m_state
protected int nr
protected int ASCON_AEAD_RATE
protected long K0
protected long K1
protected long N0
protected long N1
protected long ASCON_IV
protected long x0
protected long x1
protected long x2
protected long x3
protected long x4
protected int m_bufferSizeDecrypt
protected byte[] m_buf
protected int m_bufPos
protected long dsep
protected boolean forEncryption
protected java.lang.String algorithmName
protected int KEY_SIZE
protected int IV_SIZE
protected int MAC_SIZE
protected byte[] initialAssociatedText
protected byte[] mac
public AsconEngine(AsconEngine.AsconParameters asconParameters)
protected long pad(int i)
protected long loadBytes(byte[] in, int inOff)
protected void setBytes(long n, byte[] bs, int off)
protected void ascon_aeadinit()
protected void processFinalAadBlock()
protected void processFinalDecrypt(byte[] input, int inLen, byte[] output, int outOff)
protected void processFinalEncrypt(byte[] input, int inLen, byte[] output, int outOff)
protected void init(byte[] key, byte[] iv) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public java.lang.String getAlgorithmVersion()
protected void p(int nr)
protected void checkAAD()
protected boolean checkData()
protected void processBufferAAD(byte[] buffer, int inOff)
protected void processBufferDecrypt(byte[] buffer, int bufOff, byte[] output, int outOff)
protected void processBufferEncrypt(byte[] buffer, int bufOff, byte[] output, int outOff)
public void processAADByte(byte in)
AEADCipher
in
- the byte to be processed.public void processAADBytes(byte[] inBytes, int inOff, int len)
AEADCipher
inBytes
- 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.public int processBytes(byte[] inBytes, int inOff, int len, byte[] outBytes, int outOff) throws DataLengthException
AEADCipher
inBytes
- 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.outBytes
- the output buffer the processed bytes go into.outOff
- the offset into the output byte array the processed data starts at.DataLengthException
- if the output buffer is too small.public int doFinal(byte[] outBytes, int outOff) throws java.lang.IllegalStateException, InvalidCipherTextException, DataLengthException
AEADCipher
outBytes
- space for any resulting output data.outOff
- offset into out to start copying the data at.java.lang.IllegalStateException
- if the cipher is in an inappropriate state.InvalidCipherTextException
- if the MAC fails to match.DataLengthException
public int getUpdateOutputSize(int len)
AEADCipher
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.
len
- the length of the input.public int getOutputSize(int len)
AEADCipher
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)
.
len
- the length of the input.protected void reset(boolean clearMac)
public java.lang.String getAlgorithmName()
AEADCipher
getAlgorithmName
in interface AEADCipher
public int getKeyBytesSize()
public int getIVBytesSize()
public byte[] getMac()
AEADCipher
getMac
in interface AEADCipher
public void reset()
AEADCipher
reset
in interface AEADCipher
public int processByte(byte in, byte[] out, int outOff) throws DataLengthException
AEADCipher
processByte
in interface AEADCipher
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.DataLengthException
- if the output buffer is too small.public void init(boolean forEncryption, CipherParameters params)
AEADCipher
init
in interface AEADCipher
forEncryption
- true if we are setting up for encryption, false otherwise.params
- the necessary parameters for the underlying cipher to be initialised.