net.rim.device.api.crypto
Class ECPrivateKey

java.lang.Object
  extended by net.rim.device.api.crypto.ECPrivateKey
All Implemented Interfaces:
ECKey, Key, PrivateKey, Persistable

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.

See Also:
ECCryptoSystem, ECPublicKey
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 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.
Category: Signed ECPrivateKey(ECCryptoSystem cryptoSystem, CryptoTokenPrivateKeyData cryptoTokenData)
          Constructs an ECPrivateKey object under the given crypto system associated with the given crypto token.
 
Method Summary
Category: Signed  boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
Category: Signed  String getAlgorithm()
          Returns the name of the algorithm associated with this key ("EC").
Category: Signed  CryptoSystem getCryptoSystem()
          Returns the crypto system associated with the key.
Category: Signed  CryptoTokenPrivateKeyData getCryptoTokenData()
          Returns the data associated with the crypto token.
Category: Signed  ECCryptoSystem getECCryptoSystem()
          Returns a reference to EC the crypto system being used with this instance of the private key class.
Category: Signed  ECCryptoToken getECCryptoToken()
          Returns the EC crypto token associated with the key.
Category: Signed  byte[] getPrivateKeyData()
          Returns a copy of the private key data.
Category: Signed  byte[] getPublicKeyData()
          Returns a copy of the public key data which is encoded as an ANSI X9.62 ECPoint object.
Category: Signed  int hashCode()
          Returns a hash code value for the object.
Category: Signed  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 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

ECPrivateKey

public ECPrivateKey(ECCryptoSystem cryptoSystem,
                    CryptoTokenPrivateKeyData cryptoTokenData)
Constructs an ECPrivateKey object under the given crypto system associated with the given crypto token.

Parameters:
cryptoSystem - A ECCryptoSystem object that contains parameters for the EC computations.
cryptoTokenData - The data associated with the crypto token.
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

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
Returns:
A String representing the name of the algorithm.
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 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 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

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 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
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
Throws:
InvalidKeyException - Thrown if the specified key is improperly formatted or 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

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

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

getECCryptoToken

public ECCryptoToken getECCryptoToken()
Returns the EC crypto token associated with the key.

Returns:
The ECCryptoToken object.
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

getCryptoTokenData

public CryptoTokenPrivateKeyData getCryptoTokenData()
Returns the data associated with the crypto token.

Returns:
The CryptoTokenPrivateKeyData object.
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 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 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 Object
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-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal