PHTTPClientDigestAuthentication Class Reference

#include <http.h>

Inheritance diagram for PHTTPClientDigestAuthentication:

Collaboration diagram for PHTTPClientDigestAuthentication:

Public Types
enum	Algorithm { Algorithm_MD5, NumAlgorithms }
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
	PHTTPClientDigestAuthentication ()
PHTTPClientDigestAuthentication &	operator= (const PHTTPClientDigestAuthentication &auth)
virtual Comparison	Compare (const PObject &other) const
	Compare the two objects and return their relative rank. More...
virtual PBoolean	Parse (const PString &auth, PBoolean proxy)
virtual PBoolean	Authorise (AuthObject &pdu) const
virtual PString	GetAuthRealm () const
virtual void	SetAuthRealm (const PString &r)
const PString &	GetNonce () const
Algorithm	GetAlgorithm () const
const PString &	GetOpaque () const
bool	GetStale () const
Public Member Functions inherited from PHTTPClientAuthentication
	PHTTPClientAuthentication ()
virtual PBoolean	IsProxy () const
virtual PString	GetUsername () const
virtual PString	GetPassword () const
virtual void	SetUsername (const PString &user)
virtual void	SetPassword (const PString &pass)
PString	GetAuthParam (const PString &auth, const char *name) const
PString	AsHex (const PMessageDigest::Result &digest) const
PString	AsHex (const PBYTEArray &data) const
Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
__inline void	SetTraceContextIdentifier (unsigned id)
__inline void	SetTraceContextIdentifier (const PObject &obj)
__inline void	SetTraceContextIdentifier (const PObject *obj)
__inline void	CopyTraceContextIdentifier (PObject &obj) const
__inline void	CopyTraceContextIdentifier (PObject *obj) const
virtual	~PObject ()
__inline const char *	GetClass () const
__inline bool	IsClass (const char *name) const
__inline const PObject *	PTraceObjectInstance () const
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	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 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 Attributes
PString	authRealm
PString	nonce
Algorithm	algorithm
PString	opaque
bool	qopAuth
bool	qopAuthInt
bool	stale
PString	cnonce
atomic< uint32_t >	nonceCount
Protected Attributes inherited from PHTTPClientAuthentication
PBoolean	isProxy
PString	username
PString	password
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Static Public Member Functions inherited from PHTTPClientAuthentication
static PHTTPClientAuthentication *	ParseAuthenticationRequired (bool isProxy, const PMIMEInfo &line, PString &errorMsg)
Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject *from)
static __inline const char *	Class ()
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Member Enumeration Documentation

enum PHTTPClientDigestAuthentication::Algorithm

Enumerator
Algorithm_MD5
NumAlgorithms

Constructor & Destructor Documentation

PHTTPClientDigestAuthentication::PHTTPClientDigestAuthentication

(

)

Member Function Documentation

virtual PBoolean PHTTPClientDigestAuthentication::Authorise ( AuthObject &  pdu ) const

virtual

Implements PHTTPClientAuthentication.

virtual Comparison PHTTPClientDigestAuthentication::Compare ( const PObject &  obj ) const

virtual

Compare the two objects and return their relative rank.

This function is usually overridden by descendent classes to yield the ranking according to the semantics of the object.

The default function is to use the CompareObjectMemoryDirect() function to do a byte wise memory comparison of the two objects.

Returns

LessThan, EqualTo or GreaterThan according to the relative rank of the objects.

Reimplemented from PHTTPClientAuthentication.

Algorithm PHTTPClientDigestAuthentication::GetAlgorithm ( ) const

inline

References algorithm.

virtual PString PHTTPClientDigestAuthentication::GetAuthRealm ( ) const

inlinevirtual

Reimplemented from PHTTPClientAuthentication.

References authRealm.

const PString& PHTTPClientDigestAuthentication::GetNonce ( ) const

inline

References nonce.

const PString& PHTTPClientDigestAuthentication::GetOpaque ( ) const

inline

References opaque.

bool PHTTPClientDigestAuthentication::GetStale ( ) const

inline

References stale.

PHTTPClientDigestAuthentication& PHTTPClientDigestAuthentication::operator=

(

const PHTTPClientDigestAuthentication &

auth

)

virtual PBoolean PHTTPClientDigestAuthentication::Parse ( const PString &  auth, PBoolean  proxy  )

virtual

Implements PHTTPClientAuthentication.

virtual void PHTTPClientDigestAuthentication::SetAuthRealm ( const PString &  r )

inlinevirtual

Reimplemented from PHTTPClientAuthentication.

References authRealm.

Member Data Documentation

Algorithm PHTTPClientDigestAuthentication::algorithm

protected

Referenced by GetAlgorithm().

PString PHTTPClientDigestAuthentication::authRealm

protected

Referenced by GetAuthRealm(), and SetAuthRealm().

PString PHTTPClientDigestAuthentication::cnonce

protected

PString PHTTPClientDigestAuthentication::nonce

protected

Referenced by GetNonce().

atomic<uint32_t> PHTTPClientDigestAuthentication::nonceCount

mutableprotected

PString PHTTPClientDigestAuthentication::opaque

protected

Referenced by GetOpaque().

bool PHTTPClientDigestAuthentication::qopAuth

protected

bool PHTTPClientDigestAuthentication::qopAuthInt

protected

bool PHTTPClientDigestAuthentication::stale

protected

Referenced by GetStale().

---

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

• http.h