Dokumentace třídy Httpd::RequestAuthorizer

Kontroluje přihlašování uživatelů a jejich oprávnění přes webové rozhraní ...

#include <requestauthorizer.h>

Diagram dědičnosti pro třídu Httpd::RequestAuthorizer:

Veřejné metody
	RequestAuthorizer (HobrasoftHttpd::HttpConnection *parent)
	Konstruktor, načítá konfiguraci z konfiguračního souboru.
bool	isLoggedIn (HobrasoftHttpd::HttpRequest *, HobrasoftHttpd::HttpResponse *)
	Řídí přihlašování k webovému rozhraní
bool	isAuthorized (Security::Permissions::Permission) const
	Vrací true, pokud má přihlášený uživatel požadované oprávnění
Security::Roles::Role	role () const
AuthenticatedUser *	authenticatedUser () const

Privátní atributy
QString	m_adminuser
	Uživatelské jméno pro přihlášení, bere se z konfigurace.
QString	m_adminpassword
	Uživatelské heslo pro přihlášení, bere se z konfigurace.
bool	m_authorize
	Jestli se má přihlašovat, bere se z konfigurace.
AuthenticatedUser *	m_authenticatedUser

Detailní popis

Kontroluje přihlašování uživatelů a jejich oprávnění přes webové rozhraní

Definice je uvedena na řádku 31 v souboru requestauthorizer.h.

Dokumentace konstruktoru a destruktoru

RequestAuthorizer()

RequestAuthorizer::RequestAuthorizer

(

HobrasoftHttpd::HttpConnection *

parent

)

Konstruktor, načítá konfiguraci z konfiguračního souboru.

Definice je uvedena na řádku 39 v souboru requestauthorizer.cpp.

                                                                         : HobrasoftHttpd::HttpRequestHandler(parent) {
    m_authenticatedUser = nullptr;
}

Dokumentace členských funkcí

authenticatedUser()

AuthenticatedUser * Httpd::RequestAuthorizer::authenticatedUser ( ) const

inline

Definice je uvedena na řádku 69 v souboru requestauthorizer.h.

{ return m_authenticatedUser; }

isAuthorized()

bool RequestAuthorizer::isAuthorized

(

Security::Permissions::Permission

permission

)

const

Vrací true, pokud má přihlášený uživatel požadované oprávnění

Definice je uvedena na řádku 128 v souboru requestauthorizer.cpp.

                                                                                   {
    return GUARD->isGranted(permission, role());
}

isLoggedIn()

bool RequestAuthorizer::isLoggedIn	(	HobrasoftHttpd::HttpRequest *	request,
		HobrasoftHttpd::HttpResponse *	response )

Řídí přihlašování k webovému rozhraní

Návratová hodnota

V případě, že je uživatel přihlášený, vrací true - je možné pokračovat ve zpracování požadavku. V případě, že uživatel přihlášený není, vyvolá akce potřebné pro přihlášení (přesměrování na login stránku) a vrátí false - v takovém případě se je požadavek vyřízený a webový server nesmí ve zpracování pokračovat.

