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

java.lang.Object
  net.rim.device.api.crypto.encoder.PrivateKeyDecoder
      net.rim.device.api.crypto.encoder.PKCS8_PrivateKeyDecoder

public class PKCS8_PrivateKeyDecoder
extends PrivateKeyDecoder

Implements the private key decoder for PKCS8.

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
	PKCS8_PrivateKeyDecoder() Creates a new PKCS8_PrivatekeyDecoder object.

Method Summary
	protected PrivateKey	decodeKey(InputStream encodedKey, CryptoSystem cryptoSystem, String keyAlgorithm) Decodes the specified key.
	protected PrivateKey	decodeKey(ASN1InputStream parameters, ASN1InputStream privateKeyInfo, CryptoSystem cryptoSystem, String algorithm) Decodes a key given the key data and the details of the encoding.
	protected String	getEncodingAlgorithm() Returns the encoding algorithm used, "PKCS8".
	protected String[]	getKeyAlgorithms() Returns the key algorithm encoded.

Methods inherited from class net.rim.device.api.crypto.encoder.PrivateKeyDecoder

decode, decode, decode, decode, getDecoder, register

Methods inherited from class java.lang.Object

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

Constructor Detail

PKCS8_PrivateKeyDecoder

public PKCS8_PrivateKeyDecoder()

Creates a new PKCS8_PrivatekeyDecoder 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

decodeKey

protected PrivateKey decodeKey(InputStream encodedKey,
                               CryptoSystem cryptoSystem,
                               String keyAlgorithm)
                        throws NoSuchAlgorithmException,
                               InvalidKeyEncodingException,
                               InvalidKeyException,
                               InvalidCryptoSystemException,
                               UnsupportedCryptoSystemException,
                               CryptoTokenException,
                               CryptoUnsupportedOperationException,
                               IOException

Description copied from class: PrivateKeyDecoder

Decodes the specified key.

This method must be implemented by subclasses.

Specified by:

decodeKey in class PrivateKeyDecoder

Parameters:

encodedKey - An input stream containing 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 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.

IOException - Thrown when an I/O error occurs.

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

decodeKey

protected PrivateKey decodeKey(ASN1InputStream parameters,
                               ASN1InputStream privateKeyInfo,
                               CryptoSystem cryptoSystem,
                               String algorithm)
                        throws NoSuchAlgorithmException,
                               InvalidKeyEncodingException,
                               InvalidKeyException,
                               InvalidCryptoSystemException,
                               UnsupportedCryptoSystemException,
                               CryptoTokenException,
                               CryptoUnsupportedOperationException,
                               IOException,
                               ASN1EncodingException

Decodes a key given the key data and the details of the encoding.

This method is called by a subclass to finish decoding the key.

Parameters:

parameters - The ASN1 input stream parameters.

privateKeyInfo - The private key data.

cryptoSystem - The crypto system associated with the key.

algorithm - The algorithm used to encode the key.

Returns:

A String representing the name of the algorithm.

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.

IOException - Thrown when an I/O error occurs.

ASN1EncodingException - Thrown if the ASN1 input stream 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

getEncodingAlgorithm

protected String getEncodingAlgorithm()

Returns the encoding algorithm used, "PKCS8".

Specified by:

getEncodingAlgorithm in class PrivateKeyDecoder

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 String[] getKeyAlgorithms()

Returns the key algorithm encoded.

Specified by:

getKeyAlgorithms in class PrivateKeyDecoder

Returns:

An array of Strings representing the key 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