authentication.h

/*
 * Copyright (C) 2013-2017 Daniel Nicoletti <dantti12@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef AUTHENTICATION_H
#define AUTHENTICATION_H
 
#include <Cutelyst/cutelyst_global.h>
#include <Cutelyst/plugin.h>
#include <Cutelyst/paramsmultimap.h>
#include <Cutelyst/Plugins/Authentication/authenticationuser.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 char *defaultRealm;
 
    Authentication(Application *parent);
    virtual ~Authentication() override;
 
    void addRealm(AuthenticationRealm *realm);
 
    void addRealm(AuthenticationStore *store, AuthenticationCredential *credential, const QString &name = QLatin1String(defaultRealm));
 
    AuthenticationRealm *realm(const QString &name = QLatin1String(defaultRealm)) const;
 
    static bool authenticate(Context *c, const ParamsMultiMap &userinfo, const QString &realm = QLatin1String(defaultRealm));
 
    inline static bool authenticate(Context *c, const QString &realm = QLatin1String(defaultRealm));
 
    static AuthenticationUser findUser(Context *c, const ParamsMultiMap &userinfo, const QString &realm = QLatin1String(defaultRealm));
 
    static AuthenticationUser user(Context *c);
 
    static bool userExists(Context *c);
 
    static bool userInRealm(Context *c, const QString &realmName = QLatin1String(defaultRealm));
 
    static void logout(Context *c);
 
protected:
    virtual bool setup(Application *app) override;
 
    AuthenticationPrivate *d_ptr;
};
 
inline bool Authentication::authenticate(Context *c, const QString &realm) {
    return Authentication::authenticate(c, ParamsMultiMap(), realm);
}
 
}
 
#endif // AUTHENTICATION_H