SHOW Signed SHOW CryptoExtensionAPI

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 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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

Since:

JDE 3.6.0

Constructor Summary

PKCS8_PrivateKeyDecoder() Creates a new PKCS8_PrivatekeyDecoder object.

Method Summary

	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 PrivateKey	decodeKey(InputStream encodedKey, CryptoSystem cryptoSystem, String keyAlgorithm)
	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.

Since:

JDE 3.6.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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

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.

Overrides:

decodeKey in class PrivateKeyDecoder

Since:

JDE 3.6.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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

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.

Since:

JDE 3.6.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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

getEncodingAlgorithm

protected String getEncodingAlgorithm()

Returns the encoding algorithm used, "PKCS8".

Overrides:

getEncodingAlgorithm in class PrivateKeyDecoder

Returns:

A String representing the name of the encoding algorithm.

Since:

JDE 3.6.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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

getKeyAlgorithms

protected String[] getKeyAlgorithms()

Returns the key algorithm encoded.

Overrides:

getKeyAlgorithms in class PrivateKeyDecoder

Returns:

An array of Strings representing the key algorithm.

Since:

JDE 3.6.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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.