net.rim.device.api.crypto.TripleDESKey
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public final class TripleDESKey
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.
| 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. |
|
|
TripleDESKey(TripleDESCryptoToken cryptoToken,
byte[] data,
int offset)
Creates a TripleDESKey object using as much of the given data as necessary. |
|
|
TripleDESKey(TripleDESCryptoToken cryptoToken,
CryptoTokenSymmetricKeyData cryptoTokenData)
Creates a TripleDESKey object. |
|
|
TripleDESKey(TripleDESCryptoToken cryptoToken,
DESKey key1,
DESKey key2)
Creates a key from two DES keys. |
|
|
TripleDESKey(TripleDESCryptoToken cryptoToken,
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 ). |
|
CryptoTokenSymmetricKeyData |
getCryptoTokenData()
Returns the crypto token data associated with the key. |
|
byte[] |
getData()
Returns a copy of the byte array representing the key. |
|
int |
getLength()
Returns the length of the key in bytes. |
|
SymmetricCryptoToken |
getSymmetricCryptoToken()
Returns the crypto token associated with this key. |
|
TripleDESCryptoToken |
getTripleDESCryptoToken()
Returns the crypto token associated with the key. |
|
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 |
|---|
public static final int LENGTH
| Constructor Detail |
|---|
public TripleDESKey()
TripleDESKey key.
public TripleDESKey(byte[] data)
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.
data - The byte array of bytes to be used as key data.
IllegalArgumentException - if data==null or if data.length is
less than 24, excluding 16.
public TripleDESKey(byte[] data,
int offset)
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.
data - The array of bytes to be used.offset - The starting location within the byte array.
IllegalArgumentException - if data==null, or if the specified offset is
invalid, or if data.length - offset is less than 24, excluding 16.
public TripleDESKey(TripleDESCryptoToken cryptoToken,
byte[] data,
int offset)
throws CryptoTokenException,
CryptoUnsupportedOperationException
TripleDESKey object using as much of the given data as necessary.
Note that the TripleDESKey can only be 16 or 24 bytes long.
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.
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.
public TripleDESKey(DESKey key1,
DESKey key2)
throws CryptoTokenException,
CryptoUnsupportedOperationException
DES keys. The first key is repeated as the third key.
key1 - The first DES key.key2 - The second DES key.
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.
public TripleDESKey(DESKey key1,
DESKey key2,
DESKey key3)
throws CryptoTokenException,
CryptoUnsupportedOperationException
DES keys.
key1 - The first DES key.key2 - The second DES key.key3 - The third DES key.
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.
public TripleDESKey(TripleDESCryptoToken cryptoToken,
DESKey key1,
DESKey key2)
throws CryptoTokenException,
CryptoUnsupportedOperationException
DES keys. The first key is repeated as the third key.
cryptoToken - The TripleDESCryptoToken used to create the key.key1 - The first DES key.key2 - The second DES key.
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.
public TripleDESKey(TripleDESCryptoToken cryptoToken,
DESKey key1,
DESKey key2,
DESKey key3)
throws CryptoTokenException,
CryptoUnsupportedOperationException
DES keys.
cryptoToken - The TripleDESCryptoToken used to create the key.key1 - The first DES key.key2 - The second DES key.key3 - The third DES key.
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.
public TripleDESKey(TripleDESCryptoToken cryptoToken,
CryptoTokenSymmetricKeyData cryptoTokenData)
TripleDESKey object.
cryptoToken - The cryptoToken used to create the key.cryptoTokenData - The data associated with the
cryptoToken.| Method Detail |
|---|
public SymmetricCryptoToken getSymmetricCryptoToken()
getSymmetricCryptoToken in interface SymmetricKeypublic TripleDESCryptoToken getTripleDESCryptoToken()
public CryptoTokenSymmetricKeyData getCryptoTokenData()
public String getAlgorithm()
This method will always return the String "TripleDES".
getAlgorithm in interface Key
public int getLength()
throws CryptoTokenException,
CryptoUnsupportedOperationException
SymmetricKey
getLength in interface SymmetricKeyCryptoTokenException - 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.
public int getBitLength()
throws CryptoTokenException,
CryptoUnsupportedOperationException
getBitLength in interface SymmetricKeyCryptoTokenException - 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.
public byte[] getData()
throws CryptoTokenException,
CryptoUnsupportedOperationException
SymmetricKey
getData in interface SymmetricKeyCryptoTokenException - 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.public int hashCode()
Objectjava.util.Hashtable.
The general contract of hashCode is:
hashCode method on each of
the two objects must produce the same integer result.
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 JavaTM programming language.)
hashCode in class ObjectObject.equals(java.lang.Object),
Hashtablepublic boolean equals(Object obj)
Object
The equals method implements an equivalence relation:
x,
x.equals(x) should return true.
x and
y, x.equals(y) should return
true if and only if y.equals(x) returns
true.
x,
y, and z, if x.equals(y)
returns true and y.equals(z) returns
true, then x.equals(z) should return
true.
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.
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).
equals in class Objectobj - the reference object with which to compare.
true if this object is the same as the obj
argument; false otherwise.Boolean.hashCode(),
Hashtable
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal