src/core/identserver.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 <logger.h>
  22 #include <set>
  23
  24 #include "corenetwork.h"
  25 #include "identserver.h"
  26
  27 IdentServer::IdentServer(bool strict, QObject *parent) : QObject(parent), _strict(strict), _socketId(0), _requestId(0) {
  28     connect(&_server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
  29     connect(&_v6server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
  30 }
  31
  32 IdentServer::~IdentServer() = default;
  33
  34 bool IdentServer::startListening() {
  35     uint16_t port = Quassel::optionValue("ident-port").toUShort();
  36
  37     bool success = false;
  38     if (_v6server.listen(QHostAddress("::1"), port)) {
  39         quInfo() << qPrintable(
  40                 tr("Listening for identd clients on IPv6 %1 port %2")
  41                         .arg("::1")
  42                         .arg(_v6server.serverPort())
  43         );
  44
  45         success = true;
  46     }
  47
  48     if (_server.listen(QHostAddress("127.0.0.1"), port)) {
  49         success = true;
  50
  51         quInfo() << qPrintable(
  52                 tr("Listening for identd clients on IPv4 %1 port %2")
  53                         .arg("127.0.0.1")
  54                         .arg(_server.serverPort())
  55         );
  56     }
  57
  58     if (!success) {
  59         quError() << qPrintable(
  60                 tr("Identd could not open any network interfaces to listen on! No identd functionality will be available"));
  61     }
  62
  63     return success;
  64 }
  65
  66 void IdentServer::stopListening(const QString &msg) {
  67     bool wasListening = false;
  68     if (_server.isListening()) {
  69         wasListening = true;
  70         _server.close();
  71     }
  72     if (_v6server.isListening()) {
  73         wasListening = true;
  74         _v6server.close();
  75     }
  76     if (wasListening) {
  77         if (msg.isEmpty())
  78             quInfo() << "No longer listening for identd clients.";
  79         else
  80             quInfo() << qPrintable(msg);
  81     }
  82 }
  83
  84 void IdentServer::incomingConnection() {
  85     auto *server = qobject_cast<QTcpServer *>(sender());
  86     Q_ASSERT(server);
  87     while (server->hasPendingConnections()) {
  88         QTcpSocket *socket = server->nextPendingConnection();
  89         connect(socket, SIGNAL(readyRead()), this, SLOT(respond()));
  90     }
  91 }
  92
  93 void IdentServer::respond() {
  94     QTcpSocket *socket = qobject_cast<QTcpSocket *>(sender());
  95     Q_ASSERT(socket);
  96
  97     qint64 transactionId = _socketId;
  98
  99     if (!socket->canReadLine()) {
 100         return;
 101     }
 102
 103     QByteArray query = socket->readLine();
 104     if (query.endsWith("\r\n"))
 105         query.chop(2);
 106     else if (query.endsWith("\n"))
 107         query.chop(1);
 108
 109     QList<QByteArray> split = query.split(',');
 110
 111     bool success = false;
 112
 113     quint16 localPort = 0;
 114     if (!split.empty()) {
 115         localPort = split[0].trimmed().toUShort(&success, 10);
 116     }
 117
 118     Request request{socket, localPort, query, transactionId, _requestId++};
 119     if (!success) {
 120         request.respondError("INVALID-PORT");
 121     } else if (responseAvailable(request)) {
 122         // success
 123     } else if (lowestSocketId() < transactionId) {
 124         _requestQueue.emplace_back(request);
 125     } else {
 126         request.respondError("NO-USER");
 127     }
 128 }
 129
 130 void Request::respondSuccess(const QString &user) {
 131     QString data = query + " : USERID : Quassel : " + user + "\r\n";
 132
 133     socket->write(data.toUtf8());
 134     socket->flush();
 135     socket->close();
 136 }
 137
 138 void Request::respondError(const QString &error) {
 139     QString data = query + " : ERROR : " + error + "\r\n";
 140
 141     socket->write(data.toUtf8());
 142     socket->flush();
 143     socket->close();
 144 }
 145
 146 bool IdentServer::responseAvailable(Request request) {
 147     if (!_connections.contains(request.localPort)) {
 148         return false;
 149     }
 150
 151     QString user = _connections[request.localPort];
 152     request.respondSuccess(user);
 153     return true;
 154 }
 155
 156 bool IdentServer::addSocket(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort,
 157                             const QHostAddress &peerAddress, quint16 peerPort, qint64 socketId) {
 158     Q_UNUSED(localAddress)
 159     Q_UNUSED(peerAddress)
 160     Q_UNUSED(peerPort)
 161
 162     const CoreNetwork *network = qobject_cast<CoreNetwork *>(sender());
 163     _connections[localPort] = network->coreSession()->strictCompliantIdent(identity);;
 164     processWaiting(socketId);
 165     return true;
 166 }
 167
 168
 169 bool IdentServer::removeSocket(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort,
 170                                const QHostAddress &peerAddress, quint16 peerPort, qint64 socketId) {
 171     Q_UNUSED(identity)
 172     Q_UNUSED(localAddress)
 173     Q_UNUSED(peerAddress)
 174     Q_UNUSED(peerPort)
 175
 176     _connections.remove(localPort);
 177     processWaiting(socketId);
 178     return true;
 179 }
 180
 181 qint64 IdentServer::addWaitingSocket() {
 182     qint64 newSocketId = _socketId++;
 183     _waiting.push_back(newSocketId);
 184     return newSocketId;
 185 }
 186
 187 qint64 IdentServer::lowestSocketId() {
 188     if (_waiting.empty()) {
 189         return std::numeric_limits<qint64>::max();
 190     }
 191
 192     return _waiting.front();
 193 }
 194
 195 void IdentServer::removeWaitingSocket(qint64 socketId) {
 196     _waiting.remove(socketId);
 197 }
 198
 199 void IdentServer::processWaiting(qint64 socketId) {
 200     removeWaitingSocket(socketId);
 201     _requestQueue.remove_if([=](Request request) {
 202         if (socketId < request.transactionId && responseAvailable(request)) {
 203             return true;
 204         } else if (lowestSocketId() < request.transactionId) {
 205             return false;
 206         } else {
 207             request.respondError("NO-USER");
 208             return true;
 209         }
 210     });
 211 }
 212
 213 bool operator==(const Request &a, const Request &b) {
 214     return a.requestId == b.requestId;
 215 }