#include <XOAuth2SASLMechanism.hpp>

Inheritance diagram for XOAuth2SASLMechanism:

Collaboration diagram for XOAuth2SASLMechanism:

Public Member Functions
	XOAuth2SASLMechanism (shared_ptr< SASLContext > ctx, const string &name)

	~XOAuth2SASLMechanism ()

const string	getName () const

bool	step (shared_ptr< SASLSession > sess, const byte_t challenge, const size_t challengeLen, byte_t response, size_t responseLen)

bool	isComplete () const

bool	hasInitialResponse () const

void	encode (shared_ptr< SASLSession > sess, const byte_t input, const size_t inputLen, byte_t output, size_t outputLen)

void	decode (shared_ptr< SASLSession > sess, const byte_t input, const size_t inputLen, byte_t output, size_t outputLen)

virtual const string	getName () const =0

virtual bool	step (shared_ptr< SASLSession > sess, const byte_t challenge, const size_t challengeLen, byte_t response, size_t responseLen)=0

virtual bool	isComplete () const =0

virtual bool	hasInitialResponse () const =0

virtual void	encode (shared_ptr< SASLSession > sess, const byte_t input, const size_t inputLen, byte_t output, size_t outputLen)=0

virtual void	decode (shared_ptr< SASLSession > sess, const byte_t input, const size_t inputLen, byte_t output, size_t outputLen)=0

Additional Inherited Members
Protected Member Functions inherited from object
	object ()

	object (const object &)

object &	operator= (const object &)

virtual	~object ()

Detailed Description

SASL XOAUTH2 mechanism, used by GMail.

Constructor & Destructor Documentation

◆ XOAuth2SASLMechanism()

XOAuth2SASLMechanism	(	shared_ptr< SASLContext >	ctx,
		const string &	name
	)

◆ ~XOAuth2SASLMechanism()

~XOAuth2SASLMechanism ( )

Member Function Documentation

◆ decode()

void decode	(	shared_ptr< SASLSession >	sess,
		const byte_t *	input,
		const size_t	inputLen,
		byte_t **	output,
		size_t *	outputLen
	)

virtual

Decode data according to negotiated SASL mechanism.

This might mean that data is integrity or privacy protected.

Parameters

sess	SASL session
input	input buffer
inputLen	length of input buffer
output	output buffer (allocated bu the function, free with delete[])
outputLen	length of output buffer

Exceptions

exceptions::sasl_exception if an error occurred during the encoding of data (in this case, the values in 'output' and 'outputLen' are undetermined)

Implements SASLMechanism.

◆ encode()

void encode	(	shared_ptr< SASLSession >	sess,
		const byte_t *	input,
		const size_t	inputLen,
		byte_t **	output,
		size_t *	outputLen
	)

virtual

Encode data according to negotiated SASL mechanism.

This might mean that data is integrity or privacy protected.

Parameters

sess	SASL session
input	input buffer
inputLen	length of input buffer
output	output buffer (allocated bu the function, free with delete[])
outputLen	length of output buffer

Exceptions

exceptions::sasl_exception if an error occurred during the encoding of data (in this case, the values in 'output' and 'outputLen' are undetermined)

Implements SASLMechanism.

◆ getName()

const string getName ( ) const

virtual

Return the name of this mechanism.

Returns: mechanism name

Implements SASLMechanism.

◆ hasInitialResponse()

bool hasInitialResponse ( ) const

virtual

Determine if this mechanism has an optional initial response.

If true, caller should call step() with an empty challenge to get the initial response.

Returns: true if this mechanism has an initial response, or false otherwise

Implements SASLMechanism.

◆ isComplete()

bool isComplete ( ) const

virtual

Check whether authentication has completed.

If false, more calls to evaluateChallenge() are needed to complete the authentication process).

Returns: true if the authentication has finished, or false otherwise

Implements SASLMechanism.

◆ step()

bool step	(	shared_ptr< SASLSession >	sess,
		const byte_t *	challenge,
		const size_t	challengeLen,
		byte_t **	response,
		size_t *	responseLen
	)

virtual

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 this mechanism has one.

Parameters

sess	SASL session
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)

Implements SASLMechanism.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XOAuth2SASLMechanism()

◆ ~XOAuth2SASLMechanism()

Member Function Documentation

◆ decode()

◆ encode()

◆ getName()

◆ hasInitialResponse()

◆ isComplete()

◆ step()