Blame server/proxy/pf_config.c

Packit Service 5a9772
/**
Packit Service 5a9772
 * FreeRDP: A Remote Desktop Protocol Implementation
Packit Service 5a9772
 * FreeRDP Proxy Server
Packit Service 5a9772
 *
Packit Service 5a9772
 * Copyright 2019 Kobi Mizrachi <kmizrachi18@gmail.com>
Packit Service 5a9772
 * Copyright 2019 Idan Freiberg <speidy@gmail.com>
Packit Service 5a9772
 *
Packit Service 5a9772
 * Licensed under the Apache License, Version 2.0 (the "License");
Packit Service 5a9772
 * you may not use this file except in compliance with the License.
Packit Service 5a9772
 * You may obtain a copy of the License at
Packit Service 5a9772
 *
Packit Service 5a9772
 *     http://www.apache.org/licenses/LICENSE-2.0
Packit Service 5a9772
 *
Packit Service 5a9772
 * Unless required by applicable law or agreed to in writing, software
Packit Service 5a9772
 * distributed under the License is distributed on an "AS IS" BASIS,
Packit Service 5a9772
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Packit Service 5a9772
 * See the License for the specific language governing permissions and
Packit Service 5a9772
 * limitations under the License.
Packit Service 5a9772
 */
Packit Service 5a9772
Packit Service 5a9772
#include <stdio.h>
Packit Service 5a9772
#include <string.h>
Packit Service 5a9772
#include <winpr/crt.h>
Packit Service 5a9772
#include <winpr/collections.h>
Packit Service 5a9772
#include <winpr/cmdline.h>
Packit Service 5a9772
Packit Service 5a9772
#include "pf_log.h"
Packit Service 5a9772
#include "pf_server.h"
Packit Service 5a9772
#include "pf_config.h"
Packit Service 5a9772
#include "pf_modules.h"
Packit Service 5a9772
Packit Service 5a9772
#define TAG PROXY_TAG("config")
Packit Service 5a9772
Packit Service 5a9772
#define CONFIG_PRINT_SECTION(section) WLog_INFO(TAG, "\t%s:", section)
Packit Service 5a9772
#define CONFIG_PRINT_STR(config, key) WLog_INFO(TAG, "\t\t%s: %s", #key, config->key)
Packit Service 5a9772
#define CONFIG_PRINT_BOOL(config, key) \
Packit Service 5a9772
	WLog_INFO(TAG, "\t\t%s: %s", #key, config->key ? "TRUE" : "FALSE")
Packit Service 5a9772
#define CONFIG_PRINT_UINT16(config, key) WLog_INFO(TAG, "\t\t%s: %" PRIu16 "", #key, config->key)
Packit Service 5a9772
#define CONFIG_PRINT_UINT32(config, key) WLog_INFO(TAG, "\t\t%s: %" PRIu32 "", #key, config->key)
Packit Service 5a9772
Packit Service 5a9772
BOOL pf_config_get_uint16(wIniFile* ini, const char* section, const char* key, UINT16* result)
Packit Service 5a9772
{
Packit Service 5a9772
	int val;
Packit Service 5a9772
Packit Service 5a9772
	val = IniFile_GetKeyValueInt(ini, section, key);
Packit Service 5a9772
	if ((val < 0) || (val > UINT16_MAX))
Packit Service 5a9772
	{
Packit Service 5a9772
		WLog_ERR(TAG, "[%s]: invalid value %d for key '%s.%s'.", __FUNCTION__, val, section, key);
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	*result = (UINT16)val;
Packit Service 5a9772
	return TRUE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
BOOL pf_config_get_uint32(wIniFile* ini, const char* section, const char* key, UINT32* result)
Packit Service 5a9772
{
Packit Service 5a9772
	int val;
Packit Service 5a9772
Packit Service 5a9772
	val = IniFile_GetKeyValueInt(ini, section, key);
Packit Service 5a9772
	if ((val < 0) || (val > INT32_MAX))
Packit Service 5a9772
	{
Packit Service 5a9772
		WLog_ERR(TAG, "[%s]: invalid value %d for key '%s.%s'.", __FUNCTION__, val, section, key);
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	*result = (UINT32)val;
Packit Service 5a9772
	return TRUE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
BOOL pf_config_get_bool(wIniFile* ini, const char* section, const char* key)
Packit Service 5a9772
{
Packit Service 5a9772
	int num_value;
Packit Service 5a9772
	const char* str_value;
Packit Service 5a9772
Packit Service 5a9772
	str_value = IniFile_GetKeyValueString(ini, section, key);
Packit Service 5a9772
	if (!str_value)
Packit Service 5a9772
	{
Packit Service 5a9772
		WLog_WARN(TAG, "[%s]: key '%s.%s' not found, value defaults to false.", __FUNCTION__,
Packit Service 5a9772
		          section, key);
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	if (strcmp(str_value, "TRUE") == 0 || strcmp(str_value, "true") == 0)
Packit Service 5a9772
		return TRUE;
Packit Service 5a9772
Packit Service 5a9772
	num_value = IniFile_GetKeyValueInt(ini, section, key);
Packit Service 5a9772
Packit Service 5a9772
	if (num_value == 1)
Packit Service 5a9772
		return TRUE;
Packit Service 5a9772
Packit Service 5a9772
	return FALSE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
const char* pf_config_get_str(wIniFile* ini, const char* section, const char* key)
Packit Service 5a9772
{
Packit Service 5a9772
	const char* value;
Packit Service 5a9772
Packit Service 5a9772
	value = IniFile_GetKeyValueString(ini, section, key);
Packit Service 5a9772
Packit Service 5a9772
	if (!value)
Packit Service 5a9772
	{
Packit Service 5a9772
		WLog_ERR(TAG, "[%s]: key '%s.%s' not found.", __FUNCTION__, section, key);
Packit Service 5a9772
		return NULL;
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	return value;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static BOOL pf_config_load_server(wIniFile* ini, proxyConfig* config)
Packit Service 5a9772
{
Packit Service 5a9772
	const char* host;
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_get_uint16(ini, "Server", "Port", &config->Port))
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
Packit Service 5a9772
	host = pf_config_get_str(ini, "Server", "Host");
Packit Service 5a9772
Packit Service 5a9772
	if (!host)
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
Packit Service 5a9772
	config->Host = _strdup(host);
Packit Service 5a9772
Packit Service 5a9772
	if (!config->Host)
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
Packit Service 5a9772
	return TRUE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static BOOL pf_config_load_target(wIniFile* ini, proxyConfig* config)
Packit Service 5a9772
{
Packit Service 5a9772
	const char* target_host;
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_get_uint16(ini, "Target", "Port", &config->TargetPort))
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
Packit Service 5a9772
	target_host = pf_config_get_str(ini, "Target", "Host");
Packit Service 5a9772
Packit Service 5a9772
	if (!target_host)
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
Packit Service 5a9772
	config->TargetHost = _strdup(target_host);
Packit Service 5a9772
	if (!config->TargetHost)
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
Packit Service 5a9772
	config->UseLoadBalanceInfo = pf_config_get_bool(ini, "Target", "UseLoadBalanceInfo");
Packit Service 5a9772
	return TRUE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static BOOL pf_config_load_channels(wIniFile* ini, proxyConfig* config)
Packit Service 5a9772
{
Packit Service 5a9772
	config->GFX = pf_config_get_bool(ini, "Channels", "GFX");
Packit Service 5a9772
	config->DisplayControl = pf_config_get_bool(ini, "Channels", "DisplayControl");
Packit Service 5a9772
	config->Clipboard = pf_config_get_bool(ini, "Channels", "Clipboard");
Packit Service 5a9772
	config->AudioOutput = pf_config_get_bool(ini, "Channels", "AudioOutput");
Packit Service 5a9772
	config->RemoteApp = pf_config_get_bool(ini, "Channels", "RemoteApp");
Packit Service 5a9772
	config->Passthrough = CommandLineParseCommaSeparatedValues(
Packit Service 5a9772
	    pf_config_get_str(ini, "Channels", "Passthrough"), &config->PassthroughCount);
Packit Service 5a9772
Packit Service 5a9772
	{
Packit Service 5a9772
		/* validate channel name length */
Packit Service 5a9772
		size_t i;
Packit Service 5a9772
Packit Service 5a9772
		for (i = 0; i < config->PassthroughCount; i++)
Packit Service 5a9772
		{
Packit Service 5a9772
			if (strlen(config->Passthrough[i]) > CHANNEL_NAME_LEN)
Packit Service 5a9772
			{
Packit Service 5a9772
				WLog_ERR(TAG, "passthrough channel: %s: name too long!", config->Passthrough[i]);
Packit Service 5a9772
				return FALSE;
Packit Service 5a9772
			}
Packit Service 5a9772
		}
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	return TRUE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static BOOL pf_config_load_input(wIniFile* ini, proxyConfig* config)
Packit Service 5a9772
{
Packit Service 5a9772
	config->Keyboard = pf_config_get_bool(ini, "Input", "Keyboard");
Packit Service 5a9772
	config->Mouse = pf_config_get_bool(ini, "Input", "Mouse");
Packit Service 5a9772
	return TRUE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static BOOL pf_config_load_security(wIniFile* ini, proxyConfig* config)
Packit Service 5a9772
{
Packit Service 5a9772
	config->ServerTlsSecurity = pf_config_get_bool(ini, "Security", "ServerTlsSecurity");
Packit Service 5a9772
	config->ServerRdpSecurity = pf_config_get_bool(ini, "Security", "ServerRdpSecurity");
Packit Service 5a9772
Packit Service 5a9772
	config->ClientTlsSecurity = pf_config_get_bool(ini, "Security", "ClientTlsSecurity");
Packit Service 5a9772
	config->ClientNlaSecurity = pf_config_get_bool(ini, "Security", "ClientNlaSecurity");
Packit Service 5a9772
	config->ClientRdpSecurity = pf_config_get_bool(ini, "Security", "ClientRdpSecurity");
Packit Service 5a9772
	config->ClientAllowFallbackToTls =
Packit Service 5a9772
	    pf_config_get_bool(ini, "Security", "ClientAllowFallbackToTls");
Packit Service 5a9772
	return TRUE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static BOOL pf_config_load_clipboard(wIniFile* ini, proxyConfig* config)
Packit Service 5a9772
{
Packit Service 5a9772
	config->TextOnly = pf_config_get_bool(ini, "Clipboard", "TextOnly");
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_get_uint32(ini, "Clipboard", "MaxTextLength", &config->MaxTextLength))
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
Packit Service 5a9772
	return TRUE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static BOOL pf_config_load_modules(wIniFile* ini, proxyConfig* config)
Packit Service 5a9772
{
Packit Service 5a9772
	const char* modules_to_load;
Packit Service 5a9772
	const char* required_modules;
Packit Service 5a9772
Packit Service 5a9772
	modules_to_load = IniFile_GetKeyValueString(ini, "Plugins", "Modules");
Packit Service 5a9772
	required_modules = IniFile_GetKeyValueString(ini, "Plugins", "Required");
Packit Service 5a9772
Packit Service 5a9772
	config->Modules = CommandLineParseCommaSeparatedValues(modules_to_load, &config->ModulesCount);
Packit Service 5a9772
Packit Service 5a9772
	config->RequiredPlugins =
Packit Service 5a9772
	    CommandLineParseCommaSeparatedValues(required_modules, &config->RequiredPluginsCount);
Packit Service 5a9772
	return TRUE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static BOOL pf_config_load_captures(wIniFile* ini, proxyConfig* config)
Packit Service 5a9772
{
Packit Service 5a9772
	const char* captures_dir;
Packit Service 5a9772
Packit Service 5a9772
	config->SessionCapture = pf_config_get_bool(ini, "SessionCapture", "Enabled");
Packit Service 5a9772
	if (!config->SessionCapture)
Packit Service 5a9772
		return TRUE;
Packit Service 5a9772
Packit Service 5a9772
	captures_dir = pf_config_get_str(ini, "SessionCapture", "CapturesDirectory");
Packit Service 5a9772
Packit Service 5a9772
	if (!captures_dir)
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
Packit Service 5a9772
	config->CapturesDirectory = strdup(captures_dir);
Packit Service 5a9772
	if (!config->CapturesDirectory)
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
Packit Service 5a9772
	if (!PathFileExistsA(config->CapturesDirectory))
Packit Service 5a9772
	{
Packit Service 5a9772
		if (!CreateDirectoryA(config->CapturesDirectory, NULL))
Packit Service 5a9772
		{
Packit Service 5a9772
			free(config->CapturesDirectory);
Packit Service 5a9772
			config->CapturesDirectory = NULL;
Packit Service 5a9772
			return FALSE;
Packit Service 5a9772
		}
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	return TRUE;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
proxyConfig* pf_server_config_load(const char* path)
Packit Service 5a9772
{
Packit Service 5a9772
	proxyConfig* config = NULL;
Packit Service 5a9772
	wIniFile* ini = IniFile_New();
Packit Service 5a9772
Packit Service 5a9772
	if (!ini)
Packit Service 5a9772
	{
Packit Service 5a9772
		WLog_ERR(TAG, "[%s]: IniFile_New() failed!", __FUNCTION__);
Packit Service 5a9772
		return FALSE;
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	if (IniFile_ReadFile(ini, path) < 0)
Packit Service 5a9772
	{
Packit Service 5a9772
		WLog_ERR(TAG, "[%s] failed to parse ini file: '%s'", __FUNCTION__, path);
Packit Service 5a9772
		goto out;
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	config = calloc(1, sizeof(proxyConfig));
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_load_server(ini, config))
Packit Service 5a9772
		goto out;
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_load_target(ini, config))
Packit Service 5a9772
		goto out;
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_load_channels(ini, config))
Packit Service 5a9772
		goto out;
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_load_input(ini, config))
Packit Service 5a9772
		goto out;
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_load_security(ini, config))
Packit Service 5a9772
		goto out;
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_load_modules(ini, config))
Packit Service 5a9772
		goto out;
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_load_clipboard(ini, config))
Packit Service 5a9772
		goto out;
Packit Service 5a9772
Packit Service 5a9772
	if (!pf_config_load_captures(ini, config))
Packit Service 5a9772
		goto out;
Packit Service 5a9772
Packit Service 5a9772
	IniFile_Free(ini);
Packit Service 5a9772
	return config;
Packit Service 5a9772
Packit Service 5a9772
out:
Packit Service 5a9772
	IniFile_Free(ini);
Packit Service 5a9772
	pf_server_config_free(config);
Packit Service 5a9772
	return NULL;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static void pf_server_config_print_list(char** list, size_t count)
Packit Service 5a9772
{
Packit Service 5a9772
	size_t i;
Packit Service 5a9772
Packit Service 5a9772
	for (i = 0; i < count; i++)
Packit Service 5a9772
		WLog_INFO(TAG, "\t\t- %s", list[i]);
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
void pf_server_config_print(proxyConfig* config)
Packit Service 5a9772
{
Packit Service 5a9772
	WLog_INFO(TAG, "Proxy configuration:");
Packit Service 5a9772
Packit Service 5a9772
	CONFIG_PRINT_SECTION("Server");
Packit Service 5a9772
	CONFIG_PRINT_STR(config, Host);
Packit Service 5a9772
	CONFIG_PRINT_UINT16(config, Port);
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, SessionCapture);
Packit Service 5a9772
Packit Service 5a9772
	if (!config->UseLoadBalanceInfo)
Packit Service 5a9772
	{
Packit Service 5a9772
		CONFIG_PRINT_SECTION("Target");
Packit Service 5a9772
		CONFIG_PRINT_STR(config, TargetHost);
Packit Service 5a9772
		CONFIG_PRINT_UINT16(config, TargetPort);
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	CONFIG_PRINT_SECTION("Input");
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, Keyboard);
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, Mouse);
Packit Service 5a9772
Packit Service 5a9772
	CONFIG_PRINT_SECTION("Server Security");
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, ServerTlsSecurity);
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, ServerRdpSecurity);
Packit Service 5a9772
Packit Service 5a9772
	CONFIG_PRINT_SECTION("Client Security");
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, ClientNlaSecurity);
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, ClientTlsSecurity);
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, ClientRdpSecurity);
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, ClientAllowFallbackToTls);
Packit Service 5a9772
Packit Service 5a9772
	CONFIG_PRINT_SECTION("Channels");
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, GFX);
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, DisplayControl);
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, Clipboard);
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, AudioOutput);
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, RemoteApp);
Packit Service 5a9772
Packit Service 5a9772
	if (config->PassthroughCount)
Packit Service 5a9772
	{
Packit Service 5a9772
		WLog_INFO(TAG, "\tStatic Channels Proxy:");
Packit Service 5a9772
		pf_server_config_print_list(config->Passthrough, config->PassthroughCount);
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	CONFIG_PRINT_SECTION("Clipboard");
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, TextOnly);
Packit Service 5a9772
	if (config->MaxTextLength > 0)
Packit Service 5a9772
		CONFIG_PRINT_UINT32(config, MaxTextLength);
Packit Service 5a9772
Packit Service 5a9772
	CONFIG_PRINT_SECTION("SessionCapture");
Packit Service 5a9772
	CONFIG_PRINT_BOOL(config, SessionCapture);
Packit Service 5a9772
	CONFIG_PRINT_STR(config, CapturesDirectory);
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
void pf_server_config_free(proxyConfig* config)
Packit Service 5a9772
{
Packit Service 5a9772
	if (config == NULL)
Packit Service 5a9772
		return;
Packit Service 5a9772
Packit Service 5a9772
	free(config->Passthrough);
Packit Service 5a9772
	free(config->CapturesDirectory);
Packit Service 5a9772
	free(config->RequiredPlugins);
Packit Service 5a9772
	free(config->Modules);
Packit Service 5a9772
	free(config->TargetHost);
Packit Service 5a9772
	free(config->Host);
Packit Service 5a9772
	free(config);
Packit Service 5a9772
}