SHOW Signed

net.rim.device.api.crypto
Class ECPrivateKey

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

All Implemented Interfaces:

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

public final class ECPrivateKey

extends Object

implements PrivateKey, ECKey, Persistable

Represents a private key in an Elliptic Curve (EC) system.

Elliptic Curve cryptography is defined in various standards including P1363 and ANSI X9.62.

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:

ECCryptoSystem, ECPublicKey

Constructor Summary

ECPrivateKey(ECCryptoSystem cryptoSystem, byte[] data) Constructs an ECPrivateKey object, representing an Elliptic Curve private key, under the given crypto system using the specifed data as the private key's mathematical representation.

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 ("EC").
	CryptoSystem	getCryptoSystem() Returns the crypto system associated with the key.
	ECCryptoSystem	getECCryptoSystem() Returns a reference to EC the crypto system being used with this instance of the private key class.
	byte[]	getPrivateKeyData() Returns a copy of the private key data.
	byte[]	getPublicKeyData() Returns a copy of the public key data which is encoded as an ANSI X9.62 ECPoint object.
	int	hashCode() Returns a hash code value for the object.
	void	verify() Performs certain integrity checks on the private key parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ECPrivateKey

public ECPrivateKey(ECCryptoSystem cryptoSystem,
                    byte[] data)
             throws InvalidKeyException,
                    CryptoTokenException,
                    CryptoUnsupportedOperationException

Constructs an ECPrivateKey object, representing an Elliptic Curve private key, under the given crypto system using the specifed data as the private key's mathematical representation.

Parameters:

cryptoSystem - A ECCryptoSystem object that contains parameters for the ECC computations.

data - The keying material that is to be used for all private key operations. Note that this is an element of the finite field that the elliptic curve is defined over.

Throws:

InvalidKeyException - Thrown if the key data 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.

Method Detail

getAlgorithm

public String getAlgorithm()

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

This method will always return the String "EC".

Specified by:

getAlgorithm in interface Key

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

Returns:

A String representing 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.

getECCryptoSystem

public ECCryptoSystem getECCryptoSystem()

Returns a reference to EC the crypto system being used with this instance of the private key class.

Specified by:

getECCryptoSystem in interface ECKey

Returns:

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

getCryptoSystem

public CryptoSystem getCryptoSystem()

Returns the crypto system associated with the key.

Specified by:

getCryptoSystem in interface PrivateKey

Returns:

The CyptoSystem object.

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

Description copied from interface: PrivateKey

Performs certain integrity checks on the private key 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 real private key parameters.

Specified by:

verify in interface PrivateKey

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

Throws:

InvalidKeyException - Thrown if the specified key is improperly formatted or invalid.

InvalidCryptoSystemException - Thrown if the specified crypto system 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.

getPrivateKeyData

public byte[] getPrivateKeyData()
                         throws CryptoTokenException,
                                CryptoUnsupportedOperationException

Returns a copy of the private key data.

Returns:

A byte array containing the private key. Note that this is an element of the finite field that the elliptic curve is defined over.

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.

getPublicKeyData

public byte[] getPublicKeyData()
                        throws CryptoTokenException,
                               CryptoUnsupportedOperationException

Returns a copy of the public key data which is encoded as an ANSI X9.62 ECPoint object.

Returns:

A byte array containing the public key.

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.