net.rim.device.api.crypto
Class SHA1Digest

java.lang.Object
  net.rim.device.api.crypto.AbstractDigest
      net.rim.device.api.crypto.SHA1Digest

All Implemented Interfaces:

Digest

public final class SHA1Digest
extends AbstractDigest
implements Digest

The SHA1Digest class implements the SHA-1 algorithm.

We implemented SHA1 as it's defined in FIPS 180-1.

For a code sample using the SHA-1 algorithm, click here.

For information on cryptographic algorithms, see Crypto Algorithms.

See Also:

SHA384Digest, SHA224Digest, SHA256Digest, SHA512Digest

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

Field Summary
	static int	BLOCK_LENGTH Definition stating the block length, namely 64 bytes.
	static int	DIGEST_LENGTH A static definition stating the digest length to be of 20 bytes.

Constructor Summary
	SHA1Digest() Constructs and initializes an SHA-1Digest object.

Method Summary
	String	getAlgorithm() Returns a String containing the name of the algorithm ("SHA1").
	int	getBlockLength() Returns the block length of the digest in bytes.
	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, 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.

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

getDigest, getDigest, getDigest, 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.Digest

getDigest, getDigest, getDigest, update

Field Detail

DIGEST_LENGTH

public static final int DIGEST_LENGTH

A static definition stating the digest length to be of 20 bytes.

See Also:

Constant Field Values

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

BLOCK_LENGTH

public static final int BLOCK_LENGTH

Definition stating the block length, namely 64 bytes.

See Also:

Constant Field Values

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 Detail

SHA1Digest

public SHA1Digest()

Constructs and initializes an SHA-1Digest object.

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 a String containing the name of the algorithm ("SHA1").

This method will always return the String "SHA1".

Specified by:

getAlgorithm in interface Digest

Specified by:

getAlgorithm in class AbstractDigest

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

reset

public void reset()

Description copied from class: AbstractDigest

Reinitializes the digest.

Specified by:

reset in interface Digest

Specified by:

reset in class AbstractDigest

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: AbstractDigest

Passes a single byte into the hash algorithm.

Specified by:

update in interface Digest

Overrides:

update in class AbstractDigest

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

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

Description copied from class: AbstractDigest

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

Specified by:

update in interface Digest

Specified by:

update in class AbstractDigest

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

public int getDigestLength()

Description copied from class: AbstractDigest

Returns the length of the digest in bytes.

Specified by:

getDigestLength in interface Digest

Specified by:

getDigestLength in class AbstractDigest

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

public int getBlockLength()

Description copied from class: AbstractDigest

Returns the block length of the digest in bytes. This block length is used in HMAC and therefore is overidden by HMAC-supported digests.

Specified by:

getBlockLength in interface Digest

Overrides:

getBlockLength in class AbstractDigest

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

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

Description copied from class: AbstractDigest

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

Specified by:

getDigest in interface Digest

Specified by:

getDigest in class AbstractDigest

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