PKIFXSECCryptoHash Class Reference

#include <PKIFXSECCryptoHash.h>

Inheritance diagram for PKIFXSECCryptoHash:

[legend]

Collaboration diagram for PKIFXSECCryptoHash:

[legend]

List of all members.

---

Detailed Description

Implementation of hash and HMAC functions for XML security library

TSP-enforcing: No

Definition at line 27 of file PKIFXSECCryptoHash.h.

Public Member Functions
	PKIFXSECCryptoHash ()
	PKIFXSECCryptoHash (IPKIFMediatorPtr &med, HashType alg)
virtual	~PKIFXSECCryptoHash ()
virtual void	reset (void)
virtual void	hash (unsigned char *data, unsigned int length)
virtual unsigned int	finish (unsigned char *hash, unsigned int maxLength)
virtual HashType	getHashType () const
virtual void	setKey (XSECCryptoKey *key)

---

Constructor & Destructor Documentation

PKIFXSECCryptoHash::PKIFXSECCryptoHash

(

)

Interface: External

Construct an empty PKIFXSECCryptoHash object

Returns:

None

Definition at line 90 of file PKIFXSECCryptoHash.cpp.

PKIFXSECCryptoHash::PKIFXSECCryptoHash	(	IPKIFMediatorPtr &	med,
		HashType	alg
	)

Interface: External

Construct a PKIFXSECCryptoHash with the specified mediator and hash type

Returns:

None

Parameters:

med	[in] mediator that provides hash functionality
alg	[in] hash algorithm this instance will use

Definition at line 102 of file PKIFXSECCryptoHash.cpp.

PKIFXSECCryptoHash::~PKIFXSECCryptoHash

(

)

[virtual]

Interface: External

free resources used by a PKIFXSECCryptoHash object

Returns:

None

Definition at line 121 of file PKIFXSECCryptoHash.cpp.

---

Member Function Documentation

void PKIFXSECCryptoHash::reset

(

void

)

[virtual]

Interface: External

reset the hash object so it can be reused

Returns:

None

Definition at line 144 of file PKIFXSECCryptoHash.cpp.

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

Interface: External

update the hash object with data

Returns:

None

Parameters:

data	[in] data to hash
length	[in] length of data

Definition at line 163 of file PKIFXSECCryptoHash.cpp.

References CPKIFException::GetDescription(), and pkifHashAlgForHT().

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

Interface: External

finalize and obtain the hash

Returns:

number of bytes copied to buffer

Parameters:

hash	[out] buffer to receive hash
maxLength	[in] length of buffer

Definition at line 216 of file PKIFXSECCryptoHash.cpp.

References CPKIFException::GetDescription().

XSECCryptoHash::HashType PKIFXSECCryptoHash::getHashType

(

)

const [virtual]

Interface: External

get the hash algorithm for this object

Returns:

None

Definition at line 243 of file PKIFXSECCryptoHash.cpp.

void PKIFXSECCryptoHash::setKey

(

XSECCryptoKey *

key

)

[virtual]

Interface: External

set the key if it's an HMAC

Returns:

None

Parameters:

key	[in] pointer to the key to use

Definition at line 255 of file PKIFXSECCryptoHash.cpp.

References PKIFXSECCryptoKeyHMAC::getPKIFKeyMaterial().

---

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

• PKIFXSECCryptoHash.h
• PKIFXSECCryptoHash.cpp