SHOW Signed

net.rim.device.api.crypto
Class ECCryptoSystem

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

All Implemented Interfaces:

CryptoSystem, net.rim.vm.Persistable, Persistable

public final class ECCryptoSystem

extends Object

implements CryptoSystem, Persistable

Represents the system of asymmetric cryptography based on the Elliptic Curve Discrete Logarithm Problem. The domain parameter for this system is an elliptic curve.

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.

Since:

JDE 3.6.0

See Also:

ECPublicKey, ECPrivateKey

Field Summary

	static String	EC160R1 Represents an Elliptic curve defined over a field with size 160 bits.
	static String	EC163K1 Represents a Koblitz curve defined over a field with size 163 bits.
	static String	EC163K2 Represents a Koblitz curve defined over a field with size 163 bits.
	static String	EC163R2 Represents an Elliptic curve defined over a field with size 163 bits.
	static String	EC192R1 Represents an Elliptic curve defined over a field with size 192 bits.
	static String	EC224R1 Represents an Elliptic curve defined over a field with size 224 bits.
	static String	EC233K1 Represents a Koblitz curve defined over a field with size 233 bits.
	static String	EC233R1 Represents an Elliptic curve defined over a field with size 233 bits.
	static String	EC239K1 Represents a Koblitz curve defined over a field with size 239 bits.
	static String	EC256R1 Represents an Elliptic curve defined over a field with size 256 bits.
	static String	EC283K1 Represents a Koblitz curve defined over a field with size 283 bits.
	static String	EC283R1 Represents an Elliptic curve defined over a field with size 283 bits.
	static String	EC384R1 Represents an Elliptic curve defined over a field with size 384 bits.
	static String	EC409K1 Represents a Koblitz curve defined over a field with size 409 bits.
	static String	EC409R1 Represents an Elliptic curve defined over a field with size 409 bits.
	static String	EC521R1 Represents an Elliptic curve defined over a field with size 521 bits.
	static String	EC571K1 Represents a Koblitz curve defined over a field with size 571 bits.
	static String	EC571R1 Represents an Elliptic curve defined over a field with size 571 bits.
	static String	WTLS3 A String representing the name of the curve.
	static String	WTLS5 A String representing the name of the curve.
	static String	WTLS7 A String representing the name of the curve.

Constructor Summary

	ECCryptoSystem() Constructs an elliptic curve system using EC163K1.
	ECCryptoSystem(String name) Constructs an elliptic curve system using the specified curve.

Method Summary

	ECKeyPair	createECKeyPair()
	KeyPair	createKeyPair() Creates a new key pair using this crypto system.
	boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
	String	getAlgorithm() Returns a String that indicates the algorithm, ie "EC".
	int	getBitLength() Returns the length (in bits) of the field for this system's curve.
	int	getFieldLength() Returns the length (in bytes) of the field for this system's curve.
	String	getName() Returns a String that indicates the name of the elliptic curve, eg "EC163K1".
	int	getPrivateKeyLength() Returns the length (in bytes) of a private key for this system's curve.
	int	getPublicKeyLength() Returns the length (in bytes) of a compressed public key for this system's curve.
	int	getPublicKeyLength(boolean compressed) Returns the length (in bytes) of a public key for this system's curve.
	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

Field Detail

EC163K1

public static final String EC163K1

Represents a Koblitz curve defined over a field with size 163 bits.

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.

EC163K2

public static final String EC163K2

Represents a Koblitz curve defined over a field with size 163 bits.

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.

EC163R2

public static final String EC163R2

Represents an Elliptic curve defined over a field with size 163 bits.

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.

EC233K1

public static final String EC233K1

Represents a Koblitz curve defined over a field with size 233 bits.

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.

EC233R1

public static final String EC233R1

Represents an Elliptic curve defined over a field with size 233 bits.

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.

EC239K1

public static final String EC239K1

Represents a Koblitz curve defined over a field with size 239 bits.

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.

EC283K1

public static final String EC283K1

Represents a Koblitz curve defined over a field with size 283 bits.

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.

EC283R1

public static final String EC283R1

Represents an Elliptic curve defined over a field with size 283 bits.

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.

EC409K1

public static final String EC409K1

Represents a Koblitz curve defined over a field with size 409 bits.

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.

EC409R1

public static final String EC409R1

Represents an Elliptic curve defined over a field with size 409 bits.

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.

