Class AsconEngine

java.lang.Object
org.bouncycastle.crypto.engines.AsconEngine
All Implemented Interfaces:
AEADCipher

public class AsconEngine extends Object
Deprecated.
Now superseded. Please refer to AsconAEAD128Engine for future implementations.
The 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) .

  • Field Details

    • m_state

      protected org.bouncycastle.crypto.engines.AsconBaseEngine.State m_state
    • nr

      protected int nr
    • ASCON_AEAD_RATE

      protected int ASCON_AEAD_RATE
    • K0

      protected long K0
    • K1

      protected long K1
    • N0

      protected long N0
    • N1

      protected long N1
    • ASCON_IV

      protected long ASCON_IV
    • x0

      protected long x0
    • x1

      protected long x1
    • x2

      protected long x2
    • x3

      protected long x3
    • x4

      protected long x4
    • m_bufferSizeDecrypt

      protected int m_bufferSizeDecrypt
    • m_buf

      protected byte[] m_buf
    • m_bufPos

      protected int m_bufPos
    • dsep

      protected long dsep
    • forEncryption

      protected boolean forEncryption
    • algorithmName

      protected String algorithmName
    • KEY_SIZE

      protected int KEY_SIZE
    • IV_SIZE

      protected int IV_SIZE
    • MAC_SIZE

      protected int MAC_SIZE
    • initialAssociatedText

      protected byte[] initialAssociatedText
    • mac

      protected byte[] mac
  • Constructor Details

  • Method Details

    • pad

      protected long pad(int i)
      Deprecated.
    • loadBytes

      protected long loadBytes(byte[] in, int inOff)
      Deprecated.
    • setBytes

      protected void setBytes(long n, byte[] bs, int off)
      Deprecated.
    • ascon_aeadinit

      protected void ascon_aeadinit()
      Deprecated.
    • processFinalAadBlock

      protected void processFinalAadBlock()
      Deprecated.
    • processFinalDecrypt

      protected void processFinalDecrypt(byte[] input, int inLen, byte[] output, int outOff)
      Deprecated.
    • processFinalEncrypt

      protected void processFinalEncrypt(byte[] input, int inLen, byte[] output, int outOff)
      Deprecated.
    • init

      protected void init(byte[] key, byte[] iv) throws IllegalArgumentException
      Deprecated.
      Throws:
      IllegalArgumentException
    • getAlgorithmVersion

      public String getAlgorithmVersion()
      Deprecated.
    • p

      protected void p(int nr)
    • checkAAD

      protected void checkAAD()
    • checkData

      protected boolean checkData()
    • processBufferAAD

      protected void processBufferAAD(byte[] buffer, int inOff)
    • processBufferDecrypt

      protected void processBufferDecrypt(byte[] buffer, int bufOff, byte[] output, int outOff)
    • processBufferEncrypt

      protected void processBufferEncrypt(byte[] buffer, int bufOff, byte[] output, int outOff)
    • 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.
      Parameters:
      in - the byte to be processed.
    • processAADBytes

      public void processAADBytes(byte[] inBytes, 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:
      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.
    • processBytes

      public int processBytes(byte[] inBytes, int inOff, int len, byte[] outBytes, int outOff) throws DataLengthException
      Description copied from interface: AEADCipher
      process a block of bytes from in putting the result into out.
      Parameters:
      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.
      Returns:
      the number of bytes written to out.
      Throws:
      DataLengthException - if the output buffer is too small.
    • doFinal

      public int doFinal(byte[] outBytes, int outOff) throws IllegalStateException, InvalidCipherTextException, DataLengthException
      Description copied from interface: AEADCipher
      Finish the operation either appending or verifying the MAC at the end of the data.
      Parameters:
      outBytes - 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.
      DataLengthException
    • 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)
    • 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.
    • 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 interface AEADCipher
      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 interface AEADCipher
    • 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.
    • 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 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.