iaik.pkcs.pkcs11.provider.ciphers

Class AesCipher

java.lang.Object

javax.crypto.CipherSpi

iaik.pkcs.pkcs11.provider.ciphers.PKCS11Cipher

iaik.pkcs.pkcs11.provider.ciphers.BlockCipher

iaik.pkcs.pkcs11.provider.ciphers.AesCipher

All Implemented Interfaces:

PKCS11EngineClass

public class AesCipher
extends BlockCipher

This is an implementation of a AES Cipher class that uses the IAIK PKCS#11 wrapper to access the token. It only works with IAIKPKCS11SecretKey.

Author:

Karl Scheibelhofer

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CIPHER_NAME The JCE name of this cipher.
protected static java.util.Hashtable	cipherModePaddingMechansims_ The mapping from mode + "/" + padding to the cryptoki mechanism for DES.
protected static iaik.pkcs.pkcs11.Mechanism	DEFAULT_MECHANISM The defualt mechanism for this cipher.
protected static java.util.Vector	supportedModes_ The supported modes of operation of this cipher.

Fields inherited from class iaik.pkcs.pkcs11.provider.ciphers.BlockCipher

DEFAULT_MODE, DEFAULT_PADDING, externalPadding_, externalPaddings_, ivParameterSpec_, ivParameterSpecChanged_, modePaddingMechanisms_, supportedPaddings_

Fields inherited from class iaik.pkcs.pkcs11.provider.ciphers.PKCS11Cipher

currentKeyIsSoftwareKey_, DUMMY_DATA, initialized_, key_, keyObject_, mechanism_, mode_, modeChanged_, operationMode_, padding_, paddingChanged_, parameters_, parameterSpecs_, pkcs11OperationInitialized_, session_, softwareDelegate_, tokenManager_, unwrapTemplate_, updateUsed_, usedMechanismInfos_, usedMechanisms_

Constructor Summary

Constructors

Constructor and Description
AesCipher() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	checkKeyObject(iaik.pkcs.pkcs11.objects.Key keyObject) Check the given key object, if it is acceptable for this cipher.
protected java.lang.String	getAlgorithmName() Get the JCE name of this cipher algorithm.
protected iaik.pkcs.pkcs11.Mechanism	getDefaultMechanism() Get the default mechanism of this cipher.
protected java.util.Hashtable	getModePaddingMechanisms() Get the hashtable that maps from mode + "/" + padding to the cryptoki mechanism.
protected int	getOutputSize(int inputLen) Returns the length in bytes that an output buffer would need to be in order to hold the result of the next update or doFinal operation, given the input length inputLen (in bytes).
protected iaik.pkcs.pkcs11.MechanismInfo[][]	getUsedMechanismFeatures() Returns a two-dimensional array of MechanismInfos that this engine class uses.
protected iaik.pkcs.pkcs11.Mechanism[]	getUsedMechanisms() Returns an array of Mechanisms that this engine class uses.
protected boolean	isModeSupported(java.lang.String mode) Check, if the given mode of operation is supported by this cipher.
protected int	pkcs11GetBlockSize() Get the block size of this cipher algorithm.
protected int	pkcs11GetKeySize(java.security.Key key) Determines the key size in bits.

Methods inherited from class iaik.pkcs.pkcs11.provider.ciphers.BlockCipher

getDefaultMode, getDefaultPadding, getMechanism, getMechanismForModeAndPadding, isExternalPaddingSupported, isPaddingSupported, pkcs11DoFinal, pkcs11GetIV, pkcs11GetParameters, pkcs11Init, pkcs11Init, pkcs11Update

Methods inherited from class iaik.pkcs.pkcs11.provider.ciphers.PKCS11Cipher

engineDoFinal, engineDoFinal, engineGetBlockSize, engineGetIV, engineGetKeySize, engineGetOutputSize, engineGetParameters, engineInit, engineInit, engineInit, engineSetMode, engineSetPadding, engineUnwrap, engineUpdate, engineUpdate, engineUpdateAAD, engineWrap, finalize, finalizePkcs11Operation, getFullAlgorithmName, initialize, initializePkcs11Operation, initializeSession, initializeSoftwareDelegate, isSupportedBy, pkcs11DoFinal, pkcs11GetOutputSize, pkcs11Init, pkcs11Unwrap, pkcs11Update, pkcs11Wrap, updateAAD, updateAAD, updateAAD

Methods inherited from class javax.crypto.CipherSpi

engineDoFinal, engineUpdate, engineUpdateAAD

Methods inherited from class java.lang.Object

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

Field Detail

CIPHER_NAME

protected static final java.lang.String CIPHER_NAME

The JCE name of this cipher.

See Also:

Constant Field Values

DEFAULT_MECHANISM

protected static final iaik.pkcs.pkcs11.Mechanism DEFAULT_MECHANISM

