mrs::authentication::SaslHandler Class Reference

#include <sasl_handler.h>

Inheritance diagram for mrs::authentication::SaslHandler:

Classes
struct	SaslData
struct	SaslResult
class	SaslSessionData

Public Types
enum	AuthenticationState { AuthenticationStateExchange , AuthenticationStateInitialResponse , AuthenticationStateResponse , AuthenticationStateInvalid }
Public Types inherited from mrs::interface::AuthorizeHandler
using	SqlSessionCached = collector::MysqlCacheManager::CachedObject
using	AuthUser = mrs::database::entry::AuthUser
using	AuthApp = mrs::database::entry::AuthApp
using	RequestContext = rest::RequestContext
using	Session = http::SessionManager::Session
using	SessionPtr = http::SessionManager::SessionPtr
using	UserManager = mrs::users::UserManager

Public Member Functions
	SaslHandler (const AuthApp &entry, QueryFactory *qf)
const AuthApp &	get_entry () const override
std::set< UniversalId >	get_service_ids () const override
UniversalId	get_id () const override
virtual std::unique_ptr< SessionData >	allocate_session_data ()=0
bool	redirects (RequestContext &ctxt) const override
bool	authorize (RequestContext &ctxt, const SessionPtr &session, AuthUser *out_user) override
virtual AuthenticationState	get_authentication_state (const UrlParameters &parameters, const bool has_auth_data)
virtual SaslResult	client_request_authentication_exchange (RequestContext &ctxt, Session *session, AuthUser *out_user)=0
virtual SaslResult	client_initial_response (RequestContext &ctxt, Session *session, AuthUser *out_user, const std::string &auth_data, const bool is_json)=0
virtual SaslResult	client_response (RequestContext &ctxt, Session *session, AuthUser *out_user, const std::string &auth_data, const bool is_json)=0
UserManager &	get_user_manager () override
Public Member Functions inherited from mrs::interface::AuthorizeHandler
virtual	~AuthorizeHandler ()=default
virtual const std::string &	get_handler_name () const =0
virtual std::optional< std::string >	get_session_id_from_request_data (RequestContext &ctxt)=0
virtual void	pre_authorize_account (AuthorizeHandler *handler, const std::string &account)=0

Protected Types
using	HttpResult = mrs::interface::HttpResult
using	AuthApp = database::entry::AuthApp
using	duration = std::chrono::steady_clock::duration
using	seconds = std::chrono::seconds
using	steady_clock = std::chrono::steady_clock
using	time_point = std::chrono::steady_clock::time_point
using	HttpMethodType = ::http::base::method::key_type
using	UserManager = mrs::users::UserManager
using	SessionManager = mrs::http::SessionManager
using	VariantPointer = helper::VariantPointer
using	UrlParameters = helper::http::Url::Parameters
using	SessionData = http::SessionManager::Session::SessionData
using	QueryFactory = mrs::interface::QueryFactory

Protected Member Functions
SaslData	get_authorize_data (RequestContext &ctxt)

Protected Attributes
AuthApp	entry_
UserManager	um_

Member Typedef Documentation

AuthApp

using mrs::authentication::SaslHandler::AuthApp = database::entry::AuthApp

protected

duration

using mrs::authentication::SaslHandler::duration = std::chrono::steady_clock::duration

protected

HttpMethodType

using mrs::authentication::SaslHandler::HttpMethodType = ::http::base::method::key_type

protected

HttpResult

using mrs::authentication::SaslHandler::HttpResult = mrs::interface::HttpResult

protected

QueryFactory

using mrs::authentication::SaslHandler::QueryFactory = mrs::interface::QueryFactory

protected

seconds

using mrs::authentication::SaslHandler::seconds = std::chrono::seconds

protected

SessionData

using mrs::authentication::SaslHandler::SessionData = http::SessionManager::Session::SessionData

protected

SessionManager

