26#include <winpr/path.h>
27#include <winpr/collections.h>
28#include <winpr/cmdline.h>
31#include <freerdp/server/proxy/proxy_config.h>
33#include <freerdp/server/proxy/proxy_log.h>
35#include <freerdp/crypto/crypto.h>
36#include <freerdp/channels/cliprdr.h>
37#include <freerdp/channels/rdpsnd.h>
38#include <freerdp/channels/audin.h>
39#include <freerdp/channels/rdpdr.h>
40#include <freerdp/channels/disp.h>
41#include <freerdp/channels/rail.h>
42#include <freerdp/channels/rdpei.h>
43#include <freerdp/channels/tsmf.h>
44#include <freerdp/channels/video.h>
45#include <freerdp/channels/rdpecam.h>
49#define TAG PROXY_TAG("config")
51#define CONFIG_PRINT_SECTION(section) WLog_INFO(TAG, "\t%s:", section)
52#define CONFIG_PRINT_SECTION_KEY(section, key) WLog_INFO(TAG, "\t%s/%s:", section, key)
53#define CONFIG_PRINT_STR(config, key) WLog_INFO(TAG, "\t\t%s: %s", #key, (config)->key)
54#define CONFIG_PRINT_SECRET_STR(config, key) \
55 WLog_INFO(TAG, "\t\t%s: %s", #key, (config)->key ? "********" : nullptr)
56#define CONFIG_PRINT_BOOL(config, key) WLog_INFO(TAG, "\t\t%s: %s", #key, boolstr((config)->key))
57#define CONFIG_PRINT_UINT16(config, key) WLog_INFO(TAG, "\t\t%s: %" PRIu16 "", #key, (config)->key)
58#define CONFIG_PRINT_UINT32(config, key) WLog_INFO(TAG, "\t\t%s: %" PRIu32 "", #key, (config)->key)
60static const char* bool_str_true =
"true";
61static const char* bool_str_false =
"false";
64static const char* boolstr(BOOL rc)
66 return rc ? bool_str_true : bool_str_false;
69static const char* section_server =
"Server";
70static const char* key_host =
"Host";
71static const char* key_port =
"Port";
72static const char* key_sam_file =
"SamFile";
74static const char* section_target =
"Target";
75static const char* key_target_fixed =
"FixedTarget";
76static const char* key_target_user =
"User";
77static const char* key_target_pwd =
"Password";
78static const char* key_target_domain =
"Domain";
79static const char* key_target_tls_seclevel =
"TlsSecLevel";
80static const char* key_target_scard_auth =
"SmartcardAuth";
81static const char* key_target_scard_cert =
"SmartcardCert";
82static const char* key_target_scard_key =
"SmartcardKey";
83static const char* key_target_scard_pem_cert =
"SmartcardCertPEMContent";
84static const char* key_target_scard_pem_key =
"SmartcardKeyPEMContent";
86static const char* section_plugins =
"Plugins";
87static const char* key_plugins_modules =
"Modules";
88static const char* key_plugins_required =
"Required";
90static const char* section_codecs =
"Codecs";
91static const char* key_codecs_rfx =
"RFX";
92static const char* key_codecs_nsc =
"NSC";
94static const char* section_channels =
"Channels";
95static const char* key_channels_gfx =
"GFX";
96static const char* key_channels_disp =
"DisplayControl";
97static const char* key_channels_clip =
"Clipboard";
98static const char* key_channels_mic =
"AudioInput";
99static const char* key_channels_sound =
"AudioOutput";
100static const char* key_channels_rdpdr =
"DeviceRedirection";
101static const char* key_channels_video =
"VideoRedirection";
102static const char* key_channels_camera =
"CameraRedirection";
103static const char* key_channels_rails =
"RemoteApp";
104static const char* key_channels_blacklist =
"PassthroughIsBlacklist";
105static const char* key_channels_pass =
"Passthrough";
106static const char* key_channels_intercept =
"Intercept";
108static const char* section_input =
"Input";
109static const char* key_input_kbd =
"Keyboard";
110static const char* key_input_mouse =
"Mouse";
111static const char* key_input_multitouch =
"Multitouch";
113static const char* section_security =
"Security";
114static const char* key_security_server_nla =
"ServerNlaSecurity";
115static const char* key_security_server_tls =
"ServerTlsSecurity";
116static const char* key_security_server_rdp =
"ServerRdpSecurity";
117static const char* key_security_client_nla =
"ClientNlaSecurity";
118static const char* key_security_client_tls =
"ClientTlsSecurity";
119static const char* key_security_client_rdp =
"ClientRdpSecurity";
120static const char* key_security_client_fallback =
"ClientAllowFallbackToTls";
122static const char* section_certificates =
"Certificates";
123static const char* key_private_key_file =
"PrivateKeyFile";
124static const char* key_private_key_content =
"PrivateKeyContent";
125static const char* key_cert_file =
"CertificateFile";
126static const char* key_cert_content =
"CertificateContent";
128WINPR_ATTR_MALLOC(free, 1)
129static
char* pf_config_decode_base64(const
char* data, const
char* name,
size_t* pLength);
131WINPR_ATTR_MALLOC(CommandLineParserFree, 1)
133static
char** pf_config_parse_comma_separated_list(const
char* list,
size_t* count)
138 if (strlen(list) == 0)
144 return CommandLineParseCommaSeparatedValues(list, count);
148static BOOL pf_config_get_uint16(wIniFile* ini,
const char* section,
const char* key,
149 UINT16* result, BOOL required)
152 const char* strval =
nullptr;
154 WINPR_ASSERT(result);
156 strval = IniFile_GetKeyValueString(ini, section, key);
157 if (!strval && required)
159 WLog_ERR(TAG,
"key '%s.%s' does not exist.", section, key);
162 val = IniFile_GetKeyValueInt(ini, section, key);
163 if ((val <= 0) || (val > UINT16_MAX))
165 WLog_ERR(TAG,
"invalid value %d for key '%s.%s'.", val, section, key);
169 *result = (UINT16)val;
174static BOOL pf_config_get_uint32(wIniFile* ini,
const char* section,
const char* key,
175 UINT32* result, BOOL required)
177 WINPR_ASSERT(result);
179 const char* strval = IniFile_GetKeyValueString(ini, section, key);
183 WLog_ERR(TAG,
"key '%s.%s' does not exist.", section, key);
187 const int val = IniFile_GetKeyValueInt(ini, section, key);
190 WLog_ERR(TAG,
"invalid value %d for key '%s.%s'.", val, section, key);
194 *result = (UINT32)val;
199static BOOL pf_config_get_bool(wIniFile* ini,
const char* section,
const char* key, BOOL fallback)
202 const char* str_value =
nullptr;
204 str_value = IniFile_GetKeyValueString(ini, section, key);
207 WLog_WARN(TAG,
"key '%s.%s' not found, value defaults to %s.", section, key,
208 fallback ? bool_str_true : bool_str_false);
212 if (_stricmp(str_value, bool_str_true) == 0)
214 if (_stricmp(str_value, bool_str_false) == 0)
217 num_value = IniFile_GetKeyValueInt(ini, section, key);
219 return (num_value != 0);
223static const char* pf_config_get_str(wIniFile* ini,
const char* section,
const char* key,
226 const char* value = IniFile_GetKeyValueString(ini, section, key);
231 WLog_ERR(TAG,
"key '%s.%s' not found.", section, key);
238static void zfree(
char* str)
242 const size_t len = strlen(str);
247static void znfree(
char* str,
size_t len)
256static BOOL pf_config_copy_string(
char** dst,
const char* src)
266static BOOL pf_config_free_and_copy_string(
char** dst,
const char* src)
270 return pf_config_copy_string(dst, src);
274static BOOL pf_config_load_server(wIniFile* ini, proxyConfig* config)
276 WINPR_ASSERT(config);
277 const char* host = pf_config_get_str(ini, section_server, key_host, FALSE);
281 if (!pf_config_free_and_copy_string(&config->Host, host))
285 if (!pf_config_get_uint16(ini, section_server, key_port, &config->Port, TRUE))
288 const char* sam = pf_config_get_str(ini, section_server, key_sam_file, FALSE);
291 if (!pf_config_free_and_copy_string(&config->SamFile, sam))
299static BOOL pf_config_load_target(wIniFile* ini, proxyConfig* config)
301 const char* target_value =
nullptr;
303 WINPR_ASSERT(config);
304 config->FixedTarget = pf_config_get_bool(ini, section_target, key_target_fixed, FALSE);
306 if (!pf_config_get_uint16(ini, section_target, key_port, &config->TargetPort,
307 config->FixedTarget))
310 if (!pf_config_get_uint32(ini, section_target, key_target_tls_seclevel,
311 &config->TargetTlsSecLevel, FALSE))
314 if (config->FixedTarget)
316 target_value = pf_config_get_str(ini, section_target, key_host, TRUE);
320 if (!pf_config_free_and_copy_string(&config->TargetHost, target_value))
324 target_value = pf_config_get_str(ini, section_target, key_target_user, FALSE);
327 if (!pf_config_free_and_copy_string(&config->TargetUser, target_value))
331 target_value = pf_config_get_str(ini, section_target, key_target_pwd, FALSE);
334 if (!pf_config_free_and_copy_string(&config->TargetPassword, target_value))
338 target_value = pf_config_get_str(ini, section_target, key_target_domain, FALSE);
341 if (!pf_config_free_and_copy_string(&config->TargetDomain, target_value))
345 config->TargetSmartcardAuth =
346 pf_config_get_bool(ini, section_target, key_target_scard_auth, FALSE);
348 target_value = pf_config_get_str(ini, section_target, key_target_scard_cert, FALSE);
351 char* pem = crypto_read_pem(target_value,
nullptr);
354 free(config->TargetSmartcardCert);
355 config->TargetSmartcardCert = pem;
359 const char* pem_value =
360 pf_config_get_str(ini, section_target, key_target_scard_pem_cert, FALSE);
364 WLog_WARN(TAG,
"In section [%s] both, '%s' and '%s' are provided. Ignoring %s",
365 section_target, key_target_scard_cert, key_target_scard_pem_cert,
366 key_target_scard_cert);
367 free(config->TargetSmartcardCert);
369 config->TargetSmartcardCert =
370 pf_config_decode_base64(pem_value, key_target_scard_pem_cert, &len);
371 if (!config->TargetSmartcardCert)
376 target_value = pf_config_get_str(ini, section_target, key_target_scard_key, FALSE);
379 char* pem = crypto_read_pem(target_value,
nullptr);
380 free(config->TargetSmartcardKey);
381 config->TargetSmartcardKey = pem;
385 const char* pem_value =
386 pf_config_get_str(ini, section_target, key_target_scard_pem_key, FALSE);
390 WLog_WARN(TAG,
"In section [%s] both, '%s' and '%s' are provided. Ignoring %s",
391 section_target, key_target_scard_key, key_target_scard_pem_key,
392 key_target_scard_key);
393 free(config->TargetSmartcardKey);
396 config->TargetSmartcardKey =
397 pf_config_decode_base64(pem_value, key_target_scard_pem_key, &len);
398 if (!config->TargetSmartcardKey)
407static BOOL pf_config_load_codecs(wIniFile* ini, proxyConfig* config)
409 WINPR_ASSERT(config);
410 config->RFX = pf_config_get_bool(ini, section_codecs, key_codecs_rfx, TRUE);
411 config->NSC = pf_config_get_bool(ini, section_codecs, key_codecs_nsc, TRUE);
416static BOOL pf_config_load_channels(wIniFile* ini, proxyConfig* config)
418 WINPR_ASSERT(config);
419 config->GFX = pf_config_get_bool(ini, section_channels, key_channels_gfx, TRUE);
420 config->DisplayControl = pf_config_get_bool(ini, section_channels, key_channels_disp, TRUE);
421 config->Clipboard = pf_config_get_bool(ini, section_channels, key_channels_clip, FALSE);
422 config->AudioOutput = pf_config_get_bool(ini, section_channels, key_channels_mic, TRUE);
423 config->AudioInput = pf_config_get_bool(ini, section_channels, key_channels_sound, TRUE);
424 config->DeviceRedirection = pf_config_get_bool(ini, section_channels, key_channels_rdpdr, TRUE);
425 config->VideoRedirection = pf_config_get_bool(ini, section_channels, key_channels_video, TRUE);
426 config->CameraRedirection =
427 pf_config_get_bool(ini, section_channels, key_channels_camera, TRUE);
428 config->RemoteApp = pf_config_get_bool(ini, section_channels, key_channels_rails, FALSE);
429 config->PassthroughIsBlacklist =
430 pf_config_get_bool(ini, section_channels, key_channels_blacklist, FALSE);
431 config->Passthrough = pf_config_parse_comma_separated_list(
432 pf_config_get_str(ini, section_channels, key_channels_pass, FALSE),
433 &config->PassthroughCount);
434 config->Intercept = pf_config_parse_comma_separated_list(
435 pf_config_get_str(ini, section_channels, key_channels_intercept, FALSE),
436 &config->InterceptCount);
442static BOOL pf_config_load_input(wIniFile* ini, proxyConfig* config)
444 WINPR_ASSERT(config);
445 config->Keyboard = pf_config_get_bool(ini, section_input, key_input_kbd, TRUE);
446 config->Mouse = pf_config_get_bool(ini, section_input, key_input_mouse, TRUE);
447 config->Multitouch = pf_config_get_bool(ini, section_input, key_input_multitouch, TRUE);
452static BOOL pf_config_load_security(wIniFile* ini, proxyConfig* config)
454 WINPR_ASSERT(config);
455 config->ServerTlsSecurity =
456 pf_config_get_bool(ini, section_security, key_security_server_tls, TRUE);
457 config->ServerNlaSecurity =
458 pf_config_get_bool(ini, section_security, key_security_server_nla, FALSE);
459 config->ServerRdpSecurity =
460 pf_config_get_bool(ini, section_security, key_security_server_rdp, TRUE);
462 config->ClientTlsSecurity =
463 pf_config_get_bool(ini, section_security, key_security_client_tls, TRUE);
464 config->ClientNlaSecurity =
465 pf_config_get_bool(ini, section_security, key_security_client_nla, TRUE);
466 config->ClientRdpSecurity =
467 pf_config_get_bool(ini, section_security, key_security_client_rdp, TRUE);
468 config->ClientAllowFallbackToTls =
469 pf_config_get_bool(ini, section_security, key_security_client_fallback, TRUE);
474static BOOL pf_config_load_modules(wIniFile* ini, proxyConfig* config)
476 const char* modules_to_load =
nullptr;
477 const char* required_modules =
nullptr;
479 modules_to_load = pf_config_get_str(ini, section_plugins, key_plugins_modules, FALSE);
480 required_modules = pf_config_get_str(ini, section_plugins, key_plugins_required, FALSE);
482 WINPR_ASSERT(config);
483 config->Modules = pf_config_parse_comma_separated_list(modules_to_load, &config->ModulesCount);
485 config->RequiredPlugins =
486 pf_config_parse_comma_separated_list(required_modules, &config->RequiredPluginsCount);
490char* pf_config_decode_base64(
const char* data,
const char* name,
size_t* pLength)
492 const char* headers[] = {
"-----BEGIN PUBLIC KEY-----",
"-----BEGIN RSA PUBLIC KEY-----",
493 "-----BEGIN CERTIFICATE-----",
"-----BEGIN PRIVATE KEY-----",
494 "-----BEGIN RSA PRIVATE KEY-----" };
496 size_t decoded_length = 0;
497 char* decoded =
nullptr;
500 WLog_ERR(TAG,
"Invalid base64 data [nullptr] for %s", name);
505 WINPR_ASSERT(pLength);
507 const size_t length = strlen(data);
509 if (strncmp(data,
"-----", 5) == 0)
511 BOOL expected = FALSE;
512 for (
size_t x = 0; x < ARRAYSIZE(headers); x++)
514 const char* header = headers[x];
516 if (strncmp(data, header, strlen(header)) == 0)
525 char hdr[128] = WINPR_C_ARRAY_INIT;
526 const char* end = strchr(&data[5],
'-');
532 const size_t s = MIN(ARRAYSIZE(hdr) - 1ULL, (
size_t)(end - data));
533 memcpy(hdr, data, s);
536 WLog_WARN(TAG,
"PEM has unexpected header '%s'. Known supported headers are:", hdr);
537 for (
size_t x = 0; x < ARRAYSIZE(headers); x++)
539 const char* header = headers[x];
540 WLog_WARN(TAG,
"%s", header);
544 *pLength = length + 1;
545 return _strdup(data);
548 crypto_base64_decode(data, length, (BYTE**)&decoded, &decoded_length);
549 if (!decoded || decoded_length == 0)
551 WLog_ERR(TAG,
"Failed to decode base64 data of length %" PRIuz
" for %s", length, name);
556 *pLength = strnlen(decoded, decoded_length) + 1;
561static BOOL pf_config_load_certificates(wIniFile* ini, proxyConfig* config)
563 const char* tmp1 =
nullptr;
564 const char* tmp2 =
nullptr;
567 WINPR_ASSERT(config);
569 tmp1 = pf_config_get_str(ini, section_certificates, key_cert_file, FALSE);
572 if (!winpr_PathFileExists(tmp1))
574 WLog_ERR(TAG,
"%s/%s file %s does not exist", section_certificates, key_cert_file,
578 config->CertificateFile = _strdup(tmp1);
579 config->CertificatePEM =
580 crypto_read_pem(config->CertificateFile, &config->CertificatePEMLength);
581 if (!config->CertificatePEM)
583 config->CertificatePEMLength += 1;
585 tmp2 = pf_config_get_str(ini, section_certificates, key_cert_content, FALSE);
588 if (strlen(tmp2) < 1)
590 WLog_ERR(TAG,
"%s/%s has invalid empty value", section_certificates, key_cert_content);
593 config->CertificateContent = _strdup(tmp2);
594 config->CertificatePEM = pf_config_decode_base64(
595 config->CertificateContent,
"CertificateContent", &config->CertificatePEMLength);
596 if (!config->CertificatePEM)
602 "%s/%s and %s/%s are "
603 "mutually exclusive options",
604 section_certificates, key_cert_file, section_certificates, key_cert_content);
607 else if (!tmp1 && !tmp2)
610 "%s/%s or %s/%s are "
612 section_certificates, key_cert_file, section_certificates, key_cert_content);
616 tmp1 = pf_config_get_str(ini, section_certificates, key_private_key_file, FALSE);
619 if (!winpr_PathFileExists(tmp1))
621 WLog_ERR(TAG,
"%s/%s file %s does not exist", section_certificates,
622 key_private_key_file, tmp1);
625 config->PrivateKeyFile = _strdup(tmp1);
626 config->PrivateKeyPEM =
627 crypto_read_pem(config->PrivateKeyFile, &config->PrivateKeyPEMLength);
628 if (!config->PrivateKeyPEM)
630 config->PrivateKeyPEMLength += 1;
632 tmp2 = pf_config_get_str(ini, section_certificates, key_private_key_content, FALSE);
635 if (strlen(tmp2) < 1)
637 WLog_ERR(TAG,
"%s/%s has invalid empty value", section_certificates,
638 key_private_key_content);
641 config->PrivateKeyContent = _strdup(tmp2);
642 config->PrivateKeyPEM = pf_config_decode_base64(
643 config->PrivateKeyContent,
"PrivateKeyContent", &config->PrivateKeyPEMLength);
644 if (!config->PrivateKeyPEM)
651 "%s/%s and %s/%s are "
652 "mutually exclusive options",
653 section_certificates, key_private_key_file, section_certificates,
654 key_private_key_content);
657 else if (!tmp1 && !tmp2)
660 "%s/%s or %s/%s are "
661 "are required settings",
662 section_certificates, key_private_key_file, section_certificates,
663 key_private_key_content);
672 proxyConfig* config =
nullptr;
676 config = calloc(1,
sizeof(proxyConfig));
680 config->TargetTlsSecLevel = 1;
683 if (!pf_config_load_server(ini, config))
686 if (!pf_config_load_target(ini, config))
689 if (!pf_config_load_codecs(ini, config))
692 if (!pf_config_load_channels(ini, config))
695 if (!pf_config_load_input(ini, config))
698 if (!pf_config_load_security(ini, config))
701 if (!pf_config_load_modules(ini, config))
704 if (!pf_config_load_certificates(ini, config))
706 config->ini = IniFile_Clone(ini);
712 WINPR_PRAGMA_DIAG_PUSH
713 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
715 WINPR_PRAGMA_DIAG_POP
723 wIniFile* ini = IniFile_New();
728 if (IniFile_SetKeyValueString(ini, section_server, key_host,
"0.0.0.0") < 0)
730 if (IniFile_SetKeyValueInt(ini, section_server, key_port, 3389) < 0)
732 if (IniFile_SetKeyValueString(ini, section_server, key_sam_file,
733 "optional/path/some/file.sam") < 0)
737 if (IniFile_SetKeyValueString(ini, section_target, key_host,
"somehost.example.com") < 0)
739 if (IniFile_SetKeyValueInt(ini, section_target, key_port, 3389) < 0)
741 if (IniFile_SetKeyValueString(ini, section_target, key_target_fixed, bool_str_true) < 0)
743 if (IniFile_SetKeyValueInt(ini, section_target, key_target_tls_seclevel, 1) < 0)
745 if (IniFile_SetKeyValueString(ini, section_target, key_target_user,
"optionaltargetuser") < 0)
747 if (IniFile_SetKeyValueString(ini, section_target, key_target_domain,
"optionaltargetdomain") <
750 if (IniFile_SetKeyValueString(ini, section_target, key_target_pwd,
"optionaltargetpassword") <
753 if (IniFile_SetKeyValueString(ini, section_target, key_target_scard_auth, bool_str_false) < 0)
755 if (IniFile_SetKeyValueString(ini, section_target, key_target_scard_cert,
756 "optional/path/some/file.pem.crt") < 0)
758 if (IniFile_SetKeyValueString(ini, section_target, key_target_scard_pem_cert,
759 "<base64 encoded PEM>") < 0)
761 if (IniFile_SetKeyValueString(ini, section_target, key_target_scard_key,
762 "optional/path/some/file.pem.key") < 0)
765 if (IniFile_SetKeyValueString(ini, section_target, key_target_scard_pem_key,
766 "<base64 encoded PEM>") < 0)
769 if (IniFile_SetKeyValueString(ini, section_codecs, key_codecs_rfx, bool_str_true) < 0)
771 if (IniFile_SetKeyValueString(ini, section_codecs, key_codecs_nsc, bool_str_true) < 0)
775 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_gfx, bool_str_true) < 0)
777 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_disp, bool_str_true) < 0)
779 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_clip, bool_str_true) < 0)
781 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_mic, bool_str_true) < 0)
783 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_sound, bool_str_true) < 0)
785 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_rdpdr, bool_str_true) < 0)
787 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_video, bool_str_true) < 0)
789 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_camera, bool_str_true) < 0)
791 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_rails, bool_str_false) < 0)
794 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_blacklist, bool_str_true) < 0)
796 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_pass,
"") < 0)
798 if (IniFile_SetKeyValueString(ini, section_channels, key_channels_intercept,
"") < 0)
802 if (IniFile_SetKeyValueString(ini, section_input, key_input_kbd, bool_str_true) < 0)
804 if (IniFile_SetKeyValueString(ini, section_input, key_input_mouse, bool_str_true) < 0)
806 if (IniFile_SetKeyValueString(ini, section_input, key_input_multitouch, bool_str_true) < 0)
810 if (IniFile_SetKeyValueString(ini, section_security, key_security_server_tls, bool_str_true) <
813 if (IniFile_SetKeyValueString(ini, section_security, key_security_server_nla, bool_str_false) <
816 if (IniFile_SetKeyValueString(ini, section_security, key_security_server_rdp, bool_str_true) <
820 if (IniFile_SetKeyValueString(ini, section_security, key_security_client_tls, bool_str_true) <
823 if (IniFile_SetKeyValueString(ini, section_security, key_security_client_nla, bool_str_true) <
826 if (IniFile_SetKeyValueString(ini, section_security, key_security_client_rdp, bool_str_true) <
829 if (IniFile_SetKeyValueString(ini, section_security, key_security_client_fallback,
834 if (IniFile_SetKeyValueString(ini, section_plugins, key_plugins_modules,
835 "module1,module2,...") < 0)
837 if (IniFile_SetKeyValueString(ini, section_plugins, key_plugins_required,
838 "module1,module2,...") < 0)
842 if (IniFile_SetKeyValueString(ini, section_certificates, key_cert_file,
843 "<absolute path to some certificate file> OR") < 0)
845 if (IniFile_SetKeyValueString(ini, section_certificates, key_cert_content,
846 "<base64 encoded PEM>") < 0)
849 if (IniFile_SetKeyValueString(ini, section_certificates, key_private_key_file,
850 "<absolute path to some private key file> OR") < 0)
852 if (IniFile_SetKeyValueString(ini, section_certificates, key_private_key_content,
853 "<base64 encoded PEM>") < 0)
856 if ((strcmp(
"stdout", file) == 0) || (strcmp(
"stderr", file) == 0))
858 char* buffer = IniFile_WriteBuffer(ini);
862 if (strcmp(
"stdout", file) == 0)
864 (void)fprintf(fp,
"%s", buffer);
870 if (IniFile_WriteFile(ini, file) < 0)
883 proxyConfig* config =
nullptr;
884 wIniFile* ini =
nullptr;
890 WLog_ERR(TAG,
"IniFile_New() failed!");
894 if (IniFile_ReadBuffer(ini, buffer) < 0)
896 WLog_ERR(TAG,
"failed to parse ini: '%s'", buffer);
908 proxyConfig* config =
nullptr;
909 wIniFile* ini = IniFile_New();
913 WLog_ERR(TAG,
"IniFile_New() failed!");
917 if (IniFile_ReadFile(ini, path) < 0)
919 WLog_ERR(TAG,
"failed to parse ini file: '%s'", path);
929static void pf_server_config_print_list(
char** list,
size_t count)
932 for (
size_t i = 0; i < count; i++)
933 WLog_INFO(TAG,
"\t\t- %s", list[i]);
938 WINPR_ASSERT(config);
939 WLog_INFO(TAG,
"Proxy configuration:");
941 CONFIG_PRINT_SECTION(section_server);
942 CONFIG_PRINT_STR(config, Host);
943 CONFIG_PRINT_STR(config, SamFile);
944 CONFIG_PRINT_UINT16(config, Port);
946 if (config->FixedTarget)
948 CONFIG_PRINT_SECTION(section_target);
949 CONFIG_PRINT_STR(config, TargetHost);
950 CONFIG_PRINT_UINT16(config, TargetPort);
951 CONFIG_PRINT_UINT32(config, TargetTlsSecLevel);
953 CONFIG_PRINT_STR(config, TargetUser);
954 CONFIG_PRINT_STR(config, TargetDomain);
955 CONFIG_PRINT_SECRET_STR(config, TargetPassword);
957 CONFIG_PRINT_BOOL(config, TargetSmartcardAuth);
958 CONFIG_PRINT_SECRET_STR(config, TargetSmartcardCert);
959 CONFIG_PRINT_SECRET_STR(config, TargetSmartcardKey);
962 CONFIG_PRINT_SECTION(section_input);
963 CONFIG_PRINT_BOOL(config, Keyboard);
964 CONFIG_PRINT_BOOL(config, Mouse);
965 CONFIG_PRINT_BOOL(config, Multitouch);
967 CONFIG_PRINT_SECTION(section_security);
968 CONFIG_PRINT_BOOL(config, ServerNlaSecurity);
969 CONFIG_PRINT_BOOL(config, ServerTlsSecurity);
970 CONFIG_PRINT_BOOL(config, ServerRdpSecurity);
971 CONFIG_PRINT_BOOL(config, ClientNlaSecurity);
972 CONFIG_PRINT_BOOL(config, ClientTlsSecurity);
973 CONFIG_PRINT_BOOL(config, ClientRdpSecurity);
974 CONFIG_PRINT_BOOL(config, ClientAllowFallbackToTls);
976 CONFIG_PRINT_SECTION(section_codecs);
977 CONFIG_PRINT_BOOL(config, RFX);
978 CONFIG_PRINT_BOOL(config, NSC);
980 CONFIG_PRINT_SECTION(section_channels);
981 CONFIG_PRINT_BOOL(config, GFX);
982 CONFIG_PRINT_BOOL(config, DisplayControl);
983 CONFIG_PRINT_BOOL(config, Clipboard);
984 CONFIG_PRINT_BOOL(config, AudioOutput);
985 CONFIG_PRINT_BOOL(config, AudioInput);
986 CONFIG_PRINT_BOOL(config, DeviceRedirection);
987 CONFIG_PRINT_BOOL(config, VideoRedirection);
988 CONFIG_PRINT_BOOL(config, CameraRedirection);
989 CONFIG_PRINT_BOOL(config, RemoteApp);
990 CONFIG_PRINT_BOOL(config, PassthroughIsBlacklist);
992 if (config->PassthroughCount)
994 WLog_INFO(TAG,
"\tStatic Channels Proxy:");
995 pf_server_config_print_list(config->Passthrough, config->PassthroughCount);
998 if (config->InterceptCount)
1000 WLog_INFO(TAG,
"\tStatic Channels Proxy-Intercept:");
1001 pf_server_config_print_list(config->Intercept, config->InterceptCount);
1005 CONFIG_PRINT_SECTION_KEY(section_plugins, key_plugins_modules);
1006 for (
size_t x = 0; x < config->ModulesCount; x++)
1007 CONFIG_PRINT_STR(config, Modules[x]);
1010 CONFIG_PRINT_SECTION_KEY(section_plugins, key_plugins_required);
1011 for (
size_t x = 0; x < config->RequiredPluginsCount; x++)
1012 CONFIG_PRINT_STR(config, RequiredPlugins[x]);
1014 CONFIG_PRINT_SECTION(section_certificates);
1015 CONFIG_PRINT_STR(config, CertificateFile);
1016 CONFIG_PRINT_SECRET_STR(config, CertificateContent);
1017 CONFIG_PRINT_STR(config, PrivateKeyFile);
1018 CONFIG_PRINT_SECRET_STR(config, PrivateKeyContent);
1023 if (config ==
nullptr)
1026 zfree(config->Host);
1027 zfree(config->SamFile);
1028 zfree(config->TargetHost);
1029 zfree(config->TargetUser);
1030 zfree(config->TargetDomain);
1031 zfree(config->TargetPassword);
1032 zfree(config->TargetSmartcardCert);
1033 zfree(config->TargetSmartcardKey);
1035 CommandLineParserFree(config->Passthrough);
1036 CommandLineParserFree(config->Intercept);
1037 CommandLineParserFree(config->Modules);
1038 CommandLineParserFree(config->RequiredPlugins);
1040 zfree(config->CertificateFile);
1041 zfree(config->CertificateContent);
1042 znfree(config->CertificatePEM, config->CertificatePEMLength);
1043 zfree(config->PrivateKeyFile);
1044 zfree(config->PrivateKeyContent);
1045 znfree(config->PrivateKeyPEM, config->PrivateKeyPEMLength);
1046 IniFile_Free(config->ini);
1052 WINPR_ASSERT(config);
1053 return config->RequiredPluginsCount;
1058 WINPR_ASSERT(config);
1059 if (index >= config->RequiredPluginsCount)
1062 return config->RequiredPlugins[index];
1067 WINPR_ASSERT(config);
1068 return config->ModulesCount;
1079 WINPR_ASSERT(config);
1081 cnv.ppc = config->Modules;
1086static BOOL pf_config_copy_string_n(
char** dst,
const char* src,
size_t size)
1090 if (src && (size > 0))
1092 WINPR_ASSERT(strnlen(src, size) == size - 1);
1093 *dst = calloc(size,
sizeof(
char));
1096 memcpy(*dst, src, size);
1103static BOOL pf_config_copy_string_list(
char*** dst,
size_t* size,
char** src,
size_t srcSize)
1107 WINPR_ASSERT(src || (srcSize == 0));
1111 if (srcSize > INT32_MAX)
1116 char* csv = CommandLineToCommaSeparatedValues((INT32)srcSize, src);
1117 *dst = CommandLineParseCommaSeparatedValues(csv, size);
1126 proxyConfig* tmp = calloc(1,
sizeof(proxyConfig));
1129 WINPR_ASSERT(config);
1136 if (!pf_config_copy_string(&tmp->Host, config->Host))
1138 if (!pf_config_copy_string(&tmp->SamFile, config->SamFile))
1140 if (!pf_config_copy_string(&tmp->TargetHost, config->TargetHost))
1142 if (!pf_config_copy_string(&tmp->TargetUser, config->TargetUser))
1144 if (!pf_config_copy_string(&tmp->TargetDomain, config->TargetDomain))
1146 if (!pf_config_copy_string(&tmp->TargetPassword, config->TargetPassword))
1148 if (!pf_config_copy_string(&tmp->TargetSmartcardCert, config->TargetSmartcardCert))
1150 if (!pf_config_copy_string(&tmp->TargetSmartcardKey, config->TargetSmartcardKey))
1152 if (!pf_config_copy_string_list(&tmp->Passthrough, &tmp->PassthroughCount, config->Passthrough,
1153 config->PassthroughCount))
1155 if (!pf_config_copy_string_list(&tmp->Intercept, &tmp->InterceptCount, config->Intercept,
1156 config->InterceptCount))
1158 if (!pf_config_copy_string_list(&tmp->Modules, &tmp->ModulesCount, config->Modules,
1159 config->ModulesCount))
1161 if (!pf_config_copy_string_list(&tmp->RequiredPlugins, &tmp->RequiredPluginsCount,
1162 config->RequiredPlugins, config->RequiredPluginsCount))
1164 if (!pf_config_copy_string(&tmp->CertificateFile, config->CertificateFile))
1166 if (!pf_config_copy_string(&tmp->CertificateContent, config->CertificateContent))
1168 if (!pf_config_copy_string_n(&tmp->CertificatePEM, config->CertificatePEM,
1169 config->CertificatePEMLength))
1171 if (!pf_config_copy_string(&tmp->PrivateKeyFile, config->PrivateKeyFile))
1173 if (!pf_config_copy_string(&tmp->PrivateKeyContent, config->PrivateKeyContent))
1175 if (!pf_config_copy_string_n(&tmp->PrivateKeyPEM, config->PrivateKeyPEM,
1176 config->PrivateKeyPEMLength))
1179 tmp->ini = IniFile_Clone(config->ini);
1187 WINPR_PRAGMA_DIAG_PUSH
1188 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
1190 WINPR_PRAGMA_DIAG_POP
1194struct config_plugin_data
1196 proxyPluginsManager* mgr;
1197 const proxyConfig* config;
1200static const char config_plugin_name[] =
"config";
1201static const char config_plugin_desc[] =
1202 "A plugin filtering according to proxy configuration file rules";
1205static BOOL config_plugin_unload(proxyPlugin* plugin)
1207 WINPR_ASSERT(plugin);
1212 free(plugin->custom);
1213 plugin->custom =
nullptr;
1220static BOOL config_plugin_keyboard_event(proxyPlugin* plugin, WINPR_ATTR_UNUSED proxyData* pdata,
1224 const struct config_plugin_data* custom =
nullptr;
1225 const proxyConfig* cfg =
nullptr;
1228 WINPR_ASSERT(plugin);
1229 WINPR_ASSERT(pdata);
1230 WINPR_ASSERT(event_data);
1232 WINPR_UNUSED(event_data);
1234 custom = plugin->custom;
1235 WINPR_ASSERT(custom);
1237 cfg = custom->config;
1241 WLog_DBG(TAG,
"%s", boolstr(rc));
1246static BOOL config_plugin_unicode_event(proxyPlugin* plugin, WINPR_ATTR_UNUSED proxyData* pdata,
1250 const struct config_plugin_data* custom =
nullptr;
1251 const proxyConfig* cfg =
nullptr;
1254 WINPR_ASSERT(plugin);
1255 WINPR_ASSERT(pdata);
1256 WINPR_ASSERT(event_data);
1258 WINPR_UNUSED(event_data);
1260 custom = plugin->custom;
1261 WINPR_ASSERT(custom);
1263 cfg = custom->config;
1267 WLog_DBG(TAG,
"%s", boolstr(rc));
1272static BOOL config_plugin_mouse_event(proxyPlugin* plugin, WINPR_ATTR_UNUSED proxyData* pdata,
1276 const struct config_plugin_data* custom =
nullptr;
1277 const proxyConfig* cfg =
nullptr;
1280 WINPR_ASSERT(plugin);
1281 WINPR_ASSERT(pdata);
1282 WINPR_ASSERT(event_data);
1284 WINPR_UNUSED(event_data);
1286 custom = plugin->custom;
1287 WINPR_ASSERT(custom);
1289 cfg = custom->config;
1297static BOOL config_plugin_mouse_ex_event(proxyPlugin* plugin, WINPR_ATTR_UNUSED proxyData* pdata,
1301 const struct config_plugin_data* custom =
nullptr;
1302 const proxyConfig* cfg =
nullptr;
1305 WINPR_ASSERT(plugin);
1306 WINPR_ASSERT(pdata);
1307 WINPR_ASSERT(event_data);
1309 WINPR_UNUSED(event_data);
1311 custom = plugin->custom;
1312 WINPR_ASSERT(custom);
1314 cfg = custom->config;
1322static BOOL config_plugin_client_channel_data(WINPR_ATTR_UNUSED proxyPlugin* plugin,
1323 WINPR_ATTR_UNUSED proxyData* pdata,
void* param)
1327 WINPR_ASSERT(plugin);
1328 WINPR_ASSERT(pdata);
1329 WINPR_ASSERT(channel);
1331 WLog_DBG(TAG,
"%s [0x%04" PRIx16
"] got %" PRIuz, channel->channel_name, channel->channel_id,
1337static BOOL config_plugin_server_channel_data(WINPR_ATTR_UNUSED proxyPlugin* plugin,
1338 WINPR_ATTR_UNUSED proxyData* pdata,
void* param)
1342 WINPR_ASSERT(plugin);
1343 WINPR_ASSERT(pdata);
1344 WINPR_ASSERT(channel);
1346 WLog_DBG(TAG,
"%s [0x%04" PRIx16
"] got %" PRIuz, channel->channel_name, channel->channel_id,
1352static BOOL config_plugin_dynamic_channel_create(proxyPlugin* plugin,
1353 WINPR_ATTR_UNUSED proxyData* pdata,
void* param)
1358 WINPR_ASSERT(plugin);
1359 WINPR_ASSERT(pdata);
1360 WINPR_ASSERT(channel);
1362 const struct config_plugin_data* custom = plugin->custom;
1363 WINPR_ASSERT(custom);
1365 const proxyConfig* cfg = custom->config;
1368 pf_utils_channel_mode rc = pf_utils_get_channel_mode(cfg, channel->channel_name);
1372 case PF_UTILS_CHANNEL_INTERCEPT:
1373 case PF_UTILS_CHANNEL_PASSTHROUGH:
1376 case PF_UTILS_CHANNEL_BLOCK:
1384 if (strncmp(RDPGFX_DVC_CHANNEL_NAME, channel->channel_name,
1385 sizeof(RDPGFX_DVC_CHANNEL_NAME)) == 0)
1387 else if (strncmp(RDPSND_DVC_CHANNEL_NAME, channel->channel_name,
1388 sizeof(RDPSND_DVC_CHANNEL_NAME)) == 0)
1389 accept = cfg->AudioOutput;
1390 else if (strncmp(RDPSND_LOSSY_DVC_CHANNEL_NAME, channel->channel_name,
1391 sizeof(RDPSND_LOSSY_DVC_CHANNEL_NAME)) == 0)
1392 accept = cfg->AudioOutput;
1393 else if (strncmp(AUDIN_DVC_CHANNEL_NAME, channel->channel_name,
1394 sizeof(AUDIN_DVC_CHANNEL_NAME)) == 0)
1395 accept = cfg->AudioInput;
1396 else if (strncmp(RDPEI_DVC_CHANNEL_NAME, channel->channel_name,
1397 sizeof(RDPEI_DVC_CHANNEL_NAME)) == 0)
1398 accept = cfg->Multitouch;
1399 else if (strncmp(TSMF_DVC_CHANNEL_NAME, channel->channel_name,
1400 sizeof(TSMF_DVC_CHANNEL_NAME)) == 0)
1401 accept = cfg->VideoRedirection;
1402 else if (strncmp(VIDEO_CONTROL_DVC_CHANNEL_NAME, channel->channel_name,
1403 sizeof(VIDEO_CONTROL_DVC_CHANNEL_NAME)) == 0)
1404 accept = cfg->VideoRedirection;
1405 else if (strncmp(VIDEO_DATA_DVC_CHANNEL_NAME, channel->channel_name,
1406 sizeof(VIDEO_DATA_DVC_CHANNEL_NAME)) == 0)
1407 accept = cfg->VideoRedirection;
1408 else if (strncmp(RDPECAM_DVC_CHANNEL_NAME, channel->channel_name,
1409 sizeof(RDPECAM_DVC_CHANNEL_NAME)) == 0)
1410 accept = cfg->CameraRedirection;
1413 WLog_DBG(TAG,
"%s [0x%04" PRIx16
"]: %s", channel->channel_name, channel->channel_id,
1419static BOOL config_plugin_channel_create(proxyPlugin* plugin, WINPR_ATTR_UNUSED proxyData* pdata,
1425 WINPR_ASSERT(plugin);
1426 WINPR_ASSERT(pdata);
1427 WINPR_ASSERT(channel);
1429 const struct config_plugin_data* custom = plugin->custom;
1430 WINPR_ASSERT(custom);
1432 const proxyConfig* cfg = custom->config;
1435 pf_utils_channel_mode rc = pf_utils_get_channel_mode(cfg, channel->channel_name);
1438 case PF_UTILS_CHANNEL_INTERCEPT:
1439 case PF_UTILS_CHANNEL_PASSTHROUGH:
1442 case PF_UTILS_CHANNEL_BLOCK:
1449 if (strncmp(CLIPRDR_SVC_CHANNEL_NAME, channel->channel_name,
1450 sizeof(CLIPRDR_SVC_CHANNEL_NAME)) == 0)
1451 accept = cfg->Clipboard;
1452 else if (strncmp(RDPSND_CHANNEL_NAME, channel->channel_name,
sizeof(RDPSND_CHANNEL_NAME)) ==
1454 accept = cfg->AudioOutput;
1455 else if (strncmp(RDPDR_SVC_CHANNEL_NAME, channel->channel_name,
1456 sizeof(RDPDR_SVC_CHANNEL_NAME)) == 0)
1457 accept = cfg->DeviceRedirection;
1458 else if (strncmp(DISP_DVC_CHANNEL_NAME, channel->channel_name,
1459 sizeof(DISP_DVC_CHANNEL_NAME)) == 0)
1460 accept = cfg->DisplayControl;
1461 else if (strncmp(RAIL_SVC_CHANNEL_NAME, channel->channel_name,
1462 sizeof(RAIL_SVC_CHANNEL_NAME)) == 0)
1463 accept = cfg->RemoteApp;
1466 WLog_DBG(TAG,
"%s [static]: %s", channel->channel_name, boolstr(accept));
1472 struct config_plugin_data* custom =
nullptr;
1473 proxyPlugin plugin = WINPR_C_ARRAY_INIT;
1475 plugin.name = config_plugin_name;
1476 plugin.description = config_plugin_desc;
1477 plugin.PluginUnload = config_plugin_unload;
1479 plugin.KeyboardEvent = config_plugin_keyboard_event;
1480 plugin.UnicodeEvent = config_plugin_unicode_event;
1481 plugin.MouseEvent = config_plugin_mouse_event;
1482 plugin.MouseExEvent = config_plugin_mouse_ex_event;
1483 plugin.ClientChannelData = config_plugin_client_channel_data;
1484 plugin.ServerChannelData = config_plugin_server_channel_data;
1485 plugin.ChannelCreate = config_plugin_channel_create;
1486 plugin.DynamicChannelCreate = config_plugin_dynamic_channel_create;
1487 plugin.userdata = userdata;
1489 custom = calloc(1,
sizeof(
struct config_plugin_data));
1493 custom->mgr = plugins_manager;
1494 custom->config = userdata;
1496 plugin.custom = custom;
1497 plugin.userdata = userdata;
1499 return plugins_manager->RegisterPlugin(plugins_manager, &plugin);
1502const char*
pf_config_get(
const proxyConfig* config,
const char* section,
const char* key)
1504 WINPR_ASSERT(config);
1505 WINPR_ASSERT(config->ini);
1506 WINPR_ASSERT(section);
1509 return IniFile_GetKeyValueString(config->ini, section, key);
void pf_server_config_free(proxyConfig *config)
pf_server_config_free Releases all resources associated with proxyConfig
proxyConfig * pf_server_config_load_file(const char *path)
pf_server_config_load_file Create a proxyConfig from a INI file found at path.
void pf_server_config_print(const proxyConfig *config)
pf_server_config_print Print the configuration to stdout
const char ** pf_config_modules(const proxyConfig *config)
pf_config_modules
const char * pf_config_required_plugin(const proxyConfig *config, size_t index)
pf_config_required_plugin
proxyConfig * pf_server_config_load_buffer(const char *buffer)
pf_server_config_load_buffer Create a proxyConfig from a memory string buffer in INI file format
size_t pf_config_modules_count(const proxyConfig *config)
pf_config_modules_count
BOOL pf_config_clone(proxyConfig **dst, const proxyConfig *config)
pf_config_clone Create a copy of the configuration
proxyConfig * server_config_load_ini(wIniFile *ini)
server_config_load_ini Create a proxyConfig from a already loaded INI file.
size_t pf_config_required_plugins_count(const proxyConfig *config)
pf_config_required_plugins_count
BOOL pf_server_config_dump(const char *file)
pf_server_config_dump Dumps a default INI configuration file
BOOL pf_config_plugin(proxyPluginsManager *plugins_manager, void *userdata)
pf_config_plugin Register a proxy plugin handling event filtering defined in the configuration.
const char * pf_config_get(const proxyConfig *config, const char *section, const char *key)
pf_config_get get a value for a section/key