FreeRDP
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Modules Pages
rdp.c
1
21#include <freerdp/config.h>
22
23#include "settings.h"
24
25#include <winpr/crt.h>
26#include <winpr/string.h>
27#include <winpr/synch.h>
28#include <winpr/assert.h>
29#include <winpr/cast.h>
30#include <winpr/json.h>
31
32#include "rdp.h"
33
34#include "state.h"
35#include "info.h"
36#include "utils.h"
37#include "mcs.h"
38#include "redirection.h"
39
40#include <freerdp/codec/bulk.h>
41#include <freerdp/crypto/per.h>
42#include <freerdp/log.h>
43#include <freerdp/buildflags.h>
44
45#define RDP_TAG FREERDP_TAG("core.rdp")
46
47typedef struct
48{
49 const char* file;
50 const char* fkt;
51 size_t line;
52 DWORD level;
53} log_line_t;
54
55static const char* DATA_PDU_TYPE_STRINGS[80] = {
56 "?",
57 "?", /* 0x00 - 0x01 */
58 "Update", /* 0x02 */
59 "?",
60 "?",
61 "?",
62 "?",
63 "?",
64 "?",
65 "?",
66 "?", /* 0x03 - 0x0A */
67 "?",
68 "?",
69 "?",
70 "?",
71 "?",
72 "?",
73 "?",
74 "?",
75 "?", /* 0x0B - 0x13 */
76 "Control", /* 0x14 */
77 "?",
78 "?",
79 "?",
80 "?",
81 "?",
82 "?", /* 0x15 - 0x1A */
83 "Pointer", /* 0x1B */
84 "Input", /* 0x1C */
85 "?",
86 "?", /* 0x1D - 0x1E */
87 "Synchronize", /* 0x1F */
88 "?", /* 0x20 */
89 "Refresh Rect", /* 0x21 */
90 "Play Sound", /* 0x22 */
91 "Suppress Output", /* 0x23 */
92 "Shutdown Request", /* 0x24 */
93 "Shutdown Denied", /* 0x25 */
94 "Save Session Info", /* 0x26 */
95 "Font List", /* 0x27 */
96 "Font Map", /* 0x28 */
97 "Set Keyboard Indicators", /* 0x29 */
98 "?", /* 0x2A */
99 "Bitmap Cache Persistent List", /* 0x2B */
100 "Bitmap Cache Error", /* 0x2C */
101 "Set Keyboard IME Status", /* 0x2D */
102 "Offscreen Cache Error", /* 0x2E */
103 "Set Error Info", /* 0x2F */
104 "Draw Nine Grid Error", /* 0x30 */
105 "Draw GDI+ Error", /* 0x31 */
106 "ARC Status", /* 0x32 */
107 "?",
108 "?",
109 "?", /* 0x33 - 0x35 */
110 "Status Info", /* 0x36 */
111 "Monitor Layout", /* 0x37 */
112 "FrameAcknowledge",
113 "?",
114 "?", /* 0x38 - 0x40 */
115 "?",
116 "?",
117 "?",
118 "?",
119 "?",
120 "?" /* 0x41 - 0x46 */
121};
122
123#define rdp_check_monitor_layout_pdu_state(rdp, expected) \
124 rdp_check_monitor_layout_pdu_state_(rdp, expected, __FILE__, __func__, __LINE__)
125
126static BOOL rdp_check_monitor_layout_pdu_state_(const rdpRdp* rdp, BOOL expected, const char* file,
127 const char* fkt, size_t line)
128{
129 WINPR_ASSERT(rdp);
130 if (expected != rdp->monitor_layout_pdu)
131 {
132 const DWORD log_level = WLOG_ERROR;
133 if (WLog_IsLevelActive(rdp->log, log_level))
134 {
135 WLog_PrintMessage(rdp->log, WLOG_MESSAGE_TEXT, log_level, line, file, fkt,
136 "Expected rdp->monitor_layout_pdu == %s",
137 expected ? "TRUE" : "FALSE");
138 }
139 return FALSE;
140 }
141 return TRUE;
142}
143
144#define rdp_set_monitor_layout_pdu_state(rdp, expected) \
145 rdp_set_monitor_layout_pdu_state_(rdp, expected, __FILE__, __func__, __LINE__)
146static BOOL rdp_set_monitor_layout_pdu_state_(rdpRdp* rdp, BOOL value, const char* file,
147 const char* fkt, size_t line)
148{
149
150 WINPR_ASSERT(rdp);
151 if (value && (value == rdp->monitor_layout_pdu))
152 {
153 const DWORD log_level = WLOG_WARN;
154 if (WLog_IsLevelActive(rdp->log, log_level))
155 {
156 WLog_PrintMessage(rdp->log, WLOG_MESSAGE_TEXT, log_level, line, file, fkt,
157 "rdp->monitor_layout_pdu == TRUE, expected FALSE");
158 }
159 return FALSE;
160 }
161 rdp->monitor_layout_pdu = value;
162 return TRUE;
163}
164
165const char* data_pdu_type_to_string(UINT8 type)
166{
167 if (type >= ARRAYSIZE(DATA_PDU_TYPE_STRINGS))
168 return "???";
169 return DATA_PDU_TYPE_STRINGS[type];
170}
171
172static BOOL rdp_read_flow_control_pdu(rdpRdp* rdp, wStream* s, UINT16* type, UINT16* channel_id);
173static BOOL rdp_write_share_control_header(rdpRdp* rdp, wStream* s, size_t length, UINT16 type,
174 UINT16 channel_id);
175static BOOL rdp_write_share_data_header(rdpRdp* rdp, wStream* s, size_t length, BYTE type,
176 UINT32 share_id);
177
188BOOL rdp_read_security_header(rdpRdp* rdp, wStream* s, UINT16* flags, UINT16* length)
189{
190 char buffer[256] = { 0 };
191 WINPR_ASSERT(s);
192 WINPR_ASSERT(flags);
193 WINPR_ASSERT(rdp);
194
195 /* Basic Security Header */
196 if ((length && (*length < 4)))
197 {
198 WLog_Print(rdp->log, WLOG_WARN,
199 "invalid security header length, have %" PRIu16 ", must be >= 4", *length);
200 return FALSE;
201 }
202 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
203 return FALSE;
204
205 *flags = Stream_Get_UINT16(s); /* flags */
206 const uint16_t flagsHi = Stream_Get_UINT16(s); /* flagsHi (unused) */
207 if ((*flags & SEC_FLAGSHI_VALID) != 0)
208 {
209 WLog_Print(rdp->log, WLOG_WARN,
210 "[MS-RDPBCGR] 2.2.8.1.1.2.1 Basic (TS_SECURITY_HEADER) SEC_FLAGSHI_VALID field "
211 "set: flagsHi=0x%04" PRIx16,
212 flagsHi);
213 }
214 WLog_Print(rdp->log, WLOG_TRACE, "%s",
215 rdp_security_flag_string(*flags, buffer, sizeof(buffer)));
216 if (length)
217 *length -= 4;
218
219 return TRUE;
220}
221
231BOOL rdp_write_security_header(rdpRdp* rdp, wStream* s, UINT16 flags)
232{
233 char buffer[256] = { 0 };
234 WINPR_ASSERT(s);
235 WINPR_ASSERT(rdp);
236
237 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 4))
238 return FALSE;
239
240 WLog_Print(rdp->log, WLOG_TRACE, "%s", rdp_security_flag_string(flags, buffer, sizeof(buffer)));
241 /* Basic Security Header */
242 WINPR_ASSERT((flags & SEC_FLAGSHI_VALID) == 0); /* SEC_FLAGSHI_VALID is unsupported */
243 Stream_Write_UINT16(s, flags); /* flags */
244 Stream_Write_UINT16(s, 0); /* flagsHi (unused) */
245 return TRUE;
246}
247
248BOOL rdp_read_share_control_header(rdpRdp* rdp, wStream* s, UINT16* tpktLength,
249 UINT16* remainingLength, UINT16* type, UINT16* channel_id)
250{
251 UINT16 len = 0;
252 UINT16 tmp = 0;
253
254 WINPR_ASSERT(rdp);
255 WINPR_ASSERT(s);
256 WINPR_ASSERT(type);
257 WINPR_ASSERT(channel_id);
258
259 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
260 return FALSE;
261
262 /* Share Control Header */
263 Stream_Read_UINT16(s, len); /* totalLength */
264
265 /* If length is 0x8000 then we actually got a flow control PDU that we should ignore
266 http://msdn.microsoft.com/en-us/library/cc240576.aspx */
267 if (len == 0x8000)
268 {
269 if (!rdp_read_flow_control_pdu(rdp, s, type, channel_id))
270 return FALSE;
271 *channel_id = 0;
272 if (tpktLength)
273 *tpktLength = 8; /* Flow control PDU is 8 bytes */
274 if (remainingLength)
275 *remainingLength = 0;
276
277 char buffer[128] = { 0 };
278 WLog_Print(rdp->log, WLOG_DEBUG,
279 "[Flow control PDU] type=%s, tpktLength=%" PRIuz ", remainingLength=%" PRIuz,
280 pdu_type_to_str(*type, buffer, sizeof(buffer)), tpktLength ? *tpktLength : 0,
281 remainingLength ? *remainingLength : 0);
282 return TRUE;
283 }
284
285 if (len < 4U)
286 {
287 WLog_Print(rdp->log, WLOG_ERROR,
288 "Invalid share control header, length is %" PRIu16 ", must be >4", len);
289 return FALSE;
290 }
291
292 if (tpktLength)
293 *tpktLength = len;
294
295 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
296 return FALSE;
297
298 Stream_Read_UINT16(s, tmp); /* pduType */
299 *type = tmp & 0x0F; /* type is in the 4 least significant bits */
300
301 size_t remLen = len - 4;
302 if (len > 5)
303 {
304 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
305 return FALSE;
306
307 Stream_Read_UINT16(s, *channel_id); /* pduSource */
308 remLen = len - 6;
309 }
310 else
311 *channel_id = 0; /* Windows XP can send such short DEACTIVATE_ALL PDUs. */
312
313 char buffer[128] = { 0 };
314 WLog_Print(rdp->log, WLOG_DEBUG, "type=%s, tpktLength=%" PRIuz ", remainingLength=%" PRIuz,
315 pdu_type_to_str(*type, buffer, sizeof(buffer)), len, remLen);
316 if (remainingLength)
317 {
318 WINPR_ASSERT(remLen <= UINT16_MAX);
319 *remainingLength = (UINT16)remLen;
320 }
321 return Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, remLen);
322}
323
324BOOL rdp_write_share_control_header(rdpRdp* rdp, wStream* s, size_t length, UINT16 type,
325 UINT16 channel_id)
326{
327 WINPR_ASSERT(s);
328 WINPR_ASSERT(rdp);
329 if (length > UINT16_MAX)
330 return FALSE;
331
332 if (length < RDP_PACKET_HEADER_MAX_LENGTH)
333 return FALSE;
334 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 6))
335 return FALSE;
336 length -= RDP_PACKET_HEADER_MAX_LENGTH;
337 /* Share Control Header */
338 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, length)); /* totalLength */
339 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, type | 0x10)); /* pduType */
340 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, channel_id)); /* pduSource */
341 return TRUE;
342}
343
344BOOL rdp_read_share_data_header(rdpRdp* rdp, wStream* s, UINT16* length, BYTE* type,
345 UINT32* shareId, BYTE* compressedType, UINT16* compressedLength)
346{
347 WINPR_ASSERT(s);
348 WINPR_ASSERT(rdp);
349
350 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
351 return FALSE;
352
353 /* Share Data Header */
354 Stream_Read_UINT32(s, *shareId); /* shareId (4 bytes) */
355 Stream_Seek_UINT8(s); /* pad1 (1 byte) */
356 Stream_Seek_UINT8(s); /* streamId (1 byte) */
357 Stream_Read_UINT16(s, *length); /* uncompressedLength (2 bytes) */
358 Stream_Read_UINT8(s, *type); /* pduType2, Data PDU Type (1 byte) */
359 Stream_Read_UINT8(s, *compressedType); /* compressedType (1 byte) */
360 Stream_Read_UINT16(s, *compressedLength); /* compressedLength (2 bytes) */
361 return TRUE;
362}
363
364BOOL rdp_write_share_data_header(rdpRdp* rdp, wStream* s, size_t length, BYTE type, UINT32 share_id)
365{
366 const size_t headerLen = RDP_PACKET_HEADER_MAX_LENGTH + RDP_SHARE_CONTROL_HEADER_LENGTH +
367 RDP_SHARE_DATA_HEADER_LENGTH;
368
369 WINPR_ASSERT(s);
370 WINPR_ASSERT(rdp);
371 if (length > UINT16_MAX)
372 return FALSE;
373
374 if (length < headerLen)
375 return FALSE;
376 length -= headerLen;
377 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 12))
378 return FALSE;
379
380 /* Share Data Header */
381 Stream_Write_UINT32(s, share_id); /* shareId (4 bytes) */
382 Stream_Write_UINT8(s, 0); /* pad1 (1 byte) */
383 Stream_Write_UINT8(s, STREAM_LOW); /* streamId (1 byte) */
384 Stream_Write_UINT16(
385 s, WINPR_ASSERTING_INT_CAST(uint16_t, length)); /* uncompressedLength (2 bytes) */
386 Stream_Write_UINT8(s, type); /* pduType2, Data PDU Type (1 byte) */
387 Stream_Write_UINT8(s, 0); /* compressedType (1 byte) */
388 Stream_Write_UINT16(s, 0); /* compressedLength (2 bytes) */
389 return TRUE;
390}
391
392static BOOL rdp_security_stream_init(rdpRdp* rdp, wStream* s, BOOL sec_header, UINT16* sec_flags)
393{
394 WINPR_ASSERT(rdp);
395 WINPR_ASSERT(s);
396 WINPR_ASSERT(sec_flags);
397
398 if (rdp->do_crypt)
399 {
400 if (!Stream_SafeSeek(s, 12))
401 return FALSE;
402
403 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
404 {
405 if (!Stream_SafeSeek(s, 4))
406 return FALSE;
407 }
408
409 *sec_flags |= SEC_ENCRYPT;
410
411 if (rdp->do_secure_checksum)
412 *sec_flags |= SEC_SECURE_CHECKSUM;
413 }
414 else if (*sec_flags != 0 || sec_header)
415 {
416 if (!Stream_SafeSeek(s, 4))
417 return FALSE;
418 }
419
420 return TRUE;
421}
422
423wStream* rdp_send_stream_init(rdpRdp* rdp, UINT16* sec_flags)
424{
425 wStream* s = NULL;
426
427 WINPR_ASSERT(rdp);
428 WINPR_ASSERT(rdp->transport);
429
430 s = transport_send_stream_init(rdp->transport, 4096);
431
432 if (!s)
433 return NULL;
434
435 if (!Stream_SafeSeek(s, RDP_PACKET_HEADER_MAX_LENGTH))
436 goto fail;
437
438 if (!rdp_security_stream_init(rdp, s, FALSE, sec_flags))
439 goto fail;
440
441 return s;
442fail:
443 Stream_Release(s);
444 return NULL;
445}
446
447wStream* rdp_send_stream_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
448{
449 wStream* s = rdp_send_stream_init(rdp, sec_flags);
450
451 if (!s)
452 return NULL;
453
454 if (!Stream_SafeSeek(s, RDP_SHARE_CONTROL_HEADER_LENGTH))
455 goto fail;
456
457 return s;
458fail:
459 Stream_Release(s);
460 return NULL;
461}
462
463wStream* rdp_data_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
464{
465 wStream* s = rdp_send_stream_pdu_init(rdp, sec_flags);
466
467 if (!s)
468 return NULL;
469
470 if (!Stream_SafeSeek(s, RDP_SHARE_DATA_HEADER_LENGTH))
471 goto fail;
472
473 return s;
474fail:
475 Stream_Release(s);
476 return NULL;
477}
478
479BOOL rdp_set_error_info(rdpRdp* rdp, UINT32 errorInfo)
480{
481 WINPR_ASSERT(rdp);
482
483 rdp->errorInfo = errorInfo;
484
485 if (rdp->errorInfo != ERRINFO_SUCCESS)
486 {
487 rdpContext* context = rdp->context;
488 WINPR_ASSERT(context);
489
490 rdp_print_errinfo(rdp->errorInfo);
491
492 if (context)
493 {
494 freerdp_set_last_error_log(context, MAKE_FREERDP_ERROR(ERRINFO, errorInfo));
495
496 if (context->pubSub)
497 {
498 ErrorInfoEventArgs e = { 0 };
499 EventArgsInit(&e, "freerdp");
500 e.code = rdp->errorInfo;
501 PubSub_OnErrorInfo(context->pubSub, context, &e);
502 }
503 }
504 else
505 WLog_Print(rdp->log, WLOG_ERROR, "missing context=%p", context);
506 }
507 else
508 {
509 freerdp_set_last_error_log(rdp->context, FREERDP_ERROR_SUCCESS);
510 }
511
512 return TRUE;
513}
514
515wStream* rdp_message_channel_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
516{
517 wStream* s = NULL;
518
519 WINPR_ASSERT(rdp);
520
521 s = transport_send_stream_init(rdp->transport, 4096);
522
523 if (!s)
524 return NULL;
525
526 if (!Stream_SafeSeek(s, RDP_PACKET_HEADER_MAX_LENGTH))
527 goto fail;
528
529 if (!rdp_security_stream_init(rdp, s, TRUE, sec_flags))
530 goto fail;
531
532 return s;
533fail:
534 Stream_Release(s);
535 return NULL;
536}
537
548BOOL rdp_read_header(rdpRdp* rdp, wStream* s, UINT16* length, UINT16* channelId)
549{
550 BYTE li = 0;
551 BYTE code = 0;
552 BYTE choice = 0;
553 UINT16 initiator = 0;
554
555 WINPR_ASSERT(rdp);
556 WINPR_ASSERT(rdp->settings);
557 WINPR_ASSERT(s);
558 DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataRequest
559 : DomainMCSPDU_SendDataIndication;
560
561 *channelId = 0; /* Initialize in case of early abort */
562 if (!tpkt_read_header(s, length))
563 return FALSE;
564
565 if (!tpdu_read_header(s, &code, &li, *length))
566 return FALSE;
567
568 if (code != X224_TPDU_DATA)
569 {
570 if (code == X224_TPDU_DISCONNECT_REQUEST)
571 {
572 WLog_Print(rdp->log, WLOG_WARN, "Received X224_TPDU_DISCONNECT_REQUEST, terminating");
573 utils_abort_connect(rdp);
574 return TRUE;
575 }
576
577 WLog_Print(rdp->log, WLOG_WARN,
578 "Unexpected X224 TPDU type %s [%08" PRIx32 "] instead of %s",
579 tpdu_type_to_string(code), code, tpdu_type_to_string(X224_TPDU_DATA));
580 return FALSE;
581 }
582
583 if (!per_read_choice(s, &choice))
584 return FALSE;
585
586 const DomainMCSPDU domainMCSPDU = (DomainMCSPDU)(choice >> 2);
587
588 if (domainMCSPDU != MCSPDU)
589 {
590 if (domainMCSPDU != DomainMCSPDU_DisconnectProviderUltimatum)
591 {
592 WLog_Print(rdp->log, WLOG_WARN, "Received %s instead of %s",
593 mcs_domain_pdu_string(domainMCSPDU), mcs_domain_pdu_string(MCSPDU));
594 return FALSE;
595 }
596 }
597
598 MCSPDU = domainMCSPDU;
599
600 if (*length < 8U)
601 {
602 WLog_Print(rdp->log, WLOG_WARN, "TPDU invalid length, got %" PRIu16 ", expected at least 8",
603 *length);
604 return FALSE;
605 }
606
607 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length - 8))
608 return FALSE;
609
610 if (MCSPDU == DomainMCSPDU_DisconnectProviderUltimatum)
611 {
612 int reason = 0;
613 TerminateEventArgs e = { 0 };
614
615 if (!mcs_recv_disconnect_provider_ultimatum(rdp->mcs, s, &reason))
616 return FALSE;
617
618 rdpContext* context = rdp->context;
619 WINPR_ASSERT(context);
620 context->disconnectUltimatum = reason;
621
622 if (rdp->errorInfo == ERRINFO_SUCCESS)
623 {
629 UINT32 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
630 if (reason == Disconnect_Ultimatum_provider_initiated)
631 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
632 else if (reason == Disconnect_Ultimatum_user_requested)
633 errorInfo = ERRINFO_LOGOFF_BY_USER;
634
635 rdp_set_error_info(rdp, errorInfo);
636 }
637
638 WLog_Print(rdp->log, WLOG_DEBUG, "DisconnectProviderUltimatum: reason: %d", reason);
639 utils_abort_connect(rdp);
640 EventArgsInit(&e, "freerdp");
641 e.code = 0;
642 PubSub_OnTerminate(rdp->pubSub, context, &e);
643 return TRUE;
644 }
645
646 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 5))
647 return FALSE;
648
649 if (!per_read_integer16(s, &initiator, MCS_BASE_CHANNEL_ID)) /* initiator (UserId) */
650 return FALSE;
651
652 if (!per_read_integer16(s, channelId, 0)) /* channelId */
653 return FALSE;
654
655 const uint8_t dataPriority = Stream_Get_UINT8(s); /* dataPriority + Segmentation (0x70) */
656 WLog_Print(rdp->log, WLOG_TRACE, "dataPriority=%" PRIu8, dataPriority);
657
658 if (!per_read_length(s, length)) /* userData (OCTET_STRING) */
659 return FALSE;
660
661 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length))
662 return FALSE;
663
664 return TRUE;
665}
666
677BOOL rdp_write_header(rdpRdp* rdp, wStream* s, size_t length, UINT16 channelId, UINT16 sec_flags)
678{
679 WINPR_ASSERT(rdp);
680 WINPR_ASSERT(rdp->settings);
681 WINPR_ASSERT(s);
682 WINPR_ASSERT(length >= RDP_PACKET_HEADER_MAX_LENGTH);
683 if (length > UINT16_MAX)
684 return FALSE;
685
686 DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataIndication
687 : DomainMCSPDU_SendDataRequest;
688
689 if ((sec_flags & SEC_ENCRYPT) && (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS))
690 {
691 const UINT16 body_length = (UINT16)length - RDP_PACKET_HEADER_MAX_LENGTH;
692 const UINT16 pad = 8 - (body_length % 8);
693
694 if (pad != 8)
695 length += pad;
696 }
697
698 if (!mcs_write_domain_mcspdu_header(s, MCSPDU, (UINT16)length, 0))
699 return FALSE;
700 if (!per_write_integer16(s, rdp->mcs->userId, MCS_BASE_CHANNEL_ID)) /* initiator */
701 return FALSE;
702 if (!per_write_integer16(s, channelId, 0)) /* channelId */
703 return FALSE;
704 if (!Stream_EnsureRemainingCapacity(s, 3))
705 return FALSE;
706 Stream_Write_UINT8(s, 0x70); /* dataPriority + segmentation */
707 /*
708 * We always encode length in two bytes, even though we could use
709 * only one byte if length <= 0x7F. It is just easier that way,
710 * because we can leave room for fixed-length header, store all
711 * the data first and then store the header.
712 */
713 length = (length - RDP_PACKET_HEADER_MAX_LENGTH) | 0x8000;
714 Stream_Write_UINT16_BE(
715 s, WINPR_ASSERTING_INT_CAST(uint16_t, length)); /* userData (OCTET_STRING) */
716 return TRUE;
717}
718
719static BOOL rdp_security_stream_out(rdpRdp* rdp, wStream* s, size_t length, UINT16 sec_flags,
720 UINT32* pad)
721{
722 BOOL status = 0;
723 WINPR_ASSERT(rdp);
724 if (length > UINT16_MAX)
725 return FALSE;
726
727 *pad = 0;
728
729 if (sec_flags != 0)
730 {
731 WINPR_ASSERT(sec_flags <= UINT16_MAX);
732 if (!rdp_write_security_header(rdp, s, sec_flags))
733 return FALSE;
734
735 if (sec_flags & SEC_ENCRYPT)
736 {
737 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
738 {
739 BYTE* data = Stream_PointerAs(s, BYTE) + 12;
740 const size_t size = WINPR_ASSERTING_INT_CAST(size_t, (data - Stream_Buffer(s)));
741 if (size > length)
742 return FALSE;
743
744 length -= size;
745
746 Stream_Write_UINT16(s, 0x10); /* length */
747 Stream_Write_UINT8(s, 0x1); /* TSFIPS_VERSION 1*/
748 /* handle padding */
749 *pad = 8 - (length % 8);
750
751 if (*pad == 8)
752 *pad = 0;
753
754 if (*pad)
755 memset(data + length, 0, *pad);
756
757 Stream_Write_UINT8(s, WINPR_ASSERTING_INT_CAST(uint8_t, *pad));
758
759 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
760 return FALSE;
761 if (!security_hmac_signature(data, length, Stream_Pointer(s), 8, rdp))
762 return FALSE;
763
764 Stream_Seek(s, 8);
765 if (!security_fips_encrypt(data, length + *pad, rdp))
766 return FALSE;
767 }
768 else
769 {
770 const BYTE* data = Stream_PointerAs(s, const BYTE) + 8;
771 const size_t diff = Stream_GetPosition(s) + 8ULL;
772 if (diff > length)
773 return FALSE;
774 length -= diff;
775
776 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
777 return FALSE;
778 if (sec_flags & SEC_SECURE_CHECKSUM)
779 status = security_salted_mac_signature(rdp, data, (UINT32)length, TRUE,
780 Stream_Pointer(s), 8);
781 else
782 status = security_mac_signature(rdp, data, (UINT32)length,
783 Stream_PointerAs(s, BYTE), 8);
784
785 if (!status)
786 return FALSE;
787
788 Stream_Seek(s, 8);
789
790 if (!security_encrypt(Stream_Pointer(s), length, rdp))
791 return FALSE;
792 }
793 }
794 }
795
796 return TRUE;
797}
798
799static UINT32 rdp_get_sec_bytes(rdpRdp* rdp, UINT16 sec_flags)
800{
801 UINT32 sec_bytes = 0;
802
803 if (sec_flags & SEC_ENCRYPT)
804 {
805 sec_bytes = 12;
806
807 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
808 sec_bytes += 4;
809 }
810 else if (sec_flags != 0)
811 {
812 sec_bytes = 4;
813 }
814 else
815 {
816 sec_bytes = 0;
817 }
818
819 return sec_bytes;
820}
821
829BOOL rdp_send(rdpRdp* rdp, wStream* s, UINT16 channel_id, UINT16 sec_flags)
830{
831 BOOL rc = FALSE;
832 UINT32 pad = 0;
833 BOOL should_unlock = FALSE;
834
835 if (!s)
836 return FALSE;
837
838 if (!rdp)
839 goto fail;
840
841 if (sec_flags & SEC_ENCRYPT)
842 {
843 if (!security_lock(rdp))
844 goto fail;
845 should_unlock = TRUE;
846 }
847
848 size_t length = Stream_GetPosition(s);
849 Stream_SetPosition(s, 0);
850 if (!rdp_write_header(rdp, s, length, channel_id, sec_flags))
851 goto fail;
852
853 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
854 goto fail;
855
856 length += pad;
857 Stream_SetPosition(s, length);
858 Stream_SealLength(s);
859
860 if (transport_write(rdp->transport, s) < 0)
861 goto fail;
862
863 rc = TRUE;
864fail:
865 if (should_unlock && !security_unlock(rdp))
866 rc = FALSE;
867 Stream_Release(s);
868 return rc;
869}
870
871BOOL rdp_send_pdu(rdpRdp* rdp, wStream* s, UINT16 type, UINT16 channel_id, UINT16 sec_flags)
872{
873 BOOL rc = FALSE;
874 UINT32 sec_bytes = 0;
875 size_t sec_hold = 0;
876 UINT32 pad = 0;
877 BOOL should_unlock = FALSE;
878
879 if (!s)
880 return FALSE;
881
882 if (!rdp)
883 goto fail;
884
885 if (sec_flags & SEC_ENCRYPT)
886 {
887 if (!security_lock(rdp))
888 goto fail;
889 should_unlock = TRUE;
890 }
891
892 size_t length = Stream_GetPosition(s);
893 Stream_SetPosition(s, 0);
894 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
895 goto fail;
896 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
897 sec_hold = Stream_GetPosition(s);
898 Stream_Seek(s, sec_bytes);
899 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, type, channel_id))
900 goto fail;
901 Stream_SetPosition(s, sec_hold);
902
903 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
904 goto fail;
905
906 length += pad;
907 Stream_SetPosition(s, length);
908 Stream_SealLength(s);
909
910 if (transport_write(rdp->transport, s) < 0)
911 goto fail;
912
913 rc = TRUE;
914fail:
915 if (should_unlock && !security_unlock(rdp))
916 rc = FALSE;
917 return rc;
918}
919
920BOOL rdp_send_data_pdu(rdpRdp* rdp, wStream* s, BYTE type, UINT16 channel_id, UINT16 sec_flags)
921{
922 BOOL rc = FALSE;
923 UINT32 sec_bytes = 0;
924 size_t sec_hold = 0;
925 UINT32 pad = 0;
926 BOOL should_unlock = FALSE;
927
928 if (!s)
929 return FALSE;
930
931 if (!rdp)
932 goto fail;
933
934 if (sec_flags & SEC_ENCRYPT)
935 {
936 if (!security_lock(rdp))
937 goto fail;
938 should_unlock = TRUE;
939 }
940
941 size_t length = Stream_GetPosition(s);
942 Stream_SetPosition(s, 0);
943 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
944 goto fail;
945 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
946 sec_hold = Stream_GetPosition(s);
947 Stream_Seek(s, sec_bytes);
948 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, PDU_TYPE_DATA, channel_id))
949 goto fail;
950 if (!rdp_write_share_data_header(rdp, s, length - sec_bytes, type, rdp->settings->ShareId))
951 goto fail;
952 Stream_SetPosition(s, sec_hold);
953
954 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
955 goto fail;
956
957 length += pad;
958 Stream_SetPosition(s, length);
959 Stream_SealLength(s);
960 WLog_Print(rdp->log, WLOG_DEBUG,
961 "sending data (type=0x%x size=%" PRIuz " channelId=%" PRIu16 ")", type,
962 Stream_Length(s), channel_id);
963
964 rdp->outPackets++;
965 if (transport_write(rdp->transport, s) < 0)
966 goto fail;
967
968 rc = TRUE;
969fail:
970 if (should_unlock && !security_unlock(rdp))
971 rc = FALSE;
972 Stream_Release(s);
973 return rc;
974}
975
976BOOL rdp_send_message_channel_pdu(rdpRdp* rdp, wStream* s, UINT16 sec_flags)
977{
978 BOOL rc = FALSE;
979 UINT32 pad = 0;
980 BOOL should_unlock = FALSE;
981
982 WINPR_ASSERT(rdp);
983 WINPR_ASSERT(s);
984
985 if (sec_flags & SEC_ENCRYPT)
986 {
987 if (!security_lock(rdp))
988 goto fail;
989 should_unlock = TRUE;
990 }
991
992 size_t length = Stream_GetPosition(s);
993 Stream_SetPosition(s, 0);
994 if (!rdp_write_header(rdp, s, length, rdp->mcs->messageChannelId, sec_flags))
995 goto fail;
996
997 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
998 goto fail;
999
1000 length += pad;
1001 Stream_SetPosition(s, length);
1002 Stream_SealLength(s);
1003
1004 if (transport_write(rdp->transport, s) < 0)
1005 goto fail;
1006
1007 rc = TRUE;
1008fail:
1009 if (should_unlock && !security_unlock(rdp))
1010 rc = FALSE;
1011 Stream_Release(s);
1012 return rc;
1013}
1014
1015static BOOL rdp_recv_server_shutdown_denied_pdu(WINPR_ATTR_UNUSED rdpRdp* rdp,
1016 WINPR_ATTR_UNUSED wStream* s)
1017{
1018 return TRUE;
1019}
1020
1021static BOOL rdp_recv_server_set_keyboard_indicators_pdu(rdpRdp* rdp, wStream* s)
1022{
1023 WINPR_ASSERT(rdp);
1024 WINPR_ASSERT(s);
1025
1026 rdpContext* context = rdp->context;
1027 WINPR_ASSERT(context);
1028 WINPR_ASSERT(context->update);
1029
1030 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1031 return FALSE;
1032
1033 const uint16_t unitId = Stream_Get_UINT16(s); /* unitId (2 bytes) */
1034 if (unitId != 0)
1035 {
1036 WLog_Print(rdp->log, WLOG_WARN,
1037 "[MS-RDPBCGR] 2.2.8.2.1.1 Set Keyboard Indicators PDU Data "
1038 "(TS_SET_KEYBOARD_INDICATORS_PDU)::unitId should be 0, is %" PRIu8,
1039 unitId);
1040 }
1041 const UINT16 ledFlags = Stream_Get_UINT16(s); /* ledFlags (2 bytes) */
1042 return IFCALLRESULT(TRUE, context->update->SetKeyboardIndicators, context, ledFlags);
1043}
1044
1045static BOOL rdp_recv_server_set_keyboard_ime_status_pdu(rdpRdp* rdp, wStream* s)
1046{
1047 if (!rdp || !rdp->input)
1048 return FALSE;
1049
1050 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 10))
1051 return FALSE;
1052
1053 const uint16_t unitId = Stream_Get_UINT16(s); /* unitId (2 bytes) */
1054 if (unitId != 0)
1055 {
1056 WLog_Print(rdp->log, WLOG_WARN,
1057 "[MS-RDPBCGR] 2.2.8.2.2.1 Set Keyboard IME Status PDU Data "
1058 "(TS_SET_KEYBOARD_IME_STATUS_PDU)::unitId should be 0, is %" PRIu8,
1059 unitId);
1060 }
1061 const uint32_t imeState = Stream_Get_UINT32(s); /* imeState (4 bytes) */
1062 const uint32_t imeConvMode = Stream_Get_UINT32(s); /* imeConvMode (4 bytes) */
1063 return IFCALLRESULT(TRUE, rdp->update->SetKeyboardImeStatus, rdp->context, unitId, imeState,
1064 imeConvMode);
1065}
1066
1067static BOOL rdp_recv_set_error_info_data_pdu(rdpRdp* rdp, wStream* s)
1068{
1069 UINT32 errorInfo = 0;
1070
1071 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1072 return FALSE;
1073
1074 Stream_Read_UINT32(s, errorInfo); /* errorInfo (4 bytes) */
1075 return rdp_set_error_info(rdp, errorInfo);
1076}
1077
1078static BOOL rdp_recv_server_auto_reconnect_status_pdu(rdpRdp* rdp, wStream* s)
1079{
1080 UINT32 arcStatus = 0;
1081
1082 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1083 return FALSE;
1084
1085 Stream_Read_UINT32(s, arcStatus); /* arcStatus (4 bytes) */
1086 WLog_Print(rdp->log, WLOG_WARN, "AutoReconnectStatus: 0x%08" PRIX32 "", arcStatus);
1087 return TRUE;
1088}
1089
1090static BOOL rdp_recv_server_status_info_pdu(rdpRdp* rdp, wStream* s)
1091{
1092 UINT32 statusCode = 0;
1093
1094 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1095 return FALSE;
1096
1097 Stream_Read_UINT32(s, statusCode); /* statusCode (4 bytes) */
1098
1099 if (rdp->update->ServerStatusInfo)
1100 return rdp->update->ServerStatusInfo(rdp->context, statusCode);
1101
1102 return TRUE;
1103}
1104
1105static BOOL rdp_recv_monitor_layout_pdu(rdpRdp* rdp, wStream* s)
1106{
1107 UINT32 monitorCount = 0;
1108 MONITOR_DEF* monitorDefArray = NULL;
1109 BOOL ret = TRUE;
1110
1111 WINPR_ASSERT(rdp);
1112 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1113 return FALSE;
1114
1115 Stream_Read_UINT32(s, monitorCount); /* monitorCount (4 bytes) */
1116
1117 if (!Stream_CheckAndLogRequiredLengthOfSizeWLog(rdp->log, s, monitorCount, 20ull))
1118 return FALSE;
1119
1120 monitorDefArray = (MONITOR_DEF*)calloc(monitorCount, sizeof(MONITOR_DEF));
1121
1122 if (!monitorDefArray)
1123 return FALSE;
1124
1125 for (UINT32 index = 0; index < monitorCount; index++)
1126 {
1127 MONITOR_DEF* monitor = &monitorDefArray[index];
1128 Stream_Read_INT32(s, monitor->left); /* left (4 bytes) */
1129 Stream_Read_INT32(s, monitor->top); /* top (4 bytes) */
1130 Stream_Read_INT32(s, monitor->right); /* right (4 bytes) */
1131 Stream_Read_INT32(s, monitor->bottom); /* bottom (4 bytes) */
1132 Stream_Read_UINT32(s, monitor->flags); /* flags (4 bytes) */
1133 }
1134
1135 IFCALLRET(rdp->update->RemoteMonitors, ret, rdp->context, monitorCount, monitorDefArray);
1136 free(monitorDefArray);
1137 if (!ret)
1138 return FALSE;
1139 return rdp_set_monitor_layout_pdu_state(rdp, TRUE);
1140}
1141
1142state_run_t rdp_recv_data_pdu(rdpRdp* rdp, wStream* s)
1143{
1144 BYTE type = 0;
1145 wStream* cs = NULL;
1146 UINT16 length = 0;
1147 UINT32 shareId = 0;
1148 BYTE compressedType = 0;
1149 UINT16 compressedLength = 0;
1150
1151 WINPR_ASSERT(rdp);
1152 if (!rdp_read_share_data_header(rdp, s, &length, &type, &shareId, &compressedType,
1153 &compressedLength))
1154 {
1155 WLog_Print(rdp->log, WLOG_ERROR, "rdp_read_share_data_header() failed");
1156 return STATE_RUN_FAILED;
1157 }
1158
1159 cs = s;
1160
1161 if (compressedType & PACKET_COMPRESSED)
1162 {
1163 if (compressedLength < 18)
1164 {
1165 WLog_Print(rdp->log, WLOG_ERROR,
1166 "bulk_decompress: not enough bytes for compressedLength %" PRIu16 "",
1167 compressedLength);
1168 return STATE_RUN_FAILED;
1169 }
1170
1171 UINT32 DstSize = 0;
1172 const BYTE* pDstData = NULL;
1173 UINT16 SrcSize = compressedLength - 18;
1174
1175 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, SrcSize))
1176 {
1177 WLog_Print(rdp->log, WLOG_ERROR,
1178 "bulk_decompress: not enough bytes for compressedLength %" PRIu16 "",
1179 compressedLength);
1180 return STATE_RUN_FAILED;
1181 }
1182
1183 if (bulk_decompress(rdp->bulk, Stream_ConstPointer(s), SrcSize, &pDstData, &DstSize,
1184 compressedType))
1185 {
1186 cs = transport_take_from_pool(rdp->transport, DstSize);
1187 if (!cs)
1188 {
1189 WLog_Print(rdp->log, WLOG_ERROR, "Couldn't take stream from pool");
1190 return STATE_RUN_FAILED;
1191 }
1192
1193 Stream_SetPosition(cs, 0);
1194 Stream_Write(cs, pDstData, DstSize);
1195 Stream_SealLength(cs);
1196 Stream_SetPosition(cs, 0);
1197 }
1198 else
1199 {
1200 WLog_Print(rdp->log, WLOG_ERROR, "bulk_decompress() failed");
1201 return STATE_RUN_FAILED;
1202 }
1203
1204 Stream_Seek(s, SrcSize);
1205 }
1206
1207 WLog_Print(rdp->log, WLOG_DEBUG, "recv %s Data PDU (0x%02" PRIX8 "), length: %" PRIu16 "",
1208 data_pdu_type_to_string(type), type, length);
1209
1210 switch (type)
1211 {
1212 case DATA_PDU_TYPE_UPDATE:
1213 if (!update_recv(rdp->update, cs))
1214 {
1215 WLog_Print(rdp->log, WLOG_ERROR, "DATA_PDU_TYPE_UPDATE - update_recv() failed");
1216 goto out_fail;
1217 }
1218
1219 break;
1220
1221 case DATA_PDU_TYPE_CONTROL:
1222 if (!rdp_recv_server_control_pdu(rdp, cs))
1223 {
1224 WLog_Print(rdp->log, WLOG_ERROR,
1225 "DATA_PDU_TYPE_CONTROL - rdp_recv_server_control_pdu() failed");
1226 goto out_fail;
1227 }
1228
1229 break;
1230
1231 case DATA_PDU_TYPE_POINTER:
1232 if (!update_recv_pointer(rdp->update, cs))
1233 {
1234 WLog_Print(rdp->log, WLOG_ERROR,
1235 "DATA_PDU_TYPE_POINTER - update_recv_pointer() failed");
1236 goto out_fail;
1237 }
1238
1239 break;
1240
1241 case DATA_PDU_TYPE_SYNCHRONIZE:
1242 if (!rdp_recv_server_synchronize_pdu(rdp, cs))
1243 {
1244 WLog_Print(rdp->log, WLOG_ERROR,
1245 "DATA_PDU_TYPE_SYNCHRONIZE - rdp_recv_synchronize_pdu() failed");
1246 goto out_fail;
1247 }
1248
1249 break;
1250
1251 case DATA_PDU_TYPE_PLAY_SOUND:
1252 if (!update_recv_play_sound(rdp->update, cs))
1253 {
1254 WLog_Print(rdp->log, WLOG_ERROR,
1255 "DATA_PDU_TYPE_PLAY_SOUND - update_recv_play_sound() failed");
1256 goto out_fail;
1257 }
1258
1259 break;
1260
1261 case DATA_PDU_TYPE_SHUTDOWN_DENIED:
1262 if (!rdp_recv_server_shutdown_denied_pdu(rdp, cs))
1263 {
1264 WLog_Print(
1265 rdp->log, WLOG_ERROR,
1266 "DATA_PDU_TYPE_SHUTDOWN_DENIED - rdp_recv_server_shutdown_denied_pdu() failed");
1267 goto out_fail;
1268 }
1269
1270 break;
1271
1272 case DATA_PDU_TYPE_SAVE_SESSION_INFO:
1273 if (!rdp_recv_save_session_info(rdp, cs))
1274 {
1275 WLog_Print(rdp->log, WLOG_ERROR,
1276 "DATA_PDU_TYPE_SAVE_SESSION_INFO - rdp_recv_save_session_info() failed");
1277 goto out_fail;
1278 }
1279
1280 break;
1281
1282 case DATA_PDU_TYPE_FONT_MAP:
1283 if (!rdp_recv_font_map_pdu(rdp, cs))
1284 {
1285 WLog_Print(rdp->log, WLOG_ERROR,
1286 "DATA_PDU_TYPE_FONT_MAP - rdp_recv_font_map_pdu() failed");
1287 goto out_fail;
1288 }
1289
1290 break;
1291
1292 case DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS:
1293 if (!rdp_recv_server_set_keyboard_indicators_pdu(rdp, cs))
1294 {
1295 WLog_Print(rdp->log, WLOG_ERROR,
1296 "DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS - "
1297 "rdp_recv_server_set_keyboard_indicators_pdu() failed");
1298 goto out_fail;
1299 }
1300
1301 break;
1302
1303 case DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS:
1304 if (!rdp_recv_server_set_keyboard_ime_status_pdu(rdp, cs))
1305 {
1306 WLog_Print(rdp->log, WLOG_ERROR,
1307 "DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS - "
1308 "rdp_recv_server_set_keyboard_ime_status_pdu() failed");
1309 goto out_fail;
1310 }
1311
1312 break;
1313
1314 case DATA_PDU_TYPE_SET_ERROR_INFO:
1315 if (!rdp_recv_set_error_info_data_pdu(rdp, cs))
1316 {
1317 WLog_Print(
1318 rdp->log, WLOG_ERROR,
1319 "DATA_PDU_TYPE_SET_ERROR_INFO - rdp_recv_set_error_info_data_pdu() failed");
1320 goto out_fail;
1321 }
1322
1323 break;
1324
1325 case DATA_PDU_TYPE_ARC_STATUS:
1326 if (!rdp_recv_server_auto_reconnect_status_pdu(rdp, cs))
1327 {
1328 WLog_Print(rdp->log, WLOG_ERROR,
1329 "DATA_PDU_TYPE_ARC_STATUS - "
1330 "rdp_recv_server_auto_reconnect_status_pdu() failed");
1331 goto out_fail;
1332 }
1333
1334 break;
1335
1336 case DATA_PDU_TYPE_STATUS_INFO:
1337 if (!rdp_recv_server_status_info_pdu(rdp, cs))
1338 {
1339 WLog_Print(rdp->log, WLOG_ERROR,
1340 "DATA_PDU_TYPE_STATUS_INFO - rdp_recv_server_status_info_pdu() failed");
1341 goto out_fail;
1342 }
1343
1344 break;
1345
1346 case DATA_PDU_TYPE_MONITOR_LAYOUT:
1347 if (!rdp_recv_monitor_layout_pdu(rdp, cs))
1348 {
1349 WLog_Print(rdp->log, WLOG_ERROR,
1350 "DATA_PDU_TYPE_MONITOR_LAYOUT - rdp_recv_monitor_layout_pdu() failed");
1351 goto out_fail;
1352 }
1353
1354 break;
1355
1356 default:
1357 WLog_Print(rdp->log, WLOG_WARN,
1358 "[UNHANDLED] %s Data PDU (0x%02" PRIX8 "), length: %" PRIu16 "",
1359 data_pdu_type_to_string(type), type, length);
1360 break;
1361 }
1362
1363 if (cs != s)
1364 Stream_Release(cs);
1365
1366 return STATE_RUN_SUCCESS;
1367out_fail:
1368
1369 if (cs != s)
1370 Stream_Release(cs);
1371
1372 return STATE_RUN_FAILED;
1373}
1374
1375state_run_t rdp_recv_message_channel_pdu(rdpRdp* rdp, wStream* s, UINT16 securityFlags)
1376{
1377 WINPR_ASSERT(rdp);
1378 WINPR_ASSERT(s);
1379
1380 if (securityFlags & SEC_AUTODETECT_REQ)
1381 {
1382 /* Server Auto-Detect Request PDU */
1383 return autodetect_recv_request_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1384 }
1385
1386 if (securityFlags & SEC_AUTODETECT_RSP)
1387 {
1388 /* Client Auto-Detect Response PDU */
1389 return autodetect_recv_response_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1390 }
1391
1392 if (securityFlags & SEC_HEARTBEAT)
1393 {
1394 /* Heartbeat PDU */
1395 return rdp_recv_heartbeat_packet(rdp, s);
1396 }
1397
1398 if (securityFlags & SEC_TRANSPORT_REQ)
1399 {
1400 return multitransport_recv_request(rdp->multitransport, s);
1401 }
1402
1403 if (securityFlags & SEC_TRANSPORT_RSP)
1404 {
1405 return multitransport_recv_response(rdp->multitransport, s);
1406 }
1407
1408 if (securityFlags & SEC_LICENSE_PKT)
1409 {
1410 return license_recv(rdp->license, s);
1411 }
1412
1413 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
1414 {
1415 return license_recv(rdp->license, s);
1416 }
1417
1418 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
1419 {
1420 return license_recv(rdp->license, s);
1421 }
1422
1423 return STATE_RUN_SUCCESS;
1424}
1425
1426state_run_t rdp_recv_out_of_sequence_pdu(rdpRdp* rdp, wStream* s, UINT16 pduType, UINT16 length)
1427{
1428 state_run_t rc = STATE_RUN_FAILED;
1429 WINPR_ASSERT(rdp);
1430
1431 switch (pduType)
1432 {
1433 case PDU_TYPE_DATA:
1434 rc = rdp_recv_data_pdu(rdp, s);
1435 break;
1436 case PDU_TYPE_SERVER_REDIRECTION:
1437 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1438 break;
1439 case PDU_TYPE_FLOW_RESPONSE:
1440 case PDU_TYPE_FLOW_STOP:
1441 case PDU_TYPE_FLOW_TEST:
1442 rc = STATE_RUN_SUCCESS;
1443 break;
1444 default:
1445 {
1446 char buffer1[256] = { 0 };
1447 char buffer2[256] = { 0 };
1448
1449 WLog_Print(rdp->log, WLOG_ERROR, "expected %s, got %s",
1450 pdu_type_to_str(PDU_TYPE_DEMAND_ACTIVE, buffer1, sizeof(buffer1)),
1451 pdu_type_to_str(pduType, buffer2, sizeof(buffer2)));
1452 rc = STATE_RUN_FAILED;
1453 }
1454 break;
1455 }
1456
1457 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1458 return STATE_RUN_FAILED;
1459 return rc;
1460}
1461
1462BOOL rdp_read_flow_control_pdu(rdpRdp* rdp, wStream* s, UINT16* type, UINT16* channel_id)
1463{
1464 /*
1465 * Read flow control PDU - documented in FlowPDU section in T.128
1466 * http://www.itu.int/rec/T-REC-T.128-199802-S/en
1467 * The specification for the PDU has pad8bits listed BEFORE pduTypeFlow.
1468 * However, so far pad8bits has always been observed to arrive AFTER pduTypeFlow.
1469 * Switched the order of these two fields to match this observation.
1470 */
1471 UINT8 pduType = 0;
1472
1473 WINPR_ASSERT(rdp);
1474 WINPR_ASSERT(s);
1475 WINPR_ASSERT(type);
1476 WINPR_ASSERT(channel_id);
1477
1478 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 6))
1479 return FALSE;
1480 Stream_Read_UINT8(s, pduType); /* pduTypeFlow */
1481 *type = pduType;
1482 Stream_Seek_UINT8(s); /* pad8bits */
1483 Stream_Seek_UINT8(s); /* flowIdentifier */
1484 Stream_Seek_UINT8(s); /* flowNumber */
1485 Stream_Read_UINT16(s, *channel_id); /* pduSource */
1486 return TRUE;
1487}
1488
1500BOOL rdp_decrypt(rdpRdp* rdp, wStream* s, UINT16* pLength, UINT16 securityFlags)
1501{
1502 BOOL res = FALSE;
1503 BYTE cmac[8] = { 0 };
1504 BYTE wmac[8] = { 0 };
1505 BOOL status = FALSE;
1506
1507 WINPR_ASSERT(rdp);
1508 WINPR_ASSERT(rdp->settings);
1509 WINPR_ASSERT(s);
1510 WINPR_ASSERT(pLength);
1511
1512 if (!security_lock(rdp))
1513 return FALSE;
1514
1515 INT32 length = *pLength;
1516 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_NONE)
1517 return TRUE;
1518
1519 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
1520 {
1521 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
1522 goto unlock;
1523
1524 UINT16 len = 0;
1525 Stream_Read_UINT16(s, len); /* 0x10 */
1526 if (len != 0x10)
1527 WLog_Print(rdp->log, WLOG_WARN, "ENCRYPTION_METHOD_FIPS length %" PRIu16 " != 0x10",
1528 len);
1529
1530 UINT16 version = 0;
1531 Stream_Read_UINT8(s, version); /* 0x1 */
1532 if (version != 1)
1533 WLog_Print(rdp->log, WLOG_WARN, "ENCRYPTION_METHOD_FIPS version %" PRIu16 " != 1",
1534 version);
1535
1536 BYTE pad = 0;
1537 Stream_Read_UINT8(s, pad);
1538 const BYTE* sig = Stream_ConstPointer(s);
1539 Stream_Seek(s, 8); /* signature */
1540 length -= 12;
1541 const INT32 padLength = length - pad;
1542
1543 if ((length <= 0) || (padLength <= 0) || (padLength > UINT16_MAX))
1544 {
1545 WLog_Print(rdp->log, WLOG_ERROR, "FATAL: invalid pad length %" PRId32, padLength);
1546 goto unlock;
1547 }
1548
1549 if (!security_fips_decrypt(Stream_Pointer(s), (size_t)length, rdp))
1550 goto unlock;
1551
1552 if (!security_fips_check_signature(Stream_ConstPointer(s), (size_t)padLength, sig, 8, rdp))
1553 goto unlock;
1554
1555 Stream_SetLength(s, Stream_Length(s) - pad);
1556 *pLength = (UINT16)padLength;
1557 }
1558 else
1559 {
1560 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, sizeof(wmac)))
1561 goto unlock;
1562
1563 Stream_Read(s, wmac, sizeof(wmac));
1564 length -= sizeof(wmac);
1565
1566 if (length <= 0)
1567 {
1568 WLog_Print(rdp->log, WLOG_ERROR, "FATAL: invalid length field");
1569 goto unlock;
1570 }
1571
1572 if (!security_decrypt(Stream_PointerAs(s, BYTE), (size_t)length, rdp))
1573 goto unlock;
1574
1575 if (securityFlags & SEC_SECURE_CHECKSUM)
1576 status = security_salted_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length,
1577 FALSE, cmac, sizeof(cmac));
1578 else
1579 status = security_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length, cmac,
1580 sizeof(cmac));
1581
1582 if (!status)
1583 goto unlock;
1584
1585 if (memcmp(wmac, cmac, sizeof(wmac)) != 0)
1586 {
1587 WLog_Print(rdp->log, WLOG_ERROR, "WARNING: invalid packet signature");
1588 /*
1589 * Because Standard RDP Security is totally broken,
1590 * and cannot protect against MITM, don't treat signature
1591 * verification failure as critical. This at least enables
1592 * us to work with broken RDP clients and servers that
1593 * generate invalid signatures.
1594 */
1595 // return FALSE;
1596 }
1597
1598 *pLength = (UINT16)length;
1599 }
1600 res = TRUE;
1601unlock:
1602 if (!security_unlock(rdp))
1603 return FALSE;
1604 return res;
1605}
1606
1607const char* pdu_type_to_str(UINT16 pduType, char* buffer, size_t length)
1608{
1609 const char* str = NULL;
1610 switch (pduType)
1611 {
1612 case PDU_TYPE_DEMAND_ACTIVE:
1613 str = "PDU_TYPE_DEMAND_ACTIVE";
1614 break;
1615 case PDU_TYPE_CONFIRM_ACTIVE:
1616 str = "PDU_TYPE_CONFIRM_ACTIVE";
1617 break;
1618 case PDU_TYPE_DEACTIVATE_ALL:
1619 str = "PDU_TYPE_DEACTIVATE_ALL";
1620 break;
1621 case PDU_TYPE_DATA:
1622 str = "PDU_TYPE_DATA";
1623 break;
1624 case PDU_TYPE_SERVER_REDIRECTION:
1625 str = "PDU_TYPE_SERVER_REDIRECTION";
1626 break;
1627 case PDU_TYPE_FLOW_TEST:
1628 str = "PDU_TYPE_FLOW_TEST";
1629 break;
1630 case PDU_TYPE_FLOW_RESPONSE:
1631 str = "PDU_TYPE_FLOW_RESPONSE";
1632 break;
1633 case PDU_TYPE_FLOW_STOP:
1634 str = "PDU_TYPE_FLOW_STOP";
1635 break;
1636 default:
1637 str = "PDU_TYPE_UNKNOWN";
1638 break;
1639 }
1640
1641 winpr_str_append(str, buffer, length, "");
1642 {
1643 char msg[32] = { 0 };
1644 (void)_snprintf(msg, sizeof(msg), "[0x%08" PRIx32 "]", pduType);
1645 winpr_str_append(msg, buffer, length, "");
1646 }
1647 return buffer;
1648}
1649
1656static state_run_t rdp_recv_tpkt_pdu(rdpRdp* rdp, wStream* s)
1657{
1658 state_run_t rc = STATE_RUN_SUCCESS;
1659 UINT16 length = 0;
1660 UINT16 pduType = 0;
1661 UINT16 pduSource = 0;
1662 UINT16 channelId = 0;
1663 UINT16 securityFlags = 0;
1664
1665 WINPR_ASSERT(rdp);
1666 WINPR_ASSERT(rdp->context);
1667 WINPR_ASSERT(s);
1668
1669 freerdp* instance = rdp->context->instance;
1670 WINPR_ASSERT(instance);
1671
1672 if (!rdp_read_header(rdp, s, &length, &channelId))
1673 return STATE_RUN_FAILED;
1674
1675 if (freerdp_shall_disconnect_context(rdp->context))
1676 return STATE_RUN_SUCCESS;
1677
1678 if (rdp->autodetect->bandwidthMeasureStarted)
1679 {
1680 rdp->autodetect->bandwidthMeasureByteCount += length;
1681 }
1682
1683 if (rdp->mcs->messageChannelId && (channelId == rdp->mcs->messageChannelId))
1684 {
1685 rdp->inPackets++;
1686 return rdp_handle_message_channel(rdp, s, channelId, length);
1687 }
1688
1689 if (rdp->settings->UseRdpSecurityLayer)
1690 {
1691 if (!rdp_read_security_header(rdp, s, &securityFlags, &length))
1692 return STATE_RUN_FAILED;
1693
1694 if (securityFlags & (SEC_ENCRYPT | SEC_REDIRECTION_PKT))
1695 {
1696 if (!rdp_decrypt(rdp, s, &length, securityFlags))
1697 return STATE_RUN_FAILED;
1698 }
1699
1700 if (securityFlags & SEC_REDIRECTION_PKT)
1701 {
1702 /*
1703 * [MS-RDPBCGR] 2.2.13.2.1
1704 * - no share control header, nor the 2 byte pad
1705 */
1706 Stream_Rewind(s, 2);
1707 rdp->inPackets++;
1708
1709 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1710 goto out;
1711 }
1712 }
1713
1714 if (channelId == MCS_GLOBAL_CHANNEL_ID)
1715 {
1716 while (Stream_GetRemainingLength(s) > 3)
1717 {
1718 wStream subbuffer;
1719 wStream* sub = NULL;
1720 size_t diff = 0;
1721 UINT16 remain = 0;
1722
1723 if (!rdp_read_share_control_header(rdp, s, NULL, &remain, &pduType, &pduSource))
1724 return STATE_RUN_FAILED;
1725
1726 sub = Stream_StaticInit(&subbuffer, Stream_Pointer(s), remain);
1727 if (!Stream_SafeSeek(s, remain))
1728 return STATE_RUN_FAILED;
1729
1730 rdp->settings->PduSource = pduSource;
1731 rdp->inPackets++;
1732
1733 switch (pduType)
1734 {
1735 case PDU_TYPE_DATA:
1736 rc = rdp_recv_data_pdu(rdp, sub);
1737 if (state_run_failed(rc))
1738 return rc;
1739 break;
1740
1741 case PDU_TYPE_DEACTIVATE_ALL:
1742 if (!rdp_recv_deactivate_all(rdp, sub))
1743 {
1744 WLog_Print(rdp->log, WLOG_ERROR,
1745 "rdp_recv_tpkt_pdu: rdp_recv_deactivate_all() fail");
1746 return STATE_RUN_FAILED;
1747 }
1748
1749 break;
1750
1751 case PDU_TYPE_SERVER_REDIRECTION:
1752 return rdp_recv_enhanced_security_redirection_packet(rdp, sub);
1753
1754 case PDU_TYPE_FLOW_RESPONSE:
1755 case PDU_TYPE_FLOW_STOP:
1756 case PDU_TYPE_FLOW_TEST:
1757 WLog_Print(rdp->log, WLOG_DEBUG, "flow message 0x%04" PRIX16 "", pduType);
1758 /* http://msdn.microsoft.com/en-us/library/cc240576.aspx */
1759 if (!Stream_SafeSeek(sub, remain))
1760 return STATE_RUN_FAILED;
1761 break;
1762
1763 default:
1764 {
1765 char buffer[256] = { 0 };
1766 WLog_Print(rdp->log, WLOG_ERROR, "incorrect PDU type: %s",
1767 pdu_type_to_str(pduType, buffer, sizeof(buffer)));
1768 }
1769 break;
1770 }
1771
1772 diff = Stream_GetRemainingLength(sub);
1773 if (diff > 0)
1774 {
1775 char buffer[256] = { 0 };
1776 WLog_Print(rdp->log, WLOG_WARN,
1777 "pduType %s not properly parsed, %" PRIdz
1778 " bytes remaining unhandled. Skipping.",
1779 pdu_type_to_str(pduType, buffer, sizeof(buffer)), diff);
1780 }
1781 }
1782 }
1783 else
1784 {
1785 rdp->inPackets++;
1786
1787 if (!freerdp_channel_process(instance, s, channelId, length))
1788 return STATE_RUN_FAILED;
1789 }
1790
1791out:
1792 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1793 return STATE_RUN_FAILED;
1794 return rc;
1795}
1796
1797static state_run_t rdp_recv_fastpath_pdu(rdpRdp* rdp, wStream* s)
1798{
1799 UINT16 length = 0;
1800
1801 WINPR_ASSERT(rdp);
1802 rdpFastPath* fastpath = rdp->fastpath;
1803
1804 if (!fastpath_read_header_rdp(fastpath, s, &length))
1805 {
1806 WLog_Print(rdp->log, WLOG_ERROR, "rdp_recv_fastpath_pdu: fastpath_read_header_rdp() fail");
1807 return STATE_RUN_FAILED;
1808 }
1809
1810 if ((length == 0) || (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, length)))
1811 {
1812 WLog_Print(rdp->log, WLOG_ERROR, "incorrect FastPath PDU header length %" PRIu16 "",
1813 length);
1814 return STATE_RUN_FAILED;
1815 }
1816
1817 if (rdp->autodetect->bandwidthMeasureStarted)
1818 {
1819 rdp->autodetect->bandwidthMeasureByteCount += length;
1820 }
1821
1822 if (!fastpath_decrypt(fastpath, s, &length))
1823 return STATE_RUN_FAILED;
1824
1825 return fastpath_recv_updates(rdp->fastpath, s);
1826}
1827
1828static state_run_t rdp_recv_pdu(rdpRdp* rdp, wStream* s)
1829{
1830 const int rc = tpkt_verify_header(s);
1831 if (rc > 0)
1832 return rdp_recv_tpkt_pdu(rdp, s);
1833 else if (rc == 0)
1834 return rdp_recv_fastpath_pdu(rdp, s);
1835 else
1836 return STATE_RUN_FAILED;
1837}
1838
1839static state_run_t rdp_handle_sc_flags(rdpRdp* rdp, wStream* s, UINT32 flag,
1840 CONNECTION_STATE nextState)
1841{
1842 const UINT32 mask = FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
1843 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU;
1844 WINPR_ASSERT(rdp);
1845 state_run_t status = rdp_recv_pdu(rdp, s);
1846 if (state_run_success(status))
1847 {
1848 const UINT32 flags = rdp->finalize_sc_pdus & mask;
1849 if ((flags & flag) == flag)
1850 {
1851 if (!rdp_client_transition_to_state(rdp, nextState))
1852 status = STATE_RUN_FAILED;
1853 else
1854 status = STATE_RUN_SUCCESS;
1855 }
1856 else
1857 {
1858 char flag_buffer[256] = { 0 };
1859 char mask_buffer[256] = { 0 };
1860 WLog_Print(rdp->log, WLOG_WARN,
1861 "[%s] unexpected server message, expected flag %s [have %s]",
1862 rdp_get_state_string(rdp),
1863 rdp_finalize_flags_to_str(flag, flag_buffer, sizeof(flag_buffer)),
1864 rdp_finalize_flags_to_str(flags, mask_buffer, sizeof(mask_buffer)));
1865 }
1866 }
1867 return status;
1868}
1869
1870static state_run_t rdp_client_exchange_monitor_layout(rdpRdp* rdp, wStream* s)
1871{
1872 WINPR_ASSERT(rdp);
1873
1874 if (!rdp_check_monitor_layout_pdu_state(rdp, FALSE))
1875 return FALSE;
1876
1877 /* We might receive unrelated messages from the server (channel traffic),
1878 * so only proceed if some flag changed
1879 */
1880 const UINT32 old = rdp->finalize_sc_pdus;
1881 state_run_t status = rdp_recv_pdu(rdp, s);
1882 const UINT32 now = rdp->finalize_sc_pdus;
1883 const BOOL changed = (old != now) || rdp->monitor_layout_pdu;
1884
1885 /* This PDU is optional, so if we received a finalize PDU continue there */
1886 if (state_run_success(status) && changed)
1887 {
1888 if (!rdp->monitor_layout_pdu)
1889 {
1890 if (!rdp_finalize_is_flag_set(rdp, FINALIZE_SC_SYNCHRONIZE_PDU))
1891 return STATE_RUN_FAILED;
1892 }
1893
1894 status = rdp_client_connect_finalize(rdp);
1895 if (state_run_success(status) && !rdp->monitor_layout_pdu)
1896 status = STATE_RUN_TRY_AGAIN;
1897 }
1898 return status;
1899}
1900
1901static state_run_t rdp_recv_callback_int(WINPR_ATTR_UNUSED rdpTransport* transport, wStream* s,
1902 void* extra)
1903{
1904 state_run_t status = STATE_RUN_SUCCESS;
1905 rdpRdp* rdp = (rdpRdp*)extra;
1906
1907 WINPR_ASSERT(transport);
1908 WINPR_ASSERT(rdp);
1909 WINPR_ASSERT(s);
1910
1911 switch (rdp_get_state(rdp))
1912 {
1913 case CONNECTION_STATE_NEGO:
1914 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1915 status = STATE_RUN_FAILED;
1916 else
1917 status = STATE_RUN_CONTINUE;
1918 break;
1919 case CONNECTION_STATE_NLA:
1920 if (nla_get_state(rdp->nla) < NLA_STATE_AUTH_INFO)
1921 {
1922 if (nla_recv_pdu(rdp->nla, s) < 1)
1923 {
1924 WLog_Print(rdp->log, WLOG_ERROR, "%s - nla_recv_pdu() fail",
1925 rdp_get_state_string(rdp));
1926 status = STATE_RUN_FAILED;
1927 }
1928 }
1929 else if (nla_get_state(rdp->nla) == NLA_STATE_POST_NEGO)
1930 {
1931 nego_recv(rdp->transport, s, (void*)rdp->nego);
1932
1933 if (!nego_update_settings_from_state(rdp->nego, rdp->settings))
1934 return FALSE;
1935
1936 if (nego_get_state(rdp->nego) != NEGO_STATE_FINAL)
1937 {
1938 WLog_Print(rdp->log, WLOG_ERROR, "%s - nego_recv() fail",
1939 rdp_get_state_string(rdp));
1940 status = STATE_RUN_FAILED;
1941 }
1942 else if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
1943 status = STATE_RUN_FAILED;
1944 }
1945
1946 if (state_run_success(status))
1947 {
1948 if (nla_get_state(rdp->nla) == NLA_STATE_AUTH_INFO)
1949 {
1950 transport_set_nla_mode(rdp->transport, FALSE);
1951
1952 if (rdp->settings->VmConnectMode)
1953 {
1954 if (!nego_set_state(rdp->nego, NEGO_STATE_NLA))
1955 status = STATE_RUN_FAILED;
1956 else if (!nego_set_requested_protocols(rdp->nego,
1957 PROTOCOL_HYBRID | PROTOCOL_SSL))
1958 status = STATE_RUN_FAILED;
1959 else if (!nego_send_negotiation_request(rdp->nego))
1960 status = STATE_RUN_FAILED;
1961 else if (!nla_set_state(rdp->nla, NLA_STATE_POST_NEGO))
1962 status = STATE_RUN_FAILED;
1963 }
1964 else
1965 {
1966 if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
1967 status = STATE_RUN_FAILED;
1968 }
1969 }
1970 }
1971 if (state_run_success(status))
1972 {
1973
1974 if (nla_get_state(rdp->nla) == NLA_STATE_FINAL)
1975 {
1976 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1977 status = STATE_RUN_FAILED;
1978 else
1979 status = STATE_RUN_CONTINUE;
1980 }
1981 }
1982 break;
1983
1984 case CONNECTION_STATE_AAD:
1985 if (aad_recv(rdp->aad, s) < 1)
1986 {
1987 WLog_Print(rdp->log, WLOG_ERROR, "%s - aad_recv() fail", rdp_get_state_string(rdp));
1988 status = STATE_RUN_FAILED;
1989 }
1990 if (state_run_success(status))
1991 {
1992 if (aad_get_state(rdp->aad) == AAD_STATE_FINAL)
1993 {
1994 transport_set_aad_mode(rdp->transport, FALSE);
1995 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1996 status = STATE_RUN_FAILED;
1997 else
1998 status = STATE_RUN_CONTINUE;
1999 }
2000 }
2001 break;
2002
2003 case CONNECTION_STATE_MCS_CREATE_REQUEST:
2004 if (!mcs_client_begin(rdp->mcs))
2005 {
2006 WLog_Print(rdp->log, WLOG_ERROR, "%s - mcs_client_begin() fail",
2007 rdp_get_state_string(rdp));
2008 status = STATE_RUN_FAILED;
2009 }
2010 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_RESPONSE))
2011 status = STATE_RUN_FAILED;
2012 else if (Stream_GetRemainingLength(s) > 0)
2013 status = STATE_RUN_CONTINUE;
2014 break;
2015
2016 case CONNECTION_STATE_MCS_CREATE_RESPONSE:
2017 if (!mcs_recv_connect_response(rdp->mcs, s))
2018 {
2019 WLog_Print(rdp->log, WLOG_ERROR, "mcs_recv_connect_response failure");
2020 status = STATE_RUN_FAILED;
2021 }
2022 else
2023 {
2024 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ERECT_DOMAIN))
2025 status = STATE_RUN_FAILED;
2026 else if (!mcs_send_erect_domain_request(rdp->mcs))
2027 {
2028 WLog_Print(rdp->log, WLOG_ERROR, "mcs_send_erect_domain_request failure");
2029 status = STATE_RUN_FAILED;
2030 }
2031 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ATTACH_USER))
2032 status = STATE_RUN_FAILED;
2033 else if (!mcs_send_attach_user_request(rdp->mcs))
2034 {
2035 WLog_Print(rdp->log, WLOG_ERROR, "mcs_send_attach_user_request failure");
2036 status = STATE_RUN_FAILED;
2037 }
2038 else if (!rdp_client_transition_to_state(rdp,
2039 CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM))
2040 status = STATE_RUN_FAILED;
2041 }
2042 break;
2043
2044 case CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM:
2045 if (!mcs_recv_attach_user_confirm(rdp->mcs, s))
2046 {
2047 WLog_Print(rdp->log, WLOG_ERROR, "mcs_recv_attach_user_confirm failure");
2048 status = STATE_RUN_FAILED;
2049 }
2050 else if (!freerdp_settings_get_bool(rdp->settings, FreeRDP_SupportSkipChannelJoin))
2051 {
2052 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST))
2053 status = STATE_RUN_FAILED;
2054 else if (!mcs_send_channel_join_request(rdp->mcs, rdp->mcs->userId))
2055 {
2056 WLog_Print(rdp->log, WLOG_ERROR, "mcs_send_channel_join_request failure");
2057 status = STATE_RUN_FAILED;
2058 }
2059 else if (!rdp_client_transition_to_state(
2060 rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE))
2061 status = STATE_RUN_FAILED;
2062 }
2063 else
2064 {
2065 /* SKIP_CHANNELJOIN is active, consider channels to be joined */
2066 if (!rdp_client_skip_mcs_channel_join(rdp))
2067 status = STATE_RUN_FAILED;
2068 }
2069 break;
2070
2071 case CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE:
2072 if (!rdp_client_connect_mcs_channel_join_confirm(rdp, s))
2073 {
2074 WLog_Print(rdp->log, WLOG_ERROR,
2075 "%s - "
2076 "rdp_client_connect_mcs_channel_join_confirm() fail",
2077 rdp_get_state_string(rdp));
2078 status = STATE_RUN_FAILED;
2079 }
2080
2081 break;
2082
2083 case CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST:
2084 if (!rdp_client_connect_auto_detect(rdp, s))
2085 {
2086 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_LICENSING))
2087 status = STATE_RUN_FAILED;
2088 else
2089 status = STATE_RUN_TRY_AGAIN;
2090 }
2091 break;
2092
2093 case CONNECTION_STATE_LICENSING:
2094 status = rdp_client_connect_license(rdp, s);
2095
2096 if (state_run_failed(status))
2097 {
2098 char buffer[64] = { 0 };
2099 WLog_Print(rdp->log, WLOG_DEBUG, "%s - rdp_client_connect_license() - %s",
2100 rdp_get_state_string(rdp),
2101 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2102 }
2103
2104 break;
2105
2106 case CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST:
2107 if (!rdp_client_connect_auto_detect(rdp, s))
2108 {
2109 (void)rdp_client_transition_to_state(
2110 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE);
2111 status = STATE_RUN_TRY_AGAIN;
2112 }
2113 break;
2114
2115 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE:
2116 status = rdp_client_connect_demand_active(rdp, s);
2117
2118 if (state_run_failed(status))
2119 {
2120 char buffer[64] = { 0 };
2121 WLog_Print(rdp->log, WLOG_DEBUG,
2122 "%s - "
2123 "rdp_client_connect_demand_active() - %s",
2124 rdp_get_state_string(rdp),
2125 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2126 }
2127 else if (status == STATE_RUN_ACTIVE)
2128 {
2129 if (!rdp_client_transition_to_state(
2130 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE))
2131 status = STATE_RUN_FAILED;
2132 else
2133 status = STATE_RUN_CONTINUE;
2134 }
2135 break;
2136
2137 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT:
2138 status = rdp_client_exchange_monitor_layout(rdp, s);
2139 break;
2140
2141 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE:
2142 status = rdp_client_connect_confirm_active(rdp, s);
2143 break;
2144
2145 case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
2146 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_SYNCHRONIZE_PDU,
2147 CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE);
2148 break;
2149 case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
2150 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_COOPERATE_PDU,
2151 CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL);
2152 break;
2153 case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
2154 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_GRANTED_PDU,
2155 CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP);
2156 break;
2157 case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
2158 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_FONT_MAP_PDU, CONNECTION_STATE_ACTIVE);
2159 break;
2160
2161 case CONNECTION_STATE_ACTIVE:
2162 status = rdp_recv_pdu(rdp, s);
2163
2164 if (state_run_failed(status))
2165 {
2166 char buffer[64] = { 0 };
2167 WLog_Print(rdp->log, WLOG_DEBUG, "%s - rdp_recv_pdu() - %s",
2168 rdp_get_state_string(rdp),
2169 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2170 }
2171 break;
2172
2173 default:
2174 WLog_Print(rdp->log, WLOG_ERROR, "%s state %d", rdp_get_state_string(rdp),
2175 rdp_get_state(rdp));
2176 status = STATE_RUN_FAILED;
2177 break;
2178 }
2179
2180 if (state_run_failed(status))
2181 {
2182 char buffer[64] = { 0 };
2183 WLog_Print(rdp->log, WLOG_ERROR, "%s status %s", rdp_get_state_string(rdp),
2184 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2185 }
2186 return status;
2187}
2188
2189state_run_t rdp_recv_callback(rdpTransport* transport, wStream* s, void* extra)
2190{
2191 char buffer[64] = { 0 };
2192 state_run_t rc = STATE_RUN_FAILED;
2193 const size_t start = Stream_GetPosition(s);
2194 const rdpContext* context = transport_get_context(transport);
2195
2196 WINPR_ASSERT(context);
2197 do
2198 {
2199 const rdpRdp* rdp = context->rdp;
2200 WINPR_ASSERT(rdp);
2201
2202 if (rc == STATE_RUN_TRY_AGAIN)
2203 Stream_SetPosition(s, start);
2204
2205 const char* old = rdp_get_state_string(rdp);
2206 const size_t orem = Stream_GetRemainingLength(s);
2207 rc = rdp_recv_callback_int(transport, s, extra);
2208
2209 const char* now = rdp_get_state_string(rdp);
2210 const size_t rem = Stream_GetRemainingLength(s);
2211
2212 WLog_Print(rdp->log, WLOG_TRACE,
2213 "(client)[%s -> %s] current return %s [feeding %" PRIuz " bytes, %" PRIuz
2214 " bytes not processed]",
2215 old, now, state_run_result_string(rc, buffer, sizeof(buffer)), orem, rem);
2216 } while ((rc == STATE_RUN_TRY_AGAIN) || (rc == STATE_RUN_CONTINUE));
2217 return rc;
2218}
2219
2220BOOL rdp_send_channel_data(rdpRdp* rdp, UINT16 channelId, const BYTE* data, size_t size)
2221{
2222 return freerdp_channel_send(rdp, channelId, data, size);
2223}
2224
2225BOOL rdp_channel_send_packet(rdpRdp* rdp, UINT16 channelId, size_t totalSize, UINT32 flags,
2226 const BYTE* data, size_t chunkSize)
2227{
2228 return freerdp_channel_send_packet(rdp, channelId, totalSize, flags, data, chunkSize);
2229}
2230
2231BOOL rdp_send_error_info(rdpRdp* rdp)
2232{
2233 UINT16 sec_flags = 0;
2234 wStream* s = NULL;
2235 BOOL status = 0;
2236
2237 if (rdp->errorInfo == ERRINFO_SUCCESS)
2238 return TRUE;
2239
2240 s = rdp_data_pdu_init(rdp, &sec_flags);
2241
2242 if (!s)
2243 return FALSE;
2244
2245 Stream_Write_UINT32(s, rdp->errorInfo); /* error id (4 bytes) */
2246 status = rdp_send_data_pdu(rdp, s, DATA_PDU_TYPE_SET_ERROR_INFO, 0, sec_flags);
2247 return status;
2248}
2249
2250int rdp_check_fds(rdpRdp* rdp)
2251{
2252 int status = 0;
2253 rdpTsg* tsg = NULL;
2254 rdpTransport* transport = NULL;
2255
2256 WINPR_ASSERT(rdp);
2257 transport = rdp->transport;
2258
2259 tsg = transport_get_tsg(transport);
2260 if (tsg)
2261 {
2262 if (!tsg_check_event_handles(tsg))
2263 {
2264 WLog_Print(rdp->log, WLOG_ERROR, "rdp_check_fds: tsg_check_event_handles()");
2265 return -1;
2266 }
2267
2268 if (tsg_get_state(tsg) != TSG_STATE_PIPE_CREATED)
2269 return 1;
2270 }
2271
2272 status = transport_check_fds(transport);
2273
2274 if (status == 1)
2275 {
2276 if (!rdp_client_redirect(rdp)) /* session redirection */
2277 return -1;
2278 }
2279
2280 if (status < 0)
2281 WLog_Print(rdp->log, WLOG_DEBUG, "transport_check_fds() - %i", status);
2282
2283 return status;
2284}
2285
2286BOOL freerdp_get_stats(rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes, UINT64* inPackets,
2287 UINT64* outPackets)
2288{
2289 if (!rdp)
2290 return FALSE;
2291
2292 if (inBytes)
2293 *inBytes = rdp->inBytes;
2294 if (outBytes)
2295 *outBytes = rdp->outBytes;
2296 if (inPackets)
2297 *inPackets = rdp->inPackets;
2298 if (outPackets)
2299 *outPackets = rdp->outPackets;
2300
2301 return TRUE;
2302}
2303
2309rdpRdp* rdp_new(rdpContext* context)
2310{
2311 rdpRdp* rdp = NULL;
2312 DWORD flags = 0;
2313 rdp = (rdpRdp*)calloc(1, sizeof(rdpRdp));
2314
2315 if (!rdp)
2316 return NULL;
2317
2318 rdp->log = WLog_Get(RDP_TAG);
2319 WINPR_ASSERT(rdp->log);
2320
2321 (void)_snprintf(rdp->log_context, sizeof(rdp->log_context), "%p", (void*)context);
2322 WLog_SetContext(rdp->log, NULL, rdp->log_context);
2323
2324 InitializeCriticalSection(&rdp->critical);
2325 rdp->context = context;
2326 WINPR_ASSERT(rdp->context);
2327
2328 if (context->ServerMode)
2330
2331 if (!context->settings)
2332 {
2333 context->settings = rdp->settings = freerdp_settings_new(flags);
2334
2335 if (!rdp->settings)
2336 goto fail;
2337 }
2338 else
2339 rdp->settings = context->settings;
2340
2341 /* Keep a backup copy of settings for later comparisons */
2342 if (!rdp_set_backup_settings(rdp))
2343 goto fail;
2344
2345 rdp->settings->instance = context->instance;
2346
2347 context->settings = rdp->settings;
2348 if (context->instance)
2349 context->settings->instance = context->instance;
2350 else if (context->peer)
2351 {
2352 rdp->settings->instance = context->peer;
2353
2354#if defined(WITH_FREERDP_DEPRECATED)
2355 context->peer->settings = rdp->settings;
2356#endif
2357 }
2358
2359 rdp->transport = transport_new(context);
2360
2361 if (!rdp->transport)
2362 goto fail;
2363
2364 {
2365 const rdpTransportIo* io = transport_get_io_callbacks(rdp->transport);
2366 if (!io)
2367 goto fail;
2368 rdp->io = calloc(1, sizeof(rdpTransportIo));
2369 if (!rdp->io)
2370 goto fail;
2371 *rdp->io = *io;
2372 }
2373
2374 rdp->aad = aad_new(context, rdp->transport);
2375 if (!rdp->aad)
2376 goto fail;
2377
2378 rdp->license = license_new(rdp);
2379
2380 if (!rdp->license)
2381 goto fail;
2382
2383 rdp->input = input_new(rdp);
2384
2385 if (!rdp->input)
2386 goto fail;
2387
2388 rdp->update = update_new(rdp);
2389
2390 if (!rdp->update)
2391 goto fail;
2392
2393 rdp->fastpath = fastpath_new(rdp);
2394
2395 if (!rdp->fastpath)
2396 goto fail;
2397
2398 rdp->nego = nego_new(rdp->transport);
2399
2400 if (!rdp->nego)
2401 goto fail;
2402
2403 rdp->mcs = mcs_new(rdp->transport);
2404
2405 if (!rdp->mcs)
2406 goto fail;
2407
2408 rdp->redirection = redirection_new();
2409
2410 if (!rdp->redirection)
2411 goto fail;
2412
2413 rdp->autodetect = autodetect_new(rdp->context);
2414
2415 if (!rdp->autodetect)
2416 goto fail;
2417
2418 rdp->heartbeat = heartbeat_new();
2419
2420 if (!rdp->heartbeat)
2421 goto fail;
2422
2423 rdp->multitransport = multitransport_new(rdp, INITIATE_REQUEST_PROTOCOL_UDPFECL |
2424 INITIATE_REQUEST_PROTOCOL_UDPFECR);
2425
2426 if (!rdp->multitransport)
2427 goto fail;
2428
2429 rdp->bulk = bulk_new(context);
2430
2431 if (!rdp->bulk)
2432 goto fail;
2433
2434 rdp->pubSub = PubSub_New(TRUE);
2435 if (!rdp->pubSub)
2436 goto fail;
2437
2438 rdp->abortEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2439 if (!rdp->abortEvent)
2440 goto fail;
2441 return rdp;
2442
2443fail:
2444 WINPR_PRAGMA_DIAG_PUSH
2445 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2446 rdp_free(rdp);
2447 WINPR_PRAGMA_DIAG_POP
2448 return NULL;
2449}
2450
2451static void rdp_reset_free(rdpRdp* rdp)
2452{
2453 WINPR_ASSERT(rdp);
2454
2455 (void)security_lock(rdp);
2456 rdp_free_rc4_decrypt_keys(rdp);
2457 rdp_free_rc4_encrypt_keys(rdp);
2458
2459 winpr_Cipher_Free(rdp->fips_encrypt);
2460 winpr_Cipher_Free(rdp->fips_decrypt);
2461 rdp->fips_encrypt = NULL;
2462 rdp->fips_decrypt = NULL;
2463 (void)security_unlock(rdp);
2464
2465 mcs_free(rdp->mcs);
2466 nego_free(rdp->nego);
2467 license_free(rdp->license);
2468 transport_free(rdp->transport);
2469 fastpath_free(rdp->fastpath);
2470
2471 rdp->mcs = NULL;
2472 rdp->nego = NULL;
2473 rdp->license = NULL;
2474 rdp->transport = NULL;
2475 rdp->fastpath = NULL;
2476}
2477
2478BOOL rdp_reset(rdpRdp* rdp)
2479{
2480 BOOL rc = TRUE;
2481 rdpContext* context = NULL;
2482 rdpSettings* settings = NULL;
2483
2484 WINPR_ASSERT(rdp);
2485
2486 context = rdp->context;
2487 WINPR_ASSERT(context);
2488
2489 settings = rdp->settings;
2490 WINPR_ASSERT(settings);
2491
2492 bulk_reset(rdp->bulk);
2493
2494 rdp_reset_free(rdp);
2495
2496 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ServerRandom, NULL, 0))
2497 rc = FALSE;
2498
2499 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ServerCertificate, NULL, 0))
2500 rc = FALSE;
2501
2502 if (!freerdp_settings_set_string(settings, FreeRDP_ClientAddress, NULL))
2503 rc = FALSE;
2504
2505 if (!rc)
2506 goto fail;
2507
2508 rc = FALSE;
2509 rdp->transport = transport_new(context);
2510 if (!rdp->transport)
2511 goto fail;
2512
2513 if (rdp->io)
2514 {
2515 if (!transport_set_io_callbacks(rdp->transport, rdp->io))
2516 goto fail;
2517 }
2518
2519 aad_free(rdp->aad);
2520 rdp->aad = aad_new(context, rdp->transport);
2521 if (!rdp->aad)
2522 goto fail;
2523
2524 rdp->nego = nego_new(rdp->transport);
2525 if (!rdp->nego)
2526 goto fail;
2527
2528 rdp->mcs = mcs_new(rdp->transport);
2529 if (!rdp->mcs)
2530 goto fail;
2531
2532 if (!transport_set_layer(rdp->transport, TRANSPORT_LAYER_TCP))
2533 goto fail;
2534
2535 rdp->license = license_new(rdp);
2536 if (!rdp->license)
2537 goto fail;
2538
2539 rdp->fastpath = fastpath_new(rdp);
2540 if (!rdp->fastpath)
2541 goto fail;
2542
2543 rdp->errorInfo = 0;
2544 rc = rdp_finalize_reset_flags(rdp, TRUE);
2545
2546fail:
2547 return rc;
2548}
2549
2555void rdp_free(rdpRdp* rdp)
2556{
2557 if (rdp)
2558 {
2559 rdp_reset_free(rdp);
2560
2561 freerdp_settings_free(rdp->settings);
2562 freerdp_settings_free(rdp->originalSettings);
2563 freerdp_settings_free(rdp->remoteSettings);
2564
2565 input_free(rdp->input);
2566 update_free(rdp->update);
2567 nla_free(rdp->nla);
2568 redirection_free(rdp->redirection);
2569 autodetect_free(rdp->autodetect);
2570 heartbeat_free(rdp->heartbeat);
2571 multitransport_free(rdp->multitransport);
2572 bulk_free(rdp->bulk);
2573 free(rdp->io);
2574 PubSub_Free(rdp->pubSub);
2575 if (rdp->abortEvent)
2576 (void)CloseHandle(rdp->abortEvent);
2577 aad_free(rdp->aad);
2578 WINPR_JSON_Delete(rdp->wellknown);
2579 DeleteCriticalSection(&rdp->critical);
2580 free(rdp);
2581 }
2582}
2583
2584BOOL rdp_io_callback_set_event(rdpRdp* rdp, BOOL set)
2585{
2586 if (!rdp)
2587 return FALSE;
2588 return transport_io_callback_set_event(rdp->transport, set);
2589}
2590
2591const rdpTransportIo* rdp_get_io_callbacks(rdpRdp* rdp)
2592{
2593 if (!rdp)
2594 return NULL;
2595 return rdp->io;
2596}
2597
2598BOOL rdp_set_io_callbacks(rdpRdp* rdp, const rdpTransportIo* io_callbacks)
2599{
2600 if (!rdp)
2601 return FALSE;
2602 free(rdp->io);
2603 rdp->io = NULL;
2604 if (io_callbacks)
2605 {
2606 rdp->io = malloc(sizeof(rdpTransportIo));
2607 if (!rdp->io)
2608 return FALSE;
2609 *rdp->io = *io_callbacks;
2610 return transport_set_io_callbacks(rdp->transport, rdp->io);
2611 }
2612 return TRUE;
2613}
2614
2615BOOL rdp_set_io_callback_context(rdpRdp* rdp, void* usercontext)
2616{
2617 WINPR_ASSERT(rdp);
2618 rdp->ioContext = usercontext;
2619 return TRUE;
2620}
2621
2622void* rdp_get_io_callback_context(rdpRdp* rdp)
2623{
2624 WINPR_ASSERT(rdp);
2625 return rdp->ioContext;
2626}
2627
2628const char* rdp_finalize_flags_to_str(UINT32 flags, char* buffer, size_t size)
2629{
2630 char number[32] = { 0 };
2631 const UINT32 mask =
2632 (uint32_t)~(FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
2633 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU |
2634 FINALIZE_CS_SYNCHRONIZE_PDU | FINALIZE_CS_CONTROL_COOPERATE_PDU |
2635 FINALIZE_CS_CONTROL_REQUEST_PDU | FINALIZE_CS_PERSISTENT_KEY_LIST_PDU |
2636 FINALIZE_CS_FONT_LIST_PDU | FINALIZE_DEACTIVATE_REACTIVATE);
2637
2638 if (flags & FINALIZE_SC_SYNCHRONIZE_PDU)
2639 winpr_str_append("FINALIZE_SC_SYNCHRONIZE_PDU", buffer, size, "|");
2640 if (flags & FINALIZE_SC_CONTROL_COOPERATE_PDU)
2641 winpr_str_append("FINALIZE_SC_CONTROL_COOPERATE_PDU", buffer, size, "|");
2642 if (flags & FINALIZE_SC_CONTROL_GRANTED_PDU)
2643 winpr_str_append("FINALIZE_SC_CONTROL_GRANTED_PDU", buffer, size, "|");
2644 if (flags & FINALIZE_SC_FONT_MAP_PDU)
2645 winpr_str_append("FINALIZE_SC_FONT_MAP_PDU", buffer, size, "|");
2646 if (flags & FINALIZE_CS_SYNCHRONIZE_PDU)
2647 winpr_str_append("FINALIZE_CS_SYNCHRONIZE_PDU", buffer, size, "|");
2648 if (flags & FINALIZE_CS_CONTROL_COOPERATE_PDU)
2649 winpr_str_append("FINALIZE_CS_CONTROL_COOPERATE_PDU", buffer, size, "|");
2650 if (flags & FINALIZE_CS_CONTROL_REQUEST_PDU)
2651 winpr_str_append("FINALIZE_CS_CONTROL_REQUEST_PDU", buffer, size, "|");
2652 if (flags & FINALIZE_CS_PERSISTENT_KEY_LIST_PDU)
2653 winpr_str_append("FINALIZE_CS_PERSISTENT_KEY_LIST_PDU", buffer, size, "|");
2654 if (flags & FINALIZE_CS_FONT_LIST_PDU)
2655 winpr_str_append("FINALIZE_CS_FONT_LIST_PDU", buffer, size, "|");
2656 if (flags & FINALIZE_DEACTIVATE_REACTIVATE)
2657 winpr_str_append("FINALIZE_DEACTIVATE_REACTIVATE", buffer, size, "|");
2658 if (flags & mask)
2659 winpr_str_append("UNKNOWN_FLAG", buffer, size, "|");
2660 if (flags == 0)
2661 winpr_str_append("NO_FLAG_SET", buffer, size, "|");
2662 (void)_snprintf(number, sizeof(number), " [0x%08" PRIx32 "]", flags);
2663 winpr_str_append(number, buffer, size, "");
2664 return buffer;
2665}
2666
2667BOOL rdp_finalize_reset_flags(rdpRdp* rdp, BOOL clearAll)
2668{
2669 WINPR_ASSERT(rdp);
2670 WLog_Print(rdp->log, WLOG_DEBUG, "[%s] reset finalize_sc_pdus", rdp_get_state_string(rdp));
2671 if (clearAll)
2672 rdp->finalize_sc_pdus = 0;
2673 else
2674 rdp->finalize_sc_pdus &= FINALIZE_DEACTIVATE_REACTIVATE;
2675
2676 return rdp_set_monitor_layout_pdu_state(rdp, FALSE);
2677}
2678
2679BOOL rdp_finalize_set_flag(rdpRdp* rdp, UINT32 flag)
2680{
2681 char buffer[1024] = { 0 };
2682
2683 WINPR_ASSERT(rdp);
2684
2685 WLog_Print(rdp->log, WLOG_DEBUG, "[%s] received flag %s", rdp_get_state_string(rdp),
2686 rdp_finalize_flags_to_str(flag, buffer, sizeof(buffer)));
2687 rdp->finalize_sc_pdus |= flag;
2688 return TRUE;
2689}
2690
2691BOOL rdp_finalize_is_flag_set(rdpRdp* rdp, UINT32 flag)
2692{
2693 WINPR_ASSERT(rdp);
2694 return (rdp->finalize_sc_pdus & flag) == flag;
2695}
2696
2697BOOL rdp_reset_rc4_encrypt_keys(rdpRdp* rdp)
2698{
2699 WINPR_ASSERT(rdp);
2700 rdp_free_rc4_encrypt_keys(rdp);
2701 rdp->rc4_encrypt_key = winpr_RC4_New(rdp->encrypt_key, rdp->rc4_key_len);
2702
2703 rdp->encrypt_use_count = 0;
2704 return rdp->rc4_encrypt_key != NULL;
2705}
2706
2707void rdp_free_rc4_encrypt_keys(rdpRdp* rdp)
2708{
2709 WINPR_ASSERT(rdp);
2710 winpr_RC4_Free(rdp->rc4_encrypt_key);
2711 rdp->rc4_encrypt_key = NULL;
2712}
2713
2714void rdp_free_rc4_decrypt_keys(rdpRdp* rdp)
2715{
2716 WINPR_ASSERT(rdp);
2717 winpr_RC4_Free(rdp->rc4_decrypt_key);
2718 rdp->rc4_decrypt_key = NULL;
2719}
2720
2721BOOL rdp_reset_rc4_decrypt_keys(rdpRdp* rdp)
2722{
2723 WINPR_ASSERT(rdp);
2724 rdp_free_rc4_decrypt_keys(rdp);
2725 rdp->rc4_decrypt_key = winpr_RC4_New(rdp->decrypt_key, rdp->rc4_key_len);
2726
2727 rdp->decrypt_use_count = 0;
2728 return rdp->rc4_decrypt_key != NULL;
2729}
2730
2731const char* rdp_security_flag_string(UINT32 securityFlags, char* buffer, size_t size)
2732{
2733 if (securityFlags & SEC_EXCHANGE_PKT)
2734 winpr_str_append("SEC_EXCHANGE_PKT", buffer, size, "|");
2735 if (securityFlags & SEC_TRANSPORT_REQ)
2736 winpr_str_append("SEC_TRANSPORT_REQ", buffer, size, "|");
2737 if (securityFlags & SEC_TRANSPORT_RSP)
2738 winpr_str_append("SEC_TRANSPORT_RSP", buffer, size, "|");
2739 if (securityFlags & SEC_ENCRYPT)
2740 winpr_str_append("SEC_ENCRYPT", buffer, size, "|");
2741 if (securityFlags & SEC_RESET_SEQNO)
2742 winpr_str_append("SEC_RESET_SEQNO", buffer, size, "|");
2743 if (securityFlags & SEC_IGNORE_SEQNO)
2744 winpr_str_append("SEC_IGNORE_SEQNO", buffer, size, "|");
2745 if (securityFlags & SEC_INFO_PKT)
2746 winpr_str_append("SEC_INFO_PKT", buffer, size, "|");
2747 if (securityFlags & SEC_LICENSE_PKT)
2748 winpr_str_append("SEC_LICENSE_PKT", buffer, size, "|");
2749 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
2750 winpr_str_append("SEC_LICENSE_ENCRYPT_CS", buffer, size, "|");
2751 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
2752 winpr_str_append("SEC_LICENSE_ENCRYPT_SC", buffer, size, "|");
2753 if (securityFlags & SEC_REDIRECTION_PKT)
2754 winpr_str_append("SEC_REDIRECTION_PKT", buffer, size, "|");
2755 if (securityFlags & SEC_SECURE_CHECKSUM)
2756 winpr_str_append("SEC_SECURE_CHECKSUM", buffer, size, "|");
2757 if (securityFlags & SEC_AUTODETECT_REQ)
2758 winpr_str_append("SEC_AUTODETECT_REQ", buffer, size, "|");
2759 if (securityFlags & SEC_AUTODETECT_RSP)
2760 winpr_str_append("SEC_AUTODETECT_RSP", buffer, size, "|");
2761 if (securityFlags & SEC_HEARTBEAT)
2762 winpr_str_append("SEC_HEARTBEAT", buffer, size, "|");
2763 if (securityFlags & SEC_FLAGSHI_VALID)
2764 winpr_str_append("SEC_FLAGSHI_VALID", buffer, size, "|");
2765 {
2766 char msg[32] = { 0 };
2767
2768 (void)_snprintf(msg, sizeof(msg), "[0x%08" PRIx32 "]", securityFlags);
2769 winpr_str_append(msg, buffer, size, "");
2770 }
2771 return buffer;
2772}
2773
2774static BOOL rdp_reset_remote_settings(rdpRdp* rdp)
2775{
2776 UINT32 flags = FREERDP_SETTINGS_REMOTE_MODE;
2777 WINPR_ASSERT(rdp);
2778 freerdp_settings_free(rdp->remoteSettings);
2779
2780 if (!freerdp_settings_get_bool(rdp->settings, FreeRDP_ServerMode))
2782 rdp->remoteSettings = freerdp_settings_new(flags);
2783 return rdp->remoteSettings != NULL;
2784}
2785
2786BOOL rdp_set_backup_settings(rdpRdp* rdp)
2787{
2788 WINPR_ASSERT(rdp);
2789 freerdp_settings_free(rdp->originalSettings);
2790 rdp->originalSettings = freerdp_settings_clone(rdp->settings);
2791 if (!rdp->originalSettings)
2792 return FALSE;
2793 return rdp_reset_remote_settings(rdp);
2794}
2795
2796BOOL rdp_reset_runtime_settings(rdpRdp* rdp)
2797{
2798 WINPR_ASSERT(rdp);
2799 WINPR_ASSERT(rdp->context);
2800
2801 freerdp_settings_free(rdp->settings);
2802 rdp->context->settings = rdp->settings = freerdp_settings_clone(rdp->originalSettings);
2803
2804 if (!rdp->settings)
2805 return FALSE;
2806 return rdp_reset_remote_settings(rdp);
2807}
2808
2809static BOOL starts_with(const char* tok, const char* val)
2810{
2811 const size_t len = strlen(val);
2812 if (strncmp(tok, val, len) != 0)
2813 return FALSE;
2814 if (tok[len] != '=')
2815 return FALSE;
2816 return TRUE;
2817}
2818
2819static BOOL option_equals(const char* what, const char* val)
2820{
2821 return _stricmp(what, val) == 0;
2822}
2823
2824static BOOL parse_on_off_option(const char* value)
2825{
2826 WINPR_ASSERT(value);
2827 const char* sep = strchr(value, '=');
2828 if (!sep)
2829 return TRUE;
2830 if (option_equals("on", &sep[1]))
2831 return TRUE;
2832 if (option_equals("true", &sep[1]))
2833 return TRUE;
2834 if (option_equals("off", &sep[1]))
2835 return FALSE;
2836 if (option_equals("false", &sep[1]))
2837 return FALSE;
2838
2839 errno = 0;
2840 long val = strtol(value, NULL, 0);
2841 if (errno == 0)
2842 return val == 0 ? FALSE : TRUE;
2843
2844 return FALSE;
2845}
2846
2847#define STR(x) #x
2848
2849static BOOL option_is_runtime_checks(WINPR_ATTR_UNUSED wLog* log, const char* tok)
2850{
2851 const char* experimental[] = { STR(WITH_VERBOSE_WINPR_ASSERT) };
2852 for (size_t x = 0; x < ARRAYSIZE(experimental); x++)
2853 {
2854 const char* opt = experimental[x];
2855 if (starts_with(tok, opt))
2856 {
2857 return parse_on_off_option(tok);
2858 }
2859 }
2860 return FALSE;
2861}
2862
2863static BOOL option_is_experimental(WINPR_ATTR_UNUSED wLog* log, const char* tok)
2864{
2865 const char* experimental[] = { STR(WITH_DSP_EXPERIMENTAL), STR(WITH_VAAPI) };
2866 for (size_t x = 0; x < ARRAYSIZE(experimental); x++)
2867 {
2868 const char* opt = experimental[x];
2869 if (starts_with(tok, opt))
2870 {
2871 return parse_on_off_option(tok);
2872 }
2873 }
2874 return FALSE;
2875}
2876
2877static BOOL option_is_debug(wLog* log, const char* tok)
2878{
2879 WINPR_ASSERT(log);
2880 const char* debug[] = { STR(WITH_DEBUG_ALL),
2881 STR(WITH_DEBUG_CERTIFICATE),
2882 STR(WITH_DEBUG_CAPABILITIES),
2883 STR(WITH_DEBUG_CHANNELS),
2884 STR(WITH_DEBUG_CLIPRDR),
2885 STR(WITH_DEBUG_CODECS),
2886 STR(WITH_DEBUG_RDPGFX),
2887 STR(WITH_DEBUG_DVC),
2888 STR(WITH_DEBUG_TSMF),
2889 STR(WITH_DEBUG_KBD),
2890 STR(WITH_DEBUG_LICENSE),
2891 STR(WITH_DEBUG_NEGO),
2892 STR(WITH_DEBUG_NLA),
2893 STR(WITH_DEBUG_TSG),
2894 STR(WITH_DEBUG_RAIL),
2895 STR(WITH_DEBUG_RDP),
2896 STR(WITH_DEBUG_RDPEI),
2897 STR(WITH_DEBUG_REDIR),
2898 STR(WITH_DEBUG_RDPDR),
2899 STR(WITH_DEBUG_RFX),
2900 STR(WITH_DEBUG_SCARD),
2901 STR(WITH_DEBUG_SND),
2902 STR(WITH_DEBUG_SVC),
2903 STR(WITH_DEBUG_TRANSPORT),
2904 STR(WITH_DEBUG_TIMEZONE),
2905 STR(WITH_DEBUG_WND),
2906 STR(WITH_DEBUG_X11_CLIPRDR),
2907 STR(WITH_DEBUG_X11_LOCAL_MOVESIZE),
2908 STR(WITH_DEBUG_X11),
2909 STR(WITH_DEBUG_XV),
2910 STR(WITH_DEBUG_RINGBUFFER),
2911 STR(WITH_DEBUG_SYMBOLS),
2912 STR(WITH_DEBUG_EVENTS),
2913 STR(WITH_DEBUG_MUTEX),
2914 STR(WITH_DEBUG_NTLM),
2915 STR(WITH_DEBUG_SDL_EVENTS),
2916 STR(WITH_DEBUG_SDL_KBD_EVENTS),
2917 STR(WITH_DEBUG_THREADS),
2918 STR(WITH_DEBUG_URBDRC) };
2919
2920 for (size_t x = 0; x < ARRAYSIZE(debug); x++)
2921 {
2922 const char* opt = debug[x];
2923 if (starts_with(tok, opt))
2924 return parse_on_off_option(tok);
2925 }
2926
2927 if (starts_with(tok, "WITH_DEBUG"))
2928 {
2929 WLog_Print(log, WLOG_WARN, "[BUG] Unmapped Debug-Build option '%s'.", tok);
2930 return parse_on_off_option(tok);
2931 }
2932
2933 return FALSE;
2934}
2935
2936static void log_build_warn(rdpRdp* rdp, const char* what, const char* msg,
2937 BOOL (*cmp)(wLog* log, const char* tok))
2938{
2939 WINPR_ASSERT(rdp);
2940 WINPR_PRAGMA_DIAG_PUSH
2941 WINPR_PRAGMA_DIAG_IGNORED_OVERLENGTH_STRINGS
2942
2943 size_t len = sizeof(FREERDP_BUILD_CONFIG);
2944 char* list = calloc(len, sizeof(char));
2945 char* config = _strdup(FREERDP_BUILD_CONFIG);
2946 WINPR_PRAGMA_DIAG_POP
2947
2948 if (config && list)
2949 {
2950 char* saveptr = NULL;
2951 char* tok = strtok_s(config, " ", &saveptr);
2952 while (tok)
2953 {
2954 if (cmp(rdp->log, tok))
2955 winpr_str_append(tok, list, len, " ");
2956
2957 tok = strtok_s(NULL, " ", &saveptr);
2958 }
2959 }
2960 free(config);
2961
2962 if (list)
2963 {
2964 if (strlen(list) > 0)
2965 {
2966 WLog_Print(rdp->log, WLOG_WARN, "*************************************************");
2967 WLog_Print(rdp->log, WLOG_WARN, "This build is using [%s] build options:", what);
2968
2969 char* saveptr = NULL;
2970 char* tok = strtok_s(list, " ", &saveptr);
2971 while (tok)
2972 {
2973 WLog_Print(rdp->log, WLOG_WARN, "* '%s'", tok);
2974 tok = strtok_s(NULL, " ", &saveptr);
2975 }
2976 WLog_Print(rdp->log, WLOG_WARN, "");
2977 WLog_Print(rdp->log, WLOG_WARN, "[%s] build options %s", what, msg);
2978 WLog_Print(rdp->log, WLOG_WARN, "*************************************************");
2979 }
2980 }
2981 free(list);
2982}
2983
2984#define print_first_line(log, firstLine, what) \
2985 print_first_line_int((log), (firstLine), (what), __FILE__, __func__, __LINE__)
2986static void print_first_line_int(wLog* log, log_line_t* firstLine, const char* what,
2987 const char* file, const char* fkt, size_t line)
2988{
2989 WINPR_ASSERT(firstLine);
2990 if (!firstLine->fkt)
2991 {
2992 const DWORD level = WLOG_WARN;
2993 if (WLog_IsLevelActive(log, level))
2994 {
2995 WLog_PrintMessage(log, WLOG_MESSAGE_TEXT, level, line, file, fkt,
2996 "*************************************************");
2997 WLog_PrintMessage(log, WLOG_MESSAGE_TEXT, level, line, file, fkt,
2998 "[SSL] {%s} build or configuration missing:", what);
2999 }
3000 firstLine->line = line;
3001 firstLine->file = file;
3002 firstLine->fkt = fkt;
3003 firstLine->level = level;
3004 }
3005}
3006
3007static void print_last_line(wLog* log, const log_line_t* firstLine)
3008{
3009 WINPR_ASSERT(firstLine);
3010 if (firstLine->fkt)
3011 {
3012 if (WLog_IsLevelActive(log, firstLine->level))
3013 WLog_PrintMessage(log, WLOG_MESSAGE_TEXT, firstLine->level, firstLine->line,
3014 firstLine->file, firstLine->fkt,
3015 "*************************************************");
3016 }
3017}
3018
3019static void log_build_warn_cipher(rdpRdp* rdp, log_line_t* firstLine, WINPR_CIPHER_TYPE md,
3020 const char* what)
3021{
3022 BOOL haveCipher = FALSE;
3023
3024 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = { 0 };
3025 char iv[WINPR_CIPHER_MAX_IV_LENGTH] = { 0 };
3026
3027 /* RC4 only exists in the compatibility functions winpr_RC4_*
3028 * winpr_Cipher_* does not support that. */
3029 if (md == WINPR_CIPHER_ARC4_128)
3030 {
3031 WINPR_RC4_CTX* enc = winpr_RC4_New(key, sizeof(key));
3032 haveCipher = enc != NULL;
3033 winpr_RC4_Free(enc);
3034 }
3035 else
3036 {
3037 WINPR_CIPHER_CTX* enc =
3038 winpr_Cipher_NewEx(md, WINPR_ENCRYPT, key, sizeof(key), iv, sizeof(iv));
3039 WINPR_CIPHER_CTX* dec =
3040 winpr_Cipher_NewEx(md, WINPR_DECRYPT, key, sizeof(key), iv, sizeof(iv));
3041 if (enc && dec)
3042 haveCipher = TRUE;
3043
3044 winpr_Cipher_Free(enc);
3045 winpr_Cipher_Free(dec);
3046 }
3047
3048 if (!haveCipher)
3049 {
3050 print_first_line(rdp->log, firstLine, "Cipher");
3051 WLog_Print(rdp->log, WLOG_WARN, "* %s: %s", winpr_cipher_type_to_string(md), what);
3052 }
3053}
3054
3055static void log_build_warn_hmac(rdpRdp* rdp, log_line_t* firstLine, WINPR_MD_TYPE md,
3056 const char* what)
3057{
3058 BOOL haveHmacX = FALSE;
3059 WINPR_HMAC_CTX* hmac = winpr_HMAC_New();
3060 if (hmac)
3061 {
3062 /* We need some key length, but there is no real limit here.
3063 * just take the cipher maximum key length as we already have that available.
3064 */
3065 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = { 0 };
3066 haveHmacX = winpr_HMAC_Init(hmac, md, key, sizeof(key));
3067 }
3068 winpr_HMAC_Free(hmac);
3069
3070 if (!haveHmacX)
3071 {
3072 print_first_line(rdp->log, firstLine, "HMAC");
3073 WLog_Print(rdp->log, WLOG_WARN, " * %s: %s", winpr_md_type_to_string(md), what);
3074 }
3075}
3076
3077static void log_build_warn_hash(rdpRdp* rdp, log_line_t* firstLine, WINPR_MD_TYPE md,
3078 const char* what)
3079{
3080 BOOL haveDigestX = FALSE;
3081
3082 WINPR_DIGEST_CTX* digest = winpr_Digest_New();
3083 if (digest)
3084 haveDigestX = winpr_Digest_Init(digest, md);
3085 winpr_Digest_Free(digest);
3086
3087 if (!haveDigestX)
3088 {
3089 print_first_line(rdp->log, firstLine, "Digest");
3090 WLog_Print(rdp->log, WLOG_WARN, " * %s: %s", winpr_md_type_to_string(md), what);
3091 }
3092}
3093
3094static void log_build_warn_ssl(rdpRdp* rdp)
3095{
3096 WINPR_ASSERT(rdp);
3097
3098 log_line_t firstHashLine = { 0 };
3099 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD4, "NTLM support not available");
3100 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD5,
3101 "NTLM, assistance files with encrypted passwords, autoreconnect cookies, "
3102 "licensing and RDP security will not work");
3103 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_SHA1,
3104 "assistance files with encrypted passwords, Kerberos, Smartcard Logon, RDP "
3105 "security support not available");
3106 log_build_warn_hash(
3107 rdp, &firstHashLine, WINPR_MD_SHA256,
3108 "file clipboard, AAD gateway, NLA security and certificates might not work");
3109 print_last_line(rdp->log, &firstHashLine);
3110
3111 log_line_t firstHmacLine = { 0 };
3112 log_build_warn_hmac(rdp, &firstHmacLine, WINPR_MD_MD5, "Autoreconnect cookie not supported");
3113 log_build_warn_hmac(rdp, &firstHmacLine, WINPR_MD_SHA1, "RDP security not supported");
3114 print_last_line(rdp->log, &firstHmacLine);
3115
3116 log_line_t firstCipherLine = { 0 };
3117 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_ARC4_128,
3118 "assistance files with encrypted passwords, NTLM, RDP licensing and RDP "
3119 "security will not work");
3120 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_DES_EDE3_CBC,
3121 "RDP security FIPS mode will not work");
3122 log_build_warn_cipher(
3123 rdp, &firstCipherLine, WINPR_CIPHER_AES_128_CBC,
3124 "assistance file encrypted LHTicket will not work and ARM gateway might not");
3125 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_AES_192_CBC,
3126 "ARM gateway might not work");
3127 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_AES_256_CBC,
3128 "ARM gateway might not work");
3129 print_last_line(rdp->log, &firstCipherLine);
3130}
3131
3132void rdp_log_build_warnings(rdpRdp* rdp)
3133{
3134 static unsigned count = 0;
3135
3136 WINPR_ASSERT(rdp);
3137 /* Since this function is called in context creation routines stop logging
3138 * this issue repeatedly. This is required for proxy, which would otherwise
3139 * spam the log with these. */
3140 if (count > 0)
3141 return;
3142 count++;
3143 log_build_warn(rdp, "experimental", "might crash the application", option_is_experimental);
3144 log_build_warn(rdp, "debug", "might leak sensitive information (credentials, ...)",
3145 option_is_debug);
3146 log_build_warn(rdp, "runtime-check", "might slow down the application",
3147 option_is_runtime_checks);
3148 log_build_warn_ssl(rdp);
3149}
WINPR_API void WINPR_JSON_Delete(WINPR_JSON *item)
Delete a WinPR JSON wrapper object.
Definition json.c:142
FREERDP_API BOOL freerdp_settings_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *param)
Sets a string settings value. The param is copied.
FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
FREERDP_API rdpSettings * freerdp_settings_new(DWORD flags)
creates a new setting struct
FREERDP_API rdpSettings * freerdp_settings_clone(const rdpSettings *settings)
Creates a deep copy of settings.
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.
FREERDP_API void freerdp_settings_free(rdpSettings *settings)
Free a settings struct with all data in it.
#define FREERDP_SETTINGS_SERVER_MODE