mongo::SaslClientConversation Class Reference

Abstract class for implementing the clent-side of a SASL mechanism conversation. More...

#include <sasl_client_conversation.h>

Inheritance diagram for mongo::SaslClientConversation:

Public Member Functions
	SaslClientConversation (SaslClientSession *saslClientSession)
	Implements the client side of a SASL authentication mechanism. More...
virtual StatusWith< bool >	step (const StringData &inputData, std::string *outputData)=0
	Performs one step of the client side of the authentication session, consuming "inputData" and producing "*outputData". More...

Detailed Description

Abstract class for implementing the clent-side of a SASL mechanism conversation.

Constructor & Destructor Documentation

mongo::SaslClientConversation::SaslClientConversation ( SaslClientSession *  saslClientSession )

inlineexplicit

Implements the client side of a SASL authentication mechanism.

"saslClientSession" is the corresponding SASLClientSession. "saslClientSession" must stay in scope until the SaslClientConversation's destructor completes.

Member Function Documentation

virtual StatusWith<bool> mongo::SaslClientConversation::step ( const StringData &  inputData, std::string *  outputData  )

pure virtual

Performs one step of the client side of the authentication session, consuming "inputData" and producing "*outputData".

A return of Status::OK() indicates successful progress towards authentication. A return of !Status::OK() indicates failed authentication

A return of true means that the authentication process has finished. A return of false means that the authentication process has more steps.

Implemented in mongo::SaslSCRAMSHA1ClientConversation, and mongo::SaslPLAINClientConversation.

---

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

• src/mongo/client/sasl_client_conversation.h