Merge pull request #559 from Palakis/enhancement/ipv4-option

Settings: Add option to lock binding to IPv4

data/locale/en-US.ini

@@ -3,6 +3,7 @@ OBSWebsocket.Settings.ServerEnable="Enable WebSockets server"
 OBSWebsocket.Settings.ServerPort="Server Port"
 OBSWebsocket.Settings.AuthRequired="Enable authentication"
 OBSWebsocket.Settings.Password="Password"
+OBSWebsocket.Settings.LockToIPv4="Lock server to only using IPv4"
 OBSWebsocket.Settings.DebugEnable="Enable debug logging"
 OBSWebsocket.Settings.AlertsEnable="Enable System Tray Alerts"
 OBSWebsocket.NotifyConnect.Title="New WebSocket connection"

src/Config.cpp

@@ -25,6 +25,7 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 #define SECTION_NAME "WebsocketAPI"
 #define PARAM_ENABLE "ServerEnabled"
 #define PARAM_PORT "ServerPort"
+#define PARAM_LOCKTOIPV4 "LockToIPv4"
 #define PARAM_DEBUG "DebugEnabled"
 #define PARAM_ALERT "AlertsEnabled"
 #define PARAM_AUTHREQUIRED "AuthRequired"
@@ -41,6 +42,7 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 Config::Config() :
 	ServerEnabled(true),
 	ServerPort(4444),
+	LockToIPv4(false),
 	DebugEnabled(false),
 	AlertsEnabled(true),
 	AuthRequired(false),
@@ -67,6 +69,7 @@ void Config::Load()
 
 	ServerEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ENABLE);
 	ServerPort = config_get_uint(obsConfig, SECTION_NAME, PARAM_PORT);
+	LockToIPv4 = config_get_bool(obsConfig, SECTION_NAME, PARAM_LOCKTOIPV4);
 
 	DebugEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_DEBUG);
 	AlertsEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ALERT);
@@ -82,6 +85,7 @@ void Config::Save()
 
 	config_set_bool(obsConfig, SECTION_NAME, PARAM_ENABLE, ServerEnabled);
 	config_set_uint(obsConfig, SECTION_NAME, PARAM_PORT, ServerPort);
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_LOCKTOIPV4, LockToIPv4);
 
 	config_set_bool(obsConfig, SECTION_NAME, PARAM_DEBUG, DebugEnabled);
 	config_set_bool(obsConfig, SECTION_NAME, PARAM_ALERT, AlertsEnabled);
@@ -104,6 +108,8 @@ void Config::SetDefaults()
 			SECTION_NAME, PARAM_ENABLE, ServerEnabled);
 		config_set_default_uint(obsConfig,
 			SECTION_NAME, PARAM_PORT, ServerPort);
+		config_set_default_bool(obsConfig,
+			SECTION_NAME, PARAM_LOCKTOIPV4, LockToIPv4);
 
 		config_set_default_bool(obsConfig,
 			SECTION_NAME, PARAM_DEBUG, DebugEnabled);
@@ -205,16 +211,17 @@ void Config::OnFrontendEvent(enum obs_frontend_event event, void* param)
 
 		bool previousEnabled = config->ServerEnabled;
 		uint64_t previousPort = config->ServerPort;
+		bool previousLock = config->LockToIPv4;
 
 		config->SetDefaults();
 		config->Load();
 
