net.rim.device.api.crypto.encoder
Class SymmetricKeyEncoder

java.lang.Object
  extended by net.rim.device.api.crypto.encoder.SymmetricKeyEncoder

public abstract class SymmetricKeyEncoder
extends Object

Allows the developer to encode symmetric keys using a variety of supported encoding algorithms. Once again, the details of creating and using the appropriate algorithm are managed by SymmetricKeyDecoder and are completely transparent to the developer.

Encoding a Symmetric Key

Encoding a public key involves calling the public static encode() method with the desired symmetric key. As the following code illustrates, encoding a is straightforward:

      DESKey key = new DESKey( ... );
      EncodedKey encodedKey = SymmetricKeyEncoder.encode( key, "scheme" );
 
Of course, the DES key must be properly created and initialized.

Decoding a Symmetric Key

Decoding a symmetric key is similar to encoding one. Simply call the public static decode() method with the encoded key:

      byte[] encodedKeyData = ...;
      SymmetricKey decodedKey = SymmetricKeyDecoder.decode( encodedKey, "scheme" );
 
This code assumes that encodedKey contains a properly encoded symmetric key.

Supported Encoding Algorithms

A complete list of the key encoding algorithms supported by the RIM crypto API can be found here. Currently, RIM provides the following symmetric key encoding algorithms, which can be accessed with the specifed string :

A RIM variant of PKCS8 Use the encoding string "PKCS8".

For algorithms not found in this list, a developer can implement additional symmetric key decoding algorithms that can be integrated into the Crypto API. Please see the tutorial on Adding Encoders.

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 protected SymmetricKeyEncoder()
          Creates a new SymmetricKeyEncoder object.
 
Method Summary
Category: Signed static EncodedKey encode(SymmetricKey key)
          Encodes the given key using the default PKCS8 encoding scheme.
Category: Signed static EncodedKey encode(SymmetricKey key, String encodingAlgorithm)
          Encodes a given key using the specified encoding scheme.
Category: Signed protected abstract  EncodedKey encodeKey(SymmetricKey key)
          Encodes the passed in key in the proper format.
Category: Signed protected static SymmetricKeyEncoder getEncoder(String encodingAlgorithm, String keyAlgorithm)
          Returns the class associated with the encoding algorithm and the key algorithm.
Category: Signed protected abstract  String getEncodingAlgorithm()
          Returns the name of the encoding used, such as "PKCS8".
Category: Signed protected abstract  String[] getKeyAlgorithms()
          Returns the name of the key that was encoded, such as ("DES", "HMAC").
Category: Signed static boolean register(SymmetricKeyEncoder encoder)
          Registers the given encoder class with the API.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

SymmetricKeyEncoder

protected SymmetricKeyEncoder()
Creates a new SymmetricKeyEncoder object.

This is the default constructor.

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

encode

public static EncodedKey encode(SymmetricKey key)
                         throws NoSuchAlgorithmException,
                                CryptoTokenException,
                                CryptoUnsupportedOperationException
Encodes the given key using the default PKCS8 encoding scheme.

Parameters:
key - The symmetric key to encode.
Returns:
An EncodedKey object containing the encoded key.
Throws:
NoSuchAlgorithmException - Thrown if the encoding algorithm cannot be found.
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

encode

public static EncodedKey encode(SymmetricKey key,
                                String encodingAlgorithm)
                         throws NoSuchAlgorithmException,
                                CryptoTokenException,
                                CryptoUnsupportedOperationException
Encodes a given key using the specified encoding scheme.

Parameters:
key - The symmetric key to encode.
encodingAlgorithm - A String representing the encoding Algorithm to use, eg "PKCS8".
Returns:
An EncodedKey object containing the encoded key.
Throws:
NoSuchAlgorithmException - Thrown if the specified encoding algorithm cannot be found.
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

encodeKey

protected abstract EncodedKey encodeKey(SymmetricKey key)
                                 throws NoSuchAlgorithmException,
                                        CryptoTokenException,
                                        CryptoUnsupportedOperationException
Encodes the passed in key in the proper format.

Parameters:
key - A symmetric key to encode.
Returns:
The encoding of the key.
Throws:
NoSuchAlgorithmException - Thrown if the specified encoding algorithm cannot be found.
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

register

public static boolean register(SymmetricKeyEncoder encoder)
                        throws NoSuchAlgorithmException
Registers the given encoder class with the API.

Parameters:
encoder - The symmetric key encoder to register.
Returns:
Returns true if the class was added by the user, false if it already existed in the hash table.
Throws:
NoSuchAlgorithmException - Thrown if the specified encoding algorithm cannot be found.
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

getEncoder

protected static SymmetricKeyEncoder getEncoder(String encodingAlgorithm,
                                                String keyAlgorithm)
                                         throws NoSuchAlgorithmException
Returns the class associated with the encoding algorithm and the key algorithm.

Parameters:
encodingAlgorithm - The encoding algorithm such as "PKCS8".
keyAlgorithm - The key type that was encoded, such as "DES".
Returns:
An instance of a symmetric key encoder.
Throws:
NoSuchAlgorithmException - Thrown if the encoding algorithm cannot be found.
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

getEncodingAlgorithm

protected abstract String getEncodingAlgorithm()
Returns the name of the encoding used, such as "PKCS8".

Returns:
A String representing the name of the encoding 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

getKeyAlgorithms

protected abstract String[] getKeyAlgorithms()
Returns the name of the key that was encoded, such as ("DES", "HMAC").

Returns:
An array of Strings that represents the key algorithms.
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.