EC571K1

public static final String EC571K1

Represents a Koblitz curve defined over a field with size 571 bits.

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.

EC571R1

public static final String EC571R1

Represents an Elliptic curve defined over a field with size 571 bits.

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.

EC160R1

public static final String EC160R1

Represents an Elliptic curve defined over a field with size 160 bits.

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.

EC192R1

public static final String EC192R1

Represents an Elliptic curve defined over a field with size 192 bits.

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.

EC224R1

public static final String EC224R1

Represents an Elliptic curve defined over a field with size 224 bits.

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.

EC256R1

public static final String EC256R1

Represents an Elliptic curve defined over a field with size 256 bits.

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.

EC384R1

public static final String EC384R1

Represents an Elliptic curve defined over a field with size 384 bits.

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.

EC521R1

public static final String EC521R1

Represents an Elliptic curve defined over a field with size 521 bits.

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.

WTLS3

public static final String WTLS3

A String representing the name of the curve. This is functionally equivalent to EC163K1.

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.

WTLS5

public static final String WTLS5

A String representing the name of the curve. This is functionally equivalent to EC163K2.

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.

WTLS7

public static final String WTLS7

A String representing the name of the curve. This is functionally equivalent to EC160R1.

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.

Constructor Detail

ECCryptoSystem

public ECCryptoSystem()

Constructs an elliptic curve system using EC163K1.

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.

ECCryptoSystem

public ECCryptoSystem(String name)

Constructs an elliptic curve system using the specified curve.

Parameters:

name - A String representing the name of the desired curve.

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

verify

public void verify()
            throws InvalidCryptoSystemException,
                   CryptoTokenException,
                   CryptoUnsupportedOperationException

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

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.

getAlgorithm

public String getAlgorithm()

Returns a String that indicates the algorithm, ie "EC".

Specified by:

getAlgorithm in interface CryptoSystem

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.

getName

public String getName()
               throws CryptoTokenException,
                      CryptoUnsupportedOperationException

Returns a String that indicates the name of the elliptic curve, eg "EC163K1".

Specified by:

getName in interface CryptoSystem

Returns:

A String that represents the name.

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.

getBitLength

public int getBitLength()
                 throws CryptoTokenException,
                        CryptoUnsupportedOperationException

Returns the length (in bits) of the field for this system's curve. Notice that the "field" refers to the finite field that the elliptic curve is defined over and the length refers to either the size of the prime or the degree of the irreducible polynomial that helps define the field.

Specified by:

getBitLength in interface CryptoSystem

Returns:

An integer that represents the length in bits.

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.

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.

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.

getFieldLength

public int getFieldLength()
                   throws CryptoTokenException,
                          CryptoUnsupportedOperationException

Returns the length (in bytes) of the field for this system's curve. Notice that the "field" refers to the finite field that the elliptic curve is defined over and the length refers to either the size of the prime or the degree of the irreducible polynomial that helps define the field.

Returns:

An integer that represents the field length.

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.

getPublicKeyLength

public int getPublicKeyLength()
                       throws CryptoTokenException,
                              CryptoUnsupportedOperationException

Returns the length (in bytes) of a compressed public key for this system's curve. Note that the public key is encoded as an ANSI X9.62 ECPoint object and the compression follows the ANSI X9.62 compression format.

Returns:

An integer that represents the public key length, in bytes.

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.

getPublicKeyLength

public int getPublicKeyLength(boolean compressed)
                       throws CryptoTokenException,
                              CryptoUnsupportedOperationException

Returns the length (in bytes) of a public key for this system's curve. Note that the public key is encoded as an ANSI X9.62 ECPoint object.

Parameters:

compressed - Specifies whether to determine the length of a compressed ( using the ANSI X9.62 format ) or uncompressed Public Key. If this is true, then use compression, otherwise don't.

Returns:

An integer that represents the public key length, in bytes.

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

getPrivateKeyLength

public int getPrivateKeyLength()
                        throws CryptoTokenException,
                               CryptoUnsupportedOperationException

Returns the length (in bytes) of a private key for this system's curve. Note that the private key is an element of the finite field that the elliptic curve is defined over.

Returns:

An integer that represents the private key length, in bytes.

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.

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

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.

createECKeyPair

public ECKeyPair createECKeyPair()
                          throws CryptoTokenException,
                                 CryptoUnsupportedOperationException

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.