Class Signature

java.lang.Object
java.security.SignatureSpi
java.security.Signature
public abstract classSignatureextendsSignatureSpi
TheSignature class is used to provide applications the functionality of a digital signature algorithm. Digital signatures are used for authentication and integrity assurance of digital data.

The signature algorithm can be, among others, the NIST standard DSA, using DSA and SHA-256. The DSA algorithm using the SHA-256 message digest algorithm can be specified asSHA256withDSA. In the case of RSA the signing algorithm could be specified as, for example,SHA256withRSA. The algorithm name must be specified, as there is no default.

ASignature object can be used to generate and verify digital signatures.

There are three phases to the use of aSignature object for either signing data or verifying a signature:

  1. Initialization, with either
  2. Updating

    Depending on the type of initialization, this will update the bytes to be signed or verified. See theupdate methods.

  3. Signing or Verifying a signature on all updated bytes. See thesign methods and theverify method.

Note that this class is abstract and extends fromSignatureSpi for historical reasons. Application developers should only take notice of the methods defined in thisSignature class; all the methods in the superclass are intended for cryptographic service providers who wish to supply their own implementations of digital signature algorithms.

Every implementation of the Java platform is required to support the following standardSignature algorithms:

  • SHA1withDSA
  • SHA256withDSA
  • SHA1withRSA
  • SHA256withRSA
These algorithms are described in the Signature section of the Java Security Standard Algorithm Names Specification. Consult the release documentation for your implementation to see if any other algorithms are supported.

