de.cscc.crypto.provider
Class ISO9796Part1WithRSASignatureEngine

java.lang.Object
  java.security.SignatureSpi
      de.cscc.crypto.provider.ISO9796Part1WithRSASignatureEngine

All Implemented Interfaces:

Cloneable

public final class ISO9796Part1WithRSASignatureEngine

extends SignatureSpi

implements Cloneable

ISO9796Part1AndRSASignatureEngine Class.

Version:

$Revision: 1.3 $

Author:

Uwe Günther

Field Summary

Fields inherited from class java.security.SignatureSpi

appRandom

Constructor Summary

ISO9796Part1WithRSASignatureEngine()
Creates new ISO9796Part1WithRSASignatureEngine.

Method Summary

Object	clone() Creates and returns a copy of this object.
protected Object	engineGetParameter(String param) Deprecated.
protected AlgorithmParameters	engineGetParameters() This method is overridden by providers to return the parameters used with this signature engine, or null if this signature engine does not use any parameters.
protected void	engineInitSign(PrivateKey privateKey) Initializes this signature object with the specified private key for signing operations.
protected void	engineInitSign(PrivateKey privateKey, SecureRandom random) Initializes this signature object with the specified private key and source of randomness for signing operations.
protected void	engineInitVerify(PublicKey publicKey) Initializes this signature object with the specified public key for verification operations.
protected void	engineSetParameter(AlgorithmParameterSpec params) This method is overridden by providers to initialize this signature engine with the specified parameter set.
protected void	engineSetParameter(String param, Object value) Deprecated. Replaced by engineSetParameter.
protected byte[]	engineSign() Returns the signature bytes of all the data updated so far.
protected int	engineSign(byte[] outbuf, int offset, int len) Finishes this signature operation and stores the resulting signature bytes in the provided buffer outbuf, starting at offset.
protected void	engineUpdate(byte value) Updates the data to be signed or verified using the specified byte.
protected void	engineUpdate(byte[] values, int offset, int len) Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.
protected boolean	engineVerify(byte[] sigBytes) Verifies the passed-in signature.
protected boolean	engineVerify(byte[] sigBytes, int offset, int len) Verifies the passed-in signature in the specified array of bytes, starting at the specified offset.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ISO9796Part1WithRSASignatureEngine

public ISO9796Part1WithRSASignatureEngine()

Creates new ISO9796Part1WithRSASignatureEngine.

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Creates and returns a copy of this object.

Returns:

a clone of this instance.

Throws:

CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

hashCode(), Hashtable

hashCode

public int hashCode()

Returns a hash code value for the object.

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

toString

public String toString()

Returns a string representation of the object.

Returns:

a string representation of the object.

engineInitSign

protected void engineInitSign(PrivateKey privateKey)
                       throws InvalidKeyException

Initializes this signature object with the specified private key for signing operations.

Parameters:

privateKey - the private key of the identity whose signature will be generated.

Throws:

InvalidKeyException - if the key is improperly encoded, parameters are missing, and so on.

engineInitSign

protected void engineInitSign(PrivateKey privateKey,
                              SecureRandom random)
                       throws InvalidKeyException

Initializes this signature object with the specified private key and source of randomness for signing operations.

This concrete method has been added to this previously-defined abstract class. (For backwards compatibility, it cannot be abstract.)

Parameters:

privateKey - the private key of the identity whose signature will be generated.

random - the source of randomness

Throws:

InvalidKeyException - if the key is improperly encoded, parameters are missing, and so on.

engineInitVerify

protected void engineInitVerify(PublicKey publicKey)
                         throws InvalidKeyException

Initializes this signature object with the specified public key for verification operations.

Parameters:

publicKey - the public key of the identity whose signature is going to be verified.

Throws:

InvalidKeyException - if the key is improperly encoded, parameters are missing, and so on.

engineUpdate

protected void engineUpdate(byte value)
                     throws SignatureException

Updates the data to be signed or verified using the specified byte.

Parameters:

value - the byte to use for the update.

Throws:

SignatureException - if the engine is not initialized properly.

engineUpdate

protected void engineUpdate(byte[] values,
                            int offset,
                            int len)
                     throws SignatureException

Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.

Parameters:

values - the array of bytes

offset - the offset to start from in the array of bytes

len - the number of bytes to use, starting at offset

Throws:

SignatureException - if the engine is not initialized properly

NullPointerException - if outbuf is null.

