mrs::authentication::WwwAuthenticationHandler Class Reference

#include <www_authentication_handler.h>

Inheritance diagram for mrs::authentication::WwwAuthenticationHandler:

Classes
struct	Credentials

Public Member Functions
	WwwAuthenticationHandler (const AuthApp &entry, QueryFactory *qf)
UserManager &	get_user_manager () override
Public Member Functions inherited from mrs::interface::AuthorizeHandler
virtual	~AuthorizeHandler ()=default
virtual std::set< UniversalId >	get_service_ids () const =0
virtual UniversalId	get_id () const =0
virtual const std::string &	get_handler_name () const =0
virtual void	pre_authorize_account (AuthorizeHandler *handler, const std::string &account)=0

Static Public Attributes
constexpr static char	kAuthorization [] = "Authorization"
constexpr static char	kWwwAuthenticate [] = "WWW-Authenticate"

Protected Types
using	SessionManager = mrs::http::SessionManager
using	UserManager = mrs::users::UserManager
using	QueryFactory = mrs::interface::QueryFactory
using	Session = mrs::http::SessionManager::Session

Protected Member Functions
bool	validate_redirection_url (const std::optional< std::string > &url)
std::optional< Credentials >	authorize_method_get (RequestContext &ctxt, Session *session)
std::optional< Credentials >	authorize_method_post (RequestContext &ctxt, Session *session)
virtual bool	verify_credential (const Credentials &credentials, SqlSessionCached *out_cache, AuthUser *out_user)=0
void	throw_add_www_authenticate (const char *schema)
bool	redirects (RequestContext &ctxt) const override
bool	authorize (RequestContext &ctxt, const SessionPtr &session, AuthUser *out_user) override
std::optional< std::string >	get_session_id_from_request_data (RequestContext &) override
const AuthApp &	get_entry () const override

Protected Attributes
AuthApp	entry_
UserManager	um_

Additional Inherited Members
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

Member Typedef Documentation

QueryFactory

using mrs::authentication::WwwAuthenticationHandler::QueryFactory = mrs::interface::QueryFactory

protected

Session

using mrs::authentication::WwwAuthenticationHandler::Session = mrs::http::SessionManager::Session

protected

SessionManager

using mrs::authentication::WwwAuthenticationHandler::SessionManager = mrs::http::SessionManager

protected

UserManager

using mrs::authentication::WwwAuthenticationHandler::UserManager = mrs::users::UserManager

protected

Constructor & Destructor Documentation

WwwAuthenticationHandler()

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

inline

Member Function Documentation

authorize()

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

overrideprotectedvirtual

Implements mrs::interface::AuthorizeHandler.

authorize_method_get()

std::optional< WwwAuthenticationHandler::Credentials > mrs::authentication::WwwAuthenticationHandler::authorize_method_get ( RequestContext &  ctxt, Session *  session  )

protected

authorize_method_post()

std::optional< WwwAuthenticationHandler::Credentials > mrs::authentication::WwwAuthenticationHandler::authorize_method_post ( RequestContext &  ctxt, Session *  session  )

protected

get_entry()

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

overrideprotectedvirtual

Implements mrs::interface::AuthorizeHandler.

get_session_id_from_request_data()

std::optional< std::string > mrs::authentication::WwwAuthenticationHandler::get_session_id_from_request_data ( RequestContext &  )

overrideprotectedvirtual

Implements mrs::interface::AuthorizeHandler.

get_user_manager()

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

inlineoverridevirtual

Implements mrs::interface::AuthorizeHandler.

redirects()

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

overrideprotectedvirtual

Implements mrs::interface::AuthorizeHandler.

throw_add_www_authenticate()

void mrs::authentication::WwwAuthenticationHandler::throw_add_www_authenticate ( const char *  schema )

protected

validate_redirection_url()

bool mrs::authentication::WwwAuthenticationHandler::validate_redirection_url ( const std::optional< std::string > &  url )

protected

verify_credential()

virtual bool mrs::authentication::WwwAuthenticationHandler::verify_credential ( const Credentials &  credentials, SqlSessionCached *  out_cache, AuthUser *  out_user  )

protectedpure virtual

Implemented in mrs::authentication::MysqlHandler.

Member Data Documentation

entry_

AuthApp mrs::authentication::WwwAuthenticationHandler::entry_

protected

kAuthorization

constexpr static char mrs::authentication::WwwAuthenticationHandler::kAuthorization[] = "Authorization"

staticconstexpr

kWwwAuthenticate

constexpr static char mrs::authentication::WwwAuthenticationHandler::kWwwAuthenticate[] = "WWW-Authenticate"

staticconstexpr

um_

UserManager mrs::authentication::WwwAuthenticationHandler::um_

protected

---

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

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