SHOW Signed

net.rim.device.api.crypto
Class PKCS1SignatureSigner

java.lang.Object
  |
  +--net.rim.device.api.crypto.PKCS1SignatureSigner

All Implemented Interfaces:

SignatureSigner

public final class PKCS1SignatureSigner

extends Object

implements SignatureSigner

The PKCS1SignatureSigner object can sign messages using the RSA PKCS#1 signature scheme.

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

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

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

See Also:

PKCS1SignatureVerifier

Constructor Summary

	PKCS1SignatureSigner(RSAPrivateKey key) Constructs an RSA PKCS1SignatureSigner (version 2.0) object which uses the SHA1 digest.
	PKCS1SignatureSigner(RSAPrivateKey key, boolean useASN1) Constructs an RSA PKCS1SignatureSigner object (version 2.0) signing object which uses the given digest.
	PKCS1SignatureSigner(RSAPrivateKey key, Digest digest) Constructs an RSA PKCS1SignatureSigner object (version 2.0) signing object which uses the given digest.
	PKCS1SignatureSigner(RSAPrivateKey key, Digest digest, boolean useASN1) Constructs an RSA PKCS1SignatureSigner (version 1.5 or 2.0) object that uses the given digest.

Method Summary

	String	getAlgorithm() Returns a String containing the name of the algorithm (eg "RSA_PKCS1_V15/<DigestAlgorithm>" or "RSA_PKCS1_V20/<DigestAlgorithm>").
	String	getDigestAlgorithm() Returns the name of the digest algorithm used, eg "SHA1", etc.
	int	getLength() Returns the length of the signature in bytes.
	static boolean	isVersion20Supported() Returns true if PKCS1 version 2.0 is supported.
	void	reset() Reinitializes the signer, preparing it to generate another signature.
	void	sign(byte[] signature, int signatureOffset) Signs the formatted signature data that has been generated from the values passed through the update function.
	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PKCS1SignatureSigner

public PKCS1SignatureSigner(RSAPrivateKey key)
                     throws CryptoUnsupportedOperationException

Constructs an RSA PKCS1SignatureSigner (version 2.0) object which uses the SHA1 digest.

Parameters:

key - The private key to use for signing.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

PKCS1SignatureSigner

public PKCS1SignatureSigner(RSAPrivateKey key,
                            boolean useASN1)
                     throws CryptoUnsupportedOperationException

Constructs an RSA PKCS1SignatureSigner object (version 2.0) signing object which uses the given digest.

Parameters:

key - The private key to use for signing.

useASN1 - A boolean that determines whether or not to ASN1-encode the digest before it is signed. Set this to false for version 1.5 (which does not use ASN1) or true for version 2.0 (which does use ASN1).

Throws:

CryptoUnsupportedOperationException - Thrown if the OID for the given digest is unknown.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

PKCS1SignatureSigner

public PKCS1SignatureSigner(RSAPrivateKey key,
                            Digest digest)
                     throws CryptoUnsupportedOperationException

Constructs an RSA PKCS1SignatureSigner object (version 2.0) signing object which uses the given digest.

Parameters:

key - The private key to use for signing.

digest - The digest to use to process the message.

Throws:

CryptoUnsupportedOperationException - Thrown if the OID for the given digest is unknown.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

PKCS1SignatureSigner

public PKCS1SignatureSigner(RSAPrivateKey key,
                            Digest digest,
                            boolean useASN1)
                     throws CryptoUnsupportedOperationException

Constructs an RSA PKCS1SignatureSigner (version 1.5 or 2.0) object that uses the given digest.

Parameters:

key - The private key to use for signing

digest - The digest to use to process the message. If digest is null, then if useASN1 is set to true then a SHA1Digest is created, else a MD5Digest is created.

useASN1 - A boolean that determines whether or not to ASN1-encode the digest before it is signed. Set this to false for version 1.5 (which does not use ASN1) or true for version 2.0 (which does use ASN1).

Throws:

CryptoUnsupportedOperationException - Thrown if the OID for the given digest is unknown.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Method Detail

isVersion20Supported

public static boolean isVersion20Supported()

Returns true if PKCS1 version 2.0 is supported. Note: The code file net_rim_crypto2.cod must be present on the device to support version 2.0.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getAlgorithm

public String getAlgorithm()

Returns a String containing the name of the algorithm (eg "RSA_PKCS1_V15/<DigestAlgorithm>" or "RSA_PKCS1_V20/<DigestAlgorithm>").

Specified by:

getAlgorithm in interface SignatureSigner

Returns:

A String that represents the name of the algorithm and the digest used.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDigestAlgorithm

public String getDigestAlgorithm()

Returns the name of the digest algorithm used, eg "SHA1", etc.

Specified by:

getDigestAlgorithm in interface SignatureSigner

Returns:

A String that represents the name of the digest algorithm.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

reset

public void reset()

Description copied from interface: SignatureSigner

Reinitializes the signer, preparing it to generate another signature.

Specified by:

reset in interface SignatureSigner

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

update

public void update(int data)

Description copied from interface: SignatureSigner

Adds additional message data to the signature.

Specified by:

update in interface SignatureSigner

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

update

public void update(byte[] data)

Description copied from interface: SignatureSigner

Adds additional message data to the signature.

Specified by:

update in interface SignatureSigner

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

update

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

Description copied from interface: SignatureSigner

Adds additional message data to the signature.

Specified by:

update in interface SignatureSigner

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getLength

public int getLength()

Returns the length of the signature in bytes.

Returns:

An integer that represents the length of the signature.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

sign

public void sign(byte[] signature,
                 int signatureOffset)
          throws CryptoTokenException,
                 CryptoUnsupportedOperationException

Signs the formatted signature data that has been generated from the values passed through the update function.

Parameters:

signature - A byte array to contain the signature.

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

Throws:

CryptoTokenException - Thrown if an error occurs with the crypto token or the crypto token is invalid.

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

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.