PSSLContext Class Reference

#include <pssl.h>

List of all members.

Public Member Functions

 PSSLContext (const void *sessionId=NULL, PINDEX idSize=0)
 ~PSSLContext ()
 operator ssl_ctx_st * () const
BOOL SetCAPath (const PDirectory &caPath)
BOOL SetCAFile (const PFilePath &caFile)
BOOL UseCertificate (const PSSLCertificate &certificate)
BOOL UsePrivateKey (const PSSLPrivateKey &key)
BOOL UseDiffieHellman (const PSSLDiffieHellman &dh)
BOOL SetCipherList (const PString &ciphers)

Protected Attributes

ssl_ctx_st * context

Detailed Description

Context for SSL channels. This class embodies a common environment for all connections made via SSL using the PSSLChannel class. It includes such things as the version of SSL and certificates, CA's etc.


Constructor & Destructor Documentation

PSSLContext::PSSLContext ( const void *  sessionId = NULL,
PINDEX  idSize = 0 
)

Create a new context for SSL channels. An optional session ID may be provided in the context. This is used to identify sessions across multiple channels in this context. The session ID is a completely arbitrary block of data. If sessionId is non NULL and idSize is zero, then sessionId is assumed to be a pointer to a C string.

Parameters:
sessionId Pointer to session ID
idSize Size of session ID
PSSLContext::~PSSLContext (  ) 

Clean up the SSL context.


Member Function Documentation

PSSLContext::operator ssl_ctx_st * (  )  const [inline]

Get the internal SSL context structure.

References context.

BOOL PSSLContext::SetCAFile ( const PFilePath caFile  ) 

Set the CA certificate file.

Parameters:
caFile CA certificate file
BOOL PSSLContext::SetCAPath ( const PDirectory caPath  ) 

Set the path to locate CA certificates.

Parameters:
caPath Directory for CA certificates
BOOL PSSLContext::SetCipherList ( const PString ciphers  ) 

Set the available ciphers to those listed.

Parameters:
ciphers List of cipher names.
BOOL PSSLContext::UseCertificate ( const PSSLCertificate certificate  ) 

Use the certificate specified.

BOOL PSSLContext::UseDiffieHellman ( const PSSLDiffieHellman dh  ) 

Use the Diffie-Hellman parameters specified.

BOOL PSSLContext::UsePrivateKey ( const PSSLPrivateKey key  ) 

Use the private key specified.


Member Data Documentation

ssl_ctx_st* PSSLContext::context [protected]

Referenced by operator ssl_ctx_st *().


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

Generated on Sun Sep 6 03:50:37 2009 for PWLib by  doxygen 1.6.1