net.rim.device.api.crypto
Interface Digest

All Known Implementing Classes:

MD2Digest, MD4Digest, MD5Digest, NullDigest, RIPEMD128Digest, RIPEMD160Digest, SHA1Digest, SHA224Digest, SHA256Digest, SHA384Digest, SHA512Digest

public interface Digest

Specifies the functionality common to all Digest algorithms.

A digest algorithm is a function which converts an arbitrarily long input data value to a fixed sized hash.

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 Summary
	String	getAlgorithm() Returns the name of this digest, for example "SHA1".
	int	getBlockLength() Returns the block length of the digest in bytes.
	byte[]	getDigest() Returns a byte array containing the digest of all the input data since the last reset.
	byte[]	getDigest(boolean resetDigest) Returns a byte array containing the digest of all the input data since the last reset.
	int	getDigest(byte[] buffer, int offset) Inserts the digest of all the input data since the last reset into the specified buffer at the given offset.
	int	getDigest(byte[] buffer, int offset, boolean resetDigest) Inserts the digest of all the input data since the last reset into the specified buffer at the given offset.
	int	getDigestLength() Returns the length of the digest in bytes.
	void	reset() Reinitializes the digest.
	void	update(byte[] data) Passes a byte array of data into the hash algorithm.
	void	update(byte[] data, int offset, int length) Passes a byte array of data, specified by the length and offset, into the hash algorithm.
	void	update(int data) Passes a single byte into the hash algorithm.

Method Detail

getAlgorithm

String getAlgorithm()

Returns the name of this digest, for example "SHA1".

Returns:

A String representing the name of the digest.

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

void reset()

Reinitializes the digest.

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

void update(int data)

Passes a single byte into the hash algorithm.

Parameters:

data - The byte to be hashed.

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

void update(byte[] data)

Passes a byte array of data into the hash algorithm.

Parameters:

data - The array containing the input data. The entire array is hashed.

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

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

Passes a byte array of data, specified by the length and offset, into the hash algorithm.

Parameters:

data - The array containing the input data.

offset - The offset of the input data.

length - The length of the 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

getDigestLength

int getDigestLength()

Returns the length of the digest in bytes.

Returns:

An integer representing the number of 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

getBlockLength

int getBlockLength()

Returns the block length of the digest in bytes.

Most digest algorithms are iterated hash functions, and thus process the input data in blocks. Some primitives, like HMAC are sensitive to this block length.

Returns:

An integer representing the block length.

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

getDigest

byte[] getDigest()

Returns a byte array containing the digest of all the input data since the last reset. The digest is then reset.

Returns:

A byte array containing the digest.

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

getDigest

byte[] getDigest(boolean resetDigest)

Returns a byte array containing the digest of all the input data since the last reset.

Parameters:

resetDigest - if true, then the digest is reset.

Returns:

A byte array containing the digest.

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

getDigest

int getDigest(byte[] buffer,
              int offset)

Inserts the digest of all the input data since the last reset into the specified buffer at the given offset. The digest is then reset.

Parameters:

buffer - The byte array to hold the digest data.

offset - The offset, or initial bit position, to store the data at within the array.

Returns:

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

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

getDigest

int getDigest(byte[] buffer,
              int offset,
              boolean resetDigest)

Inserts the digest of all the input data since the last reset into the specified buffer at the given offset.

Parameters:

buffer - The byte array to hold the digest data.

offset - The offset, or initial bit position, to store the data at within the array.

resetDigest - if true, then the digest is reset.

Returns:

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

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