1 /***************************************************************************
2 * Copyright (C) 2005-2015 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 ***************************************************************************/
21 /* This file contains an implementation of an LDAP Authenticator, as an example
22 * of what a custom external auth provider could do.
24 * It's based off of this pull request for quassel by abustany:
25 * https://github.com/quassel/quassel/pull/4/
29 #ifndef LDAPAUTHENTICATOR_H
30 #define LDAPAUTHENTICATOR_H
32 #include "authenticator.h"
37 /* We should use openldap on windows if at all possible, rather than trying to
38 * write some kind of compatiblity routine.
46 // Default LDAP server port.
47 #define DEFAULT_LDAP_PORT 389
49 class LdapAuthenticator : public Authenticator
54 LdapAuthenticator(QObject *parent = 0);
55 virtual ~LdapAuthenticator();
59 bool isAvailable() const;
60 QString backendId() const;
61 QString description() const;
62 virtual QStringList setupKeys() const;
63 virtual QVariantMap setupDefaults() const;
65 virtual inline bool canChangePassword() const { return false; }
67 bool setup(const QVariantMap &settings = QVariantMap());
68 State init(const QVariantMap &settings = QVariantMap());
69 UserId validateUser(const QString &user, const QString &password);
72 virtual void setConnectionProperties(const QVariantMap &properties);
74 void ldapDisconnect();
75 bool ldapAuth(const QString &username, const QString &password);
77 // Protected methods for retrieving info about the LDAP connection.
78 inline virtual QString hostName() { return _hostName; }
79 inline virtual int port() { return _port; }
80 inline virtual QString bindDN() { return _bindDN; }
81 inline virtual QString baseDN() { return _baseDN; }
89 QString _bindPassword;
90 QString _uidAttribute;
92 // The actual connection object.