using mrs::authentication::SaslHandler::SessionManager = mrs::http::SessionManager

protected

steady_clock

using mrs::authentication::SaslHandler::steady_clock = std::chrono::steady_clock

protected

time_point

using mrs::authentication::SaslHandler::time_point = std::chrono::steady_clock::time_point

protected

UrlParameters

using mrs::authentication::SaslHandler::UrlParameters = helper::http::Url::Parameters

protected

UserManager

using mrs::authentication::SaslHandler::UserManager = mrs::users::UserManager

protected

VariantPointer

using mrs::authentication::SaslHandler::VariantPointer = helper::VariantPointer

protected

Member Enumeration Documentation

AuthenticationState

enum mrs::authentication::SaslHandler::AuthenticationState

Enumerator
AuthenticationStateExchange
AuthenticationStateInitialResponse
AuthenticationStateResponse
AuthenticationStateInvalid

Constructor & Destructor Documentation

SaslHandler()

mrs::authentication::SaslHandler::SaslHandler	(	const AuthApp &	entry,
		QueryFactory *	qf
	)

Member Function Documentation

allocate_session_data()

virtual std::unique_ptr< SessionData > mrs::authentication::SaslHandler::allocate_session_data ( )

pure virtual

Implemented in mrs::authentication::ScramHandler.

authorize()

bool mrs::authentication::SaslHandler::authorize ( RequestContext &  ctxt, const SessionPtr &  session, AuthUser *  out_user  )

overridevirtual

Implements mrs::interface::AuthorizeHandler.

client_initial_response()

virtual SaslResult mrs::authentication::SaslHandler::client_initial_response ( RequestContext &  ctxt, Session *  session, AuthUser *  out_user, const std::string &  auth_data, const bool  is_json  )

pure virtual

Implemented in mrs::authentication::ScramHandler.

client_request_authentication_exchange()

virtual SaslResult mrs::authentication::SaslHandler::client_request_authentication_exchange ( RequestContext &  ctxt, Session *  session, AuthUser *  out_user  )

pure virtual

Implemented in mrs::authentication::ScramHandler.

client_response()

virtual SaslResult mrs::authentication::SaslHandler::client_response ( RequestContext &  ctxt, Session *  session, AuthUser *  out_user, const std::string &  auth_data, const bool  is_json  )

pure virtual

Implemented in mrs::authentication::ScramHandler.

get_authentication_state()

AuthenticationState mrs::authentication::SaslHandler::get_authentication_state ( const UrlParameters &  parameters, const bool  has_auth_data  )

virtual

get_authorize_data()

SaslData mrs::authentication::SaslHandler::get_authorize_data ( RequestContext &  ctxt )

protected

get_entry()

const AuthApp & mrs::authentication::SaslHandler::get_entry ( ) const

overridevirtual

Implements mrs::interface::AuthorizeHandler.

get_id()

UniversalId mrs::authentication::SaslHandler::get_id ( ) const

overridevirtual

Implements mrs::interface::AuthorizeHandler.

get_service_ids()

std::set< UniversalId > mrs::authentication::SaslHandler::get_service_ids ( ) const

overridevirtual

Implements mrs::interface::AuthorizeHandler.

get_user_manager()

UserManager & mrs::authentication::SaslHandler::get_user_manager ( )

inlineoverridevirtual

Implements mrs::interface::AuthorizeHandler.

redirects()

bool mrs::authentication::SaslHandler::redirects ( RequestContext &  ctxt ) const

overridevirtual

Implements mrs::interface::AuthorizeHandler.

Reimplemented in mrs::authentication::ScramHandler.

Member Data Documentation

entry_

AuthApp mrs::authentication::SaslHandler::entry_

protected

um_

UserManager mrs::authentication::SaslHandler::um_

protected

---

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

• router/src/mysql_rest_service/src/mrs/authentication/sasl_handler.h
• router/src/mysql_rest_service/src/mrs/authentication/sasl_handler.cc