SHOW Signed

net.rim.device.api.crypto
Class CBCEncryptorEngine

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

All Implemented Interfaces:

BlockEncryptorEngine

public final class CBCEncryptorEngine

extends Object

implements BlockEncryptorEngine

Provides the functionality of using CBC or Cipher Block Chaining mode for encryption. CBC mode is defined in FIPS 81.

For a code sample of how to use the DES encryptor engine with CBC mode check 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:

CBCDecryptorEngine

Constructor Summary

	CBCEncryptorEngine(BlockEncryptorEngine engine) Creates a CBC encryptor engine with the given algorithm engine.
	CBCEncryptorEngine(BlockEncryptorEngine engine, InitializationVector iv) Creates a CBC encryptor engine with the given algorithm engine and initialization vector.

Method Summary

	void	encrypt(byte[] plaintext, int plaintextOffset, byte[] ciphertext, int ciphertextOffset) Encrypts a block of the given plaintext into a block of ciphertext.
	String	getAlgorithm() Returns the name of the encryption algorithm used, ie BlockEncryptorEngine.getAlgorithm() + "/CBC".
	int	getBlockLength() Returns the block length of the engine in bytes.
	InitializationVector	getIV() Returns the initialization vector associated with this decryptor engine.
	void	setIV(InitializationVector iv) Sets the initialization vector associated with this decryptor engine.

Methods inherited from class java.lang.Object

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

Constructor Detail

CBCEncryptorEngine

public CBCEncryptorEngine(BlockEncryptorEngine engine)

Creates a CBC encryptor engine with the given algorithm engine. A random initialization vector is created. Use getIV to retrieve the initialization vector.

Parameters:

engine - an algorithm engine used for encryption.

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.

CBCEncryptorEngine

public CBCEncryptorEngine(BlockEncryptorEngine engine,
                          InitializationVector iv)

Creates a CBC encryptor engine with the given algorithm engine and initialization vector.

Parameters:

engine - an algorithm engine used for encryption.

iv - an initialization vector used for seeding the mode.

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 encryption algorithm used, ie BlockEncryptorEngine.getAlgorithm() + "/CBC".

Specified by:

getAlgorithm in interface BlockEncryptorEngine

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

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.

getBlockLength

public int getBlockLength()

Description copied from interface: BlockEncryptorEngine

Returns the block length of the engine in bytes.

Specified by:

getBlockLength in interface BlockEncryptorEngine

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

Returns:

An integer that represents the number of bytes.

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.

setIV

public void setIV(InitializationVector iv)

Sets the initialization vector associated with this decryptor engine.

Parameters:

iv - An initialization vector used for seeding the engine.

Since:

JDE 3.6

See Also:

getIV()

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.

getIV

public InitializationVector getIV()

Returns the initialization vector associated with this decryptor engine.

Returns:

The initialization vector.

See Also:

setIV(net.rim.device.api.crypto.InitializationVector)

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.

encrypt

public void encrypt(byte[] plaintext,
                    int plaintextOffset,
                    byte[] ciphertext,
                    int ciphertextOffset)
             throws CryptoTokenException

Description copied from interface: BlockEncryptorEngine

Encrypts a block of the given plaintext into a block of ciphertext.

Specified by:

encrypt in interface BlockEncryptorEngine

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.