net.rim.device.api.crypto
Class ECKeyPair

java.lang.Object
  extended by net.rim.device.api.crypto.KeyPair
      extended by net.rim.device.api.crypto.ECKeyPair
All Implemented Interfaces:
Persistable

public final class ECKeyPair
extends KeyPair
implements Persistable

Holds an Elliptic Curve public and private key.

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

See Also:
ECPublicKey, ECPrivateKey
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
Category: Signed ECKeyPair(ECCryptoSystem cryptoSystem)
          Creates a new ECKeyPair object with the given crypto system.
Category: Signed ECKeyPair(ECPublicKey publicKey, ECPrivateKey privateKey)
          Creates a new ECKeyPair object using the specified public and private keys.
 
Method Summary
Category: Signed  boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
Category: Signed  ECCryptoSystem getECCryptoSystem()
          Returns the EC crypto system associated with the keys.
Category: Signed  ECPrivateKey getECPrivateKey()
          Returns the EC private key associated with this key pair.
Category: Signed  ECPublicKey getECPublicKey()
          Returns the EC public key associated with this key pair.
Category: Signed  int hashCode()
          Returns a hash code value for the object.
Category: Signed  void verify()
          Performs certain integrity checks on the key pair 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

ECKeyPair

public ECKeyPair(ECCryptoSystem cryptoSystem)
          throws CryptoTokenException,
                 CryptoUnsupportedOperationException
Creates a new ECKeyPair object with the given crypto system.

Parameters:
cryptoSystem - The crypto system associated with the key pair.
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 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

ECKeyPair

public ECKeyPair(ECPublicKey publicKey,
                 ECPrivateKey privateKey)
          throws InvalidKeyPairException
Creates a new ECKeyPair object using the specified public and private keys.

Parameters:
publicKey - The EC public key to use.
privateKey - The EC private key to use.
Throws:
InvalidKeyPairException - Thrown if one or both of the specified keys are 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

getECPublicKey

public ECPublicKey getECPublicKey()
Returns the EC public key associated with this key pair.

Returns:
The EC public key.
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

getECPrivateKey

public ECPrivateKey getECPrivateKey()
Returns the EC private key associated with this key pair.

Returns:
The EC private key.
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

getECCryptoSystem

public ECCryptoSystem getECCryptoSystem()
Returns the EC crypto system associated with the keys.

Returns:
The EC crypto system associated with the key pair.
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,
                   CryptoUnsupportedOperationException
Description copied from class: KeyPair
Performs certain integrity checks on the key pair 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 class KeyPair
Throws:
InvalidKeyException - Thrown when one or both of the keys are of an invalid format.
InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.
InvalidKeyPairException - Thrown when the keys are not related.
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 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:

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

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





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.