net.rim.device.api.crypto
Class RSAPublicKey

java.lang.Object
  extended by net.rim.device.api.crypto.RSAPublicKey
All Implemented Interfaces:
Key, PublicKey, RSAKey, Persistable

public final class RSAPublicKey
extends Object
implements PublicKey, RSAKey, Persistable

The RSAPublicKey class represents a public key in an RSA system.

A description of the RSA algorithm can be found in PKCS #1 version 2.1. We support this definition of RSA.

See Also:
RSACryptoSystem
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 RSAPublicKey(RSACryptoSystem cryptoSystem, byte[] e, byte[] n)
          Constructs an RSAPublicKey object.
Category: Signed RSAPublicKey(RSACryptoSystem cryptoSystem, CryptoTokenPublicKeyData cryptoTokenData)
          Constructs an RSAPublicKey object.
 
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 ("RSA").
Category: Signed  CryptoSystem getCryptoSystem()
          Returns the CryptoSystem used by this public key.
Category: Signed  CryptoTokenPublicKeyData getCryptoTokenData()
          Returns the crypto token public key data.
Category: Signed  byte[] getE()
          Returns a copy of the public key exponent.
Category: Signed  byte[] getN()
          Returns a copy of the public key modulus.
Category: Signed  RSACryptoSystem getRSACryptoSystem()
          Returns the RSA crypto system associated with the key.
Category: Signed  RSACryptoToken getRSACryptoToken()
          Returns the crypto token.
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

RSAPublicKey

public RSAPublicKey(RSACryptoSystem cryptoSystem,
                    byte[] e,
                    byte[] n)
             throws InvalidKeyException,
                    CryptoTokenException,
                    CryptoUnsupportedOperationException,
                    UnsupportedCryptoSystemException
Constructs an RSAPublicKey object.

Parameters:
cryptoSystem - An RSACryptoSystem that contains parameters for the RSA computations.
e - A byte array containing the public exponent.
n - A byte array containing the modulus.
Throws:
InvalidKeyException - Thrown if the key data is invalid.
CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.
UnsupportedCryptoSystemException - Thrown if the specified crypto system is 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

RSAPublicKey

public RSAPublicKey(RSACryptoSystem cryptoSystem,
                    CryptoTokenPublicKeyData cryptoTokenData)
Constructs an RSAPublicKey object.

Parameters:
cryptoSystem - An RSACryptoSystem that contains parameters for the RSA 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 4.1.0


Method Detail

getAlgorithm

public String getAlgorithm()
Returns the name of the algorithm associated with this key ("RSA").

This method will always return the String "RSA".

Specified by:
getAlgorithm in interface Key
Returns:
A String that represents 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

getRSACryptoSystem

public RSACryptoSystem getRSACryptoSystem()
Description copied from interface: RSAKey
Returns the RSA crypto system associated with the key.

Specified by:
getRSACryptoSystem in interface RSAKey
Returns:
The RSACryptoSystem.
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()
Description copied from interface: PublicKey
Returns the CryptoSystem used by this public 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
Checks the integrity of the associated CryptoSystem, and then performs integrity checks on the public key parameters. At present, there are no checks for public key parameters, but some may be added in the future.

Specified by:
verify in interface PublicKey
Throws:
InvalidKeyException - If the public key parameters are invalid
InvalidCryptoSystemException - If the crypto system parameters 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

getE

public byte[] getE()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException
Returns a copy of the public key exponent.

Returns:
A byte array containing e, the public key exponent.
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

getN

public byte[] getN()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException
Returns a copy of the public key modulus.

Returns:
A byte array containing the public key modulus.
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

getRSACryptoToken

public RSACryptoToken getRSACryptoToken()
Returns the crypto token.

Returns:
The RSACryptoToken that protects the 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

getCryptoTokenData

public CryptoTokenPublicKeyData getCryptoTokenData()
Returns the crypto token public key data.

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