SHOW Signed

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

java.lang.Object
  |
  +--net.rim.device.api.crypto.encoder.PublicKeyEncoder

public abstract class PublicKeyEncoder

extends Object

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

Encoding a Public Key

Encoding a public key simply involves calling the public static encode() method with the desired public key. As the following code illustrates, encoding an RSA public key using the X509 algorithm is straightforward:

      RSAPublicKey key = new RSAPublicKey( ... );
      EncodedKey encodedKey = PublicKeyEncoder.encode( key, "X509", false );
 

Of course, the RSA public key must be properly created and initialized.

Decoding a Public Key

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

      byte[] encodedKeyData = ...;
      PublicKey decodedKey = PublicKeyEncoder.decode( encodedKeyData, "X509" );
 

This code assumes that encodedKey contains a properly encoded public 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 public key encoding algorithms, which can be accessed with the specifed string :

Microsoft Crypto API	Use the encoding string "MSCAPI".
X509 encoding	Use the encoding string "X509".
WTLS encoding	Use the encoding string "WTLS".

The MSCAPI encoding can be found in MSDN. The X509 encoding is defined in RFC 2459. Finally, the WTLS encoding is found in WAP-199-WTLS from Feb 2000.

If a developer wishes to implement a key encoding algorithm not found in this list, the PublicKeyEncoder class can be extended. This information can be found here.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 3.6.0

Constructor Summary

Method Summary

	static EncodedKey	encode(PublicKey key) Encodes a given key using the default X509 encoding scheme.
	static EncodedKey	encode(PublicKey key, String encodingAlgorithm) Encodes a given key using the specified encoding scheme.
	static EncodedKey	encode(PublicKey key, String encodingAlgorithm, long flags) Encodes a given key using the specified encoding scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

Method Detail

encode

public static EncodedKey encode(PublicKey key)
                         throws NoSuchAlgorithmException,
                                InvalidKeyEncodingException,
                                CryptoTokenException,
                                CryptoUnsupportedOperationException

Encodes a given key using the default X509 encoding scheme.

The crypto system parameters are encoded.

Parameters:

key - The public key to encode.

Returns:

An EncodedKey object containing the encoded key.

Throws:

NoSuchAlgorithmException - Thrown if the encoding algorithm cannot be found.

InvalidKeyEncodingException - Thrown if the key is improperly formatted.

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.

Since:

JDE 3.7.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

encode

public static EncodedKey encode(PublicKey key,
                                String encodingAlgorithm)
                         throws NoSuchAlgorithmException,
                                InvalidKeyEncodingException,
                                CryptoTokenException,
                                CryptoUnsupportedOperationException

Encodes a given key using the specified encoding scheme.

Parameters:

key - The public key to encode.

encodingAlgorithm - A string representing the encoding Algorithm to use, eg "X509".

Returns:

An EncodedKey object containing the encoded key.

Throws:

NoSuchAlgorithmException - Thrown if the encoding algorithm cannot be found.

InvalidKeyEncodingException - Thrown if the key is improperly formatted.

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.

Since:

JDE 3.7.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

encode

public static EncodedKey encode(PublicKey key,
                                String encodingAlgorithm,
                                long flags)
                         throws NoSuchAlgorithmException,
                                InvalidKeyEncodingException,
                                CryptoTokenException,
                                CryptoUnsupportedOperationException

Encodes a given key using the specified encoding scheme.

Parameters:

key - The public key to encode.

encodingAlgorithm - A string representing the encoding Algorithm to use, eg "X509".

flags - Flags passed to the encoder. See PublicKeyEncoderFlags.

Returns:

An EncodedKey object containing the encoded key.

Throws:

NoSuchAlgorithmException - Thrown if the encoding algorithm cannot be found.

InvalidKeyEncodingException - Thrown if the key is improperly formatted.

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.

Since:

JDE 3.7.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.