SHOW Signed

net.rim.device.api.crypto
Class PKCS5UnformatterEngine

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

All Implemented Interfaces:

BlockUnformatterEngine

public final class PKCS5UnformatterEngine

extends Object

implements BlockUnformatterEngine

Provides the PKCS#5 padding scheme. The scheme pads the plaintext to the size of the block length and uses the number of bytes used for this padding as the actual byte to pad with. That is, if there are two bytes that needed to be padded out to get the correct block length then the two bytes used for padding would be 0x02.

We implemented the PKCS5 formatting as per PKCS #5 version 2.0 ( March 1999 ).

For a code sample using the PKCS5 unformatter engine, click 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.

See Also:

PKCS5FormatterEngine

Constructor Summary

PKCS5UnformatterEngine(BlockDecryptorEngine decryptorEngine) Creates a PKCS5UnformatterEngine object using a given SymmetricKeyDecryptorEngine for decrypting the plaintext.

Method Summary

	int	decryptAndUnformat(byte[] input, int inputOffset, byte[] output, int outputOffset) Decrypts the input and then "unformats" it into the original plaintext assuming this block is not the last block in the stream.
	int	decryptAndUnformat(byte[] input, int inputOffset, byte[] output, int outputOffset, boolean lastBlock) Decrypts the input and then "unformats" it into the original plaintext.
	String	getAlgorithm() Returns the name of the algorithm used, ie SymmetricKeyDecryptorEngine.getAlgorithm() + "/PKCS5".
	int	getInputBlockLength() Returns the length of an input block in bytes.
	int	getOutputBlockLength() Returns the length of an output block in bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

PKCS5UnformatterEngine

public PKCS5UnformatterEngine(BlockDecryptorEngine decryptorEngine)

Creates a PKCS5UnformatterEngine object using a given SymmetricKeyDecryptorEngine for decrypting the plaintext.

Parameters:

decryptorEngine - The engine that will be used to decrypt the data.

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.

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of the algorithm used, ie SymmetricKeyDecryptorEngine.getAlgorithm() + "/PKCS5".

Specified by:

getAlgorithm in interface BlockUnformatterEngine

Returns:

A String that represents the name of the algorithm.

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.

getInputBlockLength

public int getInputBlockLength()

Description copied from interface: BlockUnformatterEngine

Returns the length of an input block in bytes.

Specified by:

getInputBlockLength in interface BlockUnformatterEngine

Following copied from interface: net.rim.device.api.crypto.BlockUnformatterEngine

Returns:

An integer representing the length, in bytes, of an input block.

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.

getOutputBlockLength

public int getOutputBlockLength()

Description copied from interface: BlockUnformatterEngine

Returns the length of an output block in bytes.

Specified by:

getOutputBlockLength in interface BlockUnformatterEngine

Following copied from interface: net.rim.device.api.crypto.BlockUnformatterEngine

Returns:

An integer that represents the length, in bytes, of an output block.

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.

decryptAndUnformat

public int decryptAndUnformat(byte[] input,
                              int inputOffset,
                              byte[] output,
                              int outputOffset,
                              boolean lastBlock)
                       throws DecodeException,
                              BadPaddingException,
                              CryptoTokenException

Description copied from interface: BlockUnformatterEngine

Decrypts the input and then "unformats" it into the original plaintext.

Specified by:

decryptAndUnformat in interface BlockUnformatterEngine

Since:

JDE 3.6

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.

decryptAndUnformat

public int decryptAndUnformat(byte[] input,
                              int inputOffset,
                              byte[] output,
                              int outputOffset)
                       throws DecodeException,
                              BadPaddingException,
                              CryptoTokenException

Description copied from interface: BlockUnformatterEngine

Decrypts the input and then "unformats" it into the original plaintext assuming this block is not the last block in the stream.

Specified by:

decryptAndUnformat in interface BlockUnformatterEngine

Since:

JDE 3.6

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.