net.rim.device.api.crypto
Class HMAC

java.lang.Object
  net.rim.device.api.crypto.AbstractMAC
      net.rim.device.api.crypto.HMAC

All Implemented Interfaces:

MAC

public final class HMAC
extends AbstractMAC
implements MAC

HMAC is a Message Authentication Code algorithm based on a Digest function. HMAC is defined in RFC 2104. 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

Constructor Summary
	HMAC(HMACKey key, Digest digest) Creates an instance of the HMAC object with a given key as the MAC key, using a specified digest as the hash function.

Method Summary
	String	getAlgorithm() Returns the name of this digest, ie "HMAC/" + Digest.getAlgorithm().
	int	getLength() Returns the length of the HMAC in bytes.
	int	getMAC(byte[] buffer, int offset, boolean reset) Puts the MAC of all the input data since the last reset into the given buffer starting at the specified offset.
	void	reset() Resets the hashing of the HMAC.
	void	update(byte[] data, int offset, int length) Feeds more data into the MAC algorithm.
	void	update(int data) Feeds more data into the MAC algorithm.

Methods inherited from class net.rim.device.api.crypto.AbstractMAC

checkMAC, checkMAC, checkMAC, checkMAC, getMAC, getMAC, getMAC, update

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.rim.device.api.crypto.MAC

checkMAC, checkMAC, checkMAC, checkMAC, getMAC, getMAC, getMAC, update

Constructor Detail

HMAC

public HMAC(HMACKey key,
            Digest digest)
     throws CryptoTokenException,
            CryptoUnsupportedOperationException

Creates an instance of the HMAC object with a given key as the MAC key, using a specified digest as the hash function.

Parameters:

key - The HMAC key to use with this instance.

digest - The hash function to use with this instance.

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

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of this digest, ie "HMAC/" + Digest.getAlgorithm().

Specified by:

getAlgorithm in interface MAC

Specified by:

getAlgorithm in class AbstractMAC

Returns:

A String representing the name of the digest or cipher.

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()
           throws CryptoTokenException

Resets the hashing of the HMAC.

This method resets the underlying digest and then updates that digest with the inner pad.

Specified by:

reset in interface MAC

Specified by:

reset in class AbstractMAC

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

getLength

public int getLength()

Returns the length of the HMAC in bytes.

Specified by:

getLength in interface MAC

Specified by:

getLength in class AbstractMAC

Returns:

An integer that represents the length of the MAC.

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

update

public void update(int data)

Description copied from class: AbstractMAC

Feeds more data into the MAC algorithm.

Specified by:

update in interface MAC

Overrides:

update in class AbstractMAC

Parameters:

data - A byte of input 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

update

public void update(byte[] data,
                   int offset,
                   int length)

Description copied from class: AbstractMAC

Feeds more data into the MAC algorithm.

Specified by:

update in interface MAC

Specified by:

update in class AbstractMAC

Parameters:

data - The array containing the input data.

offset - The offset, or initial position, of the data within the array.

length - The length of the input data, in bytes.

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(byte[] buffer,
                  int offset,
                  boolean reset)
           throws CryptoTokenException

Description copied from class: AbstractMAC

Puts the MAC of all the input data since the last reset into the given buffer starting at the specified offset. The MAC is then reset.

Specified by:

getMAC in interface MAC

Specified by:

getMAC in class AbstractMAC

Parameters:

buffer - The array to contain the MAC.

offset - The offset, or initial position, of teh MAC data within the buffer.

reset - If true then the MAC is reset.

Returns:

An integer representing the number of bytes written to the buffer.

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