OpenJDK 1.23 · java.security.SignatureSpi · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected SecureRandom	appRandom Application-specified source of randomness.

Access	Constructor and Description
public	SignatureSpi() Constructor for subclasses to call.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: a clone if the implementation is cloneable. clone() Overrides java.lang.Object.clone. Returns a clone if the implementation is cloneable.
protected abstract Object	Returns: the object that represents the parameter value, or `null` if there is none. engineGetParameter(String the string name of the parameter. param) Deprecated Gets the value of the specified algorithm parameter.
protected AlgorithmParameters	Returns: the parameters used with this `Signature` object, or `null` engineGetParameters() Returns the parameters used with this `Signature` object.
protected abstract void	engineInitSign(PrivateKey the private key of the identity whose signature will be generated. privateKey) Initializes this `Signature` object with the specified private key for signing operations.
protected void	engineInitSign(PrivateKey the private key of the identity whose signature will be generated. privateKey, SecureRandom the source of randomness random) Initializes this `Signature` object with the specified private key and source of randomness for signing operations.
pack-priv void	engineInitSign(PrivateKey the private key of the identity whose signature will be generated. privateKey, AlgorithmParameterSpec the parameters for generating signature params, SecureRandom the source of randomness random) Initializes this `Signature` object with the specified private key and source of randomness for signing operations.
protected abstract void	engineInitVerify(PublicKey the public key of the identity whose signature is going to be verified. publicKey) Initializes this `Signature` object with the specified public key for verification operations.
pack-priv void	engineInitVerify(PublicKey the public key of the identity whose signature is going to be verified. publicKey, AlgorithmParameterSpec the parameters for verifying this `Signature` object params) Initializes this `Signature` object with the specified public key for verification operations.
protected abstract void	engineSetParameter(String the string identifier of the parameter. param, Object the parameter value. value) Deprecated Replaced by `engineSetParameter`. Sets the specified algorithm parameter to the specified value.
protected void	engineSetParameter(AlgorithmParameterSpec the parameters params) Initializes this `Signature` object with the specified parameter values.
protected abstract byte[]	Returns: the signature bytes of the signing operation's result. engineSign() Returns the signature bytes of all the data updated so far.
protected int	Returns: the number of bytes placed into `outbuf` engineSign(byte[] buffer for the signature result. outbuf, int offset into `outbuf` where the signature is stored. offset, int 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. len) Finishes this signature operation and stores the resulting signature bytes in the provided buffer `outbuf`, starting at `offset`.
protected abstract void	engineUpdate(byte the byte to use for the update. b) Updates the data to be signed or verified using the specified byte.
protected abstract void	engineUpdate(byte[] the array of bytes b, int the offset to start from in the array of bytes off, int the number of bytes to use, starting at offset len) Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.
protected void	engineUpdate(ByteBuffer the ByteBuffer input) Updates the data to be signed or verified using the specified ByteBuffer.
protected abstract boolean	Returns: `true` if the signature was verified, `false` if not. engineVerify(byte[] the signature bytes to be verified. sigBytes) Verifies the passed-in signature.
protected boolean	Returns: `true` if the signature was verified, `false` if not. engineVerify(byte[] the signature bytes to be verified. sigBytes, int the offset to start from in the array of bytes. offset, int the number of bytes to use, starting at offset. length) Verifies the passed-in signature in the specified array of bytes, starting at the specified offset.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

appRandom	back to summary
protected SecureRandom appRandom Application-specified source of randomness.

SignatureSpi	back to summary
public SignatureSpi() Constructor for subclasses to call.

Method Detail

clone back to summary

clone	back to summary
public Object clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Returns a clone if the implementation is cloneable. Returns:Object a clone if the implementation is cloneable. Exceptions CloneNotSupportedException: if this is called on an implementation that does not support `Cloneable`.

public Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Returns a clone if the implementation is cloneable.

Returns:Object

a clone if the implementation is cloneable.

Exceptions

CloneNotSupportedException:: if this is called on an implementation that does not support Cloneable.

engineGetParameter back to summary

engineGetParameter	back to summary
protected abstract 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 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:String the string name of the parameter. Returns:Object the object that represents the parameter value, or `null` if there is none. Annotations @Deprecated Exceptions InvalidParameterException: if `param` is an invalid parameter for this engine, or another exception occurs while trying to get this parameter.

protected abstract 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 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:String: the string name of the parameter.

Returns:Object

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

Annotations

@Deprecated

Exceptions

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

engineGetParameters back to summary

engineGetParameters	back to summary
protected AlgorithmParameters engineGetParameters() Returns the parameters used with this `Signature` object. The returned parameters may be the same that were used to initialize this `Signature` 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 the `Signature` object, the generated parameters are returned; otherwise `null` is returned. However, if the signature scheme does not support returning the parameters as `AlgorithmParameters`, `null` is always returned. Returns:AlgorithmParameters the parameters used with this `Signature` object, or `null` Exceptions UnsupportedOperationException: if this method is not overridden by a provider Since 1.4

protected AlgorithmParameters engineGetParameters()

Returns the parameters used with this Signature object.

The returned parameters may be the same that were used to initialize this Signature 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 the Signature object, the generated parameters are returned; otherwise null is returned.

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

Returns:AlgorithmParameters

the parameters used with this Signature object, or null

Exceptions

UnsupportedOperationException:: if this method is not overridden by a provider

Since

1.4

engineInitSign back to summary

engineInitSign	back to summary
protected abstract void engineInitSign(PrivateKey privateKey) throws InvalidKeyException Initializes this `Signature` object with the specified private key for signing operations. Parameters privateKey:PrivateKey the private key of the identity whose signature will be generated. Exceptions InvalidKeyException: if the key is improperly encoded, parameters are missing, and so on.

protected abstract void engineInitSign(PrivateKey privateKey) throws InvalidKeyException

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

Parameters

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

Exceptions

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

engineInitSign back to summary

engineInitSign	back to summary
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:PrivateKey the private key of the identity whose signature will be generated. random:SecureRandom the source of randomness Exceptions InvalidKeyException: if the key is improperly encoded, parameters are missing, and so on.

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:PrivateKey: the private key of the identity whose signature will be generated.
random:SecureRandom: the source of randomness

Exceptions

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

engineInitSign back to summary

