net.rim.device.api.crypto
Class RSAKeyPair

java.lang.Object
  net.rim.device.api.crypto.KeyPair
      net.rim.device.api.crypto.RSAKeyPair

All Implemented Interfaces:

Persistable

public final class RSAKeyPair
extends KeyPair
implements Persistable

The RSAKeyPair class holds an RSA public and private key.

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 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
	RSAKeyPair(RSACryptoSystem cryptoSystem) Creates a new RSA key pair with the given crypto system, and using 2^16+1 ( 0x10001 ) for the value of e.
	RSAKeyPair(RSACryptoSystem cryptoSystem, byte[] e) Creates a new RSAKeyPair object.
	RSAKeyPair(RSAPublicKey publicKey, RSAPrivateKey privateKey) Creates a new RSAKeyPair object with the given public and private keys.

Method Summary
	boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
	RSACryptoSystem	getRSACryptoSystem() Returns the RSACryptoSystem object associated with the keys.
	RSAPrivateKey	getRSAPrivateKey() Returns the RSAPrivateKey associated with this key pair.
	RSAPublicKey	getRSAPublicKey() Returns the RSAPublicKey object associated with this key pair.
	int	hashCode() Returns a hash code value for the object.
	void	verify() Checks the integrity of the associated PublicKey and PrivateKey, and then performs an integrity check on the private and public key parameters.

Methods inherited from class net.rim.device.api.crypto.KeyPair

getCryptoSystem, getPrivateKey, getPublicKey, isVerified, setKeyPair, verified

Methods inherited from class java.lang.Object

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

Constructor Detail

RSAKeyPair

public RSAKeyPair(RSACryptoSystem cryptoSystem)
           throws CryptoTokenException,
                  CryptoUnsupportedOperationException,
                  UnsupportedCryptoSystemException

Creates a new RSA key pair with the given crypto system, and using 2^16+1 ( 0x10001 ) for the value of e.

NOTE: This call can block the VM completely for up to a minute on a 5800 series Blackberry.

Parameters:

cryptoSystem - The crypto system used to create the key pair.

Throws:

CryptoTokenException - Thrown when an error occur with a crypto token or the crypto token is invalid.

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

UnsupportedCryptoSystemException - Thrown if the specified crypto system is insupported or unknown.

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

RSAKeyPair

public RSAKeyPair(RSACryptoSystem cryptoSystem,
                  byte[] e)
           throws InvalidKeyException,
                  CryptoTokenException,
                  CryptoUnsupportedOperationException,
                  UnsupportedCryptoSystemException

Creates a new RSAKeyPair object.

NOTE: This call can block the VM completely for up to a minute on a 5800 series Blackberry.

Parameters:

cryptoSystem - The crypto system used to create the key pair.

e - A byte array containing e, the public exponent.

Throws:

InvalidKeyException - Thrown if the e parameter is invalid.

CryptoTokenException - Thrown when an error occur with a crypto token or the crypto token is invalid.

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

UnsupportedCryptoSystemException - Thrown if the specified crypto system is insupported or unknown.

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

RSAKeyPair

public RSAKeyPair(RSAPublicKey publicKey,
                  RSAPrivateKey privateKey)
           throws InvalidKeyPairException

Creates a new RSAKeyPair object with the given public and private keys.

Parameters:

publicKey - The RSA public key to use

privateKey - The RSA private key to use

Throws:

InvalidKeyPairException - Thrown is the RSAKeyPair object is invalid.

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

getRSAPublicKey

public RSAPublicKey getRSAPublicKey()

Returns the RSAPublicKey object associated with this key pair.

Returns:

The RSAPublicKey object.

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

getRSAPrivateKey

public RSAPrivateKey getRSAPrivateKey()

Returns the RSAPrivateKey associated with this key pair.

Returns:

The RSAPrivateKey object.

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

getRSACryptoSystem

public RSACryptoSystem getRSACryptoSystem()

Returns the RSACryptoSystem object associated with the keys.

Returns:

The RSACryptoSystem object.

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 void verify()
            throws InvalidKeyException,
                   InvalidCryptoSystemException,
                   InvalidKeyPairException,
                   CryptoTokenException

Checks the integrity of the associated PublicKey and PrivateKey, and then performs an integrity check on the private and public key parameters. The PublicKey and PrivateKey are checked via their verify() methods, and then the following are verified:

• e * d mod (p-1) = 1
• e * d mod (q-1) = 1
• n = p * q

Specified by:

verify in class KeyPair

Throws:

InvalidKeyException - If the public or private key parameters are invalid

InvalidKeyPairException - Thrown when the keys are not related.

InvalidCryptoSystemException - If the crypto system parameters are invalid

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

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

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 KeyPair

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

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

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 KeyPair

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Boolean.hashCode(), Hashtable

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