SHOW Signed

net.rim.device.api.crypto
Class RSAPrivateKey

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

All Implemented Interfaces:

Key, net.rim.vm.Persistable, Persistable, PrivateKey, RSAKey

public final class RSAPrivateKey

extends Object

implements PrivateKey, RSAKey, Persistable

Represents a private key in an RSA system.

A description of the RSA algorithm can be found in PKCS #1 version 2.1. We support this definition of RSA.

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.

Since:

JDE 3.6.0

See Also:

RSACryptoSystem

Constructor Summary

	RSAPrivateKey(RSACryptoSystem cryptoSystem, byte[] e, byte[] d, byte[] n) Constructs an RSAPrivateKey object.
	RSAPrivateKey(RSACryptoSystem cryptoSystem, byte[] e, byte[] d, byte[] p, byte[] q) Constructs an RSAPrivateKey object.
	RSAPrivateKey(RSACryptoSystem cryptoSystem, byte[] e, byte[] p, byte[] q, byte[] dModPm1, byte[] dModQm1, byte[] qInvModP) Constructs an RSAPrivateKey object.
	RSAPrivateKey(RSACryptoSystem cryptoSystem, byte[] e, byte[] d, byte[] n, byte[] p, byte[] q, byte[] dModPm1, byte[] dModQm1, byte[] qInvModP) Constructs an RSAPrivateKey object.

Method Summary

	boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
	String	getAlgorithm() Returns the name of the algorithm associated with this key ("RSA").
	CryptoSystem	getCryptoSystem() Returns the CryptoSystem used by this private key.
	byte[]	getD() Returns a copy of the private key exponent, or null if not available.
	byte[]	getDModPm1() Returns a copy of d mod p-1, or null if not available.
	byte[]	getDModQm1() Returns a copy of d mod q-1, or null if not available.
	byte[]	getE() Returns a copy of the public key exponent, or null if not available.
	byte[]	getN() Returns a copy of the public key modulus, or null if not available.
	byte[]	getP() Returns a copy of the first prime p, or null if not available.
	byte[]	getQ() Returns a copy of the second prime q, or null if not available.
	byte[]	getQInvModP() Returns a copy of the q^-1 mod p (coefficient, Chinese Remainder Theorem), or null if not available.
	RSACryptoSystem	getRSACryptoSystem() Returns the RSA crypto system associated with the key.
	int	hashCode() Returns a hash code value for the object.
	void	verify() Checks the integrity of the associated CryptoSystem, and then performs integrity checks on the private key parameters.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RSAPrivateKey

public RSAPrivateKey(RSACryptoSystem cryptoSystem,
                     byte[] e,
                     byte[] d,
                     byte[] n)
              throws InvalidKeyException,
                     CryptoTokenException,
                     CryptoUnsupportedOperationException,
                     UnsupportedCryptoSystemException

Constructs an RSAPrivateKey object.

Parameters:

cryptoSystem - An RSACryptoSystem that contains parameters for the RSA computations.

e - A byte array containing the public exponent e. If null, it will be assumed to be 65537

d - A byte array containing the private exponent.

n - A byte array containing the public modulus n.

Throws:

InvalidKeyException - Thrown if the key data is invalid.

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

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

UnsupportedCryptoSystemException - Thrown if the specified crypto system is invalid.

Since:

JDE 3.6.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.

RSAPrivateKey

public RSAPrivateKey(RSACryptoSystem cryptoSystem,
                     byte[] e,
                     byte[] d,
                     byte[] p,
                     byte[] q)
              throws InvalidKeyException,
                     CryptoTokenException,
                     CryptoUnsupportedOperationException,
                     UnsupportedCryptoSystemException

Constructs an RSAPrivateKey object.

Parameters:

cryptoSystem - An RSACryptoSystem that contains parameters for the RSA computations.

e - A byte array containing the public exponent e. If null, it will be assumed to be 65537

d - A byte array containing the private exponent.

p - A byte array containing the first prime in the modulus n.

q - A byte array the second prime in the modulus n. Note: n = p*q.

Throws:

InvalidKeyException - Thrown if the key data is invalid.

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

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

UnsupportedCryptoSystemException - Thrown if the specified crypto system is invalid.

Since:

JDE 3.6.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.

RSAPrivateKey

public RSAPrivateKey(RSACryptoSystem cryptoSystem,
                     byte[] e,
                     byte[] p,
                     byte[] q,
                     byte[] dModPm1,
                     byte[] dModQm1,
                     byte[] qInvModP)
              throws InvalidKeyException,
                     CryptoTokenException,
                     CryptoUnsupportedOperationException,
                     UnsupportedCryptoSystemException

Constructs an RSAPrivateKey object.

Parameters:

