authenticationrealm.h

/*
 * SPDX-FileCopyrightText: (C) 2013-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef AUTHENTICATIONREALM_H
#define AUTHENTICATIONREALM_H
 
#include <Cutelyst/Plugins/Authentication/authenticationuser.h>
#include <Cutelyst/component.h>
 
namespace Cutelyst {
 
class Context;
class AuthenticationStore;
class AuthenticationCredential;

class CUTELYST_PLUGIN_AUTHENTICATION_EXPORT AuthenticationRealm : public Component
{
    Q_OBJECT
public:
    static const QStringView defaultRealm;

    explicit AuthenticationRealm(std::shared_ptr<AuthenticationStore> store,
                                 std::shared_ptr<AuthenticationCredential> credential,
                                 QStringView name = defaultRealm,
                                 QObject *parent  = nullptr);
    ~AuthenticationRealm() override;

    [[nodiscard]] std::shared_ptr<AuthenticationStore> store() const noexcept;

    [[nodiscard]] std::shared_ptr<AuthenticationCredential> credential() const noexcept;

    [[nodiscard]] virtual AuthenticationUser findUser(Context *c, const ParamsMultiMap &userinfo);

    [[nodiscard]] virtual AuthenticationUser authenticate(Context *c,
                                                          const ParamsMultiMap &authinfo);

    void removePersistedUser(Context *c);

    AuthenticationUser persistUser(Context *c, const AuthenticationUser &user);

    [[nodiscard]] AuthenticationUser restoreUser(Context *c, const QVariant &frozenUser);

    [[nodiscard]] QVariant userIsRestorable(Context *c);

    [[nodiscard]] bool checkPassword(Context *c,
                                     const AuthenticationUser &user,
                                     const QString &password,
                                     const QString &passwordField = QStringLiteral("password"));
 
private:
    friend class Authentication;
    friend class AuthenticationPrivate;
 
    std::shared_ptr<AuthenticationStore> m_store;
    std::shared_ptr<AuthenticationCredential> m_credential;
};
 
} // namespace Cutelyst
 
#endif // AUTHENTICATIONREALM_H