BeamMP/BeamMP-Server
1
0
Fork 0
mirror of https://github.com/BeamMP/BeamMP-Server.git synced 2026-06-17 22:23:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add UseSSL option to server config

Browse Source
This commit is contained in:
Lion Kortlepel
2021-12-06 13:47:07 +01:00
parent a1335e8c7d
commit 3cce875fbb
4 changed files with 69 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/Common.h
+1
View File
@@ -52,6 +52,7 @@ public:
bool SendErrors { true }; bool SendErrors { true };
bool SendErrorsMessageEnabled { true }; bool SendErrorsMessageEnabled { true };
int HTTPServerPort { 8080 }; int HTTPServerPort { 8080 };
bool HTTPServerUseSSL { true };
[[nodiscard]] bool HasCustomIP() const { return !CustomIP.empty(); } [[nodiscard]] bool HasCustomIP() const { return !CustomIP.empty(); }
}; };
include/TConfig.h
+6 -1
View File
@@ -4,6 +4,9 @@
#include <atomic> #include <atomic>
#define TOML11_PRESERVE_COMMENTS_BY_DEFAULT
#include <toml11/toml.hpp> // header-only version of TOML++
namespace fs = std::filesystem; namespace fs = std::filesystem;
class TConfig { class TConfig {
@@ -18,10 +21,12 @@ private:
void CreateConfigFile(std::string_view name); void CreateConfigFile(std::string_view name);
void ParseFromFile(std::string_view name); void ParseFromFile(std::string_view name);
void PrintDebug(); void PrintDebug();
void TryReadValue(toml::value& Table, const std::string& Category, const std::string_view& Key, std::string& OutValue);
void TryReadValue(toml::value& Table, const std::string& Category, const std::string_view& Key, bool& OutValue);
void TryReadValue(toml::value& Table, const std::string& Category, const std::string_view& Key, int& OutValue);
void ParseOldFormat(); void ParseOldFormat();
bool IsDefault(); bool IsDefault();
bool mFailed { false }; bool mFailed { false };
std::string mConfigFileName; std::string mConfigFileName;
}; };
src/Http.cpp
+10 -5
View File
@@ -270,16 +270,21 @@ Http::Server::THttpServerInstance::THttpServerInstance() {
} }
void Http::Server::THttpServerInstance::operator()() { void Http::Server::THttpServerInstance::operator()() {
beammp_info("HTTPS Server started on port " + std::to_string(Application::Settings.HTTPServerPort)); beammp_info("HTTP(S) Server started on port " + std::to_string(Application::Settings.HTTPServerPort));
httplib::SSLServer HttpLibServerInstance { Application::Settings.SSLCertPath.c_str(), Application::Settings.SSLKeyPath.c_str() }; std::unique_ptr<httplib::Server> HttpLibServerInstance;
if (Application::Settings.HTTPServerUseSSL) {
HttpLibServerInstance = std::make_unique<httplib::SSLServer>(Application::Settings.SSLCertPath.c_str(), Application::Settings.SSLKeyPath.c_str());
} else {
HttpLibServerInstance = std::make_unique<httplib::Server>();
}
// todo: make this IP agnostic so people can set their own IP // todo: make this IP agnostic so people can set their own IP
HttpLibServerInstance.Get("/", [](const httplib::Request&, httplib::Response& res) { HttpLibServerInstance->Get("/", [](const httplib::Request&, httplib::Response& res) {
res.set_content("<!DOCTYPE html><article><h1>Hello World!</h1><section><p>BeamMP Server can now serve HTTP requests!</p></section></article></html>", "text/html"); res.set_content("<!DOCTYPE html><article><h1>Hello World!</h1><section><p>BeamMP Server can now serve HTTP requests!</p></section></article></html>", "text/html");
}); });
HttpLibServerInstance.Get("/health", [](const httplib::Request&, httplib::Response& res) { HttpLibServerInstance->Get("/health", [](const httplib::Request&, httplib::Response& res) {
res.set_content("0", "text/plain"); res.set_content("0", "text/plain");
res.status = 200; res.status = 200;
}); });
Application::SetSubsystemStatus("HTTPServer", Application::Status::Good); Application::SetSubsystemStatus("HTTPServer", Application::Status::Good);
HttpLibServerInstance.listen("0.0.0.0", Application::Settings.HTTPServerPort); HttpLibServerInstance->listen("0.0.0.0", Application::Settings.HTTPServerPort);
} }
src/TConfig.cpp
+52 -37
View File
@@ -1,7 +1,4 @@
#include "Common.h" #include "Common.h"
#define TOML11_PRESERVE_COMMENTS_BY_DEFAULT
#include <toml11/toml.hpp> // header-only version of TOML++
#include "TConfig.h" #include "TConfig.h"
#include <fstream> #include <fstream>
@@ -23,6 +20,7 @@ static constexpr std::string_view StrAuthKey = "AuthKey";
static constexpr std::string_view StrSendErrors = "SendErrors"; static constexpr std::string_view StrSendErrors = "SendErrors";
static constexpr std::string_view StrSendErrorsMessageEnabled = "SendErrorsShowMessage"; static constexpr std::string_view StrSendErrorsMessageEnabled = "SendErrorsShowMessage";
static constexpr std::string_view StrHTTPServerEnabled = "HTTPServerEnabled"; static constexpr std::string_view StrHTTPServerEnabled = "HTTPServerEnabled";
static constexpr std::string_view StrHTTPServerUseSSL = "UseSSL";
// HTTP // HTTP
static constexpr std::string_view StrSSLKeyPath = "SSLKeyPath"; static constexpr std::string_view StrSSLKeyPath = "SSLKeyPath";
@@ -44,6 +42,12 @@ TConfig::TConfig(const std::string& ConfigFileName)
} }
} }
template <typename CommentsT>
void SetComment(CommentsT& Comments, const std::string& Comment) {
Comments.clear();
Comments.push_back(Comment);
}
/** /**
* @brief Writes out the loaded application state into ServerConfig.toml * @brief Writes out the loaded application state into ServerConfig.toml
* *
@@ -56,9 +60,8 @@ TConfig::TConfig(const std::string& ConfigFileName)
void TConfig::FlushToFile() { void TConfig::FlushToFile() {
auto data = toml::parse<toml::preserve_comments>(mConfigFileName); auto data = toml::parse<toml::preserve_comments>(mConfigFileName);
data["General"] = toml::table(); data["General"] = toml::table();
data["General"].comments().push_back(" General BeamMP Server settings");
data["General"][StrAuthKey.data()] = Application::Settings.Key; data["General"][StrAuthKey.data()] = Application::Settings.Key;
data["General"][StrAuthKey.data()].comments().push_back(" AuthKey has to be filled out in order to run the server"); SetComment(data["General"][StrAuthKey.data()].comments(), " AuthKey has to be filled out in order to run the server");
data["General"][StrDebug.data()] = Application::Settings.DebugModeEnabled; data["General"][StrDebug.data()] = Application::Settings.DebugModeEnabled;
data["General"][StrPrivate.data()] = Application::Settings.Private; data["General"][StrPrivate.data()] = Application::Settings.Private;
data["General"][StrPort.data()] = Application::Settings.Port; data["General"][StrPort.data()] = Application::Settings.Port;
@@ -69,14 +72,16 @@ void TConfig::FlushToFile() {
data["General"][StrDescription.data()] = Application::Settings.ServerDesc; data["General"][StrDescription.data()] = Application::Settings.ServerDesc;
data["General"][StrResourceFolder.data()] = Application::Settings.Resource; data["General"][StrResourceFolder.data()] = Application::Settings.Resource;
data["General"][StrSendErrors.data()] = Application::Settings.SendErrors; data["General"][StrSendErrors.data()] = Application::Settings.SendErrors;
data["General"][StrSendErrors.data()].comments().push_back(" You can turn on/off the SendErrors message you get on startup here"); SetComment(data["General"][StrSendErrors.data()].comments(), " You can turn on/off the SendErrors message you get on startup here");
data["General"][StrSendErrorsMessageEnabled.data()] = Application::Settings.SendErrorsMessageEnabled; data["General"][StrSendErrorsMessageEnabled.data()] = Application::Settings.SendErrorsMessageEnabled;
data["General"][StrSendErrorsMessageEnabled.data()].comments().push_back(" If SendErrors is `true`, the server will send helpful info about crashes and other issues back to the BeamMP developers. This info may include your config, who is on your server at the time of the error, and similar general information. This kind of data is vital in helping us diagnose and fix issues faster. This has no impact on server performance. You can opt-out of this system by setting this to `false`"); SetComment(data["General"][StrSendErrorsMessageEnabled.data()].comments(), " If SendErrors is `true`, the server will send helpful info about crashes and other issues back to the BeamMP developers. This info may include your config, who is on your server at the time of the error, and similar general information. This kind of data is vital in helping us diagnose and fix issues faster. This has no impact on server performance. You can opt-out of this system by setting this to `false`");
data["HTTP"][StrSSLKeyPath.data()] = Application::Settings.SSLKeyPath; data["HTTP"][StrSSLKeyPath.data()] = Application::Settings.SSLKeyPath;
data["HTTP"][StrSSLCertPath.data()] = Application::Settings.SSLCertPath; data["HTTP"][StrSSLCertPath.data()] = Application::Settings.SSLCertPath;
data["HTTP"][StrHTTPServerPort.data()] = Application::Settings.HTTPServerPort; data["HTTP"][StrHTTPServerPort.data()] = Application::Settings.HTTPServerPort;
data["HTTP"][StrHTTPServerUseSSL.data()] = Application::Settings.HTTPServerUseSSL;
SetComment(data["HTTP"][StrHTTPServerUseSSL.data()].comments(), " Recommended to keep enabled. With SSL the server will serve https and requires valid key and cert files");
data["HTTP"][StrHTTPServerEnabled.data()] = Application::Settings.HTTPServerEnabled; data["HTTP"][StrHTTPServerEnabled.data()] = Application::Settings.HTTPServerEnabled;
data["HTTP"][StrHTTPServerEnabled.data()].comments().push_back(" Enables the internal HTTP server"); SetComment(data["HTTP"][StrHTTPServerEnabled.data()].comments(), " Enables the internal HTTP server");
std::ofstream Stream(mConfigFileName); std::ofstream Stream(mConfigFileName);
Stream << data << std::flush; Stream << data << std::flush;
} }
@@ -121,35 +126,46 @@ void TConfig::CreateConfigFile(std::string_view name) {
} }
} }
void TConfig::TryReadValue(toml::value& Table, const std::string& Category, const std::string_view& Key, std::string& OutValue) {
if (Table[Category.c_str()][Key.data()].is_string()) {
OutValue = Table[Category.c_str()][Key.data()].as_string();
}
}
void TConfig::TryReadValue(toml::value& Table, const std::string& Category, const std::string_view& Key, bool& OutValue) {
if (Table[Category.c_str()][Key.data()].is_boolean()) {
OutValue = Table[Category.c_str()][Key.data()].as_boolean();
}
}
void TConfig::TryReadValue(toml::value& Table, const std::string& Category, const std::string_view& Key, int& OutValue) {
if (Table[Category.c_str()][Key.data()].is_integer()) {
OutValue = Table[Category.c_str()][Key.data()].as_integer();
}
}
void TConfig::ParseFromFile(std::string_view name) { void TConfig::ParseFromFile(std::string_view name) {
bool UpdateConfigFile = false;
try { try {
toml::value data = toml::parse<toml::preserve_comments>(name.data()); toml::value data = toml::parse<toml::preserve_comments>(name.data());
Application::Settings.DebugModeEnabled = data["General"][StrDebug.data()].as_boolean(); // GENERAL
Application::Settings.Private = data["General"][StrPrivate.data()].as_boolean(); TryReadValue(data, "General", StrDebug, Application::Settings.DebugModeEnabled);
Application::Settings.Port = data["General"][StrPort.data()].as_integer(); TryReadValue(data, "General", StrPrivate, Application::Settings.Private);
Application::Settings.MaxCars = data["General"][StrMaxCars.data()].as_integer(); TryReadValue(data, "General", StrPort, Application::Settings.Port);
Application::Settings.MaxPlayers = data["General"][StrMaxPlayers.data()].as_integer(); TryReadValue(data, "General", StrMaxCars, Application::Settings.MaxCars);
Application::Settings.MapName = data["General"][StrMap.data()].as_string(); TryReadValue(data, "General", StrMaxPlayers, Application::Settings.MaxPlayers);
Application::Settings.ServerName = data["General"][StrName.data()].as_string(); TryReadValue(data, "General", StrMap, Application::Settings.MapName);
Application::Settings.ServerDesc = data["General"][StrDescription.data()].as_string(); TryReadValue(data, "General", StrName, Application::Settings.ServerName);
Application::Settings.Resource = data["General"][StrResourceFolder.data()].as_string(); TryReadValue(data, "General", StrDescription, Application::Settings.ServerDesc);
Application::Settings.Key = data["General"][StrAuthKey.data()].as_string(); TryReadValue(data, "General", StrResourceFolder, Application::Settings.Resource);
if (!data["HTTP"][StrSSLKeyPath.data()].is_string()) { TryReadValue(data, "General", StrAuthKey, Application::Settings.Key);
UpdateConfigFile = true; TryReadValue(data, "General", StrSendErrors, Application::Settings.SendErrors);
} else { TryReadValue(data, "General", StrSendErrorsMessageEnabled, Application::Settings.SendErrorsMessageEnabled);
Application::Settings.SSLKeyPath = data["HTTP"][StrSSLKeyPath.data()].as_string(); // HTTP
Application::Settings.SSLCertPath = data["HTTP"][StrSSLCertPath.data()].as_string(); TryReadValue(data, "HTTP", StrSSLKeyPath, Application::Settings.SSLKeyPath);
Application::Settings.HTTPServerPort = data["HTTP"][StrHTTPServerPort.data()].as_integer(); TryReadValue(data, "HTTP", StrSSLCertPath, Application::Settings.SSLCertPath);
Application::Settings.HTTPServerEnabled = data["HTTP"][StrHTTPServerEnabled.data()].as_boolean(); TryReadValue(data, "HTTP", StrHTTPServerPort, Application::Settings.HTTPServerPort);
} TryReadValue(data, "HTTP", StrHTTPServerEnabled, Application::Settings.HTTPServerEnabled);
if (!data["General"][StrSendErrors.data()].is_boolean() TryReadValue(data, "HTTP", StrHTTPServerUseSSL, Application::Settings.HTTPServerUseSSL);
|| !data["General"][StrSendErrorsMessageEnabled.data()].is_boolean()) {
UpdateConfigFile = true;
} else {
Application::Settings.SendErrors = data["General"][StrSendErrors.data()].as_boolean();
Application::Settings.SendErrorsMessageEnabled = data["General"][StrSendErrorsMessageEnabled.data()].as_boolean();
}
} catch (const std::exception& err) { } catch (const std::exception& err) {
beammp_error("Error parsing config file value: " + std::string(err.what())); beammp_error("Error parsing config file value: " + std::string(err.what()));
mFailed = true; mFailed = true;
@@ -158,9 +174,8 @@ void TConfig::ParseFromFile(std::string_view name) {
} }
PrintDebug(); PrintDebug();
if (UpdateConfigFile) { // Update in any case
FlushToFile(); FlushToFile();
}
// all good so far, let's check if there's a key // all good so far, let's check if there's a key
if (Application::Settings.Key.empty()) { if (Application::Settings.Key.empty()) {
beammp_error("No AuthKey specified in the \"" + std::string(mConfigFileName) + "\" file. Please get an AuthKey, enter it into the config file, and restart this server."); beammp_error("No AuthKey specified in the \"" + std::string(mConfigFileName) + "\" file. Please get an AuthKey, enter it into the config file, and restart this server.");