iaik.pkcs.pkcs11.provider.ciphers

Class Rc4Cipher

java.lang.Object

javax.crypto.CipherSpi

iaik.pkcs.pkcs11.provider.ciphers.PKCS11Cipher

iaik.pkcs.pkcs11.provider.ciphers.Rc4Cipher

All Implemented Interfaces:

PKCS11EngineClass

public class Rc4Cipher
extends PKCS11Cipher

This is an implementation of a RC4 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 iaik.pkcs.pkcs11.Mechanism	DEFAULT_MECHANISM The defualt mechanism for this cipher.

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
Rc4Cipher() 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 boolean	isModeSupported(java.lang.String mode) This implementation does not support modes; i.e.
protected boolean	isPaddingSupported(java.lang.String padding) This implementation does not support paddings; i.e.
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.PKCS11Cipher

engineDoFinal, engineDoFinal, engineGetBlockSize, engineGetIV, engineGetKeySize, engineGetOutputSize, engineGetParameters, engineInit, engineInit, engineInit, engineSetMode, engineSetPadding, engineUnwrap, engineUpdate, engineUpdate, engineUpdateAAD, engineWrap, finalize, finalizePkcs11Operation, getFullAlgorithmName, getUsedMechanismFeatures, getUsedMechanisms, initialize, initializePkcs11Operation, initializeSession, initializeSoftwareDelegate, isSupportedBy, pkcs11DoFinal, pkcs11DoFinal, pkcs11GetIV, pkcs11GetParameters, pkcs11Init, pkcs11Init, pkcs11Unwrap, pkcs11Update, 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.

Constructor Detail

Rc4Cipher

public Rc4Cipher()

Default constructor.

Method Detail

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.

Specified by:

checkKeyObject in class PKCS11Cipher

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.

isModeSupported

protected boolean isModeSupported(java.lang.String mode)

This implementation does not support modes; i.e. the mode must be null or must equal NONE.

Specified by:

isModeSupported in class PKCS11Cipher

Parameters:

mode - The mode to check.

Returns:

True, if the given mode is supported. False, otherwise.

isPaddingSupported

protected boolean isPaddingSupported(java.lang.String padding)

This implementation does not support paddings; i.e. the padding must be null or must equal NoPadding

Specified by:

isPaddingSupported in class PKCS11Cipher

Parameters:

padding - The padding scheme to check.

Returns:

True, if the given padding is supported. False, otherwise.

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.

Overrides:

pkcs11GetKeySize in class PKCS11Cipher

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.

Overrides:

pkcs11GetBlockSize in class PKCS11Cipher

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 PKCS11Cipher

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)

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 PKCS11Cipher

Returns:

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

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.

Specified by:

getMechanism in class PKCS11Cipher

Returns:

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