net.rim.device.api.crypto
Class DHPublicKey

java.lang.Object
  net.rim.device.api.crypto.DHPublicKey

All Implemented Interfaces:

DHKey, Key, PublicKey, Persistable

public final class DHPublicKey
extends Object
implements PublicKey, DHKey, Persistable

Represents a public key in an Diffie-Hellman (DH) system.

Diffie-Hellman ( DH ) is defined in PKCS #3 and various other spots.

The DHPrivateKey and DHPublicKey classes make up a Diffie-Helman key pair.

See Also:

DHCryptoSystem, DHPrivateKey

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
	DHPublicKey(DHCryptoSystem cryptoSystem, byte[] data) Constructs a DHPublicKey object under the given crypto system using the given data as the public key's mathematical representation.
	DHPublicKey(DHCryptoSystem cryptoSystem, CryptoTokenPublicKeyData cryptoTokenData) Constructs a DHPrivateKey object under the given crypto system associated with the given crypto token.

Method Summary
	boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
	String	getAlgorithm() Returns a string containing the name of the algorithm associated with this key ("DH").
	CryptoSystem	getCryptoSystem() Returns the crypto system associated with the key.
	CryptoTokenPublicKeyData	getCryptoTokenData() Returns the DH crypto token public key data.
	DHCryptoSystem	getDHCryptoSystem() Returns the DH crypto system associated with the key.
	DHCryptoToken	getDHCryptoToken() Returns the DH crypto token.
	byte[]	getPublicKeyData() Returns a copy of the public key data.
	int	hashCode() Returns a hash code value for the object.
	void	verify() Checks the integrity of the associated CryptoSystem, and then performs integrity checks on the public key parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

DHPublicKey

public DHPublicKey(DHCryptoSystem cryptoSystem,
                   byte[] data)
            throws InvalidKeyException,
                   CryptoTokenException,
                   CryptoUnsupportedOperationException

Constructs a DHPublicKey object under the given crypto system using the given data as the public key's mathematical representation.

Parameters:

cryptoSystem - A DHCryptoSystem that contains parameters for DH computations.

data - A byte array containing the keying material that is to be used for the public key operations.

Throws:

InvalidKeyException - Thrown if the key data is invalid.

CryptoTokenException - Thrown when a problem occurs with a 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

DHPublicKey

public DHPublicKey(DHCryptoSystem cryptoSystem,
                   CryptoTokenPublicKeyData cryptoTokenData)

Constructs a DHPrivateKey object under the given crypto system associated with the given crypto token.

Parameters:

cryptoSystem - A DHCryptoSystem that contains parameters for the DH computations.

cryptoTokenData - The data associated and contained within 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 a string containing the name of the algorithm associated with this key ("DH").

This method will always return the String "DH".

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

getDHCryptoSystem

public DHCryptoSystem getDHCryptoSystem()

Returns the DH crypto system associated with the key.

Specified by:

getDHCryptoSystem in interface DHKey

Returns:

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

getCryptoSystem

public CryptoSystem getCryptoSystem()

Returns the crypto system associated with the key.

Specified by:

getCryptoSystem in interface PublicKey

Returns:

The 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

verify

public void verify()
            throws InvalidKeyException,
                   InvalidCryptoSystemException,
                   CryptoTokenException,
                   CryptoUnsupportedOperationException

Checks the integrity of the associated CryptoSystem, and then performs integrity checks on the public key parameters. The CryptoSystem is checked via its verify() method, and then the following are verified:

• y > 0
• 1 < y < p

Specified by:

verify in interface PublicKey

Throws:

InvalidKeyException - Thrown if the public key parameters are invalid.

InvalidCryptoSystemException - Thrown if the crypto system parameters are 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

getPublicKeyData

public byte[] getPublicKeyData()
                        throws CryptoTokenException,
                               CryptoUnsupportedOperationException

Returns a copy of the public key data.

Returns:

A byte array containing the public key data.

Throws:

CryptoTokenException - Thrown when a problem occurs with a 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

getDHCryptoToken

public DHCryptoToken getDHCryptoToken()

Returns the DH crypto token.

Returns:

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

getCryptoTokenData

public CryptoTokenPublicKeyData getCryptoTokenData()

Returns the DH crypto token public key data.

The public key data associated with the crypto token.

Returns:

The public key 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

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

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