Definice je uvedena na řádku 44 v souboru requestauthorizer.cpp.

                                                                                                           {
    HttpSession session = SessionStore::sessionStore()->session(request, response);
 
    if (request->path() == "/unatuhenticate") {
        SessionStore::sessionStore()->remove(session);
        response->setStatus(204, "OK");
        response->flush();
        return false;
        }
 
    if (!request->parameter("user").isEmpty() && !request->parameter("password").isEmpty()) {
        session.add("user",     request->parameter("user"));
        session.add("password", request->parameter("password"));
        }
 
    QString user     = session.value("user").toString();
    QString password = session.value("password").toString();
 
    m_authenticatedUser = new AuthenticatedUser(this);
 
    if (!m_authenticatedUser->authenticate(user, password) && (
        request->path().contains(QRegExp(R"%(\.shtml)%")) ||
        request->path().contains(QRegExp(R"%(\.html)%")))) {
        m_authenticatedUser->setAuthenticated(false);
        response->setStatus(302, "Found");
        response->setHeader("Location", "/public/login.shtml");
        response->write("302 Found");
        response->flush();
        return false;
        }
 
    if (!m_authenticatedUser->authenticate(user, password)) {
        response->setStatus(401, "Unauthorized");
        response->flush();
        m_authenticatedUser->setAuthenticated(false);
        return false;
        }
 
    if (request->path() == "/api/v1/authenticate") {
        session.add("user", user);
        session.add("password", password);
        Db::Database *db = Db::Database::create(this, m_authenticatedUser);
 
        QList<Dbt::ServerInfo> list = db->serverInfo();
        QVariantMap data;
        data["userid"]             = m_authenticatedUser->user();
        data["username"]           = m_authenticatedUser->login();
        data["name"]               = m_authenticatedUser->name();
        data["admin"]              = m_authenticatedUser->admin();
        data["lang"]               = m_authenticatedUser->lang();
        data["server_name"]        = (list.isEmpty()) ? MSETTINGS->serverName()        : list.first().name;
        data["server_description"] = (list.isEmpty()) ? MSETTINGS->serverDescription() : list.first().description;
        data["server_git_commit"]  = GIT_COMMIT;
        data["server_git_branch"]  = GIT_BRANCH;
        data["server_version"]     = VERSION;
        data["server_qt_version"]  = qtVersion();
 
        QList<Dbt::ClientSettings> cslist = db->clientSettings();
        if (cslist.size() == 1) {
            const Dbt::ClientSettings& cs = cslist[0];
            data["multiple_timesheets"]      = cs.multiple_timesheets;
            data["show_price"]               = cs.show_price;
            data["can_change_category"]      = cs.can_change_category;
            data["edit_categories"]          = cs.edit_categories;
            data["show_multiple_timesheets"] = cs.show_multiple_timesheets;
            data["show_show_price"]          = cs.show_show_price;
            data["show_can_change_category"] = cs.show_can_change_category;
            data["show_edit_categories"]     = cs.show_edit_categories;
            }
        db->deleteLater();
 
        response->setStatus(200, "OK");
        response->setHeader("Content-Type",  "application/json");
        response->setHeader("Cache-Control", "no-cache,public");
        response->write(JSON::json(data));
        response->flush();
        return false; // ano, false!
        }
 
    return true;
 
}

role()

Security::Roles::Role RequestAuthorizer::role

(

)

const

Vrací roli přihlášeného uživatele

V současnosti se rozlišují dvě role: Admin a User. Adminem je uživatel, jehož jméno a heslo je uvedené v konfiguračním souborů. Uživatel admin může být jen jeden. Uživatelskou roli dostávají všichni uživatele vytvoření přes webové rozhraní a uložení v databází.

Pokud je v konfiguračním souboru zakázaná autorizace požadavků, může k serveru přes webové rozhraní přistupovat kdokoliv bez přihlášení s právy administrátora.

Definice je uvedena na řádku 133 v souboru requestauthorizer.cpp.

                                                {
    return Security::Roles::User;
}

Dokumentace datových členů

m_adminpassword

QString Httpd::RequestAuthorizer::m_adminpassword

private

Uživatelské heslo pro přihlášení, bere se z konfigurace.

Definice je uvedena na řádku 75 v souboru requestauthorizer.h.

m_adminuser

QString Httpd::RequestAuthorizer::m_adminuser

private

Uživatelské jméno pro přihlášení, bere se z konfigurace.

Definice je uvedena na řádku 74 v souboru requestauthorizer.h.

m_authenticatedUser

AuthenticatedUser* Httpd::RequestAuthorizer::m_authenticatedUser

private

Definice je uvedena na řádku 77 v souboru requestauthorizer.h.

m_authorize

bool Httpd::RequestAuthorizer::m_authorize

private

Jestli se má přihlašovat, bere se z konfigurace.

Definice je uvedena na řádku 76 v souboru requestauthorizer.h.

---

Dokumentace pro tuto třídu byla vygenerována z následujících souborů:

• httpd/requestauthorizer.h
• httpd/requestauthorizer.cpp