SHOW Signed
 

net.rim.device.api.crypto
Class XEncryptorEngine

java.lang.Object
  |
  +--net.rim.device.api.crypto.XEncryptorEngine
All Implemented Interfaces:
BlockEncryptorEngine

public final class XEncryptorEngine
extends Object
implements BlockEncryptorEngine

The XEncryptorEngine class efficiently extends the key space of a block cipher, by whitening (ie xor'ing) random secret data before and after the cipher executes. The whitening vectors must remain secret.

    E( key, plaintext ) = E( key, plaintext ^ preWhitening ) ^ postWhitening
 

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

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:
JDE 3.6.0
See Also:
XDecryptorEngine

Constructor Summary
 Category: Signed XEncryptorEngine(BlockEncryptorEngine engine)
          Creates an XEncryptorEngine object with the given algorithm engine.
 Category: Signed XEncryptorEngine(BlockEncryptorEngine engine, InitializationVector preWhitening, InitializationVector postWhitening)
          Creates an XEncryptorEngine with the given algorithm engine and whitening vectors.
 
Method Summary
 Category: Signed  void encrypt(byte[] plaintext, int plaintextOffset, byte[] ciphertext, int ciphertextOffset)
          Encrypts a block of the given plaintext into a block of ciphertext.
 Category: Signed  String getAlgorithm()
          Returns the name of the encryption algorithm used, ie BlockDecryptorEngine.getAlgorithm() + "/X".
 Category: Signed  int getBlockLength()
          Returns the block length of the engine in bytes.
 Category: Signed  InitializationVector getPostWhitening()
          Returns the whitening vector that is applied to the ciphertext.
 Category: Signed  InitializationVector getPreWhitening()
          Returns the whitening vector that is applied to the plaintext.
 Category: Signed  void setWhiteningVectors(InitializationVector preWhitening, InitializationVector postWhitening)
          Sets the pre and post whitening vectors.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XEncryptorEngine

public XEncryptorEngine(BlockEncryptorEngine engine)
Creates an XEncryptorEngine object with the given algorithm engine. Use the getPreWhitening() and getPostWhitening() methods to retrieve the whitening vectors.

Parameters:
engine - The algorithm engine to be used for encryption.
Since:
JDE 3.6.0
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.

XEncryptorEngine

public XEncryptorEngine(BlockEncryptorEngine engine,
                        InitializationVector preWhitening,
                        InitializationVector postWhitening)
Creates an XEncryptorEngine with the given algorithm engine and whitening vectors.

Parameters:
engine - The algorithm engine used for encryption.
preWhitening - The whitening vector that is applied to the plaintext. This should remain secret.
postWhitening - The whitening vector that is applied to the ciphertext. This should remain secret.
Since:
JDE 3.6.0
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.
Method Detail

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.

Since:
JDE 3.6.0

Following copied from 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.

getAlgorithm

public String getAlgorithm()
Returns the name of the encryption algorithm used, ie BlockDecryptorEngine.getAlgorithm() + "/X".

Returns:
A String representing the name of the algorithm.
Since:
JDE 3.6.0
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.

getBlockLength

public int getBlockLength()
Description copied from interface: BlockEncryptorEngine
Returns the block length of the engine in bytes.

Since:
JDE 3.6.0

Following copied from 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.

getPostWhitening

public InitializationVector getPostWhitening()
Returns the whitening vector that is applied to the ciphertext.

Returns:
The post whitening vector.
Since:
JDE 3.6.0
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.

getPreWhitening

public InitializationVector getPreWhitening()
Returns the whitening vector that is applied to the plaintext.

Returns:
The pre whitening vector.
Since:
JDE 3.6.0
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.

setWhiteningVectors

public void setWhiteningVectors(InitializationVector preWhitening,
                                InitializationVector postWhitening)
Sets the pre and post whitening vectors.
Parameters:
preWhitening - The whitening vector that is applied to the plaintext. This should remain secret.
postWhitening - The whitening vector that is applied to the ciphertext. This should remain secret.
Since:
JDE 3.6.0
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.



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.