Signature (Java SE 9 & JDK 9 ) (original) (raw)

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	SIGN	Possible state value, signifying that this signature object has been initialized for signing.
protected int	state	Current state of this signature object.
protected static int	UNINITIALIZED	Possible state value, signifying that this signature object has not yet been initialized.
protected static int	VERIFY	Possible state value, signifying that this signature object has been initialized for verification.

   * ### Fields inherited from class java.security.[SignatureSpi](../../java/security/SignatureSpi.html "class in java.security")  
   `[appRandom](../../java/security/SignatureSpi.html#appRandom)`

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Signature(String algorithm)	Creates a Signature object for the specified algorithm.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods

Modifier and Type	Method	Description
Object	clone()	Returns a clone if the implementation is cloneable.
String	getAlgorithm()	Returns the name of the algorithm for this signature object.
static Signature	getInstance(String algorithm)	Returns a Signature object that implements the specified signature algorithm.
static Signature	getInstance(String algorithm,String provider)	Returns a Signature object that implements the specified signature algorithm.
static Signature	getInstance(String algorithm,Provider provider)	Returns a Signature object that implements the specified signature algorithm.
Object	getParameter(String param)	Deprecated.
AlgorithmParameters	getParameters()	Returns the parameters used with this signature object.
Provider	getProvider()	Returns the provider of this signature object.
void	initSign(PrivateKey privateKey)	Initialize this object for signing.
void	initSign(PrivateKey privateKey,SecureRandom random)	Initialize this object for signing.
void	initVerify(Certificate certificate)	Initializes this object for verification, using the public key from the given certificate.
void	initVerify(PublicKey publicKey)	Initializes this object for verification.
void	setParameter(String param,Object value)	Deprecated.
void	setParameter(AlgorithmParameterSpec params)	Initializes this signature engine with the specified parameter set.
byte[]	sign()	Returns the signature bytes of all the data updated.
int	sign(byte[] outbuf, int offset, int len)	Finishes the signature operation and stores the resulting signature bytes in the provided buffer outbuf, starting atoffset.
String	toString()	Returns a string representation of this signature object, providing information that includes the state of the object and the name of the algorithm used.
void	update(byte b)	Updates the data to be signed or verified by a byte.
void	update(byte[] data)	Updates the data to be signed or verified, using the specified array of bytes.
void	update(byte[] data, int off, int len)	Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.
void	update(ByteBuffer data)	Updates the data to be signed or verified using the specified ByteBuffer.
boolean	verify(byte[] signature)	Verifies the passed-in signature.
boolean	verify(byte[] signature, int offset, int length)	Verifies the passed-in signature in the specified array of bytes, starting at the specified offset.

   * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
   `[equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`  
   * ### Methods inherited from class java.security.[SignatureSpi](../../java/security/SignatureSpi.html "class in java.security")  
   `[engineGetParameter](../../java/security/SignatureSpi.html#engineGetParameter-java.lang.String-), [engineGetParameters](../../java/security/SignatureSpi.html#engineGetParameters--), [engineInitSign](../../java/security/SignatureSpi.html#engineInitSign-java.security.PrivateKey-), [engineInitSign](../../java/security/SignatureSpi.html#engineInitSign-java.security.PrivateKey-java.security.SecureRandom-), [engineInitVerify](../../java/security/SignatureSpi.html#engineInitVerify-java.security.PublicKey-), [engineSetParameter](../../java/security/SignatureSpi.html#engineSetParameter-java.lang.String-java.lang.Object-), [engineSetParameter](../../java/security/SignatureSpi.html#engineSetParameter-java.security.spec.AlgorithmParameterSpec-), [engineSign](../../java/security/SignatureSpi.html#engineSign--), [engineSign](../../java/security/SignatureSpi.html#engineSign-byte:A-int-int-), [engineUpdate](../../java/security/SignatureSpi.html#engineUpdate-byte-), [engineUpdate](../../java/security/SignatureSpi.html#engineUpdate-byte:A-int-int-), [engineUpdate](../../java/security/SignatureSpi.html#engineUpdate-java.nio.ByteBuffer-), [engineVerify](../../java/security/SignatureSpi.html#engineVerify-byte:A-), [engineVerify](../../java/security/SignatureSpi.html#engineVerify-byte:A-int-int-)`

