PHMAC Class Reference

HMAC template class. More...

#include <cypher.h>

Inheritance diagram for PHMAC:

Collaboration diagram for PHMAC:

Public Types
enum	{ KeyLength = 20 }
enum	{ BlockSize = 64 }
typedef PMessageDigest::Result	Result
Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the Compare() function. More...

Public Member Functions
virtual void	Hash (const BYTE *data, PINDEX len, Result &result)=0
virtual PString	Encode (const BYTE *data, PINDEX len)
virtual PString	Encode (const PBYTEArray &data)
virtual PString	Encode (const PString &str)
virtual void	Process (const BYTE *data, PINDEX len, Result &result)
virtual void	Process (const PBYTEArray &data, Result &result)
virtual void	Process (const PString &str, Result &result)
Public Member Functions inherited from PObject
unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
void	SetTraceContextIdentifier (unsigned id)
void	GetTraceContextIdentifier (PObject &obj)
void	GetTraceContextIdentifier (PObject *obj)
void	SetTraceContextIdentifier (const PObject &obj)
void	SetTraceContextIdentifier (const PObject *obj)
virtual	~PObject ()
virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...
template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...
virtual PINDEX	HashFunction () const
	This function yields a hash value required by the PDictionary class. More...
virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...
virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...
bool	operator== (const PObject &obj) const
	Compare the two objects. More...
bool	operator!= (const PObject &obj) const
	Compare the two objects. More...
bool	operator< (const PObject &obj) const
	Compare the two objects. More...
bool	operator> (const PObject &obj) const
	Compare the two objects. More...
bool	operator<= (const PObject &obj) const
	Compare the two objects. More...
bool	operator>= (const PObject &obj) const
	Compare the two objects. More...
virtual const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance. More...
PBoolean	IsClass (const char *cls) const
virtual PBoolean	InternalIsDescendant (const char *clsName) const
	Determine if the dynamic type of the current instance is a descendent of the specified class. More...
__inline const PObject *	PTraceObjectInstance () const
virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Member Functions
virtual PINDEX	GetL () const
virtual PINDEX	GetB () const
virtual void	Initialise (const BYTE *key, PINDEX len)
virtual void	InternalProcess (const BYTE *data, PINDEX len, PHMAC::Result &result)
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PBYTEArray	m_key
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Static Public Member Functions inherited from PObject
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...
static const char *	Class ()
	Get the name of the class as a C string. More...
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
Friends inherited from PObject

Detailed Description

HMAC template class.

Create a class that implemented a HMAC as per RFC 2104 using an arbitrary hash class

Member Typedef Documentation

typedef PMessageDigest::Result PHMAC::Result

Member Enumeration Documentation

anonymous enum

Enumerator
KeyLength

anonymous enum

Enumerator
BlockSize

Member Function Documentation

virtual PString PHMAC::Encode ( const BYTE *  data, PINDEX  len  )

virtual

virtual PString PHMAC::Encode ( const PBYTEArray &  data )

virtual

virtual PString PHMAC::Encode ( const PString &  str )

virtual

virtual PINDEX PHMAC::GetB ( ) const

inlineprotectedvirtual

References BlockSize.

virtual PINDEX PHMAC::GetL ( ) const

inlineprotectedvirtual

References KeyLength.

virtual void PHMAC::Hash ( const BYTE *  data, PINDEX  len, Result &  result  )

pure virtual

Implemented in PHMACTemplate< hash_class >.

virtual void PHMAC::Initialise ( const BYTE *  key, PINDEX  len  )

protectedvirtual

Referenced by PHMACTemplate< hash_class >::PHMACTemplate().

virtual void PHMAC::InternalProcess ( const BYTE *  data, PINDEX  len, PHMAC::Result &  result  )

protectedvirtual

virtual void PHMAC::Process ( const BYTE *  data, PINDEX  len, Result &  result  )

virtual

virtual void PHMAC::Process ( const PBYTEArray &  data, Result &  result  )

virtual

virtual void PHMAC::Process ( const PString &  str, Result &  result  )

virtual

Member Data Documentation

PBYTEArray PHMAC::m_key

protected

---

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

• cypher.h