Diffie-Hellman key exchange conteext. More...

#include <pssl.h>

Inheritance diagram for PSSLDiffieHellman:

Collaboration diagram for PSSLDiffieHellman:

Public Member Functions
	PSSLDiffieHellman ()
	Create an empty set of Diffie-Hellman parameters. More...

	PSSLDiffieHellman (const PFilePath &dhFile, PSSLFileTypes fileType=PSSLFileTypeDEFAULT)
	Create a new set of Diffie-Hellman parameters given the file. More...

	PSSLDiffieHellman (PINDEX numBits, const BYTE pData, const BYTE gData, const BYTE *pubKey=NULL)
	Create a set of Diffie-Hellman parameters. More...

	PSSLDiffieHellman (const PBYTEArray &pData, const PBYTEArray &gData, const PBYTEArray &pubKey=PBYTEArray())
	Create a set of Diffie-Hellman parameters. More...

	PSSLDiffieHellman (const PSSLDiffieHellman &dh)
	Create a copy of the Diffie-Hellman parameters. More...

PSSLDiffieHellman &	operator= (const PSSLDiffieHellman &dh)
	Create a copy of the Diffie-Hellman parameters. More...

	~PSSLDiffieHellman ()
	Destroy and release storage for Diffie-Hellman parameters. More...

bool	IsValid () const
	Return true if is a valid Diffie-Hellman context. More...

	operator dh_st * () const
	Get internal OpenSSL DH structure. More...

PBoolean	Load (const PFilePath &dhFile, PSSLFileTypes fileType=PSSLFileTypeDEFAULT)
	Load Diffie-Hellman parameters from file. More...

PINDEX	GetNumBits () const
	Get number of bits being used. More...

PBYTEArray	GetModulus () const
	Get the P value. More...

PBYTEArray	GetGenerator () const
	Get the G value. More...

PBYTEArray	GetHalfKey () const
	Get the "half-key" value. More...

bool	ComputeSessionKey (const PBYTEArray &otherHalf)
	Compute the session key, geven other half-key. More...

const PBYTEArray &	GetSessionKey () const
	Get the session key value. More...

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 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 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 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
bool	Construct (const BYTE pData, PINDEX pSize, const BYTE gData, PINDEX gSize, const BYTE *kData, PINDEX kSize)

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
dh_st *	m_dh

PBYTEArray	m_sessionKey

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

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 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)

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Friends inherited from PObject

Detailed Description

Diffie-Hellman key exchange conteext.

This class embodies a set of Diffie Helman key exchange parameters and context.

Constructor & Destructor Documentation

PSSLDiffieHellman::PSSLDiffieHellman ( )

Create an empty set of Diffie-Hellman parameters.

PSSLDiffieHellman::PSSLDiffieHellman	(	const PFilePath &	dhFile,
		PSSLFileTypes	fileType = `PSSLFileTypeDEFAULT`
	)

Create a new set of Diffie-Hellman parameters given the file.

The type of the file can be specified explicitly, or if PSSLFileTypeDEFAULT it will be determined from the file extension, ".pem" is a text file, anything else eg ".der" is a binary ASN1 file.

Parameters

dhFile	Diffie-Hellman parameters file
fileType	Type of file to read

PSSLDiffieHellman::PSSLDiffieHellman	(	PINDEX	numBits,
		const BYTE *	pData,
		const BYTE *	gData,
		const BYTE *	pubKey = `NULL`
	)

Create a set of Diffie-Hellman parameters.

If pubKey is NULL, it is automatically generated.

Note, all three buffers (if not NULL) must point to numBits/8 bytes.

Parameters

numBits	Number of bits
pData	Modulus data (numBits/8 bytes)
gData	Generator data (numBits/8 bytes)
pubKey	Public key data (numBits/8 bytes)

PSSLDiffieHellman::PSSLDiffieHellman	(	const PBYTEArray &	pData,
		const PBYTEArray &	gData,
		const PBYTEArray &	pubKey = `PBYTEArray()`
	)

Create a set of Diffie-Hellman parameters.

If pubKey is empty, it is automatically generated.

Parameters

pData	Modulus data
gData	Generator data
pubKey	Public key data

PSSLDiffieHellman::PSSLDiffieHellman ( const PSSLDiffieHellman & dh )

Create a copy of the Diffie-Hellman parameters.

PSSLDiffieHellman::~PSSLDiffieHellman ( )

Destroy and release storage for Diffie-Hellman parameters.

Member Function Documentation

bool PSSLDiffieHellman::ComputeSessionKey ( const PBYTEArray & otherHalf )

Compute the session key, geven other half-key.

bool PSSLDiffieHellman::Construct	(	const BYTE *	pData,
		PINDEX	pSize,
		const BYTE *	gData,
		PINDEX	gSize,
		const BYTE *	kData,
		PINDEX	kSize
	)

protected

PBYTEArray PSSLDiffieHellman::GetGenerator ( ) const

Get the G value.

PBYTEArray PSSLDiffieHellman::GetHalfKey ( ) const

Get the "half-key" value.

PBYTEArray PSSLDiffieHellman::GetModulus ( ) const

Get the P value.

PINDEX PSSLDiffieHellman::GetNumBits ( ) const

Get number of bits being used.

const PBYTEArray& PSSLDiffieHellman::GetSessionKey ( ) const

inline

Get the session key value.

References m_sessionKey.

bool PSSLDiffieHellman::IsValid ( ) const

inline

Return true if is a valid Diffie-Hellman context.

References m_dh.

PBoolean PSSLDiffieHellman::Load	(	const PFilePath &	dhFile,
		PSSLFileTypes	fileType = `PSSLFileTypeDEFAULT`
	)

Load Diffie-Hellman parameters from file.

The type of the file can be specified explicitly, or if PSSLFileTypeDEFAULT it will be determined from the file extension, ".pem" is a text file, anything else eg ".der" is a binary ASN1 file.

Parameters

dhFile	Diffie-Hellman parameters file
fileType	Type of file to read

PSSLDiffieHellman::operator dh_st * ( ) const

inline

Get internal OpenSSL DH structure.

References m_dh.

PSSLDiffieHellman& PSSLDiffieHellman::operator= ( const PSSLDiffieHellman & dh )

Create a copy of the Diffie-Hellman parameters.

Member Data Documentation

dh_st* PSSLDiffieHellman::m_dh

protected

Referenced by IsValid(), and operator dh_st *().

PBYTEArray PSSLDiffieHellman::m_sessionKey

protected

Referenced by GetSessionKey().

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

pssl.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation