net.rim.device.api.crypto
Class SkipjackEncryptorEngine

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

All Implemented Interfaces:

BlockEncryptorEngine, SymmetricKeyEncryptorEngine

public final class SkipjackEncryptorEngine
extends Object
implements SymmetricKeyEncryptorEngine

The SkipjackEncryptorEngine implements the encryption functionality of the Skipjack block cipher.

We implemented Skipjack as it's defined in Skipjack

Skipjack operates on 64 bit blocks and has a key length of 80 bits.

For a code sample using the Skipjack encryptor engine, click here.

For information on cryptographic algorithms, see Crypto Algorithms.

See Also:

SkipjackDecryptorEngine, SkipjackKey

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
	SkipjackEncryptorEngine(SkipjackKey key) Creates a SkipjackEncryptorEngine based upon a Skipjack key 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, ie "Skipjack".
	int	getBlockLength() Returns the block length of the engine 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

SkipjackEncryptorEngine

public SkipjackEncryptorEngine(SkipjackKey key)
                        throws CryptoTokenException,
                               CryptoUnsupportedOperationException

Creates a SkipjackEncryptorEngine based upon a Skipjack key 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 encryption.

Throws:

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

CryptoUnsupportedOperationException - Thrown if 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, ie "Skipjack".

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

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