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>
#include <Cutelyst/cutelyst_global.h>
 
namespace Cutelyst {
 
class Context;
class AuthenticationStore;
class AuthenticationCredential;
class CUTELYST_PLUGIN_AUTHENTICATION_EXPORT AuthenticationRealm : public Component
{
    Q_OBJECT
public:
    static char *defaultRealm;

    explicit AuthenticationRealm(AuthenticationStore *store,
                                 AuthenticationCredential *credential,
                                 const QString &name = QLatin1String(defaultRealm),
                                 QObject *parent     = nullptr);
    virtual ~AuthenticationRealm() override;

    AuthenticationStore *store() const;

    AuthenticationCredential *credential() const;

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

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

    void removePersistedUser(Context *c);

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

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

    QVariant userIsRestorable(Context *c);
 
private:
    friend class Authentication;
    friend class AuthenticationPrivate;
 
    AuthenticationStore *m_store;
    AuthenticationCredential *m_credential;
};
 
} // namespace Cutelyst
 
#endif // AUTHENTICATIONREALM_H