FreeRDP
Loading...
Searching...
No Matches
fastpath.c
1
23#include <freerdp/config.h>
24
25#include "settings.h"
26
27#include <stdio.h>
28#include <stdlib.h>
29#include <string.h>
30
31#include <winpr/crt.h>
32#include <winpr/assert.h>
33#include <winpr/stream.h>
34
35#include <freerdp/api.h>
36#include <freerdp/log.h>
37#include <freerdp/crypto/per.h>
38
39#include "orders.h"
40#include "update.h"
41#include "surface.h"
42#include "fastpath.h"
43#include "rdp.h"
44
45#include "../cache/pointer.h"
46#include "../cache/palette.h"
47#include "../cache/bitmap.h"
48
49#define FTAG FREERDP_TAG("core.fastpath")
50
51enum FASTPATH_INPUT_ENCRYPTION_FLAGS
52{
53 FASTPATH_INPUT_SECURE_CHECKSUM = 0x1,
54 FASTPATH_INPUT_ENCRYPTED = 0x2
55};
56
57enum FASTPATH_OUTPUT_ENCRYPTION_FLAGS
58{
59 FASTPATH_OUTPUT_SECURE_CHECKSUM = 0x1,
60 FASTPATH_OUTPUT_ENCRYPTED = 0x2
61};
62
63struct rdp_fastpath
64{
65 rdpRdp* rdp;
66 wStream* fs;
67 BYTE encryptionFlags;
68 BYTE numberEvents;
69 wStream* updateData;
70 int fragmentation;
71 wLog* log;
72};
73
84static const char* const FASTPATH_UPDATETYPE_STRINGS[] = {
85 "Orders", /* 0x0 */
86 "Bitmap", /* 0x1 */
87 "Palette", /* 0x2 */
88 "Synchronize", /* 0x3 */
89 "Surface Commands", /* 0x4 */
90 "System Pointer Hidden", /* 0x5 */
91 "System Pointer Default", /* 0x6 */
92 "???", /* 0x7 */
93 "Pointer Position", /* 0x8 */
94 "Color Pointer", /* 0x9 */
95 "Cached Pointer", /* 0xA */
96 "New Pointer", /* 0xB */
97};
98
99WINPR_ATTR_NODISCARD
100static const char* fastpath_update_to_string(UINT8 update)
101{
102 if (update >= ARRAYSIZE(FASTPATH_UPDATETYPE_STRINGS))
103 return "UNKNOWN";
104
105 return FASTPATH_UPDATETYPE_STRINGS[update];
106}
107
108WINPR_ATTR_NODISCARD
109static BOOL fastpath_read_update_header(wLog* log, wStream* s, BYTE* updateCode,
110 BYTE* fragmentation, BYTE* compression)
111{
112 BYTE updateHeader = 0;
113
114 if (!s || !updateCode || !fragmentation || !compression)
115 return FALSE;
116
117 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 1))
118 return FALSE;
119
120 Stream_Read_UINT8(s, updateHeader);
121 *updateCode = updateHeader & 0x0F;
122 *fragmentation = (updateHeader >> 4) & 0x03;
123 *compression = (updateHeader >> 6) & 0x03;
124 return TRUE;
125}
126
127WINPR_ATTR_NODISCARD
128static BOOL fastpath_write_update_header(wLog* log, wStream* s,
129 const FASTPATH_UPDATE_HEADER* fpUpdateHeader)
130{
131 BYTE updateHeader = 0;
132 WINPR_ASSERT(fpUpdateHeader);
133
134 updateHeader |= fpUpdateHeader->updateCode & 0x0F;
135 updateHeader |= (fpUpdateHeader->fragmentation & 0x03) << 4;
136 updateHeader |= (fpUpdateHeader->compression & 0x03) << 6;
137
138 if (!Stream_CheckAndLogRequiredCapacityWLog(log, s, 1))
139 return FALSE;
140 Stream_Write_UINT8(s, updateHeader);
141
142 if (fpUpdateHeader->compression)
143 {
144 if (!Stream_CheckAndLogRequiredCapacityWLog(log, s, 1))
145 return FALSE;
146
147 Stream_Write_UINT8(s, fpUpdateHeader->compressionFlags);
148 }
149
150 if (!Stream_CheckAndLogRequiredCapacityWLog(log, s, 2))
151 return FALSE;
152
153 Stream_Write_UINT16(s, fpUpdateHeader->size);
154 return TRUE;
155}
156
157WINPR_ATTR_NODISCARD
158static UINT32 fastpath_get_update_header_size(FASTPATH_UPDATE_HEADER* fpUpdateHeader)
159{
160 WINPR_ASSERT(fpUpdateHeader);
161 return (fpUpdateHeader->compression) ? 4 : 3;
162}
163
164WINPR_ATTR_NODISCARD
165static BOOL fastpath_write_update_pdu_header(wLog* log, wStream* s,
166 const FASTPATH_UPDATE_PDU_HEADER* fpUpdatePduHeader,
167 rdpRdp* rdp)
168{
169 BYTE fpOutputHeader = 0;
170 WINPR_ASSERT(fpUpdatePduHeader);
171 WINPR_ASSERT(rdp);
172
173 if (!Stream_CheckAndLogRequiredCapacityWLog(log, s, 3))
174 return FALSE;
175
176 fpOutputHeader |= (fpUpdatePduHeader->action & 0x03);
177 fpOutputHeader |= (fpUpdatePduHeader->secFlags & 0x03) << 6;
178 Stream_Write_UINT8(s, fpOutputHeader); /* fpOutputHeader (1 byte) */
179 Stream_Write_UINT8(s, 0x80 | (fpUpdatePduHeader->length >> 8)); /* length1 */
180 Stream_Write_UINT8(s, fpUpdatePduHeader->length & 0xFF); /* length2 */
181
182 if (fpUpdatePduHeader->secFlags)
183 {
184 WINPR_ASSERT(rdp->settings);
185 if (freerdp_settings_get_uint32(rdp->settings, FreeRDP_EncryptionMethods) ==
186 ENCRYPTION_METHOD_FIPS)
187 {
188 if (!Stream_CheckAndLogRequiredCapacityWLog(log, s, 4))
189 return FALSE;
190
191 Stream_Write(s, fpUpdatePduHeader->fipsInformation, 4);
192 }
193
194 if (!Stream_CheckAndLogRequiredCapacityWLog(log, s, 8))
195 return FALSE;
196
197 Stream_Write(s, fpUpdatePduHeader->dataSignature, 8);
198 }
199
200 return TRUE;
201}
202
203WINPR_ATTR_NODISCARD
204static UINT32 fastpath_get_update_pdu_header_size(FASTPATH_UPDATE_PDU_HEADER* fpUpdatePduHeader,
205 rdpRdp* rdp)
206{
207 UINT32 size = 3; /* fpUpdatePduHeader + length1 + length2 */
208
209 if (!fpUpdatePduHeader || !rdp)
210 return 0;
211
212 if (fpUpdatePduHeader->secFlags)
213 {
214 size += 8; /* dataSignature */
215
216 WINPR_ASSERT(rdp->settings);
217 if (freerdp_settings_get_uint32(rdp->settings, FreeRDP_EncryptionMethods) ==
218 ENCRYPTION_METHOD_FIPS)
219 size += 4; /* fipsInformation */
220 }
221
222 return size;
223}
224
225BOOL fastpath_read_header_rdp(rdpFastPath* fastpath, wStream* s, UINT16* length)
226{
227 WINPR_ASSERT(fastpath);
228 WINPR_ASSERT(s);
229 WINPR_ASSERT(length);
230
231 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, 1))
232 return FALSE;
233
234 const BYTE header = Stream_Get_UINT8(s);
235 fastpath->encryptionFlags = (header & 0xC0) >> 6;
236 fastpath->numberEvents = (header & 0x3C) >> 2;
237
238 if (!per_read_length(s, length))
239 return FALSE;
240
241 const size_t pos = Stream_GetPosition(s);
242 if (pos > *length)
243 return FALSE;
244
245 *length = *length - (UINT16)pos;
246 return TRUE;
247}
248
249WINPR_ATTR_NODISCARD
250static BOOL fastpath_recv_orders(rdpUpdate* update, wStream* s)
251{
252 UINT16 numberOrders = 0;
253
254 WINPR_ASSERT(update);
255 WINPR_ASSERT(update->context);
256 WINPR_ASSERT(update->context->rdp);
257 WINPR_ASSERT(update->context->rdp->fastpath);
258
259 wLog* log = update->context->rdp->fastpath->log;
260 if (!s)
261 {
262 WLog_Print(log, WLOG_ERROR, "Invalid arguments");
263 return FALSE;
264 }
265
266 if (!update)
267 {
268 WLog_Print(log, WLOG_ERROR, "Invalid configuration");
269 return FALSE;
270 }
271
272 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 2))
273 return FALSE;
274
275 Stream_Read_UINT16(s, numberOrders); /* numberOrders (2 bytes) */
276
277 while (numberOrders > 0)
278 {
279 if (!update_recv_order(update, s))
280 return FALSE;
281
282 numberOrders--;
283 }
284
285 return TRUE;
286}
287
288WINPR_ATTR_NODISCARD
289static BOOL fastpath_recv_update_common(rdpUpdate* update, wStream* s)
290{
291 BOOL rc = FALSE;
292 UINT16 updateType = 0;
293 BOOL defaultReturn = 0;
294
295 rdp_update_internal* up = update_cast(update);
296 if (!s)
297 return FALSE;
298
299 if (!update || !update->context)
300 return FALSE;
301
302 rdpContext* context = update->context;
303 WINPR_ASSERT(context->rdp);
304 WINPR_ASSERT(context->rdp->fastpath);
305
306 defaultReturn = freerdp_settings_get_bool(context->settings, FreeRDP_DeactivateClientDecoding);
307
308 if (!Stream_CheckAndLogRequiredLengthWLog(context->rdp->fastpath->log, s, 2))
309 return FALSE;
310
311 Stream_Read_UINT16(s, updateType); /* updateType (2 bytes) */
312 switch (updateType)
313 {
314 case UPDATE_TYPE_BITMAP:
315 {
316 BITMAP_UPDATE* bitmap_update = update_read_bitmap_update(update, s);
317
318 if (!bitmap_update)
319 return FALSE;
320
321 up->stats.base[RDP_STATS_BITMAP_UPDATE]++;
322 rc = IFCALLRESULT(defaultReturn, update->BitmapUpdate, context, bitmap_update);
323 free_bitmap_update(context, bitmap_update);
324 }
325 break;
326
327 case UPDATE_TYPE_PALETTE:
328 {
329 PALETTE_UPDATE* palette_update = update_read_palette(update, s);
330
331 if (!palette_update)
332 return FALSE;
333
334 up->stats.base[RDP_STATS_PALETTE]++;
335 rc = IFCALLRESULT(defaultReturn, update->Palette, context, palette_update);
336 free_palette_update(context, palette_update);
337 }
338 break;
339
340 default:
341 break;
342 }
343
344 return rc;
345}
346
347WINPR_ATTR_NODISCARD
348static BOOL fastpath_recv_update_synchronize(WINPR_ATTR_UNUSED rdpFastPath* fastpath, wStream* s)
349{
350 /* server 2008 can send invalid synchronize packet with missing padding,
351 so don't return FALSE even if the packet is invalid */
352 WINPR_ASSERT(fastpath);
353 WINPR_ASSERT(s);
354
355 const size_t len = Stream_GetRemainingLength(s);
356 const size_t skip = MIN(2, len);
357 return Stream_SafeSeek(s, skip); /* size (2 bytes), MUST be set to zero */
358}
359
360WINPR_ATTR_NODISCARD
361static BOOL fastpath_recv_update_paint_block(rdpUpdate* update, wStream* s,
362 BOOL (*fkt)(rdpUpdate*, wStream*))
363{
364 WINPR_ASSERT(fkt);
365 if (!update_begin_paint(update))
366 return FALSE;
367
368 BOOL res = fkt(update, s);
369 if (!update_end_paint(update))
370 return FALSE;
371 return res;
372}
373
374WINPR_ATTR_NODISCARD
375static int fastpath_recv_update(rdpFastPath* fastpath, BYTE updateCode, wStream* s)
376{
377 BOOL rc = FALSE;
378 int status = 0;
379
380 if (!fastpath || !fastpath->rdp || !s)
381 return -1;
382
383 Stream_SealLength(s);
384 Stream_ResetPosition(s);
385
386 rdpUpdate* update = fastpath->rdp->update;
387
388 if (!update || !update->pointer || !update->context)
389 return -1;
390
391 rdp_update_internal* up = update_cast(update);
392
393 rdpContext* context = update->context;
394 WINPR_ASSERT(context);
395
396 rdpPointerUpdate* pointer = update->pointer;
397 WINPR_ASSERT(pointer);
398
399#ifdef WITH_DEBUG_RDP
400 DEBUG_RDP(fastpath->rdp, "recv Fast-Path %s Update (0x%02" PRIX8 "), length:%" PRIuz "",
401 fastpath_update_to_string(updateCode), updateCode, Stream_GetRemainingLength(s));
402#endif
403
404 const BOOL defaultReturn =
405 freerdp_settings_get_bool(context->settings, FreeRDP_DeactivateClientDecoding);
406 switch (updateCode)
407 {
408 case FASTPATH_UPDATETYPE_ORDERS:
409 rc = fastpath_recv_update_paint_block(update, s, fastpath_recv_orders);
410 break;
411
412 case FASTPATH_UPDATETYPE_BITMAP:
413 case FASTPATH_UPDATETYPE_PALETTE:
414 rc = fastpath_recv_update_paint_block(update, s, fastpath_recv_update_common);
415 break;
416
417 case FASTPATH_UPDATETYPE_SYNCHRONIZE:
418 if (!fastpath_recv_update_synchronize(fastpath, s))
419 WLog_Print(fastpath->log, WLOG_ERROR,
420 "fastpath_recv_update_synchronize failure but we continue");
421 else
422 {
423 up->stats.base[RDP_STATS_SYNC]++;
424 rc = IFCALLRESULT(TRUE, update->Synchronize, context);
425 }
426
427 break;
428
429 case FASTPATH_UPDATETYPE_SURFCMDS:
430 status = fastpath_recv_update_paint_block(update, s, update_recv_surfcmds);
431 rc = (status >= 0);
432 break;
433
434 case FASTPATH_UPDATETYPE_PTR_NULL:
435 {
436 POINTER_SYSTEM_UPDATE pointer_system = WINPR_C_ARRAY_INIT;
437 pointer_system.type = SYSPTR_NULL;
438 up->stats.base[RDP_STATS_POINTER_SYSTEM]++;
439 rc = IFCALLRESULT(defaultReturn, pointer->PointerSystem, context, &pointer_system);
440 }
441 break;
442
443 case FASTPATH_UPDATETYPE_PTR_DEFAULT:
444 {
445 POINTER_SYSTEM_UPDATE pointer_system = WINPR_C_ARRAY_INIT;
446 pointer_system.type = SYSPTR_DEFAULT;
447 up->stats.base[RDP_STATS_POINTER_DEFAULT]++;
448 rc = IFCALLRESULT(defaultReturn, pointer->PointerSystem, context, &pointer_system);
449 }
450 break;
451
452 case FASTPATH_UPDATETYPE_PTR_POSITION:
453 {
454 POINTER_POSITION_UPDATE* pointer_position = update_read_pointer_position(update, s);
455
456 if (pointer_position)
457 {
458 up->stats.base[RDP_STATS_POINTER_POSITION]++;
459 rc = IFCALLRESULT(defaultReturn, pointer->PointerPosition, context,
460 pointer_position);
461 free_pointer_position_update(context, pointer_position);
462 }
463 }
464 break;
465
466 case FASTPATH_UPDATETYPE_COLOR:
467 {
468 POINTER_COLOR_UPDATE* pointer_color = update_read_pointer_color(update, s, 24);
469
470 if (pointer_color)
471 {
472 up->stats.base[RDP_STATS_POINTER_COLOR]++;
473 rc = IFCALLRESULT(defaultReturn, pointer->PointerColor, context, pointer_color);
474 free_pointer_color_update(context, pointer_color);
475 }
476 }
477 break;
478
479 case FASTPATH_UPDATETYPE_CACHED:
480 {
481 POINTER_CACHED_UPDATE* pointer_cached = update_read_pointer_cached(update, s);
482
483 if (pointer_cached)
484 {
485 up->stats.base[RDP_STATS_POINTER_CACHED]++;
486 rc = IFCALLRESULT(defaultReturn, pointer->PointerCached, context, pointer_cached);
487 free_pointer_cached_update(context, pointer_cached);
488 }
489 }
490 break;
491
492 case FASTPATH_UPDATETYPE_POINTER:
493 {
494 POINTER_NEW_UPDATE* pointer_new = update_read_pointer_new(update, s);
495
496 if (pointer_new)
497 {
498 up->stats.base[RDP_STATS_POINTER_NEW]++;
499 rc = IFCALLRESULT(defaultReturn, pointer->PointerNew, context, pointer_new);
500 free_pointer_new_update(context, pointer_new);
501 }
502 }
503 break;
504
505 case FASTPATH_UPDATETYPE_LARGE_POINTER:
506 {
507 POINTER_LARGE_UPDATE* pointer_large = update_read_pointer_large(update, s);
508
509 if (pointer_large)
510 {
511 up->stats.base[RDP_STATS_POINTER_LARGE]++;
512 rc = IFCALLRESULT(defaultReturn, pointer->PointerLarge, context, pointer_large);
513 free_pointer_large_update(context, pointer_large);
514 }
515 }
516 break;
517 default:
518 break;
519 }
520
521 Stream_ResetPosition(s);
522 if (!rc)
523 {
524 WLog_Print(fastpath->log, WLOG_ERROR, "Fastpath update %s [%" PRIx8 "] failed, status %d",
525 fastpath_update_to_string(updateCode), updateCode, status);
526 const BOOL ignore =
527 freerdp_settings_get_bool(context->settings, FreeRDP_AllowUnanouncedOrdersFromServer);
528 if (ignore)
529 return 0;
530 return -1;
531 }
532
533 return status;
534}
535
536WINPR_ATTR_NODISCARD
537static int fastpath_recv_update_data(rdpFastPath* fastpath, wStream* s)
538{
539 int status = 0;
540 UINT16 size = 0;
541 BYTE updateCode = 0;
542 BYTE fragmentation = 0;
543 BYTE compression = 0;
544 BYTE compressionFlags = 0;
545 UINT32 DstSize = 0;
546 const BYTE* pDstData = nullptr;
547
548 if (!fastpath || !s)
549 return -1;
550
551 rdpRdp* rdp = fastpath->rdp;
552
553 if (!rdp)
554 return -1;
555
556 rdpTransport* transport = rdp->transport;
557
558 if (!transport)
559 return -1;
560
561 if (!fastpath_read_update_header(fastpath->log, s, &updateCode, &fragmentation, &compression))
562 return -1;
563
564 if (compression == FASTPATH_OUTPUT_COMPRESSION_USED)
565 {
566 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, 1))
567 return -1;
568
569 Stream_Read_UINT8(s, compressionFlags);
570 }
571 else
572 compressionFlags = 0;
573
574 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, 2))
575 return -1;
576
577 Stream_Read_UINT16(s, size);
578
579 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, size))
580 return -1;
581
582 const int bulkStatus =
583 bulk_decompress(rdp->bulk, Stream_Pointer(s), size, &pDstData, &DstSize, compressionFlags);
584 Stream_Seek(s, size);
585
586 if (bulkStatus < 0)
587 {
588 WLog_Print(fastpath->log, WLOG_ERROR, "bulk_decompress() failed");
589 return -1;
590 }
591
592 if (!Stream_EnsureRemainingCapacity(fastpath->updateData, DstSize))
593 return -1;
594
595 Stream_Write(fastpath->updateData, pDstData, DstSize);
596
597 if (fragmentation == FASTPATH_FRAGMENT_SINGLE)
598 {
599 if (fastpath->fragmentation != -1)
600 {
601 WLog_Print(fastpath->log, WLOG_ERROR, "Unexpected FASTPATH_FRAGMENT_SINGLE");
602 goto out_fail;
603 }
604
605 status = fastpath_recv_update(fastpath, updateCode, fastpath->updateData);
606
607 if (status < 0)
608 {
609 WLog_Print(fastpath->log, WLOG_ERROR, "fastpath_recv_update() - %i", status);
610 goto out_fail;
611 }
612 }
613 else
614 {
615 rdpContext* context = nullptr;
616 const size_t totalSize = Stream_GetPosition(fastpath->updateData);
617
618 context = transport_get_context(transport);
619 WINPR_ASSERT(context);
620 WINPR_ASSERT(context->settings);
621
622 if (totalSize >
623 freerdp_settings_get_uint32(context->settings, FreeRDP_MultifragMaxRequestSize))
624 {
625 WLog_Print(
626 fastpath->log, WLOG_ERROR,
627 "Total size (%" PRIuz ") exceeds MultifragMaxRequestSize (%" PRIu32 ")", totalSize,
628 freerdp_settings_get_uint32(context->settings, FreeRDP_MultifragMaxRequestSize));
629 goto out_fail;
630 }
631
632 if (fragmentation == FASTPATH_FRAGMENT_FIRST)
633 {
634 if (fastpath->fragmentation != -1)
635 {
636 WLog_Print(fastpath->log, WLOG_ERROR, "Unexpected FASTPATH_FRAGMENT_FIRST");
637 goto out_fail;
638 }
639
640 fastpath->fragmentation = FASTPATH_FRAGMENT_FIRST;
641 }
642 else if (fragmentation == FASTPATH_FRAGMENT_NEXT)
643 {
644 if ((fastpath->fragmentation != FASTPATH_FRAGMENT_FIRST) &&
645 (fastpath->fragmentation != FASTPATH_FRAGMENT_NEXT))
646 {
647 WLog_Print(fastpath->log, WLOG_ERROR, "Unexpected FASTPATH_FRAGMENT_NEXT");
648 goto out_fail;
649 }
650
651 fastpath->fragmentation = FASTPATH_FRAGMENT_NEXT;
652 }
653 else if (fragmentation == FASTPATH_FRAGMENT_LAST)
654 {
655 if ((fastpath->fragmentation != FASTPATH_FRAGMENT_FIRST) &&
656 (fastpath->fragmentation != FASTPATH_FRAGMENT_NEXT))
657 {
658 WLog_Print(fastpath->log, WLOG_ERROR, "Unexpected FASTPATH_FRAGMENT_LAST");
659 goto out_fail;
660 }
661
662 fastpath->fragmentation = -1;
663 status = fastpath_recv_update(fastpath, updateCode, fastpath->updateData);
664
665 if (status < 0)
666 {
667 WLog_Print(fastpath->log, WLOG_ERROR, "fastpath_recv_update() - %i", status);
668 goto out_fail;
669 }
670 }
671 }
672
673 return status;
674out_fail:
675 return -1;
676}
677
678state_run_t fastpath_recv_updates(rdpFastPath* fastpath, wStream* s)
679{
680 state_run_t rc = STATE_RUN_FAILED;
681
682 WINPR_ASSERT(s);
683 WINPR_ASSERT(fastpath);
684 WINPR_ASSERT(fastpath->rdp);
685
686 while (Stream_GetRemainingLength(s) >= 3)
687 {
688 if (fastpath_recv_update_data(fastpath, s) < 0)
689 {
690 WLog_Print(fastpath->log, WLOG_ERROR, "fastpath_recv_update_data() fail");
691 rc = STATE_RUN_FAILED;
692 goto fail;
693 }
694 }
695
696 rc = STATE_RUN_SUCCESS;
697fail:
698
699 return rc;
700}
701
702WINPR_ATTR_NODISCARD
703static BOOL fastpath_read_input_event_header(wLog* log, wStream* s, BYTE* eventFlags,
704 BYTE* eventCode)
705{
706 BYTE eventHeader = 0;
707
708 WINPR_ASSERT(s);
709 WINPR_ASSERT(eventFlags);
710 WINPR_ASSERT(eventCode);
711
712 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 1))
713 return FALSE;
714
715 Stream_Read_UINT8(s, eventHeader); /* eventHeader (1 byte) */
716 *eventFlags = (eventHeader & 0x1F);
717 *eventCode = (eventHeader >> 5);
718 return TRUE;
719}
720
721WINPR_ATTR_NODISCARD
722static BOOL fastpath_recv_input_event_scancode(rdpFastPath* fastpath, wStream* s, BYTE eventFlags)
723{
724 WINPR_ASSERT(fastpath);
725 WINPR_ASSERT(fastpath->rdp);
726 WINPR_ASSERT(fastpath->rdp->input);
727 WINPR_ASSERT(s);
728
729 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, 1))
730 return FALSE;
731
732 rdpInput* input = fastpath->rdp->input;
733
734 const UINT8 code = Stream_Get_UINT8(s); /* keyCode (1 byte) */
735
736 UINT16 flags = 0;
737 if ((eventFlags & FASTPATH_INPUT_KBDFLAGS_RELEASE))
738 flags |= KBD_FLAGS_RELEASE;
739
740 if ((eventFlags & FASTPATH_INPUT_KBDFLAGS_EXTENDED))
741 flags |= KBD_FLAGS_EXTENDED;
742
743 if ((eventFlags & FASTPATH_INPUT_KBDFLAGS_PREFIX_E1))
744 flags |= KBD_FLAGS_EXTENDED1;
745
746 /* only pass input if we are actually connected */
747 if (!rdp_has_reached_state(input->context->rdp, CONNECTION_STATE_ACTIVE))
748 return TRUE;
749 return IFCALLRESULT(TRUE, input->KeyboardEvent, input, flags, code);
750}
751
752WINPR_ATTR_NODISCARD
753static BOOL fastpath_recv_input_event_mouse(rdpFastPath* fastpath, wStream* s,
754 WINPR_ATTR_UNUSED BYTE eventFlags)
755{
756 UINT16 pointerFlags = 0;
757 UINT16 xPos = 0;
758 UINT16 yPos = 0;
759 WINPR_ASSERT(fastpath);
760 WINPR_ASSERT(fastpath->rdp);
761 WINPR_ASSERT(fastpath->rdp->input);
762 WINPR_ASSERT(s);
763
764 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, 6))
765 return FALSE;
766
767 rdpInput* input = fastpath->rdp->input;
768
769 /* only pass input if we are actually connected */
770 if (!rdp_has_reached_state(input->context->rdp, CONNECTION_STATE_ACTIVE))
771 return TRUE;
772
773 Stream_Read_UINT16(s, pointerFlags); /* pointerFlags (2 bytes) */
774 Stream_Read_UINT16(s, xPos); /* xPos (2 bytes) */
775 Stream_Read_UINT16(s, yPos); /* yPos (2 bytes) */
776 return IFCALLRESULT(TRUE, input->MouseEvent, input, pointerFlags, xPos, yPos);
777}
778
779WINPR_ATTR_NODISCARD
780static BOOL fastpath_recv_input_event_relmouse(rdpFastPath* fastpath, wStream* s,
781 WINPR_ATTR_UNUSED BYTE eventFlags)
782{
783 rdpInput* input = nullptr;
784 UINT16 pointerFlags = 0;
785 INT16 xDelta = 0;
786 INT16 yDelta = 0;
787 WINPR_ASSERT(fastpath);
788 WINPR_ASSERT(fastpath->rdp);
789 WINPR_ASSERT(fastpath->rdp->context);
790 WINPR_ASSERT(fastpath->rdp->input);
791 WINPR_ASSERT(s);
792
793 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, 6))
794 return FALSE;
795
796 input = fastpath->rdp->input;
797
798 Stream_Read_UINT16(s, pointerFlags); /* pointerFlags (2 bytes) */
799 Stream_Read_INT16(s, xDelta); /* xDelta (2 bytes) */
800 Stream_Read_INT16(s, yDelta); /* yDelta (2 bytes) */
801
802 if (!freerdp_settings_get_bool(input->context->settings, FreeRDP_HasRelativeMouseEvent))
803 {
804 WLog_Print(fastpath->log, WLOG_ERROR,
805 "Received relative mouse event(flags=0x%04" PRIx16 ", xPos=%" PRId16
806 ", yPos=%" PRId16 "), but we did not announce support for that",
807 pointerFlags, xDelta, yDelta);
808 return FALSE;
809 }
810
811 /* only pass input if we are actually connected */
812 if (!rdp_has_reached_state(input->context->rdp, CONNECTION_STATE_ACTIVE))
813 return TRUE;
814 return IFCALLRESULT(TRUE, input->RelMouseEvent, input, pointerFlags, xDelta, yDelta);
815}
816
817WINPR_ATTR_NODISCARD
818static BOOL fastpath_recv_input_event_qoe(rdpFastPath* fastpath, wStream* s,
819 WINPR_ATTR_UNUSED BYTE eventFlags)
820{
821 WINPR_ASSERT(fastpath);
822 WINPR_ASSERT(fastpath->rdp);
823 WINPR_ASSERT(fastpath->rdp->context);
824 WINPR_ASSERT(fastpath->rdp->input);
825 WINPR_ASSERT(s);
826
827 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, 4))
828 return FALSE;
829
830 rdpInput* input = fastpath->rdp->input;
831
832 UINT32 timestampMS = 0;
833 Stream_Read_UINT32(s, timestampMS); /* timestamp (4 bytes) */
834
835 if (!freerdp_settings_get_bool(input->context->settings, FreeRDP_HasQoeEvent))
836 {
837 WLog_Print(fastpath->log, WLOG_ERROR,
838 "Received qoe event(timestamp=%" PRIu32
839 "ms), but we did not announce support for that",
840 timestampMS);
841 return FALSE;
842 }
843
844 /* only pass input if we are actually connected */
845 if (!rdp_has_reached_state(input->context->rdp, CONNECTION_STATE_ACTIVE))
846 return TRUE;
847 return IFCALLRESULT(TRUE, input->QoEEvent, input, timestampMS);
848}
849
850WINPR_ATTR_NODISCARD
851static BOOL fastpath_recv_input_event_mousex(rdpFastPath* fastpath, wStream* s,
852 WINPR_ATTR_UNUSED BYTE eventFlags)
853{
854 rdpInput* input = nullptr;
855 UINT16 pointerFlags = 0;
856 UINT16 xPos = 0;
857 UINT16 yPos = 0;
858
859 WINPR_ASSERT(fastpath);
860 WINPR_ASSERT(fastpath->rdp);
861 WINPR_ASSERT(fastpath->rdp->context);
862 WINPR_ASSERT(fastpath->rdp->input);
863 WINPR_ASSERT(s);
864
865 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, 6))
866 return FALSE;
867
868 input = fastpath->rdp->input;
869
870 Stream_Read_UINT16(s, pointerFlags); /* pointerFlags (2 bytes) */
871 Stream_Read_UINT16(s, xPos); /* xPos (2 bytes) */
872 Stream_Read_UINT16(s, yPos); /* yPos (2 bytes) */
873
874 if (!freerdp_settings_get_bool(input->context->settings, FreeRDP_HasExtendedMouseEvent))
875 {
876 WLog_Print(fastpath->log, WLOG_ERROR,
877 "Received extended mouse event(flags=0x%04" PRIx16 ", xPos=%" PRIu16
878 ", yPos=%" PRIu16 "), but we did not announce support for that",
879 pointerFlags, xPos, yPos);
880 return FALSE;
881 }
882
883 /* only pass input if we are actually connected */
884 if (!rdp_has_reached_state(input->context->rdp, CONNECTION_STATE_ACTIVE))
885 return TRUE;
886
887 return IFCALLRESULT(TRUE, input->ExtendedMouseEvent, input, pointerFlags, xPos, yPos);
888}
889
890WINPR_ATTR_NODISCARD
891static BOOL fastpath_recv_input_event_sync(rdpFastPath* fastpath, WINPR_ATTR_UNUSED wStream* s,
892 BYTE eventFlags)
893{
894 WINPR_ASSERT(fastpath);
895 WINPR_ASSERT(fastpath->rdp);
896 WINPR_ASSERT(fastpath->rdp->input);
897 WINPR_ASSERT(s);
898
899 rdpInput* input = fastpath->rdp->input;
900
901 /* only pass input if we are actually connected */
902 if (!rdp_has_reached_state(input->context->rdp, CONNECTION_STATE_ACTIVE))
903 return TRUE;
904 return IFCALLRESULT(TRUE, input->SynchronizeEvent, input, eventFlags);
905}
906
907WINPR_ATTR_NODISCARD
908static BOOL fastpath_recv_input_event_unicode(rdpFastPath* fastpath, wStream* s, BYTE eventFlags)
909{
910 UINT16 unicodeCode = 0;
911 UINT16 flags = 0;
912
913 WINPR_ASSERT(fastpath);
914 WINPR_ASSERT(s);
915
916 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, 2))
917 return FALSE;
918
919 Stream_Read_UINT16(s, unicodeCode); /* unicodeCode (2 bytes) */
920 flags = 0;
921
922 if ((eventFlags & FASTPATH_INPUT_KBDFLAGS_RELEASE))
923 flags |= KBD_FLAGS_RELEASE;
924
925 /* only pass input if we are actually connected */
926 if (!rdp_has_reached_state(fastpath->rdp->input->context->rdp, CONNECTION_STATE_ACTIVE))
927 return TRUE;
928
929 WINPR_ASSERT(fastpath->rdp);
930 WINPR_ASSERT(fastpath->rdp);
931 WINPR_ASSERT(fastpath->rdp->input);
932 return IFCALLRESULT(FALSE, fastpath->rdp->input->UnicodeKeyboardEvent, fastpath->rdp->input,
933 flags, unicodeCode);
934}
935
936WINPR_ATTR_NODISCARD
937static BOOL fastpath_recv_input_event(rdpFastPath* fastpath, wStream* s)
938{
939 BYTE eventFlags = 0;
940 BYTE eventCode = 0;
941
942 WINPR_ASSERT(fastpath);
943 WINPR_ASSERT(s);
944
945 if (!rdp_is_active_state(fastpath->rdp))
946 {
947 WLog_Print(fastpath->log, WLOG_WARN, "Input event before activation, ignoring");
948 return TRUE;
949 }
950
951 if (!fastpath_read_input_event_header(fastpath->log, s, &eventFlags, &eventCode))
952 return FALSE;
953
954 switch (eventCode)
955 {
956 case FASTPATH_INPUT_EVENT_SCANCODE:
957 if (!fastpath_recv_input_event_scancode(fastpath, s, eventFlags))
958 return FALSE;
959
960 break;
961
962 case FASTPATH_INPUT_EVENT_MOUSE:
963 if (!fastpath_recv_input_event_mouse(fastpath, s, eventFlags))
964 return FALSE;
965
966 break;
967
968 case FASTPATH_INPUT_EVENT_MOUSEX:
969 if (!fastpath_recv_input_event_mousex(fastpath, s, eventFlags))
970 return FALSE;
971
972 break;
973
974 case FASTPATH_INPUT_EVENT_SYNC:
975 if (!fastpath_recv_input_event_sync(fastpath, s, eventFlags))
976 return FALSE;
977
978 break;
979
980 case FASTPATH_INPUT_EVENT_UNICODE:
981 if (!fastpath_recv_input_event_unicode(fastpath, s, eventFlags))
982 return FALSE;
983
984 break;
985
986 case TS_FP_RELPOINTER_EVENT:
987 if (!fastpath_recv_input_event_relmouse(fastpath, s, eventFlags))
988 return FALSE;
989
990 break;
991
992 case TS_FP_QOETIMESTAMP_EVENT:
993 if (!fastpath_recv_input_event_qoe(fastpath, s, eventFlags))
994 return FALSE;
995 break;
996
997 default:
998 WLog_Print(fastpath->log, WLOG_ERROR, "Unknown eventCode %" PRIu8 "", eventCode);
999 break;
1000 }
1001
1002 return TRUE;
1003}
1004
1005state_run_t fastpath_recv_inputs(rdpFastPath* fastpath, wStream* s)
1006{
1007 WINPR_ASSERT(fastpath);
1008 WINPR_ASSERT(s);
1009
1010 if (fastpath->numberEvents == 0)
1011 {
1016 if (!Stream_CheckAndLogRequiredLengthWLog(fastpath->log, s, 1))
1017 return STATE_RUN_FAILED;
1018
1019 Stream_Read_UINT8(s, fastpath->numberEvents); /* eventHeader (1 byte) */
1020 }
1021
1022 for (BYTE i = 0; i < fastpath->numberEvents; i++)
1023 {
1024 if (!fastpath_recv_input_event(fastpath, s))
1025 return STATE_RUN_FAILED;
1026 }
1027
1028 return STATE_RUN_SUCCESS;
1029}
1030
1031WINPR_ATTR_NODISCARD
1032static UINT32 fastpath_get_sec_bytes(rdpRdp* rdp)
1033{
1034 UINT32 sec_bytes = 0;
1035
1036 if (!rdp)
1037 return 0;
1038
1039 if (rdp->do_crypt)
1040 {
1041 sec_bytes = 8;
1042
1043 if (freerdp_settings_get_uint32(rdp->settings, FreeRDP_EncryptionMethods) ==
1044 ENCRYPTION_METHOD_FIPS)
1045 sec_bytes += 4;
1046 }
1047
1048 return sec_bytes;
1049}
1050
1051wStream* fastpath_input_pdu_init_header(rdpFastPath* fastpath, UINT16* sec_flags)
1052{
1053 if (!fastpath || !fastpath->rdp)
1054 return nullptr;
1055
1056 rdpRdp* rdp = fastpath->rdp;
1057 wStream* s = transport_send_stream_init(rdp->transport, 256);
1058
1059 if (!s)
1060 return nullptr;
1061
1062 Stream_Seek(s, 3); /* fpInputHeader, length1 and length2 */
1063
1064 if (rdp->do_crypt)
1065 {
1066 *sec_flags |= SEC_ENCRYPT;
1067
1068 if (rdp->do_secure_checksum)
1069 *sec_flags |= SEC_SECURE_CHECKSUM;
1070 }
1071
1072 Stream_Seek(s, fastpath_get_sec_bytes(rdp));
1073 return s;
1074}
1075
1076wStream* fastpath_input_pdu_init(rdpFastPath* fastpath, BYTE eventFlags, BYTE eventCode,
1077 UINT16* sec_flags)
1078{
1079 wStream* s = nullptr;
1080 s = fastpath_input_pdu_init_header(fastpath, sec_flags);
1081
1082 if (!s)
1083 return nullptr;
1084
1085 WINPR_ASSERT(eventCode < 8);
1086 WINPR_ASSERT(eventFlags < 0x20);
1087 Stream_Write_UINT8(s, (UINT8)(eventFlags | (eventCode << 5))); /* eventHeader (1 byte) */
1088 return s;
1089}
1090
1091BOOL fastpath_send_multiple_input_pdu(rdpFastPath* fastpath, wStream* s, size_t iNumEvents,
1092 UINT16 sec_flags)
1093{
1094 BOOL rc = FALSE;
1095 BYTE eventHeader = 0;
1096 BOOL should_unlock = FALSE;
1097
1098 if (!s)
1099 return FALSE;
1100
1101 if (!fastpath)
1102 {
1103 Stream_Release(s);
1104 return FALSE;
1105 }
1106
1107 rdpRdp* rdp = fastpath->rdp;
1108 WINPR_ASSERT(rdp);
1109
1110 WINPR_ASSERT(iNumEvents > 0);
1111 {
1112 const CONNECTION_STATE state = rdp_get_state(rdp);
1113 if (!rdp_is_active_state(rdp))
1114 {
1115 if (!rdp->was_deactivated)
1116 {
1117 WLog_Print(fastpath->log, WLOG_WARN, "called before activation [%s]",
1118 rdp_state_string(state));
1119 goto fail;
1120 }
1121
1122 WLog_Print(fastpath->log, WLOG_DEBUG,
1123 "called during deactivate-reactivate [%s], ignoring",
1124 rdp_state_string(state));
1125 rc = TRUE;
1126 goto fail;
1127 }
1128 }
1129
1130 /*
1131 * A maximum of 15 events are allowed per request
1132 * if the optional numEvents field isn't used
1133 * see MS-RDPBCGR 2.2.8.1.2 for details
1134 */
1135 if (iNumEvents > 15)
1136 goto fail;
1137
1138 {
1139 size_t length = Stream_GetPosition(s);
1140
1141 if (length >= (2u << 14))
1142 {
1143 WLog_Print(fastpath->log, WLOG_ERROR, "Maximum FastPath PDU length is 32767");
1144 goto fail;
1145 }
1146
1147 eventHeader = FASTPATH_INPUT_ACTION_FASTPATH;
1148 eventHeader |= (iNumEvents << 2); /* numberEvents */
1149
1150 if (sec_flags & SEC_ENCRYPT)
1151 eventHeader |= (FASTPATH_INPUT_ENCRYPTED << 6);
1152
1153 if (sec_flags & SEC_SECURE_CHECKSUM)
1154 eventHeader |= (FASTPATH_INPUT_SECURE_CHECKSUM << 6);
1155
1156 Stream_ResetPosition(s);
1157 Stream_Write_UINT8(s, eventHeader);
1158 /* Write length later, RDP encryption might add a padding */
1159 Stream_Seek(s, 2);
1160
1161 if (sec_flags & SEC_ENCRYPT)
1162 {
1163 security_lock(rdp);
1164 should_unlock = TRUE;
1165
1166 const size_t sec_bytes = fastpath_get_sec_bytes(fastpath->rdp);
1167 if (sec_bytes + 3ULL > length)
1168 goto fail;
1169
1170 BYTE* fpInputEvents = Stream_PointerAs(s, BYTE) + sec_bytes;
1171 const UINT16 fpInputEvents_length = (UINT16)(length - 3 - sec_bytes);
1172
1173 WINPR_ASSERT(rdp->settings);
1174 if (freerdp_settings_get_uint32(rdp->settings, FreeRDP_EncryptionMethods) ==
1175 ENCRYPTION_METHOD_FIPS)
1176 {
1177 BYTE pad = 0;
1178
1179 if ((pad = 8 - (fpInputEvents_length % 8)) == 8)
1180 pad = 0;
1181
1182 if (!Stream_CheckAndLogRequiredCapacityWLog(fastpath->log, s, 4))
1183 goto fail;
1184
1185 Stream_Write_UINT16(s, 0x10); /* length */
1186 Stream_Write_UINT8(s, 0x1); /* TSFIPS_VERSION 1*/
1187 Stream_Write_UINT8(s, pad); /* padding */
1188
1189 if (!Stream_CheckAndLogRequiredCapacityWLog(
1190 fastpath->log, s, 1ull * fpInputEvents_length + sec_bytes + pad + 8ull))
1191 goto fail;
1192
1193 if (!security_hmac_signature(fpInputEvents, fpInputEvents_length, Stream_Pointer(s),
1194 8, rdp))
1195 goto fail;
1196
1197 if (pad)
1198 memset(fpInputEvents + fpInputEvents_length, 0, pad);
1199
1200 if (!security_fips_encrypt(fpInputEvents, fpInputEvents_length + pad, rdp))
1201 goto fail;
1202
1203 length += pad;
1204 }
1205 else
1206 {
1207 BOOL res = 0;
1208 if (!Stream_CheckAndLogRequiredCapacityWLog(fastpath->log, s, 8))
1209 goto fail;
1210 if (sec_flags & SEC_SECURE_CHECKSUM)
1211 res = security_salted_mac_signature(rdp, fpInputEvents, fpInputEvents_length,
1212 TRUE, Stream_Pointer(s), 8);
1213 else
1214 res = security_mac_signature(rdp, fpInputEvents, fpInputEvents_length,
1215 Stream_Pointer(s), 8);
1216
1217 if (!res || !security_encrypt(fpInputEvents, fpInputEvents_length, rdp))
1218 goto fail;
1219 }
1220 }
1221
1222 /*
1223 * We always encode length in two bytes, even though we could use
1224 * only one byte if length <= 0x7F. It is just easier that way,
1225 * because we can leave room for fixed-length header, store all
1226 * the data first and then store the header.
1227 */
1228 WINPR_ASSERT(length < UINT16_MAX);
1229 if (!Stream_SetPosition(s, 1))
1230 goto fail;
1231 Stream_Write_UINT16_BE(s, 0x8000 | (UINT16)length);
1232 if (!Stream_SetPosition(s, length))
1233 goto fail;
1234 Stream_SealLength(s);
1235 }
1236
1237 if (transport_write(rdp->transport, s) < 0)
1238 goto fail;
1239
1240 rc = TRUE;
1241fail:
1242 if (should_unlock)
1243 security_unlock(rdp);
1244 Stream_Release(s);
1245 return rc;
1246}
1247
1248BOOL fastpath_send_input_pdu(rdpFastPath* fastpath, wStream* s, UINT16 sec_flags)
1249{
1250 return fastpath_send_multiple_input_pdu(fastpath, s, 1, sec_flags);
1251}
1252
1253wStream* fastpath_update_pdu_init(rdpFastPath* fastpath)
1254{
1255 return transport_send_stream_init(fastpath->rdp->transport, FASTPATH_MAX_PACKET_SIZE);
1256}
1257
1258wStream* fastpath_update_pdu_init_new(WINPR_ATTR_UNUSED rdpFastPath* fastpath)
1259{
1260 wStream* s = nullptr;
1261 s = Stream_New(nullptr, FASTPATH_MAX_PACKET_SIZE);
1262 return s;
1263}
1264
1265BOOL fastpath_send_update_pdu(rdpFastPath* fastpath, BYTE updateCode, wStream* s,
1266 BOOL skipCompression)
1267{
1268 BOOL status = TRUE;
1269 wStream* fs = nullptr;
1270 rdpSettings* settings = nullptr;
1271 rdpRdp* rdp = nullptr;
1272 UINT32 fpHeaderSize = 6;
1273 UINT32 fpUpdatePduHeaderSize = 0;
1274 UINT32 fpUpdateHeaderSize = 0;
1275 FASTPATH_UPDATE_PDU_HEADER fpUpdatePduHeader = WINPR_C_ARRAY_INIT;
1276 FASTPATH_UPDATE_HEADER fpUpdateHeader = WINPR_C_ARRAY_INIT;
1277 UINT16 sec_flags = 0;
1278
1279 if (!fastpath || !fastpath->rdp || !fastpath->fs || !s)
1280 return FALSE;
1281
1282 rdp = fastpath->rdp;
1283 fs = fastpath->fs;
1284 settings = rdp->settings;
1285
1286 if (!settings)
1287 return FALSE;
1288
1289 UINT16 maxLength = FASTPATH_MAX_PACKET_SIZE - 20;
1290
1291 if (freerdp_settings_get_bool(rdp->settings, FreeRDP_CompressionEnabled) && !skipCompression)
1292 {
1293 const UINT16 CompressionMaxSize = bulk_compression_max_size(rdp->bulk);
1294 maxLength = (maxLength < CompressionMaxSize) ? maxLength : CompressionMaxSize;
1295 maxLength -= 20;
1296 }
1297
1298 size_t totalLength = Stream_GetPosition(s);
1299 Stream_ResetPosition(s);
1300
1301 /* check if fast path output is possible */
1302 if (!freerdp_settings_get_bool(rdp->settings, FreeRDP_FastPathOutput))
1303 {
1304 WLog_Print(fastpath->log, WLOG_ERROR, "client does not support fast path output");
1305 return FALSE;
1306 }
1307
1308 /* check if the client's fast path pdu buffer is large enough */
1309 if (totalLength > freerdp_settings_get_uint32(settings, FreeRDP_MultifragMaxRequestSize))
1310 {
1311 WLog_Print(fastpath->log, WLOG_ERROR,
1312 "fast path update size (%" PRIuz
1313 ") exceeds the client's maximum request size (%" PRIu32 ")",
1314 totalLength,
1315 freerdp_settings_get_uint32(settings, FreeRDP_MultifragMaxRequestSize));
1316 return FALSE;
1317 }
1318
1319 if (rdp->do_crypt)
1320 {
1321 sec_flags |= SEC_ENCRYPT;
1322
1323 if (rdp->do_secure_checksum)
1324 sec_flags |= SEC_SECURE_CHECKSUM;
1325 }
1326
1327 for (int fragment = 0; (totalLength > 0) || (fragment == 0); fragment++)
1328 {
1329 UINT32 DstSize = 0;
1330 const BYTE* pDstData = nullptr;
1331 UINT32 compressionFlags = 0;
1332 BYTE pad = 0;
1333 BYTE* pSignature = nullptr;
1334 fpUpdatePduHeader.action = 0;
1335 fpUpdatePduHeader.secFlags = 0;
1336 fpUpdateHeader.compression = 0;
1337 fpUpdateHeader.compressionFlags = 0;
1338 fpUpdateHeader.updateCode = updateCode;
1339 fpUpdateHeader.size = (UINT16)(totalLength > maxLength) ? maxLength : (UINT16)totalLength;
1340 const BYTE* pSrcData = Stream_Pointer(s);
1341 UINT32 SrcSize = DstSize = fpUpdateHeader.size;
1342 BOOL should_unlock = FALSE;
1343
1344 if (sec_flags & SEC_ENCRYPT)
1345 fpUpdatePduHeader.secFlags |= FASTPATH_OUTPUT_ENCRYPTED;
1346
1347 if (sec_flags & SEC_SECURE_CHECKSUM)
1348 fpUpdatePduHeader.secFlags |= FASTPATH_OUTPUT_SECURE_CHECKSUM;
1349
1350 if (freerdp_settings_get_bool(settings, FreeRDP_CompressionEnabled) && !skipCompression)
1351 {
1352 if (bulk_compress(rdp->bulk, pSrcData, SrcSize, &pDstData, &DstSize,
1353 &compressionFlags) >= 0)
1354 {
1355 if (compressionFlags)
1356 {
1357 WINPR_ASSERT(compressionFlags <= UINT8_MAX);
1358 fpUpdateHeader.compressionFlags = (UINT8)compressionFlags;
1359 fpUpdateHeader.compression = FASTPATH_OUTPUT_COMPRESSION_USED;
1360 }
1361 }
1362 }
1363
1364 if (!fpUpdateHeader.compression)
1365 {
1366 pDstData = Stream_Pointer(s);
1367 DstSize = fpUpdateHeader.size;
1368 }
1369
1370 if (DstSize > UINT16_MAX)
1371 return FALSE;
1372 fpUpdateHeader.size = (UINT16)DstSize;
1373 totalLength -= SrcSize;
1374
1375 if (totalLength == 0)
1376 fpUpdateHeader.fragmentation =
1377 (fragment == 0) ? FASTPATH_FRAGMENT_SINGLE : FASTPATH_FRAGMENT_LAST;
1378 else
1379 fpUpdateHeader.fragmentation =
1380 (fragment == 0) ? FASTPATH_FRAGMENT_FIRST : FASTPATH_FRAGMENT_NEXT;
1381
1382 fpUpdateHeaderSize = fastpath_get_update_header_size(&fpUpdateHeader);
1383 fpUpdatePduHeaderSize = fastpath_get_update_pdu_header_size(&fpUpdatePduHeader, rdp);
1384 fpHeaderSize = fpUpdateHeaderSize + fpUpdatePduHeaderSize;
1385
1386 if (sec_flags & SEC_ENCRYPT)
1387 {
1388 pSignature = Stream_Buffer(fs) + 3;
1389
1390 if (freerdp_settings_get_uint32(rdp->settings, FreeRDP_EncryptionMethods) ==
1391 ENCRYPTION_METHOD_FIPS)
1392 {
1393 pSignature += 4;
1394
1395 if ((pad = 8 - ((DstSize + fpUpdateHeaderSize) % 8)) == 8)
1396 pad = 0;
1397
1398 fpUpdatePduHeader.fipsInformation[0] = 0x10;
1399 fpUpdatePduHeader.fipsInformation[1] = 0x00;
1400 fpUpdatePduHeader.fipsInformation[2] = 0x01;
1401 fpUpdatePduHeader.fipsInformation[3] = pad;
1402 }
1403 }
1404
1405 const size_t len = fpUpdateHeader.size + fpHeaderSize + pad;
1406 if (len > UINT16_MAX)
1407 return FALSE;
1408
1409 fpUpdatePduHeader.length = (UINT16)len;
1410 Stream_ResetPosition(fs);
1411 if (!fastpath_write_update_pdu_header(fastpath->log, fs, &fpUpdatePduHeader, rdp))
1412 return FALSE;
1413 if (!fastpath_write_update_header(fastpath->log, fs, &fpUpdateHeader))
1414 return FALSE;
1415
1416 if (!Stream_CheckAndLogRequiredCapacityWLog(fastpath->log, (fs), (size_t)DstSize + pad))
1417 return FALSE;
1418 Stream_Write(fs, pDstData, DstSize);
1419
1420 if (pad)
1421 Stream_Zero(fs, pad);
1422
1423 BOOL res = FALSE;
1424 if (sec_flags & SEC_ENCRYPT)
1425 {
1426 security_lock(rdp);
1427
1428 should_unlock = TRUE;
1429 UINT32 dataSize = fpUpdateHeaderSize + DstSize + pad;
1430 BYTE* data = Stream_PointerAs(fs, BYTE) - dataSize;
1431
1432 if (freerdp_settings_get_uint32(rdp->settings, FreeRDP_EncryptionMethods) ==
1433 ENCRYPTION_METHOD_FIPS)
1434 {
1435 // TODO: Ensure stream capacity
1436 if (!security_hmac_signature(data, dataSize - pad, pSignature, 8, rdp))
1437 goto unlock;
1438
1439 if (!security_fips_encrypt(data, dataSize, rdp))
1440 goto unlock;
1441 }
1442 else
1443 {
1444 // TODO: Ensure stream capacity
1445 if (sec_flags & SEC_SECURE_CHECKSUM)
1446 status =
1447 security_salted_mac_signature(rdp, data, dataSize, TRUE, pSignature, 8);
1448 else
1449 status = security_mac_signature(rdp, data, dataSize, pSignature, 8);
1450
1451 if (!status || !security_encrypt(data, dataSize, rdp))
1452 goto unlock;
1453 }
1454 }
1455 res = TRUE;
1456
1457 Stream_SealLength(fs);
1458
1459 if (transport_write(rdp->transport, fs) < 0)
1460 {
1461 status = FALSE;
1462 }
1463
1464 unlock:
1465 if (should_unlock)
1466 security_unlock(rdp);
1467
1468 if (!res || !status)
1469 return FALSE;
1470
1471 Stream_Seek(s, SrcSize);
1472 }
1473
1474 return status;
1475}
1476
1477rdpFastPath* fastpath_new(rdpRdp* rdp)
1478{
1479 WINPR_ASSERT(rdp);
1480
1481 rdpFastPath* fastpath = (rdpFastPath*)calloc(1, sizeof(rdpFastPath));
1482
1483 if (!fastpath)
1484 return nullptr;
1485 fastpath->log = WLog_Get(FTAG);
1486 fastpath->rdp = rdp;
1487 fastpath->fragmentation = -1;
1488 fastpath->fs = Stream_New(nullptr, FASTPATH_MAX_PACKET_SIZE);
1489 fastpath->updateData = Stream_New(nullptr, FASTPATH_MAX_PACKET_SIZE);
1490
1491 if (!fastpath->fs || !fastpath->updateData)
1492 goto out_free;
1493
1494 return fastpath;
1495out_free:
1496 fastpath_free(fastpath);
1497 return nullptr;
1498}
1499
1500void fastpath_free(rdpFastPath* fastpath)
1501{
1502 if (fastpath)
1503 {
1504 Stream_Free(fastpath->updateData, TRUE);
1505 Stream_Free(fastpath->fs, TRUE);
1506 free(fastpath);
1507 }
1508}
1509
1510BYTE fastpath_get_encryption_flags(rdpFastPath* fastpath)
1511{
1512 WINPR_ASSERT(fastpath);
1513 return fastpath->encryptionFlags;
1514}
1515
1516BOOL fastpath_decrypt(rdpFastPath* fastpath, wStream* s, UINT16* length)
1517{
1518 WINPR_ASSERT(fastpath);
1519 if (fastpath_get_encryption_flags(fastpath) & FASTPATH_OUTPUT_ENCRYPTED)
1520 {
1521 const UINT16 flags =
1522 (fastpath_get_encryption_flags(fastpath) & FASTPATH_OUTPUT_SECURE_CHECKSUM)
1523 ? SEC_SECURE_CHECKSUM
1524 : 0;
1525
1526 if (!rdp_decrypt(fastpath->rdp, s, length, flags))
1527 return FALSE;
1528 }
1529
1530 return TRUE;
1531}
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.