23#include "rail_common.h"
26#include <freerdp/channels/log.h>
28#define TAG CHANNELS_TAG("rail.common")
30const char* rail_get_order_type_string(UINT16 orderType)
34 case TS_RAIL_ORDER_EXEC:
35 return "TS_RAIL_ORDER_EXEC";
36 case TS_RAIL_ORDER_ACTIVATE:
37 return "TS_RAIL_ORDER_ACTIVATE";
38 case TS_RAIL_ORDER_SYSPARAM:
39 return "TS_RAIL_ORDER_SYSPARAM";
40 case TS_RAIL_ORDER_SYSCOMMAND:
41 return "TS_RAIL_ORDER_SYSCOMMAND";
42 case TS_RAIL_ORDER_HANDSHAKE:
43 return "TS_RAIL_ORDER_HANDSHAKE";
44 case TS_RAIL_ORDER_NOTIFY_EVENT:
45 return "TS_RAIL_ORDER_NOTIFY_EVENT";
46 case TS_RAIL_ORDER_WINDOWMOVE:
47 return "TS_RAIL_ORDER_WINDOWMOVE";
48 case TS_RAIL_ORDER_LOCALMOVESIZE:
49 return "TS_RAIL_ORDER_LOCALMOVESIZE";
50 case TS_RAIL_ORDER_MINMAXINFO:
51 return "TS_RAIL_ORDER_MINMAXINFO";
52 case TS_RAIL_ORDER_CLIENTSTATUS:
53 return "TS_RAIL_ORDER_CLIENTSTATUS";
54 case TS_RAIL_ORDER_SYSMENU:
55 return "TS_RAIL_ORDER_SYSMENU";
56 case TS_RAIL_ORDER_LANGBARINFO:
57 return "TS_RAIL_ORDER_LANGBARINFO";
58 case TS_RAIL_ORDER_GET_APPID_REQ:
59 return "TS_RAIL_ORDER_GET_APPID_REQ";
60 case TS_RAIL_ORDER_GET_APPID_RESP:
61 return "TS_RAIL_ORDER_GET_APPID_RESP";
62 case TS_RAIL_ORDER_TASKBARINFO:
63 return "TS_RAIL_ORDER_TASKBARINFO";
64 case TS_RAIL_ORDER_LANGUAGEIMEINFO:
65 return "TS_RAIL_ORDER_LANGUAGEIMEINFO";
66 case TS_RAIL_ORDER_COMPARTMENTINFO:
67 return "TS_RAIL_ORDER_COMPARTMENTINFO";
68 case TS_RAIL_ORDER_HANDSHAKE_EX:
69 return "TS_RAIL_ORDER_HANDSHAKE_EX";
70 case TS_RAIL_ORDER_ZORDER_SYNC:
71 return "TS_RAIL_ORDER_ZORDER_SYNC";
72 case TS_RAIL_ORDER_CLOAK:
73 return "TS_RAIL_ORDER_CLOAK";
74 case TS_RAIL_ORDER_POWER_DISPLAY_REQUEST:
75 return "TS_RAIL_ORDER_POWER_DISPLAY_REQUEST";
76 case TS_RAIL_ORDER_SNAP_ARRANGE:
77 return "TS_RAIL_ORDER_SNAP_ARRANGE";
78 case TS_RAIL_ORDER_GET_APPID_RESP_EX:
79 return "TS_RAIL_ORDER_GET_APPID_RESP_EX";
80 case TS_RAIL_ORDER_EXEC_RESULT:
81 return "TS_RAIL_ORDER_EXEC_RESULT";
82 case TS_RAIL_ORDER_TEXTSCALEINFO:
83 return "TS_RAIL_ORDER_TEXTSCALEINFO";
84 case TS_RAIL_ORDER_CARETBLINKINFO:
85 return "TS_RAIL_ORDER_CARETBLINKINFO";
87 return "TS_RAIL_ORDER_UNKNOWN";
91const char* rail_get_order_type_string_full(UINT16 orderType,
char* buffer,
size_t length)
93 (void)_snprintf(buffer, length,
"%s[0x%04" PRIx16
"]", rail_get_order_type_string(orderType),
103UINT rail_read_pdu_header(
wStream* s, UINT16* orderType, UINT16* orderLength)
105 if (!s || !orderType || !orderLength)
106 return ERROR_INVALID_PARAMETER;
108 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
109 return ERROR_INVALID_DATA;
111 Stream_Read_UINT16(s, *orderType);
112 Stream_Read_UINT16(s, *orderLength);
113 return CHANNEL_RC_OK;
116BOOL rail_write_pdu_header(
wStream* s, UINT16 orderType, UINT16 orderLength)
118 if (!Stream_EnsureRemainingCapacity(s, 4))
120 Stream_Write_UINT16(s, orderType);
121 Stream_Write_UINT16(s, orderLength);
125wStream* rail_pdu_init(
size_t length)
127 wStream* s = Stream_New(
nullptr, length + RAIL_PDU_HEADER_LENGTH);
132 Stream_Seek(s, RAIL_PDU_HEADER_LENGTH);
143 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
144 return ERROR_INVALID_DATA;
146 Stream_Read_UINT32(s, handshake->buildNumber);
147 return CHANNEL_RC_OK;
153 WINPR_ASSERT(handshake);
154 WINPR_ASSERT(Stream_EnsureRemainingCapacity(s, 4));
155 Stream_Write_UINT32(s, handshake->buildNumber);
165 if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
166 return ERROR_INVALID_DATA;
168 Stream_Read_UINT32(s, handshakeEx->buildNumber);
169 Stream_Read_UINT32(s, handshakeEx->railHandshakeFlags);
170 return CHANNEL_RC_OK;
176 WINPR_ASSERT(handshakeEx);
177 WINPR_ASSERT(Stream_EnsureRemainingCapacity(s, 8));
179 Stream_Write_UINT32(s, handshakeEx->buildNumber);
180 Stream_Write_UINT32(s, handshakeEx->railHandshakeFlags);
190 if (!s || !unicode_string)
191 return ERROR_INVALID_PARAMETER;
193 if (!Stream_EnsureRemainingCapacity(s, 2 + unicode_string->length))
195 WLog_ERR(TAG,
"Stream_EnsureRemainingCapacity failed!");
196 return CHANNEL_RC_NO_MEMORY;
199 Stream_Write_UINT16(s, unicode_string->length);
200 Stream_Write(s, unicode_string->string, unicode_string->length);
201 return CHANNEL_RC_OK;
213 if (!s || !unicode_string)
214 return ERROR_INVALID_PARAMETER;
216 length = unicode_string->length;
220 if (!Stream_EnsureRemainingCapacity(s, length))
222 WLog_ERR(TAG,
"Stream_EnsureRemainingCapacity failed!");
223 return CHANNEL_RC_NO_MEMORY;
226 Stream_Write(s, unicode_string->string, length);
229 return CHANNEL_RC_OK;
239 if (!s || !highContrast)
240 return ERROR_INVALID_PARAMETER;
242 if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
243 return ERROR_INVALID_DATA;
245 Stream_Read_UINT32(s, highContrast->flags);
246 Stream_Read_UINT32(s, highContrast->colorSchemeLength);
248 if (!rail_read_unicode_string(s, &highContrast->colorScheme))
249 return ERROR_INTERNAL_ERROR;
250 return CHANNEL_RC_OK;
260 UINT32 colorSchemeLength = 0;
262 if (!s || !highContrast)
263 return ERROR_INVALID_PARAMETER;
265 if (!Stream_EnsureRemainingCapacity(s, 8))
266 return CHANNEL_RC_NO_MEMORY;
268 colorSchemeLength = highContrast->colorScheme.length + 2;
269 Stream_Write_UINT32(s, highContrast->flags);
270 Stream_Write_UINT32(s, colorSchemeLength);
271 return rail_write_unicode_string(s, &highContrast->colorScheme);
281 if (!s || !filterKeys)
282 return ERROR_INVALID_PARAMETER;
284 if (!Stream_CheckAndLogRequiredLength(TAG, s, 20))
285 return ERROR_INVALID_DATA;
287 Stream_Read_UINT32(s, filterKeys->Flags);
288 Stream_Read_UINT32(s, filterKeys->WaitTime);
289 Stream_Read_UINT32(s, filterKeys->DelayTime);
290 Stream_Read_UINT32(s, filterKeys->RepeatTime);
291 Stream_Read_UINT32(s, filterKeys->BounceTime);
292 return CHANNEL_RC_OK;
302 if (!s || !filterKeys)
303 return ERROR_INVALID_PARAMETER;
305 if (!Stream_EnsureRemainingCapacity(s, 20))
306 return CHANNEL_RC_NO_MEMORY;
308 Stream_Write_UINT32(s, filterKeys->Flags);
309 Stream_Write_UINT32(s, filterKeys->WaitTime);
310 Stream_Write_UINT32(s, filterKeys->DelayTime);
311 Stream_Write_UINT32(s, filterKeys->RepeatTime);
312 Stream_Write_UINT32(s, filterKeys->BounceTime);
313 return CHANNEL_RC_OK;
324 UINT error = CHANNEL_RC_OK;
327 return ERROR_INVALID_PARAMETER;
329 if (!Stream_CheckAndLogRequiredLength(TAG, s, 5))
330 return ERROR_INVALID_DATA;
332 Stream_Read_UINT32(s, sysparam->param);
334 sysparam->params = 0;
336 switch (sysparam->param)
339 case SPI_SET_DRAG_FULL_WINDOWS:
340 sysparam->params |= SPI_MASK_SET_DRAG_FULL_WINDOWS;
341 Stream_Read_UINT8(s, body);
342 sysparam->dragFullWindows = body != 0;
345 case SPI_SET_KEYBOARD_CUES:
346 sysparam->params |= SPI_MASK_SET_KEYBOARD_CUES;
347 Stream_Read_UINT8(s, body);
348 sysparam->keyboardCues = body != 0;
351 case SPI_SET_KEYBOARD_PREF:
352 sysparam->params |= SPI_MASK_SET_KEYBOARD_PREF;
353 Stream_Read_UINT8(s, body);
354 sysparam->keyboardPref = body != 0;
357 case SPI_SET_MOUSE_BUTTON_SWAP:
358 sysparam->params |= SPI_MASK_SET_MOUSE_BUTTON_SWAP;
359 Stream_Read_UINT8(s, body);
360 sysparam->mouseButtonSwap = body != 0;
363 case SPI_SET_WORK_AREA:
364 sysparam->params |= SPI_MASK_SET_WORK_AREA;
366 if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
367 return ERROR_INVALID_DATA;
369 Stream_Read_UINT16(s, sysparam->workArea.left);
370 Stream_Read_UINT16(s, sysparam->workArea.top);
371 Stream_Read_UINT16(s, sysparam->workArea.right);
372 Stream_Read_UINT16(s, sysparam->workArea.bottom);
375 case SPI_DISPLAY_CHANGE:
376 sysparam->params |= SPI_MASK_DISPLAY_CHANGE;
378 if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
379 return ERROR_INVALID_DATA;
381 Stream_Read_UINT16(s, sysparam->displayChange.left);
382 Stream_Read_UINT16(s, sysparam->displayChange.top);
383 Stream_Read_UINT16(s, sysparam->displayChange.right);
384 Stream_Read_UINT16(s, sysparam->displayChange.bottom);
387 case SPI_TASKBAR_POS:
388 sysparam->params |= SPI_MASK_TASKBAR_POS;
390 if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
391 return ERROR_INVALID_DATA;
393 Stream_Read_UINT16(s, sysparam->taskbarPos.left);
394 Stream_Read_UINT16(s, sysparam->taskbarPos.top);
395 Stream_Read_UINT16(s, sysparam->taskbarPos.right);
396 Stream_Read_UINT16(s, sysparam->taskbarPos.bottom);
399 case SPI_SET_HIGH_CONTRAST:
400 sysparam->params |= SPI_MASK_SET_HIGH_CONTRAST;
401 if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
402 return ERROR_INVALID_DATA;
404 error = rail_read_high_contrast(s, &sysparam->highContrast);
407 case SPI_SETCARETWIDTH:
408 sysparam->params |= SPI_MASK_SET_CARET_WIDTH;
410 if (!extendedSpiSupported)
411 return ERROR_INVALID_DATA;
413 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
414 return ERROR_INVALID_DATA;
416 Stream_Read_UINT32(s, sysparam->caretWidth);
418 if (sysparam->caretWidth < 0x0001)
419 return ERROR_INVALID_DATA;
423 case SPI_SETSTICKYKEYS:
424 sysparam->params |= SPI_MASK_SET_STICKY_KEYS;
426 if (!extendedSpiSupported)
427 return ERROR_INVALID_DATA;
429 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
430 return ERROR_INVALID_DATA;
432 Stream_Read_UINT32(s, sysparam->stickyKeys);
435 case SPI_SETTOGGLEKEYS:
436 sysparam->params |= SPI_MASK_SET_TOGGLE_KEYS;
438 if (!extendedSpiSupported)
439 return ERROR_INVALID_DATA;
441 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
442 return ERROR_INVALID_DATA;
444 Stream_Read_UINT32(s, sysparam->toggleKeys);
447 case SPI_SETFILTERKEYS:
448 sysparam->params |= SPI_MASK_SET_FILTER_KEYS;
450 if (!extendedSpiSupported)
451 return ERROR_INVALID_DATA;
453 if (!Stream_CheckAndLogRequiredLength(TAG, s, 20))
454 return ERROR_INVALID_DATA;
456 error = rail_read_filterkeys(s, &sysparam->filterKeys);
460 case SPI_SETSCREENSAVEACTIVE:
461 sysparam->params |= SPI_MASK_SET_SCREEN_SAVE_ACTIVE;
463 Stream_Read_UINT8(s, body);
464 sysparam->setScreenSaveActive = body != 0;
467 case SPI_SETSCREENSAVESECURE:
468 sysparam->params |= SPI_MASK_SET_SET_SCREEN_SAVE_SECURE;
470 Stream_Read_UINT8(s, body);
471 sysparam->setScreenSaveSecure = body != 0;
482 BOOL extendedSpiSupported)
485 UINT error = CHANNEL_RC_OK;
488 return ERROR_INVALID_PARAMETER;
490 if (!Stream_EnsureRemainingCapacity(s, 12))
491 return CHANNEL_RC_NO_MEMORY;
493 Stream_Write_UINT32(s, sysparam->param);
495 switch (sysparam->param)
498 case SPI_SET_DRAG_FULL_WINDOWS:
499 body = sysparam->dragFullWindows ? 1 : 0;
500 Stream_Write_UINT8(s, body);
503 case SPI_SET_KEYBOARD_CUES:
504 body = sysparam->keyboardCues ? 1 : 0;
505 Stream_Write_UINT8(s, body);
508 case SPI_SET_KEYBOARD_PREF:
509 body = sysparam->keyboardPref ? 1 : 0;
510 Stream_Write_UINT8(s, body);
513 case SPI_SET_MOUSE_BUTTON_SWAP:
514 body = sysparam->mouseButtonSwap ? 1 : 0;
515 Stream_Write_UINT8(s, body);
518 case SPI_SET_WORK_AREA:
519 Stream_Write_UINT16(s, sysparam->workArea.left);
520 Stream_Write_UINT16(s, sysparam->workArea.top);
521 Stream_Write_UINT16(s, sysparam->workArea.right);
522 Stream_Write_UINT16(s, sysparam->workArea.bottom);
525 case SPI_DISPLAY_CHANGE:
526 Stream_Write_UINT16(s, sysparam->displayChange.left);
527 Stream_Write_UINT16(s, sysparam->displayChange.top);
528 Stream_Write_UINT16(s, sysparam->displayChange.right);
529 Stream_Write_UINT16(s, sysparam->displayChange.bottom);
532 case SPI_TASKBAR_POS:
533 Stream_Write_UINT16(s, sysparam->taskbarPos.left);
534 Stream_Write_UINT16(s, sysparam->taskbarPos.top);
535 Stream_Write_UINT16(s, sysparam->taskbarPos.right);
536 Stream_Write_UINT16(s, sysparam->taskbarPos.bottom);
539 case SPI_SET_HIGH_CONTRAST:
540 error = rail_write_high_contrast(s, &sysparam->highContrast);
543 case SPI_SETCARETWIDTH:
544 if (!extendedSpiSupported)
545 return ERROR_INVALID_DATA;
547 if (sysparam->caretWidth < 0x0001)
548 return ERROR_INVALID_DATA;
550 Stream_Write_UINT32(s, sysparam->caretWidth);
553 case SPI_SETSTICKYKEYS:
554 if (!extendedSpiSupported)
555 return ERROR_INVALID_DATA;
557 Stream_Write_UINT32(s, sysparam->stickyKeys);
560 case SPI_SETTOGGLEKEYS:
561 if (!extendedSpiSupported)
562 return ERROR_INVALID_DATA;
564 Stream_Write_UINT32(s, sysparam->toggleKeys);
567 case SPI_SETFILTERKEYS:
568 if (!extendedSpiSupported)
569 return ERROR_INVALID_DATA;
571 error = rail_write_filterkeys(s, &sysparam->filterKeys);
575 case SPI_SETSCREENSAVEACTIVE:
576 body = sysparam->setScreenSaveActive ? 1 : 0;
577 Stream_Write_UINT8(s, body);
580 case SPI_SETSCREENSAVESECURE:
581 body = sysparam->setScreenSaveSecure ? 1 : 0;
582 Stream_Write_UINT8(s, body);
586 return ERROR_INVALID_PARAMETER;
592BOOL rail_is_extended_spi_supported(UINT32 channelFlags)
594 return (channelFlags & TS_RAIL_ORDER_HANDSHAKE_EX_FLAGS_EXTENDED_SPI_SUPPORTED) != 0;
597const char* rail_handshake_ex_flags_to_string(UINT32 flags,
char* buffer,
size_t len)
602 (void)_snprintf(buffer, len,
"{");
603 char* fbuffer = &buffer[1];
606 if (flags & TS_RAIL_ORDER_HANDSHAKEEX_FLAGS_HIDEF)
607 winpr_str_append(
"HIDEF", fbuffer, len,
"|");
608 if (flags & TS_RAIL_ORDER_HANDSHAKE_EX_FLAGS_EXTENDED_SPI_SUPPORTED)
609 winpr_str_append(
"EXTENDED_SPI_SUPPORTED", fbuffer, len,
"|");
610 if (flags & TS_RAIL_ORDER_HANDSHAKE_EX_FLAGS_SNAP_ARRANGE_SUPPORTED)
611 winpr_str_append(
"SNAP_ARRANGE_SUPPORTED", fbuffer, len,
"|");
612 if (flags & TS_RAIL_ORDER_HANDSHAKE_EX_FLAGS_TEXT_SCALE_SUPPORTED)
613 winpr_str_append(
"TEXT_SCALE_SUPPORTED", fbuffer, len,
"|");
614 if (flags & TS_RAIL_ORDER_HANDSHAKE_EX_FLAGS_CARET_BLINK_SUPPORTED)
615 winpr_str_append(
"CARET_BLINK_SUPPORTED", fbuffer, len,
"|");
616 if (flags & TS_RAIL_ORDER_HANDSHAKE_EX_FLAGS_EXTENDED_SPI_2_SUPPORTED)
617 winpr_str_append(
"EXTENDED_SPI_2_SUPPORTED", fbuffer, len,
"|");
619 char number[16] = WINPR_C_ARRAY_INIT;
620 (void)_snprintf(number,
sizeof(number),
"[0x%08" PRIx32
"]", flags);
621 winpr_str_append(number, buffer, len,
"}");