cryptoSystem - An RSACryptoSystem that contains parameters for the RSA computations.

p - A byte array containing the first prime that makes up the public modulus n.

q - A byte array containing the second prime that makes up the public modulus n.

dModPm1 - A byte array containing the d mod p-1.

dModQm1 - A byte array containing the d mod q-1.

qInvModP - A byte array containing the q^-1 mod p.

Throws:

InvalidKeyException - Thrown if the key data is invalid.

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

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

UnsupportedCryptoSystemException - Thrown if the specified crypto system is invalid.

Since:

JDE 3.6.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.

RSAPrivateKey

public RSAPrivateKey(RSACryptoSystem cryptoSystem,
                     byte[] e,
                     byte[] d,
                     byte[] n,
                     byte[] p,
                     byte[] q,
                     byte[] dModPm1,
                     byte[] dModQm1,
                     byte[] qInvModP)
              throws InvalidKeyException,
                     CryptoTokenException,
                     CryptoUnsupportedOperationException,
                     UnsupportedCryptoSystemException

Constructs an RSAPrivateKey object.

Parameters:

cryptoSystem - a RSACryptoSystem that contains parameters for the RSA computations.

e - A byte array containing the public exponent e.

d - A byte array containing the private exponent d.

n - A byte array containing the public modulus n.

p - A byte array containing the first prime that makes up the public modulus n.

q - A byte array containing the second prime that makes up the public modulus n.

dModPm1 - A byte array containing the d mod p-1.

dModQm1 - A byte array containing the d mod q-1.

qInvModP - A byte array containing the q^-1 mod p.

Throws:

InvalidKeyException - Thrown if the key data is invalid.

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

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

UnsupportedCryptoSystemException - Thrown if the specified crypto system is invalid.

Since:

JDE 3.6.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.

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of the algorithm associated with this key ("RSA").

This method will always return the String "RSA".

Specified by:

getAlgorithm in interface Key

Returns:

A String that represents the name of the algorithm.

Since:

JDE 3.6.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.

getRSACryptoSystem

public RSACryptoSystem getRSACryptoSystem()

Description copied from interface: RSAKey

Returns the RSA crypto system associated with the key.

Specified by:

getRSACryptoSystem in interface RSAKey

Since:

JDE 3.6.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.

getCryptoSystem

public CryptoSystem getCryptoSystem()

Description copied from interface: PrivateKey

Returns the CryptoSystem used by this private key.

Specified by:

getCryptoSystem in interface PrivateKey

Since:

JDE 3.6.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.

verify

public void verify()
            throws InvalidKeyException,
                   InvalidCryptoSystemException,
                   CryptoTokenException

Checks the integrity of the associated CryptoSystem, and then performs integrity checks on the private key parameters. The CryptoSystem is checked via its verify() method, and then the following is verified:

• q^-1 * q (mod p) = 1

Specified by:

verify in interface PrivateKey

Throws:

InvalidKeyException - If the private key parameters are invalid

InvalidCryptoSystemException - If the crypto system parameters are invalid

Since:

JDE 3.6.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.

getE

public byte[] getE()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException

Returns a copy of the public key exponent, or null if not available.

Returns:

A byte array containing e, the key exponent.

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.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.

getD

public byte[] getD()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException

Returns a copy of the private key exponent, or null if not available.

Returns:

A byte array containing d, the private key exponent.

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.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.

getN

public byte[] getN()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException

Returns a copy of the public key modulus, or null if not available.

Returns:

A byte array containing n, the public key modulus.

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.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.

getP

public byte[] getP()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException

Returns a copy of the first prime p, or null if not available.

Returns:

A byte array containing p, the first prime.

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.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.

getQ

public byte[] getQ()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException

Returns a copy of the second prime q, or null if not available.

Returns:

A byte array containing q, the second prime.

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.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.

getDModPm1

public byte[] getDModPm1()
                  throws CryptoTokenException,
                         CryptoUnsupportedOperationException

Returns a copy of d mod p-1, or null if not available.

Returns:

A byte array containing d mod p-1.

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.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.

getDModQm1

public byte[] getDModQm1()
                  throws CryptoTokenException,
                         CryptoUnsupportedOperationException

Returns a copy of d mod q-1, or null if not available.

Returns:

A byte array containing d mod q-1.

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.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.

getQInvModP

public byte[] getQInvModP()
                   throws CryptoTokenException,
                          CryptoUnsupportedOperationException

Returns a copy of the q^-1 mod p (coefficient, Chinese Remainder Theorem), or null if not available.

Returns:

A byte array containing q^-1 mod p.

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.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.

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Since:

JDE 3.6.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.

equals

public boolean equals(Object obj)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:

equals in class Object

Since:

JDE 3.7.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.