net.rim.device.api.crypto
Class KEACryptoToken

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

All Implemented Interfaces:

AsymmetricCryptoToken, CryptoToken, Persistable

public abstract class KEACryptoToken
extends Object
implements AsymmetricCryptoToken, Persistable

An interface for KEA cryptographic tokens to implement.

Note: This class must be extended in order to override the default implementation.

Note: It is considered good practice to implement the equals and hashCode methods when extending this class. Otherwise, odd behaviour can occur.

Details on implementing for smart cards.

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

Fields inherited from interface net.rim.device.api.crypto.AsymmetricCryptoToken

KEY_GENERATION, PRIVATE_KEY_OPERATION, PUBLIC_KEY_OPERATION

Constructor Summary
	protected	KEACryptoToken() Creates a new KEACryptoToken object.

Method Summary
	KEAKeyPair	createKEAKeyPair(CryptoTokenCryptoSystemData cryptoTokenData) Creates a key pair using the specified crypto token.
	void	deleteKEAPrivateKey(CryptoTokenPrivateKeyData data) Delete the specified key on the crypto token.
	void	deleteKEAPublicKey(CryptoTokenPublicKeyData data) Delete the specified key on the crypto token.
	byte[]	extractKEAPrivateKeyData(CryptoTokenPrivateKeyData cryptoTokenData) Returns the private key data.
	byte[]	extractKEAPublicKeyData(CryptoTokenPrivateKeyData cryptoTokenData) Returns the public key data.
	byte[]	extractKEAPublicKeyData(CryptoTokenPublicKeyData cryptoTokenData) Returns the public key data.
	byte[]	generateKEASharedSecret(CryptoTokenCryptoSystemData cryptoTokenCryptoSystemData, CryptoTokenPrivateKeyData cryptoTokenLocalStaticPrivateKeyData, CryptoTokenPrivateKeyData cryptoTokenLocalEphemeralPrivateKeyData, byte[] remoteStaticPublicKeyData, byte[] remoteEphemeralPublicKeyData) Generates the shared secret using given local and remote, public and private keys.
	String	getAlgorithm() Returns the algorithm supported by this token, ie "KEA".
	int	getKEACryptoSystemBitLength(CryptoTokenCryptoSystemData cryptoTokenData) Returns the number of bits (aka the "strength") of the crypto system, eg 1024.
	CryptoTokenCryptoSystemData	getKEACryptoSystemData(byte[] p, byte[] q, byte[] g, String name) Returns the KEA crypto system data associated with the crypto token.
	byte[]	getKEACryptoSystemG(CryptoTokenCryptoSystemData cryptoTokenData) Returns the g domain parameter.
	String	getKEACryptoSystemName(CryptoTokenCryptoSystemData cryptoTokenData) Returns a String that indicates the set of parameters in use, eg "WTLS1", or null.
	byte[]	getKEACryptoSystemP(CryptoTokenCryptoSystemData cryptoTokenData) Returns the p domain parameter.
	byte[]	getKEACryptoSystemQ(CryptoTokenCryptoSystemData cryptoTokenData) Returns the q domain parameter, or null.
	int	getKEAPrivateKeyLength(CryptoTokenCryptoSystemData cryptoTokenData) Returns the length of the private key.
	int	getKEAPublicKeyLength(CryptoTokenCryptoSystemData cryptoTokenData) Returns the length of the public key.
	CryptoTokenPrivateKeyData	injectKEAPrivateKey(CryptoTokenCryptoSystemData cryptoSystemData, byte[] data) Inserts (or injects) the private key data onto the crypto token.
	CryptoTokenPublicKeyData	injectKEAPublicKey(CryptoTokenCryptoSystemData cryptoSystemData, byte[] data) Inserts (or injects) the public key data onto the crypto token.
	boolean	isSupported(CryptoSystem cryptoSystem, int operation) Indicates whether the chosen operation is supported by this CryptoToken using the provided CryptoSytem.
	boolean	providesUserAuthentication() Returns true if the token provides its own user authentication checks, eg a smartcard will prompt for a password before allowing access to the keys.
	void	verifyKEACryptoSystemData(CryptoTokenCryptoSystemData cryptoSystemData) Checks the validity of the crypto system parameters represented by this token.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KEACryptoToken

protected KEACryptoToken()

Creates a new KEACryptoToken object.

This constructor is not used.

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 final String getAlgorithm()

Returns the algorithm supported by this token, ie "KEA".

This method will always return the String "KEA".

Specified by:

getAlgorithm in interface CryptoToken

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

providesUserAuthentication

public boolean providesUserAuthentication()

Returns true if the token provides its own user authentication checks, eg a smartcard will prompt for a password before allowing access to the keys. This default implementation returns false.

Specified by:

