Class PhotonBeetleEngine

  • All Implemented Interfaces:
    AEADCipher

    public class PhotonBeetleEngine
    extends java.lang.Object
    Photon-Beetle, https://csrc.nist.gov/CSRC/media/Projects/lightweight-cryptography/documents/finalist-round/updated-spec-doc/photon-beetle-spec-final.pdf

    Photon-Beetle with reference to C Reference Impl from: https://github.com/PHOTON-Beetle/Software

    • Field Detail

      • m_buf

        protected byte[] m_buf
      • m_aad

        protected byte[] m_aad
      • m_bufPos

        protected int m_bufPos
      • m_aadPos

        protected int m_aadPos
      • aadFinished

        protected boolean aadFinished
      • initialised

        protected boolean initialised
      • AADBufferSize

        protected int AADBufferSize
      • BlockSize

        protected int BlockSize
      • m_state

        protected org.bouncycastle.crypto.engines.AEADBufferBaseEngine.State m_state
      • forEncryption

        protected boolean forEncryption
      • algorithmName

        protected java.lang.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
    • Method Detail

      • init

        protected void init​(byte[] key,
                            byte[] iv)
                     throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException
      • processBufferAAD

        protected void processBufferAAD​(byte[] input,
                                        int inOff)
      • processBuffer

        protected void processBuffer​(byte[] input,
                                     int inOff,
                                     byte[] output,
                                     int outOff)
      • processAADByte

        public void processAADByte​(byte input)
        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:
        input - the byte to be processed.
      • processAADBytes

        public void processAADBytes​(byte[] input,
                                    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:
        input - 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[] input,
                                int inOff,
                                int len,
                                byte[] output,
                                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:
        input - 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.
        output - 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.
      • processFinalBlock

        protected void processFinalBlock​(byte[] output,
                                         int outOff)
      • processFinalAAD

        protected void processFinalAAD()
      • reset

        protected void reset​(boolean clearMac)
      • doFinal

        public int doFinal​(byte[] output,
                           int outOff)
                    throws java.lang.IllegalStateException,
                           InvalidCipherTextException
        Description copied from interface: AEADCipher
        Finish the operation either appending or verifying the MAC at the end of the data.
        Parameters:
        output - space for any resulting output data.
        outOff - offset into out to start copying the data at.
        Returns:
        number of bytes written into out.
        Throws:
        java.lang.IllegalStateException - if the cipher is in an inappropriate state.
        InvalidCipherTextException - if the MAC fails to match.
      • getBlockSize

        public int getBlockSize()
      • 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.
      • checkAAD

        protected void checkAAD()
      • checkData

        protected boolean checkData()
      • bufferReset

        protected void bufferReset()
      • validateAndProcessBuffer

        protected void validateAndProcessBuffer​(byte[] input,
                                                int inOff,
                                                byte[] output,
                                                int outOff)
      • getAlgorithmName

        public java.lang.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.