1 /***************************************************************************
2 * Copyright (C) 2005-2016 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
25 #include <QStringList>
30 class Authenticator : public QObject {
35 Authenticator(QObject *parent = 0);
36 virtual ~Authenticator() {};
39 IsReady, // ready to go
40 NeedsSetup, // need basic setup (ask the user for input)
41 NotAvailable // remove the authenticator backend from the list of avaliable authenticators.
48 //! Check if the authenticator type is available.
49 /** An authenticator subclass should return true if it can be successfully used, i.e. if all
50 * prerequisites are in place.
51 * \return True if and only if the authenticator class can be successfully used.
53 virtual bool isAvailable() const = 0;
55 //! Returns the display name of the authenticator backend
56 /** \return A string that can be used by the client to name the authenticator backend */
57 virtual QString backendId() const = 0;
59 //! Returns a description of this authenticator backend
60 /** \return A string that can be displayed by the client to describe the authenticator */
61 virtual QString description() const = 0;
63 //! Returns a list of properties required to use the authenticator backend
64 virtual QStringList setupKeys() const = 0;
66 //! Checks if the authenticator allows manual password changes from inside quassel.
67 virtual bool canChangePassword() const = 0;
69 //! Returns a map where the keys are are properties to use the authenticator backend
70 /* the values are QVariants with default values */
71 virtual QVariantMap setupDefaults() const = 0;
73 //! Setup the authenticator provider.
74 /** This prepares the authenticator provider (e.g. create tables, etc.) for use within Quassel.
75 * \param settings Hostname, port, username, password, ...
76 * \return True if and only if the authenticator provider was initialized successfully.
78 virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0;
80 //! Initialize the authenticator provider
81 /** \param settings Hostname, port, username, password, ...
82 * \return the State the authenticator backend is now in (see authenticator::State)
84 virtual State init(const QVariantMap &settings = QVariantMap()) = 0;
86 //! Validate a username with a given password.
87 /** \param user The username to validate
88 * \param password The user's alleged password
89 * \return A valid UserId if the password matches the username; 0 else
91 virtual UserId validateUser(const QString &user, const QString &password) = 0;