Field Detail

 * #### UNINITIALIZED  
 protected static final int UNINITIALIZED  
 Possible [state](../../java/security/Signature.html#state) value, signifying that this signature object has not yet been initialized.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.security.Signature.UNINITIALIZED)  
 * #### SIGN  
 protected static final int SIGN  
 Possible [state](../../java/security/Signature.html#state) value, signifying that this signature object has been initialized for signing.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.security.Signature.SIGN)  
 * #### VERIFY  
 protected static final int VERIFY  
 Possible [state](../../java/security/Signature.html#state) value, signifying that this signature object has been initialized for verification.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.security.Signature.VERIFY)  
 * #### state  
 protected int state  
 Current state of this signature object.

Constructor Detail

* #### Signature  
protected Signature([String](../../java/lang/String.html "class in java.lang") algorithm)  
Creates a Signature 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](../../../specs/security/standard-names.html#signature-algorithms) for information about standard algorithm names.

Method Detail

* #### getInstance  
public static [Signature](../../java/security/Signature.html "class in java.security") getInstance([String](../../java/lang/String.html "class in java.lang") algorithm)  
                             throws [NoSuchAlgorithmException](../../java/security/NoSuchAlgorithmException.html "class in java.security")  
Returns a Signature object that implements the specified signature algorithm.  
 This method traverses the list of registered security Providers, starting with the most preferred Provider. A new Signature object encapsulating the SignatureSpi implementation from the first Provider that supports the specified algorithm is returned.  
 Note that the list of registered providers may be retrieved via the [Security.getProviders()](../../java/security/Security.html#getProviders--) method.  
Implementation Note:  
The JDK Reference Implementation additionally uses the`jdk.security.provider.preferred` [Security](../../java/security/Security.html#getProperty-java.lang.String-) property to determine the preferred provider order for the specified algorithm. This may be different than the order of providers returned by[Security.getProviders()](../../java/security/Security.html#getProviders--).  
Parameters:  
`algorithm` \- the standard name of the algorithm requested. See the Signature section in the [ Java Security Standard Algorithm Names Specification](../../../specs/security/standard-names.html#signature-algorithms) for information about standard algorithm names.  
Returns:  
the new `Signature` object  
Throws:  
`[NoSuchAlgorithmException](../../java/security/NoSuchAlgorithmException.html "class in java.security")` \- if no `Provider` supports a`Signature` implementation for the specified algorithm  
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if `algorithm` is `null`  
See Also:  
[Provider](../../java/security/Provider.html "class in java.security")  
* #### getInstance  
public static [Signature](../../java/security/Signature.html "class in java.security") getInstance([String](../../java/lang/String.html "class in java.lang") algorithm,  
                                    [String](../../java/lang/String.html "class in java.lang") provider)  
                             throws [NoSuchAlgorithmException](../../java/security/NoSuchAlgorithmException.html "class in java.security"),  
                                    [NoSuchProviderException](../../java/security/NoSuchProviderException.html "class in java.security")  
Returns a Signature object that implements the specified signature algorithm.  
 A new Signature object encapsulating the SignatureSpi 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 the [Security.getProviders()](../../java/security/Security.html#getProviders--) method.  
Parameters:  
`algorithm` \- the name of the algorithm requested. See the Signature section in the [ Java Security Standard Algorithm Names Specification](../../../specs/security/standard-names.html#signature-algorithms) for information about standard algorithm names.  
`provider` \- the name of the provider.  
Returns:  
the new `Signature` object  
Throws:  
`[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the provider name is `null` or empty  
`[NoSuchAlgorithmException](../../java/security/NoSuchAlgorithmException.html "class in java.security")` \- if a `SignatureSpi` implementation for the specified algorithm is not available from the specified provider  
`[NoSuchProviderException](../../java/security/NoSuchProviderException.html "class in java.security")` \- if the specified provider is not registered in the security provider list  
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if `algorithm` is `null`  
See Also:  
[Provider](../../java/security/Provider.html "class in java.security")  
* #### getInstance  
public static [Signature](../../java/security/Signature.html "class in java.security") getInstance([String](../../java/lang/String.html "class in java.lang") algorithm,  
                                    [Provider](../../java/security/Provider.html "class in java.security") provider)  
                             throws [NoSuchAlgorithmException](../../java/security/NoSuchAlgorithmException.html "class in java.security")  
Returns a Signature object that implements the specified signature algorithm.  
 A new Signature object encapsulating the SignatureSpi implementation from the specified Provider object is returned. Note that the specified Provider object 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](../../../specs/security/standard-names.html#signature-algorithms) for information about standard algorithm names.  
`provider` \- the provider.  
Returns:  
the new `Signature` object  
Throws:  
`[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the provider is `null`  
`[NoSuchAlgorithmException](../../java/security/NoSuchAlgorithmException.html "class in java.security")` \- if a `SignatureSpi` implementation for the specified algorithm is not available from the specified `Provider` object  
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if `algorithm` is `null`  
Since:  
1.4  
See Also:  
[Provider](../../java/security/Provider.html "class in java.security")  
* #### getProvider  
public final [Provider](../../java/security/Provider.html "class in java.security") getProvider()  
Returns the provider of this signature object.  
Returns:  
the provider of this signature object  
* #### initVerify  
public final void initVerify([PublicKey](../../java/security/PublicKey.html "interface in java.security") publicKey)  
                      throws [InvalidKeyException](../../java/security/InvalidKeyException.html "class in java.security")  
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](../../java/security/InvalidKeyException.html "class in java.security")` \- if the key is invalid.  
* #### initVerify  
public final void initVerify([Certificate](../../java/security/cert/Certificate.html "class in java.security.cert") certificate)  
                      throws [InvalidKeyException](../../java/security/InvalidKeyException.html "class in java.security")  
Initializes this object for verification, using the public key from the given certificate.  
If the certificate is of type X.509 and has a _key usage_ extension field marked as critical, and the value of the _key 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, an`InvalidKeyException` is thrown.  
Parameters:  
`certificate` \- the certificate of the identity whose signature is going to be verified.  
Throws:  
`[InvalidKeyException](../../java/security/InvalidKeyException.html "class in java.security")` \- 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](../../java/security/PrivateKey.html "interface in java.security") privateKey)  
                    throws [InvalidKeyException](../../java/security/InvalidKeyException.html "class in java.security")  
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](../../java/security/InvalidKeyException.html "class in java.security")` \- if the key is invalid.  
* #### initSign  
public final void initSign([PrivateKey](../../java/security/PrivateKey.html "interface in java.security") privateKey,  
                           [SecureRandom](../../java/security/SecureRandom.html "class in java.security") random)  
                    throws [InvalidKeyException](../../java/security/InvalidKeyException.html "class in java.security")  
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 this signature.  
Throws:  
`[InvalidKeyException](../../java/security/InvalidKeyException.html "class in java.security")` \- if the key is invalid.  
* #### sign  
public final byte[] sign()  
                  throws [SignatureException](../../java/security/SignatureException.html "class in java.security")  
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 this signature object to the state it was in when previously initialized for signing via a call to `initSign(PrivateKey)`. That is, the object is reset and available to generate another signature from the same signer, if desired, via new calls to `update` and`sign`.  
Returns:  
the signature bytes of the signing operation's result.  
Throws:  
`[SignatureException](../../java/security/SignatureException.html "class in java.security")` \- if this signature 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)  
               throws [SignatureException](../../java/security/SignatureException.html "class in java.security")  
Finishes the 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.  
This signature object is reset to its initial state (the state it was in after a call to one of the `initSign` methods) and can be reused to generate further signatures with the same private key.  
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.  
Returns:  
the number of bytes placed into `outbuf`.  
Throws:  
`[SignatureException](../../java/security/SignatureException.html "class in java.security")` \- if this signature object is not initialized properly, if this signature algorithm is unable to process the input data provided, or if `len` is less than the actual signature length.  
`[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `outbuf` is `null`, or `offset` or `len` is less than 0, or the sum of`offset` and `len` is greater than the length of`outbuf`.  
Since:  
1.2  
* #### verify  
public final boolean verify(byte[] signature)  
                     throws [SignatureException](../../java/security/SignatureException.html "class in java.security")  
Verifies the passed-in signature.  
A call to this method resets this signature object to the state it was in when previously initialized for verification via a call to `initVerify(PublicKey)`. That is, the object is reset and available to verify another signature from the identity whose public key was specified in the call to `initVerify`.  
Parameters:  
`signature` \- the signature bytes to be verified.  
Returns:  
true if the signature was verified, false if not.  
Throws:  
`[SignatureException](../../java/security/SignatureException.html "class in java.security")` \- if this signature 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)  
                     throws [SignatureException](../../java/security/SignatureException.html "class in java.security")  
Verifies the passed-in signature in the specified array of bytes, starting at the specified offset.  
A call to this method resets this signature object to the state it was in when previously initialized for verification via a call to `initVerify(PublicKey)`. That is, the object is reset and available to verify another signature from the identity whose public key was specified in the call to `initVerify`.  
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](../../java/security/SignatureException.html "class in java.security")` \- if this signature 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](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the `signature` byte array is null, or the `offset` or `length` is less than 0, or the sum of the `offset` and`length` is greater than the length of the`signature` byte array.  
Since:  
1.4  
* #### update  
public final void update(byte b)  
                  throws [SignatureException](../../java/security/SignatureException.html "class in java.security")  
Updates the data to be signed or verified by a byte.  
Parameters:  
`b` \- the byte to use for the update.  
Throws:  
`[SignatureException](../../java/security/SignatureException.html "class in java.security")` \- if this signature object is not initialized properly.  
* #### update  
public final void update(byte[] data)  
                  throws [SignatureException](../../java/security/SignatureException.html "class in java.security")  
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](../../java/security/SignatureException.html "class in java.security")` \- if this signature object is not initialized properly.  
* #### update  
public final void update(byte[] data,  
                         int off,  
                         int len)  
                  throws [SignatureException](../../java/security/SignatureException.html "class in java.security")  
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](../../java/security/SignatureException.html "class in java.security")` \- if this signature object is not initialized properly.  
`[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `data` is `null`, or `off` or `len` is less than 0, or the sum of`off` and `len` is greater than the length of`data`.  
* #### update  
public final void update([ByteBuffer](../../java/nio/ByteBuffer.html "class in java.nio") data)  
                  throws [SignatureException](../../java/security/SignatureException.html "class in java.security")  
Updates the data to be signed or verified using the specified ByteBuffer. Processes the `data.remaining()` bytes starting at `data.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](../../java/security/SignatureException.html "class in java.security")` \- if this signature object is not initialized properly.  
Since:  
1.5  
* #### getAlgorithm  
public final [String](../../java/lang/String.html "class in java.lang") getAlgorithm()  
Returns the name of the algorithm for this signature object.  
Returns:  
the name of the algorithm for this signature object.  
* #### toString  
public [String](../../java/lang/String.html "class in java.lang") toString()  
Returns a string representation of this signature object, providing information that includes the state of the object and the name of the algorithm used.  
Overrides:  
`[toString](../../java/lang/Object.html#toString--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
Returns:  
a string representation of this signature object.  
* #### setParameter  
[@Deprecated](../../java/lang/Deprecated.html "annotation in java.lang")  
public final void setParameter([String](../../java/lang/String.html "class in java.lang") param,  
                               [Object](../../java/lang/Object.html "class in java.lang") value)  
                        throws [InvalidParameterException](../../java/security/InvalidParameterException.html "class in java.security")  
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](../../java/security/InvalidParameterException.html "class in java.security")` \- 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.  
See Also:  
[getParameter(java.lang.String)](../../java/security/Signature.html#getParameter-java.lang.String-)  
* #### setParameter  
public final void setParameter([AlgorithmParameterSpec](../../java/security/spec/AlgorithmParameterSpec.html "interface in java.security.spec") params)  
                        throws [InvalidAlgorithmParameterException](../../java/security/InvalidAlgorithmParameterException.html "class in java.security")  
Initializes this signature engine with the specified parameter set.  
Parameters:  
`params` \- the parameters  
Throws:  
`[InvalidAlgorithmParameterException](../../java/security/InvalidAlgorithmParameterException.html "class in java.security")` \- if the given parameters are inappropriate for this signature engine  
See Also:  
[getParameters()](../../java/security/Signature.html#getParameters--)  
* #### getParameters  
public final [AlgorithmParameters](../../java/security/AlgorithmParameters.html "class in java.security") getParameters()  
Returns the parameters used with this signature object.  
The returned parameters may be the same that were used to initialize this signature, or may contain a combination of default and randomly generated parameter values used by the underlying signature implementation if this signature requires algorithm parameters but was not initialized with any.  
Returns:  
the parameters used with this signature, or null if this signature does not use any parameters.  
Since:  
1.4  
See Also:  
[setParameter(AlgorithmParameterSpec)](../../java/security/Signature.html#setParameter-java.security.spec.AlgorithmParameterSpec-)  
* #### getParameter  
[@Deprecated](../../java/lang/Deprecated.html "annotation in java.lang")  
public final [Object](../../java/lang/Object.html "class in java.lang") getParameter([String](../../java/lang/String.html "class in java.lang") param)  
                          throws [InvalidParameterException](../../java/security/InvalidParameterException.html "class in java.security")  
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](../../java/security/InvalidParameterException.html "class in java.security")` \- if `param` is an invalid parameter for this engine, or another exception occurs while trying to get this parameter.  
See Also:  
[setParameter(String, Object)](../../java/security/Signature.html#setParameter-java.lang.String-java.lang.Object-)  
* #### clone  
public [Object](../../java/lang/Object.html "class in java.lang") clone()  
             throws [CloneNotSupportedException](../../java/lang/CloneNotSupportedException.html "class in java.lang")  
Returns a clone if the implementation is cloneable.  
Overrides:  
`[clone](../../java/security/SignatureSpi.html#clone--)` in class `[SignatureSpi](../../java/security/SignatureSpi.html "class in java.security")`  
Returns:  
a clone if the implementation is cloneable.  
Throws:  
`[CloneNotSupportedException](../../java/lang/CloneNotSupportedException.html "class in java.lang")` \- if this is called on an implementation that does not support `Cloneable`.  
See Also:  
[Cloneable](../../java/lang/Cloneable.html "interface in java.lang")

Signature (Java SE 9 & JDK 9 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail