SHOW Signed

net.rim.device.api.crypto
Class PKCS1UnformatterEngine

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

All Implemented Interfaces:

BlockUnformatterEngine

public final class PKCS1UnformatterEngine

extends Object

implements BlockUnformatterEngine

Provides the PKCS1 decoding functionality on a block by block basis. The block length is the size of the modulus of an EncryptorEngine minus the overhead.

We implemented the PKCS1 formatter engine as per the PKCS #1 version 2.1 document.

For a code sample using the PKCS1 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.

Since:

JDE 3.6.0

See Also:

PKCS1FormatterEngine

Constructor Summary

PKCS1UnformatterEngine(PrivateKeyDecryptorEngine decryptorEngine) Creates a PKCS1UnformatterEngine object that takes a PrivateKeyDecryptorEngine that will be used for decrypting the ciphertext.

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 PublicKeyDecryptorEngine.getAlgorithm() + "_PKCS1".
	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

PKCS1UnformatterEngine

public PKCS1UnformatterEngine(PrivateKeyDecryptorEngine decryptorEngine)

Creates a PKCS1UnformatterEngine object that takes a PrivateKeyDecryptorEngine that will be used for decrypting the ciphertext.

Parameters:

decryptorEngine - The private key engine to decrypt the data with.

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.

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of the algorithm used, ie PublicKeyDecryptorEngine.getAlgorithm() + "_PKCS1".

Specified by:

getAlgorithm in interface BlockUnformatterEngine

Returns:

A String that represents name of the 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.

getInputBlockLength

public int getInputBlockLength()

Description copied from interface: BlockUnformatterEngine

Returns the length of an input block in bytes.

Specified by:

getInputBlockLength in interface BlockUnformatterEngine

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.

getOutputBlockLength

public int getOutputBlockLength()

Description copied from interface: BlockUnformatterEngine

Returns the length of an output block in bytes.

Specified by:

getOutputBlockLength in interface BlockUnformatterEngine

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.

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 4.0.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.

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 4.0.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.