SHOW Signed

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

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

public abstract class PrivateKeyDecoder

extends Object

Allows the developer to encode private keys using a variety of supported encoding algorithms. The details of creating and using the appropriate algorithm are managed by PrivateKeyEncoder and are completely transparent to the developer.

Encoding a Private Key

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

      RSAPrivateKey key = new RSAPrivateKey( ... );
      EncodedKey encodedKey = PrivateKeyEncoder.encode( key, "PKCS8", false );
 

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

Decoding a Private Key

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

      byte[] encodedKeyData = ...;
      PrivateKey decodedKey = PrivateKeyEncoder.decode( encodedKeyData, "PKCS8" );
 

This code assumes that encodedKeyData contains a properly encoded private key.

Supported Encoding Algorithms

Please see here for a list of the RIM supplied encoding algorithms. Currently, RIM provides the following private key encoding algorithms, which can be accessed with the specifed string :

Microsoft Crypto API	Use the encoding string "MSCAPI".
PKCS8 encoding	Use the encoding string "PKCS8".

The MSCAPI encoding can be found in MSDN. The PKCS8 encoding is found in the PKCS8 standard v1.2.

For algorithms not found in this list, a developer can implement additional private key encoding 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 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 PrivateKey	decode(byte[] encodedKey, String encodingAlgorithm) Takes in an encoded key and returns the decoded private key.
	static PrivateKey	decode(byte[] encodedKey, String encodingAlgorithm, CryptoSystem cryptoSystem, String keyAlgorithm) Accepts an encoded key and returns the decoded private key.
	static PrivateKey	decode(InputStream encodedKey, String encodingAlgorithm) Takes in an encoded key and returns the decoded private key.
	static PrivateKey	decode(InputStream encodedKey, String encodingAlgorithm, CryptoSystem cryptoSystem, String keyAlgorithm) Accepts an encoded key and returns the decoded private key.

Methods inherited from class java.lang.Object

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

Constructor Detail

Method Detail

decode

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

Accepts an encoded key and returns the decoded private key.

Parameters:

encodedKey - An input stream containing the encoding of the key.

encodingAlgorithm - The encoding algorithm used for the encoded key.

cryptoSystem - The crypto system to base the decoded key upon (if no parameters were encoded with it).

keyAlgorithm - The type of key.

Returns:

The decoded private 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 PrivateKey decode(byte[] encodedKey,
                                String encodingAlgorithm,
                                CryptoSystem cryptoSystem,
                                String keyAlgorithm)
                         throws NoSuchAlgorithmException,
                                InvalidKeyEncodingException,
                                InvalidKeyException,
                                InvalidCryptoSystemException,
                                UnsupportedCryptoSystemException,
                                CryptoTokenException,
                                CryptoUnsupportedOperationException

Accepts an encoded key and returns the decoded private key.

Parameters:

encodedKey - A byte array containing the encoding of the key.

encodingAlgorithm - The encoding algorithm used for the encoded key.

cryptoSystem - The crypto system to base the decoded key upon (if no parameters were encoded with it).

keyAlgorithm - The type of key.

Returns:

The decoded private 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 PrivateKey decode(InputStream encodedKey,
                                String encodingAlgorithm)
                         throws NoSuchAlgorithmException,
                                InvalidKeyEncodingException,
                                InvalidKeyException,
                                InvalidCryptoSystemException,
                                UnsupportedCryptoSystemException,
                                CryptoTokenException,
                                CryptoUnsupportedOperationException

Takes in an encoded key and returns the decoded private key.

Parameters:

encodedKey - An input stream containing the key encoding.

encodingAlgorithm - The encoding algorithm used for the encoded key.

Returns:

The decoded private 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 PrivateKey decode(byte[] encodedKey,
                                String encodingAlgorithm)
                         throws NoSuchAlgorithmException,
                                InvalidKeyEncodingException,
                                InvalidKeyException,
                                InvalidCryptoSystemException,
                                UnsupportedCryptoSystemException,
                                CryptoTokenException,
                                CryptoUnsupportedOperationException

Takes in an encoded key and returns the decoded private key.

Parameters:

encodedKey - A byte array containing the key encoding.

encodingAlgorithm - The encoding algorithm used for the encoded key.

Returns:

The decoded private key.

Throws:

NoSuchAlgorithmException - Thrown if the specified key 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.