Package org.bouncycastle.crypto.engines

Class NullEngine

java.lang.Object
org.bouncycastle.crypto.engines.NullEngine
All Implemented Interfaces:
BlockCipher
public class NullEngine extends Object implements BlockCipher
The no-op engine that just copies bytes through, irrespective of whether encrypting and decrypting. Provided for the sake of completeness.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final int
    DEFAULT_BLOCK_SIZE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    NullEngine()
    Constructs a null engine with a block size of 1 byte.
    NullEngine(int blockSize)
    Constructs a null engine with a specific block size.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAlgorithmName()
    Return the name of the algorithm the cipher implements.
    int
    getBlockSize()
    Return the block size for this cipher (in bytes).
    void
    init(boolean forEncryption, CipherParameters params)
    Initialise the cipher.
    int
    processBlock(byte[] in, int inOff, byte[] out, int outOff)
    Process one block of input from the array in and write it to the out array.
    void
    reset()
    Reset the cipher.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • NullEngine

      public NullEngine()
      Constructs a null engine with a block size of 1 byte.

    • NullEngine

      public NullEngine(int blockSize)
      Constructs a null engine with a specific block size.
      Parameters:
      blockSize - the block size in bytes.

  • Method Details

    • init

      public void init(boolean forEncryption, CipherParameters params) throws IllegalArgumentException
      Description copied from interface: BlockCipher
      Initialise the cipher.
      Specified by:
      init in interface BlockCipher
      Parameters:
      forEncryption - if true the cipher is initialised for encryption, if false for decryption.
      params - the key and other data required by the cipher.
      Throws:
      IllegalArgumentException - if the params argument is inappropriate.

    • getAlgorithmName

      public String getAlgorithmName()
      Description copied from interface: BlockCipher
      Return the name of the algorithm the cipher implements.
      Specified by:
      getAlgorithmName in interface BlockCipher
      Returns:
      the name of the algorithm the cipher implements.

    • getBlockSize

      public int getBlockSize()
      Description copied from interface: BlockCipher
      Return the block size for this cipher (in bytes).
      Specified by:
      getBlockSize in interface BlockCipher
      Returns:
      the block size for this cipher in bytes.

    • processBlock

      public int processBlock(byte[] in, int inOff, byte[] out, int outOff) throws DataLengthException, IllegalStateException
      Description copied from interface: BlockCipher
      Process one block of input from the array in and write it to the out array.
      Specified by:
      processBlock in interface BlockCipher
      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.
      Throws:
      DataLengthException - if there isn't enough data in input , or space in out.
      IllegalStateException - if the cipher isn't initialised.

    • reset

      public void reset()
      Description copied from interface: BlockCipher
      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 BlockCipher