org.cryptacular.spec

Class BufferedBlockCipherSpec

java.lang.Object

org.cryptacular.spec.BufferedBlockCipherSpec

All Implemented Interfaces:

Spec<org.bouncycastle.crypto.BufferedBlockCipher>

Direct Known Subclasses:

KeyedBlockCipherSpec

public class BufferedBlockCipherSpec
extends java.lang.Object
implements Spec<org.bouncycastle.crypto.BufferedBlockCipher>

Describes a block cipher in terms of a (algorithm, mode, padding) tuple and provides a facility to create a new instance of the cipher via the newInstance() method.

Version:

$Revision: 2744 $

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	algorithm Cipher algorithm algorithm.
static java.util.regex.Pattern	FORMAT String specification format, algorithm/mode/padding.
private java.lang.String	mode Cipher mode, e.g.
private java.lang.String	padding Cipher padding scheme, e.g.

Constructor Summary

Constructors

Constructor and Description
BufferedBlockCipherSpec(java.lang.String algName) Creates a new instance from an algorithm name.
BufferedBlockCipherSpec(java.lang.String algName, java.lang.String cipherMode) Creates a new instance from a cipher algorithm and mode.
BufferedBlockCipherSpec(java.lang.String algName, java.lang.String cipherMode, java.lang.String cipherPadding) Creates a new instance from the given cipher specifications.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlgorithm()
BlockCipherSpec	getBlockCipherSpec() Gets the simple block cipher specification corresponding to this instance.
java.lang.String	getMode() Gets the cipher mode.
java.lang.String	getPadding() Gets the cipher padding scheme.
private static org.bouncycastle.crypto.paddings.BlockCipherPadding	getPadding(java.lang.String padding) Gets a instance of block cipher padding from a padding name string.
org.bouncycastle.crypto.BufferedBlockCipher	newInstance() Creates a new buffered block cipher from the specification in this instance.
static BufferedBlockCipherSpec	parse(java.lang.String specification) Parses a string representation of a buffered block cipher specification into an instance of this class.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT

public static final java.util.regex.Pattern FORMAT

String specification format, algorithm/mode/padding.

algorithm

private final java.lang.String algorithm

Cipher algorithm algorithm.

mode

private final java.lang.String mode

Cipher mode, e.g. CBC, OFB.

padding

private final java.lang.String padding

Cipher padding scheme, e.g. PKCS5Padding.

Constructor Detail

BufferedBlockCipherSpec

public BufferedBlockCipherSpec(java.lang.String algName)

Creates a new instance from an algorithm name.

Parameters:

algName - Cipher algorithm name.

BufferedBlockCipherSpec

public BufferedBlockCipherSpec(java.lang.String algName,
                               java.lang.String cipherMode)

Creates a new instance from a cipher algorithm and mode.

Parameters:

algName - Cipher algorithm name.

cipherMode - Cipher mode.

BufferedBlockCipherSpec

public BufferedBlockCipherSpec(java.lang.String algName,
                               java.lang.String cipherMode,
                               java.lang.String cipherPadding)

Creates a new instance from the given cipher specifications.

Parameters:

algName - Cipher algorithm name.

cipherMode - Cipher mode.

cipherPadding - Cipher padding scheme algorithm.

Method Detail

getAlgorithm

public java.lang.String getAlgorithm()

Specified by:

getAlgorithm in interface Spec<org.bouncycastle.crypto.BufferedBlockCipher>

Returns:

Cryptographic algorithm name.

getMode

public java.lang.String getMode()

Gets the cipher mode.

Returns:

Cipher mode, e.g. CBC, OFB.

getPadding

public java.lang.String getPadding()

Gets the cipher padding scheme.

Returns:

Padding scheme algorithm, e.g. PKCS5Padding. The following names are equivalent for no padding: NULL, Zero, None.

getBlockCipherSpec

public BlockCipherSpec getBlockCipherSpec()

Gets the simple block cipher specification corresponding to this instance.

Returns:

Simple block cipher specification.

newInstance

public org.bouncycastle.crypto.BufferedBlockCipher newInstance()

Creates a new buffered block cipher from the specification in this instance.

Specified by:

newInstance in interface Spec<org.bouncycastle.crypto.BufferedBlockCipher>

Returns:

New buffered block cipher instance.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parse

public static BufferedBlockCipherSpec parse(java.lang.String specification)

Parses a string representation of a buffered block cipher specification into an instance of this class.

Parameters:

specification - Block cipher specification of the form algorithm/mode/padding.

Returns:

Buffered block cipher specification instance.

getPadding

private static org.bouncycastle.crypto.paddings.BlockCipherPadding getPadding(java.lang.String padding)

Gets a instance of block cipher padding from a padding name string.

Parameters:

padding - Name of padding algorithm.

Returns:

Block cipher padding instance.