This class will start a secure SSL based channel. More...

#include <pssl.h>

Inheritance diagram for PSSLChannel:

Collaboration diagram for PSSLChannel:

Classes
struct	VerifyInfo

Public Types
typedef PSSLContext::VerifyMode	VerifyMode

typedef PNotifierTemplate < VerifyInfo & >	VerifyNotifier

Public Types inherited from PChannel
enum	PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }

enum	Errors { NoError, NotFound, FileExists, DiskFull, AccessDenied, DeviceInUse, BadParameter, NoMemory, NotOpen, Timeout, Interrupted, BufferTooSmall, Miscellaneous, ProtocolFailure, Unavailable, NumNormalisedErrors }
	Normalised error codes. More...

enum	ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
	Error groups. More...

typedef PNotifierTemplate < PChannel::AsyncContext & >	AsyncNotifier

enum	ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }

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
	PSSLChannel (PSSLContext *context=NULL, PBoolean autoDeleteContext=false)
	Create a new channel given the context. More...

	PSSLChannel (PSSLContext &context)

	~PSSLChannel ()
	Close and clear the SSL channel. More...

virtual PBoolean	Read (void *buf, PINDEX len)
	Low level read from the channel. More...

virtual PBoolean	Write (const void *buf, PINDEX len)
	Low level write to the channel. More...

virtual PBoolean	Close ()
	Close the channel. More...

virtual PBoolean	Shutdown (ShutdownValue)
	Close one or both of the data streams associated with a channel. More...

virtual PString	GetErrorText (ErrorGroup group=NumErrorGroups) const
	Get error message description. More...

virtual PBoolean	ConvertOSError (P_INT_PTR libcReturnValue, ErrorGroup group=LastGeneralError)
	Convert an operating system error into platform independent error. More...

PBoolean	Accept ()
	Accept a new inbound connection (server). More...

PBoolean	Accept (PChannel &channel)
	Accept a new inbound connection (server). More...

PBoolean	Accept (PChannel *channel, PBoolean autoDelete=true)
	Accept a new inbound connection (server). More...

PBoolean	Connect ()
	Connect to remote server. More...

PBoolean	Connect (PChannel &channel)
	Connect to remote server. More...

PBoolean	Connect (PChannel *channel, PBoolean autoDelete=true)
	Connect to remote server. More...

bool	AddClientCA (const PSSLCertificate &certificate)
	Set the CA certificate(s) to send to client from server. More...

bool	AddClientCA (const PList< PSSLCertificate > &certificates)

PBoolean	UseCertificate (const PSSLCertificate &certificate)
	Use the certificate specified. More...

PBoolean	UsePrivateKey (const PSSLPrivateKey &key)
	Use the private key file specified. More...

PString	GetCipherList () const
	Get the available ciphers. More...

void	SetVerifyMode (VerifyMode mode, const VerifyNotifier &notifier=VerifyNotifier())
	Set certificate verification mode for connection. More...

virtual void	OnVerify (VerifyInfo &info)
	Call back for certificate verification. More...

bool	GetPeerCertificate (PSSLCertificate &certificate, PString *error=NULL)
	Get the peer certificate, if there is one. More...

bool	SetServerNameIndication (const PString &name)
	Set the Server Name Indication TLS extension. More...

bool	CheckHostName (const PString &hostname, PSSLCertificate::CheckHostFlags flags=PSSLCertificate::CheckHostNormalRules)
	Check the host name against the certificate. More...

PSSLContext *	GetContext () const

	operator ssl_st * () const
	Get the internal SSL context structure. More...

Public Member Functions inherited from PIndirectChannel
	PIndirectChannel ()
	Create a new indirect channel without any channels to redirect to. More...

	~PIndirectChannel ()
	Close the indirect channel, deleting read/write channels if desired. More...

Comparison	Compare (const PObject &obj) const
	Determine if the two objects refer to the same indirect channel. More...

virtual PString	GetName () const
	Get the name of the channel. More...

