src/core/coreauthhandler.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 #include "coreauthhandler.h"
  22
  23 #ifdef HAVE_SSL
  24 #  include <QSslSocket>
  25 #endif
  26
  27 #include "core.h"
  28 #include "logmessage.h"
  29
  30 using namespace Protocol;
  31
  32 CoreAuthHandler::CoreAuthHandler(QTcpSocket *socket, QObject *parent)
  33     : AuthHandler(parent),
  34     _peer(0),
  35     _magicReceived(false),
  36     _legacy(false),
  37     _clientRegistered(false),
  38     _connectionFeatures(0)
  39 {
  40     setSocket(socket);
  41     connect(socket, SIGNAL(readyRead()), SLOT(onReadyRead()));
  42
  43     // TODO: Timeout for the handshake phase
  44
  45 }
  46
  47
  48 void CoreAuthHandler::onReadyRead()
  49 {
  50     if (socket()->bytesAvailable() < 4)
  51         return;
  52
  53     // once we have selected a peer, we certainly don't want to read more data!
  54     if (_peer)
  55         return;
  56
  57     if (!_magicReceived) {
  58         quint32 magic;
  59         socket()->peek((char*)&magic, 4);
  60         magic = qFromBigEndian<quint32>(magic);
  61
  62         if ((magic & 0xffffff00) != Protocol::magic) {
  63             // no magic, assume legacy protocol
  64             qDebug() << "Legacy client detected, switching to compatibility mode";
  65             _legacy = true;
  66             RemotePeer *peer = PeerFactory::createPeer(PeerFactory::ProtoDescriptor(Protocol::LegacyProtocol, 0), this, socket(), Compressor::NoCompression, this);
  67             connect(peer, SIGNAL(protocolVersionMismatch(int,int)), SLOT(onProtocolVersionMismatch(int,int)));
  68             setPeer(peer);
  69             return;
  70         }
  71
  72         _magicReceived = true;
  73         quint8 features = magic & 0xff;
  74         // figure out which connection features we'll use based on the client's support
  75         if (Core::sslSupported() && (features & Protocol::Encryption))
  76             _connectionFeatures |= Protocol::Encryption;
  77         if (features & Protocol::Compression)
  78             _connectionFeatures |= Protocol::Compression;
  79
  80         socket()->read((char*)&magic, 4); // read the 4 bytes we've just peeked at
  81     }
  82
  83     // read the list of protocols supported by the client
  84     while (socket()->bytesAvailable() >= 4 && _supportedProtos.size() < 16) { // sanity check
  85         quint32 data;
  86         socket()->read((char*)&data, 4);
  87         data = qFromBigEndian<quint32>(data);
  88
  89         Protocol::Type type = static_cast<Protocol::Type>(data & 0xff);
  90         quint16 protoFeatures = static_cast<quint16>(data>>8 & 0xffff);
  91         _supportedProtos.append(PeerFactory::ProtoDescriptor(type, protoFeatures));
  92
  93         if (data >= 0x80000000) { // last protocol
  94             Compressor::CompressionLevel level;
  95             if (_connectionFeatures & Protocol::Compression)
  96                 level = Compressor::BestCompression;
  97             else
  98                 level = Compressor::NoCompression;
  99
 100             RemotePeer *peer = PeerFactory::createPeer(_supportedProtos, this, socket(), level, this);
 101             if (!peer) {
 102                 qWarning() << "Received invalid handshake data from client" << socket()->peerAddress().toString();
 103                 close();
 104                 return;
 105             }
 106
 107             if (peer->protocol() == Protocol::LegacyProtocol) {
 108                 _legacy = true;
 109                 connect(peer, SIGNAL(protocolVersionMismatch(int,int)), SLOT(onProtocolVersionMismatch(int,int)));
 110             }
 111             setPeer(peer);
 112
 113             // inform the client
 114             quint32 reply = peer->protocol() | peer->enabledFeatures()<<8 | _connectionFeatures<<24;
 115             reply = qToBigEndian<quint32>(reply);
 116             socket()->write((char*)&reply, 4);
 117             socket()->flush();
 118
 119             if (!_legacy && (_connectionFeatures & Protocol::Encryption))
 120                 startSsl(); // legacy peer enables it later
 121             return;
 122         }
 123     }
 124 }
 125
 126
 127 void CoreAuthHandler::setPeer(RemotePeer *peer)
 128 {
 129     qDebug().nospace() << "Using " << qPrintable(peer->protocolName()) << "...";
 130
 131     _peer = peer;
 132     disconnect(socket(), SIGNAL(readyRead()), this, SLOT(onReadyRead()));
 133 }
 134
 135 // only in compat mode
 136 void CoreAuthHandler::onProtocolVersionMismatch(int actual, int expected)
 137 {
 138     qWarning() << qPrintable(tr("Client")) << _peer->description() << qPrintable(tr("too old, rejecting."));
 139     QString errorString = tr("<b>Your Quassel Client is too old!</b><br>"
 140                              "This core needs at least client/core protocol version %1 (got: %2).<br>"
 141                              "Please consider upgrading your client.").arg(expected, actual);
 142     _peer->dispatch(ClientDenied(errorString));
 143     _peer->close();
 144 }
 145
 146
 147 bool CoreAuthHandler::checkClientRegistered()
 148 {
 149     if (!_clientRegistered) {
 150         qWarning() << qPrintable(tr("Client")) << qPrintable(socket()->peerAddress().toString()) << qPrintable(tr("did not send a registration message before trying to login, rejecting."));
 151         _peer->dispatch(ClientDenied(tr("<b>Client not initialized!</b><br>You need to send a registration message before trying to login.")));
 152         _peer->close();
 153         return false;
 154     }
 155     return true;
 156 }
 157
 158
 159 void CoreAuthHandler::handle(const RegisterClient &msg)
 160 {
 161     bool useSsl;
 162     if (_legacy)
 163         useSsl = Core::sslSupported() && msg.sslSupported;
 164     else
 165         useSsl = _connectionFeatures & Protocol::Encryption;
 166
 167     if (Quassel::isOptionSet("require-ssl") && !useSsl && !_peer->isLocal()) {
 168         quInfo() << qPrintable(tr("SSL required but non-SSL connection attempt from %1").arg(socket()->peerAddress().toString()));
 169         _peer->dispatch(ClientDenied(tr("<b>SSL is required!</b><br>You need to use SSL in order to connect to this core.")));
 170         _peer->close();
 171         return;
 172     }
 173
 174     _peer->setFeatures(std::move(msg.features));
 175     _peer->setBuildDate(msg.buildDate);
 176     _peer->setClientVersion(msg.clientVersion);
 177
 178     QVariantList backends;
 179     QVariantList authenticators;
 180     bool configured = Core::isConfigured();
 181     if (!configured) {
 182         backends = Core::backendInfo();
 183         if (_peer->hasFeature(Quassel::Feature::Authenticators)) {
 184             authenticators = Core::authenticatorInfo();
 185         }
 186     }
 187
 188     _peer->dispatch(ClientRegistered(Quassel::Features{}, configured, backends, authenticators, useSsl));
 189
 190     // useSsl is only used for the legacy protocol
 191     if (_legacy && useSsl)
 192         startSsl();
 193
 194     _clientRegistered = true;
 195 }
 196
 197
 198 void CoreAuthHandler::handle(const SetupData &msg)
 199 {
 200     if (!checkClientRegistered())
 201         return;
 202
 203     // The default parameter to authenticator is Database.
 204     // Maybe this should be hardcoded elsewhere, i.e. as a define.
 205     QString authenticator = msg.authenticator;
 206     quInfo() << "[" << authenticator << "]";
 207     if (authenticator.trimmed().isEmpty()) {
 208         authenticator = QString("Database");
 209     }
 210
 211     QString result = Core::setup(msg.adminUser, msg.adminPassword, msg.backend, msg.setupData, authenticator, msg.authSetupData);
 212     if (!result.isEmpty())
 213         _peer->dispatch(SetupFailed(result));
 214     else
 215         _peer->dispatch(SetupDone());
 216 }
 217
 218
 219 void CoreAuthHandler::handle(const Login &msg)
 220 {
 221     if (!checkClientRegistered())
 222         return;
 223
 224     if (!Core::isConfigured()) {
 225         qWarning() << qPrintable(tr("Client")) << qPrintable(socket()->peerAddress().toString()) << qPrintable(tr("attempted to login before the core was configured, rejecting."));
 226         _peer->dispatch(ClientDenied(tr("<b>Attempted to login before core was configured!</b><br>The core must be configured before attempting to login.")));
 227         return;
 228     }
 229
 230     // First attempt local auth using the real username and password.
 231     // If that fails, move onto the auth provider.
 232     UserId uid = Core::validateUser(msg.user, msg.password);
 233     if (uid == 0) {
 234         uid = Core::authenticateUser(msg.user, msg.password);
 235     }
 236
 237     if (uid == 0) {
 238         quInfo() << qPrintable(tr("Invalid login attempt from %1 as \"%2\"").arg(socket()->peerAddress().toString(), msg.user));
 239         _peer->dispatch(LoginFailed(tr("<b>Invalid username or password!</b><br>The username/password combination you supplied could not be found in the database.")));
 240         return;
 241     }
 242     _peer->dispatch(LoginSuccess());
 243
 244     quInfo() << qPrintable(tr("Client %1 initialized and authenticated successfully as \"%2\" (UserId: %3).").arg(socket()->peerAddress().toString(), msg.user, QString::number(uid.toInt())));
 245
 246     const auto &clientFeatures = _peer->features();
 247     auto unsupported = clientFeatures.toStringList(false);
 248     if (!unsupported.isEmpty()) {
 249         if (unsupported.contains("NoFeatures"))
 250             quInfo() << qPrintable(tr("Client does not support extended features."));
 251         else
 252             quInfo() << qPrintable(tr("Client does not support the following features: %1").arg(unsupported.join(", ")));
 253     }
 254
 255     if (!clientFeatures.unknownFeatures().isEmpty()) {
 256         quInfo() << qPrintable(tr("Client supports unknown features: %1").arg(clientFeatures.unknownFeatures().join(", ")));
 257     }
 258
 259     disconnect(socket(), 0, this, 0);
 260     disconnect(_peer, 0, this, 0);
 261     _peer->setParent(0); // Core needs to take care of this one now!
 262
 263     socket()->flush(); // Make sure all data is sent before handing over the peer (and socket) to the session thread (bug 682)
 264     emit handshakeComplete(_peer, uid);
 265 }
 266
 267
 268 /*** SSL Stuff ***/
 269
 270 void CoreAuthHandler::startSsl()
 271 {
 272     #ifdef HAVE_SSL
 273     QSslSocket *sslSocket = qobject_cast<QSslSocket *>(socket());
 274     Q_ASSERT(sslSocket);
 275
 276     qDebug() << qPrintable(tr("Starting encryption for Client:"))  << _peer->description();
 277     connect(sslSocket, SIGNAL(sslErrors(const QList<QSslError> &)), SLOT(onSslErrors()));
 278     sslSocket->flush(); // ensure that the write cache is flushed before we switch to ssl (bug 682)
 279     sslSocket->startServerEncryption();
 280     #endif /* HAVE_SSL */
 281 }
 282
 283
 284 #ifdef HAVE_SSL
 285 void CoreAuthHandler::onSslErrors()
 286 {
 287     QSslSocket *sslSocket = qobject_cast<QSslSocket *>(socket());
 288     Q_ASSERT(sslSocket);
 289     sslSocket->ignoreSslErrors();
 290 }
 291 #endif
 292