SHOW Signed

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.

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

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

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.

Method Detail

getAlgorithm

public String getAlgorithm()

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

Specified by:

getAlgorithm in interface MAC

Overrides:

getAlgorithm in class AbstractMAC

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.

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

Overrides:

reset in class AbstractMAC

Throws:

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

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

Returns the length of the HMAC in bytes.

Specified by:

getLength in interface MAC

Overrides:

getLength in class AbstractMAC

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.

update

public void update(int data)

Description copied from interface: MAC

Feeds more data into the MAC algorithm.

Specified by:

update in interface MAC

Overrides:

update in class AbstractMAC

Since:

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

update

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

Description copied from interface: MAC

Feeds more data into the MAC algorithm.

Specified by:

update in interface MAC

Overrides:

update in class AbstractMAC

Since:

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

getMAC

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

Description copied from interface: MAC

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

Overrides:

getMAC in class AbstractMAC

Throws:

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

Since:

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