nymea-remoteproxy/libnymea-remoteproxy/proxyserver.cpp

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
*  Copyright 2013 - 2020, nymea GmbH
*  Contact: contact@nymea.io
*
*  This file is part of nymea.
*  This project including source code and documentation is protected by copyright law, and
*  remains the property of nymea GmbH. All rights, including reproduction, publication,
*  editing and translation, are reserved. The use of this project is subject to the terms of a
*  license agreement to be concluded with nymea GmbH in accordance with the terms
*  of use of nymea GmbH, available under https://nymea.io/license
*
*  GNU General Public License Usage
*  Alternatively, this project may be redistributed and/or modified under
*  the terms of the GNU General Public License as published by the Free Software Foundation,
*  GNU version 3. this project is distributed in the hope that it will be useful, but WITHOUT ANY
*  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
*  PURPOSE. See the GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License along with this project.
*  If not, see <https://www.gnu.org/licenses/>.
*
*  For any further details and any questions please contact us under contact@nymea.io
*  or see our FAQ/Licensing Information on https://nymea.io/license/faq
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#include "engine.h"
#include "proxyserver.h"
#include "loggingcategories.h"

#include <QSettings>
#include <QMetaObject>
#include <QVariantList>
#include <QJsonDocument>

namespace remoteproxy {

ProxyServer::ProxyServer(QObject *parent) : QObject(parent)
{
    qRegisterMetaType<ProxyClient *>("ProxyClient *");
    m_jsonRpcServer = new JsonRpcServer(this);

    loadStatistics();
}

ProxyServer::~ProxyServer()
{
    qCDebug(dcProxyServer()) << "Shutting down proxy server";
}

bool ProxyServer::running() const
{
    return m_running;
}

void ProxyServer::registerTransportInterface(TransportInterface *interface)
{
    qCDebug(dcProxyServer()) << "Register transport interface" << interface->serverName();

    if (m_transportInterfaces.contains(interface)) {
        qCWarning(dcProxyServer()) << "Transport interface already registerd.";
        return;
    }

    connect(interface, &TransportInterface::clientConnected, this, &ProxyServer::onClientConnected);
    connect(interface, &TransportInterface::clientDisconnected, this, &ProxyServer::onClientDisconnected);
    connect(interface, &TransportInterface::dataAvailable, this, &ProxyServer::onClientDataAvailable);

    m_transportInterfaces.append(interface);
}

QVariantMap ProxyServer::currentStatistics()
{
    QVariantMap statisticsMap;
    statisticsMap.insert("clientCount", m_proxyClients.count());
    statisticsMap.insert("tunnelCount", m_tunnels.count());
    statisticsMap.insert("troughput", m_troughput);

    QVariantMap totalStatisticsMap;
    totalStatisticsMap.insert("totalClientCount", m_totalClientCount);
    totalStatisticsMap.insert("totalTunnelCount", m_totalTunnelCount);
    totalStatisticsMap.insert("totalTraffic", m_totalTraffic);
    statisticsMap.insert("total", totalStatisticsMap);

    // Create client list
    QVariantList clientList;
    foreach (ProxyClient *client, m_proxyClients) {
        QVariantMap clientMap;
        clientMap.insert("id", client->clientId().toString());
        clientMap.insert("address", client->peerAddress().toString());
        clientMap.insert("timestamp", client->creationTime());
        clientMap.insert("authenticated", client->isAuthenticated());
        clientMap.insert("tunnelConnected", client->isTunnelConnected());
        clientMap.insert("name", client->name());
        clientMap.insert("userName", client->userName());
        clientMap.insert("uuid", client->uuid());
        clientMap.insert("rxDataCount", client->rxDataCount());
        clientMap.insert("txDataCount", client->txDataCount());
        clientList.append(clientMap);
    }
    statisticsMap.insert("clients", clientList);

    // Create tunnel list
    QVariantList tunnelList;
    foreach (const TunnelConnection &tunnel, m_tunnels) {
        QVariantMap tunnelMap;
        tunnelMap.insert("clientOne", tunnel.clientOne()->clientId().toString());
        tunnelMap.insert("clientTwo", tunnel.clientTwo()->clientId().toString());
        tunnelMap.insert("timestamp", tunnel.creationTime());
        tunnelList.append(tunnelMap);
    }
    statisticsMap.insert("tunnels", tunnelList);

    return statisticsMap;
}

void ProxyServer::setRunning(bool running)
{
    if (m_running == running)
        return;

    qCDebug(dcProxyServer()) << "The proxy server is now up and running";
    m_running = running;
    emit runningChanged();
}

void ProxyServer::loadStatistics()
{
    QSettings settings;
    settings.beginGroup("Statistics");
    m_totalClientCount = settings.value("totalClientCount", 0).toInt();
    m_totalTunnelCount = settings.value("totalTunnelCount", 0).toInt();
    m_totalTraffic = settings.value("totalTraffic", 0).toInt();
    settings.endGroup();
}

void ProxyServer::saveStatistics()
{
    QSettings settings;
    settings.beginGroup("Statistics");
    settings.setValue("totalClientCount", m_totalClientCount);
    settings.value("totalTunnelCount", m_totalTunnelCount);
    settings.value("totalTraffic", m_totalTraffic);
    settings.endGroup();
}

ProxyClient *ProxyServer::getRemoteClient(ProxyClient *proxyClient)
{
    if (!m_tunnels.contains(proxyClient->tunnelIdentifier()))
        return nullptr;

    if (proxyClient == m_tunnels.value(proxyClient->tunnelIdentifier()).clientOne()) {
        return m_tunnels.value(proxyClient->tunnelIdentifier()).clientTwo();
    } else if (proxyClient == m_tunnels.value(proxyClient->tunnelIdentifier()).clientTwo()) {
        return m_tunnels.value(proxyClient->tunnelIdentifier()).clientOne();
    }

    return nullptr;
}

void ProxyServer::establishTunnel(ProxyClient *firstClient, ProxyClient *secondClient)
{
    qCDebug(dcProxyServer()) << "Create tunnel between authenticated clients " << firstClient << secondClient;

    TunnelConnection tunnel(firstClient, secondClient);
    if (!tunnel.isValid()) {
        qCWarning(dcProxyServer()) << "Invalid tunnel. Could not establish connection.";
        //FIXME:
    }

    m_tunnels.insert(tunnel.tunnelIdentifier(), tunnel);

    // Tell both clients the tunnel has been established
    QVariantMap notificationParamsFirst;
    notificationParamsFirst.insert("name", tunnel.clientTwo()->name());
    notificationParamsFirst.insert("uuid", tunnel.clientTwo()->uuid());

    QVariantMap notificationParamsSecond;
    notificationParamsSecond.insert("name", tunnel.clientOne()->name());
    notificationParamsSecond.insert("uuid", tunnel.clientOne()->uuid());

    // Make sure the proxy is the first one who knows that the tunnel is connected
    firstClient->setTunnelConnected(true);
    secondClient->setTunnelConnected(true);

    qCDebug(dcProxyServer()) << tunnel;
    qCDebug(dcTunnel()) << "Tunnel established between" << firstClient->peerAddress().toString() << firstClient->uuid()
                        << "<-->" << secondClient->peerAddress().toString() << secondClient->uuid();

    m_totalTunnelCount += 1;
    saveStatistics();

    // Notify the clients in the next event loop
    QMetaObject::invokeMethod(m_jsonRpcServer, QString("sendNotification").toLatin1().data(), Qt::QueuedConnection,
                              Q_ARG(QString, m_jsonRpcServer->name()),
                              Q_ARG(QString, "TunnelEstablished"),
                              Q_ARG(QVariantMap, notificationParamsFirst),
                              Q_ARG(ProxyClient *, tunnel.clientOne()));

    QMetaObject::invokeMethod(m_jsonRpcServer, QString("sendNotification").toLatin1().data(), Qt::QueuedConnection,
                              Q_ARG(QString, m_jsonRpcServer->name()),
                              Q_ARG(QString, "TunnelEstablished"),
                              Q_ARG(QVariantMap, notificationParamsSecond),
                              Q_ARG(ProxyClient *, tunnel.clientTwo()));
}

void ProxyServer::onClientConnected(const QUuid &clientId, const QHostAddress &address)
{
    TransportInterface *interface = static_cast<TransportInterface *>(sender());

    qCDebug(dcProxyServer()) << "New client connected"  << interface->serverName() << clientId.toString() << address.toString();

    ProxyClient *proxyClient = new ProxyClient(interface, clientId, address, this);
    connect(proxyClient, &ProxyClient::authenticated, this, &ProxyServer::onProxyClientAuthenticated);
    connect(proxyClient, &ProxyClient::timeoutOccured, this, &ProxyServer::onProxyClientTimeoutOccured);

    m_totalClientCount += 1;
    saveStatistics();

    m_proxyClients.insert(clientId, proxyClient);
    m_jsonRpcServer->registerClient(proxyClient);
}

void ProxyServer::onClientDisconnected(const QUuid &clientId)
{
    TransportInterface *interface = static_cast<TransportInterface *>(sender());
    qCDebug(dcProxyServer()) << "Client disconnected" << interface->serverName() << clientId.toString();

    if (m_proxyClients.contains(clientId)) {
        ProxyClient *proxyClient = m_proxyClients.take(clientId);

        // Clean up client tables
        if (m_authenticatedClients.values().contains(proxyClient)) {
            m_authenticatedClients.remove(proxyClient->token());
        }

        if (m_authenticatedClientsNonce.values().contains(proxyClient)) {
            m_authenticatedClientsNonce.remove(proxyClient->nonce());
        }

        // Unregister from json rpc server
        m_jsonRpcServer->unregisterClient(proxyClient);

        // Check if
        if (m_tunnels.contains(proxyClient->tunnelIdentifier())) {
            // There is a tunnel connection for this client, remove the tunnel and disconnect also the other client
            ProxyClient *remoteClient = getRemoteClient(proxyClient);
            TunnelConnection tunnelConnection = m_tunnels.take(proxyClient->tunnelIdentifier());
            Engine::instance()->logEngine()->logTunnel(tunnelConnection);
            if (remoteClient) {
                qCDebug(dcTunnel()) << "Remove tunnel between" << proxyClient->peerAddress().toString() << proxyClient->uuid()
                                    << "<-->" << remoteClient->peerAddress().toString() << remoteClient->uuid();
                remoteClient->killConnection("Tunnel client disconnected");
            }
        }

        // Delete the proxy client
        proxyClient->deleteLater();
    } else {
        qCWarning(dcProxyServer()) << "Unknown client disconnected from proxy server." << clientId.toString();
    }
}

void ProxyServer::onClientDataAvailable(const QUuid &clientId, const QByteArray &data)
{
    ProxyClient *proxyClient = m_proxyClients.value(clientId);
    if (!proxyClient) {
        qCWarning(dcProxyServer()) << "Could not find client for uuid" << clientId;
        return;
    }

    // If this client is not authenticated yet, and not tunnel connected, pipe the traffic into the json rpc server
    if (!proxyClient->isAuthenticated() && !proxyClient->isTunnelConnected()) {
        qCDebug(dcProxyServerTraffic()) << "Client data available" << proxyClient << qUtf8Printable(data);
        m_jsonRpcServer->processData(proxyClient, data);
        return;
    }

    // If the client is authenticated, but no tunnel created yet, kill the connection since no addition call is allowed until
    // the tunne is fully established.
    if (proxyClient->isAuthenticated() && !proxyClient->isTunnelConnected()) {
        qCWarning(dcProxyServer()) << "An authenticated client sent data without tunnel connection. This is not allowed.";
        m_jsonRpcServer->unregisterClient(proxyClient);
        // The client is authenticated and tries to send data, this is not allowed.
        proxyClient->killConnection("Data received while authenticated but not remote connected.");
        return;
    }

    if (proxyClient->isAuthenticated() && proxyClient->isTunnelConnected()) {
        ProxyClient *remoteClient = getRemoteClient(proxyClient);
        Q_ASSERT_X(remoteClient, "ProxyServer", "Tunnel existing but not tunnel client available");
        Q_ASSERT_X(m_tunnels.contains(proxyClient->tunnelIdentifier()), "ProxyServer", "Tunnel connect but not existing");

        // Calculate server statisitcs
        m_troughputCounter += data.count();
        proxyClient->addRxDataCount(data.count());
        remoteClient->addTxDataCount(data.count());

        m_totalTraffic += data.count();
        saveStatistics();

        qCDebug(dcProxyServerTraffic()) << "Pipe tunnel data:";
        qCDebug(dcProxyServerTraffic()) << "    --> from" << proxyClient;
        qCDebug(dcProxyServerTraffic()) << "    --> to" << remoteClient;
        qCDebug(dcProxyServerTraffic()) << "    --> data:" << qUtf8Printable(data);

        remoteClient->sendData(data);
    }
}

void ProxyServer::onProxyClientAuthenticated()
{
    ProxyClient *proxyClient = static_cast<ProxyClient *>(sender());

    qCDebug(dcProxyServer()) << "Client authenticated" << proxyClient;

    //FIXME: limit the amount of connection with one token

    // Check if we already have a tunnel with this identifier
    if (m_tunnels.contains(proxyClient->tunnelIdentifier())) {
        qCWarning(dcProxyServer()) << "There is already a tunnel with this token and nonce. The client has to take a new nonce or a new token.";
        // There is already a tunnel with this token and nonce. Reject the connection
        proxyClient->killConnection("Tunnel already exists for this token nonce combination.");
        return;
    }


    // FIXME: for backwards compatibility
    if (proxyClient->nonce().isEmpty()) {
        // Check if we have an other authenticated client with this token
        if (m_authenticatedClients.keys().contains(proxyClient->token())) {

            // Found a client with this token
            ProxyClient *tunnelPartner = m_authenticatedClients.take(proxyClient->token());

            // Check if the two clients show up with the same uuid to prevent connection loops
            if (tunnelPartner->uuid() == proxyClient->uuid()) {
                qCWarning(dcProxyServer()) << "The clients have the same uuid. This is not allowed.";
                proxyClient->killConnection("Duplicated client UUID.");
                tunnelPartner->killConnection("Duplicated client UUID.");
                return;
            }

            // All ok so far. Create the tunnel
            establishTunnel(tunnelPartner, proxyClient);
        } else {
            // Append and wait for the other client
            m_authenticatedClients.insert(proxyClient->token(), proxyClient);
        }
    } else {
        // The client passed a nonce, let's hash with that to prevent cross connections
        if (m_authenticatedClientsNonce.keys().contains(proxyClient->nonce())) {
            // Found a client with this nonce
            ProxyClient *tunnelPartner = m_authenticatedClientsNonce.take(proxyClient->nonce());

            // Check if the two clients show up with the same uuid to prevent connection loops
            if (tunnelPartner->uuid() == proxyClient->uuid()) {
                qCWarning(dcProxyServer()) << "The clients have the same uuid. This could cause a loop and is not allowed.";
                proxyClient->killConnection("Client loop detected.");
                tunnelPartner->killConnection("Client loop detected.");
                return;
            }

            // All ok so far. Create the tunnel
            establishTunnel(tunnelPartner, proxyClient);
        } else {
            m_authenticatedClientsNonce.insert(proxyClient->nonce(), proxyClient);
        }
    }
}

void ProxyServer::onProxyClientTimeoutOccured()
{
    ProxyClient *proxyClient = static_cast<ProxyClient *>(sender());
    qCDebug(dcProxyServer()) << "Timeout occured for" << proxyClient;
    proxyClient->killConnection("Proxy timeout occuret");
}

void ProxyServer::startServer()
{
    qCDebug(dcProxyServer()) << "Start proxy server.";
    foreach (TransportInterface *interface, m_transportInterfaces) {
        interface->startServer();
    }
    setRunning(true);
}

void ProxyServer::stopServer()
{
    qCDebug(dcProxyServer()) << "Stop proxy server.";
    foreach (TransportInterface *interface, m_transportInterfaces) {
        interface->stopServer();
    }
    setRunning(false);
}

void ProxyServer::tick()
{
    m_troughput = m_troughputCounter;
    m_troughputCounter = 0;
}

}