net::auth::AuthentificationContext Class Reference

A thin wrapper around the username. More...

#include <auth.h>

Inheritance diagram for net::auth::AuthentificationContext:

Collaboration diagram for net::auth::AuthentificationContext:

Public Member Functions
	AuthentificationContext (User user)
	AuthentificationContext ()
void	set_remote_identifier (RemoteIdentifier r)
bool	can_do (SecurityLevel task) const
bool	hasBetterClearenceThen (const User &other) const
void	login (const User &user)
User	user () const
size_t	printTo (Print &p) const override

Detailed Description

A thin wrapper around the username.

Note that we do not support logouts. Logout happens when the context object is destroyed. The scope is typically given by the TCP/IP session.

Definition at line 231 of file auth.h.

Constructor & Destructor Documentation

AuthentificationContext() [1/2]

net::auth::AuthentificationContext::AuthentificationContext ( User user )

inline

Definition at line 238 of file auth.h.

AuthentificationContext() [2/2]

net::auth::AuthentificationContext::AuthentificationContext ( )

inline

Definition at line 240 of file auth.h.

Member Function Documentation

can_do()

bool net::auth::AuthentificationContext::can_do ( SecurityLevel task ) const

inline

Definition at line 244 of file auth.h.

References net::auth::UserPasswordAuthentification::can_do(), and utils::HeapSingleton< Gatekeeper >::get().

Referenced by msg::JsonLinesProtocol::handleMessage(), hasBetterClearenceThen(), and net::auth::Gatekeeper::lock_release().

hasBetterClearenceThen()

bool net::auth::AuthentificationContext::hasBetterClearenceThen ( const User & other ) const

inline

Definition at line 253 of file auth.h.

References can_do(), net::auth::UserPasswordAuthentification::can_do(), net::auth::RequiresAdmin, and net::auth::RequiresLogin.

Referenced by net::auth::Gatekeeper::login().

login()

void net::auth::AuthentificationContext::login ( const User & user )

inline

Definition at line 258 of file auth.h.

References user().

Referenced by net::auth::Gatekeeper::login().

printTo()

size_t net::auth::AuthentificationContext::printTo ( Print & p ) const

inlineoverride

Definition at line 262 of file auth.h.

References net::auth::RemoteIdentifier::printTo(), and user().

set_remote_identifier()

void net::auth::AuthentificationContext::set_remote_identifier ( RemoteIdentifier r )

inline

Definition at line 242 of file auth.h.

Referenced by web::LucidacWebsocketsClient::LucidacWebsocketsClient().

user()

User net::auth::AuthentificationContext::user ( ) const

inline

Definition at line 260 of file auth.h.

Referenced by net::auth::Gatekeeper::lock_acquire(), net::auth::Gatekeeper::lock_release(), login(), and printTo().

---

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

• lib/communication/src/net/auth.h