RC5CryptoToken (BlackBerry JDE 7.1.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.device.api.crypto
Class RC5CryptoToken

java.lang.Object
  net.rim.device.api.crypto.RC5CryptoToken

All Implemented Interfaces:: CryptoToken, SymmetricCryptoToken, Persistable

public abstract class RC5CryptoToken
extends Object
implements SymmetricCryptoToken, Persistable
extends Object
implements SymmetricCryptoToken, Persistable

Represents an RC5 crypto token.

Note: This class must be extended in order to override the default implementation.

Note: It is considered good practice to implement the equals and hashCode methods when extending this class. Otherwise, odd behaviour can occur.

Details on implementing for smart cards.

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 Summary
	`protected`	`RC5CryptoToken()` Creates a new `RC5CryptoToken` object.

Method Summary
	`CryptoTokenSymmetricKeyData`	`createKey(int bitLength)` Creates a new key.
	`void`	`decrypt(CryptoTokenCipherContext context, byte[] ciphertext, int ciphertextOffset, byte[] plaintext, int plaintextOffset)` Decrypts data given an array of plaintext and a context.
	`void`	`deleteKey(CryptoTokenSymmetricKeyData data)` Delete the specified key on the crypto token.
	`void`	`encrypt(CryptoTokenCipherContext context, byte[] plaintext, int plaintextOffset, byte[] ciphertext, int ciphertextOffset)` Encrypts data given an array of plaintext and a context.
	`byte[]`	`extractKeyData(CryptoTokenSymmetricKeyData data)` Extracts the key data from the crypto token and returns it in a byte array.
	`int`	`extractKeyDataLength(CryptoTokenSymmetricKeyData data)` Returns an integer representing the length of the key.
	`String`	`getAlgorithm()` Returns the algorithm supported by this token, ie "RC5".
	`CryptoTokenCipherContext`	`initializeDecrypt(CryptoTokenSymmetricKeyData data, int blockLength, int numberOfRounds)` Initializes the crypto token for decryption.
	`CryptoTokenCipherContext`	`initializeEncrypt(CryptoTokenSymmetricKeyData data, int blockLength, int numberOfRounds)` Initializes the crypto token for encryption.
	`CryptoTokenSymmetricKeyData`	`injectKey(byte[] key, int offset, int bitLength)` Inserts the specified key onto the crypto token.
	`boolean`	`providesUserAuthentication()` Returns true if the token provides its own user authentication checks, eg a smartcard will prompt for a password before allowing access to the keys.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

RC5CryptoToken

protected RC5CryptoToken()

Creates a new RC5CryptoToken object.

This constructor is not used.

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

getAlgorithm

public final String getAlgorithm()

Returns the algorithm supported by this token, ie "RC5".

Specified by:: getAlgorithm in interface CryptoToken

Returns:: A String that represents 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

providesUserAuthentication

public boolean providesUserAuthentication()

Returns true if the token provides its own user authentication checks, eg a smartcard will prompt for a password before allowing access to the keys. This default implementation returns false.

Specified by:: providesUserAuthentication in interface CryptoToken

Returns:: true if the user will be authenticated by the token itself.
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

initializeEncrypt

public CryptoTokenCipherContext initializeEncrypt(CryptoTokenSymmetricKeyData data,
                                                  int blockLength,
                                                  int numberOfRounds)
                                           throws CryptoTokenException,
                                                  CryptoUnsupportedOperationException

Initializes the crypto token for encryption.

Parameters:: data - The symmetric key data used to encrypt the plaintext.; blockLength - The block length of the cipher.; numberOfRounds - The number of rounds used when encrypting the data.
Returns:: The crypto token cipher context.
Throws:: CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.; CryptoUnsupportedOperationException - Thrown if 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

encrypt

public void encrypt(CryptoTokenCipherContext context,
                    byte[] plaintext,
                    int plaintextOffset,
                    byte[] ciphertext,
                    int ciphertextOffset)
             throws CryptoTokenException

Encrypts data given an array of plaintext and a context.

Parameters:: context - The cipher context.; plaintext - A byte array containing the plaintext.; plaintextOffset - The offset, or initial position, of the plaintext data within the array.; ciphertext - A byte array containing the ciphertext.; ciphertextOffset - The offset, or initial position, of the ciphertext within the array.
Throws:: CryptoTokenException - Thrown if an error 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

initializeDecrypt

public CryptoTokenCipherContext initializeDecrypt(CryptoTokenSymmetricKeyData data,
                                                  int blockLength,
                                                  int numberOfRounds)
                                           throws CryptoTokenException,
                                                  CryptoUnsupportedOperationException

Initializes the crypto token for decryption.

Parameters:: data - The symmetric key data used to encrypt the plaintext.; blockLength - The block length of the cipher.; numberOfRounds - The number of rounds used when encrypting the data.
Returns:: The crypto token cipher context.
Throws:: CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.; CryptoUnsupportedOperationException - Thrown if 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

decrypt

public void decrypt(CryptoTokenCipherContext context,
                    byte[] ciphertext,
                    int ciphertextOffset,
                    byte[] plaintext,
                    int plaintextOffset)
             throws CryptoTokenException

Decrypts data given an array of plaintext and a context.

Parameters:: context - The cipher context.; ciphertext - A byte array containing the ciphertext.; ciphertextOffset - The offset, or initial position, of the ciphertext within the array.; plaintext - A byte array to contain the plaintext.; plaintextOffset - The offset, or initial position, of the plaintext data within the array.
Throws:: CryptoTokenException - Thrown if an error 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

extractKeyDataLength

public int extractKeyDataLength(CryptoTokenSymmetricKeyData data)
                         throws CryptoTokenException,
                                CryptoUnsupportedOperationException

Returns an integer representing the length of the key.

Parameters:: data - The symmetric key data.
Returns:: An integer representing the key length.
Throws:: CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.; CryptoUnsupportedOperationException - Thrown if 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

extractKeyData

public byte[] extractKeyData(CryptoTokenSymmetricKeyData data)
                      throws CryptoTokenException,
                             CryptoUnsupportedOperationException

Extracts the key data from the crypto token and returns it in a byte array.

Parameters:: data - The symmetric key data contained within the token.
Returns:: A byte array containing the key data.
Throws:: CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.; CryptoUnsupportedOperationException - Thrown if 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

createKey

public CryptoTokenSymmetricKeyData createKey(int bitLength)
                                      throws CryptoTokenException,
                                             CryptoUnsupportedOperationException

Creates a new key.

Parameters:: bitLength - The length of the key in bits.
Returns:: The symmetric key.
Throws:: CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.; CryptoUnsupportedOperationException - Thrown if 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

injectKey

public CryptoTokenSymmetricKeyData injectKey(byte[] key,
                                             int offset,
                                             int bitLength)
                                      throws CryptoTokenException,
                                             CryptoUnsupportedOperationException

Inserts the specified key onto the crypto token.

Parameters:: key - A byte array containing the key data to be injected.; offset - The offset, or start position, of the key data within the array.; bitLength - The length of the key in bits.
Returns:: The symmetric key data.
Throws:: CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.; CryptoUnsupportedOperationException - Thrown if 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

deleteKey

public void deleteKey(CryptoTokenSymmetricKeyData data)
               throws CryptoTokenException,
                      CryptoUnsupportedOperationException

Delete the specified key on the crypto token.

Parameters:: data - The symmetric key data contained within the token.
Throws:: CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.; CryptoUnsupportedOperationException - Thrown if 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