net.rim.device.api.crypto
Class KEAKeyPair

java.lang.Object
  net.rim.device.api.crypto.KeyPair
      net.rim.device.api.crypto.KEAKeyPair

All Implemented Interfaces:

Persistable

public final class KEAKeyPair
extends KeyPair
implements Persistable

The KEAKeyPair object holds a Key Exchange Algorithm (KEA) public and private key.

A description of the KEA algorithm can be found at KEA.

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
	KEAKeyPair(KEACryptoSystem cryptoSystem) Creates a new KEAKeyPair object with the given crypto system.
	KEAKeyPair(KEAPublicKey publicKey, KEAPrivateKey privateKey) Creates a new KEAKeyPair object with the given public and private keys.

Method Summary
	boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
	KEACryptoSystem	getKEACryptoSystem() Returns the KEA crypto system associated with the keys.
	KEAPrivateKey	getKEAPrivateKey() Returns the KEA private key associated with this key pair.
	KEAPublicKey	getKEAPublicKey() Returns the KEAPublicKey object associated with this key pair.
	int	hashCode() Returns a hash code value for the object.
	void	verify() Checks the integrity of the associated PublicKey and PrivateKey, and then performs an integrity check on the private and public key 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

KEAKeyPair

public KEAKeyPair(KEACryptoSystem cryptoSystem)
           throws CryptoTokenException,
                  CryptoUnsupportedOperationException

Creates a new KEAKeyPair object with the given crypto system.

Parameters:

cryptoSystem - The crypto system associated with the key pair.

Throws:

CryptoTokenException - Thrown when an error occurs with the crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown when 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

KEAKeyPair

public KEAKeyPair(KEAPublicKey publicKey,
                  KEAPrivateKey privateKey)
           throws InvalidKeyPairException

Creates a new KEAKeyPair object with the given public and private keys.

Parameters:

publicKey - The KEA public key to use.

privateKey - The KEA private key to use.

Throws:

InvalidKeyPairException - Thrown if one or both of the keys are of an improper format.

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

getKEAPublicKey

public KEAPublicKey getKEAPublicKey()

Returns the KEAPublicKey object associated with this key pair.

Returns:

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

getKEAPrivateKey

public KEAPrivateKey getKEAPrivateKey()

Returns the KEA private key associated with this key pair.

Returns:

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

getKEACryptoSystem

public KEACryptoSystem getKEACryptoSystem()

Returns the KEA crypto system associated with the keys.

Returns:

The KEACryptoSystem 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,
                   InvalidCryptoSystemException,
                   InvalidKeyPairException,
                   CryptoTokenException,
                   CryptoUnsupportedOperationException

Checks the integrity of the associated PublicKey and PrivateKey, and then performs an integrity check on the private and public key parameters. The PublicKey and PrivateKey are checked via their verify() methods, and then the following is verified:

• g^x mod p = y

Specified by:

verify in class KeyPair

Throws:

InvalidKeyException - If the public or private key parameters are invalid

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

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

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