net.rim.device.api.crypto
Class KEACryptoSystem

java.lang.Object
  extended by net.rim.device.api.crypto.KEACryptoSystem
All Implemented Interfaces:
CryptoSystem, Persistable

public final class KEACryptoSystem
extends Object
implements CryptoSystem, Persistable

Represents the system of asymmetric cryptography which is based on the Discrete Logarithm Problem.

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

Field Summary
Category: Signed static String FORTEZZA
          Represents the 1024 bit parameters defined in Fortezza.
Category: Signed static String SUN1024
          Represents the 1024 bit parameters defined in the SUN JCA.
 
Constructor Summary
Category: Signed KEACryptoSystem()
          Creates the KEACryptoSystem object with the Fortezza parameters.
Category: Signed KEACryptoSystem(byte[] p, byte[] q, byte[] g)
          Creates a KEACryptoSystem object with the specified p, q and g domain parameters.
Category: Signed KEACryptoSystem(byte[] p, byte[] q, byte[] g, String name)
          Creates a KEACryptosystem object with the specified p, q and g domain parameters.
Category: Signed KEACryptoSystem(String name)
          Creates the KEACryptoSystem object using the specified parameters.
Category: Signed KEACryptoSystem(KEACryptoToken cryptoToken, byte[] p, byte[] q, byte[] g, String name)
          Creates a KEACryptoSystem object with the specified p, q and g domain parameters.
Category: Signed KEACryptoSystem(KEACryptoToken cryptoToken, String name)
          Creates the KEACryptoSystem object using the specified parameters.
Category: Signed KEACryptoSystem(KEACryptoToken cryptoToken, CryptoTokenCryptoSystemData cryptoTokenData)
          Creates a KEACryptoSystem object with the specified crypto token and associated crypto token data.
 
Method Summary
Category: Signed  KEAKeyPair createKEAKeyPair()
           
Category: Signed  KeyPair createKeyPair()
          Creates a new key pair using this crypto system.
Category: Signed  boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
Category: Signed  String getAlgorithm()
          Returns a String that indicates the algorithm, ie "KEA".
Category: Signed  AsymmetricCryptoToken getAsymmetricCryptoToken()
          Returns the KEACryptoToken object used top create the crypto system.
Category: Signed  int getBitLength()
          Returns the number of bits (aka the "strength") of the crypto system, eg 1024 (for RSA), 163 (for EC).
Category: Signed  CryptoTokenCryptoSystemData getCryptoTokenData()
          Returns the crypto token data.
Category: Signed  byte[] getG()
          Returns the g domain parameter.
Category: Signed  String getName()
          Returns a String that indicates the set of parameters in use, eg "SUN1024", or null.
Category: Signed  byte[] getP()
          Returns the p domain parameter.
Category: Signed  int getPrivateKeyLength()
          Returns the length of the private key.
Category: Signed  int getPublicKeyLength()
          Returns the length of the public key.
Category: Signed  byte[] getQ()
          Returns the q domain parameter, or null.
Category: Signed  int hashCode()
          Returns a hash code value for the object.
Category: Signed  boolean isStrong()
          Returns whether or not the CryptoSystem is cryptographically strong as of the release date of the code.
Category: Signed  void verify()
          Performs integrity checks on the crypto system parameters.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

SUN1024

public static final String SUN1024
Represents the 1024 bit parameters defined in the SUN JCA.

See Also:
Constant Field Values
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

FORTEZZA

public static final String FORTEZZA
Represents the 1024 bit parameters defined in Fortezza.

See Also:
Constant Field Values
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 Detail

KEACryptoSystem

public KEACryptoSystem()
Creates the KEACryptoSystem object with the Fortezza parameters.

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

KEACryptoSystem

public KEACryptoSystem(String name)
Creates the KEACryptoSystem object using the specified parameters.

Parameters:
name - Specifies the parameters to use.
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

KEACryptoSystem

public KEACryptoSystem(KEACryptoToken cryptoToken,
                       String name)
                throws CryptoTokenException,
                       CryptoUnsupportedOperationException,
                       UnsupportedCryptoSystemException
Creates the KEACryptoSystem object using the specified parameters.

Parameters:
cryptoToken - The crypto token associated with the crypto system.
name - Specifies the parameters to use.
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.
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

KEACryptoSystem

public KEACryptoSystem(byte[] p,
                       byte[] q,
                       byte[] g)
                throws InvalidCryptoSystemException
Creates a KEACryptoSystem object with the specified p, q and g domain parameters.

Parameters:
p - The p domain parameter.
q - The q domain parameter.
g - The g domain parameter.

Throws:
InvalidCryptoSystemException - Thrown if any or all if the given 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

KEACryptoSystem

public KEACryptoSystem(byte[] p,
                       byte[] q,
                       byte[] g,
                       String name)
                throws InvalidCryptoSystemException
Creates a KEACryptosystem object with the specified p, q and g domain parameters.

Parameters:
p - The p domain parameter.
q - The q domain parameter.
g - The g domain parameter.
name - A String that represents a desciption of the parameters, eg "SUN1024".
Throws:
InvalidCryptoSystemException - Thrown if any or all of the given 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