providesUserAuthentication in interface CryptoToken

Returns:

true if the user will be authenticated by the token itself.

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

getKEACryptoSystemBitLength

public int getKEACryptoSystemBitLength(CryptoTokenCryptoSystemData cryptoTokenData)
                                throws CryptoTokenException,
                                       CryptoUnsupportedOperationException

Returns the number of bits (aka the "strength") of the crypto system, eg 1024.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

An integer that represents the bit length of the crypto system.

Throws:

CryptoTokenException - Thrown when an error 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

getKEACryptoSystemName

public String getKEACryptoSystemName(CryptoTokenCryptoSystemData cryptoTokenData)
                              throws CryptoTokenException,
                                     CryptoUnsupportedOperationException

Returns a String that indicates the set of parameters in use, eg "WTLS1", or null.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

A String that represents the name of the crypto system.

Throws:

CryptoTokenException - Thrown when an error 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

getKEACryptoSystemP

public byte[] getKEACryptoSystemP(CryptoTokenCryptoSystemData cryptoTokenData)
                           throws CryptoTokenException,
                                  CryptoUnsupportedOperationException

Returns the p domain parameter.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

A byte array containing the domain parameter p.

Throws:

CryptoTokenException - Thrown when an error 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

getKEACryptoSystemQ

public byte[] getKEACryptoSystemQ(CryptoTokenCryptoSystemData cryptoTokenData)
                           throws CryptoTokenException,
                                  CryptoUnsupportedOperationException

Returns the q domain parameter, or null.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

A byte array containing the domain parameter q.

Throws:

CryptoTokenException - Thrown when an error 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

getKEACryptoSystemG

public byte[] getKEACryptoSystemG(CryptoTokenCryptoSystemData cryptoTokenData)
                           throws CryptoTokenException,
                                  CryptoUnsupportedOperationException

Returns the g domain parameter.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

A byte array containing the domain parameter g.

Throws:

CryptoTokenException - Thrown when an error 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

getKEAPublicKeyLength

public int getKEAPublicKeyLength(CryptoTokenCryptoSystemData cryptoTokenData)
                          throws CryptoTokenException,
                                 CryptoUnsupportedOperationException

Returns the length of the public key.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

An integer representing the length of the public key, in bytes.

Throws:

CryptoTokenException - Thrown when an error 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

getKEAPrivateKeyLength

public int getKEAPrivateKeyLength(CryptoTokenCryptoSystemData cryptoTokenData)
                           throws CryptoTokenException,
                                  CryptoUnsupportedOperationException

Returns the length of the private key.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

An integer representing the length of the private key, in bytes.

Throws:

CryptoTokenException - Thrown when an error 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

extractKEAPublicKeyData

public byte[] extractKEAPublicKeyData(CryptoTokenPublicKeyData cryptoTokenData)
                               throws CryptoTokenException,
                                      CryptoUnsupportedOperationException

Returns the public key data.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

A byte array containing the public key data.

Throws:

CryptoTokenException - Thrown when an error 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

extractKEAPublicKeyData

public byte[] extractKEAPublicKeyData(CryptoTokenPrivateKeyData cryptoTokenData)
                               throws CryptoTokenException,
                                      CryptoUnsupportedOperationException

Returns the public key data.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

A byte array containing the public key data.

Throws:

CryptoTokenException - Thrown when an error 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

extractKEAPrivateKeyData

public byte[] extractKEAPrivateKeyData(CryptoTokenPrivateKeyData cryptoTokenData)
                                throws CryptoTokenException,
                                       CryptoUnsupportedOperationException

Returns the private key data.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

A byte array containing the private key data.

Throws:

CryptoTokenException - Thrown when an error 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

verifyKEACryptoSystemData

public void verifyKEACryptoSystemData(CryptoTokenCryptoSystemData cryptoSystemData)
                               throws CryptoTokenException,
                                      CryptoUnsupportedOperationException,
                                      InvalidCryptoSystemException

Checks the validity of the crypto system parameters represented by this token. This method is called by KEACryptoSystem.verify() after it has gone through the integrity tests for the KEACryptoSystem.

Parameters:

cryptoSystemData - The data associated with the crypto system.

Throws:

CryptoTokenException - Thrown when an error occurs with a crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown when a call is made to an unsupported operation.

InvalidCryptoSystemException - Thrown when the specified crypto system is improperly formatted.

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

getKEACryptoSystemData

public CryptoTokenCryptoSystemData getKEACryptoSystemData(byte[] p,
                                                          byte[] q,
                                                          byte[] g,
                                                          String name)
                                                   throws CryptoTokenException,
                                                          CryptoUnsupportedOperationException,
                                                          InvalidCryptoSystemException,
                                                          UnsupportedCryptoSystemException

