authentication.h

/*
 * SPDX-FileCopyrightText: (C) 2013-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef AUTHENTICATION_H
#define AUTHENTICATION_H
 
#include <Cutelyst/Plugins/Authentication/authenticationuser.h>
#include <Cutelyst/Plugins/authentication_export.h>
#include <Cutelyst/paramsmultimap.h>
#include <Cutelyst/plugin.h>
 
namespace Cutelyst {
 
class Context;
class AuthenticationStore;
class AuthenticationRealm;
 
class CUTELYST_PLUGIN_AUTHENTICATION_EXPORT AuthenticationCredential : public QObject
{
    Q_OBJECT
public:
    explicit AuthenticationCredential(QObject *parent = nullptr);
 
    virtual ~AuthenticationCredential();
 
    virtual AuthenticationUser
        authenticate(Context *c, AuthenticationRealm *realm, const ParamsMultiMap &authinfo) = 0;
};
 
class AuthenticationPrivate;
 
class CUTELYST_PLUGIN_AUTHENTICATION_EXPORT Authentication : public Plugin
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(Authentication)
public:
    static const QStringView defaultRealm;
 
    explicit Authentication(Application *parent);
 
    virtual ~Authentication() override;
 
    void addRealm(std::shared_ptr<AuthenticationRealm> realm);
 
    void addRealm(std::shared_ptr<AuthenticationStore> store,
                  std::shared_ptr<AuthenticationCredential> credential,
                  QStringView name = defaultRealm);
 
    [[nodiscard]] std::shared_ptr<AuthenticationRealm> realm(QStringView name = defaultRealm) const;
 
    [[nodiscard]] static bool
        authenticate(Context *c, const ParamsMultiMap &userinfo, QStringView realm = defaultRealm);
 
    [[nodiscard]] inline static bool authenticate(Context *c, QStringView realm = defaultRealm);
 
    [[nodiscard]] static AuthenticationUser
        findUser(Context *c, const ParamsMultiMap &userinfo, QStringView realm = defaultRealm);
 
    [[nodiscard]] static AuthenticationUser user(Context *c);
 
    [[nodiscard]] static bool userExists(Context *c);
 
    [[nodiscard]] static bool userInRealm(Context *c, QStringView realmName = defaultRealm);
 
    static void logout(Context *c);
 
protected:
    virtual bool setup(Application *app) override;
 
    AuthenticationPrivate *d_ptr;
};
 
inline bool Authentication::authenticate(Context *c, QStringView realm)
{
    return Authentication::authenticate(c, ParamsMultiMap(), realm);
}
 
} // namespace Cutelyst
 
#endif // AUTHENTICATION_H