net.rim.device.api.crypto
Class CAST128Key

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

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. 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 size of the key represented in bytes, ie 16 bytes.
 
Constructor Summary
Category: Signed CAST128Key()
          Creates a new CAST128Key populating the key data with random information.
Category: Signed CAST128Key(byte[] data)
          Creates a new CAST128Key populating the key with 16 bytes or 128 bits of data from the array passed in.
Category: Signed 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.
Category: Signed 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.
Category: Signed 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
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 ("CAST128").
Category: Signed  int getBitLength()
          Returns the number of bits that make up the actual keying material ( for example parity bits are not counted ).
Category: Signed  CAST128CryptoToken getCAST128CryptoToken()
          Returns the crypto token.
Category: Signed  CryptoTokenSymmetricKeyData getCryptoTokenData()
          Returns the crypto token data.
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  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 size of the key represented in bytes, ie 16 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

CAST128Key

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

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

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

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

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

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

getCAST128CryptoToken

public CAST128CryptoToken getCAST128CryptoToken()
Returns the crypto token.

Returns:
A CAST128CryptoToken object representing 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.

Returns:
Returns the crypto token symmetric key 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 ("CAST128").

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
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.
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
Description copied from interface: SymmetricKey
Returns the number of bits that make up the actual keying material ( for example parity bits are not counted ).

Specified by:
getBitLength in interface SymmetricKey
Returns:
An integer that represents the number of bits in the key.
Throws:
CryptoTokenException - Thrown when a problem occurs with a crypto token or the crypto token is invalid.
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.