virtual P_INT_PTR	GetHandle () const
	Get the OS specific handle for the PSoundChannel. More...

virtual PBoolean	IsOpen () const
	Determine if the channel is currently open and read and write operations can be executed on it. More...

virtual int	ReadChar ()
	Read a single character from the channel. More...

virtual bool	SetLocalEcho (bool localEcho)
	Set local echo mode. More...

virtual PChannel *	GetBaseReadChannel () const
	This function returns the eventual base channel for reading of a series of indirect channels provided by descendents of `PIndirectChannel`. More...

virtual PChannel *	GetBaseWriteChannel () const
	This function returns the eventual base channel for writing of a series of indirect channels provided by descendents of `PIndirectChannel`. More...

virtual bool	CloseBaseReadChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

virtual bool	CloseBaseWriteChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

PBoolean	Open (PChannel &channel)
	Set the channel for both read and write operations. More...

PBoolean	Open (PChannel *channel, PBoolean autoDelete=true)
	Set the channel for both read and write operations. More...

PBoolean	Open (PChannel readChannel, PChannel writeChannel, PBoolean autoDeleteRead=true, PBoolean autoDeleteWrite=true)
	Set the channel for both read and write operations. More...

PChannel *	Detach (ShutdownValue option=ShutdownReadAndWrite)
	Detach without closing the read/write channel. More...

PChannel *	GetReadChannel () const
	Get the channel used for read operations. More...

bool	SetReadChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
	Set the channel for read operations. More...

PChannel *	GetWriteChannel () const
	Get the channel used for write operations. More...

PBoolean	SetWriteChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
	Set the channel for read operations. More...

template<class ChannelClass >
ChannelClass *	FindChannel ()
	Locate a channel of a specific class in the indirect chain. More...

Public Member Functions inherited from PChannel
PBoolean	SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)
	Set error values to those specified. More...

virtual PINDEX	HashFunction () const
	Calculate a hash value for use in sets and dictionaries. More...

FILE *	FDOpen (const char *mode)
	Re-open the device using the stdio library. More...

void	SetReadTimeout (const PTimeInterval &time)
	Set the timeout for read operations. More...

PTimeInterval	GetReadTimeout () const
	Get the timeout for read operations. More...

virtual PINDEX	GetLastReadCount () const
	Get the number of bytes read by the last Read() call. More...

virtual PINDEX	SetLastReadCount (PINDEX count)

PBoolean	ReadBlock (void *buf, PINDEX len)
	Read len bytes into the buffer from the channel. More...

PString	ReadString (PINDEX len)
	Read `len` character into a string from the channel. More...

void	SetWriteTimeout (const PTimeInterval &time)
	Set the timeout for write operations to complete. More...

PTimeInterval	GetWriteTimeout () const
	Get the timeout for write operations to complete. More...

virtual PBoolean	Write (const void buf, PINDEX len, const void )
	Low level write to the channel with marker. More...

virtual PINDEX	GetLastWriteCount () const
	Get the number of bytes written by the last Write() call. More...

virtual PINDEX	SetLastWriteCount (PINDEX count)

PBoolean	WriteChar (int c)
	Write a single character to the channel. More...

PBoolean	WriteString (const PString &str)
	Write a string to the channel. More...

	~PChannel ()
	Close down the channel. More...

Errors	GetErrorCode (ErrorGroup group=NumErrorGroups) const
	Get normalised error code. More...

int	GetErrorNumber (ErrorGroup group=NumErrorGroups) const
	Get OS errro code. More...

virtual bool	ReadAsync (AsyncContext &context)
	Begin an asynchronous read from channel. More...

virtual void	OnReadComplete (AsyncContext &context)
	User callback function for when a `ReadAsync()` call has completed or timed out. More...

virtual bool	WriteAsync (AsyncContext &context)
	Begin an asynchronous write from channel. More...

virtual void	OnWriteComplete (AsyncContext &context)
	User callback function for when a WriteAsync() call has completed or timed out. More...