-		if (config->ServerEnabled != previousEnabled || config->ServerPort != previousPort) {
+		if (config->ServerEnabled != previousEnabled || config->ServerPort != previousPort || config->LockToIPv4 != previousLock) {
 			auto server = GetServer();
 			server->stop();
 
 			if (config->ServerEnabled) {
-				server->start(config->ServerPort);
+				server->start(config->ServerPort, config->LockToIPv4);
 
 				if (previousEnabled != config->ServerEnabled) {
 					Utils::SysTrayNotify(startMessage, QSystemTrayIcon::MessageIcon::Information);
@@ -247,6 +254,13 @@ void Config::MigrateFromGlobalSettings()
 		config_remove_value(source, SECTION_NAME, PARAM_PORT);
 	}
 	
+	if(config_has_user_value(source, SECTION_NAME, PARAM_LOCKTOIPV4)) {
+		bool value = config_get_bool(source, SECTION_NAME, PARAM_LOCKTOIPV4);
+		config_set_bool(destination, SECTION_NAME, PARAM_LOCKTOIPV4, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_LOCKTOIPV4);
+	}
+
 	if(config_has_user_value(source, SECTION_NAME, PARAM_DEBUG)) {
 		bool value = config_get_bool(source, SECTION_NAME, PARAM_DEBUG);
 		config_set_bool(destination, SECTION_NAME, PARAM_DEBUG, value);

src/Config.h

@@ -42,6 +42,7 @@ class Config {
 
 		bool ServerEnabled;
 		uint64_t ServerPort;
+		bool LockToIPv4;
 
 		bool DebugEnabled;
 		bool AlertsEnabled;

src/WSServer.cpp

@@ -60,10 +60,10 @@ WSServer::~WSServer()
 	stop();
 }
 
-void WSServer::start(quint16 port)
+void WSServer::start(quint16 port, bool lockToIPv4)
 {
-	if (_server.is_listening() && port == _serverPort) {
+	if (_server.is_listening() && (port == _serverPort && _lockToIPv4 == lockToIPv4)) {
-		blog(LOG_INFO, "WSServer::start: server already on this port. no restart needed");
+		blog(LOG_INFO, "WSServer::start: server already on this port and protocol mode. no restart needed");
 		return;
 	}
 
@@ -74,9 +74,16 @@ void WSServer::start(quint16 port)
 	_server.reset();
 
 	_serverPort = port;
+	_lockToIPv4 = lockToIPv4;
 
 	websocketpp::lib::error_code errorCode;
+	if (lockToIPv4) {
+		blog(LOG_INFO, "WSServer::start: Locked to IPv4 bindings");
+		_server.listen(websocketpp::lib::asio::ip::tcp::v4(), _serverPort, errorCode);
+	} else {
+		blog(LOG_INFO, "WSServer::start: Not locked to IPv4 bindings");
 		_server.listen(_serverPort, errorCode);
+	}
 
 	if (errorCode) {
 		std::string errorCodeMessage = errorCode.message();

src/WSServer.h

@@ -44,7 +44,7 @@ Q_OBJECT
 public:
 	explicit WSServer();
 	virtual ~WSServer();
-	void start(quint16 port);
+	void start(quint16 port, bool lockToIPv4);
 	void stop();
 	void broadcast(const RpcEvent& event);
 	QThreadPool* threadPool() {
@@ -62,6 +62,7 @@ private:
 
 	server _server;
 	quint16 _serverPort;
+	bool _lockToIPv4;
 	std::set<connection_hdl, std::owner_less<connection_hdl>> _connections;
 	std::map<connection_hdl, ConnectionProperties, std::owner_less<connection_hdl>> _connectionProperties;
 	QMutex _clMutex;

src/forms/settings-dialog.cpp

@@ -45,6 +45,7 @@ void SettingsDialog::showEvent(QShowEvent* event) {
 
 	ui->serverEnabled->setChecked(conf->ServerEnabled);
 	ui->serverPort->setValue(conf->ServerPort);
+	ui->lockToIPv4->setChecked(conf->LockToIPv4);
 
 	ui->debugEnabled->setChecked(conf->DebugEnabled);
 	ui->alertsEnabled->setChecked(conf->AlertsEnabled);
@@ -72,6 +73,7 @@ void SettingsDialog::FormAccepted() {
 
 	conf->ServerEnabled = ui->serverEnabled->isChecked();
 	conf->ServerPort = ui->serverPort->value();
+	conf->LockToIPv4 = ui->lockToIPv4->isChecked();
 
 	conf->DebugEnabled = ui->debugEnabled->isChecked();
 	conf->AlertsEnabled = ui->alertsEnabled->isChecked();
@@ -95,7 +97,7 @@ void SettingsDialog::FormAccepted() {
 
 	auto server = GetServer();
 	if (conf->ServerEnabled) {
-		server->start(conf->ServerPort);
+		server->start(conf->ServerPort, conf->LockToIPv4);
 	} else {
 		server->stop();
 	}

src/forms/settings-dialog.ui

@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>407</width>
-		<height>195</height>
+    <height>216</height>
    </rect>
   </property>
   <property name="sizePolicy">
@@ -79,7 +79,7 @@
        </property>
       </widget>
      </item>
-		 <item row="5" column="1">
+     <item row="6" column="1">
       <widget class="QCheckBox" name="alertsEnabled">
        <property name="text">
         <string>OBSWebsocket.Settings.AlertsEnable</string>
@@ -89,7 +89,7 @@
        </property>
       </widget>
      </item>
-		 <item row="6" column="1">
+     <item row="7" column="1">
       <widget class="QCheckBox" name="debugEnabled">
        <property name="text">
         <string>OBSWebsocket.Settings.DebugEnable</string>
@@ -99,6 +99,13 @@
        </property>
       </widget>
      </item>
+     <item row="5" column="1">
+      <widget class="QCheckBox" name="lockToIPv4">
+       <property name="text">
+        <string>OBSWebsocket.Settings.LockToIPv4</string>
+       </property>
+      </widget>
+     </item>
     </layout>
    </item>
    <item>

src/obs-websocket.cpp

@@ -81,7 +81,7 @@ bool obs_module_load(void) {
 	auto eventCallback = [](enum obs_frontend_event event, void *param) {
 		if (event == OBS_FRONTEND_EVENT_FINISHED_LOADING) {
 			if (_config->ServerEnabled) {
-				_server->start(_config->ServerPort);
+				_server->start(_config->ServerPort, _config->LockToIPv4);
 			}
 			obs_frontend_remove_event_callback((obs_frontend_event_cb)param, nullptr);
 		}