nymea-remoteproxy/libnymea-remoteproxy/proxyconfiguration.cpp

349 lines
13 KiB
C++

// SPDX-License-Identifier: LGPL-3.0-or-later
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* nymea-remoteproxy
* Tunnel proxy server for the nymea remote access
*
* Copyright (C) 2013 - 2024, nymea GmbH
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
*
* This file is part of nymea-remoteproxy.
*
* nymea-remoteproxy is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* nymea-remoteproxy 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with nymea-remoteproxy. If not, see <https://www.gnu.org/licenses/>.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#include "loggingcategories.h"
#include "proxyconfiguration.h"
#include <QFile>
#include <QSslKey>
#include <QFileInfo>
#include <QSslCertificate>
namespace remoteproxy {
ProxyConfiguration::ProxyConfiguration(QObject *parent) :
QObject(parent)
{
}
bool ProxyConfiguration::loadConfiguration(const QString &fileName)
{
m_fileName = fileName;
QFileInfo fileInfo(m_fileName);
if (!fileInfo.exists()) {
qCWarning(dcApplication()) << "Configuration: Could not find configuration file" << m_fileName;
return false;
}
QSettings settings(m_fileName, QSettings::IniFormat);
settings.beginGroup("ProxyServer");
setServerName(settings.value("name", "nymea-remoteproxy").toString());
setWriteLogFile(settings.value("writeLogs", false).toBool());
setLogFileName(settings.value("logFile", "/var/log/nymea-remoteproxy.log").toString());
setLogEngineEnabled(settings.value("logEngineEnabled", false).toBool());
setMonitorSocketFileName(settings.value("monitorSocket", "/tmp/nymea-remoteproxy.monitor").toString());
setJsonRpcTimeout(settings.value("jsonRpcTimeout", 10000).toInt());
setInactiveTimeout(settings.value("inactiveTimeout", 8000).toInt());
settings.endGroup();
settings.beginGroup("SSL");
setSslEnabled(settings.value("enabled", true).toBool());
setSslCertificateFileName(settings.value("certificate", "/etc/ssl/certs/ssl-cert-snakeoil.pem").toString());
setSslCertificateKeyFileName(settings.value("certificateKey", "/etc/ssl/private/ssl-cert-snakeoil.key").toString());
setSslCertificateChainFileName(settings.value("certificateChain", "").toString());
settings.endGroup();
settings.beginGroup("UnixSocketServerTunnelProxy");
setUnixSocketFileName(settings.value("unixSocketFileName", "/run/nymea-remoteproxy.socket").toString());
settings.endGroup();
settings.beginGroup("WebSocketServerTunnelProxy");
setWebSocketServerTunnelProxyHost(QHostAddress(settings.value("host", "127.0.0.1").toString()));
setWebSocketServerTunnelProxyPort(static_cast<quint16>(settings.value("port", 2212).toInt()));
settings.endGroup();
settings.beginGroup("TcpServerTunnelProxy");
setTcpServerTunnelProxyHost(QHostAddress(settings.value("host", "127.0.0.1").toString()));
setTcpServerTunnelProxyPort(static_cast<quint16>(settings.value("port", 2213).toInt()));
settings.endGroup();
// Load SSL configuration
QSslConfiguration sslConfiguration;
sslConfiguration.setPeerVerifyMode(QSslSocket::VerifyNone);
sslConfiguration.setProtocol(QSsl::TlsV1_2OrLater);
// SSL certificate
QFile certFile(sslCertificateFileName());
if (!certFile.open(QIODevice::ReadOnly)) {
qCWarning(dcApplication()) << "Could not open certificate file" << sslCertificateFileName() << certFile.errorString();
return false;
}
QSslCertificate certificate(&certFile, QSsl::Pem);
qCDebug(dcApplication()) << "Loaded successfully certificate" << sslCertificateFileName();
certFile.close();
sslConfiguration.setLocalCertificate(certificate);
// SSL certificate key
QFile certKeyFile(sslCertificateKeyFileName());
if (!certKeyFile.open(QIODevice::ReadOnly)) {
qCWarning(dcApplication()) << "Could not open certificate key file:" << sslCertificateKeyFileName() << certKeyFile.errorString();
return false;
}
QSslKey sslKey(&certKeyFile, QSsl::Rsa, QSsl::Pem, QSsl::PrivateKey);
qCDebug(dcApplication()) << "Loaded successfully certificate key" << sslCertificateKeyFileName();
certKeyFile.close();
sslConfiguration.setPrivateKey(sslKey);
// SSL certificate chain
if (!sslCertificateChainFileName().isEmpty()) {
QFile certChainFile(sslCertificateChainFileName());
if (!certChainFile.open(QIODevice::ReadOnly)) {
qCWarning(dcApplication()) << "Could not open certificate chain file:" << sslCertificateChainFileName() << certChainFile.errorString();
return false;
}
QSslCertificate certificate(&certChainFile, QSsl::Pem);
sslConfiguration.setCaCertificates( QList<QSslCertificate>() << certificate );
certChainFile.close();
qCDebug(dcApplication()) << "Loaded successfully certificate chain" << sslCertificateKeyFileName();
}
m_sslConfiguration = sslConfiguration;
return true;
}
QString ProxyConfiguration::fileName() const
{
return m_fileName;
}
QString ProxyConfiguration::serverName() const
{
return m_serverName;
}
void ProxyConfiguration::setServerName(const QString &serverName)
{
m_serverName = serverName;
}
bool ProxyConfiguration::writeLogFile() const
{
return m_writeLogFile;
}
void ProxyConfiguration::setWriteLogFile(bool enabled)
{
m_writeLogFile = enabled;
}
QString ProxyConfiguration::logFileName() const
{
return m_logFileName;
}
void ProxyConfiguration::setLogFileName(const QString &logFileName)
{
m_logFileName = logFileName;
}
bool ProxyConfiguration::logEngineEnabled() const
{
return m_logEngineEnabled;
}
void ProxyConfiguration::setLogEngineEnabled(bool enabled)
{
m_logEngineEnabled = enabled;
}
QString ProxyConfiguration::monitorSocketFileName() const
{
return m_monitorSocketFileName;
}
void ProxyConfiguration::setMonitorSocketFileName(const QString &fileName)
{
m_monitorSocketFileName = fileName;
}
int ProxyConfiguration::jsonRpcTimeout() const
{
return m_jsonRpcTimeout;
}
void ProxyConfiguration::setJsonRpcTimeout(int timeout)
{
m_jsonRpcTimeout = timeout;
}
int ProxyConfiguration::inactiveTimeout() const
{
return m_inactiveTimeout;
}
void ProxyConfiguration::setInactiveTimeout(int timeout)
{
m_inactiveTimeout = timeout;
}
bool ProxyConfiguration::sslEnabled() const
{
return m_sslEnabled;
}
void ProxyConfiguration::setSslEnabled(bool enabled)
{
m_sslEnabled = enabled;
}
QString ProxyConfiguration::sslCertificateFileName() const
{
return m_sslCertificateFileName;
}
void ProxyConfiguration::setSslCertificateFileName(const QString &fileName)
{
m_sslCertificateFileName = fileName;
}
QString ProxyConfiguration::sslCertificateKeyFileName() const
{
return m_sslCertificateKeyFileName;
}
void ProxyConfiguration::setSslCertificateKeyFileName(const QString &fileName)
{
m_sslCertificateKeyFileName = fileName;
}
QString ProxyConfiguration::sslCertificateChainFileName() const
{
return m_sslCertificateChainFileName;
}
void ProxyConfiguration::setSslCertificateChainFileName(const QString &fileName)
{
m_sslCertificateChainFileName = fileName;
}
QSslConfiguration ProxyConfiguration::sslConfiguration() const
{
return m_sslConfiguration;
}
QString ProxyConfiguration::unixSocketFileName() const
{
return m_unixSocketFileName;
}
void ProxyConfiguration::setUnixSocketFileName(const QString &unixSocketFileName)
{
m_unixSocketFileName = unixSocketFileName;
}
QHostAddress ProxyConfiguration::webSocketServerTunnelProxyHost() const
{
return m_webSocketServerTunnelProxyHost;
}
void ProxyConfiguration::setWebSocketServerTunnelProxyHost(const QHostAddress &address)
{
m_webSocketServerTunnelProxyHost = address;
}
quint16 ProxyConfiguration::webSocketServerTunnelProxyPort() const
{
return m_webSocketServerTunnelProxyPort;
}
void ProxyConfiguration::setWebSocketServerTunnelProxyPort(quint16 port)
{
m_webSocketServerTunnelProxyPort = port;
}
QHostAddress ProxyConfiguration::tcpServerTunnelProxyHost() const
{
return m_tcpServerTunnelProxyHost;
}
void ProxyConfiguration::setTcpServerTunnelProxyHost(const QHostAddress &address)
{
m_tcpServerTunnelProxyHost = address;
}
quint16 ProxyConfiguration::tcpServerTunnelProxyPort() const
{
return m_tcpServerTunnelProxyPort;
}
void ProxyConfiguration::setTcpServerTunnelProxyPort(quint16 port)
{
m_tcpServerTunnelProxyPort = port;
}
QDebug operator<<(QDebug debug, ProxyConfiguration *configuration)
{
QDebugStateSaver saver(debug);
debug.nospace() << "\n" << "========== ProxyConfiguration ==========" << "\n";
debug.nospace() << "Configuration file:" << configuration->fileName() << "\n";
debug.nospace() << "RemoteProxy configuration" << "\n";
debug.nospace() << " - Server name:" << configuration->serverName() << "\n";
debug.nospace() << " - Write logfile:" << configuration->writeLogFile() << "\n";
debug.nospace() << " - Logfile:" << configuration->logFileName() << "\n";
debug.nospace() << " - Log engine enabled:" << configuration->logEngineEnabled() << "\n";
debug.nospace() << " - JSON RPC timeout:" << configuration->jsonRpcTimeout() << " [ms]" << "\n";
debug.nospace() << " - Inactive timeout:" << configuration->inactiveTimeout() << " [ms]" << "\n";
debug.nospace() << "SSL configuration" << "\n";
debug.nospace() << " - Enabled:" << configuration->sslEnabled() << "\n";
debug.nospace() << " - Certificate:" << configuration->sslCertificateFileName() << "\n";
debug.nospace() << " - Certificate key:" << configuration->sslCertificateKeyFileName() << "\n";
debug.nospace() << " - Certificate chain:" << configuration->sslCertificateChainFileName() << "\n";
debug.nospace() << " - SSL certificate information:" << "\n";
debug.nospace() << " Common name:" << configuration->sslConfiguration().localCertificate().subjectInfo(QSslCertificate::CommonName) << "\n";
debug.nospace() << " Organisation:" << configuration->sslConfiguration().localCertificate().subjectInfo(QSslCertificate::Organization) << "\n";
debug.nospace() << " Organisation unit name:" << configuration->sslConfiguration().localCertificate().subjectInfo(QSslCertificate::OrganizationalUnitName) << "\n";
debug.nospace() << " Country name:" << configuration->sslConfiguration().localCertificate().subjectInfo(QSslCertificate::CountryName) << "\n";
debug.nospace() << " Locality name:" << configuration->sslConfiguration().localCertificate().subjectInfo(QSslCertificate::LocalityName) << "\n";
debug.nospace() << " State/Province:" << configuration->sslConfiguration().localCertificate().subjectInfo(QSslCertificate::StateOrProvinceName) << "\n";
debug.nospace() << " Email address:" << configuration->sslConfiguration().localCertificate().subjectInfo(QSslCertificate::EmailAddress) << "\n";
debug.nospace() << " - SSL certificate issuer information:" << "\n";
debug.nospace() << " Common name:" << configuration->sslConfiguration().localCertificate().issuerInfo(QSslCertificate::CommonName) << "\n";
debug.nospace() << " Organisation:" << configuration->sslConfiguration().localCertificate().issuerInfo(QSslCertificate::Organization) << "\n";
debug.nospace() << " Organisation unit name:" << configuration->sslConfiguration().localCertificate().issuerInfo(QSslCertificate::OrganizationalUnitName) << "\n";
debug.nospace() << " Country name:" << configuration->sslConfiguration().localCertificate().issuerInfo(QSslCertificate::CountryName) << "\n";
debug.nospace() << " Locality name:" << configuration->sslConfiguration().localCertificate().issuerInfo(QSslCertificate::LocalityName) << "\n";
debug.nospace() << " State/Province:" << configuration->sslConfiguration().localCertificate().issuerInfo(QSslCertificate::StateOrProvinceName) << "\n";
debug.nospace() << " Email address:" << configuration->sslConfiguration().localCertificate().issuerInfo(QSslCertificate::EmailAddress) << "\n";
debug.nospace() << "UnixSocketServer Proxy" << "\n";
debug.nospace() << " - Filename:" << configuration->unixSocketFileName() << "\n";
debug.nospace() << "WebSocketServer TunnelProxy" << "\n";
debug.nospace() << " - Host:" << configuration->webSocketServerTunnelProxyHost().toString() << "\n";
debug.nospace() << " - Port:" << configuration->webSocketServerTunnelProxyPort() << "\n";
debug.nospace() << "TcpServer TunnelProxy" << "\n";
debug.nospace() << " - Host:" << configuration->tcpServerTunnelProxyHost().toString() << "\n";
debug.nospace() << " - Port:" << configuration->tcpServerTunnelProxyPort() << "\n";
debug.nospace() << "========== ProxyConfiguration ==========";
return debug;
}
}