virtual bool	FlowControl (const void *flowData)
	Flow Control information Pass data to the channel for flowControl determination. More...

PBoolean	SetBufferSize (PINDEX newSize)
	Set the iostream buffer size for reads and writes. More...

PBoolean	SendCommandString (const PString &command)
	Send a command meta-string. More...

void	AbortCommandString ()
	Abort a command string that is in progress. More...

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 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
void	Construct (PSSLContext *ctx, PBoolean autoDel)

virtual bool	InternalAccept ()

virtual bool	InternalConnect ()

virtual int	BioRead (char *buf, int len)

virtual int	BioWrite (const char *buf, int len)

virtual long	BioControl (int cmd, long num, void *ptr)

virtual int	BioClose ()

	PDECLARE_MUTEX (m_writeMutex)

	P_REMOVE_VIRTUAL (PBoolean, RawSSLRead(void *, PINDEX &), false)

	P_REMOVE_VIRTUAL (bool, OnVerify(bool, const PSSLCertificate &), false)

Protected Member Functions inherited from PIndirectChannel
virtual PBoolean	OnOpen ()
	This callback is executed when the Open() function is called with open channels. More...

	PDECLARE_READ_WRITE_MUTEX (channelPointerMutex)
	Race condition prevention on closing channel. More...

Protected Member Functions inherited from PChannel
	PChannel (const PChannel &)

PChannel &	operator= (const PChannel &)

int	ReadCharWithTimeout (PTimeInterval &timeout)
	Read a character with specified timeout. More...

PBoolean	ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)

bool	CheckNotOpen ()

virtual int	os_errno () const

PBoolean	PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)

P_INT_PTR	GetOSHandleAsInt () const

int	PXClose ()

	PDECLARE_MUTEX (px_threadMutex)

	PDECLARE_MUTEX (px_writeMutex)

	PChannel ()
	Create the channel. More...

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

Static Protected Member Functions
static int	BioRead (bio_st bio, char buf, int len)

static int	BioWrite (bio_st bio, const char buf, int len)

static long	BioControl (bio_st bio, int cmd, long num, void ptr)

static int	BioClose (bio_st *bio)

Protected Attributes
PSSLContext *	m_context

bool	m_autoDeleteContext

ssl_st *	m_ssl

bio_method_st *	m_bioMethod

bio_st *	m_bio

VerifyNotifier	m_verifyNotifier

Protected Attributes inherited from PIndirectChannel
PChannel *	readChannel
	Channel for read operations. More...

PBoolean	readAutoDelete
	Automatically delete read channel on destruction. More...

PChannel *	writeChannel
	Channel for write operations. More...

PBoolean	writeAutoDelete
	Automatically delete write channel on destruction. More...

Protected Attributes inherited from PChannel
PTimeInterval	readTimeout
	Timeout for read operations. More...

PTimeInterval	writeTimeout
	Timeout for write operations. More...

atomic< P_INT_PTR >	os_handle
	The operating system file handle return by standard open() function. More...

PThreadLocalStorage< Status >	m_status [NumErrorGroups+1]

PXBlockType	px_lastBlockType

PThread *	px_readThread

PThread *	px_writeThread

PThread *	px_selectThread [3]

PCriticalSection	px_selectMutex [3]

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Static Public Member Functions inherited from PChannel
static PString	GetErrorText (Errors lastError, int osError=0)
	Get error message description. 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 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...

Detailed Description

This class will start a secure SSL based channel.

Member Typedef Documentation

typedef PSSLContext::VerifyMode PSSLChannel::VerifyMode

typedef PNotifierTemplate<VerifyInfo &> PSSLChannel::VerifyNotifier

Constructor & Destructor Documentation

PSSLChannel::PSSLChannel	(	PSSLContext *	context = `NULL`,
		PBoolean	autoDeleteContext = `false`
	)

Create a new channel given the context.

If no context is given a default one is created.

Parameters

