SASLSession Class Reference

Inheritance diagram for SASLSession:

Collaboration diagram for SASLSession:

Public Member Functions
	~SASLSession ()
void	init ()
shared_ptr< authenticator >	getAuthenticator ()
shared_ptr< SASLMechanism >	getMechanism ()
shared_ptr< SASLContext >	getContext ()
bool	evaluateChallenge (const byte_t *challenge, const size_t challengeLen, byte_t **response, size_t *responseLen)
shared_ptr< net::socket >	getSecuredSocket (shared_ptr< net::socket > sok)
const string	getServiceName () const

Static Public Member Functions
static shared_ptr< SASLSession >	create (const string &serviceName, shared_ptr< SASLContext > ctx, shared_ptr< authenticator > auth, shared_ptr< SASLMechanism > mech)

Additional Inherited Members
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

An SASL client session.

Constructor & Destructor Documentation

~SASLSession()

~SASLSession

(

)

References SASLSession::create().

Member Function Documentation

create()

shared_ptr< SASLSession > create ( const string &  serviceName, shared_ptr< SASLContext >  ctx, shared_ptr< authenticator >  auth, shared_ptr< SASLMechanism >  mech  )

static

Construct a new SASL session.

Parameters

serviceName	name of the service using this session
ctx	SASL context
auth	authenticator to use for this session
mech	SASL mechanism

Referenced by SASLContext::createSession(), and SASLSession::~SASLSession().

evaluateChallenge()

bool evaluateChallenge	(	const byte_t *	challenge,
		const size_t	challengeLen,
		byte_t **	response,
		size_t *	responseLen
	)

Perform one step of SASL authentication.

Accept data from the server (challenge), process it and return data to be returned in response to the server.

If the challenge is empty (challengeLen == 0), the initial response is returned, if the mechanism has one.

Parameters

challenge	challenge sent from the server
challengeLen	length of challenge
response	response to send to the server (allocated by this function, free with delete[])
responseLen	length of response buffer

Returns

true if authentication terminated successfully, or false if the authentication process should continue

Exceptions

exceptions::sasl_exception

if an error occurred during authentication (in this case, the values in 'response' and 'responseLen' are undetermined)

Referenced by SASLSession::getContext().

getAuthenticator()

shared_ptr< authenticator > getAuthenticator

(

)

Return the authenticator used for this session.

This is the authenticator which has been previously set with a call to setAuthenticator().

Returns

authenticator object

Referenced by SASLSession::getServiceName().

getContext()

shared_ptr< SASLContext > getContext

(

)

Return the SASL context.

Returns

SASL context

References SASLSession::evaluateChallenge().

getMechanism()

shared_ptr< SASLMechanism > getMechanism

(

)

Return the mechanism used for this session.

Returns

SASL mechanism

getSecuredSocket()

shared_ptr< net::socket > getSecuredSocket

(

shared_ptr< net::socket >

sok

)

Return a socket in which transmitted data is integrity and/or privacy protected, depending on the QOP (Quality of Protection) negotiated during the SASL authentication.

Parameters

sok	socket to wrap

Returns

secured socket

getServiceName()

const string getServiceName

(

)

const

Return the name of the service which is using this SASL session (eg.

"imap"). This value should be returned by the authenticator when INFO_SERVICE is requested.

Returns

service name

References SASLSession::getAuthenticator().

init()

void init

(

)

Initialize this SASL session.

This must be called before calling any other method on this object (except accessors).

---

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

• SASLSession.hpp
• SASLSession.cpp