Cutelyst  2.13.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Cutelyst::Authentication Class Reference
Inheritance diagram for Cutelyst::Authentication:
Inheritance graph

Public Member Functions

 Authentication (Application *parent)
 Constructs a new Authentication object with the given parent.
void addRealm (AuthenticationRealm *realm)
 Adds the realm with name. More...
void addRealm (AuthenticationStore *store, AuthenticationCredential *credential, const QString &name=QLatin1String(defaultRealm))
 Creates a new AuthenticationRealm using store, credential and name to build it. More...
AuthenticationRealmrealm (const QString &name=QLatin1String(defaultRealm)) const
 Returns an AuthenticationRealm object that was registered with name.
- Public Member Functions inherited from Cutelyst::Plugin
 Plugin (Application *parent)

Static Public Member Functions

static bool authenticate (Context *c, const ParamsMultiMap &userinfo, const QString &realm=QLatin1String(defaultRealm))
static bool authenticate (Context *c, const QString &realm=QLatin1String(defaultRealm))
static AuthenticationUser findUser (Context *c, const ParamsMultiMap &userinfo, const QString &realm=QLatin1String(defaultRealm))
 Tries to find the user with userinfo using the realm, returning a non null AuthenticationUser on success.
static void logout (Context *c)
static AuthenticationUser user (Context *c)
static bool userExists (Context *c)
static bool userInRealm (Context *c, const QString &realmName=QLatin1String(defaultRealm))

Static Public Attributes

static char * defaultRealm
 default realm name

Protected Member Functions

virtual bool setup (Application *app) override

Detailed Description

Definition at line 49 of file authentication.h.

Member Function Documentation

◆ addRealm() [1/2]

void Authentication::addRealm ( Cutelyst::AuthenticationRealm realm)
This class will take ownership of realm.

Definition at line 55 of file authentication.cpp.

References realm().

◆ addRealm() [2/2]

void Cutelyst::Authentication::addRealm ( Cutelyst::AuthenticationStore store,
Cutelyst::AuthenticationCredential credential,
const QString &  name = QLatin1String(defaultRealm) 
This class will take ownership of realm, store and credential.

Definition at line 63 of file authentication.cpp.

◆ authenticate() [1/2]

bool Authentication::authenticate ( Cutelyst::Context c,
const ParamsMultiMap userinfo,
const QString &  realm = QLatin1String(defaultRealm) 

Returns true if the userinfo could be validated against a realm.

Definition at line 74 of file authentication.cpp.

References Cutelyst::AuthenticationRealm::authenticate(), Cutelyst::AuthenticationUser::isNull(), realm(), and user().

Referenced by authenticate().

◆ authenticate() [2/2]

bool Cutelyst::Authentication::authenticate ( Context c,
const QString &  realm = QLatin1String(defaultRealm) 

Returns true if the request information could be validated against a realm.

Definition at line 129 of file authentication.h.

References authenticate(), and realm().

◆ logout()

void Authentication::logout ( Context c)

Logs the user out. Deletes the currently logged in user from the Context and the session. It does not delete the session.

Definition at line 161 of file authentication.cpp.

References realm(), and Cutelyst::AuthenticationRealm::removePersistedUser().

◆ setup()

bool Authentication::setup ( Application app)

Reimplement this if you need to connect to the signals emitted from Cutelyst::Application

Reimplemented from Cutelyst::Plugin.

Definition at line 175 of file authentication.cpp.

References Cutelyst::Application::postForked().

◆ user()

Cutelyst::AuthenticationUser Authentication::user ( Cutelyst::Context c)

Returns the authenticated user if any, if you only need to know if the user is authenticated (rather than retrieving it's ID) use userExists instead which is faster.

Definition at line 113 of file authentication.cpp.

References Cutelyst::AuthenticationUser::isNull(), and Cutelyst::Context::stash().

Referenced by authenticate(), Cutelyst::RoleACL::canVisit(), and userInRealm().

◆ userExists()

bool Authentication::userExists ( Cutelyst::Context c)

Returns true if a user is logged in right now. The difference between userExists() and user() is that userExists will return true if a user is logged in, even if it has not been yet retrieved from the storage backend. If you only need to know if the user is logged in, depending on the storage mechanism this can be much more efficient. userExists() only looks into the session while user() is trying to restore the user.

Definition at line 125 of file authentication.cpp.

References Cutelyst::Context::stash().

◆ userInRealm()

bool Authentication::userInRealm ( Cutelyst::Context c,
const QString &  realmName = QLatin1String(defaultRealm) 

Works like user_exists, except that it only returns true if a user is both logged in right now and was retrieved from the realm provided.

Definition at line 141 of file authentication.cpp.

References Cutelyst::AuthenticationUser::isNull(), Cutelyst::Component::name(), realm(), Cutelyst::Context::stash(), and user().