net.rim.device.api.crypto
Class PKCS1SignatureVerifier

java.lang.Object
  net.rim.device.api.crypto.PKCS1SignatureVerifier

All Implemented Interfaces:

SignatureVerifier

public final class PKCS1SignatureVerifier
extends Object
implements SignatureVerifier

The PKCS1SignatureVerifier class can verify an RSA PKCS#1 signature.

We implemented the PKCS1 verification as per the PKCS #1 version 2.1 document.

For a code sample using the PKCS1 signature verifier, click here.

See Also:

PKCS1SignatureSigner

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Constructor Summary
	PKCS1SignatureVerifier(RSAPublicKey key, byte[] signature, int signatureOffset) Constructs an RSA PKCS1SignatureVerifier object which uses the SHA-1 digest.
	PKCS1SignatureVerifier(RSAPublicKey key, Digest digest, byte[] signature, int signatureOffset) Constructs an RSA PKCS1SignatureVerifier object which uses the given digest.

Method Summary
	String	getAlgorithm() Returns the name of the signing algorithm used ("RSA_PKCS1_(V15 or V20)/" + digest algorithm name).
	void	update(byte[] data) Adds additional message data to the signature.
	void	update(byte[] data, int offset, int length) Adds additional message data to the signature.
	void	update(int data) Adds additional message data to the signature.
	boolean	verify() Returns true if the signature is valid, false otherwise.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PKCS1SignatureVerifier

public PKCS1SignatureVerifier(RSAPublicKey key,
                              byte[] signature,
                              int signatureOffset)
                       throws InvalidSignatureEncodingException,
                              CryptoTokenException,
                              CryptoUnsupportedOperationException

Constructs an RSA PKCS1SignatureVerifier object which uses the SHA-1 digest.

Parameters:

key - The public key used to verify the signature.

signature - The signature to be verified.

signatureOffset - The offset, or the start position, of the signature data within the array.

Throws:

InvalidSignatureEncodingException

CryptoTokenException

CryptoUnsupportedOperationException

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

PKCS1SignatureVerifier

public PKCS1SignatureVerifier(RSAPublicKey key,
                              Digest digest,
                              byte[] signature,
                              int signatureOffset)
                       throws InvalidSignatureEncodingException,
                              CryptoTokenException,
                              CryptoUnsupportedOperationException

Constructs an RSA PKCS1SignatureVerifier object which uses the given digest.

Parameters:

key - The public key used to verify the signature.

digest - The digest used to process the message.

signature - The signature to be verified.

signatureOffset - The offset, or start position, of the signature data within the array.

Throws:

InvalidSignatureEncodingException

CryptoTokenException

CryptoUnsupportedOperationException

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of the signing algorithm used ("RSA_PKCS1_(V15 or V20)/" + digest algorithm name).

Specified by:

getAlgorithm in interface SignatureVerifier

Returns:

A String representing the name of the algorithm.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

update

public void update(int data)

Description copied from interface: SignatureVerifier

Adds additional message data to the signature.

Specified by:

update in interface SignatureVerifier

Parameters:

data - The byte to be hashed.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

update

public void update(byte[] data)

Description copied from interface: SignatureVerifier

Adds additional message data to the signature.

Specified by:

update in interface SignatureVerifier

Parameters:

data - A byte array containing the message data to hash.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

update

public void update(byte[] data,
                   int offset,
                   int length)

Description copied from interface: SignatureVerifier

Adds additional message data to the signature.

Specified by:

update in interface SignatureVerifier

Parameters:

data - The message data to hash.

offset - The offset, or initial position to start reading in the data.

length - The amount of data to read.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

verify

public boolean verify()
               throws CryptoTokenException,
                      CryptoUnsupportedOperationException

Description copied from interface: SignatureVerifier

Returns true if the signature is valid, false otherwise.

Specified by:

verify in interface SignatureVerifier

Returns:

A boolean that returns true if the signature is valid, false otherwise.

Throws:

CryptoTokenException - Thrown when a problem occurs with a crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown when a call is made to an unsupported operation.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0