context	Context for SSL channel
autoDeleteContext	Flag for context to be automatically deleted.

PSSLChannel::PSSLChannel ( PSSLContext & context )

Parameters

context Context for SSL channel

PSSLChannel::~PSSLChannel ( )

Close and clear the SSL channel.

Member Function Documentation

PBoolean PSSLChannel::Accept ( )

Accept a new inbound connection (server).

This version expects that the indirect channel has already been opened using Open() beforehand.

PBoolean PSSLChannel::Accept ( PChannel & channel )

Accept a new inbound connection (server).

Parameters

channel Channel to attach to.

PBoolean PSSLChannel::Accept	(	PChannel *	channel,
		PBoolean	autoDelete = `true`
	)

Accept a new inbound connection (server).

Parameters

channel	Channel to attach to.
autoDelete	Flag for if channel should be automatically deleted.

bool PSSLChannel::AddClientCA ( const PSSLCertificate & certificate )

Set the CA certificate(s) to send to client from server.

bool PSSLChannel::AddClientCA ( const PList< PSSLCertificate > & certificates )

static int PSSLChannel::BioClose ( bio_st * bio )

staticprotected

virtual int PSSLChannel::BioClose ( )

protectedvirtual

static long PSSLChannel::BioControl	(	bio_st *	bio,
		int	cmd,
		long	num,
		void *	ptr
	)

staticprotected

virtual long PSSLChannel::BioControl	(	int	cmd,
		long	num,
		void *	ptr
	)

protectedvirtual

static int PSSLChannel::BioRead	(	bio_st *	bio,
		char *	buf,
		int	len
	)

staticprotected

virtual int PSSLChannel::BioRead	(	char *	buf,
		int	len
	)

protectedvirtual

static int PSSLChannel::BioWrite	(	bio_st *	bio,
		const char *	buf,
		int	len
	)

staticprotected

virtual int PSSLChannel::BioWrite	(	const char *	buf,
		int	len
	)

protectedvirtual

bool PSSLChannel::CheckHostName	(	const PString &	hostname,
		PSSLCertificate::CheckHostFlags	flags = `PSSLCertificate::CheckHostNormalRules`
	)

Check the host name against the certificate.

Note if SetVerifyMode() is set to VerifyNone, this always returns true.

virtual PBoolean PSSLChannel::Close ( )

virtual

Close the channel.

This will detach itself from the read and write channels and delete both of them if they are auto delete.

Returns: true if the channel is closed.

Reimplemented from PIndirectChannel.

PBoolean PSSLChannel::Connect ( )

Connect to remote server.

This version expects that the indirect channel has already been opened using Open() beforehand.

PBoolean PSSLChannel::Connect ( PChannel & channel )

Connect to remote server.

Parameters

channel Channel to attach to.

PBoolean PSSLChannel::Connect	(	PChannel *	channel,
		PBoolean	autoDelete = `true`
	)

Connect to remote server.

Parameters

channel	Channel to attach to.
autoDelete	Flag for if channel should be automatically deleted.

void PSSLChannel::Construct	(	PSSLContext *	ctx,
		PBoolean	autoDel
	)

protected

virtual PBoolean PSSLChannel::ConvertOSError	(	P_INT_PTR	libcReturnValue,
		ErrorGroup	group = `LastGeneralError`
	)

virtual

Convert an operating system error into platform independent error.

The internal error codes are set by this function. They may be obtained via the GetErrorCode() and GetErrorNumber() functions.

Returns: true if there was no error.

Reimplemented from PChannel.

PString PSSLChannel::GetCipherList ( ) const

Get the available ciphers.

PSSLContext* PSSLChannel::GetContext ( ) const

inline

References m_context.

virtual PString PSSLChannel::GetErrorText ( ErrorGroup group = NumErrorGroups ) const

virtual

Get error message description.

Return a string indicating the error message that may be displayed to the user. The error for the last I/O operation in this object is used.

Returns: Operating System error description string.