KEACryptoSystem

public KEACryptoSystem(KEACryptoToken cryptoToken,
                       byte[] p,
                       byte[] q,
                       byte[] g,
                       String name)
                throws CryptoTokenException,
                       CryptoUnsupportedOperationException,
                       InvalidCryptoSystemException,
                       UnsupportedCryptoSystemException
Creates a KEACryptoSystem object with the specified p, q and g domain parameters.

Parameters:
cryptoToken - The token associated with the crypto system.
p - The p domain parameter.
q - The q domain parameter.
g - The g domain parameter.
name - A String that represents a desciption of the parameters, eg "SUN1024".
Throws:
CryptoTokenException - Thrown if an error occurs with the crypto token.
CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.
InvalidCryptoSystemException - Thrown if any or all of the given parameters are invalid.
UnsupportedCryptoSystemException - Thrown if the specified crypto system is unsupported 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

KEACryptoSystem

public KEACryptoSystem(KEACryptoToken cryptoToken,
                       CryptoTokenCryptoSystemData cryptoTokenData)
Creates a KEACryptoSystem object with the specified crypto token and associated crypto token data.

Parameters:
cryptoToken - The crypto token used to create the crypto system.
cryptoTokenData - The associated crypto token data.
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

verify

public void verify()
            throws InvalidCryptoSystemException,
                   CryptoTokenException,
                   CryptoUnsupportedOperationException
Performs integrity checks on the crypto system parameters. Specifically, the following are verified: Then, the verifyCryptoSystemData method of the associated crypto token is called.

Specified by:
verify in interface CryptoSystem
Throws:
InvalidCryptoSystemException - Thrown if the crypto system parameters are invalid.
CryptoTokenException - Thrown if an error occurs with the crypto token.
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

getAlgorithm

public String getAlgorithm()
Returns a String that indicates the algorithm, ie "KEA".

This method will always return the String "KEA".

Specified by:
getAlgorithm in interface CryptoSystem
Returns:
A String representing 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

getAsymmetricCryptoToken

public AsymmetricCryptoToken getAsymmetricCryptoToken()
Returns the KEACryptoToken object used top create the crypto system.

Specified by:
getAsymmetricCryptoToken in interface CryptoSystem
Returns:
The KEACryptoToken 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 CryptoTokenCryptoSystemData getCryptoTokenData()
Returns the crypto token data.

Returns:
The CryptoTokenCryptoSystemData 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

getBitLength

public int getBitLength()
                 throws CryptoTokenException,
                        CryptoUnsupportedOperationException
Description copied from interface: CryptoSystem
Returns the number of bits (aka the "strength") of the crypto system, eg 1024 (for RSA), 163 (for EC).

Note: the strength of a CryptoSystem is a combination of the algorithm and the bit length. For example, a 1024 bit RSA CryptoSystem is estimated to have the same cryptographic strength as 160 bit EC CryptoSystem.

Specified by:
getBitLength in interface CryptoSystem
Returns:
An integer that represents the number of bits.
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.
See Also:
CryptoSystem.isStrong()
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

isStrong

public boolean isStrong()
                 throws CryptoTokenException,
                        CryptoUnsupportedOperationException
Returns whether or not the CryptoSystem is cryptographically strong as of the release date of the code.

Note: Due to the nature of cryptography, things that are presently strong may be insecure in the future.

Specified by:
isStrong in interface CryptoSystem
Returns:
true if the crypto system is strong as of the release date of this code.
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

getName

public String getName()
               throws CryptoTokenException,
                      CryptoUnsupportedOperationException
Returns a String that indicates the set of parameters in use, eg "SUN1024", or null.

Specified by:
getName in interface CryptoSystem
Returns:
A String representing the name os all parameters in use.
Throws:
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.
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

getP

public byte[] getP()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException
Returns the p domain parameter.

Returns:
A byte array containing the domain parameter p.
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

getQ

public byte[] getQ()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException
Returns the q domain parameter, or null.

Returns:
A byte array containing the domain parameter q.
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

getG

public byte[] getG()
            throws CryptoTokenException,
                   CryptoUnsupportedOperationException
Returns the g domain parameter.

Returns:
A byte array containing the domain parameter g.
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

getPublicKeyLength

public int getPublicKeyLength()
                       throws CryptoTokenException,
                              CryptoUnsupportedOperationException
Returns the length of the public key.

Returns:
An integer representing the length of the public key in bytes.
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

getPrivateKeyLength

public int getPrivateKeyLength()
                        throws CryptoTokenException,
                               CryptoUnsupportedOperationException
Returns the length of the private key.

Returns:
An integer representing the length of the private key in bytes.
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

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

createKeyPair

public KeyPair createKeyPair()
                      throws CryptoTokenException,
                             CryptoUnsupportedOperationException
Description copied from interface: CryptoSystem
Creates a new key pair using this crypto system.

Specified by:
createKeyPair in interface CryptoSystem
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

createKEAKeyPair

public KEAKeyPair createKEAKeyPair()
                            throws CryptoTokenException,
                                   CryptoUnsupportedOperationException
Throws:
CryptoTokenException
CryptoUnsupportedOperationException
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.