Overview | Package | Class | Tree | Deprecated | Index | Help
| Bouncy Castle Cryptography Library 1.84
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.bouncycastle.crypto
Interface BlockCipher

All Known Subinterfaces:
  CBCModeCipher, CFBModeCipher, CTRModeCipher, MultiBlockCipher

All Known Implementing Classes:
  AESFastEngine, AESLightEngine, ARIAEngine, BlowfishEngine, CamelliaEngine, CamelliaLightEngine, CAST5Engine, CBCBlockCipher, CFBBlockCipher, DefaultMultiBlockCipher, DESedeEngine, DESEngine, DSTU7624Engine, G3413CBCBlockCipher, GOST28147Engine, GOST3412_2015Engine, IDEAEngine, LEAEngine, NoekeonEngine, NullEngine, OpenPGPCFBBlockCipher, PGPCFBBlockCipher, RC2Engine, RC532Engine, RC564Engine, RC6Engine, RijndaelEngine, SEEDEngine, SerpentEngineBase, Shacal2Engine, SICBlockCipher, SkipjackEngine, SM4Engine, TEAEngine, ThreefishEngine, TwofishEngine, XTEAEngine

public interface BlockCipher

Block cipher engines are expected to conform to this interface.

Method Summary
`java.lang.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[] input, int inOff, byte[] output, int outOff)` Process one block of input from the array in and write it to the out array.
`void` | `reset()` Reset the cipher.

Method Detail

### init

    public void init(boolean forEncryption,
                     CipherParameters params)
              throws java.lang.IllegalArgumentException

  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.
  Throws:
    `java.lang.IllegalArgumentException` - if the params argument is inappropriate.

### getAlgorithmName

    public java.lang.String getAlgorithmName()

  Return the name of the algorithm the cipher implements.

  Returns:
    the name of the algorithm the cipher implements.

### getBlockSize

    public int getBlockSize()

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

  Returns:
    the block size for this cipher in bytes.

### processBlock

    public int processBlock(byte[] input,
                            int inOff,
                            byte[] output,
                            int outOff)
                     throws DataLengthException,
                            java.lang.IllegalStateException

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

  Parameters:
    `input` - the array containing the input data.
    `inOff` - offset into the in array the data starts at.
    `output` - 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.
    `java.lang.IllegalStateException` - if the cipher isn't initialised.

### reset

    public 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).

Overview | Package | Class | Tree | Deprecated | Index | Help
| Bouncy Castle Cryptography Library 1.84
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD