Interface BlockCipher

  • All Implemented Interfaces:

    
    public interface BlockCipher
    
                        

    Block cipher engines are expected to conform to this interface.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract void init(boolean forEncryption, CipherParameters params) Initialise the cipher.
      abstract String getAlgorithmName() Return the name of the algorithm the cipher implements.
      abstract int getBlockSize() Return the block size for this cipher (in bytes).
      abstract int processBlock(Array<byte> in, int inOff, Array<byte> out, int outOff) Process one block of input from the array in and write it to the out array.
      abstract void reset() Reset the cipher.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • init

         abstract void init(boolean forEncryption, CipherParameters params)

        Initialise the cipher.

        Parameters:
        forEncryption - if true the cipher is initialised for encryption, if false for decryption.
        params - the key and other data required by the cipher.
      • getAlgorithmName

         abstract String getAlgorithmName()

        Return the name of the algorithm the cipher implements.

        Returns:

        the name of the algorithm the cipher implements.

      • getBlockSize

         abstract int getBlockSize()

        Return the block size for this cipher (in bytes).

        Returns:

        the block size for this cipher in bytes.

      • processBlock

         abstract int processBlock(Array<byte> in, int inOff, Array<byte> out, int outOff)

        Process one block of input from the array in and write it to the out array.

        Parameters:
        in - the array containing the input data.
        inOff - offset into the in array the data starts at.
        out - the array the output data will be copied into.
        outOff - the offset into the out array the output will start at.
        Returns:

        the number of bytes processed and produced.

      • reset

         abstract void reset()

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