SHOW Signed

net.rim.device.api.crypto
Class RSACryptoSystem

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

All Implemented Interfaces:

CryptoSystem, Persistable, net.rim.vm.Persistable

public final class RSACryptoSystem

extends Object

implements CryptoSystem, Persistable

RSACryptoSystem represents the system of asymmetric cryptography created by Rivest, Shamir and Adleman based on the Integer Factorization Problem.

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.

Constructor Summary

	RSACryptoSystem() Constructs an RSA system which uses keys of bit length 1024.
	RSACryptoSystem(int modulusBitLength) Constructs an RSACryptoSystem object which uses keys of a given bit length.

Method Summary

	KeyPair	createKeyPair() Creates a new key pair using this crypto system.
	RSAKeyPair	createRSAKeyPair()
	RSAKeyPair	createRSAKeyPair(byte[] e)
	boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
	String	getAlgorithm() Returns a String that indicates the algorithm, ie "RSA".
	int	getBitLength() Returns the number of bits (aka the "strength") of the crypto system, eg 1024 (for RSA), 163 (for EC).
	int	getModulusLength() Returns the number of bytes that comprise the public modulus for the system.
	String	getName() Returns a String that indicates the name of the crypto system, ie "RSA1024".
	int	hashCode() Returns a hash code value for the object.
	boolean	isStrong() Returns whether or not the CryptoSystem is cryptographically strong as of the release date of the code.
	void	verify() Performs certain integrity checks on the crypto system parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

RSACryptoSystem

public RSACryptoSystem()
                throws UnsupportedCryptoSystemException

Constructs an RSA system which uses keys of bit length 1024.

Throws:

UnsupportedCryptoSystemException - Thrown if the specified crypto system is invalid.

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.

RSACryptoSystem

public RSACryptoSystem(int modulusBitLength)
                throws UnsupportedCryptoSystemException

Constructs an RSACryptoSystem object which uses keys of a given bit length.

Parameters:

modulusBitLength - The length of the key, or the number of bits, when created under this system.

Throws:

UnsupportedCryptoSystemException - Thrown if the specified crypto system is invalid.

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

verify

public void verify()
            throws InvalidCryptoSystemException

Description copied from interface: CryptoSystem

Performs certain integrity checks on the crypto system parameters.

These checks are useful to prevent certain types of attacks that involve modifying the parameters and then using a signed message to calculate the private key parameters.

Specified by:

verify in interface CryptoSystem

Following copied from interface: net.rim.device.api.crypto.CryptoSystem

Throws:

InvalidCryptoSystemException - Thrown if the specified cryptosystem is invalid.

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.

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 that indicates the algorithm, ie "RSA".

This method will always return the String "RSA".

Specified by:

getAlgorithm in interface CryptoSystem

Returns:

A String that represents the 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.

getName

public String getName()

Returns a String that indicates the name of the crypto system, ie "RSA1024".

Specified by:

getName in interface CryptoSystem

Returns:

A String that represents the name of the crypto system.

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.

getBitLength

public int getBitLength()

Description copied from interface: CryptoSystem

Returns the number of bits (aka the "strength") of the crypto system, eg 1024 (for RSA), 163 (for EC).

Note: the strength of a CryptoSystem is a combination of the algorithm and the bit length. For example, a 1024 bit RSA CryptoSystem is estimated to have the same cryptographic strength as 160 bit EC CryptoSystem.

Specified by:

getBitLength in interface CryptoSystem

Following copied from interface: net.rim.device.api.crypto.CryptoSystem

Returns:

An integer that represents the number of bits.

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.

See Also:

CryptoSystem.isStrong()

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.

isStrong

public boolean isStrong()
                 throws CryptoTokenException,
                        CryptoUnsupportedOperationException

Returns whether or not the CryptoSystem is cryptographically strong as of the release date of the code.

Note: Due to the nature of cryptography, things that are presently strong may be insecure in the future.

Specified by:

isStrong in interface CryptoSystem

Returns:

true if the crypto system is strong as of the release date of this code.

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.

getModulusLength

public int getModulusLength()

Returns the number of bytes that comprise the public modulus for the system.

Returns:

An integer that specifies the number of bytes.

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

Following copied from class: java.lang.Object

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

createKeyPair

public KeyPair createKeyPair()
                      throws CryptoTokenException,
                             CryptoUnsupportedOperationException

Description copied from interface: CryptoSystem

Creates a new key pair using this crypto system.

Specified by:

createKeyPair in interface CryptoSystem

Following copied from interface: net.rim.device.api.crypto.CryptoSystem

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.

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.

createRSAKeyPair

public RSAKeyPair createRSAKeyPair()
                            throws CryptoTokenException,
                                   CryptoUnsupportedOperationException

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.

createRSAKeyPair

public RSAKeyPair createRSAKeyPair(byte[] e)
                            throws InvalidKeyException,
                                   CryptoTokenException,
                                   CryptoUnsupportedOperationException

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.