Reimplemented from PIndirectChannel.

bool PSSLChannel::GetPeerCertificate	(	PSSLCertificate &	certificate,
		PString *	error = `NULL`
	)

Get the peer certificate, if there is one.

If SetVerifyMode() has been called with VerifyPeer then this will return true if the remote does not offer a certificate. If set to VerifyPeerMandatory, then it will return false. In both cases it will return false if the certificate is offered but cannot be authenticated.

virtual bool PSSLChannel::InternalAccept ( )

protectedvirtual

Reimplemented in PSSLChannelDTLS.

virtual bool PSSLChannel::InternalConnect ( )

protectedvirtual

Reimplemented in PSSLChannelDTLS.

virtual void PSSLChannel::OnVerify ( VerifyInfo & info )

virtual

Call back for certificate verification.

Default calls m_verifyNotifier if not NULL.

PSSLChannel::operator ssl_st * ( ) const

inline

Get the internal SSL context structure.

References m_ssl.

PSSLChannel::P_REMOVE_VIRTUAL	(	PBoolean	,
		RawSSLRead(void *, PINDEX &)	,
		false
	)

protected

PSSLChannel::P_REMOVE_VIRTUAL	(	bool	,
		OnVerify(bool, const PSSLCertificate &)	,
		false
	)

protected

PSSLChannel::PDECLARE_MUTEX ( m_writeMutex )

protected

virtual PBoolean PSSLChannel::Read	(	void *	buf,
		PINDEX	len
	)

virtual

Low level read from the channel.

This function may block until the requested number of characters were read or the read timeout was reached. The GetLastReadCount() function returns the actual number of bytes read.

This will use the readChannel pointer to actually do the read. If readChannel is null the this asserts.

The GetErrorCode() function should be consulted after Read() returns false to determine what caused the failure.

Returns: true indicates that at least one character was read from the channel. false means no bytes were read due to timeout or some other I/O error.

Reimplemented from PIndirectChannel.

Reimplemented in PSSLChannelDTLS.

bool PSSLChannel::SetServerNameIndication ( const PString & name )

Set the Server Name Indication TLS extension.

Parameters

name	For client, this is the server we are conneting to

void PSSLChannel::SetVerifyMode	(	VerifyMode	mode,
		const VerifyNotifier &	notifier = `VerifyNotifier()`
	)

Set certificate verification mode for connection.

virtual PBoolean PSSLChannel::Shutdown ( ShutdownValue option )

virtual

Close one or both of the data streams associated with a channel.

The behavour here is to pass the shutdown on to its read and write channels.

Returns: true if the shutdown was successfully performed.

Reimplemented from PIndirectChannel.

PBoolean PSSLChannel::UseCertificate ( const PSSLCertificate & certificate )

Use the certificate specified.

PBoolean PSSLChannel::UsePrivateKey ( const PSSLPrivateKey & key )

Use the private key file specified.

virtual PBoolean PSSLChannel::Write	(	const void *	buf,
		PINDEX	len
	)

virtual

Low level write to the channel.

This function will block until the requested number of characters are written or the write timeout is reached. The GetLastWriteCount() function returns the actual number of bytes written.

This will use the writeChannel pointer to actually do the write. If writeChannel is null the this asserts.

The GetErrorCode() function should be consulted after Write() returns false to determine what caused the failure.

Returns: true if at least len bytes were written to the channel.

Reimplemented from PIndirectChannel.

Reimplemented in PSSLChannelDTLS.

Member Data Documentation

bool PSSLChannel::m_autoDeleteContext

protected

bio_st* PSSLChannel::m_bio

protected

bio_method_st* PSSLChannel::m_bioMethod

protected

PSSLContext* PSSLChannel::m_context

protected

Referenced by GetContext().

ssl_st* PSSLChannel::m_ssl

protected

Referenced by operator ssl_st *().

VerifyNotifier PSSLChannel::m_verifyNotifier

protected

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

pssl.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation