Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public abstract class

SignatureSpi

extends Object
java.lang.Object
   ↳ java.security.SignatureSpi
Known Direct Subclasses

Class Overview

SignatureSpi is the Service Provider Interface ( SPI ) definition for Signature .

See Also

Summary

Fields
protected SecureRandom appRandom Implementation specific source of randomness.
Public Constructors
SignatureSpi ()
Public Methods
Object clone ()
Creates and returns a copy of this Object .
Protected Methods
abstract Object engineGetParameter ( String param)
This method was deprecated in API level 1. There is no generally accepted parameter naming convention.
AlgorithmParameters engineGetParameters ()
Returns the AlgorithmParameters of this SignatureSpi instance.
void engineInitSign ( PrivateKey privateKey, SecureRandom random)
Initializes this SignatureSpi instance for signing, using the private key of the identity whose signature is going to be generated and the specified source of randomness.
abstract void engineInitSign ( PrivateKey privateKey)
Initializes this SignatureSpi instance for signing, using the private key of the identity whose signature is going to be generated.
abstract void engineInitVerify ( PublicKey publicKey)
Initializes this SignatureSpi instance for signature verification, using the public key of the identity whose signature is going to be verified.
abstract void engineSetParameter ( String param, Object value)
This method was deprecated in API level 1. Use engineSetParameter(AlgorithmParameterSpec)
void engineSetParameter ( AlgorithmParameterSpec params)
Sets the specified AlgorithmParameterSpec .
int engineSign (byte[] outbuf, int offset, int len)
Generates and stores the signature of all updated data in the provided byte[] at the specified position with the specified length.
abstract byte[] engineSign ()
Generates and returns the signature of all updated data.
abstract void engineUpdate (byte b)
Updates the data to be verified or to be signed, using the specified byte .
void engineUpdate ( ByteBuffer input)
Updates the data to be verified or to be signed, using the specified ByteBuffer .
abstract void engineUpdate (byte[] b, int off, int len)
Updates the data to be verified or to be signed, using the given byte[] , starting form the specified index for the specified length.
boolean engineVerify (byte[] sigBytes, int offset, int length)
Indicates whether the given sigBytes starting at index offset with length bytes can be verified using the public key or a certificate of the signer.
abstract boolean engineVerify (byte[] sigBytes)
Indicates whether the given sigBytes can be verified using the public key or a certificate of the signer.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected SecureRandom appRandom

Added in API level 1

Implementation specific source of randomness.

Public Constructors

public SignatureSpi ()

Added in API level 1

Public Methods

public Object clone ()

Added in API level 1

Creates and returns a copy of this Object . The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.

Returns
  • a copy of this object.
Throws
CloneNotSupportedException

Protected Methods

protected abstract Object engineGetParameter ( String param)

Added in API level 1

This method was deprecated in API level 1.
There is no generally accepted parameter naming convention.

Returns the value of the parameter with the specified name.

Parameters
param the name of the requested parameter value.
Returns
  • the value of the parameter with the specified name, maybe null .
Throws
InvalidParameterException if param is not a valid parameter for this SignatureSpi or an other error occurs.

protected AlgorithmParameters engineGetParameters ()

Added in API level 1

Returns the AlgorithmParameters of this SignatureSpi instance.

Returns

protected void engineInitSign ( PrivateKey privateKey, SecureRandom random)

Added in API level 1

Initializes this SignatureSpi instance for signing, using the private key of the identity whose signature is going to be generated and the specified source of randomness.

Parameters
privateKey the private key.
random the SecureRandom to use.
Throws
InvalidKeyException if privateKey is not valid.

protected abstract void engineInitSign ( PrivateKey privateKey)

Added in API level 1

Initializes this SignatureSpi instance for signing, using the private key of the identity whose signature is going to be generated.

Parameters
privateKey the private key.
Throws
InvalidKeyException if privateKey is not valid.

protected abstract void engineInitVerify ( PublicKey publicKey)

Added in API level 1

Initializes this SignatureSpi instance for signature verification, using the public key of the identity whose signature is going to be verified.

Parameters
publicKey the public key.
Throws
InvalidKeyException if publicKey is not valid.

protected abstract void engineSetParameter ( String param, Object value)

Added in API level 1

This method was deprecated in API level 1.
Use engineSetParameter(AlgorithmParameterSpec)

Sets the specified parameter to the given value.

Parameters
param the name of the parameter.
value the parameter value.
Throws
InvalidParameterException if the parameter is invalid, already set or is not allowed to be changed.

protected void engineSetParameter ( AlgorithmParameterSpec params)

Added in API level 1

Sets the specified AlgorithmParameterSpec .

Parameters
params the parameter to set.
Throws
InvalidAlgorithmParameterException if the parameter is invalid, already set or is not allowed to be changed.

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

Added in API level 1

Generates and stores the signature of all updated data in the provided byte[] at the specified position with the specified length.

This SignatureSpi instance is reset to the state of its last initialization for signing and thus can be used for another signature from the same identity.

Parameters
outbuf the buffer to store the signature.
offset the index of the first byte in outbuf to store.
len the number of bytes allocated for the signature.
Returns
  • the number of bytes stored in outbuf .
Throws
SignatureException if this SignatureSpi instance is not initialized properly.
IllegalArgumentException if offset or len are not valid in respect to outbuf .

protected abstract byte[] engineSign ()

Added in API level 1

Generates and returns the signature of all updated data.

This SignatureSpi instance is reset to the state of its last initialization for signing and thus can be used for another signature from the same identity.

Returns
  • the signature of all updated data.
Throws
SignatureException if this SignatureSpi instance is not initialized properly.

protected abstract void engineUpdate (byte b)

Added in API level 1

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

Parameters
b the byte to update with.
Throws
SignatureException if this SignatureSpi instance is not initialized properly.

protected void engineUpdate ( ByteBuffer input)

Added in API level 1

Updates the data to be verified or to be signed, using the specified ByteBuffer .

Parameters
input the ByteBuffer to update with.
Throws
RuntimeException since SignatureException is not specified for this method it throws a RuntimeException if underlying engineUpdate(byte[], int, int) throws SignatureException .

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

Added in API level 1

Updates the data to be verified or to be signed, using the given byte[] , starting form the specified index for the specified length.

Parameters
b the byte array to update with.
off the start index in b of the data.
len the number of bytes to use.
Throws
SignatureException if this SignatureSpi instance is not initialized properly.

protected boolean engineVerify (byte[] sigBytes, int offset, int length)

Added in API level 1

Indicates whether the given sigBytes starting at index offset with length bytes can be verified using the public key or a certificate of the signer.

This SignatureSpi instance is reset to the state of its last initialization for verifying and thus can be used to verify another signature of the same signer.

Parameters
sigBytes the byte[] containing the signature to verify.
offset the start index in sigBytes of the signature
length the number of bytes allocated for the signature.
Returns
  • true if the signature was verified, false otherwise.
Throws
SignatureException if this SignatureSpi instance is not initialized properly.
IllegalArgumentException if offset or length are not valid in respect to sigBytes .

protected abstract boolean engineVerify (byte[] sigBytes)

Added in API level 1

Indicates whether the given sigBytes can be verified using the public key or a certificate of the signer.

This SignatureSpi instance is reset to the state of its last initialization for verifying and thus can be used to verify another signature of the same signer.

Parameters
sigBytes the signature to verify.
Returns
  • true if the signature was verified, false otherwise.
Throws
SignatureException if this SignatureSpi instance is not initialized properly.