OpenSSLCryptoHash Class Reference
[OpenSSL Interface]

#include <OpenSSLCryptoHash.hpp>

Inheritance diagram for OpenSSLCryptoHash:

[legend]Collaboration diagram for OpenSSLCryptoHash:

[legend]List of all members.

---

Detailed Description

Interface definition for Hash functions.

Uses the OpenSSL EVP_digest functions to implement the various hash functions required by the OpenSSL library.

Public Member Functions
Constructors and Destructors
	OpenSSLCryptoHash (XSECCryptoHash::HashType alg)
virtual	~OpenSSLCryptoHash ()
HMAC Functions
virtual void	setKey (XSECCryptoKey *key)
Digest/Hash functions
virtual void	reset (void)
	Rest the hash function.
virtual void	hash (unsigned char *data, unsigned int length)
	Hash some data.
virtual unsigned int	finish (unsigned char *hash, unsigned int maxLength)
	Finish up a Digest operation and read the result.
Information functions
virtual HashType	getHashType (void)

---

Constructor & Destructor Documentation

OpenSSLCryptoHash::OpenSSLCryptoHash (  XSECCryptoHash::HashType  alg  )

virtual OpenSSLCryptoHash::~OpenSSLCryptoHash (   )  [virtual]

---

Member Function Documentation

virtual unsigned int OpenSSLCryptoHash::finish (  unsigned char *  hash, unsigned int  maxLength )  [virtual]

Finish up a Digest operation and read the result. This call tells the CryptoHash object that the input is complete and to finalise the Digest. The output of the digest is read into the hash buffer (at most maxLength bytes) Parameters: hash  The buffer the hash should be read into. maxLength  The maximum number of bytes to be read into hash Returns: The number of bytes copied into the hash buffer Implements XSECCryptoHash.

virtual HashType OpenSSLCryptoHash::getHashType (  void   )  [virtual]

Determine the hash type of this object Returns: The hash type Implements XSECCryptoHash.

virtual void OpenSSLCryptoHash::hash (  unsigned char *  data, unsigned int  length )  [virtual]

Hash some data. Take length bytes of data from the data buffer and update the hash that already exists. This function may (and normally will) be called many times for large blocks of data. Parameters: data  The buffer containing the data to be hashed. length  The number of bytes to be read from data Implements XSECCryptoHash.

virtual void OpenSSLCryptoHash::reset (  void   )  [virtual]

Rest the hash function. Re-initialises the digest structure. Implements XSECCryptoHash.

virtual void OpenSSLCryptoHash::setKey (  XSECCryptoKey *  key  )  [inline, virtual]

Does nothing. If the required function is an HMAC function, then OpenSSLCryptoHashHMAC should be used. Parameters: key  The key the HMAC function should use. Implements XSECCryptoHash.

---

The documentation for this class was generated from the following file:

• OpenSSLCryptoHash.hpp

---