SHOW Signed SHOW CryptoExtensionAPI

net.rim.device.api.crypto
Class CAST128Key

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

All Implemented Interfaces:

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

public final class CAST128Key

extends Object

implements SymmetricKey, Persistable

Represents a CAST128 key. The CAST algorithm was designed by Carlisle Adams and Stafford Tavares. This version of CAST has a 128 bit key and a 64 bit block size.

This cipher is available worldwide on a royalty-free basis for commercial and non-commercial use.

For more information please refer to RFC 2144.

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.

Since:

JDE 3.6.0

Field Summary

static int

LENGTH The size of the key represented in bytes, ie 16 bytes.

Constructor Summary

	CAST128Key() Creates a new CAST128Key populating the key data with random information.
	CAST128Key(byte[] data) Creates a new CAST128Key populating the key with 16 bytes or 128 bits of data from the array passed in.
	CAST128Key(byte[] data, int offset) Creates a new CAST128Key populating the key with 16 bytes or 128 bits of data from the array passed in.
	CAST128Key(CAST128CryptoToken cryptoToken, byte[] data, int offset) Creates a new CAST128Key populating the key with 16 bytes or 128 bits of data from the array passed in.
	CAST128Key(CAST128CryptoToken cryptoToken, CryptoTokenSymmetricKeyData cryptoTokenData) Creates a new CAST128Key populating the key with 16 bytes or 128 bits of data from the array passed in.

Method Summary

	boolean	equals(Object obj)
	String	getAlgorithm() Returns a string containing the name of the algorithm associated with this key ("CAST128").
	int	getBitLength()
	CAST128CryptoToken	getCAST128CryptoToken() Returns the crypto token.
	CryptoTokenSymmetricKeyData	getCryptoTokenData() Returns the crypto token data.
	byte[]	getData()
	int	getLength()
	SymmetricCryptoToken	getSymmetricCryptoToken() Returns the crypto token associated with this key.
	int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

LENGTH

public static final int LENGTH

The size of the key represented in bytes, ie 16 bytes.

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.

Constructor Detail

CAST128Key

public CAST128Key()

Creates a new CAST128Key populating the key data with random information.

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.

CAST128Key

public CAST128Key(byte[] data)

Creates a new CAST128Key populating the key with 16 bytes or 128 bits of data from the array passed in.

Parameters:

data - the data to be used for the key data of this key.

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.

CAST128Key

public CAST128Key(byte[] data,
                  int offset)

Creates a new CAST128Key populating the key with 16 bytes or 128 bits of data from the array passed in.

Parameters:

data - the data to be used for the key data of this key.

offset - the starting location within data for the key data.

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.

CAST128Key

public CAST128Key(CAST128CryptoToken cryptoToken,
                  byte[] data,
                  int offset)
           throws CryptoTokenException,
                  CryptoUnsupportedOperationException

Creates a new CAST128Key populating the key with 16 bytes or 128 bits of data from the array passed in.

Parameters:

cryptoToken - The crypto token.

data - The data to be used for the key data of this key.

offset - The starting location within data for the key data.

Throws:

CryptoTokenException - Thrown if an error occurs with the crypto token or if the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown if an unsupported operation is called.

Since:

JDE 3.6.0

Category:

CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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.

CAST128Key

public CAST128Key(CAST128CryptoToken cryptoToken,
                  CryptoTokenSymmetricKeyData cryptoTokenData)

Creates a new CAST128Key populating the key with 16 bytes or 128 bits of data from the array passed in.

Parameters:

cryptoToken - The crypto token.

cryptoTokenData - The data for this crypto token.

Since:

JDE 3.6.0

Category:

CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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

getSymmetricCryptoToken

public SymmetricCryptoToken getSymmetricCryptoToken()

Returns the crypto token associated with this key.

Since:

JDE 3.6.0

Category:

CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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.

getCAST128CryptoToken

public CAST128CryptoToken getCAST128CryptoToken()

Returns the crypto token.

Returns:

A CAST128CryptoToken object representing the crypto token.

Since:

JDE 3.6.0

Category:

CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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.

getCryptoTokenData

public CryptoTokenSymmetricKeyData getCryptoTokenData()

Returns the crypto token data.

Returns:

Returns the crypto token symmetric key data.

Since:

JDE 3.6.0

Category:

CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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.

getAlgorithm

public String getAlgorithm()

Returns a string containing the name of the algorithm associated with this key ("CAST128").

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.

getLength

public int getLength()
              throws CryptoTokenException

Description copied from interface: SymmetricKey

Returns the length of the key in bytes.

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.

getBitLength

public int getBitLength()
                 throws CryptoTokenException

Description copied from interface: SymmetricKey

Returns the number of bits that make up the actual keying material ( for example parity bits are not counted ).

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.

getData

public byte[] getData()
               throws CryptoTokenException,
                      CryptoUnsupportedOperationException

Description copied from interface: SymmetricKey

Returns a copy of the byte array representing the key.

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.

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

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.

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.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.