Bouncy Castle Cryptography 1.11 API Specification: Class DESEngine

org.bouncycastle.crypto.engines
Class DESEngine

java.lang.Object
  |
  +--org.bouncycastle.crypto.engines.DESEngine

All Implemented Interfaces:

BlockCipher

Direct Known Subclasses:

DESedeEngine

public class DESEngine

extends java.lang.Object

implements BlockCipher

a class that provides a basic DES engine.

Field Summary

protected static int

BLOCK_SIZE

Constructor Summary

DESEngine()
standard constructor.

Method Summary

protected void	desFunc(int[] wKey, byte[] in, int inOff, byte[] out, int outOff) the DES engine.
protected int[]	generateWorkingKey(boolean encrypting, byte[] key) generate an integer based working key based on our secret key and what we processing we are planning to do.
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 encrypting, CipherParameters params) initialise a DES 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 Detail

BLOCK_SIZE

protected static final int BLOCK_SIZE

Constructor Detail

DESEngine

public DESEngine()

standard constructor.

Method Detail

init

public void init(boolean encrypting,
                 CipherParameters params)

initialise a DES cipher.

Specified by:

init in interface BlockCipher

Parameters:

forEncryption - whether or not we are for encryption.

params - the parameters required to set up the cipher.

Throws:

java.lang.IllegalArgumentException - if the params argument is inappropriate.

getAlgorithmName

public java.lang.String getAlgorithmName()

Description copied from interface: BlockCipher

Return the name of the algorithm the cipher implements.

Specified by:

getAlgorithmName in interface BlockCipher

Following copied from interface: org.bouncycastle.crypto.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

Following copied from interface: org.bouncycastle.crypto.BlockCipher

Returns:

the block size for this cipher in bytes.

processBlock

public int processBlock(byte[] in,
                        int inOff,
                        byte[] out,
                        int outOff)

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

Following copied from interface: org.bouncycastle.crypto.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 in, or space in out.

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

generateWorkingKey

protected int[] generateWorkingKey(boolean encrypting,
                                   byte[] key)

generate an integer based working key based on our secret key and what we processing we are planning to do. Acknowledgements for this routine go to James Gillogly & Phil Karn. (whoever, and wherever they are!).

desFunc

protected void desFunc(int[] wKey,
                       byte[] in,
                       int inOff,
                       byte[] out,
                       int outOff)

the DES engine.