net.rim.device.api.crypto
Class RC2EncryptorEngine

java.lang.Object
  net.rim.device.api.crypto.RC2EncryptorEngine

All Implemented Interfaces:

BlockEncryptorEngine, SymmetricKeyEncryptorEngine

public final class RC2EncryptorEngine
extends Object
implements SymmetricKeyEncryptorEngine

The RC2EncryptorEngine implements the encryption functionality of the RC2 block cipher.

We implemented RC2 as per RFC 2268.

RC2 operates on 64 bit blocks and supports key lengths between 1 and 1024 bits.

For information on cryptographic algorithms, see Crypto Algorithms.

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

Field Summary
	static int	BLOCK_LENGTH Represents the block length of the cipher in bytes, namely 8 bytes.

Constructor Summary
	RC2EncryptorEngine(RC2Key key) Creates a RC2EncryptorEngine class based upon a RC2Key that is initialized and used for encryption of the plaintext for all subsequent calls to the class.

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 algorithm used, eg "RC2_64" ("RC2_" + keyBitLength).
	int	getBlockLength() Returns the block length of the engine in bytes.
	int	getKeyLength() Returns the length of the engine's key in bytes.

Methods inherited from class java.lang.Object

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

Field Detail

BLOCK_LENGTH

public static final int BLOCK_LENGTH

Represents the block length of the cipher in bytes, namely 8 bytes.

See Also:

Constant Field Values

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 Detail

RC2EncryptorEngine

public RC2EncryptorEngine(RC2Key key)
                   throws CryptoTokenException,
                          CryptoUnsupportedOperationException

Creates a RC2EncryptorEngine class based upon a RC2Key that is initialized and used for encryption of the plaintext for all subsequent calls to the class.

Parameters:

key - Contains the key material that will be used for decryption.

Throws:

CryptoTokenException - Thrown when an error occurs with a crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown when a call is made to an unsupported operation.

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 algorithm used, eg "RC2_64" ("RC2_" + keyBitLength).

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

getKeyLength

public int getKeyLength()

Returns the length of the engine's key in bytes.

Returns:

An integer that represents the length of the key.

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