IllegalArgumentException - if offset or len is negative, or the sum of offset and len is greater than length of the values array.

engineSign

protected byte[] engineSign()
                     throws SignatureException

Returns the signature bytes of all the data updated so far. The format of the signature depends on the underlying signature scheme.

Returns:

the signature bytes of the signing operation's result.

Throws:

SignatureException - if the engine is not initialized properly.

engineSign

protected int engineSign(byte[] outbuf,
                         int offset,
                         int len)
                  throws SignatureException

Finishes this signature operation and stores the resulting signature bytes in the provided buffer outbuf, starting at offset. The format of the signature depends on the underlying signature scheme.

The signature implementation is reset to its initial state (the state it was in after a call to one of the engineInitSign methods) and can be reused to generate further signatures with the same private key. This method should be abstract, but we leave it concrete for binary compatibility. Knowledgeable providers should override this method.

Parameters:

outbuf - buffer for the signature result.

offset - offset into outbuf where the signature is stored.

len - number of bytes within outbuf allotted for the signature. Both this default implementation and the SUN provider do not return partial digests. If the value of this parameter is less than the actual signature length, this method will throw a SignatureException. This parameter is ignored if its value is greater than or equal to the actual signature length.

Returns:

the number of bytes placed into outbuf

Throws:

SignatureException - if an error occurs or len is less than the actual signature length.

NullPointerException - if outbuf is null.

IllegalArgumentException - if offset or len is negative, or the sum of offset and len is greater than length of the outbuf array.

engineVerify

protected boolean engineVerify(byte[] sigBytes)
                        throws SignatureException

Verifies the passed-in signature.

Parameters:

sigBytes - the signature bytes to be verified.

Returns:

true if the signature was verified, false if not.

Throws:

SignatureException - if the engine is not initialized properly, or the passed-in signature is improperly encoded or of the wrong type, etc.

engineVerify

protected boolean engineVerify(byte[] sigBytes,
                               int offset,
                               int len)
                        throws SignatureException

Verifies the passed-in signature in the specified array of bytes, starting at the specified offset.

Note: Subclasses should overwrite the default implementation.

Parameters:

sigBytes - the signature bytes to be verified.

offset - the offset to start from in the array of bytes.

len - the number of bytes to use, starting at offset.

Returns:

true if the signature was verified, false if not.

Throws:

SignatureException - if the engine is not initialized properly, or the passed-in signature is improperly encoded or of the wrong type, etc.

engineSetParameter

protected void engineSetParameter(AlgorithmParameterSpec params)
                           throws InvalidAlgorithmParameterException

This method is overridden by providers to initialize this signature engine with the specified parameter set.

Parameters:

params - the parameters

Throws:

UnsupportedOperationException - if this method is not overridden by a provider

InvalidAlgorithmParameterException - if this method is overridden by a provider and the the given parameters are inappropriate for this signature engine

engineGetParameters

protected AlgorithmParameters engineGetParameters()

This method is overridden by providers to return the parameters used with this signature engine, or null if this signature engine does not use any parameters.

The returned parameters may be the same that were used to initialize this signature engine, or may contain a combination of default and randomly generated parameter values used by the underlying signature implementation if this signature engine requires algorithm parameters but was not initialized with any.

Returns:

the parameters used with this signature engine, or null if this signature engine does not use any parameters

Throws:

UnsupportedOperationException - if this method is not overridden by a provider

engineSetParameter

protected void engineSetParameter(String param,
                                  Object value)
                           throws InvalidParameterException

Deprecated. Replaced by engineSetParameter.

Sets the specified algorithm parameter to the specified value. This method supplies a general-purpose mechanism through which it is possible to set the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether or not to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time.

Parameters:

param - the string identifier of the parameter.

value - the parameter value.

Throws:

InvalidParameterException - if param is an invalid parameter for this signature algorithm engine, the parameter is already set and cannot be set again, a security exception occurs, and so on.

engineGetParameter

protected Object engineGetParameter(String param)
                             throws InvalidParameterException

Deprecated.

Gets the value of the specified algorithm parameter. This method supplies a general-purpose mechanism through which it is possible to get the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether or not to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time.

Parameters:

param - the string name of the parameter.

Returns:

the object that represents the parameter value, or null if there is none.

Throws:

InvalidParameterException - if param is an invalid parameter for this engine, or another exception occurs while trying to get this parameter.