net.rim.device.api.crypto
Class DHPublicKey

java.lang.Object
  extended by 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
Category: Signed 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.
Category: Signed DHPublicKey(DHCryptoSystem cryptoSystem, CryptoTokenPublicKeyData cryptoTokenData)
          Constructs a DHPrivateKey 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 a string containing the name of the algorithm associated with this key ("DH").
Category: Signed  CryptoSystem getCryptoSystem()
          Returns the crypto system associated with the key.
Category: Signed  CryptoTokenPublicKeyData getCryptoTokenData()
          Returns the DH crypto token public key data.
Category: Signed  DHCryptoSystem getDHCryptoSystem()
          Returns the DH crypto system associated with the key.
Category: Signed  DHCryptoToken getDHCryptoToken()
          Returns the DH crypto token.
Category: Signed  byte[] getPublicKeyData()
          Returns a copy of the public key data.
Category: Signed  int hashCode()
          Returns a hash code value for the object.
Category: Signed  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:

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:

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