1 /***************************************************************************
2 * Copyright (C) 2005-2018 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 #include "coreauthhandler.h"
24 # include <QSslSocket>
29 using namespace Protocol;
31 CoreAuthHandler::CoreAuthHandler(QTcpSocket* socket, QObject* parent)
34 , _magicReceived(false)
36 , _clientRegistered(false)
37 , _connectionFeatures(0)
40 connect(socket, &QIODevice::readyRead, this, &CoreAuthHandler::onReadyRead);
42 // TODO: Timeout for the handshake phase
45 void CoreAuthHandler::onReadyRead()
47 if (socket()->bytesAvailable() < 4)
50 // once we have selected a peer, we certainly don't want to read more data!
54 if (!_magicReceived) {
56 socket()->peek((char*)&magic, 4);
57 magic = qFromBigEndian<quint32>(magic);
59 if ((magic & 0xffffff00) != Protocol::magic) {
60 // no magic, assume legacy protocol
61 qDebug() << "Legacy client detected, switching to compatibility mode";
63 RemotePeer* peer = PeerFactory::createPeer(PeerFactory::ProtoDescriptor(Protocol::LegacyProtocol, 0),
66 Compressor::NoCompression,
68 connect(peer, &RemotePeer::protocolVersionMismatch, this, &CoreAuthHandler::onProtocolVersionMismatch);
73 _magicReceived = true;
74 quint8 features = magic & 0xff;
75 // figure out which connection features we'll use based on the client's support
76 if (Core::sslSupported() && (features & Protocol::Encryption))
77 _connectionFeatures |= Protocol::Encryption;
78 if (features & Protocol::Compression)
79 _connectionFeatures |= Protocol::Compression;
81 socket()->read((char*)&magic, 4); // read the 4 bytes we've just peeked at
84 // read the list of protocols supported by the client
85 while (socket()->bytesAvailable() >= 4 && _supportedProtos.size() < 16) { // sanity check
87 socket()->read((char*)&data, 4);
88 data = qFromBigEndian<quint32>(data);
90 auto type = static_cast<Protocol::Type>(data & 0xff);
91 auto protoFeatures = static_cast<quint16>(data >> 8 & 0xffff);
92 _supportedProtos.append(PeerFactory::ProtoDescriptor(type, protoFeatures));
94 if (data >= 0x80000000) { // last protocol
95 Compressor::CompressionLevel level;
96 if (_connectionFeatures & Protocol::Compression)
97 level = Compressor::BestCompression;
99 level = Compressor::NoCompression;
101 RemotePeer* peer = PeerFactory::createPeer(_supportedProtos, this, socket(), level, this);
103 qWarning() << "Received invalid handshake data from client" << socket()->peerAddress().toString();
108 if (peer->protocol() == Protocol::LegacyProtocol) {
110 connect(peer, &RemotePeer::protocolVersionMismatch, this, &CoreAuthHandler::onProtocolVersionMismatch);
115 quint32 reply = peer->protocol() | peer->enabledFeatures() << 8 | _connectionFeatures << 24;
116 reply = qToBigEndian<quint32>(reply);
117 socket()->write((char*)&reply, 4);
120 if (!_legacy && (_connectionFeatures & Protocol::Encryption))
121 startSsl(); // legacy peer enables it later
127 void CoreAuthHandler::setPeer(RemotePeer* peer)
129 qDebug().nospace() << "Using " << qPrintable(peer->protocolName()) << "...";
132 disconnect(socket(), &QIODevice::readyRead, this, &CoreAuthHandler::onReadyRead);
135 // only in compat mode
136 void CoreAuthHandler::onProtocolVersionMismatch(int actual, int expected)
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.")
142 .arg(expected, actual);
143 _peer->dispatch(ClientDenied(errorString));
147 bool CoreAuthHandler::checkClientRegistered()
149 if (!_clientRegistered) {
150 qWarning() << qPrintable(tr("Client")) << qPrintable(socket()->peerAddress().toString())
151 << qPrintable(tr("did not send a registration message before trying to login, rejecting."));
153 ClientDenied(tr("<b>Client not initialized!</b><br>You need to send a registration message before trying to login.")));
160 void CoreAuthHandler::handle(const RegisterClient& msg)
164 useSsl = Core::sslSupported() && msg.sslSupported;
166 useSsl = _connectionFeatures & Protocol::Encryption;
168 if (Quassel::isOptionSet("require-ssl") && !useSsl && !_peer->isLocal()) {
169 qInfo() << qPrintable(tr("SSL required but non-SSL connection attempt from %1").arg(socket()->peerAddress().toString()));
170 _peer->dispatch(ClientDenied(tr("<b>SSL is required!</b><br>You need to use SSL in order to connect to this core.")));
175 _peer->setFeatures(std::move(msg.features));
176 _peer->setBuildDate(msg.buildDate);
177 _peer->setClientVersion(msg.clientVersion);
179 QVariantList backends;
180 QVariantList authenticators;
181 bool configured = Core::isConfigured();
183 backends = Core::backendInfo();
184 if (_peer->hasFeature(Quassel::Feature::Authenticators)) {
185 authenticators = Core::authenticatorInfo();
189 _peer->dispatch(ClientRegistered(Quassel::Features{}, configured, backends, authenticators, useSsl));
191 // useSsl is only used for the legacy protocol
192 if (_legacy && useSsl)
195 _clientRegistered = true;
198 void CoreAuthHandler::handle(const SetupData& msg)
200 if (!checkClientRegistered())
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 qInfo() << "[" << authenticator << "]";
207 if (authenticator.trimmed().isEmpty()) {
208 authenticator = QString("Database");
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));
215 _peer->dispatch(SetupDone());
218 void CoreAuthHandler::handle(const Login& msg)
220 if (!checkClientRegistered())
223 if (!Core::isConfigured()) {
224 qWarning() << qPrintable(tr("Client")) << qPrintable(socket()->peerAddress().toString())
225 << qPrintable(tr("attempted to login before the core was configured, rejecting."));
226 _peer->dispatch(ClientDenied(
227 tr("<b>Attempted to login before core was configured!</b><br>The core must be configured before attempting to login.")));
231 // First attempt local auth using the real username and password.
232 // If that fails, move onto the auth provider.
233 UserId uid = Core::validateUser(msg.user, msg.password);
235 uid = Core::authenticateUser(msg.user, msg.password);
239 qInfo() << qPrintable(tr("Invalid login attempt from %1 as \"%2\"").arg(socket()->peerAddress().toString(), msg.user));
240 _peer->dispatch(LoginFailed(tr(
241 "<b>Invalid username or password!</b><br>The username/password combination you supplied could not be found in the database.")));
244 _peer->dispatch(LoginSuccess());
246 qInfo() << qPrintable(tr("Client %1 initialized and authenticated successfully as \"%2\" (UserId: %3).")
247 .arg(socket()->peerAddress().toString(), msg.user, QString::number(uid.toInt())));
249 const auto& clientFeatures = _peer->features();
250 auto unsupported = clientFeatures.toStringList(false);
251 if (!unsupported.isEmpty()) {
252 if (unsupported.contains("NoFeatures"))
253 qInfo() << qPrintable(tr("Client does not support extended features."));
255 qInfo() << qPrintable(tr("Client does not support the following features: %1").arg(unsupported.join(", ")));
258 if (!clientFeatures.unknownFeatures().isEmpty()) {
259 qInfo() << qPrintable(tr("Client supports unknown features: %1").arg(clientFeatures.unknownFeatures().join(", ")));
262 disconnect(socket(), nullptr, this, nullptr);
263 disconnect(_peer, nullptr, this, nullptr);
264 _peer->setParent(nullptr); // Core needs to take care of this one now!
266 socket()->flush(); // Make sure all data is sent before handing over the peer (and socket) to the session thread (bug 682)
267 emit handshakeComplete(_peer, uid);
272 void CoreAuthHandler::startSsl()
275 auto* sslSocket = qobject_cast<QSslSocket*>(socket());
278 qDebug() << qPrintable(tr("Starting encryption for Client:")) << _peer->description();
279 connect(sslSocket, selectOverload<const QList<QSslError>&>(&QSslSocket::sslErrors), this, &CoreAuthHandler::onSslErrors);
280 sslSocket->flush(); // ensure that the write cache is flushed before we switch to ssl (bug 682)
281 sslSocket->startServerEncryption();
282 #endif /* HAVE_SSL */
286 void CoreAuthHandler::onSslErrors()
288 auto* sslSocket = qobject_cast<QSslSocket*>(socket());
290 sslSocket->ignoreSslErrors();