src/core/ldapauthenticator.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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  ***************************************************************************/
  20
  21 /* This file contains an implementation of an LDAP Authenticator, as an example
  22  * of what a custom external auth provider could do.
  23  *
  24  * It's based off of this pull request for quassel by abustany:
  25  * https://github.com/quassel/quassel/pull/4/
  26  *
  27  */
  28
  29 #include "ldapauthenticator.h"
  30
  31 #include "logger.h"
  32 #include "network.h"
  33 #include "quassel.h"
  34
  35 /* We should use openldap on windows if at all possible, rather than trying to
  36  * write some kind of compatiblity routine.
  37 #ifdef Q_CC_MSVC
  38 #include <windows.h>
  39 #include <winldap.h>
  40 #else*/
  41 #include <ldap.h>
  42 //#endif
  43
  44 LdapAuthenticator::LdapAuthenticator(QObject *parent)
  45     : Authenticator(parent),
  46     _connection(0)
  47 {
  48 }
  49
  50
  51 LdapAuthenticator::~LdapAuthenticator()
  52 {
  53     if (_connection != 0) {
  54         ldap_unbind_ext(_connection, 0, 0);
  55     }
  56 }
  57
  58
  59 bool LdapAuthenticator::isAvailable() const
  60 {
  61     // FIXME: probably this should test if we can speak to the LDAP server.
  62     return true;
  63 }
  64
  65
  66 QString LdapAuthenticator::backendId() const
  67 {
  68     // We identify the backend to use for the monolithic core by this identifier.
  69     // so only change this string if you _really_ have to and make sure the core
  70     // setup for the mono client still works ;)
  71     return QString("LDAP");
  72 }
  73
  74
  75 QString LdapAuthenticator::displayName() const
  76 {
  77     return tr("LDAP");
  78 }
  79
  80
  81 QString LdapAuthenticator::description() const
  82 {
  83     return tr("Authenticate users using an LDAP server.");
  84 }
  85
  86
  87 QVariantList LdapAuthenticator::setupData() const
  88 {
  89     // The parameters needed for LDAP.
  90     QVariantList data;
  91     data << "Hostname"     << tr("Hostname")      << QString{"ldap://localhost"}
  92          << "Port"         << tr("Port")          << DEFAULT_LDAP_PORT
  93          << "BindDN"       << tr("Bind DN")       << QString{}
  94          << "BindPassword" << tr("Bind Password") << QString{}
  95          << "BaseDN"       << tr("Base DN")       << QString{}
  96          << "Filter"       << tr("Filter")        << QString{}
  97          << "UidAttribute" << tr("UID Attribute") << QString{"uid"}
  98          ;
  99     return data;
 100 }
 101
 102
 103 void LdapAuthenticator::setAuthProperties(const QVariantMap &properties)
 104 {
 105     _hostName = properties["Hostname"].toString();
 106     _port = properties["Port"].toInt();
 107     _bindDN = properties["BindDN"].toString();
 108     _bindPassword = properties["BindPassword"].toString();
 109     _baseDN = properties["BaseDN"].toString();
 110     _filter = properties["Filter"].toString();
 111     _uidAttribute = properties["UidAttribute"].toString();
 112 }
 113
 114 // TODO: this code is sufficiently general that in the future, perhaps an abstract
 115 // class should be created implementing it.
 116 // i.e. a provider that does its own thing and then pokes at the current storage
 117 // through the default core method.
 118 UserId LdapAuthenticator::validateUser(const QString &username, const QString &password)
 119 {
 120     bool result = ldapAuth(username, password);
 121     if (!result) {
 122         return UserId();
 123     }
 124
 125     // LDAP is case-insensitive, thus we will lowercase the username, in spite of
 126     // a better solution :(
 127     const QString lUsername = username.toLower();
 128
 129     // If auth succeeds, but the user has not logged into quassel previously, make
 130     // a new user for them and return that ID.
 131     // Users created via LDAP have empty passwords, but authenticator column = LDAP.
 132     // On the other hand, if auth succeeds and the user already exists, do a final
 133     // cross-check to confirm we're using the right auth provider.
 134     UserId quasselId = Core::validateUser(lUsername, QString());
 135     if (!quasselId.isValid()) {
 136         return Core::addUser(lUsername, QString(), backendId());
 137     }
 138     else if (!(Core::checkAuthProvider(quasselId, backendId()))) {
 139         return 0;
 140     }
 141     return quasselId;
 142 }
 143
 144
 145 bool LdapAuthenticator::setup(const QVariantMap &settings)
 146 {
 147     setAuthProperties(settings);
 148     bool status = ldapConnect();
 149     return status;
 150 }
 151
 152
 153 Authenticator::State LdapAuthenticator::init(const QVariantMap &settings)
 154 {
 155     setAuthProperties(settings);
 156
 157     bool status = ldapConnect();
 158     if (!status) {
 159         quInfo() << qPrintable(backendId()) << "authenticator cannot connect.";
 160         return NotAvailable;
 161     }
 162
 163     quInfo() << qPrintable(backendId()) << "authenticator is ready.";
 164     return IsReady;
 165 }
 166
 167 // Method based on abustany LDAP quassel patch.
 168 bool LdapAuthenticator::ldapConnect()
 169 {
 170     if (_connection != 0) {
 171         ldapDisconnect();
 172     }
 173
 174     int res, v = LDAP_VERSION3;
 175
 176     QString serverURI;
 177     QByteArray serverURIArray;
 178
 179     // Convert info to hostname:port.
 180     serverURI = _hostName + ":" + QString::number(_port);
 181     serverURIArray = serverURI.toLocal8Bit();
 182     res = ldap_initialize(&_connection, serverURIArray);
 183
 184     quInfo() << "LDAP: Connecting to" << serverURI;
 185
 186     if (res != LDAP_SUCCESS) {
 187         qWarning() << "Could not connect to LDAP server:" << ldap_err2string(res);
 188         return false;
 189     }
 190
 191     res = ldap_set_option(_connection, LDAP_OPT_PROTOCOL_VERSION, (void*)&v);
 192
 193     if (res != LDAP_SUCCESS) {
 194         qWarning() << "Could not set LDAP protocol version to v3:" << ldap_err2string(res);
 195         ldap_unbind_ext(_connection, 0, 0);
 196         _connection = 0;
 197         return false;
 198     }
 199
 200     return true;
 201 }
 202
 203
 204 void LdapAuthenticator::ldapDisconnect()
 205 {
 206     if (_connection == 0) {
 207         return;
 208     }
 209
 210     ldap_unbind_ext(_connection, 0, 0);
 211     _connection = 0;
 212 }
 213
 214
 215 bool LdapAuthenticator::ldapAuth(const QString &username, const QString &password)
 216 {
 217     if (password.isEmpty()) {
 218         return false;
 219     }
 220
 221     int res;
 222
 223     // Attempt to establish a connection.
 224     if (_connection == 0) {
 225         if (!ldapConnect()) {
 226             return false;
 227         }
 228     }
 229
 230     struct berval cred;
 231
 232     // Convert some things to byte arrays as needed.
 233     QByteArray bindPassword = _bindPassword.toLocal8Bit();
 234     QByteArray bindDN = _bindDN.toLocal8Bit();
 235     QByteArray baseDN = _baseDN.toLocal8Bit();
 236     QByteArray uidAttribute = _uidAttribute.toLocal8Bit();
 237
 238     cred.bv_val = (bindPassword.size() > 0 ? bindPassword.data() : NULL);
 239     cred.bv_len = bindPassword.size();
 240
 241     res = ldap_sasl_bind_s(_connection, bindDN.size() > 0 ? bindDN.constData() : 0, LDAP_SASL_SIMPLE, &cred, 0, 0, 0);
 242
 243     if (res != LDAP_SUCCESS) {
 244         qWarning() << "Refusing connection from" << username << "(LDAP bind failed:" << ldap_err2string(res) << ")";
 245         ldapDisconnect();
 246         return false;
 247     }
 248
 249     LDAPMessage *msg = NULL, *entry = NULL;
 250
 251     const QByteArray ldapQuery = "(&(" + uidAttribute + '=' + username.toLocal8Bit() + ")" + _filter.toLocal8Bit() + ")";
 252
 253     res = ldap_search_ext_s(_connection, baseDN.constData(), LDAP_SCOPE_SUBTREE, ldapQuery.constData(), 0, 0, 0, 0, 0, 0, &msg);
 254
 255     if (res != LDAP_SUCCESS) {
 256         qWarning() << "Refusing connection from" << username << "(LDAP search failed:" << ldap_err2string(res) << ")";
 257         return false;
 258     }
 259
 260     if (ldap_count_entries(_connection, msg) > 1) {
 261         qWarning() << "Refusing connection from" << username << "(LDAP search returned more than one result)";
 262         ldap_msgfree(msg);
 263         return false;
 264     }
 265
 266     entry = ldap_first_entry(_connection, msg);
 267
 268     if (entry == 0) {
 269         qWarning() << "Refusing connection from" << username << "(LDAP search returned no results)";
 270         ldap_msgfree(msg);
 271         return false;
 272     }
 273
 274     QByteArray passwordArray = password.toLocal8Bit();
 275     cred.bv_val = passwordArray.data();
 276     cred.bv_len = password.size();
 277
 278     char *userDN = ldap_get_dn(_connection, entry);
 279
 280     res = ldap_sasl_bind_s(_connection, userDN, LDAP_SASL_SIMPLE, &cred, 0, 0, 0);
 281
 282     if (res != LDAP_SUCCESS) {
 283         qWarning() << "Refusing connection from" << username << "(LDAP authentication failed)";
 284         ldap_memfree(userDN);
 285         ldap_msgfree(msg);
 286         return false;
 287     }
 288
 289     // The original implementation had requiredAttributes. I have not included this code
 290     // but it would be easy to re-add if someone wants this feature.
 291     // Ben Rosser <bjr@acm.jhu.edu> (12/23/15).
 292
 293     ldap_memfree(userDN);
 294     ldap_msgfree(msg);
 295     return true;
 296 }