KEACryptoSystem (BlackBerry JDE 7.1.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.device.api.crypto
Class KEACryptoSystem

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

All Implemented Interfaces:: CryptoSystem, Persistable

public final class KEACryptoSystem
extends Object
implements CryptoSystem, Persistable
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
	`static String`	`FORTEZZA` Represents the 1024 bit parameters defined in Fortezza.
	`static String`	`SUN1024` Represents the 1024 bit parameters defined in the SUN JCA.

Constructor Summary
	`KEACryptoSystem()` Creates the `KEACryptoSystem` object with the Fortezza parameters.
	`KEACryptoSystem(byte[] p, byte[] q, byte[] g)` Creates a `KEACryptoSystem` object with the specified p, q and g domain parameters.
	`KEACryptoSystem(byte[] p, byte[] q, byte[] g, String name)` Creates a `KEACryptosystem` object with the specified p, q and g domain parameters.
	`KEACryptoSystem(String name)` Creates the `KEACryptoSystem` object using the specified parameters.
	`KEACryptoSystem(KEACryptoToken cryptoToken, byte[] p, byte[] q, byte[] g, String name)` Creates a `KEACryptoSystem` object with the specified p, q and g domain parameters.
	`KEACryptoSystem(KEACryptoToken cryptoToken, String name)` Creates the `KEACryptoSystem` object using the specified parameters.
	`KEACryptoSystem(KEACryptoToken cryptoToken, CryptoTokenCryptoSystemData cryptoTokenData)` Creates a `KEACryptoSystem` object with the specified crypto token and associated crypto token data.

Method Summary
	`KEAKeyPair`	`createKEAKeyPair()`
	`KeyPair`	`createKeyPair()` Creates a new key pair using this crypto system.
	`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
	`String`	`getAlgorithm()` Returns a String that indicates the algorithm, ie "KEA".
	`AsymmetricCryptoToken`	`getAsymmetricCryptoToken()` Returns the `KEACryptoToken` object used top create the crypto system.
	`int`	`getBitLength()` Returns the number of bits (aka the "strength") of the crypto system, eg 1024 (for RSA), 163 (for EC).
	`CryptoTokenCryptoSystemData`	`getCryptoTokenData()` Returns the crypto token data.
	`byte[]`	`getG()` Returns the g domain parameter.
	`String`	`getName()` Returns a String that indicates the set of parameters in use, eg "SUN1024", or null.
	`byte[]`	`getP()` Returns the p domain parameter.
	`int`	`getPrivateKeyLength()` Returns the length of the private key.
	`int`	`getPublicKeyLength()` Returns the length of the public key.
	`byte[]`	`getQ()` Returns the q domain parameter, or null.
	`int`	`hashCode()` Returns a hash code value for the object.
	`boolean`	`isStrong()` Returns whether or not the CryptoSystem is cryptographically strong as of the release date of the code.
	`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:

p, q, g > 0
p is odd, q is odd
2¹⁵⁹ < q < 2¹⁶⁰
1 < g < p
q | (p-1)
g^q mod p = 1

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:

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

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

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

net.rim.device.api.crypto Class KEACryptoSystem

SUN1024

FORTEZZA

KEACryptoSystem

KEACryptoSystem

KEACryptoSystem

KEACryptoSystem

KEACryptoSystem

KEACryptoSystem

KEACryptoSystem

verify

getAlgorithm

getAsymmetricCryptoToken

getCryptoTokenData

getBitLength

isStrong

getName

getP

getQ

getG

getPublicKeyLength

getPrivateKeyLength

hashCode

equals

createKeyPair

createKEAKeyPair

net.rim.device.api.crypto
Class KEACryptoSystem