The defualt mechanism for this cipher.

supportedModes_

protected static java.util.Vector supportedModes_

The supported modes of operation of this cipher.

cipherModePaddingMechansims_

protected static java.util.Hashtable cipherModePaddingMechansims_

The mapping from mode + "/" + padding to the cryptoki mechanism for DES.

Constructor Detail

AesCipher

public AesCipher()

Default constructor.

Method Detail

getUsedMechanisms

protected iaik.pkcs.pkcs11.Mechanism[] getUsedMechanisms()

Returns an array of Mechanisms that this engine class uses. For each of this mechanisms, the engine must provide at least one MechanismInfo via the getRequiredMechanismFeatures() method.

Overrides:

getUsedMechanisms in class PKCS11Cipher

Returns:

An array that includes all used pkcs#11 mechanisms. The token must support at least one of these mechanisms. The dimension is equal to the first array dimension of getUsedMechanismFeatures(). May be empty, but must not be null.

Postconditions:

(result <> null) and (result.length == getUsedMechanismFeatures().length)

getUsedMechanismFeatures

protected iaik.pkcs.pkcs11.MechanismInfo[][] getUsedMechanismFeatures()

Returns a two-dimensional array of MechanismInfos that this engine class uses. For each mechanism used by this engine, the engine must provide at least one MechanismInfo. The first dimension (index) of the returned array corresponds to the used mechanism as returned by getUsedMechanisms(). The array at this index is the list of used feature combinations used by this engine. The current token must at least support one mechanism and one of the feature combinations (expressed as a MechanismInfo) of the same mechanism.

Overrides:

getUsedMechanismFeatures in class BlockCipher

Returns:

A two-dimensional array that includes MechanismInfo objects. The first dimension is equal to the array dimension of getUsedMechanisms(). The token must at least support one of these features.

Postconditions:

(result <> null) and (result.length > 0) and (result.length == getUsedMechanisms().length)

checkKeyObject

protected void checkKeyObject(iaik.pkcs.pkcs11.objects.Key keyObject)
                       throws java.security.InvalidKeyException

Check the given key object, if it is acceptable for this cipher. Throw an exception, if not.

Overrides:

checkKeyObject in class BlockCipher

Parameters:

keyObject - The key object to check.

Throws:

java.security.InvalidKeyException - If this cipher cannot work with this type of key object.

Preconditions:

(key <> null)

getAlgorithmName

protected java.lang.String getAlgorithmName()

Get the JCE name of this cipher algorithm.

Specified by:

getAlgorithmName in class PKCS11Cipher

Returns:

The JCE name of this cipher algorithm; e.g. RSA.

getModePaddingMechanisms

protected java.util.Hashtable getModePaddingMechanisms()

Get the hashtable that maps from mode + "/" + padding to the cryptoki mechanism.

Specified by:

getModePaddingMechanisms in class BlockCipher

Returns:

The hashtable that maps from mode + "/" + padding to the cryptoki mechanism.

Postconditions:

(result <> null)

getDefaultMechanism

protected iaik.pkcs.pkcs11.Mechanism getDefaultMechanism()

Get the default mechanism of this cipher. This must work with the default mode of operation and padding

Specified by:

getDefaultMechanism in class BlockCipher

Returns:

The default mechanism; e.g. Mechanism.DES_ECB.

Postconditions:

(result <> null)

getOutputSize

protected int getOutputSize(int inputLen)

Returns the length in bytes that an output buffer would need to be in order to hold the result of the next update or doFinal operation, given the input length inputLen (in bytes). This call takes into account any unprocessed (buffered) data from a previous update call, and padding. The actual output length of the next update or doFinal call may be smaller than the length returned by this method.

Parameters:

inputLen - The length of the input data in bytes.

Returns:

The (maximum) length of the output in bytes or -1, if unknown.

pkcs11GetKeySize

protected int pkcs11GetKeySize(java.security.Key key)
                        throws java.security.InvalidKeyException

Determines the key size in bits.

Specified by:

pkcs11GetKeySize in class BlockCipher

Parameters:

key - The key to get the length for.

Returns:

The key's length in bits.

Throws:

java.security.InvalidKeyException - If the given key is not supported by this class.

Preconditions:

(key <> null)

pkcs11GetBlockSize

protected int pkcs11GetBlockSize()

Get the block size of this cipher algorithm. This is always 16 bytes (128 bit) for AES.

Specified by:

pkcs11GetBlockSize in class BlockCipher

Returns:

The block size in bytes or -1, if unknown.

isModeSupported

protected boolean isModeSupported(java.lang.String mode)

Check, if the given mode of operation is supported by this cipher.

Overrides:

isModeSupported in class BlockCipher

Parameters:

mode - The mode to check.

Returns:

True, if the mode is supported, false otherwise.