net.rim.device.api.crypto
Class TripleDESKey

java.lang.Object
  extended by net.rim.device.api.crypto.TripleDESKey
All Implemented Interfaces:
Key, SymmetricKey, Persistable

public final class TripleDESKey
extends Object
implements SymmetricKey, Persistable

Creates a TripleDESKey object.

The TripleDES algorithm proposed by NIST utilizes the standard DES algorithm in an alternating encryption then decryption operation. That is, EDE (Encryption/Decryption/Encryption) performing three DES operations and hence its name. This cipher is also commonly referred to as the DESede cipher.

Our implementation provides two types of TripleDES. Namely, two key and three key TripleDES. That is, two key TripleDES uses two different keys -- one for the encryption operations and one for the decryption operation. Three key TripleDES uses a different key for each operation.

The key length is 128 bits or 192 bits depending on whether you are using two key or three key TripleDES. Note that the effective key length is actually 112 bits or 168 bits after removing the parity bits from the DES operations. The block size is 64 bits.

If possible, three key TripleDES should be used instead of two key TripleDES due to the larger keysize and specific attacks against two key TripleDES.

Please refer to FIPS 46-3 for more information.

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
Category: Signed static int LENGTH
          The number of key bytes required, ie 24 bytes.
 
Constructor Summary
Category: Signed TripleDESKey()
          Creates a new random TripleDESKey key.
Category: Signed TripleDESKey(byte[] data)
          Creates a new TripleDESKey object using as much of the given data as necessary.
Category: Signed TripleDESKey(byte[] data, int offset)
          Creates a TripleDESKey object using as much of the given data as necessary.
Category: Signed TripleDESKey(DESKey key1, DESKey key2)
          Creates a key from two DES keys.
Category: Signed TripleDESKey(DESKey key1, DESKey key2, DESKey key3)
          Creates a key from three DES keys.
Category: Signed TripleDESKey(TripleDESCryptoToken cryptoToken, byte[] data, int offset)
          Creates a TripleDESKey object using as much of the given data as necessary.
Category: Signed TripleDESKey(TripleDESCryptoToken cryptoToken, CryptoTokenSymmetricKeyData cryptoTokenData)
          Creates a TripleDESKey object.
Category: Signed TripleDESKey(TripleDESCryptoToken cryptoToken, DESKey key1, DESKey key2)
          Creates a key from two DES keys.
Category: Signed TripleDESKey(TripleDESCryptoToken cryptoToken, DESKey key1, DESKey key2, DESKey key3)
          Creates a key from three DES keys.
 
Method Summary
Category: Signed  boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
Category: Signed  String getAlgorithm()
          Returns a string containing the name of the algorithm associated with this key ("TripleDES").
