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.

CBC Mode is defined where the encryption of each block depends on the encryption of the previous block. Note also that with CBC mode an Initialization Vector (IV) is required. If one is not supplied a random IV is generated.

For a code sample of how to use the DES encryptor engine with CBC mode check here.

For information on cryptographic algorithms, see Crypto Algorithms.

See Also:

CBCDecryptorEngine

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

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

getAlgorithm

public String getAlgorithm()

Returns the name of the encryption algorithm used, ie BlockEncryptorEngine.getAlgorithm() + "/CBC".

Specified by:

getAlgorithm in interface BlockEncryptorEngine

Returns:

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

getBlockLength

public int getBlockLength()

Description copied from interface: BlockEncryptorEngine

Returns the block length of the engine in bytes.

Specified by:

getBlockLength in interface BlockEncryptorEngine

Returns:

An integer that represents the number of bytes.

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

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.

See Also:

CBCEncryptorEngine.getIV()

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

getIV

public InitializationVector getIV()

Returns the initialization vector associated with this decryptor engine.

Returns:

The initialization vector.

See Also:

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

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

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

Parameters:

plaintext - A byte array containing the input that is to be encrypted.

plaintextOffset - The starting offset, or initial byte position, of the data within the input array.

ciphertext - A byte array to hold the ciphertext output from the method.

ciphertextOffset - The starting offset, or initial byte position, of the data within the output array.

Throws:

CryptoTokenException - Thrown when an problem occurs with the crypto token or the crypto token 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