PTLib  Version 2.18.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PSSLCertificateFingerprint Class Reference

Create a "fingerprint" for SSL certificate. More...

#include <pssl.h>

Inheritance diagram for PSSLCertificateFingerprint:
Collaboration diagram for PSSLCertificateFingerprint:

Public Member Functions

 P_DECLARE_ENUM (HashType, HashMd5, HashSha1, HashSha256, HashSha512)
 
 PSSLCertificateFingerprint ()
 Create empty fingerprint. More...
 
 PSSLCertificateFingerprint (const PString &inStr)
 Create fingerprint by parsing string in format: "type fingerprint". More...
 
 PSSLCertificateFingerprint (HashType type, const PSSLCertificate &certificate)
 Create fingerprint with specified type from certificate. More...
 
Comparison Compare (const PObject &other) const
 Compare the two objects and return their relative rank. More...
 
bool IsValid () const
 
bool MatchForCertificate (const PSSLCertificate &cert) const
 
PString AsString () const
 
bool FromString (const PString &str)
 
HashType GetHash () const
 
void SetHash (HashType hash)
 
- 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 PObjectPTraceObjectInstance () const
 
virtual PObjectClone () 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...
 

Additional Inherited Members

- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
 
- 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 PObjectPTraceObjectInstance (const char *)
 
static __inline const PObjectPTraceObjectInstance (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...
 
- Protected Attributes inherited from PObject
unsigned m_traceContextIdentifier
 

Detailed Description

Create a "fingerprint" for SSL certificate.

Constructor & Destructor Documentation

PSSLCertificateFingerprint::PSSLCertificateFingerprint ( )

Create empty fingerprint.

PSSLCertificateFingerprint::PSSLCertificateFingerprint ( const PString inStr)

Create fingerprint by parsing string in format: "type fingerprint".

Parameters
inStrFingerprint string.
PSSLCertificateFingerprint::PSSLCertificateFingerprint ( HashType  type,
const PSSLCertificate certificate 
)

Create fingerprint with specified type from certificate.

Parameters
typeHasing algorithm to use
certificateCertificate to fingerprint.

Member Function Documentation

PString PSSLCertificateFingerprint::AsString ( ) const
Comparison PSSLCertificateFingerprint::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 PObject.

bool PSSLCertificateFingerprint::FromString ( const PString str)
HashType PSSLCertificateFingerprint::GetHash ( ) const
inline
bool PSSLCertificateFingerprint::IsValid ( ) const
bool PSSLCertificateFingerprint::MatchForCertificate ( const PSSLCertificate cert) const
PSSLCertificateFingerprint::P_DECLARE_ENUM ( HashType  ,
HashMd5  ,
HashSha1  ,
HashSha256  ,
HashSha512   
)
void PSSLCertificateFingerprint::SetHash ( HashType  hash)
inline

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