Category: Signed  int getBitLength()
          Returns the number of bits that make up the actual keying material ( for example parity bits aren't counted ).
Category: Signed  CryptoTokenSymmetricKeyData getCryptoTokenData()
          Returns the crypto token data associated with the key.
Category: Signed  byte[] getData()
          Returns a copy of the byte array representing the key.
Category: Signed  int getLength()
          Returns the length of the key in bytes.
Category: Signed  SymmetricCryptoToken getSymmetricCryptoToken()
          Returns the crypto token associated with this key.
Category: Signed  TripleDESCryptoToken getTripleDESCryptoToken()
          Returns the crypto token associated with the key.
Category: Signed  int hashCode()
          Returns a hash code value for the object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

LENGTH

public static final int LENGTH
The number of key bytes required, ie 24 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

TripleDESKey

public TripleDESKey()
Creates a new random TripleDESKey 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

TripleDESKey

public TripleDESKey(byte[] data)
Creates a new TripleDESKey object using as much of the given data as necessary. If the data length is 16, then a 24 byte key is created with the first 8 bytes repeated for the last 8 bytes. If the data length is greater than 24 then the first 24 bytes are used.

Parameters:
data - The byte array of bytes to be used as key data.
Throws:
IllegalArgumentException - if data==null or if data.length is less than 24, excluding 16.
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

TripleDESKey

public TripleDESKey(byte[] data,
                    int offset)
Creates a TripleDESKey object using as much of the given data as necessary. If the data length, after applying the offset, is 16, then a 24 byte key is created with the first 8 bytes repeated for the last 8 bytes. If the data length, after applying the offset, is greater than 24 then the first 24 bytes are used.

Parameters:
data - The array of bytes to be used.
offset - The starting location within the byte array.
Throws:
IllegalArgumentException - if data==null, or if the specified offset is invalid, or if data.length - offset is less than 24, excluding 16.
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

TripleDESKey

public TripleDESKey(TripleDESCryptoToken cryptoToken,
                    byte[] data,
                    int offset)
             throws CryptoTokenException,
                    CryptoUnsupportedOperationException
Creates a TripleDESKey object using as much of the given data as necessary. Note that the TripleDESKey can only be 16 or 24 bytes long.

Parameters:
cryptoToken - The TripleDESCryptoToken used to create the key.
data - The array of bytes to be used.
offset - The starting location, or initial position, of the key data within the byte array.
Throws:
CryptoTokenException - Thrown when a problem occurs with the 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

TripleDESKey

public TripleDESKey(DESKey key1,
                    DESKey key2)
             throws CryptoTokenException,
                    CryptoUnsupportedOperationException
Creates a key from two DES keys. The first key is repeated as the third key.

Parameters:
key1 - The first DES key.
key2 - The second DES key.
Throws:
CryptoTokenException - Thrown when a problem occurs with the 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

TripleDESKey

public TripleDESKey(DESKey key1,
                    DESKey key2,
                    DESKey key3)
             throws CryptoTokenException,
                    CryptoUnsupportedOperationException
Creates a key from three DES keys.

Parameters:
key1 - The first DES key.
key2 - The second DES key.
key3 - The third DES key.
Throws:
CryptoTokenException - Thrown when a problem occurs with the 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

TripleDESKey

public TripleDESKey(TripleDESCryptoToken cryptoToken,
                    DESKey key1,
                    DESKey key2)
             throws CryptoTokenException,
                    CryptoUnsupportedOperationException
Creates a key from two DES keys. The first key is repeated as the third key.

Parameters:
cryptoToken - The TripleDESCryptoToken used to create the key.
key1 - The first DES key.
key2 - The second DES key.
Throws:
CryptoTokenException - Thrown when a problem occurs with the 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

TripleDESKey

public TripleDESKey(TripleDESCryptoToken cryptoToken,
                    DESKey key1,
                    DESKey key2,
                    DESKey key3)
             throws CryptoTokenException,
                    CryptoUnsupportedOperationException
Creates a key from three DES keys.

Parameters:
cryptoToken - The TripleDESCryptoToken used to create the key.
key1 - The first DES key.
key2 - The second DES key.
key3 - The third DES key.
Throws:
CryptoTokenException - Thrown when a problem occurs with the 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

TripleDESKey

public TripleDESKey(TripleDESCryptoToken cryptoToken,
                    CryptoTokenSymmetricKeyData cryptoTokenData)
Creates a TripleDESKey object.

Parameters:
cryptoToken - The cryptoToken used to create the key.
cryptoTokenData - The data associated with the cryptoToken.
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

getSymmetricCryptoToken

public SymmetricCryptoToken getSymmetricCryptoToken()
Returns the crypto token associated with this key.

Specified by:
getSymmetricCryptoToken in interface SymmetricKey
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

getTripleDESCryptoToken

public TripleDESCryptoToken getTripleDESCryptoToken()
Returns the crypto token associated with the key.

Returns:
The crypto token.
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

getCryptoTokenData

public CryptoTokenSymmetricKeyData getCryptoTokenData()
Returns the crypto token data associated with the key.

Returns:
The crypto token data.
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

getAlgorithm

public String getAlgorithm()
Returns a string containing the name of the algorithm associated with this key ("TripleDES").

This method will always return the String "TripleDES".

Specified by:
getAlgorithm in interface Key
Returns:
A String representing 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

getLength

public int getLength()
              throws CryptoTokenException,
                     CryptoUnsupportedOperationException
Description copied from interface: SymmetricKey
Returns the length of the key in bytes.

Specified by:
getLength in interface SymmetricKey
Returns:
An integer that represents the number of bytes.
Throws:
CryptoTokenException - Thrown when a problem 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

getBitLength

public int getBitLength()
                 throws CryptoTokenException,
                        CryptoUnsupportedOperationException
Returns the number of bits that make up the actual keying material ( for example parity bits aren't counted ). In the case of TripleDES, if this is 2-Key Triple DES, it will return 112 bits ( since the key is 128 bits long with 16 parity bits ) or if it is 3-Key Triple DES, it will return 168 bits ( since the key is 192 bits long with 24 parity bits ).

Specified by:
getBitLength in interface SymmetricKey
Returns:
An integer that represents the number of bits in the key ( in this case 112 or 168 ).
Throws:
CryptoTokenException - Thrown when a problem 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

getData

public byte[] getData()
               throws CryptoTokenException,
                      CryptoUnsupportedOperationException
Description copied from interface: SymmetricKey
Returns a copy of the byte array representing the key.

Specified by:
getData in interface SymmetricKey
Returns:
A byte array containing the key.
Throws:
CryptoTokenException - Thrown when a problem 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

hashCode

public int hashCode()
Description copied from class: Object
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), Hashtable
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

equals

public boolean equals(Object obj)
Description copied from class: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:
equals in class Object
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Boolean.hashCode(), Hashtable
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





Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.