FreeRDP
Loading...
Searching...
No Matches
core/settings.c
1
22#include <freerdp/config.h>
23
24#include "settings.h"
25
26#include <freerdp/crypto/certificate.h>
27
28#include <ctype.h>
29
30#include <winpr/crt.h>
31#include <winpr/file.h>
32#include <winpr/path.h>
33#include <winpr/sysinfo.h>
34#include <winpr/registry.h>
35#include <winpr/wtsapi.h>
36#include <winpr/input.h>
37
38#include <freerdp/version.h>
39#include <freerdp/settings.h>
40#include <freerdp/utils/string.h>
41#include <freerdp/utils/helpers.h>
42#include <freerdp/build-config.h>
43
44#include "../core/utils.h"
45#include "../crypto/certificate.h"
46#include "../crypto/privatekey.h"
47#include "capabilities.h"
48
49#define TAG FREERDP_TAG("settings")
50
51#ifdef _MSC_VER
52#pragma warning(push)
53#pragma warning(disable : 4244)
54#endif
55
56static const char client_dll[] = "C:\\Windows\\System32\\mstscax.dll";
57
58#define SERVER_KEY "Software\\%s\\Server"
59#define CLIENT_KEY "Software\\%s\\Client"
60#define BITMAP_CACHE_KEY CLIENT_KEY "\\BitmapCacheV2"
61#define GLYPH_CACHE_KEY CLIENT_KEY "\\GlyphCache"
62#define POINTER_CACHE_KEY CLIENT_KEY "\\PointerCache"
63
64struct bounds_t
65{
66 INT32 x;
67 INT32 y;
68 INT32 width;
69 INT32 height;
70};
71
72static const char* bounds2str(const struct bounds_t* bounds, char* buffer, size_t len)
73{
74 WINPR_ASSERT(bounds);
75 (void)_snprintf(buffer, len, "{%dx%d-%dx%d}", bounds->x, bounds->y, bounds->x + bounds->width,
76 bounds->y + bounds->height);
77 return buffer;
78}
79
80static struct bounds_t union_rect(const struct bounds_t* a, const struct bounds_t* b)
81{
82 WINPR_ASSERT(a);
83 WINPR_ASSERT(b);
84
85 struct bounds_t u = *a;
86 if (b->x < u.x)
87 u.x = b->x;
88 if (b->y < u.y)
89 u.y = b->y;
90
91 const INT32 rightA = a->x + a->width;
92 const INT32 rightB = b->x + b->width;
93 const INT32 right = MAX(rightA, rightB);
94 u.width = right - u.x;
95
96 const INT32 bottomA = a->y + a->height;
97 const INT32 bottomB = b->y + b->height;
98 const INT32 bottom = MAX(bottomA, bottomB);
99 u.height = bottom - u.y;
100
101 return u;
102}
103
104static BOOL intersect_rects(const struct bounds_t* r1, const struct bounds_t* r2)
105{
106 WINPR_ASSERT(r1);
107 WINPR_ASSERT(r2);
108
109 const INT32 left = MAX(r1->x, r2->x);
110 const INT32 top = MAX(r1->y, r2->y);
111 const INT32 right = MIN(r1->x + r1->width, r2->x + r2->width);
112 const INT32 bottom = MIN(r1->y + r1->height, r2->y + r2->height);
113
114 return (left < right) && (top < bottom);
115}
116
117static BOOL align_rects(const struct bounds_t* r1, const struct bounds_t* r2)
118{
119 WINPR_ASSERT(r1);
120 WINPR_ASSERT(r2);
121
122 const INT32 left = MAX(r1->x, r2->x);
123 const INT32 top = MAX(r1->y, r2->y);
124 const INT32 right = MIN(r1->x + r1->width, r2->x + r2->width);
125 const INT32 bottom = MIN(r1->y + r1->height, r2->y + r2->height);
126
127 return (left == right) || (top == bottom);
128}
129
130static BOOL settings_reg_query_dword_val(HKEY hKey, const TCHAR* sub, DWORD* value)
131{
132 DWORD dwType = 0;
133 DWORD dwSize = 0;
134
135 dwSize = sizeof(DWORD);
136 if (RegQueryValueEx(hKey, sub, nullptr, &dwType, (BYTE*)value, &dwSize) != ERROR_SUCCESS)
137 return FALSE;
138 if (dwType != REG_DWORD)
139 return FALSE;
140
141 return TRUE;
142}
143
144static BOOL settings_reg_query_word_val(HKEY hKey, const TCHAR* sub, UINT16* value)
145{
146 DWORD dwValue = 0;
147
148 if (!settings_reg_query_dword_val(hKey, sub, &dwValue))
149 return FALSE;
150
151 if (dwValue > UINT16_MAX)
152 return FALSE;
153
154 *value = (UINT16)dwValue;
155 return TRUE;
156}
157
158static BOOL settings_reg_query_bool_val(HKEY hKey, const TCHAR* sub, BOOL* value)
159{
160 DWORD dwValue = 0;
161
162 if (!settings_reg_query_dword_val(hKey, sub, &dwValue))
163 return FALSE;
164 *value = dwValue != 0;
165 return TRUE;
166}
167
168static BOOL settings_reg_query_dword(rdpSettings* settings, FreeRDP_Settings_Keys_UInt32 id,
169 HKEY hKey, const TCHAR* sub)
170{
171 DWORD dwValue = 0;
172
173 if (!settings_reg_query_dword_val(hKey, sub, &dwValue))
174 return FALSE;
175
176 return freerdp_settings_set_uint32(settings, id, dwValue);
177}
178
179static BOOL settings_reg_query_bool(rdpSettings* settings, FreeRDP_Settings_Keys_Bool id, HKEY hKey,
180 const TCHAR* sub)
181{
182 DWORD dwValue = 0;
183
184 if (!settings_reg_query_dword_val(hKey, sub, &dwValue))
185 return FALSE;
186
187 return freerdp_settings_set_bool(settings, id, (dwValue != 0));
188}
189
190static void settings_client_load_hkey_local_machine(rdpSettings* settings)
191{
192 {
193 char* key = freerdp_getApplicatonDetailsRegKey(CLIENT_KEY);
194 if (key)
195 {
196 HKEY hKey = nullptr;
197 const LONG status =
198 RegOpenKeyExA(HKEY_LOCAL_MACHINE, key, 0, KEY_READ | KEY_WOW64_64KEY, &hKey);
199 free(key);
200
201 if (status == ERROR_SUCCESS)
202 {
203 settings_reg_query_dword(settings, FreeRDP_DesktopWidth, hKey, _T("DesktopWidth"));
204 settings_reg_query_dword(settings, FreeRDP_DesktopHeight, hKey,
205 _T("DesktopHeight"));
206 settings_reg_query_bool(settings, FreeRDP_Fullscreen, hKey, _T("Fullscreen"));
207 settings_reg_query_dword(settings, FreeRDP_ColorDepth, hKey, _T("ColorDepth"));
208 settings_reg_query_dword(settings, FreeRDP_KeyboardType, hKey, _T("KeyboardType"));
209 settings_reg_query_dword(settings, FreeRDP_KeyboardSubType, hKey,
210 _T("KeyboardSubType"));
211 settings_reg_query_dword(settings, FreeRDP_KeyboardFunctionKey, hKey,
212 _T("KeyboardFunctionKeys"));
213 settings_reg_query_dword(settings, FreeRDP_KeyboardLayout, hKey,
214 _T("KeyboardLayout"));
215 settings_reg_query_bool(settings, FreeRDP_ExtSecurity, hKey, _T("ExtSecurity"));
216 settings_reg_query_bool(settings, FreeRDP_NlaSecurity, hKey, _T("NlaSecurity"));
217 settings_reg_query_bool(settings, FreeRDP_TlsSecurity, hKey, _T("TlsSecurity"));
218 settings_reg_query_bool(settings, FreeRDP_RdpSecurity, hKey, _T("RdpSecurity"));
219 settings_reg_query_bool(settings, FreeRDP_MstscCookieMode, hKey,
220 _T("MstscCookieMode"));
221 settings_reg_query_dword(settings, FreeRDP_CookieMaxLength, hKey,
222 _T("CookieMaxLength"));
223 settings_reg_query_bool(settings, FreeRDP_BitmapCacheEnabled, hKey,
224 _T("BitmapCache"));
225 settings_reg_query_dword(settings, FreeRDP_OffscreenSupportLevel, hKey,
226 _T("OffscreenBitmapCache"));
227 settings_reg_query_dword(settings, FreeRDP_OffscreenCacheSize, hKey,
228 _T("OffscreenBitmapCacheSize"));
229 settings_reg_query_dword(settings, FreeRDP_OffscreenCacheEntries, hKey,
230 _T("OffscreenBitmapCacheEntries"));
231 RegCloseKey(hKey);
232 }
233 }
234 }
235 {
236 char* key = freerdp_getApplicatonDetailsRegKey(BITMAP_CACHE_KEY);
237 if (key)
238 {
239 HKEY hKey = nullptr;
240 const LONG status =
241 RegOpenKeyExA(HKEY_LOCAL_MACHINE, key, 0, KEY_READ | KEY_WOW64_64KEY, &hKey);
242 free(key);
243
244 if (status == ERROR_SUCCESS)
245 {
246 settings_reg_query_dword(settings, FreeRDP_BitmapCacheV2NumCells, hKey,
247 _T("NumCells"));
248 for (unsigned x = 0; x < 5; x++)
249 {
250 DWORD val = 0;
251 TCHAR numentries[64] = WINPR_C_ARRAY_INIT;
252 TCHAR persist[64] = WINPR_C_ARRAY_INIT;
253 BITMAP_CACHE_V2_CELL_INFO cache = WINPR_C_ARRAY_INIT;
254 (void)_sntprintf(numentries, ARRAYSIZE(numentries), _T("Cell%uNumEntries"), x);
255 (void)_sntprintf(persist, ARRAYSIZE(persist), _T("Cell%uPersistent"), x);
256 if (!settings_reg_query_dword_val(hKey, numentries, &val) ||
257 !settings_reg_query_bool_val(hKey, persist, &cache.persistent))
258 continue;
259
260 if (!freerdp_settings_set_pointer_array(settings, FreeRDP_BitmapCacheV2CellInfo,
261 x, &cache))
262 WLog_WARN(TAG, "Failed to load registry keys to settings!");
263 cache.numEntries = val;
264 }
265
266 settings_reg_query_bool(settings, FreeRDP_AllowCacheWaitingList, hKey,
267 _T("AllowCacheWaitingList"));
268 RegCloseKey(hKey);
269 }
270 }
271 }
272 {
273 char* key = freerdp_getApplicatonDetailsRegKey(GLYPH_CACHE_KEY);
274 if (key)
275 {
276 HKEY hKey = nullptr;
277 const LONG status =
278 RegOpenKeyExA(HKEY_LOCAL_MACHINE, key, 0, KEY_READ | KEY_WOW64_64KEY, &hKey);
279 free(key);
280
281 if (status == ERROR_SUCCESS)
282 {
283 unsigned x = 0;
284 UINT32 GlyphSupportLevel = 0;
285 settings_reg_query_dword(settings, FreeRDP_GlyphSupportLevel, hKey,
286 _T("SupportLevel"));
287 for (; x < 10; x++)
288 {
289 GLYPH_CACHE_DEFINITION cache = WINPR_C_ARRAY_INIT;
290 TCHAR numentries[64] = WINPR_C_ARRAY_INIT;
291 TCHAR maxsize[64] = WINPR_C_ARRAY_INIT;
292 (void)_sntprintf(numentries, ARRAYSIZE(numentries), _T("Cache%uNumEntries"), x);
293 (void)_sntprintf(maxsize, ARRAYSIZE(maxsize), _T("Cache%uMaxCellSize"), x);
294
295 settings_reg_query_word_val(hKey, numentries, &cache.cacheEntries);
296 settings_reg_query_word_val(hKey, maxsize, &cache.cacheMaximumCellSize);
297 if (!freerdp_settings_set_pointer_array(settings, FreeRDP_GlyphCache, x,
298 &cache))
299 WLog_WARN(TAG, "Failed to store GlyphCache %u", x);
300 }
301 {
302 GLYPH_CACHE_DEFINITION cache = WINPR_C_ARRAY_INIT;
303 settings_reg_query_word_val(hKey, _T("FragCacheNumEntries"),
304 &cache.cacheEntries);
305 settings_reg_query_word_val(hKey, _T("FragCacheMaxCellSize"),
306 &cache.cacheMaximumCellSize);
307 if (!freerdp_settings_set_pointer_array(settings, FreeRDP_FragCache, x, &cache))
308 WLog_WARN(TAG, "Failed to store FragCache");
309 }
310
311 RegCloseKey(hKey);
312
313 if (!freerdp_settings_set_uint32(settings, FreeRDP_GlyphSupportLevel,
314 GlyphSupportLevel))
315 WLog_WARN(TAG, "Failed to load registry keys to settings!");
316 }
317 }
318 }
319 {
320 char* key = freerdp_getApplicatonDetailsRegKey(POINTER_CACHE_KEY);
321 if (key)
322 {
323 HKEY hKey = nullptr;
324 const LONG status =
325 RegOpenKeyExA(HKEY_LOCAL_MACHINE, key, 0, KEY_READ | KEY_WOW64_64KEY, &hKey);
326 free(key);
327
328 if (status == ERROR_SUCCESS)
329 {
330 settings_reg_query_dword(settings, FreeRDP_LargePointerFlag, hKey,
331 _T("LargePointer"));
332 settings_reg_query_dword(settings, FreeRDP_PointerCacheSize, hKey,
333 _T("PointerCacheSize"));
334 settings_reg_query_dword(settings, FreeRDP_ColorPointerCacheSize, hKey,
335 _T("ColorPointerCacheSize"));
336 RegCloseKey(hKey);
337 }
338 }
339 }
340}
341
342static void settings_server_load_hkey_local_machine(rdpSettings* settings)
343{
344 HKEY hKey = nullptr;
345
346 char* key = freerdp_getApplicatonDetailsRegKey(SERVER_KEY);
347 if (!key)
348 return;
349
350 const LONG status =
351 RegOpenKeyExA(HKEY_LOCAL_MACHINE, key, 0, KEY_READ | KEY_WOW64_64KEY, &hKey);
352 free(key);
353
354 if (status != ERROR_SUCCESS)
355 return;
356
357 settings_reg_query_bool(settings, FreeRDP_ExtSecurity, hKey, _T("ExtSecurity"));
358 settings_reg_query_bool(settings, FreeRDP_NlaSecurity, hKey, _T("NlaSecurity"));
359 settings_reg_query_bool(settings, FreeRDP_TlsSecurity, hKey, _T("TlsSecurity"));
360 settings_reg_query_dword(settings, FreeRDP_TlsSecLevel, hKey, _T("TlsSecLevel"));
361 settings_reg_query_bool(settings, FreeRDP_RdpSecurity, hKey, _T("RdpSecurity"));
362
363 RegCloseKey(hKey);
364}
365
366static void settings_load_hkey_local_machine(rdpSettings* settings)
367{
368 if (freerdp_settings_get_bool(settings, FreeRDP_ServerMode))
369 settings_server_load_hkey_local_machine(settings);
370 else
371 settings_client_load_hkey_local_machine(settings);
372}
373
374static BOOL settings_init_computer_name(rdpSettings* settings)
375{
376 CHAR computerName[MAX_COMPUTERNAME_LENGTH + 1] = WINPR_C_ARRAY_INIT;
377 DWORD nSize = ARRAYSIZE(computerName);
378
379 if (!GetComputerNameExA(ComputerNameNetBIOS, computerName, &nSize))
380 return FALSE;
381
382 if (!freerdp_settings_set_string(settings, FreeRDP_ComputerName, computerName))
383 return FALSE;
384 return freerdp_settings_set_string(settings, FreeRDP_ClientHostname, computerName);
385}
386
387void freerdp_settings_print_warnings(const rdpSettings* settings)
388{
389 const UINT32 level = freerdp_settings_get_uint32(settings, FreeRDP_GlyphSupportLevel);
390 if (level != GLYPH_SUPPORT_NONE)
391 {
392 char buffer[32] = WINPR_C_ARRAY_INIT;
393 WLog_WARN(TAG, "[experimental] enabled GlyphSupportLevel %s, expect visual artefacts!",
394 freerdp_settings_glyph_level_string(level, buffer, sizeof(buffer)));
395 }
396}
397
398static BOOL monitor_operlaps(const rdpSettings* settings, UINT32 orig, UINT32 start, UINT32 count,
399 const rdpMonitor* compare)
400{
401 const struct bounds_t rect1 = {
402 .x = compare->x, .y = compare->y, .width = compare->width, .height = compare->height
403 };
404 for (UINT32 x = start; x < count; x++)
405 {
406 const rdpMonitor* monitor =
407 freerdp_settings_get_pointer_array(settings, FreeRDP_MonitorDefArray, x);
408 const struct bounds_t rect2 = {
409 .x = monitor->x, .y = monitor->y, .width = monitor->width, .height = monitor->height
410 };
411
412 if (intersect_rects(&rect1, &rect2))
413 {
414 char buffer1[32] = WINPR_C_ARRAY_INIT;
415 char buffer2[32] = WINPR_C_ARRAY_INIT;
416
417 WLog_ERR(TAG, "Monitor %" PRIu32 " and %" PRIu32 " are overlapping:", orig, x);
418 WLog_ERR(TAG, "%s overlapps with %s", bounds2str(&rect1, buffer1, sizeof(buffer1)),
419 bounds2str(&rect2, buffer2, sizeof(buffer2)));
420 WLog_ERR(
421 TAG,
422 "Mulitimonitor mode requested, but local layout has gaps or overlapping areas!");
423 WLog_ERR(TAG,
424 "Please reconfigure your local monitor setup so that there are no gaps or "
425 "overlapping areas!");
426 return TRUE;
427 }
428 }
429 return FALSE;
430}
431
432static BOOL monitor_has_gaps(const rdpSettings* settings, UINT32 start, UINT32 count,
433 const rdpMonitor* compare, UINT32** graph)
434{
435 const struct bounds_t rect1 = {
436 .x = compare->x, .y = compare->y, .width = compare->width, .height = compare->height
437 };
438
439 BOOL hasNeighbor = FALSE;
440 for (UINT32 i = 0; i < count; i++)
441 {
442 if (i == start)
443 continue;
444
445 const rdpMonitor* monitor =
446 freerdp_settings_get_pointer_array(settings, FreeRDP_MonitorDefArray, i);
447
448 const struct bounds_t rect2 = {
449 .x = monitor->x, .y = monitor->y, .width = monitor->width, .height = monitor->height
450 };
451 if (align_rects(&rect1, &rect2))
452 {
453 hasNeighbor = TRUE;
454 graph[start][i] = 1;
455 graph[i][start] = 1;
456 }
457 }
458
459 if (!hasNeighbor)
460 {
461 WLog_ERR(TAG,
462 "Monitor configuration has gaps! Monitor %" PRIu32 " does not have any neighbor",
463 start);
464 }
465
466 return !hasNeighbor;
467}
468
469static void alloc_free(UINT32** ptr)
470{
471 free((void*)ptr);
472}
473
474WINPR_ATTR_MALLOC(alloc_free, 1)
475WINPR_ATTR_NODISCARD
476static UINT32** alloc_array(size_t count)
477{
478 // NOLINTNEXTLINE(clang-analyzer-unix.MallocSizeof)
479 BYTE* array = calloc(count * sizeof(uintptr_t), count * sizeof(UINT32));
480 UINT32** dst = WINPR_PACKED_ALIGN_CAST(UINT32**, array);
481 UINT32* val = WINPR_PACKED_ALIGN_CAST(UINT32*, (array + count * sizeof(uintptr_t)));
482 for (size_t x = 0; x < count; x++)
483 dst[x] = &val[x];
484
485 return dst;
486}
487
488/* Monitors in the array need to:
489 *
490 * 1. be connected to another monitor (edges touch but don't overlap or have gaps)
491 * 2. all monitors need to be connected so there are no separate groups.
492 *
493 * So, what we do here is we use dijkstra algorithm to find a path from any start node
494 * (lazy as we are we always use the first in the array) to each other node.
495 */
496static BOOL find_path_exists_with_dijkstra(UINT32** graph, size_t count, UINT32 start)
497{
498 if (count < 1)
499 return FALSE;
500
501 WINPR_ASSERT(start < count);
502
503 UINT32** cost = alloc_array(count);
504 WINPR_ASSERT(cost);
505
506 UINT32* distance = calloc(count, sizeof(UINT32));
507 WINPR_ASSERT(distance);
508
509 UINT32* visited = calloc(count, sizeof(UINT32));
510 WINPR_ASSERT(visited);
511
512 UINT32* parent = calloc(count, sizeof(UINT32));
513 WINPR_ASSERT(parent);
514
515 for (size_t x = 0; x < count; x++)
516 {
517 for (size_t y = 0; y < count; y++)
518 {
519 if (graph[x][y] == 0)
520 cost[x][y] = UINT32_MAX;
521 else
522 cost[x][y] = graph[x][y];
523 }
524 }
525
526 for (UINT32 x = 0; x < count; x++)
527 {
528 distance[x] = cost[start][x];
529 parent[x] = start;
530 visited[x] = 0;
531 }
532
533 distance[start] = 0;
534 visited[start] = 1;
535
536 size_t pos = 1;
537 UINT32 nextnode = UINT32_MAX;
538 while (pos < count - 1)
539 {
540 UINT32 mindistance = UINT32_MAX;
541
542 for (UINT32 x = 0; x < count; x++)
543 {
544 if ((distance[x] < mindistance) && !visited[x])
545 {
546 mindistance = distance[x];
547 nextnode = x;
548 }
549 }
550
551 visited[nextnode] = 1;
552
553 for (size_t y = 0; y < count; y++)
554 {
555 if (!visited[y])
556 {
557 UINT32 dist = mindistance + cost[nextnode][y];
558 if (dist < distance[y])
559 {
560 distance[y] = dist;
561 parent[y] = nextnode;
562 }
563 }
564 }
565 pos++;
566 }
567
568 BOOL rc = TRUE;
569 for (size_t x = 0; x < count; x++)
570 {
571 if (x != start)
572 {
573 if (distance[x] == UINT32_MAX)
574 {
575 WLog_ERR(TAG, "monitor %" PRIu32 " not connected with monitor %" PRIuz, start, x);
576 rc = FALSE;
577 break;
578 }
579 }
580 }
581 alloc_free(cost);
582 free(distance);
583 free(visited);
584 free(parent);
585
586 return rc;
587}
588
589static BOOL freerdp_settings_client_monitors_have_gaps(const rdpSettings* settings)
590{
591 BOOL rc = TRUE;
592 const UINT32 count = freerdp_settings_get_uint32(settings, FreeRDP_MonitorCount);
593 if (count <= 1)
594 return FALSE;
595
596 UINT32** graph = alloc_array(count);
597 WINPR_ASSERT(graph);
598
599 for (UINT32 x = 0; x < count; x++)
600 {
601 const rdpMonitor* monitor =
602 freerdp_settings_get_pointer_array(settings, FreeRDP_MonitorDefArray, x);
603 if (monitor_has_gaps(settings, x, count, monitor, graph))
604 goto fail;
605 }
606
607 rc = !find_path_exists_with_dijkstra(graph, count, 0);
608
609fail:
610 alloc_free(graph);
611
612 return rc;
613}
614
615static void log_monitor(UINT32 idx, const rdpMonitor* monitor, wLog* log, DWORD level)
616{
617 WINPR_ASSERT(monitor);
618
619 WLog_Print(log, level,
620 "[%" PRIu32 "] [%s] {%dx%d-%dx%d} [%" PRIu32 "] {%" PRIu32 "x%" PRIu32
621 ", orientation: %s [%" PRIu32 "], desktopScale: %" PRIu32 ", deviceScale: %" PRIu32
622 "}",
623 idx, monitor->is_primary ? "primary" : " ", monitor->x, monitor->y,
624 monitor->width, monitor->height, monitor->orig_screen,
625 monitor->attributes.physicalWidth, monitor->attributes.physicalHeight,
626 freerdp_desktop_rotation_flags_to_string(monitor->attributes.orientation),
627 monitor->attributes.orientation, monitor->attributes.desktopScaleFactor,
628 monitor->attributes.deviceScaleFactor);
629}
630
631static void log_monitor_configuration(const rdpSettings* settings, wLog* log, DWORD level)
632{
633 const UINT32 count = freerdp_settings_get_uint32(settings, FreeRDP_MonitorCount);
634 WLog_Print(log, level, "[BEGIN] MonitorDefArray[%" PRIu32 "]", count);
635 for (UINT32 x = 0; x < count; x++)
636 {
637 const rdpMonitor* monitor =
638 freerdp_settings_get_pointer_array(settings, FreeRDP_MonitorDefArray, x);
639 log_monitor(x, monitor, log, level);
640 }
641 WLog_Print(log, level, "[END] MonitorDefArray[%" PRIu32 "]", count);
642}
643
644static BOOL freerdp_settings_client_monitors_overlap(const rdpSettings* settings)
645{
646 const UINT32 count = freerdp_settings_get_uint32(settings, FreeRDP_MonitorCount);
647 for (UINT32 x = 0; x < count; x++)
648 {
649 const rdpMonitor* monitor =
650 freerdp_settings_get_pointer_array(settings, FreeRDP_MonitorDefArray, x);
651 if (monitor_operlaps(settings, x, x + 1, count, monitor))
652 return TRUE;
653 }
654 return FALSE;
655}
656
657/* See [MS-RDPBCGR] 2.2.1.3.6.1 for details on limits
658 * https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpbcgr/c3964b39-3d54-4ae1-a84a-ceaed311e0f6
659 */
660static BOOL freerdp_settings_client_monitors_check_primary_and_origin(const rdpSettings* settings)
661{
662 const UINT32 count = freerdp_settings_get_uint32(settings, FreeRDP_MonitorCount);
663 BOOL havePrimary = FALSE;
664 BOOL foundOrigin = FALSE;
665 BOOL primaryIsOrigin = FALSE;
666 BOOL rc = TRUE;
667
668 struct bounds_t bounds = WINPR_C_ARRAY_INIT;
669
670 if (count == 0)
671 {
672 WLog_WARN(TAG, "Monitor configuration empty.");
673 return TRUE;
674 }
675
676 for (UINT32 x = 0; x < count; x++)
677 {
678 const rdpMonitor* monitor =
679 freerdp_settings_get_pointer_array(settings, FreeRDP_MonitorDefArray, x);
680 struct bounds_t cur = {
681 .x = monitor->x, .y = monitor->y, .width = monitor->width, .height = monitor->height
682 };
683
684 bounds = union_rect(&bounds, &cur);
685
686 if (monitor->is_primary)
687 {
688 if (havePrimary)
689 {
690 WLog_ERR(TAG, "Monitor configuration contains multiple primary monitors!");
691 rc = FALSE;
692 }
693 havePrimary = TRUE;
694 }
695
696 if ((monitor->x == 0) && (monitor->y == 0))
697 {
698 if (foundOrigin)
699 {
700 WLog_ERR(TAG, "Monitor configuration does have multiple origin 0/0");
701 rc = FALSE;
702 }
703 foundOrigin = TRUE;
704 primaryIsOrigin = monitor->is_primary != 0;
705 }
706 }
707
708 if ((bounds.width > 32766) || (bounds.width < 200))
709 {
710 WLog_ERR(TAG,
711 "Monitor configuration virtual desktop width must be 200 <= %" PRId32 " <= 32766",
712 bounds.width);
713 rc = FALSE;
714 }
715 if ((bounds.height > 32766) || (bounds.height < 200))
716 {
717 WLog_ERR(TAG,
718 "Monitor configuration virtual desktop height must be 200 <= %" PRId32 " <= 32766",
719 bounds.height);
720 rc = FALSE;
721 }
722
723 if (!havePrimary)
724 {
725 WLog_ERR(TAG, "Monitor configuration does not contain a primary monitor!");
726 rc = FALSE;
727 }
728 if (!foundOrigin)
729 {
730 WLog_ERR(TAG, "Monitor configuration must start at 0/0 for first monitor!");
731 rc = FALSE;
732 }
733 if (!primaryIsOrigin)
734 {
735 WLog_ERR(TAG, "Monitor configuration must start at 0/0 for primary monitor!");
736 rc = FALSE;
737 }
738
739 return rc;
740}
741
742BOOL freerdp_settings_check_client_after_preconnect(const rdpSettings* settings)
743{
744 wLog* log = WLog_Get(TAG);
745 BOOL rc = TRUE;
746 log_monitor_configuration(settings, log, WLOG_DEBUG);
747 if (freerdp_settings_client_monitors_overlap(settings))
748 rc = FALSE;
749 if (freerdp_settings_client_monitors_have_gaps(settings))
750 rc = FALSE;
751 if (!freerdp_settings_client_monitors_check_primary_and_origin(settings))
752 rc = FALSE;
753 if (!rc)
754 {
755 DWORD level = WLOG_ERROR;
756 WLog_Print(log, level, "Invalid or unsupported monitor configuration detected");
757 WLog_Print(log, level, "Check if the configuration is valid.");
758 WLog_Print(log, level,
759 "If you suspect a bug create a new issue at "
760 "https://github.com/FreeRDP/FreeRDP/issues/new");
761 WLog_Print(
762 log, level,
763 "Provide at least the following log lines detailing your monitor configuration:");
764 log_monitor_configuration(settings, log, level);
765 }
766
767 return rc;
768}
769
770BOOL freerdp_settings_set_default_order_support(rdpSettings* settings)
771{
772 BYTE* OrderSupport = freerdp_settings_get_pointer_writable(settings, FreeRDP_OrderSupport);
773 if (!OrderSupport)
774 return FALSE;
775
776 ZeroMemory(OrderSupport, 32);
777 OrderSupport[NEG_DSTBLT_INDEX] = TRUE;
778 OrderSupport[NEG_PATBLT_INDEX] = TRUE;
779 OrderSupport[NEG_SCRBLT_INDEX] = TRUE;
780 OrderSupport[NEG_OPAQUE_RECT_INDEX] = TRUE;
781 OrderSupport[NEG_DRAWNINEGRID_INDEX] = FALSE;
782 OrderSupport[NEG_MULTIDSTBLT_INDEX] = FALSE;
783 OrderSupport[NEG_MULTIPATBLT_INDEX] = FALSE;
784 OrderSupport[NEG_MULTISCRBLT_INDEX] = FALSE;
785 OrderSupport[NEG_MULTIOPAQUERECT_INDEX] = TRUE;
786 OrderSupport[NEG_MULTI_DRAWNINEGRID_INDEX] = FALSE;
787 OrderSupport[NEG_LINETO_INDEX] = TRUE;
788 OrderSupport[NEG_POLYLINE_INDEX] = TRUE;
789 OrderSupport[NEG_MEMBLT_INDEX] =
790 freerdp_settings_get_bool(settings, FreeRDP_BitmapCacheEnabled) ? 1 : 0;
791 OrderSupport[NEG_MEM3BLT_INDEX] =
792 freerdp_settings_get_bool(settings, FreeRDP_BitmapCacheEnabled) ? 1 : 0;
793 OrderSupport[NEG_MEMBLT_V2_INDEX] =
794 freerdp_settings_get_bool(settings, FreeRDP_BitmapCacheEnabled) ? 1 : 0;
795 OrderSupport[NEG_MEM3BLT_V2_INDEX] =
796 freerdp_settings_get_bool(settings, FreeRDP_BitmapCacheEnabled) ? 1 : 0;
797 OrderSupport[NEG_SAVEBITMAP_INDEX] = FALSE;
798 OrderSupport[NEG_GLYPH_INDEX_INDEX] =
799 freerdp_settings_get_uint32(settings, FreeRDP_GlyphSupportLevel) != GLYPH_SUPPORT_NONE;
800 OrderSupport[NEG_FAST_INDEX_INDEX] =
801 freerdp_settings_get_uint32(settings, FreeRDP_GlyphSupportLevel) != GLYPH_SUPPORT_NONE;
802 OrderSupport[NEG_FAST_GLYPH_INDEX] =
803 freerdp_settings_get_uint32(settings, FreeRDP_GlyphSupportLevel) != GLYPH_SUPPORT_NONE;
804 OrderSupport[NEG_POLYGON_SC_INDEX] = FALSE;
805 OrderSupport[NEG_POLYGON_CB_INDEX] = FALSE;
806 OrderSupport[NEG_ELLIPSE_SC_INDEX] = FALSE;
807 OrderSupport[NEG_ELLIPSE_CB_INDEX] = FALSE;
808 return TRUE;
809}
810
812{
813 return freerdp_GetConfigFilePath(FALSE, "");
814}
815
816rdpSettings* freerdp_settings_new(DWORD flags)
817{
818 const BOOL server = ((flags & FREERDP_SETTINGS_SERVER_MODE) != 0);
819 const BOOL remote = ((flags & FREERDP_SETTINGS_REMOTE_MODE) != 0);
820 rdpSettings* settings = (rdpSettings*)calloc(1, sizeof(rdpSettings));
821
822 if (!settings)
823 return nullptr;
824
825 {
826 const char* vendor = freerdp_getApplicationDetailsVendor();
827 const char* product = freerdp_getApplicationDetailsProduct();
828 const char* details = freerdp_getApplicationDetailsString();
829 char* issuer1 = nullptr;
830 char* issuer2 = nullptr;
831 char* issuer3 = nullptr;
832 size_t len = 0;
833 (void)winpr_asprintf(&issuer1, &len, "%s-licenser", freerdp_getApplicationDetailsString());
834 (void)winpr_asprintf(&issuer2, &len, "%s-licenser", freerdp_getApplicationDetailsVendor());
835 (void)winpr_asprintf(&issuer3, &len, "%s-licenser", freerdp_getApplicationDetailsProduct());
836
837 char* issuers[] = { WINPR_CAST_CONST_PTR_AWAY(vendor, char*),
838 WINPR_CAST_CONST_PTR_AWAY(product, char*),
839 WINPR_CAST_CONST_PTR_AWAY(details, char*),
840 issuer1,
841 issuer2,
842 issuer3 };
843
844 const BOOL res = freerdp_server_license_issuers_copy(settings, issuers, ARRAYSIZE(issuers));
845 free(issuer1);
846 free(issuer2);
847 free(issuer3);
848 if (!res)
849 goto out_fail;
850 }
851 if (!server && !remote)
852 {
853 if (!freerdp_settings_set_string(settings, FreeRDP_GatewayHttpUserAgent,
854 FREERDP_USER_AGENT))
855 goto out_fail;
856 if (!freerdp_settings_set_string(settings, FreeRDP_GatewayHttpMsUserAgent,
857 FREERDP_USER_AGENT))
858 goto out_fail;
859
860 if (!freerdp_settings_set_string(settings, FreeRDP_GatewayHttpReferer, ""))
861 goto out_fail;
862 if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAvdAccessTokenFormat,
863 "ms-appx-web%%3a%%2f%%2fMicrosoft.AAD.BrokerPlugin%%2f%s"))
864 goto out_fail;
865 if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAvdAccessAadFormat,
866 "https%%3A%%2F%%2F%s%%2F%s%%2Foauth2%%2Fnativeclient"))
867 goto out_fail;
868 if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAvdScope,
869 "https%3A%2F%2Fwww.wvd.microsoft.com%2F.default%20openid%"
870 "20profile%20offline_access"))
871
872 goto out_fail;
873 if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAvdClientID,
874 "a85cf173-4192-42f8-81fa-777a763e6e2c"))
875 goto out_fail;
876 if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAzureActiveDirectory,
877 "login.microsoftonline.com"))
878 goto out_fail;
879 if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAvdAadtenantid, "common"))
880 goto out_fail;
881 if (!freerdp_settings_set_bool(settings, FreeRDP_GatewayAvdUseTenantid, FALSE))
882 goto out_fail;
883 if (!freerdp_settings_set_uint32(settings, FreeRDP_DesktopPhysicalWidth, 1000))
884 goto out_fail;
885 if (!freerdp_settings_set_uint32(settings, FreeRDP_DesktopPhysicalHeight, 1000))
886 goto out_fail;
887 if (!freerdp_settings_set_uint16(settings, FreeRDP_DesktopOrientation,
888 ORIENTATION_LANDSCAPE))
889 goto out_fail;
890 if (!freerdp_settings_set_uint32(settings, FreeRDP_DeviceScaleFactor, 100))
891 goto out_fail;
892 if (!freerdp_settings_set_uint32(settings, FreeRDP_DesktopScaleFactor, 100))
893 goto out_fail;
894 }
895 if (!freerdp_settings_set_uint32(settings, FreeRDP_SurfaceCommandsSupported,
896 SURFCMDS_SET_SURFACE_BITS | SURFCMDS_STREAM_SURFACE_BITS |
897 SURFCMDS_FRAME_MARKER))
898 goto out_fail;
899
900 if (!freerdp_settings_set_uint32(settings, FreeRDP_RemoteFxRlgrMode, RLGR3))
901 goto out_fail;
902
903 if (!freerdp_settings_set_uint16(settings, FreeRDP_CapsProtocolVersion,
904 TS_CAPS_PROTOCOLVERSION))
905 goto out_fail;
906
907 if (!freerdp_settings_set_uint32(settings, FreeRDP_ClipboardFeatureMask,
908 CLIPRDR_FLAG_DEFAULT_MASK))
909 goto out_fail;
910 if (!freerdp_settings_set_string(settings, FreeRDP_ServerLicenseCompanyName,
911 freerdp_getApplicationDetailsVendor()))
912 goto out_fail;
913
914 {
915 size_t len = 0;
916 char* val = nullptr;
917 (void)winpr_asprintf(&val, &len, "%s-licensing-server",
918 freerdp_getApplicationDetailsProduct());
919 if (!val)
920 goto out_fail;
921
922 const BOOL rc =
923 freerdp_settings_set_string(settings, FreeRDP_ServerLicenseProductName, val);
924 free(val);
925 if (!rc)
926 goto out_fail;
927 }
928
929 if (!freerdp_settings_set_uint32(settings, FreeRDP_ServerLicenseProductVersion, 1))
930 goto out_fail;
931
932 if (!freerdp_settings_set_uint16(settings, FreeRDP_SupportedColorDepths,
933 RNS_UD_32BPP_SUPPORT | RNS_UD_24BPP_SUPPORT |
934 RNS_UD_16BPP_SUPPORT | RNS_UD_15BPP_SUPPORT))
935 goto out_fail;
936
937 const UINT32 railflags = TS_RAIL_CLIENTSTATUS_ALLOWLOCALMOVESIZE |
938 TS_RAIL_CLIENTSTATUS_ZORDER_SYNC |
939 TS_RAIL_CLIENTSTATUS_WINDOW_RESIZE_MARGIN_SUPPORTED |
940 TS_RAIL_CLIENTSTATUS_APPBAR_REMOTING_SUPPORTED |
941 TS_RAIL_CLIENTSTATUS_POWER_DISPLAY_REQUEST_SUPPORTED |
942 TS_RAIL_CLIENTSTATUS_BIDIRECTIONAL_CLOAK_SUPPORTED;
943 if (!freerdp_settings_set_uint32(settings, FreeRDP_RemoteAppFeatureFlags, railflags))
944 goto out_fail;
945
946 if (!freerdp_settings_set_bool(settings, FreeRDP_UnicodeInput, TRUE) ||
947 !freerdp_settings_set_bool(settings, FreeRDP_HasHorizontalWheel, TRUE) ||
948 !freerdp_settings_set_bool(settings, FreeRDP_HasExtendedMouseEvent, TRUE) ||
949 !freerdp_settings_set_bool(settings, FreeRDP_HasQoeEvent, TRUE) ||
950 !freerdp_settings_set_bool(settings, FreeRDP_HasRelativeMouseEvent, TRUE) ||
951 !freerdp_settings_set_bool(settings, FreeRDP_HiDefRemoteApp, TRUE) ||
953 settings, FreeRDP_RemoteApplicationSupportMask,
954 RAIL_LEVEL_SUPPORTED | RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED |
955 RAIL_LEVEL_SHELL_INTEGRATION_SUPPORTED | RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED |
956 RAIL_LEVEL_SERVER_TO_CLIENT_IME_SYNC_SUPPORTED |
957 RAIL_LEVEL_HIDE_MINIMIZED_APPS_SUPPORTED | RAIL_LEVEL_WINDOW_CLOAKING_SUPPORTED |
958 RAIL_LEVEL_HANDSHAKE_EX_SUPPORTED) ||
959 !freerdp_settings_set_uint16(settings, FreeRDP_TextANSICodePage, CP_UTF8) ||
960 !freerdp_settings_set_uint16(settings, FreeRDP_OrderSupportFlags,
961 NEGOTIATE_ORDER_SUPPORT | ZERO_BOUNDS_DELTA_SUPPORT |
962 COLOR_INDEX_SUPPORT) ||
963 !freerdp_settings_set_bool(settings, FreeRDP_SupportHeartbeatPdu, TRUE) ||
964 !freerdp_settings_set_bool(settings, FreeRDP_ServerMode, server) ||
965 !freerdp_settings_set_bool(settings, FreeRDP_WaitForOutputBufferFlush, TRUE) ||
966 !freerdp_settings_set_uint32(settings, FreeRDP_ClusterInfoFlags, REDIRECTION_SUPPORTED) ||
967 !freerdp_settings_set_uint32(settings, FreeRDP_DesktopWidth, 1024) ||
968 !freerdp_settings_set_uint32(settings, FreeRDP_DesktopHeight, 768) ||
969 !freerdp_settings_set_bool(settings, FreeRDP_Workarea, FALSE) ||
970 !freerdp_settings_set_bool(settings, FreeRDP_Fullscreen, FALSE) ||
971 !freerdp_settings_set_bool(settings, FreeRDP_GrabKeyboard, TRUE) ||
972 !freerdp_settings_set_bool(settings, FreeRDP_Decorations, TRUE) ||
973 !freerdp_settings_set_uint32(settings, FreeRDP_RdpVersion, RDP_VERSION_10_12) ||
974 !freerdp_settings_set_uint32(settings, FreeRDP_ColorDepth, 32) ||
975 !freerdp_settings_set_bool(settings, FreeRDP_AadSecurity, FALSE) ||
976 !freerdp_settings_set_bool(settings, FreeRDP_ExtSecurity, TRUE) ||
977 !freerdp_settings_set_bool(settings, FreeRDP_NlaSecurity, TRUE) ||
978 !freerdp_settings_set_bool(settings, FreeRDP_TlsSecurity, TRUE) ||
979 !freerdp_settings_set_bool(settings, FreeRDP_RdpSecurity, TRUE) ||
980 !freerdp_settings_set_bool(settings, FreeRDP_RdstlsSecurity, FALSE) ||
981 !freerdp_settings_set_bool(settings, FreeRDP_NegotiateSecurityLayer, TRUE) ||
982 !freerdp_settings_set_bool(settings, FreeRDP_RestrictedAdminModeRequired, FALSE) ||
983 !freerdp_settings_set_bool(settings, FreeRDP_RestrictedAdminModeSupported, TRUE) ||
984 !freerdp_settings_set_bool(settings, FreeRDP_MstscCookieMode, FALSE) ||
985 !freerdp_settings_set_uint32(settings, FreeRDP_CookieMaxLength,
986 DEFAULT_COOKIE_MAX_LENGTH) ||
987 !freerdp_settings_set_uint32(settings, FreeRDP_ClientBuild,
988 18363) || /* Windows 10, Version 1909 */
989 !freerdp_settings_set_uint32(settings, FreeRDP_KeyboardType, WINPR_KBD_TYPE_IBM_ENHANCED) ||
990 !freerdp_settings_set_uint32(settings, FreeRDP_KeyboardSubType, 0) ||
991 !freerdp_settings_set_uint32(settings, FreeRDP_KeyboardFunctionKey, 12) ||
992 !freerdp_settings_set_uint32(settings, FreeRDP_KeyboardLayout, 0) ||
993 !freerdp_settings_set_uint32(settings, FreeRDP_KeyboardHook,
994 KEYBOARD_HOOK_FULLSCREEN_ONLY) ||
995 !freerdp_settings_set_bool(settings, FreeRDP_UseRdpSecurityLayer, FALSE) ||
996 !freerdp_settings_set_bool(settings, FreeRDP_SaltedChecksum, TRUE) ||
997 !freerdp_settings_set_uint32(settings, FreeRDP_ServerPort, 3389) ||
998 !freerdp_settings_set_uint32(settings, FreeRDP_GatewayPort, 443) ||
999 !freerdp_settings_set_bool(settings, FreeRDP_DesktopResize, TRUE) ||
1000 !freerdp_settings_set_bool(settings, FreeRDP_ToggleFullscreen, TRUE) ||
1001 !freerdp_settings_set_uint32(settings, FreeRDP_DesktopPosX, UINT32_MAX) ||
1002 !freerdp_settings_set_uint32(settings, FreeRDP_DesktopPosY, UINT32_MAX) ||
1003 !freerdp_settings_set_bool(settings, FreeRDP_SoftwareGdi, TRUE) ||
1004 !freerdp_settings_set_bool(settings, FreeRDP_UnmapButtons, FALSE) ||
1005 !freerdp_settings_set_uint32(settings, FreeRDP_PerformanceFlags, PERF_FLAG_NONE) ||
1006 !freerdp_settings_set_bool(settings, FreeRDP_AllowFontSmoothing, TRUE) ||
1007 !freerdp_settings_set_bool(settings, FreeRDP_AllowDesktopComposition, FALSE) ||
1008 !freerdp_settings_set_bool(settings, FreeRDP_DisableWallpaper, FALSE) ||
1009 !freerdp_settings_set_bool(settings, FreeRDP_DisableFullWindowDrag, TRUE) ||
1010 !freerdp_settings_set_bool(settings, FreeRDP_DisableMenuAnims, TRUE) ||
1011 !freerdp_settings_set_bool(settings, FreeRDP_DisableThemes, FALSE) ||
1012 !freerdp_settings_set_uint32(settings, FreeRDP_ConnectionType,
1013 CONNECTION_TYPE_AUTODETECT) ||
1014 !freerdp_settings_set_bool(settings, FreeRDP_NetworkAutoDetect, TRUE) ||
1015 !freerdp_settings_set_uint32(settings, FreeRDP_EncryptionMethods, ENCRYPTION_METHOD_NONE) ||
1016 !freerdp_settings_set_uint32(settings, FreeRDP_EncryptionLevel, ENCRYPTION_LEVEL_NONE) ||
1017 !freerdp_settings_set_bool(settings, FreeRDP_FIPSMode, FALSE) ||
1018 !freerdp_settings_set_bool(settings, FreeRDP_CompressionEnabled, TRUE) ||
1019 !freerdp_settings_set_bool(settings, FreeRDP_LogonNotify, TRUE) ||
1020 !freerdp_settings_set_uint32(settings, FreeRDP_BrushSupportLevel, BRUSH_COLOR_FULL) ||
1021 !freerdp_settings_set_uint32(settings, FreeRDP_CompressionLevel, PACKET_COMPR_TYPE_RDP61) ||
1022 !freerdp_settings_set_bool(settings, FreeRDP_Authentication, TRUE) ||
1023 !freerdp_settings_set_bool(settings, FreeRDP_AuthenticationOnly, FALSE) ||
1024 !freerdp_settings_set_bool(settings, FreeRDP_CredentialsFromStdin, FALSE) ||
1025 !freerdp_settings_set_bool(settings, FreeRDP_DisableCredentialsDelegation, FALSE) ||
1026 !freerdp_settings_set_uint32(settings, FreeRDP_AuthenticationLevel, 2) ||
1027 !freerdp_settings_set_uint32(settings, FreeRDP_ChannelCount, 0) ||
1028 !freerdp_settings_set_bool(settings, FreeRDP_CertificateCallbackPreferPEM, FALSE) ||
1029 !freerdp_settings_set_uint32(settings, FreeRDP_KeySpec, AT_KEYEXCHANGE))
1030 goto out_fail;
1031
1032 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ChannelDefArray, nullptr,
1033 CHANNEL_MAX_COUNT))
1034 goto out_fail;
1035
1036 if (!freerdp_settings_set_bool(settings, FreeRDP_SupportMonitorLayoutPdu, FALSE))
1037 goto out_fail;
1038
1039 if (!freerdp_settings_set_uint32(settings, FreeRDP_MonitorCount, 0))
1040 goto out_fail;
1041
1042 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_MonitorDefArray, nullptr, 32))
1043 goto out_fail;
1044
1045 if (!freerdp_settings_set_int32(settings, FreeRDP_MonitorLocalShiftX, 0))
1046 goto out_fail;
1047
1048 if (!freerdp_settings_set_int32(settings, FreeRDP_MonitorLocalShiftY, 0))
1049 goto out_fail;
1050
1051 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_MonitorIds, nullptr, 0))
1052 goto out_fail;
1053
1054 if (!freerdp_settings_set_uint32(settings, FreeRDP_MultitransportFlags,
1055 TRANSPORT_TYPE_UDP_FECR))
1056 goto out_fail;
1057 if (!freerdp_settings_set_bool(settings, FreeRDP_SupportMultitransport, TRUE))
1058 goto out_fail;
1059
1060 if (!settings_init_computer_name(settings))
1061 goto out_fail;
1062
1063 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_RdpServerCertificate, nullptr, 1))
1064 goto out_fail;
1065
1066 if (!freerdp_capability_buffer_resize(settings, 32, FALSE))
1067 goto out_fail;
1068
1069 {
1070 char tmp[32] = WINPR_C_ARRAY_INIT;
1071 if (!freerdp_settings_set_string_len(settings, FreeRDP_ClientProductId, tmp, sizeof(tmp)))
1072 goto out_fail;
1073 }
1074
1075 /* [MS-RDPBCGR] 2.2.7.1.5 Pointer Capability Set (TS_POINTER_CAPABILITYSET)
1076 *
1077 * if we are in server mode send a reasonable large cache size,
1078 * if we are in client mode just set the value to the maximum we want to
1079 * support and during capability exchange that size will be limited to the
1080 * sizes the server supports
1081 *
1082 * We have chosen 128 cursors in cache which is at worst 128 * 576kB (384x384 pixel cursor with
1083 * 32bit color depth)
1084 * */
1085 if (freerdp_settings_get_bool(settings, FreeRDP_ServerMode))
1086 {
1087 if (!freerdp_settings_set_uint32(settings, FreeRDP_PointerCacheSize, 25) ||
1088 !freerdp_settings_set_uint32(settings, FreeRDP_ColorPointerCacheSize, 25))
1089 goto out_fail;
1090 }
1091 else
1092 {
1093 if (!freerdp_settings_set_uint32(settings, FreeRDP_PointerCacheSize, 128) ||
1094 !freerdp_settings_set_uint32(settings, FreeRDP_ColorPointerCacheSize, 128))
1095 goto out_fail;
1096 }
1097
1098 if (!freerdp_settings_set_uint32(settings, FreeRDP_LargePointerFlag,
1099 (LARGE_POINTER_FLAG_96x96 | LARGE_POINTER_FLAG_384x384)) ||
1100 !freerdp_settings_set_bool(settings, FreeRDP_SoundBeepsEnabled, TRUE) ||
1101 !freerdp_settings_set_bool(settings, FreeRDP_DrawGdiPlusEnabled, FALSE) ||
1102 !freerdp_settings_set_bool(settings, FreeRDP_DrawAllowSkipAlpha, TRUE) ||
1103 !freerdp_settings_set_bool(settings, FreeRDP_DrawAllowColorSubsampling, FALSE) ||
1104 !freerdp_settings_set_bool(settings, FreeRDP_DrawAllowDynamicColorFidelity, TRUE) ||
1105 !freerdp_settings_set_bool(settings, FreeRDP_FrameMarkerCommandEnabled, TRUE) ||
1106 !freerdp_settings_set_bool(settings, FreeRDP_SurfaceFrameMarkerEnabled, TRUE) ||
1107 !freerdp_settings_set_bool(settings, FreeRDP_AllowCacheWaitingList, TRUE))
1108 goto out_fail;
1109
1110 const BITMAP_CACHE_V2_CELL_INFO CellInfo[5] = {
1111 { 600, FALSE }, { 600, FALSE }, { 65536, FALSE }, { 4096, FALSE }, { 2048, FALSE }
1112 };
1113 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_BitmapCacheV2CellInfo, CellInfo,
1114 ARRAYSIZE(CellInfo)))
1115 goto out_fail;
1116
1117 if (!freerdp_settings_set_bool(settings, FreeRDP_NoBitmapCompressionHeader, TRUE) ||
1118 !freerdp_settings_set_bool(settings, FreeRDP_RefreshRect, TRUE) ||
1119 !freerdp_settings_set_bool(settings, FreeRDP_SuppressOutput, TRUE) ||
1120 !freerdp_settings_set_uint32(settings, FreeRDP_GlyphSupportLevel, GLYPH_SUPPORT_NONE))
1121 goto out_fail;
1122 settings->GlyphCache = calloc(10, sizeof(GLYPH_CACHE_DEFINITION));
1123
1124 if (!settings->GlyphCache)
1125 goto out_fail;
1126
1127 settings->FragCache = calloc(1, sizeof(GLYPH_CACHE_DEFINITION));
1128
1129 if (!settings->FragCache)
1130 goto out_fail;
1131
1132 for (size_t x = 0; x < 10; x++)
1133 {
1134 GLYPH_CACHE_DEFINITION cache = WINPR_C_ARRAY_INIT;
1135 cache.cacheEntries = 254;
1136 switch (x)
1137 {
1138 case 0:
1139 case 1:
1140 cache.cacheMaximumCellSize = 4;
1141 break;
1142 case 2:
1143 case 3:
1144 cache.cacheMaximumCellSize = 8;
1145 break;
1146 case 4:
1147 cache.cacheMaximumCellSize = 16;
1148 break;
1149 case 5:
1150 cache.cacheMaximumCellSize = 32;
1151 break;
1152 case 6:
1153 cache.cacheMaximumCellSize = 64;
1154 break;
1155 case 7:
1156 cache.cacheMaximumCellSize = 128;
1157 break;
1158 case 8:
1159 cache.cacheMaximumCellSize = 256;
1160 break;
1161 case 9:
1162 cache.cacheMaximumCellSize = 256;
1163 break;
1164 default:
1165 goto out_fail;
1166 }
1167
1168 if (!freerdp_settings_set_pointer_array(settings, FreeRDP_GlyphCache, x, &cache))
1169 goto out_fail;
1170 }
1171 {
1172 GLYPH_CACHE_DEFINITION cache = WINPR_C_ARRAY_INIT;
1173 cache.cacheEntries = 256;
1174 cache.cacheMaximumCellSize = 256;
1175 if (!freerdp_settings_set_pointer_array(settings, FreeRDP_FragCache, 0, &cache))
1176 goto out_fail;
1177 }
1178 if (!freerdp_settings_set_uint32(settings, FreeRDP_OffscreenSupportLevel, 0) ||
1179 !freerdp_settings_set_uint32(settings, FreeRDP_OffscreenCacheSize, 7680) ||
1180 !freerdp_settings_set_uint32(settings, FreeRDP_OffscreenCacheEntries, 2000) ||
1181 !freerdp_settings_set_uint32(settings, FreeRDP_DrawNineGridCacheSize, 2560) ||
1182 !freerdp_settings_set_uint32(settings, FreeRDP_DrawNineGridCacheEntries, 256) ||
1183 !freerdp_settings_set_string(settings, FreeRDP_ClientDir, client_dll) ||
1184 !freerdp_settings_get_string(settings, FreeRDP_ClientDir) ||
1185 !freerdp_settings_set_uint32(settings, FreeRDP_RemoteWndSupportLevel,
1186 WINDOW_LEVEL_SUPPORTED | WINDOW_LEVEL_SUPPORTED_EX) ||
1187 !freerdp_settings_set_uint32(settings, FreeRDP_RemoteAppNumIconCaches, 3) ||
1188 !freerdp_settings_set_uint32(settings, FreeRDP_RemoteAppNumIconCacheEntries, 12) ||
1189 !freerdp_settings_set_uint32(settings, FreeRDP_VCChunkSize,
1190 (server && !remote) ? CHANNEL_CHUNK_MAX_LENGTH
1191 : CHANNEL_CHUNK_LENGTH) ||
1192 /* [MS-RDPBCGR] 2.2.7.2.7 Large Pointer Capability Set (TS_LARGE_POINTER_CAPABILITYSET)
1193 requires at least this size */
1194 !freerdp_settings_set_uint32(settings, FreeRDP_MultifragMaxRequestSize,
1195 server ? 0 : 608299) ||
1196 !freerdp_settings_set_bool(settings, FreeRDP_GatewayUseSameCredentials, FALSE) ||
1197 !freerdp_settings_set_bool(settings, FreeRDP_GatewayBypassLocal, FALSE) ||
1198 !freerdp_settings_set_bool(settings, FreeRDP_GatewayRpcTransport, TRUE) ||
1199 !freerdp_settings_set_bool(settings, FreeRDP_GatewayHttpTransport, TRUE) ||
1200 !freerdp_settings_set_bool(settings, FreeRDP_GatewayUdpTransport, TRUE) ||
1201 !freerdp_settings_set_bool(settings, FreeRDP_GatewayHttpUseWebsockets, TRUE) ||
1202 !freerdp_settings_set_bool(settings, FreeRDP_GatewayHttpExtAuthSspiNtlm, FALSE) ||
1203 !freerdp_settings_set_bool(settings, FreeRDP_GatewayArmTransport, FALSE) ||
1204 !freerdp_settings_set_bool(settings, FreeRDP_FastPathInput, TRUE) ||
1205 !freerdp_settings_set_bool(settings, FreeRDP_FastPathOutput, TRUE) ||
1206 !freerdp_settings_set_bool(settings, FreeRDP_LongCredentialsSupported, TRUE) ||
1207 !freerdp_settings_set_uint32(settings, FreeRDP_FrameAcknowledge, 2) ||
1208 !freerdp_settings_set_bool(settings, FreeRDP_MouseMotion, TRUE) ||
1209 !freerdp_settings_set_uint32(settings, FreeRDP_NSCodecColorLossLevel, 3) ||
1210 !freerdp_settings_set_bool(settings, FreeRDP_NSCodecAllowSubsampling, TRUE) ||
1211 !freerdp_settings_set_bool(settings, FreeRDP_NSCodecAllowDynamicColorFidelity, TRUE) ||
1212 !freerdp_settings_set_bool(settings, FreeRDP_AutoReconnectionEnabled, FALSE) ||
1213 !freerdp_settings_set_uint32(settings, FreeRDP_AutoReconnectMaxRetries, 20) ||
1214 !freerdp_settings_set_bool(settings, FreeRDP_GfxThinClient, FALSE) ||
1215 !freerdp_settings_set_bool(settings, FreeRDP_GfxSmallCache, TRUE) ||
1216 !freerdp_settings_set_bool(settings, FreeRDP_GfxProgressive, FALSE) ||
1217 !freerdp_settings_set_bool(settings, FreeRDP_GfxProgressiveV2, FALSE) ||
1218 !freerdp_settings_set_bool(settings, FreeRDP_GfxPlanar, TRUE) ||
1219 !freerdp_settings_set_bool(settings, FreeRDP_GfxH264, FALSE) ||
1220 !freerdp_settings_set_bool(settings, FreeRDP_GfxAVC444, FALSE) ||
1221 !freerdp_settings_set_bool(settings, FreeRDP_GfxCodecAV1, TRUE) ||
1222 !freerdp_settings_set_uint32(settings, FreeRDP_GfxCodecAV1Profile, 1) ||
1223 !freerdp_settings_set_bool(settings, FreeRDP_GfxSendQoeAck, FALSE) ||
1224 !freerdp_settings_set_bool(settings, FreeRDP_SupportDisplayControl, TRUE))
1225 goto out_fail;
1226 {
1227 ARC_CS_PRIVATE_PACKET cookie = WINPR_C_ARRAY_INIT;
1228 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ClientAutoReconnectCookie, &cookie,
1229 1))
1230 goto out_fail;
1231 }
1232 {
1233 ARC_SC_PRIVATE_PACKET cookie = WINPR_C_ARRAY_INIT;
1234 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ServerAutoReconnectCookie, &cookie,
1235 1))
1236 goto out_fail;
1237 }
1238
1239 settings->ClientTimeZone = (LPTIME_ZONE_INFORMATION)calloc(1, sizeof(TIME_ZONE_INFORMATION));
1240
1241 if (!settings->ClientTimeZone)
1242 goto out_fail;
1243
1244 if (!settings->ServerMode)
1245 {
1246 DYNAMIC_TIME_ZONE_INFORMATION dynamic = WINPR_C_ARRAY_INIT;
1248 freerdp_settings_get_pointer_writable(settings, FreeRDP_ClientTimeZone);
1249 WINPR_ASSERT(tz);
1250
1251 GetTimeZoneInformation(tz);
1252 GetDynamicTimeZoneInformation(&dynamic);
1253
1254 if (!freerdp_settings_set_string_from_utf16N(settings, FreeRDP_DynamicDSTTimeZoneKeyName,
1255 dynamic.TimeZoneKeyName,
1256 ARRAYSIZE(dynamic.TimeZoneKeyName)))
1257 goto out_fail;
1258
1259 if (!freerdp_settings_set_bool(settings, FreeRDP_DynamicDaylightTimeDisabled,
1260 dynamic.DynamicDaylightTimeDisabled))
1261 goto out_fail;
1262 }
1263
1264 if (!freerdp_settings_set_bool(settings, FreeRDP_TcpKeepAlive, TRUE) ||
1265 !freerdp_settings_set_uint32(settings, FreeRDP_TcpKeepAliveRetries, 3) ||
1266 !freerdp_settings_set_uint32(settings, FreeRDP_TcpKeepAliveDelay, 5) ||
1267 !freerdp_settings_set_uint32(settings, FreeRDP_TcpKeepAliveInterval, 2) ||
1268 !freerdp_settings_set_uint32(settings, FreeRDP_TcpAckTimeout, 9000) ||
1269 !freerdp_settings_set_uint32(settings, FreeRDP_TcpConnectTimeout, 15000))
1270 goto out_fail;
1271
1272 /* Bound for waiting on a gateway HTTP response (status/header phase and body phase each),
1273 * separate from FreeRDP_TcpConnectTimeout, which only bounds TCP connection establishment. */
1274 if (!freerdp_settings_set_uint32(settings, FreeRDP_GatewayResponseTimeout, 15000))
1275 goto out_fail;
1276
1277 if (!freerdp_settings_get_bool(settings, FreeRDP_ServerMode))
1278 {
1279 BOOL rc = FALSE;
1280 char* path = nullptr;
1281 if (!freerdp_settings_set_bool(settings, FreeRDP_RedirectClipboard, TRUE))
1282 goto out_fail;
1283 /* these values are used only by the client part */
1284 path = GetKnownPath(KNOWN_PATH_HOME);
1285 rc = freerdp_settings_set_string(settings, FreeRDP_HomePath, path);
1286 free(path);
1287
1288 if (!rc || !freerdp_settings_get_string(settings, FreeRDP_HomePath))
1289 goto out_fail;
1290
1291 char* config = freerdp_settings_get_config_path();
1292 rc = freerdp_settings_set_string(settings, FreeRDP_ConfigPath, config);
1293 if (rc)
1294 {
1295 char* action = GetCombinedPath(config, "action.sh");
1296 rc = freerdp_settings_set_string(settings, FreeRDP_ActionScript, action);
1297 free(action);
1298 }
1299
1300 free(config);
1301 if (!rc)
1302 goto out_fail;
1303 }
1304
1305 settings_load_hkey_local_machine(settings);
1306
1307 if (!freerdp_settings_set_bool(settings, FreeRDP_SmartcardLogon, FALSE))
1308 goto out_fail;
1309 if (!freerdp_settings_set_uint32(settings, FreeRDP_TlsSecLevel, FREERDP_TLS_SECLEVEL_112BIT))
1310 goto out_fail;
1311 settings->OrderSupport = calloc(1, 32);
1312
1313 if (!freerdp_settings_set_uint16(settings, FreeRDP_TLSMinVersion, TLS1_2_VERSION))
1314 goto out_fail;
1315 if (!freerdp_settings_set_uint16(settings, FreeRDP_TLSMaxVersion, 0))
1316 goto out_fail;
1317
1318 if (!settings->OrderSupport)
1319 goto out_fail;
1320
1321 if (!freerdp_settings_set_default_order_support(settings))
1322 goto out_fail;
1323
1324 {
1325 const BOOL enable = freerdp_settings_get_bool(settings, FreeRDP_ServerMode);
1326 {
1327 const FreeRDP_Settings_Keys_Bool keys[] = { FreeRDP_SupportGraphicsPipeline,
1328 FreeRDP_SupportStatusInfoPdu,
1329 FreeRDP_SupportErrorInfoPdu,
1330 FreeRDP_SupportAsymetricKeys };
1331
1332 for (size_t x = 0; x < ARRAYSIZE(keys); x++)
1333 {
1334 if (!freerdp_settings_set_bool(settings, keys[x], enable))
1335 goto out_fail;
1336 }
1337 }
1338 }
1339
1340 if (!freerdp_settings_set_bool(settings, FreeRDP_SupportDynamicTimeZone, TRUE))
1341 goto out_fail;
1342 if (!freerdp_settings_set_bool(settings, FreeRDP_SupportSkipChannelJoin, TRUE))
1343 goto out_fail;
1344
1345 UUID corrId = WINPR_C_ARRAY_INIT;
1346 if (UuidCreate(&corrId) != RPC_S_OK)
1347 goto out_fail;
1348
1349 char buffer[64] = WINPR_C_ARRAY_INIT;
1350 if (!freerdp_settings_set_string(settings, FreeRDP_CorrelationId,
1351 guid2str(&corrId, buffer, sizeof(buffer))))
1352 goto out_fail;
1353
1354 return settings;
1355out_fail:
1356 WINPR_PRAGMA_DIAG_PUSH
1357 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
1358 freerdp_settings_free(settings);
1359 WINPR_PRAGMA_DIAG_POP
1360 return nullptr;
1361}
1362
1363static void freerdp_settings_free_internal(rdpSettings* settings)
1364{
1365 freerdp_server_license_issuers_free(settings);
1366 freerdp_target_net_addresses_free(settings);
1367 freerdp_device_collection_free(settings);
1368 freerdp_static_channel_collection_free(settings);
1369 freerdp_dynamic_channel_collection_free(settings);
1370
1371 freerdp_capability_buffer_free(settings);
1372
1373 /* Free all strings, set other pointers nullptr */
1374 freerdp_settings_free_keys(settings, TRUE);
1375}
1376
1377static void freerdp_settings_free_internal_ensure_reset(rdpSettings* settings)
1378{
1379 settings->ServerLicenseProductIssuersCount = 0;
1380 settings->ServerLicenseProductIssuers = nullptr;
1381
1382 settings->ReceivedCapabilitiesSize = 0;
1383}
1384
1385void freerdp_settings_free(rdpSettings* settings)
1386{
1387 if (!settings)
1388 return;
1389
1390 freerdp_settings_free_internal(settings);
1391 free(settings);
1392}
1393
1394static BOOL freerdp_settings_int_buffer_copy(rdpSettings* dst, const rdpSettings* settings)
1395{
1396 BOOL rc = FALSE;
1397
1398 if (!dst || !settings)
1399 return FALSE;
1400
1401 typedef struct
1402 {
1403 FreeRDP_Settings_Keys_UInt32 lenKey;
1404 FreeRDP_Settings_Keys_Pointer pointerKey;
1405 } PointerDefs;
1406
1407 PointerDefs pointerDefs[] = {
1408 /* */
1409 { FreeRDP_LoadBalanceInfoLength, FreeRDP_LoadBalanceInfo },
1410 { FreeRDP_ServerRandomLength, FreeRDP_ServerRandom },
1411 { FreeRDP_ClientRandomLength, FreeRDP_ClientRandom },
1412 { FreeRDP_ServerCertificateLength, FreeRDP_ServerCertificate },
1413 { FreeRDP_ChannelDefArraySize, FreeRDP_ChannelDefArray },
1414 { FreeRDP_NumMonitorIds, FreeRDP_MonitorIds },
1415 { FreeRDP_BitmapCacheV2NumCells, FreeRDP_BitmapCacheV2CellInfo },
1416 { FreeRDP_RedirectionPasswordLength, FreeRDP_RedirectionPassword },
1417 { FreeRDP_RedirectionTsvUrlLength, FreeRDP_RedirectionTsvUrl },
1418 { FreeRDP_RedirectionGuidLength, FreeRDP_RedirectionGuid },
1419 { FreeRDP_MonitorDefArraySize, FreeRDP_MonitorDefArray }
1420 };
1421
1422 for (size_t i = 0; i < ARRAYSIZE(pointerDefs); i++)
1423 {
1424 const PointerDefs* keys = &pointerDefs[i];
1425 UINT32 n = freerdp_settings_get_uint32(settings, keys->lenKey);
1426
1427 const void* ptr = freerdp_settings_get_pointer(settings, keys->pointerKey);
1428 if (!freerdp_settings_set_pointer_len(dst, keys->pointerKey, ptr, n))
1429 goto out_fail;
1430 }
1431
1432 if (!freerdp_server_license_issuers_copy(dst, settings->ServerLicenseProductIssuers,
1433 settings->ServerLicenseProductIssuersCount))
1434 goto out_fail;
1435
1436 if (settings->RdpServerCertificate)
1437 {
1438 rdpCertificate* cert = freerdp_certificate_clone(settings->RdpServerCertificate);
1439 if (!cert)
1440 goto out_fail;
1441 if (!freerdp_settings_set_pointer_len(dst, FreeRDP_RdpServerCertificate, cert, 1))
1442 {
1443 freerdp_certificate_free(cert);
1444 goto out_fail;
1445 }
1446 }
1447 else
1448 {
1449 if (!freerdp_settings_set_pointer_len(dst, FreeRDP_RdpServerCertificate, nullptr, 0))
1450 goto out_fail;
1451 }
1452
1453 if (settings->RdpServerRsaKey)
1454 {
1455 rdpPrivateKey* key = freerdp_key_clone(settings->RdpServerRsaKey);
1456 if (!key)
1457 goto out_fail;
1458 if (!freerdp_settings_set_pointer_len(dst, FreeRDP_RdpServerRsaKey, key, 1))
1459 {
1460 freerdp_key_free(key);
1461 goto out_fail;
1462 }
1463 }
1464 else
1465 {
1466 if (!freerdp_settings_set_pointer_len(dst, FreeRDP_RdpServerRsaKey, nullptr, 0))
1467 goto out_fail;
1468 }
1469
1470 if (!freerdp_settings_set_uint32(dst, FreeRDP_ChannelCount,
1471 freerdp_settings_get_uint32(settings, FreeRDP_ChannelCount)))
1472 goto out_fail;
1473
1474 if (settings->OrderSupport)
1475 {
1476 dst->OrderSupport = calloc(32, sizeof(BYTE));
1477 if (!dst->OrderSupport)
1478 goto out_fail;
1479
1480 CopyMemory(dst->OrderSupport, settings->OrderSupport, 32);
1481 }
1482
1483 if (!freerdp_capability_buffer_copy(dst, settings))
1484 goto out_fail;
1485
1486 {
1487 const UINT32 glyphCacheCount = 10;
1488 const GLYPH_CACHE_DEFINITION* glyphCache =
1489 freerdp_settings_get_pointer(settings, FreeRDP_GlyphCache);
1490 if (!freerdp_settings_set_pointer_len(dst, FreeRDP_GlyphCache, glyphCache, glyphCacheCount))
1491 goto out_fail;
1492 }
1493
1494 {
1495 const UINT32 fragCacheCount = 1;
1496 const GLYPH_CACHE_DEFINITION* fragCache =
1497 freerdp_settings_get_pointer(settings, FreeRDP_FragCache);
1498 if (!freerdp_settings_set_pointer_len(dst, FreeRDP_FragCache, fragCache, fragCacheCount))
1499 goto out_fail;
1500 }
1501
1503 dst, FreeRDP_ClientAutoReconnectCookie,
1504 freerdp_settings_get_pointer(settings, FreeRDP_ClientAutoReconnectCookie), 1))
1505 goto out_fail;
1507 dst, FreeRDP_ServerAutoReconnectCookie,
1508 freerdp_settings_get_pointer(settings, FreeRDP_ServerAutoReconnectCookie), 1))
1509 goto out_fail;
1510
1511 {
1512 const TIME_ZONE_INFORMATION* tz =
1513 freerdp_settings_get_pointer(settings, FreeRDP_ClientTimeZone);
1514 if (!freerdp_settings_set_pointer_len(dst, FreeRDP_ClientTimeZone, tz, 1))
1515 goto out_fail;
1516 }
1517
1518 {
1519 const UINT32 nrports = freerdp_settings_get_uint32(settings, FreeRDP_TargetNetAddressCount);
1520 if (!freerdp_target_net_adresses_reset(dst, nrports))
1521 goto out_fail;
1522
1523 for (UINT32 i = 0; i < nrports; i++)
1524 {
1525 const char* address =
1526 freerdp_settings_get_pointer_array(settings, FreeRDP_TargetNetAddresses, i);
1527 const UINT32* port =
1528 freerdp_settings_get_pointer_array(settings, FreeRDP_TargetNetPorts, i);
1529
1530 if (!freerdp_settings_set_pointer_array(dst, FreeRDP_TargetNetAddresses, i, address))
1531 goto out_fail;
1532 if (!freerdp_settings_set_pointer_array(dst, FreeRDP_TargetNetPorts, i, port))
1533 goto out_fail;
1534 }
1535 }
1536
1537 {
1538 const UINT32 len = freerdp_settings_get_uint32(settings, FreeRDP_DeviceArraySize);
1539 const UINT32 count = freerdp_settings_get_uint32(settings, FreeRDP_DeviceCount);
1540
1541 if (len < count)
1542 goto out_fail;
1543 if (!freerdp_settings_set_pointer_len(dst, FreeRDP_DeviceArray, nullptr, len))
1544 goto out_fail;
1545 if (!freerdp_settings_set_uint32(dst, FreeRDP_DeviceCount, count))
1546 goto out_fail;
1547
1548 for (size_t index = 0; index < count; index++)
1549 {
1550 const RDPDR_DEVICE* argv =
1551 freerdp_settings_get_pointer_array(settings, FreeRDP_DeviceArray, index);
1552 WINPR_ASSERT(argv);
1553 if (!freerdp_settings_set_pointer_array(dst, FreeRDP_DeviceArray, index, argv))
1554 goto out_fail;
1555 }
1556 WINPR_ASSERT(dst->DeviceArray || (len == 0));
1557 WINPR_ASSERT(len >= count);
1558 }
1559 {
1560 const UINT32 len = freerdp_settings_get_uint32(dst, FreeRDP_StaticChannelArraySize);
1561 const UINT32 count = freerdp_settings_get_uint32(settings, FreeRDP_StaticChannelCount);
1562
1563 if (len < count)
1564 goto out_fail;
1565 if (!freerdp_settings_set_pointer_len(dst, FreeRDP_StaticChannelArray, nullptr, len))
1566 goto out_fail;
1567 if (!freerdp_settings_set_uint32(dst, FreeRDP_StaticChannelCount, count))
1568 goto out_fail;
1569
1570 for (size_t index = 0; index < count; index++)
1571 {
1572 const ADDIN_ARGV* argv =
1573 freerdp_settings_get_pointer_array(settings, FreeRDP_StaticChannelArray, index);
1574 WINPR_ASSERT(argv);
1575 if (!freerdp_settings_set_pointer_array(dst, FreeRDP_StaticChannelArray, index, argv))
1576 goto out_fail;
1577 }
1578 }
1579 {
1580 const UINT32 len = freerdp_settings_get_uint32(dst, FreeRDP_DynamicChannelArraySize);
1581 const UINT32 count = freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelCount);
1582
1583 if (len < count)
1584 goto out_fail;
1585 if (!freerdp_settings_set_pointer_len(dst, FreeRDP_DynamicChannelArray, nullptr, len))
1586 goto out_fail;
1587 if (!freerdp_settings_set_uint32(dst, FreeRDP_DynamicChannelCount, count))
1588 goto out_fail;
1589
1590 for (size_t index = 0; index < count; index++)
1591 {
1592 const ADDIN_ARGV* argv =
1593 freerdp_settings_get_pointer_array(settings, FreeRDP_DynamicChannelArray, index);
1594 WINPR_ASSERT(argv);
1595 if (!freerdp_settings_set_pointer_array(dst, FreeRDP_DynamicChannelArray, index, argv))
1596 goto out_fail;
1597 }
1598 }
1599
1600 rc = freerdp_settings_set_string(dst, FreeRDP_ActionScript,
1601 freerdp_settings_get_string(settings, FreeRDP_ActionScript));
1602
1603out_fail:
1604 return rc;
1605}
1606
1607BOOL freerdp_settings_copy(rdpSettings* dst, const rdpSettings* src)
1608{
1609 BOOL rc = 0;
1610
1611 if (!dst || !src)
1612 return FALSE;
1613
1614 /* This is required to free all non string buffers */
1615 freerdp_settings_free_internal(dst);
1616
1617 /* This copies everything except allocated non string buffers. reset all allocated buffers to
1618 * nullptr to fix issues during cleanup */
1619 rc = freerdp_settings_clone_keys(dst, src);
1620 if (!rc)
1621 goto out_fail;
1622 freerdp_settings_free_internal_ensure_reset(dst);
1623
1624 /* Begin copying */
1625 if (!freerdp_settings_int_buffer_copy(dst, src))
1626 goto out_fail;
1627 return TRUE;
1628out_fail:
1629 freerdp_settings_free_internal(dst);
1630 return FALSE;
1631}
1632
1633rdpSettings* freerdp_settings_clone(const rdpSettings* settings)
1634{
1635 rdpSettings* dst = (rdpSettings*)calloc(1, sizeof(rdpSettings));
1636
1637 if (!freerdp_settings_copy(dst, settings))
1638 goto out_fail;
1639
1640 return dst;
1641out_fail:
1642 WINPR_PRAGMA_DIAG_PUSH
1643 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
1645 WINPR_PRAGMA_DIAG_POP
1646 return nullptr;
1647}
1648#ifdef _MSC_VER
1649#pragma warning(pop)
1650#endif
1651
1652BOOL identity_set_from_settings_with_pwd(SEC_WINNT_AUTH_IDENTITY* identity,
1653 const rdpSettings* settings,
1654 FreeRDP_Settings_Keys_String UserId,
1655 FreeRDP_Settings_Keys_String DomainId,
1656 const WCHAR* Password, size_t pwdLen)
1657{
1658 WINPR_ASSERT(identity);
1659 WINPR_ASSERT(settings);
1660
1661 size_t UserLen = 0;
1662 size_t DomainLen = 0;
1663
1664 WCHAR* Username = freerdp_settings_get_string_as_utf16(settings, UserId, &UserLen);
1665 WCHAR* Domain = freerdp_settings_get_string_as_utf16(settings, DomainId, &DomainLen);
1666
1667 const int rc = sspi_SetAuthIdentityWithLengthW(identity, Username, UserLen, Domain, DomainLen,
1668 Password, pwdLen);
1669 winpr_znfree(Username, UserLen * sizeof(WCHAR));
1670 winpr_znfree(Domain, DomainLen * sizeof(WCHAR));
1671 return (rc >= 0);
1672}
1673
1674BOOL identity_set_from_settings(SEC_WINNT_AUTH_IDENTITY_W* identity, const rdpSettings* settings,
1675 FreeRDP_Settings_Keys_String UserId,
1676 FreeRDP_Settings_Keys_String DomainId,
1677 FreeRDP_Settings_Keys_String PwdId)
1678{
1679 WINPR_ASSERT(identity);
1680 WINPR_ASSERT(settings);
1681
1682 size_t PwdLen = 0;
1683
1684 WCHAR* Password = freerdp_settings_get_string_as_utf16(settings, PwdId, &PwdLen);
1685
1686 const BOOL rc =
1687 identity_set_from_settings_with_pwd(identity, settings, UserId, DomainId, Password, PwdLen);
1688 winpr_znfree(Password, PwdLen * sizeof(WCHAR));
1689 return rc;
1690}
1691
1692BOOL identity_set_from_smartcard_hash(SEC_WINNT_AUTH_IDENTITY_W* identity,
1693 const rdpSettings* settings,
1694 FreeRDP_Settings_Keys_String userId,
1695 FreeRDP_Settings_Keys_String domainId,
1696 FreeRDP_Settings_Keys_String pwdId,
1697 WINPR_ATTR_UNUSED const BYTE* certSha1,
1698 WINPR_ATTR_UNUSED size_t sha1len)
1699{
1700#ifdef _WIN32
1701 CERT_CREDENTIAL_INFO certInfo = { sizeof(CERT_CREDENTIAL_INFO), WINPR_C_ARRAY_INIT };
1702 LPWSTR marshalledCredentials = nullptr;
1703
1704 memcpy(certInfo.rgbHashOfCert, certSha1, MIN(sha1len, sizeof(certInfo.rgbHashOfCert)));
1705
1706 if (!CredMarshalCredentialW(CertCredential, &certInfo, &marshalledCredentials))
1707 {
1708 WLog_ERR(TAG, "error marshalling cert credentials");
1709 return FALSE;
1710 }
1711
1712 size_t pwdLen = 0;
1713 WCHAR* Password = freerdp_settings_get_string_as_utf16(settings, pwdId, &pwdLen);
1714 const int rc = sspi_SetAuthIdentityWithLengthW(identity, marshalledCredentials,
1715 _wcslen(marshalledCredentials), nullptr, 0,
1716 Password, pwdLen);
1717 winpr_znfree(Password, pwdLen * sizeof(WCHAR));
1718 CredFree(marshalledCredentials);
1719 return (rc >= 0);
1720#else
1721 return identity_set_from_settings(identity, settings, userId, domainId, pwdId);
1722#endif /* _WIN32 */
1723}
1724
1725const char* freerdp_settings_glyph_level_string(UINT32 level, char* buffer, size_t size)
1726{
1727 const char* str = "GLYPH_SUPPORT_UNKNOWN";
1728 switch (level)
1729 {
1730 case GLYPH_SUPPORT_NONE:
1731 str = "GLYPH_SUPPORT_NONE";
1732 break;
1733 case GLYPH_SUPPORT_PARTIAL:
1734 str = "GLYPH_SUPPORT_PARTIAL";
1735 break;
1736 case GLYPH_SUPPORT_FULL:
1737 str = "GLYPH_SUPPORT_FULL";
1738 break;
1739 case GLYPH_SUPPORT_ENCODE:
1740 str = "GLYPH_SUPPORT_ENCODE";
1741 break;
1742 default:
1743 break;
1744 }
1745
1746 (void)_snprintf(buffer, size, "%s[0x%08" PRIx32 "]", str, level);
1747 return buffer;
1748}
1749
1750BOOL freerdp_target_net_adresses_reset(rdpSettings* settings, size_t size)
1751{
1752 freerdp_target_net_addresses_free(settings);
1753
1754 return freerdp_target_net_addresses_resize(settings, size);
1755}
1756
1757BOOL freerdp_settings_enforce_monitor_exists(rdpSettings* settings)
1758{
1759 const UINT32 count = freerdp_settings_get_uint32(settings, FreeRDP_MonitorCount);
1760 const BOOL fullscreen = freerdp_settings_get_bool(settings, FreeRDP_Fullscreen);
1761 const BOOL multimon = freerdp_settings_get_bool(settings, FreeRDP_UseMultimon);
1762 const BOOL useMonitors = fullscreen || multimon;
1763
1764 const UINT32 size = freerdp_settings_get_uint32(settings, FreeRDP_MonitorDefArraySize);
1765 if (size == 0)
1766 {
1767 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_MonitorDefArray, nullptr, 16))
1768 return FALSE;
1769 }
1770
1771 if (!useMonitors || (count == 0))
1772 {
1773 const UINT32 width = freerdp_settings_get_uint32(settings, FreeRDP_DesktopWidth);
1774 const UINT32 height = freerdp_settings_get_uint32(settings, FreeRDP_DesktopHeight);
1775 const UINT32 pwidth = freerdp_settings_get_uint32(settings, FreeRDP_DesktopPhysicalWidth);
1776 const UINT32 pheight = freerdp_settings_get_uint32(settings, FreeRDP_DesktopPhysicalHeight);
1777 const UINT16 orientation =
1778 freerdp_settings_get_uint16(settings, FreeRDP_DesktopOrientation);
1779 const UINT32 desktopScaleFactor =
1780 freerdp_settings_get_uint32(settings, FreeRDP_DeviceScaleFactor);
1781 const UINT32 deviceScaleFactor =
1782 freerdp_settings_get_uint32(settings, FreeRDP_DesktopScaleFactor);
1783
1784 if (!freerdp_settings_set_uint32(settings, FreeRDP_MonitorCount, 1))
1785 return FALSE;
1786
1787 rdpMonitor monitor = WINPR_C_ARRAY_INIT;
1788 monitor.x = 0;
1789 monitor.y = 0;
1790 monitor.width = WINPR_ASSERTING_INT_CAST(int32_t, width);
1791 monitor.height = WINPR_ASSERTING_INT_CAST(int32_t, height);
1792 monitor.is_primary = TRUE;
1793 monitor.orig_screen = 0;
1794 monitor.attributes.physicalWidth = pwidth;
1795 monitor.attributes.physicalHeight = pheight;
1796 monitor.attributes.orientation = orientation;
1797 monitor.attributes.desktopScaleFactor = desktopScaleFactor;
1798 monitor.attributes.deviceScaleFactor = deviceScaleFactor;
1799 if (!freerdp_settings_set_monitor_def_array_sorted(settings, &monitor, 1))
1800 return FALSE;
1801 }
1802
1803 return TRUE;
1804}
1805
1806void freerdp_settings_sanitize_keyboard_type(wLog* log, rdpSettings* settings, const char* source)
1807{
1808 WINPR_ASSERT(settings);
1809
1810 switch (settings->KeyboardType)
1811 {
1812 case WINPR_KBD_TYPE_IBM_PC_XT:
1813 case WINPR_KBD_TYPE_OLIVETTI_ICO:
1814 case WINPR_KBD_TYPE_IBM_PC_AT:
1815 case WINPR_KBD_TYPE_IBM_ENHANCED:
1816 case WINPR_KBD_TYPE_NOKIA_1050:
1817 case WINPR_KBD_TYPE_NOKIA_9140:
1818 case WINPR_KBD_TYPE_JAPANESE:
1819 case WINPR_KBD_TYPE_KOREAN:
1820 return;
1821 default:
1822 break;
1823 }
1824
1825 if (!log)
1826 log = WLog_Get(TAG);
1827 WLog_Print(log, WLOG_WARN,
1828 "%s: KeyboardType=0x%08" PRIx32
1829 " is not a known WINPR_KBD_TYPE, using WINPR_KBD_TYPE_IBM_ENHANCED instead",
1830 source ? source : "settings", settings->KeyboardType);
1831 settings->KeyboardType = WINPR_KBD_TYPE_IBM_ENHANCED;
1832}
1833
1834BOOL freerdp_settings_enforce_consistency(rdpSettings* settings)
1835{
1836 if (freerdp_settings_get_bool(settings, FreeRDP_BitmapCacheV3Enabled))
1837 {
1838 settings->OrderSupportFlagsEx |= CACHE_BITMAP_V3_SUPPORT;
1839 settings->OrderSupportFlags |= ORDER_FLAGS_EXTRA_SUPPORT;
1840 }
1841
1842 if (settings->FrameMarkerCommandEnabled)
1843 {
1844 settings->OrderSupportFlagsEx |= ALTSEC_FRAME_MARKER_SUPPORT;
1845 settings->OrderSupportFlags |= ORDER_FLAGS_EXTRA_SUPPORT;
1846 }
1847 return TRUE;
1848}
WINPR_ATTR_NODISCARD FREERDP_API const void * freerdp_settings_get_pointer(const rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id)
Returns a immutable pointer settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_string_from_utf16N(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const WCHAR *param, size_t length)
Sets a string settings value. The param is converted to UTF-8 and the copy stored.
rdpSettings * freerdp_settings_new(DWORD flags)
creates a new setting struct
rdpSettings * freerdp_settings_clone(const rdpSettings *settings)
Creates a deep copy of settings.
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings *settings, FreeRDP_Settings_Keys_Bool id, BOOL val)
Sets a BOOL settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_string_len(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val, size_t len)
Sets a string settings value. The val is copied.
char * freerdp_settings_get_config_path(void)
return the configuration directory for the library
WINPR_ATTR_NODISCARD FREERDP_API void * freerdp_settings_get_pointer_writable(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id)
Returns a mutable pointer settings value.
WINPR_ATTR_NODISCARD FREERDP_API UINT16 freerdp_settings_get_uint16(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt16 id)
Returns a UINT16 settings value.
BOOL freerdp_settings_copy(rdpSettings *dst, const rdpSettings *src)
Deep copies settings from src to dst.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 val)
Sets a UINT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_pointer_len(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id, const void *data, size_t len)
Set a pointer to value data.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_int32(rdpSettings *settings, FreeRDP_Settings_Keys_Int32 id, INT32 val)
Sets a INT32 settings value.
void freerdp_settings_free(rdpSettings *settings)
Free a settings struct with all data in it.
#define FREERDP_SETTINGS_SERVER_MODE
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
FREERDP_API WCHAR * freerdp_settings_get_string_as_utf16(const rdpSettings *settings, FreeRDP_Settings_Keys_String id, size_t *pCharLen)
Return an allocated UTF16 string.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_uint16(rdpSettings *settings, FreeRDP_Settings_Keys_UInt16 id, UINT16 val)
Sets a UINT16 settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_monitor_def_array_sorted(rdpSettings *settings, const rdpMonitor *monitors, size_t count)
Sort monitor array according to:
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val)
Sets a string settings value. The param is copied.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
Definition wtypes.h:263