Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

java.security
Class SignatureSpi  view SignatureSpi download SignatureSpi.java

java.lang.Object
  extended byjava.security.SignatureSpi
Direct Known Subclasses:
Signature

public abstract class SignatureSpi
extends java.lang.Object

SignatureSpi defines the Service Provider Interface (SPI) for the Signature class. The signature class provides an interface to a digital signature algorithm. Digital signatures are used for authentication and integrity of data.

Since:
1.2

Field Summary
protected  SecureRandom appRandom
          Source of randomness.
 
Constructor Summary
SignatureSpi()
          Creates a new instance of SignatureSpi.
 
Method Summary
 java.lang.Object clone()
          Returns a clone of this instance.
protected abstract  java.lang.Object engineGetParameter(java.lang.String param)
          Deprecated. use the other getParameter
protected  AlgorithmParameters engineGetParameters()
          The default implementaion of this method always throws a java.lang.UnsupportedOperationException.
protected abstract  void engineInitSign(PrivateKey privateKey)
          Initializes this instance with the private key for signing purposes.
protected  void engineInitSign(PrivateKey privateKey, SecureRandom random)
          Initializes this instance with the private key and source of randomness for signing purposes.
protected abstract  void engineInitVerify(PublicKey publicKey)
          Initializes this instance with the public key for verification purposes.
protected  void engineSetParameter(java.security.spec.AlgorithmParameterSpec params)
          Sets the signature engine with the specified java.security.spec.AlgorithmParameterSpec.
protected abstract  void engineSetParameter(java.lang.String param, java.lang.Object value)
          Deprecated. use the other setParameter.
protected abstract  byte[] engineSign()
          Returns the signature bytes of all the data fed to this instance.
protected  int engineSign(byte[] outbuf, int offset, int len)
          Generates signature bytes of all the data fed to this instance and stores the result in the designated array.
protected abstract  void engineUpdate(byte b)
          Updates the data to be signed or verified with the specified byte.
protected abstract  void engineUpdate(byte[] b, int off, int len)
          Updates the data to be signed or verified with the specified bytes.
protected abstract  boolean engineVerify(byte[] sigBytes)
          Verifies a designated signature.
protected  boolean engineVerify(byte[] sigBytes, int offset, int length)
          Convenience method which calls the method with the same name and one argument after copying the designated bytes into a temporary byte array.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

appRandom

protected SecureRandom appRandom
Source of randomness.

Constructor Detail

SignatureSpi

public SignatureSpi()
Creates a new instance of SignatureSpi.

Method Detail

engineInitVerify

protected abstract void engineInitVerify(PublicKey publicKey)
                                  throws InvalidKeyException
Initializes this instance with the public key for verification purposes.


engineInitSign

protected abstract void engineInitSign(PrivateKey privateKey)
                                throws InvalidKeyException
Initializes this instance with the private key for signing purposes.


engineInitSign

protected void engineInitSign(PrivateKey privateKey,
                              SecureRandom random)
                       throws InvalidKeyException
Initializes this instance with the private key and source of randomness for signing purposes.

This method cannot be abstract for backward compatibility reasons.

Since:
1.2

engineUpdate

protected abstract void engineUpdate(byte b)
                              throws SignatureException
Updates the data to be signed or verified with the specified byte.


engineUpdate

protected abstract void engineUpdate(byte[] b,
                                     int off,
                                     int len)
                              throws SignatureException
Updates the data to be signed or verified with the specified bytes.


engineSign

protected abstract byte[] engineSign()
                              throws SignatureException
Returns the signature bytes of all the data fed to this instance. The format of the output depends on the underlying signature algorithm.


engineSign

protected int engineSign(byte[] outbuf,
                         int offset,
                         int len)
                  throws SignatureException
Generates signature bytes of all the data fed to this instance and stores the result in the designated array. The format of the output depends on the underlying signature algorithm.

This method cannot be abstract for backward compatibility reasons. After calling this method, the signature is reset to its initial state and can be used to generate additional signatures.

IMPLEMENTATION NOTE:: Neither this method nor the GNU provider will return partial digests. If len is less than the signature length, this method will throw a SignatureException. If it is greater than or equal then it is ignored.

Since:
1.2

engineVerify

protected abstract boolean engineVerify(byte[] sigBytes)
                                 throws SignatureException
Verifies a designated signature.


engineVerify

protected boolean engineVerify(byte[] sigBytes,
                               int offset,
                               int length)
                        throws SignatureException
Convenience method which calls the method with the same name and one argument after copying the designated bytes into a temporary byte array. Subclasses may override this method for performance reasons.


engineSetParameter

protected abstract void engineSetParameter(java.lang.String param,
                                           java.lang.Object value)
                                    throws InvalidParameterException
Deprecated. use the other setParameter.

Sets the specified algorithm parameter to the specified value.


engineSetParameter

protected void engineSetParameter(java.security.spec.AlgorithmParameterSpec params)
                           throws InvalidAlgorithmParameterException
Sets the signature engine with the specified java.security.spec.AlgorithmParameterSpec.

This method cannot be abstract for backward compatibility reasons. By default it always throws java.lang.UnsupportedOperationException unless overridden.


engineGetParameters

protected AlgorithmParameters engineGetParameters()
The default implementaion of this method always throws a java.lang.UnsupportedOperationException. It MUST be overridden by concrete implementations to return the appropriate AlgorithmParameters for this signature engine (or null when that engine does not use any parameters.


engineGetParameter

protected abstract java.lang.Object engineGetParameter(java.lang.String param)
                                                throws InvalidParameterException
Deprecated. use the other getParameter

Returns the value for the specified algorithm parameter.


clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns a clone of this instance.