class PSSLContext

Context for SSL channels.

Public Methods

[more] PSSLContext ( const void* sessionId = NULL, PINDEX idSize = 0 )
Create a new context for SSL channels.
[more] ~PSSLContext ()
Clean up the SSL context
[more] operator ssl_ctx_st * () const
Get the internal SSL context structure
[more]BOOL SetCAPath ( const PDirectory & caPath )
Set the path to locate CA certificates.
[more]BOOL SetCAFile ( const PFilePath & caFile )
Set the CA certificate file.
[more]BOOL UseCertificate ( const PSSLCertificate & certificate )
Use the certificate specified
[more]BOOL UsePrivateKey ( const PSSLPrivateKey & key )
Use the private key specified
[more]BOOL UseDiffieHellman ( const PSSLDiffieHellman & dh )
Use the Diffie-Hellman parameters specified
[more]BOOL SetCipherList ( const PString & ciphers )
Set the available ciphers to those listed.


Documentation

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.
o 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

o ~PSSLContext()
Clean up the SSL context

o operator ssl_ctx_st *() const
Get the internal SSL context structure

oBOOL SetCAPath( const PDirectory & caPath )
Set the path to locate CA certificates.
Parameters:
caPath - Directory for CA certificates

oBOOL SetCAFile( const PFilePath & caFile )
Set the CA certificate file.
Parameters:
caFile - CA certificate file

oBOOL UseCertificate( const PSSLCertificate & certificate )
Use the certificate specified

oBOOL UsePrivateKey( const PSSLPrivateKey & key )
Use the private key specified

oBOOL UseDiffieHellman( const PSSLDiffieHellman & dh )
Use the Diffie-Hellman parameters specified

oBOOL SetCipherList( const PString & ciphers )
Set the available ciphers to those listed.
Parameters:
ciphers - List of cipher names.


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.