iaik.pkcs.pkcs11.provider

Class NullCipher

java.lang.Object

javax.crypto.CipherSpi

iaik.pkcs.pkcs11.provider.NullCipher

All Implemented Interfaces:

PKCS11EngineClass

public class NullCipher
extends javax.crypto.CipherSpi
implements PKCS11EngineClass

This is just a null-cipher that does nothing; i.e. it jsut maps the input to the output. It is jsut used in the workaround for the bug in some JDKs that prevents inserting a signed provider at the first position.

Author:

Karl Scheibelhofer

Constructor Summary

Constructors

Constructor and Description
NullCipher() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected byte[]	engineDoFinal(byte[] input, int inputOffset, int inputLength) Just returns a clone of the input data.
protected int	engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) Just copy the input to the output.
protected int	engineGetBlockSize() Return 1.
protected byte[]	engineGetIV() Returns null.
protected int	engineGetKeySize(java.security.Key key) Returns -1.
protected int	engineGetOutputSize(int inputLength) Returns -1.
protected java.security.AlgorithmParameters	engineGetParameters() Returns null.
protected void	engineInit(int operationMode, java.security.Key key, java.security.spec.AlgorithmParameterSpec parameterSpecs, java.security.SecureRandom randomSource) Does nothing, because this cipher needs no initialization.
protected void	engineInit(int operationMode, java.security.Key key, java.security.AlgorithmParameters parameters, java.security.SecureRandom random) Does nothing, because this cipher needs no initialization.
protected void	engineInit(int operationMode, java.security.Key key, java.security.SecureRandom randomSource) Does nothing, because this cipher needs no initialization.
protected void	engineSetMode(java.lang.String mode) Does nothing, because this cipher needs no mode.
protected void	engineSetPadding(java.lang.String padding) Does nothing, because this cipher needs no padding.
protected java.security.Key	engineUnwrap(byte[] wrappedKey, java.lang.String wrappedKeyAlgorithm, int wrappedKeyType) Just returns the given wrapped key as key material in a key object.
protected byte[]	engineUpdate(byte[] data, int offset, int length) Just return the input data.
protected int	engineUpdate(byte[] input, int inputOffset, int inputLength, byte[] output, int outputOffset) Update the cureently running cipher operation with the given data and write the intermediate result (if any) to the given buffer.
protected byte[]	engineWrap(java.security.Key key) Wrap (encrypt) the given key.
boolean	isSupportedBy(TokenManager tokenManager) Always returns true.

Methods inherited from class javax.crypto.CipherSpi

engineDoFinal, engineUpdate, engineUpdateAAD, engineUpdateAAD

Methods inherited from class java.lang.Object

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

Constructor Detail

NullCipher

public NullCipher()

Default constructor.

Method Detail

isSupportedBy

public boolean isSupportedBy(TokenManager tokenManager)

Always returns true.

Specified by:

isSupportedBy in interface PKCS11EngineClass

Parameters:

tokenManager - Not used by this implementation.

Returns:

True.

Postconditions:

(result == true)

engineDoFinal

protected int engineDoFinal(byte[] input,
                            int inputOffset,
                            int inputLen,
                            byte[] output,
                            int outputOffset)
                     throws javax.crypto.ShortBufferException

Just copy the input to the output.

Specified by:

engineDoFinal in class javax.crypto.CipherSpi

Parameters:

input - The byte array that holds the input data.

inputOffset - The offset in the input byte array that indicates the first input data byte to read.

inputLen - The number of bytes to read starting from offset.

output - The byte array that receives the final output data.

outputOffset - The offset in the output byte array where to start writing the output.

Returns:

The actual number of bytes written to the output buffer.

Throws:

javax.crypto.ShortBufferException - If the provided output buffer is too small.

Postconditions:

(result > 0)

Preconditions:

(input <> null) and ((inputOffset + inputLength) <= input.length) and (output <> null) and ((output.length - outputOffset) >= inputLen)

engineDoFinal

protected byte[] engineDoFinal(byte[] input,
                               int inputOffset,
                               int inputLength)
                        throws javax.crypto.BadPaddingException,
                               javax.crypto.IllegalBlockSizeException

Just returns a clone of the input data.

Specified by:

engineDoFinal in class javax.crypto.CipherSpi

Parameters:

input - The byte array that holds the input data.

inputOffset - The offset in the input byte array that indicates the first input data byte to read.

inputLength - The number of bytes to read starting from offset.

Returns:

The final operation result; i.e. cipher text or plain text.

Throws:

javax.crypto.BadPaddingException - If the padding of the decrypted data is bad or if the padding of the input data failed.

javax.crypto.IllegalBlockSizeException - If the input data size does not match the required block size.

Postconditions:

(result <> null)

Preconditions:

(input <> null) and ((inputOffset + inputLength) <= input.length)

engineGetBlockSize

protected int engineGetBlockSize()

Return 1.

Specified by:

engineGetBlockSize in class javax.crypto.CipherSpi

Returns:

1.

Postconditions:

(result == 1)

engineGetIV

protected byte[] engineGetIV()

Returns null.

Specified by:

engineGetIV in class javax.crypto.CipherSpi

Returns:

null.

Postconditions:

(result == null)

engineGetKeySize

protected int engineGetKeySize(java.security.Key key)

Returns -1.

Overrides:

engineGetKeySize in class javax.crypto.CipherSpi

Parameters:

key - Unused.

Returns:

-1.

Postconditions:

(result == -1)

engineGetOutputSize

protected int engineGetOutputSize(int inputLength)

Returns -1.

Specified by:

engineGetOutputSize in class javax.crypto.CipherSpi

Parameters:

inputLength - Unused.

Returns:

-1.

Postconditions:

(result == -1)

engineGetParameters

protected java.security.AlgorithmParameters engineGetParameters()

Returns null.

Specified by:

engineGetParameters in class javax.crypto.CipherSpi

Returns:

null.

engineInit

protected void engineInit(int operationMode,
                          java.security.Key key,
                          java.security.SecureRandom randomSource)

Does nothing, because this cipher needs no initialization.

Specified by:

engineInit in class javax.crypto.CipherSpi

Parameters:

operationMode - Unused.

key - The Unused.

randomSource - Unused.

engineInit

protected void engineInit(int operationMode,
                          java.security.Key key,
                          java.security.AlgorithmParameters parameters,
                          java.security.SecureRandom random)

Does nothing, because this cipher needs no initialization.

Specified by:

engineInit in class javax.crypto.CipherSpi

Parameters:

operationMode - Unused.

key - Unused.

parameters - Unused.

random - Unused.

engineInit

protected void engineInit(int operationMode,
                          java.security.Key key,
                          java.security.spec.AlgorithmParameterSpec parameterSpecs,
                          java.security.SecureRandom randomSource)

Does nothing, because this cipher needs no initialization.

Specified by:

engineInit in class javax.crypto.CipherSpi

Parameters:

operationMode - Unused.

key - Unused.

parameterSpecs - Unused.

randomSource - Unused.

engineSetMode

protected void engineSetMode(java.lang.String mode)

Does nothing, because this cipher needs no mode.

Specified by:

engineSetMode in class javax.crypto.CipherSpi

Parameters:

mode - Unused.

engineSetPadding

protected void engineSetPadding(java.lang.String padding)

Does nothing, because this cipher needs no padding.

Specified by:

engineSetPadding in class javax.crypto.CipherSpi

Parameters:

padding - The padding.

engineUpdate

protected byte[] engineUpdate(byte[] data,
                              int offset,
                              int length)

Just return the input data.

Specified by:

engineUpdate in class javax.crypto.CipherSpi

Parameters:

data - The byte array that holds the data.

offset - The offset in the byte array that indicates the first data byte to read.

length - The number of bytes to read starting from offset.

Returns:

The input data.

Preconditions:

(data <> null) and ((offset + length) <= data.length)

engineUpdate

protected int engineUpdate(byte[] input,
                           int inputOffset,
                           int inputLength,
                           byte[] output,
                           int outputOffset)
                    throws javax.crypto.ShortBufferException

Update the cureently running cipher operation with the given data and write the intermediate result (if any) to the given buffer. This implementation delegates this call to the software provider, if the current key is a software key. If the key is a key of this provider, it delegates the call to the corresponding pkcs11 method with prefix pkcs11 instead of engine.

Specified by:

engineUpdate in class javax.crypto.CipherSpi

Parameters:

input - The byte array that holds the input data.

inputOffset - The offset in the input byte array that indicates the first input data byte to read.

inputLength - The number of bytes to read starting from offset.

output - The byte array that receives the output data.

outputOffset - The offset in the output byte array where to start writing the output.

Returns:

The actual number of bytes written to the output buffer.

Throws:

javax.crypto.ShortBufferException - If the given output buffer does not have enough space left for the produced output.

Preconditions:

(input <> null) and ((inputOffset + inputLength) <= input.length) and (output <> null) and ((output.length - outputOffset) >= inputLen)

engineUnwrap

protected java.security.Key engineUnwrap(byte[] wrappedKey,
                                         java.lang.String wrappedKeyAlgorithm,
                                         int wrappedKeyType)

Just returns the given wrapped key as key material in a key object.

Overrides:

engineUnwrap in class javax.crypto.CipherSpi

Parameters:

wrappedKey - The wrapped (encrypted) key to be unwrapped (decrypted).

wrappedKeyAlgorithm - Ignored in this implementation.

wrappedKeyType - Ignored in this implementation.

Returns:

The unwrapped (decrypted) key.

Postconditions:

(result <> null)

Preconditions:

(wrappedKey <> null)

engineWrap

protected byte[] engineWrap(java.security.Key key)
                     throws java.security.InvalidKeyException,
                            javax.crypto.IllegalBlockSizeException

Wrap (encrypt) the given key. The encryption key is the key used to initialize the operation. This implementation delegates this call to the software provider, if the current key is a software key. If the key is a key of this provider, it delegates the call to the corresponding pkcs11 method with prefix pkcs11 instead of engine.

Overrides:

engineWrap in class javax.crypto.CipherSpi

Parameters:

key - The key to wrap (encrypt).

Returns:

The wrapped (encrypted) key.

Throws:

java.security.InvalidKeyException - If the given key is invalid.

javax.crypto.IllegalBlockSizeException - If wrapping fails due to block-size constraints of the cipher.

Preconditions:

(key <> null)