Returns the KEA crypto system data associated with the crypto token.

Parameters:

p - A byte array containing the domain parameter p.

q - A byte array containing the domain parameter q.

g - A byte array containing the domain parameter g.

name - A String representing the name of the crypto system.

Returns:

The CryptoTokenCryptoSystemData object associated with the crypto token.

Throws:

CryptoTokenException - Thrown when an error occurs with a crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown when a call is made to an unsupported operation.

InvalidCryptoSystemException - Thrown when the specified crypto system is improperly formatted.

UnsupportedCryptoSystemException - Thrown when 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

createKEAKeyPair

public KEAKeyPair createKEAKeyPair(CryptoTokenCryptoSystemData cryptoTokenData)
                            throws CryptoTokenException,
                                   CryptoUnsupportedOperationException

Creates a key pair using the specified crypto token.

Parameters:

cryptoTokenData - The data associated with the crypto token.

Returns:

The KEA key pair.

Throws:

CryptoTokenException - Thrown when an error occurs with the crypto token.

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

injectKEAPublicKey

public CryptoTokenPublicKeyData injectKEAPublicKey(CryptoTokenCryptoSystemData cryptoSystemData,
                                                   byte[] data)
                                            throws InvalidKeyException,
                                                   CryptoTokenException,
                                                   CryptoUnsupportedOperationException

Inserts (or injects) the public key data onto the crypto token.

Parameters:

cryptoSystemData - The data associated with the crypto ssystem.

data - A byte array containing the key data to be inserted onto the token.

Returns:

The public key data associated with the token.

Throws:

InvalidKeyException - Thrown if the specified key is invalid or improperly formed.

CryptoTokenException - Thrown when an error occurs with the crypto token.

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

injectKEAPrivateKey

public CryptoTokenPrivateKeyData injectKEAPrivateKey(CryptoTokenCryptoSystemData cryptoSystemData,
                                                     byte[] data)
                                              throws InvalidKeyException,
                                                     CryptoTokenException,
                                                     CryptoUnsupportedOperationException

Inserts (or injects) the private key data onto the crypto token.

Parameters:

cryptoSystemData - The data associated with the crypto ssystem.

data - A byte array containing the key data to be inserted onto the token.

Returns:

The private key data associated with the token.

Throws:

InvalidKeyException - Thrown if the specified key is invalid or improperly formed.

CryptoTokenException - Thrown when an error occurs with the crypto token.

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

deleteKEAPublicKey

public void deleteKEAPublicKey(CryptoTokenPublicKeyData data)
                        throws CryptoTokenException,
                               CryptoUnsupportedOperationException

Delete the specified key on the crypto token.

Parameters:

data - The key data contained within the token.

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

deleteKEAPrivateKey

public void deleteKEAPrivateKey(CryptoTokenPrivateKeyData data)
                         throws CryptoTokenException,
                                CryptoUnsupportedOperationException

Delete the specified key on the crypto token.

Parameters:

data - The key data contained within the token.

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

generateKEASharedSecret

public byte[] generateKEASharedSecret(CryptoTokenCryptoSystemData cryptoTokenCryptoSystemData,
                                      CryptoTokenPrivateKeyData cryptoTokenLocalStaticPrivateKeyData,
                                      CryptoTokenPrivateKeyData cryptoTokenLocalEphemeralPrivateKeyData,
                                      byte[] remoteStaticPublicKeyData,
                                      byte[] remoteEphemeralPublicKeyData)
                               throws CryptoTokenException,
                                      CryptoUnsupportedOperationException,
                                      InvalidKeyException

Generates the shared secret using given local and remote, public and private keys.

Parameters:

cryptoTokenCryptoSystemData - The crypto system data contained on the token.

cryptoTokenLocalStaticPrivateKeyData - The local static private key to use.

cryptoTokenLocalEphemeralPrivateKeyData - The local ephemeral private key to use.

remoteStaticPublicKeyData - The remote static public key to use.

remoteEphemeralPublicKeyData - The remote ephemeral public key to use.

Returns:

A byte array containing the shared secret data.

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.

InvalidKeyException - Thrown if the calculated shared secret is not contained within the expected subgroup. This may be thrown if a small subgroup attack is detected.

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

isSupported

public boolean isSupported(CryptoSystem cryptoSystem,
                           int operation)

Indicates whether the chosen operation is supported by this CryptoToken using the provided CryptoSytem.

Specified by:

isSupported in interface AsymmetricCryptoToken

Parameters:

cryptoSystem - The CryptoSystem to check against.

operation - An integer, either KEY_GENERATION, PUBLIC_KEY_OPERATION, PRIVATE_KEY_OPERATION, or some other value specific to the cryptosystem that indicates the operation to be checked.

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