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