Since:
1.1

  • Field Details

    • UNINITIALIZED

      protected static final int UNINITIALIZED
      Possiblestate value, signifying that thisSignature object has not yet been initialized.
      See Also:

    • SIGN

      protected static final int SIGN
      Possiblestate value, signifying that thisSignature object has been initialized for signing.
      See Also:

    • VERIFY

      protected static final int VERIFY
      Possiblestate value, signifying that thisSignature object has been initialized for verification.
      See Also:

    • state

      protected int state
      Current state of thisSignature object.

  • Constructor Details

    • Signature

      protected Signature(String algorithm)
      Creates aSignature object for the specified algorithm.
      Parameters:
      algorithm - the standard string name of the algorithm. See the Signature section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.

  • Method Details

    • getInstance

      public static Signature getInstance(String algorithm) throwsNoSuchAlgorithmException
      Returns aSignature object that implements the specified signature algorithm.

      This method traverses the list of registered security Providers, starting with the most preferred Provider. A newSignature object encapsulating theSignatureSpi implementation from the first provider that supports the specified algorithm is returned.

      Note that the list of registered providers may be retrieved via theSecurity.getProviders() method.

      Implementation Note:
      The JDK Reference Implementation additionally uses thejdk.security.provider.preferredSecurity property to determine the preferred provider order for the specified algorithm. This may be different from the order of providers returned bySecurity.getProviders().
      Parameters:
      algorithm - the standard name of the algorithm requested. See the Signature section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.
      Returns:
      the newSignature object
      Throws:
      NoSuchAlgorithmException - if noProvider supports aSignature implementation for the specified algorithm
      NullPointerException - ifalgorithm isnull
      See Also:

    • getInstance

      public static Signature getInstance(String algorithm,String provider) throwsNoSuchAlgorithmException,NoSuchProviderException
      Returns aSignature object that implements the specified signature algorithm.

      A newSignature object encapsulating theSignatureSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.

      Note that the list of registered providers may be retrieved via theSecurity.getProviders() method.

      Parameters:
      algorithm - the name of the algorithm requested. See the Signature section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.
      provider - the name of the provider.
      Returns:
      the newSignature object
      Throws:
      IllegalArgumentException - if the provider name isnull or empty
      NoSuchAlgorithmException - if aSignatureSpi implementation for the specified algorithm is not available from the specified provider
      NoSuchProviderException - if the specified provider is not registered in the security provider list
      NullPointerException - ifalgorithm isnull
      See Also:

    • getInstance

      public static Signature getInstance(String algorithm,Provider provider) throwsNoSuchAlgorithmException
      Returns aSignature object that implements the specified signature algorithm.

      A newSignature object encapsulating theSignatureSpi implementation from the specified provider is returned. Note that the specified provider does not have to be registered in the provider list.

      Parameters:
      algorithm - the name of the algorithm requested. See the Signature section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.
      provider - the provider.
      Returns:
      the newSignature object
      Throws:
      IllegalArgumentException - if the provider isnull
      NoSuchAlgorithmException - if aSignatureSpi implementation for the specified algorithm is not available from the specifiedProvider object
      NullPointerException - ifalgorithm isnull
      Since:
      1.4
      See Also:

    • getProvider

      public final Provider getProvider()
      Returns the provider of thisSignature object.
      Returns:
      the provider of thisSignature object

    • initVerify

      public final void initVerify(PublicKey publicKey) throwsInvalidKeyException
      Initializes this object for verification. If this method is called again with a different argument, it negates the effect of this call.
      Parameters:
      publicKey - the public key of the identity whose signature is going to be verified.
      Throws:
      InvalidKeyException - if the key is invalid.

    • initVerify

      public final void initVerify(Certificate certificate) throwsInvalidKeyException
      Initializes this object for verification, using the public key from the given certificate.

      If the certificate is of type X.509 and has akey usage extension field marked as critical, and the value of thekey usage extension field implies that the public key in the certificate and its corresponding private key are not supposed to be used for digital signatures, anInvalidKeyException is thrown.

      Parameters:
      certificate - the certificate of the identity whose signature is going to be verified.
      Throws:
      InvalidKeyException - if the public key in the certificate is not encoded properly or does not include required parameter information or cannot be used for digital signature purposes.
      Since:
      1.3

    • initSign

      public final void initSign(PrivateKey privateKey) throwsInvalidKeyException
      Initialize this object for signing. If this method is called again with a different argument, it negates the effect of this call.
      Parameters:
      privateKey - the private key of the identity whose signature is going to be generated.
      Throws:
      InvalidKeyException - if the key is invalid.

    • initSign

      public final void initSign(PrivateKey privateKey,SecureRandom random) throwsInvalidKeyException
      Initialize this object for signing. If this method is called again with a different argument, it negates the effect of this call.
      Parameters:
      privateKey - the private key of the identity whose signature is going to be generated
      random - the source of randomness for thisSignature object
      Throws:
      InvalidKeyException - if the key is invalid.

    • sign

      public final byte[] sign() throwsSignatureException
      Returns the signature bytes of all the data updated. The format of the signature depends on the underlying signature scheme.

      A call to this method resets thisSignature object to the state it was in when previously initialized for signing via a call toinitSign(PrivateKey). That is, the object is reset and available to generate another signature from the same signer, if desired, via new calls toupdate andsign.

      Returns:
      the signature bytes of the signing operation's result.
      Throws:
      SignatureException - if thisSignature object is not initialized properly or if this signature algorithm is unable to process the input data provided.

    • sign

      public final int sign(byte[] outbuf, int offset, int len) throwsSignatureException
      Finishes the signature operation and stores the resulting signature bytes in the provided bufferoutbuf, starting atoffset. The format of the signature depends on the underlying signature scheme.

      ThisSignature object is reset to its initial state (the state it was in after a call to one of theinitSign methods) and can be reused to generate further signatures with the same private key.

      Parameters:
      outbuf - buffer for the signature result.
      offset - offset intooutbuf where the signature is stored.
      len - number of bytes withinoutbuf allotted for the signature.
      Returns:
      the number of bytes placed intooutbuf.
      Throws:
      SignatureException - if thisSignature object is not initialized properly, if this signature algorithm is unable to process the input data provided, or iflen is less than the actual signature length.
      IllegalArgumentException - ifoutbuf isnull, oroffset orlen is less than 0, or the sum ofoffset andlen is greater than the length ofoutbuf.
      Since:
      1.2

    • verify

      public final boolean verify(byte[] signature) throwsSignatureException
      Verifies the passed-in signature.

      A call to this method resets thisSignature object to the state it was in when previously initialized for verification via a call toinitVerify(PublicKey). That is, the object is reset and available to verify another signature from the identity whose public key was specified in the call toinitVerify.

      Parameters:
      signature - the signature bytes to be verified.
      Returns:
      true if the signature was verified,false if not.
      Throws:
      SignatureException - if thisSignature object is not initialized properly, the passed-in signature is improperly encoded or of the wrong type, if this signature algorithm is unable to process the input data provided, etc.

    • verify

      public final boolean verify(byte[] signature, int offset, int length) throwsSignatureException
      Verifies the passed-in signature in the specified array of bytes, starting at the specified offset.

      A call to this method resets thisSignature object to the state it was in when previously initialized for verification via a call toinitVerify(PublicKey). That is, the object is reset and available to verify another signature from the identity whose public key was specified in the call toinitVerify.

      Parameters:
      signature - the signature bytes to be verified.
      offset - the offset to start from in the array of bytes.
      length - the number of bytes to use, starting at offset.
      Returns:
      true if the signature was verified,false if not.
      Throws:
      SignatureException - if thisSignature object is not initialized properly, the passed-in signature is improperly encoded or of the wrong type, if this signature algorithm is unable to process the input data provided, etc.
      IllegalArgumentException - if thesignature byte array isnull, or theoffset orlength is less than 0, or the sum of theoffset andlength is greater than the length of thesignature byte array.
      Since:
      1.4

    • update

      public final void update(byte b) throwsSignatureException
      Updates the data to be signed or verified by a byte.
      Parameters:
      b - the byte to use for the update.
      Throws:
      SignatureException - if thisSignature object is not initialized properly.

    • update

      public final void update(byte[] data) throwsSignatureException
      Updates the data to be signed or verified, using the specified array of bytes.
      Parameters:
      data - the byte array to use for the update.
      Throws:
      SignatureException - if thisSignature object is not initialized properly.

    • update

      public final void update(byte[] data, int off, int len) throwsSignatureException
      Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.
      Parameters:
      data - the array of bytes.
      off - the offset to start from in the array of bytes.
      len - the number of bytes to use, starting at offset.
      Throws:
      SignatureException - if thisSignature object is not initialized properly.
      IllegalArgumentException - ifdata isnull, oroff orlen is less than 0, or the sum ofoff andlen is greater than the length ofdata.

    • update

      public final void update(ByteBuffer data) throwsSignatureException
      Updates the data to be signed or verified using the specified ByteBuffer. Processes thedata.remaining() bytes starting atdata.position(). Upon return, the buffer's position will be equal to its limit; its limit will not have changed.
      Parameters:
      data - the ByteBuffer
      Throws:
      SignatureException - if thisSignature object is not initialized properly.
      Since:
      1.5

    • getAlgorithm

      public final String getAlgorithm()
      Returns the name of the algorithm for thisSignature object.
      Returns:
      the name of the algorithm for thisSignature object.

    • toString

      public String toString()
      Returns a string representation of thisSignature object, providing information that includes the state of the object and the name of the algorithm used.
      Overrides:
      toString in class Object
      Returns:
      a string representation of thisSignature object.

    • setParameter

      @Deprecatedpublic final void setParameter(String param,Object value) throwsInvalidParameterException
      Deprecated.
      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 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 - ifparam is an invalid parameter for thisSignature object, the parameter is already set and cannot be set again, a security exception occurs, and so on.
      See Also:

    • setParameter

      public final void setParameter(AlgorithmParameterSpec params) throwsInvalidAlgorithmParameterException
      Initializes thisSignature object with the specified parameter values.
      Parameters:
      params - the parameter values
      Throws:
      InvalidAlgorithmParameterException - if the given parameter values are inappropriate for thisSignature object
      See Also:

    • getParameters

      public final AlgorithmParameters getParameters()
      Returns the parameters used with thisSignature object.

      The returned parameters may be the same that were used to initialize thisSignature object, or may contain additional default or random parameter values used by the underlying signature scheme. If the required parameters were not supplied and can be generated by theSignature object, the generated parameters are returned; otherwisenull is returned.

      However, if the signature scheme does not support returning the parameters asAlgorithmParameters,null is always returned.

      Returns:
      the parameters used with thisSignature object, ornull
      Throws:
      UnsupportedOperationException - if the provider does not support this method
      Since:
      1.4
      See Also:

    • getParameter

      @Deprecatedpublic final Object getParameter(String param) throwsInvalidParameterException
      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 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, ornull if there is none.
      Throws:
      InvalidParameterException - ifparam is an invalid parameter for this engine, or another exception occurs while trying to get this parameter.
      See Also:

    • clone

      public Object clone() throwsCloneNotSupportedException
      Returns a clone if the implementation is cloneable.
      Overrides:
      clone in class SignatureSpi
      Returns:
      a clone if the implementation is cloneable.
      Throws:
      CloneNotSupportedException - if this is called on an implementation that does not supportCloneable.
      See Also: