X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fldapauthenticator.cpp;h=90b7e8941bceed917fb4940430fb9f83635db12b;hp=40085e2dd27b547a7dd2393c1128f79b7e920046;hb=7fb88a023ef8e4658b39d22c2d88c0d8bd6709f8;hpb=61aac1868f15babb7086d8bc6bbcff530346f438 diff --git a/src/core/ldapauthenticator.cpp b/src/core/ldapauthenticator.cpp index 40085e2d..90b7e894 100644 --- a/src/core/ldapauthenticator.cpp +++ b/src/core/ldapauthenticator.cpp @@ -18,20 +18,266 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ +/* This file contains an implementation of an LDAP Authenticator, as an example + * of what a custom external auth provider could do. + * + * It's based off of this pull request for quassel by abustany: + * https://github.com/quassel/quassel/pull/4/ + * + */ + #include "ldapauthenticator.h" +#include "logger.h" #include "network.h" #include "quassel.h" +// Link against LDAP. +#include + LdapAuthenticator::LdapAuthenticator(QObject *parent) - : LdapAuthenticator(parent), - _port(-1) + : Authenticator(parent), + _connection(0) { } LdapAuthenticator::~LdapAuthenticator() { + if (_connection != 0) + { + ldap_unbind_ext(_connection, 0, 0); + } +} + + +bool LdapAuthenticator::isAvailable() const +{ + // XXX: probably this should test if we can speak to the LDAP server. + return true; +} + +QString LdapAuthenticator::displayName() const +{ + // We identify the backend to use for the monolithic core by its displayname. + // so only change this string if you _really_ have to and make sure the core + // setup for the mono client still works ;) + return QString("LDAP"); +} + +QString LdapAuthenticator::description() const +{ + return tr("Authenticate users using an LDAP server."); +} + +QStringList LdapAuthenticator::setupKeys() const +{ + // The parameters needed for LDAP. + QStringList keys; + keys << "Hostname" + << "Port" + << "Bind DN" + << "Bind Password" + << "Base DN" + << "Filter" + << "UID Attribute"; + return keys; +} + +QVariantMap LdapAuthenticator::setupDefaults() const +{ + QVariantMap map; + map["Hostname"] = QVariant(QString("ldap://localhost")); + map["Port"] = QVariant(DEFAULT_LDAP_PORT); + map["UID Attribute"] = QVariant(QString("uid")); + return map; } -// XXX: TODO: write the actual LDAP code. \ No newline at end of file +void LdapAuthenticator::setConnectionProperties(const QVariantMap &properties) +{ + _hostName = properties["Hostname"].toString(); + _port = properties["Port"].toInt(); + _baseDN = properties["Base DN"].toString(); + _filter = properties["Filter"].toString(); + _bindDN = properties["Bind DN"].toString(); + _bindPassword = properties["Bind Password"].toString(); + _uidAttribute = properties["UID Attribute"].toString(); +} + +// XXX: this code is sufficiently general that in the future, perhaps an abstract +// class should be created implementing it. +// i.e. a provider that does its own thing and then pokes at the current storage +// through the default core method. +UserId LdapAuthenticator::validateUser(const QString &username, const QString &password) +{ + bool result = ldapAuth(username, password); + if (!result) + { + return UserId(); + } + + // If auth succeeds, but the user has not logged into quassel previously, make + // a new user for them and return that ID. + // Users created via LDAP have empty passwords, but authenticator column = LDAP. + // On the other hand, if auth succeeds and the user already exists, do a final + // cross-check to confirm we're using the right auth provider. + UserId quasselID = Core::validateUser(username, QString()); + if (!quasselID.isValid()) + { + return Core::addUser(username, QString(), displayName()); + } + else if (!(Core::checkAuthProvider(quasselID, displayName()))) + { + return 0; + } + return quasselID; +} + +bool LdapAuthenticator::setup(const QVariantMap &settings) +{ + setConnectionProperties(settings); + bool status = ldapConnect(); + return status; +} + +Authenticator::State LdapAuthenticator::init(const QVariantMap &settings) +{ + setConnectionProperties(settings); + + bool status = ldapConnect(); + if (!status) + { + quInfo() << qPrintable(displayName()) << "Authenticator cannot connect."; + return NotAvailable; + } + + quInfo() << qPrintable(displayName()) << "Authenticator is ready."; + return IsReady; +} + +// Method based on abustany LDAP quassel patch. +bool LdapAuthenticator::ldapConnect() +{ + if (_connection != 0) { + ldapDisconnect(); + } + + int res, v = LDAP_VERSION3; + + QString serverURI; + QByteArray serverURIArray; + + // Convert info to hostname:port. + serverURI = _hostName + ":" + QString::number(_port); + serverURIArray = serverURI.toLocal8Bit(); + res = ldap_initialize(&_connection, serverURIArray); + + if (res != LDAP_SUCCESS) { + qWarning() << "Could not connect to LDAP server:" << ldap_err2string(res); + return false; + } + + res = ldap_set_option(_connection, LDAP_OPT_PROTOCOL_VERSION, (void*)&v); + + if (res != LDAP_SUCCESS) { + qWarning() << "Could not set LDAP protocol version to v3:" << ldap_err2string(res); + ldap_unbind_ext(_connection, 0, 0); + _connection = 0; + return false; + } + + return true; +} + +void LdapAuthenticator::ldapDisconnect() +{ + if (_connection == 0) { + return; + } + + ldap_unbind_ext(_connection, 0, 0); + _connection = 0; +} + +bool LdapAuthenticator::ldapAuth(const QString &username, const QString &password) +{ + if (password.isEmpty()) { + return false; + } + + int res; + + // Attempt to establish a connection. + if (_connection == 0) { + if (not ldapConnect()) { + return false; + } + } + + struct berval cred; + + // Convert some things to byte arrays as needed. + QByteArray bindPassword = _bindPassword.toLocal8Bit(); + QByteArray bindDN = _bindDN.toLocal8Bit(); + QByteArray baseDN = _baseDN.toLocal8Bit(); + QByteArray uidAttribute = _uidAttribute.toLocal8Bit(); + + cred.bv_val = const_cast(bindPassword.size() > 0 ? bindPassword.constData() : NULL); + cred.bv_len = bindPassword.size(); + + res = ldap_sasl_bind_s(_connection, bindDN.size() > 0 ? bindDN.constData() : 0, LDAP_SASL_SIMPLE, &cred, 0, 0, 0); + + if (res != LDAP_SUCCESS) { + qWarning() << "Refusing connection from" << username << "(LDAP bind failed:" << ldap_err2string(res) << ")"; + ldapDisconnect(); + return false; + } + + LDAPMessage *msg = NULL, *entry = NULL; + + const QByteArray ldapQuery = "(&(" + uidAttribute + '=' + username.toLocal8Bit() + ")" + _filter.toLocal8Bit() + ")"; + + res = ldap_search_ext_s(_connection, baseDN.constData(), LDAP_SCOPE_SUBTREE, ldapQuery.constData(), 0, 0, 0, 0, 0, 0, &msg); + + if (res != LDAP_SUCCESS) { + qWarning() << "Refusing connection from" << username << "(LDAP search failed:" << ldap_err2string(res) << ")"; + return false; + } + + if (ldap_count_entries(_connection, msg) > 1) { + qWarning() << "Refusing connection from" << username << "(LDAP search returned more than one result)"; + ldap_msgfree(msg); + return false; + } + + entry = ldap_first_entry(_connection, msg); + + if (entry == 0) { + qWarning() << "Refusing connection from" << username << "(LDAP search returned no results)"; + ldap_msgfree(msg); + return false; + } + + const QByteArray passwordArray = password.toLocal8Bit(); + cred.bv_val = const_cast(passwordArray.constData()); + cred.bv_len = password.size(); + + char *userDN = ldap_get_dn(_connection, entry); + + res = ldap_sasl_bind_s(_connection, userDN, LDAP_SASL_SIMPLE, &cred, 0, 0, 0); + + if (res != LDAP_SUCCESS) { + qWarning() << "Refusing connection from" << username << "(LDAP authentication failed)"; + ldap_memfree(userDN); + ldap_msgfree(msg); + return false; + } + + // The original implementation had requiredAttributes. I have not included this code + // but it would be easy to re-add if someone wants this feature. + // Ben Rosser (12/23/15). + + ldap_memfree(userDN); + ldap_msgfree(msg); + return true; +}