1 /***************************************************************************
2 * Copyright (C) 2005-2019 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"
26 # include <QSslSocket>
31 CoreAuthHandler::CoreAuthHandler(QTcpSocket* socket, QObject* parent)
34 , _metricsServer(Core::instance()->metricsServer())
35 , _magicReceived(false)
37 , _clientRegistered(false)
38 , _connectionFeatures(0)
41 connect(socket, &QIODevice::readyRead, this, &CoreAuthHandler::onReadyRead);
43 // TODO: Timeout for the handshake phase
46 void CoreAuthHandler::onReadyRead()
48 if (socket()->bytesAvailable() < 4)
51 // once we have selected a peer, we certainly don't want to read more data!
55 if (!_magicReceived) {
57 socket()->peek((char*)&magic, 4);
58 magic = qFromBigEndian<quint32>(magic);
60 if ((magic & 0xffffff00) != Protocol::magic) {
61 // no magic, assume legacy protocol
62 qDebug() << "Legacy client detected, switching to compatibility mode";
64 RemotePeer* peer = PeerFactory::createPeer(PeerFactory::ProtoDescriptor(Protocol::LegacyProtocol, 0),
67 Compressor::NoCompression,
69 connect(peer, &RemotePeer::protocolVersionMismatch, this, &CoreAuthHandler::onProtocolVersionMismatch);
74 _magicReceived = true;
75 quint8 features = magic & 0xff;
76 // figure out which connection features we'll use based on the client's support
77 if (Core::sslSupported() && (features & Protocol::Encryption))
78 _connectionFeatures |= Protocol::Encryption;
79 if (features & Protocol::Compression)
80 _connectionFeatures |= Protocol::Compression;
82 socket()->read((char*)&magic, 4); // read the 4 bytes we've just peeked at
85 // read the list of protocols supported by the client
86 while (socket()->bytesAvailable() >= 4 && _supportedProtos.size() < 16) { // sanity check
88 socket()->read((char*)&data, 4);
89 data = qFromBigEndian<quint32>(data);
91 auto type = static_cast<Protocol::Type>(data & 0xff);
92 auto protoFeatures = static_cast<quint16>(data >> 8 & 0xffff);
93 _supportedProtos.append(PeerFactory::ProtoDescriptor(type, protoFeatures));
95 if (data >= 0x80000000) { // last protocol
96 Compressor::CompressionLevel level;
97 if (_connectionFeatures & Protocol::Compression)
98 level = Compressor::BestCompression;
100 level = Compressor::NoCompression;
102 RemotePeer* peer = PeerFactory::createPeer(_supportedProtos, this, socket(), level, this);
104 qWarning() << "Received invalid handshake data from client" << socket()->peerAddress().toString();
109 if (peer->protocol() == Protocol::LegacyProtocol) {
111 connect(peer, &RemotePeer::protocolVersionMismatch, this, &CoreAuthHandler::onProtocolVersionMismatch);
116 quint32 reply = peer->protocol() | peer->enabledFeatures() << 8 | _connectionFeatures << 24;
117 reply = qToBigEndian<quint32>(reply);
118 socket()->write((char*)&reply, 4);
121 if (!_legacy && (_connectionFeatures & Protocol::Encryption))
122 startSsl(); // legacy peer enables it later
128 void CoreAuthHandler::setPeer(RemotePeer* peer)
130 qDebug().nospace() << "Using " << qPrintable(peer->protocolName()) << "...";
133 disconnect(socket(), &QIODevice::readyRead, this, &CoreAuthHandler::onReadyRead);
136 // only in compat mode
137 void CoreAuthHandler::onProtocolVersionMismatch(int actual, int expected)
139 qWarning() << qPrintable(tr("Client")) << _peer->description() << qPrintable(tr("too old, rejecting."));
140 QString errorString = tr("<b>Your Quassel Client is too old!</b><br>"
141 "This core needs at least client/core protocol version %1 (got: %2).<br>"
142 "Please consider upgrading your client.")
143 .arg(expected, actual);
144 _peer->dispatch(Protocol::ClientDenied(errorString));
148 bool CoreAuthHandler::checkClientRegistered()
150 if (!_clientRegistered) {
151 qWarning() << qPrintable(tr("Client")) << qPrintable(socket()->peerAddress().toString())
152 << qPrintable(tr("did not send a registration message before trying to login, rejecting."));
154 Protocol::ClientDenied(tr("<b>Client not initialized!</b><br>You need to send a registration message before trying to login.")));
161 void CoreAuthHandler::handle(const Protocol::RegisterClient& msg)
165 useSsl = Core::sslSupported() && msg.sslSupported;
167 useSsl = _connectionFeatures & Protocol::Encryption;
169 if (Quassel::isOptionSet("require-ssl") && !useSsl && !_peer->isLocal()) {
170 qInfo() << qPrintable(tr("SSL required but non-SSL connection attempt from %1").arg(socket()->peerAddress().toString()));
171 _peer->dispatch(Protocol::ClientDenied(tr("<b>SSL is required!</b><br>You need to use SSL in order to connect to this core.")));
176 _peer->setFeatures(std::move(msg.features));
177 _peer->setBuildDate(msg.buildDate);
178 _peer->setClientVersion(msg.clientVersion);
180 QVariantList backends;
181 QVariantList authenticators;
182 bool configured = Core::isConfigured();
184 backends = Core::backendInfo();
185 if (_peer->hasFeature(Quassel::Feature::Authenticators)) {
186 authenticators = Core::authenticatorInfo();
190 _peer->dispatch(Protocol::ClientRegistered(Quassel::Features{}, configured, backends, authenticators, useSsl));
192 // useSsl is only used for the legacy protocol
193 if (_legacy && useSsl)
196 _clientRegistered = true;
199 void CoreAuthHandler::handle(const Protocol::SetupData& msg)
201 if (!checkClientRegistered())
204 // The default parameter to authenticator is Database.
205 // Maybe this should be hardcoded elsewhere, i.e. as a define.
206 QString authenticator = msg.authenticator;
207 qInfo() << "[" << authenticator << "]";
208 if (authenticator.trimmed().isEmpty()) {
209 authenticator = QString("Database");
212 QString result = Core::setup(msg.adminUser, msg.adminPassword, msg.backend, msg.setupData, authenticator, msg.authSetupData);
213 if (!result.isEmpty())
214 _peer->dispatch(Protocol::SetupFailed(result));
216 _peer->dispatch(Protocol::SetupDone());
219 void CoreAuthHandler::handle(const Protocol::Login& msg)
221 if (!checkClientRegistered())
224 if (!Core::isConfigured()) {
225 qWarning() << qPrintable(tr("Client")) << qPrintable(socket()->peerAddress().toString())
226 << qPrintable(tr("attempted to login before the core was configured, rejecting."));
227 _peer->dispatch(Protocol::ClientDenied(
228 tr("<b>Attempted to login before core was configured!</b><br>The core must be configured before attempting to login.")));
232 // First attempt local auth using the real username and password.
233 // If that fails, move onto the auth provider.
235 // Check to see if the user has the "Database" authenticator configured.
237 if (Core::getUserAuthenticator(msg.user) == "Database") {
238 uid = Core::validateUser(msg.user, msg.password);
241 // If they did not, *or* if the database login fails, try to use a different authenticator.
242 // TODO: this logic should likely be moved into Core::authenticateUser in the future.
243 // Right now a core can only have one authenticator configured; this might be something
244 // to change in the future.
246 uid = Core::authenticateUser(msg.user, msg.password);
250 qInfo() << qPrintable(tr("Invalid login attempt from %1 as \"%2\"").arg(socket()->peerAddress().toString(), msg.user));
251 _peer->dispatch(Protocol::LoginFailed(tr(
252 "<b>Invalid username or password!</b><br>The username/password combination you supplied could not be found in the database.")));
253 if (_metricsServer) {
254 _metricsServer->addLoginAttempt(msg.user, false);
258 _peer->dispatch(Protocol::LoginSuccess());
259 if (_metricsServer) {
260 _metricsServer->addLoginAttempt(uid, true);
263 qInfo() << qPrintable(tr("Client %1 initialized and authenticated successfully as \"%2\" (UserId: %3).")
264 .arg(socket()->peerAddress().toString(), msg.user, QString::number(uid.toInt())));
266 const auto& clientFeatures = _peer->features();
267 auto unsupported = clientFeatures.toStringList(false);
268 if (!unsupported.isEmpty()) {
269 if (unsupported.contains("NoFeatures"))
270 qInfo() << qPrintable(tr("Client does not support extended features."));
272 qInfo() << qPrintable(tr("Client does not support the following features: %1").arg(unsupported.join(", ")));
275 if (!clientFeatures.unknownFeatures().isEmpty()) {
276 qInfo() << qPrintable(tr("Client supports unknown features: %1").arg(clientFeatures.unknownFeatures().join(", ")));
279 disconnect(socket(), nullptr, this, nullptr);
280 disconnect(_peer, nullptr, this, nullptr);
281 _peer->setParent(nullptr); // Core needs to take care of this one now!
283 socket()->flush(); // Make sure all data is sent before handing over the peer (and socket) to the session thread (bug 682)
284 emit handshakeComplete(_peer, uid);
289 void CoreAuthHandler::startSsl()
292 auto* sslSocket = qobject_cast<QSslSocket*>(socket());
295 qDebug() << qPrintable(tr("Starting encryption for Client:")) << _peer->description();
296 connect(sslSocket, selectOverload<const QList<QSslError>&>(&QSslSocket::sslErrors), this, &CoreAuthHandler::onSslErrors);
297 sslSocket->flush(); // ensure that the write cache is flushed before we switch to ssl (bug 682)
298 sslSocket->startServerEncryption();
299 #endif /* HAVE_SSL */
303 void CoreAuthHandler::onSslErrors()
305 auto* sslSocket = qobject_cast<QSslSocket*>(socket());
307 sslSocket->ignoreSslErrors();