This class contains the necessary information for a developer or a user or
an interested IT person to determine and specify the ciphersuites that are
to be used with a specific connection or that are supposed to be used in
general with all connections.
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.
TDES_CBC_EDE
Represents triple DES (EDE) in CBC mode.
Method Summary
static void
addEncryptionAlgorithm(byte algorithm,
int priority)
Add an encryption algorithm with the specified priority.
static void
addKeyExchangeAlgorithm(byte[] algorithm,
int priority)
Add a key exchange algorithm with the specified priority.
static void
addMACAlgorithm(byte algorithm,
int priority)
Add a MAC algorithm with the specified priority.
static boolean
export(byte cipher)
This method checks to see if the encryption algorithm passed into this method
is considered to be of export strength.
static byte[]
getDefaultEncryptionAlgorithms()
This method returns the default algorithms with
their default priority keeping the security of the
ciphersuites in mind at all times.
static byte[][]
getDefaultKeyExchangeAlgorithms()
This method returns the default MAC Algorithms with
their default priority keeping the security of the
ciphersuites in mind at all times.
static byte[]
getDefaultMACAlgorithms()
This method returns the default MAC Algorithms with
their default priority keeping the security of the
ciphersuites in mind at all times.
static byte[]
getEncryptionPriority()
This method returns the array of ciphersuites currently stored
with their appropriate priority (first in the array has most
priority).
static byte[][]
getKeyExchangePriority()
This method returns the array of key exchanges currently stored
with their appropriate priority (first in the array has most
priority).
static byte[]
getMACPriority()
This method returns the array of MACs currently stored
with their appropriate priority (first in the array has most
priority).
static byte[]
getSupportedEncryptionAlgorithms()
Returns a byte array comprising of the supported
encryption algorithms for the WTLS implementation on the RIM
device.
getSupportedKeyExchangeAlgorithms()
Returns a byte array comprising of the supported
Key Exchange algorithms for the WTLS implementation on the RIM
device.
static byte[]
getSupportedMACAlgorithms()
Returns a byte array comprising of the supported
MAC algorithms for the WTLS implementation on the RIM
device.
prioritizeEncryptionAlgorithms(byte higher,
byte lower)
This method ensures that the ciphersuite passed in as higher
will be higher than the ciphersuite passed in as lower.
static void
prioritizeKeyExchangeAlgorithms(byte[] higher,
byte[] lower)
This method ensures that the kex algorithm passed in as higher
will be higher than the kex algorithm passed in as lower.
static void
prioritizeMACAlgorithms(byte higher,
byte lower)
This method ensures that the mac algorithm passed in as higher
will be higher than the mac algorithm passed in as lower.
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.
DES_CBC_40
public static final byte DES_CBC_40
Represents 40 bit DES encryption in CBC mode.
Since:
JDE 3.6.0
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.
IDEA_CBC
public static final byte IDEA_CBC
Represents IDEA encryption in CBC mode.
Since:
JDE 3.6.0
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.
IDEA_CBC_40
public static final byte IDEA_CBC_40
Represents 40 bit IDEA encryption in CBC mode.
Since:
JDE 3.6.0
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.
IDEA_CBC_56
public static final byte IDEA_CBC_56
Represents 56 bit IDEA encryption in CBC mode.
Since:
JDE 3.6.0
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.
IDEA_CBC_64
public static final byte IDEA_CBC_64
Represents 64 bit IDEA encryption in CBC mode.
Since:
JDE 3.6.0
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.
MD5
public static final byte MD5
Represents the MD5 MAC algorithm.
Since:
JDE 3.6.0
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.
MD5_40
public static final byte MD5_40
Represents the 40 bit MD5 MAC algorithm.
Since:
JDE 3.6.0
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.
MD5_80
public static final byte MD5_80
Represents the 80 bit MD5 MAC algorithm.
Since:
JDE 3.6.0
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.
NULL
public static final byte NULL
Represents Null.
Since:
JDE 3.6.0
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.
RC5_CBC
public static final byte RC5_CBC
Represents RC5 encryption in CBC mode.
Since:
JDE 3.6.0
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.
RC5_CBC_40
public static final byte RC5_CBC_40
Represents 40 bit RC5 encryption in CBC mode.
Since:
JDE 3.6.0
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.
RC5_CBC_56
public static final byte RC5_CBC_56
Represents 56 bit RC5 encryption in CBC mode.
Since:
JDE 3.6.0
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.
RC5_CBC_64
public static final byte RC5_CBC_64
Represents 64 bit RC5 encryption in CBC mode.
Since:
JDE 3.6.0
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.
SHA
public static final byte SHA
Respresents the SHA MAC algorithm.
Since:
JDE 3.6.0
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.
SHA_0
public static final byte SHA_0
Represents the SHA-0 MAC algorithm.
Since:
JDE 3.6.0
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.
SHA_40
public static final byte SHA_40
Represents the 40 bit SHA MAC algorithm.
Since:
JDE 3.6.0
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.
SHA_80
public static final byte SHA_80
Represents the 80 bit SHA MAC algorithm.
Since:
JDE 3.6.0
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.
TDES_CBC_EDE
public static final byte TDES_CBC_EDE
Represents triple DES (EDE) in CBC mode.
Since:
JDE 3.6.0
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
addEncryptionAlgorithm
public static void addEncryptionAlgorithm(byte algorithm,
int priority)
Add an encryption algorithm with the specified priority.
Priority
is a location in an array so to speak and hence the lower
index in the array the more priority. If you want to place
the element at the end of the array then pass in priority
less than zero.
Parameters:
algorithm - A byte representing the algorithm to add.
priority - An integer specifying the priority.
Since:
JDE 3.6.0
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.
addKeyExchangeAlgorithm
public static void addKeyExchangeAlgorithm(byte[] algorithm,
int priority)
Add a key exchange algorithm with the specified priority.
Priority
is a location in an array so to speak and hence the lower
index in the array the more priority. If you want to place
the element at the end of the array then pass in priority
less than zero.
Parameters:
algorithm - A byte representing the key exchange algorithm to add.
priority - An integer specifying the priority.
Since:
JDE 3.6.0
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.
addMACAlgorithm
public static void addMACAlgorithm(byte algorithm,
int priority)
Add a MAC algorithm with the specified priority. Priority
is a location in an array so to speak and hence the lower
index in the array the more priority. If you want to place
the element at the end of the array then pass in priority
less than zero.
Parameters:
algorithm - A byte representing the MAC algorithm to add.
priority - An integer specifying the priority.
Since:
JDE 3.6.0
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.
export
public static boolean export(byte cipher)
This method checks to see if the encryption algorithm passed into this method
is considered to be of export strength. If so, it returns true and false
otherwise. It will return false if the algorithm is not supported.
Parameters:
cipher - A byte representing the encryption algorithm to check.
Returns:
A boolean that indicates if the cipher suite is of export quality.
Since:
JDE 3.6.0
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.
getDefaultEncryptionAlgorithms
public static byte[] getDefaultEncryptionAlgorithms()
This method returns the default algorithms with
their default priority keeping the security of the
ciphersuites in mind at all times.
Returns:
A byte array containing the names of the default encryption algorithms.
Since:
JDE 3.6.0
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.
getDefaultKeyExchangeAlgorithms
public static byte[][] getDefaultKeyExchangeAlgorithms()
This method returns the default MAC Algorithms with
their default priority keeping the security of the
ciphersuites in mind at all times.
Returns:
A byte array containing the names of the default key exchange algorithms.
Since:
JDE 3.6.0
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.
getDefaultMACAlgorithms
public static byte[] getDefaultMACAlgorithms()
This method returns the default MAC Algorithms with
their default priority keeping the security of the
ciphersuites in mind at all times.
Returns:
A byte array containing the names of the default MAC algorithms.
Since:
JDE 3.6.0
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.
getEncryptionPriority
public static byte[] getEncryptionPriority()
This method returns the array of ciphersuites currently stored
with their appropriate priority (first in the array has most
priority).
Returns:
A byte array containing the priority.
Since:
JDE 3.6.0
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.
getKeyExchangePriority
public static byte[][] getKeyExchangePriority()
This method returns the array of key exchanges currently stored
with their appropriate priority (first in the array has most
priority).
Returns:
A byte array containing the priority.
Since:
JDE 3.6.0
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.
getMACPriority
public static byte[] getMACPriority()
This method returns the array of MACs currently stored
with their appropriate priority (first in the array has most
priority).
Returns:
A byte array containing the priority.
Since:
JDE 3.6.0
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.
getSupportedEncryptionAlgorithms
public static byte[] getSupportedEncryptionAlgorithms()
Returns a byte array comprising of the supported
encryption algorithms for the WTLS implementation on the RIM
device.
Returns:
A byte array containing the names of all supported encryption algorithms.
Since:
JDE 3.6.0
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.
getSupportedExportEncryptionAlgorithms
public static byte[] getSupportedExportEncryptionAlgorithms()
Returns a copy of the supported export encryption algorithms
for the WTLS implementation on the RIM device.
Returns:
A byte array containing the names of all supported export encryption algorithms.
Since:
JDE 3.6.0
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.
getSupportedKeyExchangeAlgorithms
public static byte[][] getSupportedKeyExchangeAlgorithms()
Returns a byte array comprising of the supported
Key Exchange algorithms for the WTLS implementation on the RIM
device.
Returns:
A byte array containing the names of all supported key exchange algorithms.
Since:
JDE 3.6.0
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.
getSupportedMACAlgorithms
public static byte[] getSupportedMACAlgorithms()
Returns a byte array comprising of the supported
MAC algorithms for the WTLS implementation on the RIM
device.
Returns:
A byte array containing the names of all supported MAC algorithms.
Since:
JDE 3.6.0
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.
getSupportedNonExportEncryptionAlgorithms
public static byte[] getSupportedNonExportEncryptionAlgorithms()
Returns a copy of the supported non-export encryption algorithms
for the WTLS implementation on the RIM device.
Returns:
A byte array containing the names of all non-supported export encryption algorithms.
Since:
JDE 3.6.0
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.
prioritizeEncryptionAlgorithms
public static void prioritizeEncryptionAlgorithms(byte higher,
byte lower)
This method ensures that the ciphersuite passed in as higher
will be higher than the ciphersuite passed in as lower.
If higher already has a higher priority then this method
does not change anything. If higher has a lower priority
then it is placed directly above the lower priority ciphersuite.
If one of higher or lower is not contained in the container then nothing is
changed.
Parameters:
higher - An integer representing the upper bound.
lower - An integer repreenting the lower bound.
Since:
JDE 3.6.0
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.
prioritizeKeyExchangeAlgorithms
public static void prioritizeKeyExchangeAlgorithms(byte[] higher,
byte[] lower)
This method ensures that the kex algorithm passed in as higher
will be higher than the kex algorithm passed in as lower.
If higher already has a higher priority then this method
does not change anything. If higher has a lower priority
then it is placed directly above the lower priority kex algorithm.
If one of higher or lower is not contained in the container then nothing is
changed.
Parameters:
higher - An integer representing the upper bound.
lower - An integer repreenting the lower bound.
Since:
JDE 3.6.0
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.
prioritizeMACAlgorithms
public static void prioritizeMACAlgorithms(byte higher,
byte lower)
This method ensures that the mac algorithm passed in as higher
will be higher than the mac algorithm passed in as lower.
If higher already has a higher priority then this method
does not change anything. If higher has a lower priority
then it is placed directly above the lower priority mac algorithm.
If one of higher or lower is not contained in the container then nothing is
changed.
Parameters:
higher - An integer representing the upper bound.
lower - An integer repreenting the lower bound.
Since:
JDE 3.6.0
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.
removeAllEncryptionAlgorithms
public static void removeAllEncryptionAlgorithms()
This class removes all the encryption algorithms stored in the storage.
Since:
JDE 3.6.0
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.
removeAllKeyExchangeAlgorithms
public static void removeAllKeyExchangeAlgorithms()
This class removes all the keyex algorithms stored in the storage.
Since:
JDE 3.6.0
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.
removeAllMACAlgorithms
public static void removeAllMACAlgorithms()
This class removes all the mac algorithms stored in the storage.
Since:
JDE 3.6.0
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.
removeEncryptionAlgorithm
public static void removeEncryptionAlgorithm(byte algorithm)
Removes the specified encryption algorithm from the priority list.
Parameters:
algorithm - A byte representing the algorithm to remove.
Since:
JDE 3.6.0
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.
removeKeyExchangeAlgorithm
public static void removeKeyExchangeAlgorithm(byte[] algorithm)
Removes the specified KeyX algorithm from the priority list.
Parameters:
algorithm - The key exchange algorithm to remove.
Since:
JDE 3.6.0
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.
removeMACAlgorithm
public static void removeMACAlgorithm(byte algorithm)
Removes the specified MAC algorithm from the priority list.
Parameters:
algorithm - A byte representing the MAC algorithm to remove.
Since:
JDE 3.6.0
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.
Copyright 1999-2007 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.