SHOW Signed

net.rim.device.api.crypto
Class RSAPublicKey

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

All Implemented Interfaces:

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

public final class RSAPublicKey

extends Object

implements PublicKey, RSAKey, Persistable

The RSAPublicKey class represents a public 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.

See Also:

RSACryptoSystem

Constructor Summary

RSAPublicKey(RSACryptoSystem cryptoSystem, byte[] e, byte[] n) Constructs an RSAPublicKey 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 public key.
	byte[]	getE() Returns a copy of the public key exponent.
	byte[]	getN() Returns a copy of the public key modulus.
	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 public key parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

RSAPublicKey

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

Constructs an RSAPublicKey object.

Parameters:

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

e - A byte array containing the public exponent.

n - A byte array containing the modulus.

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.

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.

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

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

Returns:

The RSACryptoSystem.

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: PublicKey

Returns the CryptoSystem used by this public key.

Specified by:

getCryptoSystem in interface PublicKey

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

Returns:

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.

verify

public void verify()
            throws InvalidKeyException,
                   InvalidCryptoSystemException

Checks the integrity of the associated CryptoSystem, and then performs integrity checks on the public key parameters. At present, there are no checks for public key parameters, but some may be added in the future.

Specified by:

verify in interface PublicKey

Throws:

InvalidKeyException - If the public key parameters are invalid

InvalidCryptoSystemException - If the crypto system parameters are 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.

getE

public byte[] getE()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException

Returns a copy of the public key exponent.

Returns:

A byte array containing e, the public 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.

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.

Returns:

A byte array containing 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.

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.