SHOW Signed

net.rim.device.api.crypto
Class TripleDESKey

java.lang.Object
  |
  +--net.rim.device.api.crypto.TripleDESKey

All Implemented Interfaces:

Key, Persistable, net.rim.vm.Persistable, SymmetricKey

public final class TripleDESKey

extends Object

implements SymmetricKey, Persistable

Creates a TripleDESKey object.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Field Summary

static int

LENGTH The number of key bytes required, ie 24 bytes.

Constructor Summary

	TripleDESKey() Creates a new random TripleDESKey key.
	TripleDESKey(byte[] data) Creates a new TripleDESKey object using as much of the given data as necessary.
	TripleDESKey(byte[] data, int offset) Creates a TripleDESKey object using as much of the given data as necessary.
	TripleDESKey(DESKey key1, DESKey key2) Creates a key from two DES keys.
	TripleDESKey(DESKey key1, DESKey key2, DESKey key3) Creates a key from three DES keys.

Method Summary

	boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
	String	getAlgorithm() Returns a string containing the name of the algorithm associated with this key ("TripleDES").
	int	getBitLength() Returns the number of bits that make up the actual keying material ( for example parity bits aren't counted ).
	byte[]	getData() Returns a copy of the byte array representing the key.
	int	getLength() Returns the length of the key in bytes.
	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.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Constructor Detail

TripleDESKey

public TripleDESKey()

Creates a new random TripleDESKey key.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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 repreated for the last 8 bytes.

Parameters:

data - The byte array of bytes to be used as key data.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

TripleDESKey

public TripleDESKey(byte[] data,
                    int offset)

Creates a TripleDESKey object using as much of the given data as necessary.

Parameters:

data - The array of bytes to be used.

offset - The starting location within the byte array.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Method Detail

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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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

Following copied from interface: net.rim.device.api.crypto.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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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

Following copied from interface: net.rim.device.api.crypto.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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

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 Java^TM programming language.)

Overrides:

hashCode in class Object

Following copied from class: java.lang.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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified.
• For any non-null reference value x, x.equals(null) should return false.

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

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.