nsICryptoHash

nsICryptoHash
This interface provides crytographic hashing algorithms.

Methods

init(aAlgorithm)

Initialize the hashing object. This method may be
called multiple times with different algorithm types.

@throws NS_ERROR_INVALID_ARG if an unsupported algorithm
type is passed.

NOTE: This method or initWithString must be called
before any other method on this interface is called.

Parameters

aAlgorithm the algorithm type to be used. This value must be one of the above valid algorithm types.

initWithString(aAlgorithm)

Initialize the hashing object. This method may be
called multiple times with different algorithm types.

@throws NS_ERROR_INVALID_ARG if an unsupported algorithm
type is passed.

NOTE: This method or init must be called before any
other method on this interface is called.

Parameters

aAlgorithm the algorithm type to be used.

update(aData, aLen)

@throws NS_ERROR_NOT_INITIALIZED if |init| has not been
called.

Parameters

aData a buffer to calculate the hash over
aLen the length of the buffer |aData|

updateFromStream(aStream, aLen)

Calculates and updates a new hash based on a given data stream.

@throws NS_ERROR_NOT_INITIALIZED if |init| has not been
called.

@throws NS_ERROR_NOT_AVAILABLE if the requested amount of
data to be calculated into the hash is not available.

Parameters

aStream an input stream to read from.
aLen how much to read from the given |aStream|. Passing UINT32_MAX indicates that all data available will be used to update the hash.

finish(aASCII)

Completes this hash object and produces the actual hash data.

@throws NS_ERROR_NOT_INITIALIZED if |init| has not been
called.

NOTE: This method may be called any time after |init|
is called. This call resets the object to its
pre-init state.

Parameters

aASCII if true then the returned value is a base-64 encoded string. if false, then the returned value is binary data.

Returns

a hash of the data that was read by this object. This can be either binary data or base 64 encoded.

Constants

MD2

Hashing Algorithms. These values are to be used by the
|init| method to indicate which hashing function to
use. These values map directly onto the values defined
in mozilla/security/nss/lib/cryptohi/hasht.h.

MD5

SHA1

SHA256

SHA384

SHA512