SHOW Signed

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

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

public abstract class PublicKeyDecoder

extends Object

Allows the developer to decode public keys using a variety of supported encoding algorithms. The details of creating and using the appropriate algorithm are managed by PublicKeyDecoder 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. 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".

Supported Encoding Algorithms

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.

A complete list of the key encoding algorithms supported by the RIM crypto API can be found here.

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 PublicKey	decode(byte[] encodedKey, String encodingAlgorithm) Takes in the given encoded key and returns the decoded public key.
	static PublicKey	decode(byte[] encodedKey, String encodingAlgorithm, CryptoSystem cryptoSystem, String keyAlgorithm) Decodes an encoded public key.
	static PublicKey	decode(InputStream encodedKey, String encodingAlgorithm) Takes in the given encoded key and returns the decoded public key.
	static PublicKey	decode(InputStream encodedKey, String encodingAlgorithm, CryptoSystem cryptoSystem, String keyAlgorithm) Decodes an encoded public key.

Methods inherited from class java.lang.Object

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

Constructor Detail

Method Detail

decode

public static PublicKey decode(InputStream encodedKey,
                               String encodingAlgorithm,
                               CryptoSystem cryptoSystem,
                               String keyAlgorithm)
                        throws NoSuchAlgorithmException,
                               InvalidKeyEncodingException,
                               InvalidKeyException,
                               InvalidCryptoSystemException,
                               UnsupportedCryptoSystemException,
                               CryptoTokenException,
                               CryptoUnsupportedOperationException

Decodes an encoded public key.

Parameters:

encodedKey - An InputStream containing the key encoding.

encodingAlgorithm - The encoding algorithm to use to decode, such as "X509".

cryptoSystem - The crypto system to retrieve parameter information from, if necessary.

keyAlgorithm - The type of key.

Returns:

the decoded public key.

Throws:

NoSuchAlgorithmException - Thrown if the specified algorithm is invalid.

InvalidKeyEncodingException - Thrown if the key is improperly formatted.

InvalidKeyException - Thrown if the specified key is invalid.

InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.

UnsupportedCryptoSystemException - Thrown if the specified crypto system is unsupported.

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.

decode

public static PublicKey decode(byte[] encodedKey,
                               String encodingAlgorithm,
                               CryptoSystem cryptoSystem,
                               String keyAlgorithm)
                        throws NoSuchAlgorithmException,
                               InvalidKeyEncodingException,
                               InvalidKeyException,
                               InvalidCryptoSystemException,
                               UnsupportedCryptoSystemException,
                               CryptoTokenException,
                               CryptoUnsupportedOperationException

Decodes an encoded public key.

Parameters:

encodedKey - A byte array containing the key encoding.

encodingAlgorithm - The encoding algorithm to use to decode, such as "X509".

cryptoSystem - The crypto system to retrieve parameter information, if necessary.

keyAlgorithm - The type of key.

Returns:

The decoded public key.

Throws:

NoSuchAlgorithmException - Thrown if the specified algorithm is invalid.

InvalidKeyEncodingException - Thrown if the key is improperly formatted.

InvalidKeyException - Thrown if the specified key is invalid.

InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.

UnsupportedCryptoSystemException - Thrown if the specified crypto system is unsupported.

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.

decode

public static PublicKey decode(InputStream encodedKey,
                               String encodingAlgorithm)
                        throws NoSuchAlgorithmException,
                               InvalidKeyEncodingException,
                               InvalidKeyException,
                               InvalidCryptoSystemException,
                               UnsupportedCryptoSystemException,
                               CryptoTokenException,
                               CryptoUnsupportedOperationException

Takes in the given encoded key and returns the decoded public key.

Parameters:

encodedKey - An input stream containing the encoding and other relevant information.

encodingAlgorithm - The encoding algorithm to use to decode, such as "X509."

Returns:

The decoded public key.

Throws:

NoSuchAlgorithmException - Thrown if the specified algorithm is invalid.

InvalidKeyEncodingException - Thrown if the key is improperly formatted.

InvalidKeyException - Thrown if the specified key is invalid.

InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.

UnsupportedCryptoSystemException - Thrown if the specified crypto system is unsupported.

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.

decode

public static PublicKey decode(byte[] encodedKey,
                               String encodingAlgorithm)
                        throws NoSuchAlgorithmException,
                               InvalidKeyEncodingException,
                               InvalidKeyException,
                               InvalidCryptoSystemException,
                               UnsupportedCryptoSystemException,
                               CryptoTokenException,
                               CryptoUnsupportedOperationException

Takes in the given encoded key and returns the decoded public key.

Parameters:

encodedKey - A byte array containing the encoding and other relevant information.

encodingAlgorithm - The encoding algorithm to use to decode, such as "X509."

Returns:

The decoded public key.

Throws:

NoSuchAlgorithmException - Thrown if the specified algorithm is invalid.

InvalidKeyEncodingException - Thrown if the key is improperly formatted.

InvalidKeyException - Thrown if the specified key is invalid.

InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.

UnsupportedCryptoSystemException - Thrown if the specified crypto system is unsupported.

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.