engineInitSign	back to summary
pack-priv void engineInitSign(PrivateKey privateKey, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException 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:PrivateKey the private key of the identity whose signature will be generated. params:AlgorithmParameterSpec the parameters for generating signature random:SecureRandom the source of randomness Exceptions InvalidKeyException: if the key is improperly encoded, parameters are missing, and so on. InvalidAlgorithmParameterException: if the parameters is invalid.

pack-priv void engineInitSign(PrivateKey privateKey, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException

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:PrivateKey: the private key of the identity whose signature will be generated.
params:AlgorithmParameterSpec: the parameters for generating signature
random:SecureRandom: the source of randomness

Exceptions

InvalidKeyException:: if the key is improperly encoded, parameters are missing, and so on.
InvalidAlgorithmParameterException:: if the parameters is invalid.

engineInitVerify back to summary

engineInitVerify	back to summary
protected abstract void engineInitVerify(PublicKey publicKey) throws InvalidKeyException Initializes this `Signature` object with the specified public key for verification operations. Parameters publicKey:PublicKey the public key of the identity whose signature is going to be verified. Exceptions InvalidKeyException: if the key is improperly encoded, parameters are missing, and so on.

protected abstract void engineInitVerify(PublicKey publicKey) throws InvalidKeyException

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

Parameters

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

Exceptions

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

engineInitVerify back to summary

engineInitVerify	back to summary
pack-priv void engineInitVerify(PublicKey publicKey, AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException Initializes this `Signature` object with the specified public key for verification operations. Parameters publicKey:PublicKey the public key of the identity whose signature is going to be verified. params:AlgorithmParameterSpec the parameters for verifying this `Signature` object Exceptions InvalidKeyException: if the key is improperly encoded, does not work with the given parameters, and so on. InvalidAlgorithmParameterException: if the given parameters is invalid.

pack-priv void engineInitVerify(PublicKey publicKey, AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException

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

Parameters

publicKey:PublicKey: the public key of the identity whose signature is going to be verified.
params:AlgorithmParameterSpec: the parameters for verifying this Signature object

Exceptions

InvalidKeyException:: if the key is improperly encoded, does not work with the given parameters, and so on.
InvalidAlgorithmParameterException:: if the given parameters is invalid.

engineSetParameter back to summary

engineSetParameter	back to summary
protected abstract 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 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:String the string identifier of the parameter. value:Object the parameter value. Annotations @Deprecated Exceptions InvalidParameterException: if `param` is an invalid parameter for this `Signature` object, the parameter is already set and cannot be set again, a security exception occurs, and so on.

protected abstract 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 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:String: the string identifier of the parameter.
value:Object: the parameter value.

Annotations

@Deprecated

Exceptions

InvalidParameterException:: if param is an invalid parameter for this Signature object, the parameter is already set and cannot be set again, a security exception occurs, and so on.

engineSetParameter back to summary

engineSetParameter	back to summary
protected void engineSetParameter(AlgorithmParameterSpec params) throws InvalidAlgorithmParameterException Initializes this `Signature` object with the specified parameter values. Parameters params:AlgorithmParameterSpec the parameters Exceptions InvalidAlgorithmParameterException: if this method is overridden by a provider and the given parameters are inappropriate for this `Signature` object UnsupportedOperationException: if this method is not overridden by a provider

protected void engineSetParameter(AlgorithmParameterSpec params) throws InvalidAlgorithmParameterException

Initializes this Signature object with the specified parameter values.

Parameters

params:AlgorithmParameterSpec: the parameters

Exceptions

InvalidAlgorithmParameterException:: if this method is overridden by a provider and the given parameters are inappropriate for this Signature object
UnsupportedOperationException:: if this method is not overridden by a provider

engineSign	back to summary
protected abstract 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:byte[] the signature bytes of the signing operation's result. Exceptions SignatureException: if the engine is not initialized properly or if this signature algorithm is unable to process the input data provided.

engineSign

back to summary

protected abstract 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:byte[]

the signature bytes of the signing operation's result.

Exceptions

SignatureException:: if the engine is not initialized properly or if this signature algorithm is unable to process the input data provided.

engineSign back to summary

engineSign	back to summary
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:byte[] buffer for the signature result. offset:int offset into `outbuf` where the signature is stored. len:int 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:int the number of bytes placed into `outbuf` Exceptions SignatureException: if the engine 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. Since 1.2

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:byte[]: buffer for the signature result.
offset:int: offset into outbuf where the signature is stored.
len:int: 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:int

the number of bytes placed into outbuf

Exceptions

SignatureException:: if the engine 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.

Since

1.2

engineUpdate	back to summary
protected abstract void engineUpdate(byte b) throws SignatureException Updates the data to be signed or verified using the specified byte. Parameters b:byte the byte to use for the update. Exceptions SignatureException: if the engine is not initialized properly.

engineUpdate

back to summary

protected abstract void engineUpdate(byte b) throws SignatureException

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

Parameters

b:byte: the byte to use for the update.

Exceptions

SignatureException:: if the engine is not initialized properly.

engineUpdate	back to summary
protected abstract void engineUpdate(byte[] b, int off, int len) throws SignatureException Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset. Parameters b:byte[] the array of bytes off:int the offset to start from in the array of bytes len:int the number of bytes to use, starting at offset Exceptions SignatureException: if the engine is not initialized properly

engineUpdate

back to summary

protected abstract void engineUpdate(byte[] b, int off, int len) throws SignatureException

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

Parameters

b:byte[]: the array of bytes
off:int: the offset to start from in the array of bytes
len:int: the number of bytes to use, starting at offset

Exceptions

SignatureException:: if the engine is not initialized properly

engineUpdate back to summary

engineUpdate	back to summary
protected void engineUpdate(ByteBuffer input) 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 input:ByteBuffer the ByteBuffer Since 1.5

protected void engineUpdate(ByteBuffer input)

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

input:ByteBuffer: the ByteBuffer

Since

1.5

engineVerify back to summary

engineVerify	back to summary
protected abstract boolean engineVerify(byte[] sigBytes) throws SignatureException Verifies the passed-in signature. Parameters sigBytes:byte[] the signature bytes to be verified. Returns:boolean `true` if the signature was verified, `false` if not. Exceptions SignatureException: if the engine 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.

protected abstract boolean engineVerify(byte[] sigBytes) throws SignatureException

Verifies the passed-in signature.

Parameters

sigBytes:byte[]: the signature bytes to be verified.

Returns:boolean

true if the signature was verified, false if not.

Exceptions

SignatureException:: if the engine 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.

engineVerify back to summary

engineVerify	back to summary
protected boolean engineVerify(byte[] sigBytes, int offset, int length) 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:byte[] the signature bytes to be verified. offset:int the offset to start from in the array of bytes. length:int the number of bytes to use, starting at offset. Returns:boolean `true` if the signature was verified, `false` if not. Exceptions SignatureException: if the engine 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. Since 1.4

protected boolean engineVerify(byte[] sigBytes, int offset, int length) 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:byte[]: the signature bytes to be verified.
offset:int: the offset to start from in the array of bytes.
length:int: the number of bytes to use, starting at offset.

Returns:boolean

true if the signature was verified, false if not.

Exceptions

SignatureException:: if the engine 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.

Since

1.4

public abstract Class SignatureSpi

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail