iaik.pkcs.pkcs11.provider.ciphers

Class Rc2Cipher

java.lang.Object

javax.crypto.CipherSpi

iaik.pkcs.pkcs11.provider.ciphers.PKCS11Cipher

iaik.pkcs.pkcs11.provider.ciphers.BlockCipher

iaik.pkcs.pkcs11.provider.ciphers.Rc2Cipher

All Implemented Interfaces:

PKCS11EngineClass

public class Rc2Cipher
extends BlockCipher

This is an implementation of a RC2 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 RC2.
protected static iaik.pkcs.pkcs11.Mechanism	DEFAULT_MECHANISM The defualt mechanism for this cipher.
protected javax.crypto.spec.RC2ParameterSpec	rc2ParameterSpec_ The current RC2 cipher parameter.
protected boolean	rc2ParameterSpecChanged_ Indicates that the rc2ParameterSpec_ has been changed.

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

DEFAULT_MODE, DEFAULT_PADDING, externalPadding_, externalPaddings_, ivParameterSpec_, ivParameterSpecChanged_, modePaddingMechanisms_, supportedModes_, 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
Rc2Cipher() 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 iaik.pkcs.pkcs11.Mechanism	getMechanism() Get the current mechanism of this cipher object.
protected java.util.Hashtable	getModePaddingMechanisms() Get the hashtable that maps from mode + "/" + padding to the cryptoki mechanism.
protected iaik.pkcs.pkcs11.Mechanism[]	getUsedMechanisms() Returns an array of Mechanisms that this engine class uses.
protected int	pkcs11GetBlockSize() Get the block size of this cipher algorithm.
protected int	pkcs11GetKeySize(java.security.Key key) Determines the key size in bits.
protected int	pkcs11GetOutputSize(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 void	pkcs11Init(int operationMode, java.security.Key key, java.security.spec.AlgorithmParameterSpec parameterSpecs, java.security.SecureRandom randomSource) Initialize this cipher for an operation.

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

getDefaultMode, getDefaultPadding, getMechanismForModeAndPadding, getUsedMechanismFeatures, isExternalPaddingSupported, isModeSupported, isPaddingSupported, pkcs11DoFinal, pkcs11GetIV, pkcs11GetParameters, 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, 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.

cipherModePaddingMechansims_

protected static java.util.Hashtable cipherModePaddingMechansims_

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

rc2ParameterSpec_

protected javax.crypto.spec.RC2ParameterSpec rc2ParameterSpec_

The current RC2 cipher parameter.

rc2ParameterSpecChanged_

protected boolean rc2ParameterSpecChanged_

Indicates that the rc2ParameterSpec_ has been changed. The mechanism needs to be updated.

Constructor Detail

Rc2Cipher

public Rc2Cipher()

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)

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.RC2_ECB.

Postconditions:

(result <> null)

getMechanism

protected iaik.pkcs.pkcs11.Mechanism getMechanism()

Get the current mechanism of this cipher object. This may change with the mode of operation and padding. This mechanism must also include any required parameter objects.

Overrides:

getMechanism in class BlockCipher

Returns:

The mechanism this object uses for encryption and decryption. If the currently set combination of mode and padding is unsupported, this method returns null.

pkcs11GetOutputSize

protected int pkcs11GetOutputSize(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.

Overrides:

pkcs11GetOutputSize in class PKCS11Cipher

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 the same as the current key size, but in bytes.

Specified by:

pkcs11GetBlockSize in class BlockCipher

Returns:

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

pkcs11Init

protected void pkcs11Init(int operationMode,
                          java.security.Key key,
                          java.security.spec.AlgorithmParameterSpec parameterSpecs,
                          java.security.SecureRandom randomSource)
                   throws java.security.InvalidAlgorithmParameterException,
                          java.security.InvalidKeyException

Initialize this cipher for an operation.

Overrides:

pkcs11Init in class BlockCipher

Parameters:

operationMode - The operation to initialize; Cipher.ENCRYPT_MODE, Cipher.DECRYPT_MODE, Cipher.UNWRAP_MODE or Cipher.WRAP_MODE.

key - The key to use for the operation.

parameterSpecs - The parameter specs to use. Some cipher do not support parameter specs, they require null.

randomSource - Optional random source to use.

Throws:

java.security.InvalidAlgorithmParameterException - If the parameter specs are invalid.

java.security.InvalidKeyException - If the key is invalid for this operation.

Preconditions:

((operationMode == Cipher.ENCRYPT_MODE) or (operationMode == Cipher.DECRYPT_MODE) or (operationMode == Cipher.UNWRAP_MODE) or (operationMode == Cipher.WRAP_MODE)) and (key <> null) and (key instanceof IAIKPKCS11Key)