HMACCryptoToken (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 HMACCryptoToken

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

All Implemented Interfaces:: CryptoToken, SymmetricCryptoToken, Persistable

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

Implements the HMAC 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.

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

Method Summary
	`CryptoTokenMACKeyData`	`createKey(int length)` Creates a key of a specified length on the crypto token.
	`void`	`deleteKey(CryptoTokenMACKeyData data)` Delete the specified key on the crypto token.
	`byte[]`	`extractKeyData(CryptoTokenMACKeyData cryptoTokenData)` Returns the key data contained in the crypto token.
	`int`	`extractKeyLength(CryptoTokenMACKeyData cryptoTokenData)` Returns the key length of the crypto token.
	`String`	`getAlgorithm()` Returns the algorithm supported by this token, ie "HMAC".
	`int`	`getMAC(CryptoTokenMACContext context, byte[] buffer, int offset, boolean reset)` Returns the Message Authetication Code (MAC) associated with the crypto token.
	`CryptoTokenMACContext`	`initialize(CryptoTokenMACKeyData keyData, Digest digest)` Initializes the crypto token.
	`CryptoTokenMACKeyData`	`injectKey(byte[] key, int offset, int length)` Injects the specified raw key data into 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.
	`void`	`reset(CryptoTokenMACContext context)` Resets the crypto token.

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

Constructor Detail

HMACCryptoToken

protected HMACCryptoToken()

Creates a new HMACCryptoToken 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 "HMAC".

This method will always return the String "HMAC".

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

extractKeyLength

public int extractKeyLength(CryptoTokenMACKeyData cryptoTokenData)
                     throws CryptoUnsupportedOperationException,
                            CryptoTokenException

Returns the key length of the crypto token.

Parameters:: cryptoTokenData - The data associated with the crypto token.
Returns:: An integer that represents the length of the key.
Throws:: CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.; 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

extractKeyData

public byte[] extractKeyData(CryptoTokenMACKeyData cryptoTokenData)
                      throws CryptoUnsupportedOperationException,
                             CryptoTokenException

Returns the key data contained in the crypto token.

Parameters:: cryptoTokenData - The data associated with the crypto token.
Returns:: An integer that represents the length of the key.
Throws:: CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.; 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

initialize

public CryptoTokenMACContext initialize(CryptoTokenMACKeyData keyData,
                                        Digest digest)
                                 throws CryptoUnsupportedOperationException,
                                        CryptoTokenException

Initializes the crypto token.

Parameters:: keyData - The key data associated with the crypto token.; digest - The digest used to initialize the crypto token.
Returns:: The CryptoTokenMACContext object.
Throws:: CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.; 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

reset

public void reset(CryptoTokenMACContext context)
           throws CryptoTokenException

Resets the crypto token.

Parameters:: context - The context of the crypto token.
Throws:: CryptoTokenException - Thrown if an error occurs with the 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

getMAC

public int getMAC(CryptoTokenMACContext context,
                  byte[] buffer,
                  int offset,
                  boolean reset)
           throws CryptoTokenException

Returns the Message Authetication Code (MAC) associated with the crypto token.

Parameters:: context - The context of the crypto token.; buffer - The byte array to contain the MAC.; offset - The offset, or start position, of the MAC data within the array.
Returns:: An integer representing the code.
Throws:: CryptoTokenException - Thrown if an error occurs with the 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

createKey

public CryptoTokenMACKeyData createKey(int length)
                                throws CryptoUnsupportedOperationException,
                                       CryptoTokenException

Creates a key of a specified length on the crypto token.

Parameters:: length - An integer that represents the length of the key, in bytes.
Returns:: The CryptoTokenMACKeyData object associated with the crypto token.
Throws:: CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.; 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

injectKey

public CryptoTokenMACKeyData injectKey(byte[] key,
                                       int offset,
                                       int length)
                                throws CryptoUnsupportedOperationException,
                                       CryptoTokenException

Injects the specified raw key data into the crypto token.

Parameters:: key - A byte array containing the key.; offset - The offset, or start position, of the key within the array.; length - The length of the key, in bytes.
Returns:: The crypto token MAC key data.
Throws:: CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.; 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

deleteKey

public void deleteKey(CryptoTokenMACKeyData data)
               throws CryptoTokenException,
                      CryptoUnsupportedOperationException

Delete the specified key on the crypto token.

Parameters:: data - The 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