21#include <freerdp/config.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>
39#include "redirection.h"
41#include <freerdp/codec/bulk.h>
42#include <freerdp/crypto/per.h>
43#include <freerdp/log.h>
44#include <freerdp/buildflags.h>
46#define RDP_TAG FREERDP_TAG("core.rdp")
56static const char* DATA_PDU_TYPE_STRINGS[80] = {
98 "Set Keyboard Indicators",
100 "Bitmap Cache Persistent List",
101 "Bitmap Cache Error",
102 "Set Keyboard IME Status",
103 "Offscreen Cache Error",
105 "Draw Nine Grid Error",
124#define rdp_check_monitor_layout_pdu_state(rdp, expected) \
125 rdp_check_monitor_layout_pdu_state_(rdp, expected, __FILE__, __func__, __LINE__)
128static BOOL rdp_check_monitor_layout_pdu_state_(
const rdpRdp* rdp, BOOL expected,
const char* file,
129 const char* fkt,
size_t line)
132 if (expected != rdp->monitor_layout_pdu)
134 const DWORD log_level = WLOG_ERROR;
135 if (WLog_IsLevelActive(rdp->log, log_level))
137 WLog_PrintTextMessage(rdp->log, log_level, line, file, fkt,
138 "Expected rdp->monitor_layout_pdu == %s",
139 expected ?
"TRUE" :
"FALSE");
146#define rdp_set_monitor_layout_pdu_state(rdp, expected) \
147 rdp_set_monitor_layout_pdu_state_(rdp, expected, __FILE__, __func__, __LINE__)
149static BOOL rdp_set_monitor_layout_pdu_state_(rdpRdp* rdp, BOOL value,
const char* file,
150 const char* fkt,
size_t line)
154 if (value && (value == rdp->monitor_layout_pdu))
156 const DWORD log_level = WLOG_WARN;
157 if (WLog_IsLevelActive(rdp->log, log_level))
159 WLog_PrintTextMessage(rdp->log, log_level, line, file, fkt,
160 "rdp->monitor_layout_pdu == TRUE, expected FALSE");
164 rdp->monitor_layout_pdu = value;
168const char* data_pdu_type_to_string(UINT8 type)
170 if (type >= ARRAYSIZE(DATA_PDU_TYPE_STRINGS))
172 return DATA_PDU_TYPE_STRINGS[type];
176static BOOL rdp_read_flow_control_pdu(rdpRdp* rdp,
wStream* s, UINT16* type, UINT16* channel_id);
179static BOOL rdp_write_share_control_header(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 type,
183static BOOL rdp_write_share_data_header(rdpRdp* rdp,
wStream* s,
size_t length, BYTE type,
196BOOL rdp_read_security_header(rdpRdp* rdp,
wStream* s, UINT16* flags, UINT16* length)
198 char buffer[256] = WINPR_C_ARRAY_INIT;
204 if ((length && (*length < 4)))
206 WLog_Print(rdp->log, WLOG_WARN,
207 "invalid security header length, have %" PRIu16
", must be >= 4", *length);
210 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
213 *flags = Stream_Get_UINT16(s);
214 const uint16_t flagsHi = Stream_Get_UINT16(s);
215 if ((*flags & SEC_FLAGSHI_VALID) != 0)
217 WLog_Print(rdp->log, WLOG_WARN,
218 "[MS-RDPBCGR] 2.2.8.1.1.2.1 Basic (TS_SECURITY_HEADER) SEC_FLAGSHI_VALID field "
219 "set: flagsHi=0x%04" PRIx16,
222 WLog_Print(rdp->log, WLOG_TRACE,
"%s",
223 rdp_security_flag_string(*flags, buffer,
sizeof(buffer)));
239BOOL rdp_write_security_header(rdpRdp* rdp,
wStream* s, UINT16 flags)
241 char buffer[256] = WINPR_C_ARRAY_INIT;
245 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 4))
248 WLog_Print(rdp->log, WLOG_TRACE,
"%s", rdp_security_flag_string(flags, buffer,
sizeof(buffer)));
250 WINPR_ASSERT((flags & SEC_FLAGSHI_VALID) == 0);
251 Stream_Write_UINT16(s, flags);
252 Stream_Write_UINT16(s, 0);
256BOOL rdp_read_share_control_header(rdpRdp* rdp,
wStream* s, UINT16* tpktLength,
257 UINT16* remainingLength, UINT16* type, UINT16* channel_id)
265 WINPR_ASSERT(channel_id);
267 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
271 Stream_Read_UINT16(s, len);
277 if (!rdp_read_flow_control_pdu(rdp, s, type, channel_id))
283 *remainingLength = 0;
285 char buffer[128] = WINPR_C_ARRAY_INIT;
286 WLog_Print(rdp->log, WLOG_DEBUG,
287 "[Flow control PDU] type=%s, tpktLength=%" PRIu16
", remainingLength=%" PRIu16,
288 pdu_type_to_str(*type, buffer,
sizeof(buffer)), tpktLength ? *tpktLength : 0u,
289 remainingLength ? *remainingLength : 0u);
295 WLog_Print(rdp->log, WLOG_ERROR,
296 "Invalid share control header, length is %" PRIu16
", must be >4", len);
303 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
306 Stream_Read_UINT16(s, tmp);
309 size_t remLen = len - 4;
312 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
315 Stream_Read_UINT16(s, *channel_id);
321 char buffer[128] = WINPR_C_ARRAY_INIT;
322 WLog_Print(rdp->log, WLOG_DEBUG,
"type=%s, tpktLength=%" PRIu16
", remainingLength=%" PRIuz,
323 pdu_type_to_str(*type, buffer,
sizeof(buffer)), len, remLen);
326 WINPR_ASSERT(remLen <= UINT16_MAX);
327 *remainingLength = (UINT16)remLen;
329 return Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, remLen);
332BOOL rdp_write_share_control_header(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 type,
337 if (length > UINT16_MAX)
340 if (length < RDP_PACKET_HEADER_MAX_LENGTH)
342 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 6))
344 length -= RDP_PACKET_HEADER_MAX_LENGTH;
346 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, length));
347 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, type | 0x10));
348 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, channel_id));
352BOOL rdp_read_share_data_header(rdpRdp* rdp,
wStream* s, UINT16* length, BYTE* type,
353 UINT32* shareId, BYTE* compressedType, UINT16* compressedLength)
358 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
362 Stream_Read_UINT32(s, *shareId);
363 Stream_Seek_UINT8(s);
364 Stream_Seek_UINT8(s);
365 Stream_Read_UINT16(s, *length);
366 Stream_Read_UINT8(s, *type);
367 Stream_Read_UINT8(s, *compressedType);
368 Stream_Read_UINT16(s, *compressedLength);
372BOOL rdp_write_share_data_header(rdpRdp* rdp,
wStream* s,
size_t length, BYTE type, UINT32 share_id)
374 const size_t headerLen = RDP_PACKET_HEADER_MAX_LENGTH + RDP_SHARE_CONTROL_HEADER_LENGTH +
375 RDP_SHARE_DATA_HEADER_LENGTH;
379 if (length > UINT16_MAX)
382 if (length < headerLen)
385 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 12))
389 Stream_Write_UINT32(s, share_id);
390 Stream_Write_UINT8(s, 0);
391 Stream_Write_UINT8(s, STREAM_LOW);
393 s, WINPR_ASSERTING_INT_CAST(uint16_t, length));
394 Stream_Write_UINT8(s, type);
395 Stream_Write_UINT8(s, 0);
396 Stream_Write_UINT16(s, 0);
401static BOOL rdp_security_stream_init(rdpRdp* rdp,
wStream* s, BOOL sec_header, UINT16* sec_flags)
405 WINPR_ASSERT(sec_flags);
409 if (!Stream_SafeZero(s, 12))
412 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
414 if (!Stream_SafeZero(s, 4))
418 *sec_flags |= SEC_ENCRYPT;
420 if (rdp->do_secure_checksum)
421 *sec_flags |= SEC_SECURE_CHECKSUM;
423 else if (*sec_flags != 0 || sec_header)
425 if (!Stream_SafeZero(s, 4))
432wStream* rdp_send_stream_init(rdpRdp* rdp, UINT16* sec_flags)
437 WINPR_ASSERT(rdp->transport);
439 s = transport_send_stream_init(rdp->transport, 4096);
444 if (!Stream_SafeZero(s, RDP_PACKET_HEADER_MAX_LENGTH))
447 if (!rdp_security_stream_init(rdp, s, FALSE, sec_flags))
456wStream* rdp_send_stream_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
458 wStream* s = rdp_send_stream_init(rdp, sec_flags);
463 if (!Stream_SafeZero(s, RDP_SHARE_CONTROL_HEADER_LENGTH))
472wStream* rdp_data_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
474 wStream* s = rdp_send_stream_pdu_init(rdp, sec_flags);
479 if (!Stream_SafeZero(s, RDP_SHARE_DATA_HEADER_LENGTH))
488BOOL rdp_set_error_info(rdpRdp* rdp, UINT32 errorInfo)
493 rdp->errorInfo = errorInfo;
495 if (rdp->errorInfo != ERRINFO_SUCCESS)
497 rdpContext* context = rdp->context;
498 WINPR_ASSERT(context);
500 rdp_print_errinfo(rdp->errorInfo);
504 freerdp_set_last_error_log(context, MAKE_FREERDP_ERROR(
ERRINFO, errorInfo));
508 ErrorInfoEventArgs e = WINPR_C_ARRAY_INIT;
509 EventArgsInit(&e,
"freerdp");
510 e.code = rdp->errorInfo;
511 rc = PubSub_OnErrorInfo(context->pubSub, context, &e) >= 0;
515 WLog_Print(rdp->log, WLOG_ERROR,
"missing context=%p", (
void*)context);
519 freerdp_set_last_error_log(rdp->context, FREERDP_ERROR_SUCCESS);
525wStream* rdp_message_channel_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
531 s = transport_send_stream_init(rdp->transport, 4096);
536 if (!Stream_SafeZero(s, RDP_PACKET_HEADER_MAX_LENGTH))
539 if (!rdp_security_stream_init(rdp, s, TRUE, sec_flags))
558BOOL rdp_read_header(rdpRdp* rdp,
wStream* s, UINT16* length, UINT16* channelId)
563 UINT16 initiator = 0;
566 WINPR_ASSERT(rdp->settings);
568 DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataRequest
569 : DomainMCSPDU_SendDataIndication;
571 const size_t start = Stream_GetPosition(s);
573 if (!tpkt_read_header(s, length))
575 const UINT16 tpktLength = *length;
577 if (!tpdu_read_header(s, &code, &li, *length))
580 if (code != X224_TPDU_DATA)
582 if (code == X224_TPDU_DISCONNECT_REQUEST)
584 WLog_Print(rdp->log, WLOG_WARN,
"Received X224_TPDU_DISCONNECT_REQUEST, terminating");
585 utils_abort_connect(rdp);
589 WLog_Print(rdp->log, WLOG_WARN,
590 "Unexpected X224 TPDU type %s [%08" PRIx32
"] instead of %s",
591 tpdu_type_to_string(code), code, tpdu_type_to_string(X224_TPDU_DATA));
595 if (!per_read_choice(s, &choice))
598 const DomainMCSPDU domainMCSPDU = (DomainMCSPDU)(choice >> 2);
600 if (domainMCSPDU != MCSPDU)
602 if (domainMCSPDU != DomainMCSPDU_DisconnectProviderUltimatum)
604 WLog_Print(rdp->log, WLOG_WARN,
"Received %s instead of %s",
605 mcs_domain_pdu_string(domainMCSPDU), mcs_domain_pdu_string(MCSPDU));
610 MCSPDU = domainMCSPDU;
614 WLog_Print(rdp->log, WLOG_WARN,
"TPDU invalid length, got %" PRIu16
", expected at least 8",
619 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length - 8))
622 if (MCSPDU == DomainMCSPDU_DisconnectProviderUltimatum)
625 TerminateEventArgs e = WINPR_C_ARRAY_INIT;
627 if (!mcs_recv_disconnect_provider_ultimatum(rdp->mcs, s, &reason))
630 rdpContext* context = rdp->context;
631 WINPR_ASSERT(context);
632 context->disconnectUltimatum = reason;
634 if (rdp->errorInfo == ERRINFO_SUCCESS)
641 UINT32 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
642 if (reason == Disconnect_Ultimatum_provider_initiated)
643 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
644 else if (reason == Disconnect_Ultimatum_user_requested)
645 errorInfo = ERRINFO_LOGOFF_BY_USER;
647 if (!rdp_set_error_info(rdp, errorInfo))
651 WLog_Print(rdp->log, WLOG_DEBUG,
"DisconnectProviderUltimatum: reason: %d", reason);
652 utils_abort_connect(rdp);
653 EventArgsInit(&e,
"freerdp");
655 return PubSub_OnTerminate(rdp->pubSub, context, &e) >= 0;
658 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 5))
661 if (!per_read_integer16(s, &initiator, MCS_BASE_CHANNEL_ID))
664 if (!per_read_integer16(s, channelId, 0))
667 const uint8_t dataPriority = Stream_Get_UINT8(s);
668 WLog_Print(rdp->log, WLOG_TRACE,
"dataPriority=%" PRIu8, dataPriority);
670 if (!per_read_length(s, length))
676 const size_t headerLength = Stream_GetPosition(s) - start;
677 if ((headerLength > tpktLength) || (*length != tpktLength - headerLength))
679 WLog_Print(rdp->log, WLOG_ERROR,
680 "MCS userData length %" PRIu16
" is inconsistent with TPKT length %" PRIu16
681 " and header length %" PRIuz,
682 *length, tpktLength, headerLength);
686 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length))
702BOOL rdp_write_header(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 channelId, UINT16 sec_flags)
705 WINPR_ASSERT(rdp->settings);
707 WINPR_ASSERT(length >= RDP_PACKET_HEADER_MAX_LENGTH);
708 if (length > UINT16_MAX)
711 DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataIndication
712 : DomainMCSPDU_SendDataRequest;
714 if ((sec_flags & SEC_ENCRYPT) && (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS))
716 const UINT16 body_length = (UINT16)length - RDP_PACKET_HEADER_MAX_LENGTH;
717 const UINT16 pad = 8 - (body_length % 8);
723 if (!mcs_write_domain_mcspdu_header(s, MCSPDU, (UINT16)length, 0))
725 if (!per_write_integer16(s, rdp->mcs->userId, MCS_BASE_CHANNEL_ID))
727 if (!per_write_integer16(s, channelId, 0))
729 if (!Stream_EnsureRemainingCapacity(s, 3))
731 Stream_Write_UINT8(s, 0x70);
738 length = (length - RDP_PACKET_HEADER_MAX_LENGTH) | 0x8000;
739 Stream_Write_UINT16_BE(
740 s, WINPR_ASSERTING_INT_CAST(uint16_t, length));
745static BOOL rdp_security_stream_out(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 sec_flags,
750 if (length > UINT16_MAX)
757 WINPR_ASSERT(sec_flags <= UINT16_MAX);
758 if (!rdp_write_security_header(rdp, s, sec_flags))
761 if (sec_flags & SEC_ENCRYPT)
763 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
765 BYTE* data = Stream_PointerAs(s, BYTE) + 12;
766 const size_t size = WINPR_ASSERTING_INT_CAST(
size_t, (data - Stream_Buffer(s)));
772 Stream_Write_UINT16(s, 0x10);
773 Stream_Write_UINT8(s, 0x1);
775 *pad = 8 - (length % 8);
780 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, length + *pad))
784 memset(data + length, 0, *pad);
786 Stream_Write_UINT8(s, WINPR_ASSERTING_INT_CAST(uint8_t, *pad));
788 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
790 if (!security_hmac_signature(data, length, Stream_Pointer(s), 8, rdp))
794 if (!security_fips_encrypt(data, length + *pad, rdp))
799 const BYTE* data = Stream_PointerAs(s,
const BYTE) + 8;
800 const size_t diff = Stream_GetPosition(s) + 8ULL;
805 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
807 if (sec_flags & SEC_SECURE_CHECKSUM)
808 status = security_salted_mac_signature(rdp, data, (UINT32)length, TRUE,
809 Stream_Pointer(s), 8);
811 status = security_mac_signature(rdp, data, (UINT32)length,
812 Stream_PointerAs(s, BYTE), 8);
819 if (!security_encrypt(Stream_Pointer(s), length, rdp))
829static UINT32 rdp_get_sec_bytes(rdpRdp* rdp, UINT16 sec_flags)
831 UINT32 sec_bytes = 0;
833 if (sec_flags & SEC_ENCRYPT)
837 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
840 else if (sec_flags != 0)
852BOOL rdp_send(rdpRdp* rdp,
wStream* s, UINT16 channelId, UINT16 sec_flags)
856 BOOL should_unlock = FALSE;
864 if (sec_flags & SEC_ENCRYPT)
867 should_unlock = TRUE;
871 size_t length = Stream_GetPosition(s);
872 Stream_ResetPosition(s);
873 if (!rdp_write_header(rdp, s, length, channelId, sec_flags))
876 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
880 if (!Stream_SetPosition(s, length))
882 Stream_SealLength(s);
885 if (transport_write(rdp->transport, s) < 0)
891 security_unlock(rdp);
896BOOL rdp_send_pdu(rdpRdp* rdp,
wStream* s, UINT16 type, UINT16 channel_id, UINT16 sec_flags)
899 UINT32 sec_bytes = 0;
902 BOOL should_unlock = FALSE;
910 if (sec_flags & SEC_ENCRYPT)
913 should_unlock = TRUE;
917 size_t length = Stream_GetPosition(s);
918 Stream_ResetPosition(s);
919 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
921 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
922 sec_hold = Stream_GetPosition(s);
923 Stream_Seek(s, sec_bytes);
924 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, type, channel_id))
926 if (!Stream_SetPosition(s, sec_hold))
929 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
933 if (!Stream_SetPosition(s, length))
935 Stream_SealLength(s);
938 if (transport_write(rdp->transport, s) < 0)
944 security_unlock(rdp);
948BOOL rdp_send_data_pdu(rdpRdp* rdp,
wStream* s, BYTE type, UINT16 channel_id, UINT16 sec_flags)
951 UINT32 sec_bytes = 0;
954 BOOL should_unlock = FALSE;
962 if (sec_flags & SEC_ENCRYPT)
965 should_unlock = TRUE;
969 size_t length = Stream_GetPosition(s);
970 Stream_ResetPosition(s);
971 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
973 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
974 sec_hold = Stream_GetPosition(s);
975 Stream_Seek(s, sec_bytes);
976 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, PDU_TYPE_DATA, channel_id))
978 if (!rdp_write_share_data_header(rdp, s, length - sec_bytes, type, rdp->settings->ShareId))
980 if (!Stream_SetPosition(s, sec_hold))
983 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
987 if (!Stream_SetPosition(s, length))
989 Stream_SealLength(s);
991 WLog_Print(rdp->log, WLOG_DEBUG,
992 "sending data (type=0x%x size=%" PRIuz
" channelId=%" PRIu16
")", type,
993 Stream_Length(s), channel_id);
996 if (transport_write(rdp->transport, s) < 0)
1002 security_unlock(rdp);
1007BOOL rdp_send_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 sec_flags)
1011 BOOL should_unlock = FALSE;
1016 if (sec_flags & SEC_ENCRYPT)
1019 should_unlock = TRUE;
1023 size_t length = Stream_GetPosition(s);
1024 Stream_ResetPosition(s);
1025 if (!rdp_write_header(rdp, s, length, rdp->mcs->messageChannelId, sec_flags))
1028 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
1032 if (!Stream_SetPosition(s, length))
1035 Stream_SealLength(s);
1037 if (transport_write(rdp->transport, s) < 0)
1043 security_unlock(rdp);
1050static BOOL rdp_recv_server_shutdown_denied_pdu(WINPR_ATTR_UNUSED rdpRdp* rdp,
1057static BOOL rdp_recv_server_set_keyboard_indicators_pdu(rdpRdp* rdp,
wStream* s)
1062 rdpContext* context = rdp->context;
1063 WINPR_ASSERT(context);
1064 WINPR_ASSERT(context->update);
1066 if (!rdp_has_reached_state(rdp, CONNECTION_STATE_ACTIVE))
1069 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1072 const uint16_t unitId = Stream_Get_UINT16(s);
1075 WLog_Print(rdp->log, WLOG_WARN,
1076 "[MS-RDPBCGR] 2.2.8.2.1.1 Set Keyboard Indicators PDU Data "
1077 "(TS_SET_KEYBOARD_INDICATORS_PDU)::unitId should be 0, is %" PRIu16,
1080 const UINT16 ledFlags = Stream_Get_UINT16(s);
1081 return IFCALLRESULT(TRUE, context->update->SetKeyboardIndicators, context, ledFlags);
1085static BOOL rdp_recv_server_set_keyboard_ime_status_pdu(rdpRdp* rdp,
wStream* s)
1087 if (!rdp || !rdp->input)
1090 if (!rdp_has_reached_state(rdp, CONNECTION_STATE_ACTIVE))
1093 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 10))
1096 const uint16_t unitId = Stream_Get_UINT16(s);
1099 WLog_Print(rdp->log, WLOG_WARN,
1100 "[MS-RDPBCGR] 2.2.8.2.2.1 Set Keyboard IME Status PDU Data "
1101 "(TS_SET_KEYBOARD_IME_STATUS_PDU)::unitId should be 0, is %" PRIu16,
1104 const uint32_t imeState = Stream_Get_UINT32(s);
1105 const uint32_t imeConvMode = Stream_Get_UINT32(s);
1106 return IFCALLRESULT(TRUE, rdp->update->SetKeyboardImeStatus, rdp->context, unitId, imeState,
1111static BOOL rdp_recv_set_error_info_data_pdu(rdpRdp* rdp,
wStream* s)
1113 UINT32 errorInfo = 0;
1115 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1118 Stream_Read_UINT32(s, errorInfo);
1119 return rdp_set_error_info(rdp, errorInfo);
1123static BOOL rdp_recv_server_auto_reconnect_status_pdu(rdpRdp* rdp,
wStream* s)
1125 UINT32 arcStatus = 0;
1127 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1130 Stream_Read_UINT32(s, arcStatus);
1131 WLog_Print(rdp->log, WLOG_WARN,
"AutoReconnectStatus: 0x%08" PRIX32
"", arcStatus);
1136static BOOL rdp_recv_server_status_info_pdu(rdpRdp* rdp,
wStream* s)
1138 UINT32 statusCode = 0;
1140 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1143 Stream_Read_UINT32(s, statusCode);
1145 if (rdp->update->ServerStatusInfo)
1146 return rdp->update->ServerStatusInfo(rdp->context, statusCode);
1151static void log_monitor(
size_t idx,
const MONITOR_DEF* monitor, wLog* log, DWORD level)
1153 WINPR_ASSERT(monitor);
1155 WLog_Print(log, level,
"[%" PRIuz
"] {%dx%d-%dx%d} [0x%08" PRIx32
"]", idx, monitor->left,
1156 monitor->top, monitor->right, monitor->bottom, monitor->flags);
1159static void log_monitor_configuration(wLog* log,
const MONITOR_DEF* monitors,
size_t count)
1161 const DWORD level = WLOG_DEBUG;
1162 WLog_Print(log, level,
"[BEGIN] RemoteMonitors[%" PRIuz
"]", count);
1163 for (
size_t x = 0; x < count; x++)
1166 log_monitor(x, monitor, log, level);
1168 WLog_Print(log, level,
"[END] RemoteMonitors[%" PRIuz
"]", count);
1172static BOOL rdp_recv_monitor_layout_pdu(rdpRdp* rdp,
wStream* s)
1178 if (!rdp_has_reached_state(rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT))
1181 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1184 const UINT32 monitorCount = Stream_Get_UINT32(s);
1186 if (!Stream_CheckAndLogRequiredLengthOfSizeWLog(rdp->log, s, monitorCount, 20ull))
1191 if (!monitorDefArray)
1194 for (UINT32 index = 0; index < monitorCount; index++)
1197 Stream_Read_INT32(s, monitor->left);
1198 Stream_Read_INT32(s, monitor->top);
1199 Stream_Read_INT32(s, monitor->right);
1200 Stream_Read_INT32(s, monitor->bottom);
1201 Stream_Read_UINT32(s, monitor->flags);
1204 log_monitor_configuration(rdp->log, monitorDefArray, monitorCount);
1205 IFCALLRET(rdp->update->RemoteMonitors, ret, rdp->context, monitorCount, monitorDefArray);
1206 free(monitorDefArray);
1209 return rdp_set_monitor_layout_pdu_state(rdp, TRUE);
1212state_run_t rdp_recv_data_pdu(rdpRdp* rdp,
wStream* s)
1218 BYTE compressedType = 0;
1219 UINT16 compressedLength = 0;
1222 if (!rdp_read_share_data_header(rdp, s, &length, &type, &shareId, &compressedType,
1225 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_read_share_data_header() failed");
1226 return STATE_RUN_FAILED;
1231 if (compressedType & PACKET_COMPRESSED)
1233 if (compressedLength < 18)
1235 WLog_Print(rdp->log, WLOG_ERROR,
1236 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1238 return STATE_RUN_FAILED;
1242 const BYTE* pDstData =
nullptr;
1243 UINT16 SrcSize = compressedLength - 18;
1245 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, SrcSize))
1247 WLog_Print(rdp->log, WLOG_ERROR,
1248 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1250 return STATE_RUN_FAILED;
1253 if (bulk_decompress(rdp->bulk, Stream_ConstPointer(s), SrcSize, &pDstData, &DstSize,
1256 cs = transport_take_from_pool(rdp->transport, DstSize);
1259 WLog_Print(rdp->log, WLOG_ERROR,
"Couldn't take stream from pool");
1260 return STATE_RUN_FAILED;
1263 Stream_ResetPosition(cs);
1264 Stream_Write(cs, pDstData, DstSize);
1265 Stream_SealLength(cs);
1266 Stream_ResetPosition(cs);
1270 WLog_Print(rdp->log, WLOG_ERROR,
"bulk_decompress() failed");
1271 return STATE_RUN_FAILED;
1274 Stream_Seek(s, SrcSize);
1277 WLog_Print(rdp->log, WLOG_DEBUG,
"recv %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1278 data_pdu_type_to_string(type), type, length);
1282 case DATA_PDU_TYPE_UPDATE:
1283 if (!update_recv(rdp->update, cs))
1285 WLog_Print(rdp->log, WLOG_ERROR,
"DATA_PDU_TYPE_UPDATE - update_recv() failed");
1291 case DATA_PDU_TYPE_CONTROL:
1292 if (!rdp_recv_server_control_pdu(rdp, cs))
1294 WLog_Print(rdp->log, WLOG_ERROR,
1295 "DATA_PDU_TYPE_CONTROL - rdp_recv_server_control_pdu() failed");
1301 case DATA_PDU_TYPE_POINTER:
1302 if (!update_recv_pointer(rdp->update, cs))
1304 WLog_Print(rdp->log, WLOG_ERROR,
1305 "DATA_PDU_TYPE_POINTER - update_recv_pointer() failed");
1311 case DATA_PDU_TYPE_SYNCHRONIZE:
1312 if (!rdp_recv_server_synchronize_pdu(rdp, cs))
1314 WLog_Print(rdp->log, WLOG_ERROR,
1315 "DATA_PDU_TYPE_SYNCHRONIZE - rdp_recv_synchronize_pdu() failed");
1321 case DATA_PDU_TYPE_PLAY_SOUND:
1322 if (!update_recv_play_sound(rdp->update, cs))
1324 WLog_Print(rdp->log, WLOG_ERROR,
1325 "DATA_PDU_TYPE_PLAY_SOUND - update_recv_play_sound() failed");
1331 case DATA_PDU_TYPE_SHUTDOWN_DENIED:
1332 if (!rdp_recv_server_shutdown_denied_pdu(rdp, cs))
1335 rdp->log, WLOG_ERROR,
1336 "DATA_PDU_TYPE_SHUTDOWN_DENIED - rdp_recv_server_shutdown_denied_pdu() failed");
1342 case DATA_PDU_TYPE_SAVE_SESSION_INFO:
1343 if (!rdp_recv_save_session_info(rdp, cs))
1345 WLog_Print(rdp->log, WLOG_ERROR,
1346 "DATA_PDU_TYPE_SAVE_SESSION_INFO - rdp_recv_save_session_info() failed");
1352 case DATA_PDU_TYPE_FONT_MAP:
1353 if (!rdp_recv_font_map_pdu(rdp, cs))
1355 WLog_Print(rdp->log, WLOG_ERROR,
1356 "DATA_PDU_TYPE_FONT_MAP - rdp_recv_font_map_pdu() failed");
1362 case DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS:
1363 if (!rdp_recv_server_set_keyboard_indicators_pdu(rdp, cs))
1365 WLog_Print(rdp->log, WLOG_ERROR,
1366 "DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS - "
1367 "rdp_recv_server_set_keyboard_indicators_pdu() failed");
1373 case DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS:
1374 if (!rdp_recv_server_set_keyboard_ime_status_pdu(rdp, cs))
1376 WLog_Print(rdp->log, WLOG_ERROR,
1377 "DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS - "
1378 "rdp_recv_server_set_keyboard_ime_status_pdu() failed");
1384 case DATA_PDU_TYPE_SET_ERROR_INFO:
1385 if (!rdp_recv_set_error_info_data_pdu(rdp, cs))
1388 rdp->log, WLOG_ERROR,
1389 "DATA_PDU_TYPE_SET_ERROR_INFO - rdp_recv_set_error_info_data_pdu() failed");
1395 case DATA_PDU_TYPE_ARC_STATUS:
1396 if (!rdp_recv_server_auto_reconnect_status_pdu(rdp, cs))
1398 WLog_Print(rdp->log, WLOG_ERROR,
1399 "DATA_PDU_TYPE_ARC_STATUS - "
1400 "rdp_recv_server_auto_reconnect_status_pdu() failed");
1406 case DATA_PDU_TYPE_STATUS_INFO:
1407 if (!rdp_recv_server_status_info_pdu(rdp, cs))
1409 WLog_Print(rdp->log, WLOG_ERROR,
1410 "DATA_PDU_TYPE_STATUS_INFO - rdp_recv_server_status_info_pdu() failed");
1416 case DATA_PDU_TYPE_MONITOR_LAYOUT:
1417 if (!rdp_recv_monitor_layout_pdu(rdp, cs))
1419 WLog_Print(rdp->log, WLOG_ERROR,
1420 "DATA_PDU_TYPE_MONITOR_LAYOUT - rdp_recv_monitor_layout_pdu() failed");
1427 WLog_Print(rdp->log, WLOG_WARN,
1428 "[UNHANDLED] %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1429 data_pdu_type_to_string(type), type, length);
1436 return STATE_RUN_SUCCESS;
1442 return STATE_RUN_FAILED;
1445state_run_t rdp_recv_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 securityFlags)
1450 if (securityFlags & SEC_AUTODETECT_REQ)
1453 return autodetect_recv_request_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1456 if (securityFlags & SEC_AUTODETECT_RSP)
1459 return autodetect_recv_response_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1462 if (securityFlags & SEC_HEARTBEAT)
1465 return rdp_recv_heartbeat_packet(rdp, s);
1468 if (securityFlags & SEC_TRANSPORT_REQ)
1470 return multitransport_recv_request(rdp->multitransport, s);
1473 if (securityFlags & SEC_TRANSPORT_RSP)
1475 return multitransport_recv_response(rdp->multitransport, s);
1478 if (securityFlags & SEC_LICENSE_PKT)
1480 return license_recv(rdp->license, s);
1483 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
1485 return license_recv(rdp->license, s);
1488 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
1490 return license_recv(rdp->license, s);
1493 return STATE_RUN_SUCCESS;
1496state_run_t rdp_recv_out_of_sequence_pdu(rdpRdp* rdp,
wStream* s, UINT16 pduType, UINT16 length)
1498 state_run_t rc = STATE_RUN_FAILED;
1504 rc = rdp_recv_data_pdu(rdp, s);
1506 case PDU_TYPE_SERVER_REDIRECTION:
1507 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1509 case PDU_TYPE_FLOW_RESPONSE:
1510 case PDU_TYPE_FLOW_STOP:
1511 case PDU_TYPE_FLOW_TEST:
1512 rc = STATE_RUN_SUCCESS;
1516 char buffer1[256] = WINPR_C_ARRAY_INIT;
1517 char buffer2[256] = WINPR_C_ARRAY_INIT;
1519 WLog_Print(rdp->log, WLOG_ERROR,
"expected %s, got %s",
1520 pdu_type_to_str(PDU_TYPE_DEMAND_ACTIVE, buffer1,
sizeof(buffer1)),
1521 pdu_type_to_str(pduType, buffer2,
sizeof(buffer2)));
1522 rc = STATE_RUN_FAILED;
1527 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1528 return STATE_RUN_FAILED;
1532BOOL rdp_read_flow_control_pdu(rdpRdp* rdp,
wStream* s, UINT16* type, UINT16* channel_id)
1546 WINPR_ASSERT(channel_id);
1548 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 6))
1550 Stream_Read_UINT8(s, pduType);
1552 Stream_Seek_UINT8(s);
1553 Stream_Seek_UINT8(s);
1554 Stream_Seek_UINT8(s);
1555 Stream_Read_UINT16(s, *channel_id);
1570BOOL rdp_decrypt(rdpRdp* rdp,
wStream* s, UINT16* pLength, UINT16 securityFlags)
1573 BYTE cmac[8] = WINPR_C_ARRAY_INIT;
1574 BYTE wmac[8] = WINPR_C_ARRAY_INIT;
1575 BOOL status = FALSE;
1578 WINPR_ASSERT(rdp->settings);
1580 WINPR_ASSERT(pLength);
1584 INT32 length = *pLength;
1585 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_NONE)
1591 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *pLength))
1594 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
1596 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
1600 Stream_Read_UINT16(s, len);
1602 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS length %" PRIu16
" != 0x10",
1606 Stream_Read_UINT8(s, version);
1608 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS version %" PRIu16
" != 1",
1612 Stream_Read_UINT8(s, pad);
1613 const BYTE* sig = Stream_ConstPointer(s);
1616 const INT32 padLength = length - pad;
1618 if ((length <= 0) || (padLength <= 0) || (padLength > UINT16_MAX))
1620 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid pad length %" PRId32, padLength);
1627 if ((length % 8) != 0)
1629 WLog_Print(rdp->log, WLOG_ERROR,
1630 "FATAL: FIPS data length %" PRId32
" is not a multiple of 3DES block size",
1635 if (!security_fips_decrypt(Stream_Pointer(s), (
size_t)length, rdp))
1638 if (!security_fips_check_signature(Stream_ConstPointer(s), (
size_t)padLength, sig, 8, rdp))
1641 if (!Stream_SetLength(s, Stream_Length(s) - pad))
1644 *pLength = (UINT16)padLength;
1648 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s,
sizeof(wmac)))
1651 Stream_Read(s, wmac,
sizeof(wmac));
1652 length -=
sizeof(wmac);
1656 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid length field");
1660 if (!security_decrypt(Stream_PointerAs(s, BYTE), (
size_t)length, rdp))
1663 if (securityFlags & SEC_SECURE_CHECKSUM)
1664 status = security_salted_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length,
1665 FALSE, cmac,
sizeof(cmac));
1667 status = security_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length, cmac,
1673 if (memcmp(wmac, cmac,
sizeof(wmac)) != 0)
1675 WLog_Print(rdp->log, WLOG_ERROR,
"WARNING: invalid packet signature");
1686 *pLength = (UINT16)length;
1690 security_unlock(rdp);
1694const char* pdu_type_to_str(UINT16 pduType,
char* buffer,
size_t length)
1696 const char* str =
nullptr;
1699 case PDU_TYPE_DEMAND_ACTIVE:
1700 str =
"PDU_TYPE_DEMAND_ACTIVE";
1702 case PDU_TYPE_CONFIRM_ACTIVE:
1703 str =
"PDU_TYPE_CONFIRM_ACTIVE";
1705 case PDU_TYPE_DEACTIVATE_ALL:
1706 str =
"PDU_TYPE_DEACTIVATE_ALL";
1709 str =
"PDU_TYPE_DATA";
1711 case PDU_TYPE_SERVER_REDIRECTION:
1712 str =
"PDU_TYPE_SERVER_REDIRECTION";
1714 case PDU_TYPE_FLOW_TEST:
1715 str =
"PDU_TYPE_FLOW_TEST";
1717 case PDU_TYPE_FLOW_RESPONSE:
1718 str =
"PDU_TYPE_FLOW_RESPONSE";
1720 case PDU_TYPE_FLOW_STOP:
1721 str =
"PDU_TYPE_FLOW_STOP";
1724 str =
"PDU_TYPE_UNKNOWN";
1728 winpr_str_append(str, buffer, length,
"");
1730 char msg[32] = WINPR_C_ARRAY_INIT;
1731 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", pduType);
1732 winpr_str_append(msg, buffer, length,
"");
1743static state_run_t rdp_recv_tpkt_pdu(rdpRdp* rdp,
wStream* s)
1745 state_run_t rc = STATE_RUN_SUCCESS;
1748 UINT16 pduSource = 0;
1749 UINT16 channelId = 0;
1750 UINT16 securityFlags = 0;
1753 WINPR_ASSERT(rdp->context);
1756 freerdp* instance = rdp->context->instance;
1757 WINPR_ASSERT(instance);
1759 if (!rdp_read_header(rdp, s, &length, &channelId))
1760 return STATE_RUN_FAILED;
1762 if (freerdp_shall_disconnect_context(rdp->context))
1763 return STATE_RUN_SUCCESS;
1765 if (rdp->autodetect->bandwidthMeasureStarted)
1767 rdp->autodetect->bandwidthMeasureByteCount += length;
1770 if (rdp->mcs->messageChannelId && (channelId == rdp->mcs->messageChannelId))
1773 return rdp_handle_message_channel(rdp, s, channelId, length);
1776 if (rdp->settings->UseRdpSecurityLayer)
1778 if (!rdp_read_security_header(rdp, s, &securityFlags, &length))
1779 return STATE_RUN_FAILED;
1781 if (securityFlags & (SEC_ENCRYPT | SEC_REDIRECTION_PKT))
1783 if (!rdp_decrypt(rdp, s, &length, securityFlags))
1784 return STATE_RUN_FAILED;
1787 if (securityFlags & SEC_REDIRECTION_PKT)
1793 Stream_Rewind(s, 2);
1796 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1801 if (channelId == MCS_GLOBAL_CHANNEL_ID)
1803 while (Stream_GetRemainingLength(s) > 3)
1810 if (!rdp_read_share_control_header(rdp, s,
nullptr, &remain, &pduType, &pduSource))
1811 return STATE_RUN_FAILED;
1813 sub = Stream_StaticInit(&subbuffer, Stream_Pointer(s), remain);
1814 if (!Stream_SafeSeek(s, remain))
1815 return STATE_RUN_FAILED;
1817 rdp->settings->PduSource = pduSource;
1823 rc = rdp_recv_data_pdu(rdp, sub);
1824 if (state_run_failed(rc))
1828 case PDU_TYPE_DEACTIVATE_ALL:
1829 if (!rdp_recv_deactivate_all(rdp, sub))
1831 WLog_Print(rdp->log, WLOG_ERROR,
1832 "rdp_recv_tpkt_pdu: rdp_recv_deactivate_all() fail");
1833 return STATE_RUN_FAILED;
1838 case PDU_TYPE_SERVER_REDIRECTION:
1839 return rdp_recv_enhanced_security_redirection_packet(rdp, sub);
1841 case PDU_TYPE_FLOW_RESPONSE:
1842 case PDU_TYPE_FLOW_STOP:
1843 case PDU_TYPE_FLOW_TEST:
1844 WLog_Print(rdp->log, WLOG_DEBUG,
"flow message 0x%04" PRIX16
"", pduType);
1846 if (!Stream_SafeSeek(sub, remain))
1847 return STATE_RUN_FAILED;
1852 char buffer[256] = WINPR_C_ARRAY_INIT;
1853 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect PDU type: %s",
1854 pdu_type_to_str(pduType, buffer,
sizeof(buffer)));
1859 diff = Stream_GetRemainingLength(sub);
1862 char buffer[256] = WINPR_C_ARRAY_INIT;
1863 WLog_Print(rdp->log, WLOG_WARN,
1864 "pduType %s not properly parsed, %" PRIuz
1865 " bytes remaining unhandled. Skipping.",
1866 pdu_type_to_str(pduType, buffer,
sizeof(buffer)), diff);
1874 if (!freerdp_channel_process(instance, s, channelId, length))
1875 return STATE_RUN_FAILED;
1879 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1880 return STATE_RUN_FAILED;
1885static state_run_t rdp_recv_fastpath_pdu(rdpRdp* rdp,
wStream* s)
1890 rdpFastPath* fastpath = rdp->fastpath;
1892 if (!fastpath_read_header_rdp(fastpath, s, &length))
1894 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_recv_fastpath_pdu: fastpath_read_header_rdp() fail");
1895 return STATE_RUN_FAILED;
1898 if ((length == 0) || (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, length)))
1900 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect FastPath PDU header length %" PRIu16
"",
1902 return STATE_RUN_FAILED;
1905 if (rdp->autodetect->bandwidthMeasureStarted)
1907 rdp->autodetect->bandwidthMeasureByteCount += length;
1910 if (!fastpath_decrypt(fastpath, s, &length))
1911 return STATE_RUN_FAILED;
1913 return fastpath_recv_updates(rdp->fastpath, s);
1917static state_run_t rdp_recv_pdu(rdpRdp* rdp,
wStream* s)
1919 const int rc = tpkt_verify_header(s);
1921 return rdp_recv_tpkt_pdu(rdp, s);
1923 return rdp_recv_fastpath_pdu(rdp, s);
1925 return STATE_RUN_FAILED;
1929static state_run_t rdp_handle_sc_flags(rdpRdp* rdp,
wStream* s, UINT32 flag,
1930 CONNECTION_STATE nextState)
1932 const UINT32 mask = FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
1933 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU;
1935 state_run_t status = rdp_recv_pdu(rdp, s);
1936 if (state_run_success(status))
1938 const UINT32 flags = rdp->finalize_sc_pdus & mask;
1939 if ((flags & flag) == flag)
1941 if (!rdp_client_transition_to_state(rdp, nextState))
1942 status = STATE_RUN_FAILED;
1944 status = STATE_RUN_SUCCESS;
1948 char flag_buffer[256] = WINPR_C_ARRAY_INIT;
1949 char mask_buffer[256] = WINPR_C_ARRAY_INIT;
1950 WLog_Print(rdp->log, WLOG_WARN,
1951 "[%s] unexpected server message, expected flag %s [have %s]",
1952 rdp_get_state_string(rdp),
1953 rdp_finalize_flags_to_str(flag, flag_buffer,
sizeof(flag_buffer)),
1954 rdp_finalize_flags_to_str(flags, mask_buffer,
sizeof(mask_buffer)));
1961static state_run_t rdp_client_exchange_monitor_layout(rdpRdp* rdp,
wStream* s)
1965 if (!rdp_check_monitor_layout_pdu_state(rdp, FALSE))
1966 return STATE_RUN_FAILED;
1971 const UINT32 old = rdp->finalize_sc_pdus;
1972 state_run_t status = rdp_recv_pdu(rdp, s);
1973 const UINT32 now = rdp->finalize_sc_pdus;
1974 const BOOL changed = (old != now) || rdp->monitor_layout_pdu;
1977 if (state_run_success(status) && changed)
1979 if (!rdp->monitor_layout_pdu)
1981 if (!rdp_finalize_is_flag_set(rdp, FINALIZE_SC_SYNCHRONIZE_PDU))
1982 return STATE_RUN_FAILED;
1983 else if (!rdp_client_transition_to_state(rdp,
1984 CONNECTION_STATE_FINALIZATION_CLIENT_SYNC))
1985 return STATE_RUN_FAILED;
1987 return STATE_RUN_TRY_AGAIN;
1992 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_CLIENT_SYNC))
1993 return STATE_RUN_FAILED;
1999static state_run_t rdp_recv_callback_int(WINPR_ATTR_UNUSED rdpTransport* transport,
wStream* s,
2002 state_run_t status = STATE_RUN_SUCCESS;
2003 rdpRdp* rdp = (rdpRdp*)extra;
2005 WINPR_ASSERT(transport);
2009 switch (rdp_get_state(rdp))
2011 case CONNECTION_STATE_NEGO:
2012 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
2013 status = STATE_RUN_FAILED;
2015 status = STATE_RUN_CONTINUE;
2017 case CONNECTION_STATE_NLA:
2018 if (nla_get_state(rdp->nla) < NLA_STATE_AUTH_INFO)
2020 if (nla_recv_pdu(rdp->nla, s) < 1)
2022 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nla_recv_pdu() fail",
2023 rdp_get_state_string(rdp));
2024 status = STATE_RUN_FAILED;
2027 else if (nla_get_state(rdp->nla) == NLA_STATE_POST_NEGO)
2029 if (nego_recv(rdp->transport, s, (
void*)rdp->nego) < 0)
2030 return STATE_RUN_FAILED;
2032 if (!nego_update_settings_from_state(rdp->nego, rdp->settings))
2033 return STATE_RUN_FAILED;
2035 if (nego_get_state(rdp->nego) != NEGO_STATE_FINAL)
2037 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nego_recv() fail",
2038 rdp_get_state_string(rdp));
2039 status = STATE_RUN_FAILED;
2041 else if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
2042 status = STATE_RUN_FAILED;
2045 if (state_run_success(status))
2047 if (nla_get_state(rdp->nla) == NLA_STATE_AUTH_INFO)
2049 transport_set_nla_mode(rdp->transport, FALSE);
2051 if (rdp->settings->VmConnectMode)
2053 if (!nego_set_state(rdp->nego, NEGO_STATE_NLA))
2054 status = STATE_RUN_FAILED;
2055 else if (!nego_set_requested_protocols(rdp->nego,
2056 PROTOCOL_HYBRID | PROTOCOL_SSL))
2057 status = STATE_RUN_FAILED;
2058 else if (!nego_send_negotiation_request(rdp->nego))
2059 status = STATE_RUN_FAILED;
2060 else if (!nla_set_state(rdp->nla, NLA_STATE_POST_NEGO))
2061 status = STATE_RUN_FAILED;
2065 if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
2066 status = STATE_RUN_FAILED;
2070 if (state_run_success(status))
2073 if (nla_get_state(rdp->nla) == NLA_STATE_FINAL)
2075 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
2076 status = STATE_RUN_FAILED;
2078 status = STATE_RUN_CONTINUE;
2083 case CONNECTION_STATE_AAD:
2084 if (aad_recv(rdp->aad, s) < 1)
2086 WLog_Print(rdp->log, WLOG_ERROR,
"%s - aad_recv() fail", rdp_get_state_string(rdp));
2087 status = STATE_RUN_FAILED;
2089 if (state_run_success(status))
2091 if (aad_get_state(rdp->aad) == AAD_STATE_FINAL)
2093 transport_set_aad_mode(rdp->transport, FALSE);
2094 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
2095 status = STATE_RUN_FAILED;
2097 status = STATE_RUN_CONTINUE;
2102 case CONNECTION_STATE_MCS_CREATE_REQUEST:
2103 if (!mcs_client_begin(rdp->mcs))
2105 WLog_Print(rdp->log, WLOG_ERROR,
"%s - mcs_client_begin() fail",
2106 rdp_get_state_string(rdp));
2107 status = STATE_RUN_FAILED;
2109 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_RESPONSE))
2110 status = STATE_RUN_FAILED;
2111 else if (Stream_GetRemainingLength(s) > 0)
2112 status = STATE_RUN_CONTINUE;
2115 case CONNECTION_STATE_MCS_CREATE_RESPONSE:
2116 if (!mcs_recv_connect_response(rdp->mcs, s))
2118 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_connect_response failure");
2119 status = STATE_RUN_FAILED;
2123 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ERECT_DOMAIN))
2124 status = STATE_RUN_FAILED;
2125 else if (!mcs_send_erect_domain_request(rdp->mcs))
2127 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_erect_domain_request failure");
2128 status = STATE_RUN_FAILED;
2130 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ATTACH_USER))
2131 status = STATE_RUN_FAILED;
2132 else if (!mcs_send_attach_user_request(rdp->mcs))
2134 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_attach_user_request failure");
2135 status = STATE_RUN_FAILED;
2137 else if (!rdp_client_transition_to_state(rdp,
2138 CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM))
2139 status = STATE_RUN_FAILED;
2143 case CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM:
2144 if (!mcs_recv_attach_user_confirm(rdp->mcs, s))
2146 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_attach_user_confirm failure");
2147 status = STATE_RUN_FAILED;
2151 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST))
2152 status = STATE_RUN_FAILED;
2153 else if (!mcs_send_channel_join_request(rdp->mcs, rdp->mcs->userId))
2155 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_channel_join_request failure");
2156 status = STATE_RUN_FAILED;
2158 else if (!rdp_client_transition_to_state(
2159 rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE))
2160 status = STATE_RUN_FAILED;
2165 if (!rdp_client_skip_mcs_channel_join(rdp))
2166 status = STATE_RUN_FAILED;
2170 case CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE:
2171 if (!rdp_client_connect_mcs_channel_join_confirm(rdp, s))
2173 WLog_Print(rdp->log, WLOG_ERROR,
2175 "rdp_client_connect_mcs_channel_join_confirm() fail",
2176 rdp_get_state_string(rdp));
2177 status = STATE_RUN_FAILED;
2182 case CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST:
2183 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2185 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_LICENSING))
2186 status = STATE_RUN_FAILED;
2188 status = STATE_RUN_TRY_AGAIN;
2192 case CONNECTION_STATE_LICENSING:
2193 status = rdp_client_connect_license(rdp, s);
2195 if (state_run_failed(status))
2197 char buffer[64] = WINPR_C_ARRAY_INIT;
2198 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_client_connect_license() - %s",
2199 rdp_get_state_string(rdp),
2200 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2205 case CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST:
2206 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2208 if (!rdp_client_transition_to_state(
2209 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE))
2210 status = STATE_RUN_FAILED;
2212 status = STATE_RUN_TRY_AGAIN;
2216 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE:
2217 status = rdp_client_connect_demand_active(rdp, s);
2219 if (state_run_failed(status))
2221 char buffer[64] = WINPR_C_ARRAY_INIT;
2222 WLog_Print(rdp->log, WLOG_DEBUG,
2224 "rdp_client_connect_demand_active() - %s",
2225 rdp_get_state_string(rdp),
2226 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2228 else if (status == STATE_RUN_ACTIVE)
2230 if (!rdp_client_transition_to_state(
2231 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE))
2232 status = STATE_RUN_FAILED;
2234 status = STATE_RUN_CONTINUE;
2238 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT:
2239 status = rdp_client_exchange_monitor_layout(rdp, s);
2242 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE:
2243 status = rdp_client_connect_confirm_active(rdp, s);
2246 case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
2247 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_SYNCHRONIZE_PDU,
2248 CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE);
2250 case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
2251 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_COOPERATE_PDU,
2252 CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL);
2254 case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
2255 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_GRANTED_PDU,
2256 CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP);
2258 case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
2259 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_FONT_MAP_PDU, CONNECTION_STATE_ACTIVE);
2262 case CONNECTION_STATE_ACTIVE:
2263 status = rdp_recv_pdu(rdp, s);
2265 if (state_run_failed(status))
2267 char buffer[64] = WINPR_C_ARRAY_INIT;
2268 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_recv_pdu() - %s",
2269 rdp_get_state_string(rdp),
2270 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2275 WLog_Print(rdp->log, WLOG_ERROR,
"%s state %u", rdp_get_state_string(rdp),
2276 rdp_get_state(rdp));
2277 status = STATE_RUN_FAILED;
2281 if (state_run_failed(status))
2283 char buffer[64] = WINPR_C_ARRAY_INIT;
2284 WLog_Print(rdp->log, WLOG_ERROR,
"%s status %s", rdp_get_state_string(rdp),
2285 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2290state_run_t rdp_recv_callback(rdpTransport* transport,
wStream* s,
void* extra)
2292 char buffer[64] = WINPR_C_ARRAY_INIT;
2293 state_run_t rc = STATE_RUN_FAILED;
2294 const size_t start = Stream_GetPosition(s);
2295 const rdpContext* context = transport_get_context(transport);
2297 WINPR_ASSERT(context);
2300 const rdpRdp* rdp = context->rdp;
2303 if (rc == STATE_RUN_TRY_AGAIN)
2305 if (!Stream_SetPosition(s, start))
2306 return STATE_RUN_FAILED;
2309 const char* old = rdp_get_state_string(rdp);
2310 const size_t orem = Stream_GetRemainingLength(s);
2311 rc = rdp_recv_callback_int(transport, s, extra);
2313 const char* now = rdp_get_state_string(rdp);
2314 const size_t rem = Stream_GetRemainingLength(s);
2316 WLog_Print(rdp->log, WLOG_TRACE,
2317 "(client)[%s -> %s] current return %s [feeding %" PRIuz
" bytes, %" PRIuz
2318 " bytes not processed]",
2319 old, now, state_run_result_string(rc, buffer,
sizeof(buffer)), orem, rem);
2320 }
while ((rc == STATE_RUN_TRY_AGAIN) || (rc == STATE_RUN_CONTINUE));
2324BOOL rdp_send_channel_data(rdpRdp* rdp, UINT16 channelId,
const BYTE* data,
size_t size)
2326 return freerdp_channel_send(rdp, channelId, data, size);
2329BOOL rdp_channel_send_packet(rdpRdp* rdp, UINT16 channelId,
size_t totalSize, UINT32 flags,
2330 const BYTE* data,
size_t chunkSize)
2332 return freerdp_channel_send_packet(rdp, channelId, totalSize, flags, data, chunkSize);
2335BOOL rdp_send_error_info(rdpRdp* rdp)
2337 UINT16 sec_flags = 0;
2341 if (rdp->errorInfo == ERRINFO_SUCCESS)
2344 s = rdp_data_pdu_init(rdp, &sec_flags);
2349 Stream_Write_UINT32(s, rdp->errorInfo);
2350 status = rdp_send_data_pdu(rdp, s, DATA_PDU_TYPE_SET_ERROR_INFO, 0, sec_flags);
2354int rdp_check_fds(rdpRdp* rdp)
2357 rdpTsg* tsg =
nullptr;
2358 rdpTransport* transport =
nullptr;
2361 transport = rdp->transport;
2363 tsg = transport_get_tsg(transport);
2366 if (!tsg_check_event_handles(tsg))
2368 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_check_fds: tsg_check_event_handles()");
2372 if (tsg_get_state(tsg) != TSG_STATE_PIPE_CREATED)
2376 status = transport_check_fds(transport);
2380 if (!rdp_client_redirect(rdp))
2385 WLog_Print(rdp->log, WLOG_DEBUG,
"transport_check_fds() - %i", status);
2387 status = freerdp_timer_poll(rdp->timer);
2389 if ((status >= 0) && !multitransport_check(rdp->multitransport))
2395BOOL freerdp_get_stats(
const rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes, UINT64* inPackets,
2402 *inBytes = rdp->inBytes;
2404 *outBytes = rdp->outBytes;
2406 *inPackets = rdp->inPackets;
2408 *outPackets = rdp->outPackets;
2414static bool rdp_new_common(rdpRdp* rdp)
2419 rdp->transport = transport_new(rdp->context);
2420 if (!rdp->transport)
2425 if (!transport_set_io_callbacks(rdp->transport, rdp->io))
2429 rdp->aad = aad_new(rdp->context);
2433 rdp->nego = nego_new(rdp->transport);
2437 rdp->mcs = mcs_new(rdp->context);
2441 rdp->license = license_new(rdp);
2445 rdp->fastpath = fastpath_new(rdp);
2459rdpRdp* rdp_new(rdpContext* context)
2462 rdpRdp* rdp = (rdpRdp*)calloc(1,
sizeof(rdpRdp));
2467 rdp->log = WLog_Create(RDP_TAG, WLog_GetRoot());
2471 (void)_snprintf(rdp->log_context,
sizeof(rdp->log_context),
"%p", (
void*)context);
2472 if (!WLog_SetContext(rdp->log,
nullptr, rdp->log_context))
2475 InitializeCriticalSection(&rdp->critical);
2476 rdp->context = context;
2477 WINPR_ASSERT(rdp->context);
2479 if (context->ServerMode)
2482 if (!context->settings)
2490 rdp->settings = context->settings;
2493 if (!rdp_set_backup_settings(rdp))
2496 rdp->settings->instance = context->instance;
2498 context->settings = rdp->settings;
2499 if (context->instance)
2500 context->settings->instance = context->instance;
2501 else if (context->peer)
2503 rdp->settings->instance = context->peer;
2505#if defined(WITH_FREERDP_DEPRECATED)
2506 context->peer->settings = rdp->settings;
2510 if (!rdp_new_common(rdp))
2514 const rdpTransportIo* io = transport_get_io_callbacks(rdp->transport);
2517 rdp->io = calloc(1,
sizeof(rdpTransportIo));
2523 rdp->input = input_new(rdp);
2528 rdp->update = update_new(rdp);
2533 rdp->redirection = redirection_new();
2535 if (!rdp->redirection)
2538 rdp->autodetect = autodetect_new(rdp->context);
2540 if (!rdp->autodetect)
2543 rdp->heartbeat = heartbeat_new();
2545 if (!rdp->heartbeat)
2548 rdp->multitransport = multitransport_new(rdp, INITIATE_REQUEST_PROTOCOL_UDPFECL |
2549 INITIATE_REQUEST_PROTOCOL_UDPFECR);
2551 if (!rdp->multitransport)
2554 rdp->bulk = bulk_new(context);
2559 rdp->pubSub = PubSub_New(TRUE);
2563 rdp->abortEvent = CreateEvent(
nullptr, TRUE, FALSE,
nullptr);
2564 if (!rdp->abortEvent)
2567 rdp->timer = freerdp_timer_new(rdp);
2574 WINPR_PRAGMA_DIAG_PUSH
2575 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2577 WINPR_PRAGMA_DIAG_POP
2581static void rdp_reset_free(rdpRdp* rdp)
2586 rdp_free_rc4_decrypt_keys(rdp);
2587 rdp_free_rc4_encrypt_keys(rdp);
2589 winpr_Cipher_Free(rdp->fips_encrypt);
2590 winpr_Cipher_Free(rdp->fips_decrypt);
2591 rdp->fips_encrypt =
nullptr;
2592 rdp->fips_decrypt =
nullptr;
2593 security_unlock(rdp);
2597 nego_free(rdp->nego);
2598 license_free(rdp->license);
2599 transport_free(rdp->transport);
2600 fastpath_free(rdp->fastpath);
2604 rdp->nego =
nullptr;
2605 rdp->license =
nullptr;
2606 rdp->transport =
nullptr;
2607 rdp->fastpath =
nullptr;
2610BOOL rdp_reset(rdpRdp* rdp)
2616 rdpSettings* settings = rdp->settings;
2617 WINPR_ASSERT(settings);
2619 bulk_reset(rdp->bulk);
2620 multitransport_reset(rdp->multitransport);
2622 rdp_reset_free(rdp);
2636 rc = rdp_new_common(rdp);
2640 if (!transport_set_layer(rdp->transport, TRANSPORT_LAYER_TCP))
2644 rc = rdp_finalize_reset_flags(rdp, TRUE);
2655void rdp_free(rdpRdp* rdp)
2659 freerdp_timer_free(rdp->timer);
2660 rdp_reset_free(rdp);
2666 input_free(rdp->input);
2667 update_free(rdp->update);
2669 redirection_free(rdp->redirection);
2670 autodetect_free(rdp->autodetect);
2671 heartbeat_free(rdp->heartbeat);
2672 multitransport_free(rdp->multitransport);
2673 freerdp_bulk_free(rdp->bulk);
2675 PubSub_Free(rdp->pubSub);
2676 if (rdp->abortEvent)
2677 (void)CloseHandle(rdp->abortEvent);
2680 DeleteCriticalSection(&rdp->critical);
2681 WLog_Discard(rdp->log);
2686BOOL rdp_io_callback_set_event(rdpRdp* rdp, BOOL set)
2690 return transport_io_callback_set_event(rdp->transport, set);
2693const rdpTransportIo* rdp_get_io_callbacks(rdpRdp* rdp)
2700BOOL rdp_set_io_callbacks(rdpRdp* rdp,
const rdpTransportIo* io_callbacks)
2708 rdp->io = malloc(
sizeof(rdpTransportIo));
2711 *rdp->io = *io_callbacks;
2712 return transport_set_io_callbacks(rdp->transport, rdp->io);
2717BOOL rdp_set_io_callback_context(rdpRdp* rdp,
void* usercontext)
2720 rdp->ioContext = usercontext;
2724void* rdp_get_io_callback_context(rdpRdp* rdp)
2727 return rdp->ioContext;
2730const char* rdp_finalize_flags_to_str(UINT32 flags,
char* buffer,
size_t size)
2732 char number[32] = WINPR_C_ARRAY_INIT;
2734 (uint32_t)~(FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
2735 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU |
2736 FINALIZE_CS_SYNCHRONIZE_PDU | FINALIZE_CS_CONTROL_COOPERATE_PDU |
2737 FINALIZE_CS_CONTROL_REQUEST_PDU | FINALIZE_CS_PERSISTENT_KEY_LIST_PDU |
2738 FINALIZE_CS_FONT_LIST_PDU | FINALIZE_DEACTIVATE_REACTIVATE);
2740 if (flags & FINALIZE_SC_SYNCHRONIZE_PDU)
2741 winpr_str_append(
"FINALIZE_SC_SYNCHRONIZE_PDU", buffer, size,
"|");
2742 if (flags & FINALIZE_SC_CONTROL_COOPERATE_PDU)
2743 winpr_str_append(
"FINALIZE_SC_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2744 if (flags & FINALIZE_SC_CONTROL_GRANTED_PDU)
2745 winpr_str_append(
"FINALIZE_SC_CONTROL_GRANTED_PDU", buffer, size,
"|");
2746 if (flags & FINALIZE_SC_FONT_MAP_PDU)
2747 winpr_str_append(
"FINALIZE_SC_FONT_MAP_PDU", buffer, size,
"|");
2748 if (flags & FINALIZE_CS_SYNCHRONIZE_PDU)
2749 winpr_str_append(
"FINALIZE_CS_SYNCHRONIZE_PDU", buffer, size,
"|");
2750 if (flags & FINALIZE_CS_CONTROL_COOPERATE_PDU)
2751 winpr_str_append(
"FINALIZE_CS_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2752 if (flags & FINALIZE_CS_CONTROL_REQUEST_PDU)
2753 winpr_str_append(
"FINALIZE_CS_CONTROL_REQUEST_PDU", buffer, size,
"|");
2754 if (flags & FINALIZE_CS_PERSISTENT_KEY_LIST_PDU)
2755 winpr_str_append(
"FINALIZE_CS_PERSISTENT_KEY_LIST_PDU", buffer, size,
"|");
2756 if (flags & FINALIZE_CS_FONT_LIST_PDU)
2757 winpr_str_append(
"FINALIZE_CS_FONT_LIST_PDU", buffer, size,
"|");
2758 if (flags & FINALIZE_DEACTIVATE_REACTIVATE)
2759 winpr_str_append(
"FINALIZE_DEACTIVATE_REACTIVATE", buffer, size,
"|");
2761 winpr_str_append(
"UNKNOWN_FLAG", buffer, size,
"|");
2763 winpr_str_append(
"NO_FLAG_SET", buffer, size,
"|");
2764 (void)_snprintf(number,
sizeof(number),
" [0x%08" PRIx32
"]", flags);
2765 winpr_str_append(number, buffer, size,
"");
2769BOOL rdp_finalize_reset_flags(rdpRdp* rdp, BOOL clearAll)
2772 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] reset finalize_sc_pdus", rdp_get_state_string(rdp));
2774 rdp->finalize_sc_pdus = 0;
2776 rdp->finalize_sc_pdus &= FINALIZE_DEACTIVATE_REACTIVATE;
2778 return rdp_set_monitor_layout_pdu_state(rdp, FALSE);
2781BOOL rdp_finalize_set_flag(rdpRdp* rdp, UINT32 flag)
2783 char buffer[1024] = WINPR_C_ARRAY_INIT;
2787 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] received flag %s", rdp_get_state_string(rdp),
2788 rdp_finalize_flags_to_str(flag, buffer,
sizeof(buffer)));
2789 rdp->finalize_sc_pdus |= flag;
2793BOOL rdp_finalize_is_flag_set(rdpRdp* rdp, UINT32 flag)
2796 return (rdp->finalize_sc_pdus & flag) == flag;
2799BOOL rdp_reset_rc4_encrypt_keys(rdpRdp* rdp)
2802 rdp_free_rc4_encrypt_keys(rdp);
2803 rdp->rc4_encrypt_key = winpr_RC4_New(rdp->encrypt_key, rdp->rc4_key_len);
2805 rdp->encrypt_use_count = 0;
2806 return rdp->rc4_encrypt_key !=
nullptr;
2809void rdp_free_rc4_encrypt_keys(rdpRdp* rdp)
2812 winpr_RC4_Free(rdp->rc4_encrypt_key);
2813 rdp->rc4_encrypt_key =
nullptr;
2816void rdp_free_rc4_decrypt_keys(rdpRdp* rdp)
2819 winpr_RC4_Free(rdp->rc4_decrypt_key);
2820 rdp->rc4_decrypt_key =
nullptr;
2823BOOL rdp_reset_rc4_decrypt_keys(rdpRdp* rdp)
2826 rdp_free_rc4_decrypt_keys(rdp);
2827 rdp->rc4_decrypt_key = winpr_RC4_New(rdp->decrypt_key, rdp->rc4_key_len);
2829 rdp->decrypt_use_count = 0;
2830 return rdp->rc4_decrypt_key !=
nullptr;
2833const char* rdp_security_flag_string(UINT32 securityFlags,
char* buffer,
size_t size)
2835 if (securityFlags & SEC_EXCHANGE_PKT)
2836 winpr_str_append(
"SEC_EXCHANGE_PKT", buffer, size,
"|");
2837 if (securityFlags & SEC_TRANSPORT_REQ)
2838 winpr_str_append(
"SEC_TRANSPORT_REQ", buffer, size,
"|");
2839 if (securityFlags & SEC_TRANSPORT_RSP)
2840 winpr_str_append(
"SEC_TRANSPORT_RSP", buffer, size,
"|");
2841 if (securityFlags & SEC_ENCRYPT)
2842 winpr_str_append(
"SEC_ENCRYPT", buffer, size,
"|");
2843 if (securityFlags & SEC_RESET_SEQNO)
2844 winpr_str_append(
"SEC_RESET_SEQNO", buffer, size,
"|");
2845 if (securityFlags & SEC_IGNORE_SEQNO)
2846 winpr_str_append(
"SEC_IGNORE_SEQNO", buffer, size,
"|");
2847 if (securityFlags & SEC_INFO_PKT)
2848 winpr_str_append(
"SEC_INFO_PKT", buffer, size,
"|");
2849 if (securityFlags & SEC_LICENSE_PKT)
2850 winpr_str_append(
"SEC_LICENSE_PKT", buffer, size,
"|");
2851 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
2852 winpr_str_append(
"SEC_LICENSE_ENCRYPT_CS", buffer, size,
"|");
2853 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
2854 winpr_str_append(
"SEC_LICENSE_ENCRYPT_SC", buffer, size,
"|");
2855 if (securityFlags & SEC_REDIRECTION_PKT)
2856 winpr_str_append(
"SEC_REDIRECTION_PKT", buffer, size,
"|");
2857 if (securityFlags & SEC_SECURE_CHECKSUM)
2858 winpr_str_append(
"SEC_SECURE_CHECKSUM", buffer, size,
"|");
2859 if (securityFlags & SEC_AUTODETECT_REQ)
2860 winpr_str_append(
"SEC_AUTODETECT_REQ", buffer, size,
"|");
2861 if (securityFlags & SEC_AUTODETECT_RSP)
2862 winpr_str_append(
"SEC_AUTODETECT_RSP", buffer, size,
"|");
2863 if (securityFlags & SEC_HEARTBEAT)
2864 winpr_str_append(
"SEC_HEARTBEAT", buffer, size,
"|");
2865 if (securityFlags & SEC_FLAGSHI_VALID)
2866 winpr_str_append(
"SEC_FLAGSHI_VALID", buffer, size,
"|");
2868 char msg[32] = WINPR_C_ARRAY_INIT;
2870 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", securityFlags);
2871 winpr_str_append(msg, buffer, size,
"");
2877static BOOL rdp_reset_remote_settings(rdpRdp* rdp)
2879 UINT32 flags = FREERDP_SETTINGS_REMOTE_MODE;
2886 return rdp->remoteSettings !=
nullptr;
2889BOOL rdp_set_backup_settings(rdpRdp* rdp)
2894 if (!rdp->originalSettings)
2896 return rdp_reset_remote_settings(rdp);
2899BOOL rdp_reset_runtime_settings(rdpRdp* rdp)
2902 WINPR_ASSERT(rdp->context);
2909 return rdp_reset_remote_settings(rdp);
2913static BOOL starts_with(
const char* tok,
const char* val)
2915 const size_t len = strlen(val);
2916 if (strncmp(tok, val, len) != 0)
2918 if (tok[len] !=
'=')
2924static BOOL option_equals(
const char* what,
const char* val)
2926 return _stricmp(what, val) == 0;
2930static BOOL parse_on_off_option(
const char* value)
2932 WINPR_ASSERT(value);
2933 const char* sep = strchr(value,
'=');
2936 if (option_equals(
"on", &sep[1]))
2938 if (option_equals(
"true", &sep[1]))
2940 if (option_equals(
"off", &sep[1]))
2942 if (option_equals(
"false", &sep[1]))
2946 long val = strtol(value,
nullptr, 0);
2956static BOOL option_is_runtime_checks(WINPR_ATTR_UNUSED wLog* log, WINPR_ATTR_UNUSED DWORD level,
2959 const char* experimental[] = { STR(WITH_VERBOSE_WINPR_ASSERT) };
2960 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2962 const char* opt = experimental[x];
2963 if (starts_with(tok, opt))
2965 return parse_on_off_option(tok);
2972static BOOL option_is_experimental(WINPR_ATTR_UNUSED wLog* log, WINPR_ATTR_UNUSED DWORD level,
2975 const char* experimental[] = { STR(WITH_DSP_EXPERIMENTAL), STR(WITH_FFMPEG_HWACCEL),
2976 STR(WITH_GFX_AV1), STR(WITH_GFX_AV2),
2977 STR(WITH_GFX_AZURE), STR(WITH_MEDIACODEC),
2978 STR(WITH_CLIENT_SDL2), STR(WITH_OPENCL),
2979 STR(WITH_LIBRESSL), STR(WITH_MBEDTLS),
2980 STR(WITH_MEDIA_FOUNDATION), STR(WITH_KRB5_HEIMDAL),
2981 STR(WITH_RDPEUDP) };
2982 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2984 const char* opt = experimental[x];
2985 if (starts_with(tok, opt))
2987 return parse_on_off_option(tok);
2994static BOOL option_is_debug(wLog* log, WINPR_ATTR_UNUSED DWORD level,
const char* tok)
2997 const char* debug[] = { STR(WITH_DEBUG_ALL),
2998 STR(WITH_DEBUG_CERTIFICATE),
2999 STR(WITH_DEBUG_CAPABILITIES),
3000 STR(WITH_DEBUG_CHANNELS),
3001 STR(WITH_DEBUG_CLIPRDR),
3002 STR(WITH_DEBUG_CODECS),
3003 STR(WITH_DEBUG_DVC),
3004 STR(WITH_DEBUG_TSMF),
3005 STR(WITH_DEBUG_KBD),
3006 STR(WITH_DEBUG_LICENSE),
3007 STR(WITH_DEBUG_NEGO),
3008 STR(WITH_DEBUG_NLA),
3009 STR(WITH_DEBUG_TSG),
3010 STR(WITH_DEBUG_RAIL),
3011 STR(WITH_DEBUG_RDP),
3012 STR(WITH_DEBUG_RDPEI),
3013 STR(WITH_DEBUG_REDIR),
3014 STR(WITH_DEBUG_RDPDR),
3015 STR(WITH_DEBUG_RFX),
3016 STR(WITH_DEBUG_SCARD),
3017 STR(WITH_DEBUG_SND),
3018 STR(WITH_DEBUG_SVC),
3019 STR(WITH_DEBUG_TRANSPORT),
3020 STR(WITH_DEBUG_TIMEZONE),
3021 STR(WITH_DEBUG_WND),
3022 STR(WITH_DEBUG_RINGBUFFER),
3023 STR(WITH_DEBUG_SYMBOLS),
3024 STR(WITH_DEBUG_EVENTS),
3025 STR(WITH_DEBUG_MUTEX),
3026 STR(WITH_DEBUG_NTLM),
3027 STR(WITH_DEBUG_SDL_KBD_EVENTS),
3028 STR(WITH_DEBUG_SDL_KBD_EVENTS),
3029 STR(WITH_DEBUG_THREADS),
3030 STR(WITH_DEBUG_URBDRC) };
3032 for (
size_t x = 0; x < ARRAYSIZE(debug); x++)
3034 const char* opt = debug[x];
3035 if (starts_with(tok, opt))
3036 return parse_on_off_option(tok);
3039 if (starts_with(tok,
"WITH_DEBUG"))
3041 WLog_Print(log, level,
"[BUG] Unmapped Debug-Build option '%s'.", tok);
3042 return parse_on_off_option(tok);
3048static void log_build_warn(wLog* log, DWORD level,
const char* what,
const char* msg,
3049 BOOL (*cmp)(wLog* log, DWORD level,
const char* tok))
3051 WINPR_PRAGMA_DIAG_PUSH
3052 WINPR_PRAGMA_DIAG_IGNORED_OVERLENGTH_STRINGS
3054 size_t len =
sizeof(FREERDP_BUILD_CONFIG);
3055 char* list = calloc(len,
sizeof(
char));
3056 char* config = _strdup(FREERDP_BUILD_CONFIG);
3057 WINPR_PRAGMA_DIAG_POP
3061 char* saveptr =
nullptr;
3062 char* tok = strtok_s(config,
" ", &saveptr);
3065 if (cmp(log, level, tok))
3066 winpr_str_append(tok, list, len,
" ");
3068 tok = strtok_s(
nullptr,
" ", &saveptr);
3075 if (strlen(list) > 0)
3077 WLog_Print(log, level,
"*************************************************");
3078 WLog_Print(log, level,
"This build is using [%s] build options:", what);
3080 char* saveptr =
nullptr;
3081 char* tok = strtok_s(list,
" ", &saveptr);
3084 WLog_Print(log, level,
"* '%s'", tok);
3085 tok = strtok_s(
nullptr,
" ", &saveptr);
3087 WLog_Print(log, level,
"*");
3088 WLog_Print(log, level,
"[%s] build options %s", what, msg);
3089 WLog_Print(log, level,
"*************************************************");
3095#define print_first_line(log, level, firstLine, what) \
3096 print_first_line_int((log), (level), (firstLine), (what), __FILE__, __func__, __LINE__)
3097static void print_first_line_int(wLog* log, DWORD level, log_line_t* firstLine,
const char* what,
3098 const char* file,
const char* fkt,
size_t line)
3100 WINPR_ASSERT(firstLine);
3101 if (!firstLine->fkt)
3103 if (WLog_IsLevelActive(log, level))
3105 WLog_PrintTextMessage(log, level, line, file, fkt,
3106 "*************************************************");
3107 WLog_PrintTextMessage(log, level, line, file, fkt,
3108 "[SSL] {%s} build or configuration missing:", what);
3110 firstLine->line = line;
3111 firstLine->file = file;
3112 firstLine->fkt = fkt;
3113 firstLine->level = level;
3117static void print_last_line(wLog* log,
const log_line_t* firstLine)
3119 WINPR_ASSERT(firstLine);
3122 if (WLog_IsLevelActive(log, firstLine->level))
3123 WLog_PrintTextMessage(log, firstLine->level, firstLine->line, firstLine->file,
3125 "*************************************************");
3129static void log_build_warn_cipher(wLog* log, DWORD level, log_line_t* firstLine,
3130 WINPR_CIPHER_TYPE md,
const char* what, BOOL allowFIPS)
3132 BOOL haveCipher = FALSE;
3134 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3135 char iv[WINPR_CIPHER_MAX_IV_LENGTH] = WINPR_C_ARRAY_INIT;
3139 if (md == WINPR_CIPHER_ARC4_128)
3141 WINPR_RC4_CTX* enc =
nullptr;
3143 enc = winpr_RC4_New_Allow_FIPS(key,
sizeof(key));
3145 enc = winpr_RC4_New(key,
sizeof(key));
3146 haveCipher = enc !=
nullptr;
3147 winpr_RC4_Free(enc);
3151 WINPR_CIPHER_CTX* enc =
3152 winpr_Cipher_NewEx(md, WINPR_ENCRYPT, key,
sizeof(key), iv,
sizeof(iv));
3153 WINPR_CIPHER_CTX* dec =
3154 winpr_Cipher_NewEx(md, WINPR_DECRYPT, key,
sizeof(key), iv,
sizeof(iv));
3158 winpr_Cipher_Free(enc);
3159 winpr_Cipher_Free(dec);
3164 print_first_line(log, level, firstLine,
"Cipher");
3165 WLog_Print(log, level,
"* %s: %s", winpr_cipher_type_to_string(md), what);
3169static void log_build_warn_hmac(wLog* log, DWORD level, log_line_t* firstLine, WINPR_MD_TYPE md,
3172 BOOL haveHmacX = FALSE;
3173 WINPR_HMAC_CTX* hmac = winpr_HMAC_New();
3179 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3180 haveHmacX = winpr_HMAC_Init(hmac, md, key,
sizeof(key));
3182 winpr_HMAC_Free(hmac);
3186 print_first_line(log, level, firstLine,
"HMAC");
3187 WLog_Print(log, level,
" * %s: %s", winpr_md_type_to_string(md), what);
3191static void log_build_warn_hash(wLog* log, DWORD level, log_line_t* firstLine, WINPR_MD_TYPE md,
3192 const char* what, BOOL allowFIPS)
3194 BOOL haveDigestX = FALSE;
3195 WINPR_DIGEST_CTX* digest = winpr_Digest_New();
3199 haveDigestX = winpr_Digest_Init_Allow_FIPS(digest, md);
3201 haveDigestX = winpr_Digest_Init(digest, md);
3203 winpr_Digest_Free(digest);
3207 print_first_line(log, level, firstLine,
"Digest");
3208 WLog_Print(log, level,
" * %s: %s", winpr_md_type_to_string(md), what);
3212static void log_build_warn_ssl(wLog* log, DWORD level)
3214 const BOOL fips = winpr_FIPSMode();
3218 WLog_Print(log, WLOG_INFO,
3219 "FIPS mode active: non-approved algorithms are unavailable "
3220 "as expected. NTLM, autoreconnect cookies, assistance files "
3221 "with encrypted passwords and RDP security will not work.");
3224 log_line_t firstHashLine = WINPR_C_ARRAY_INIT;
3227 log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_MD4,
"NTLM support not available",
3229 log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_MD5,
3230 "NTLM, assistance files with encrypted passwords "
3231 " and autoreconnect cookies will not work",
3234 log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_MD5,
3235 "RDP licensing and RDP security will not work", TRUE);
3236 log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_SHA1,
3237 "assistance files with encrypted passwords, Kerberos, Smartcard Logon, RDP "
3238 "security support not available",
3240 log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_SHA256,
3241 "file clipboard, AAD gateway, NLA security and certificates might not work",
3243 print_last_line(log, &firstHashLine);
3247 log_line_t firstHmacLine = WINPR_C_ARRAY_INIT;
3248 log_build_warn_hmac(log, level, &firstHmacLine, WINPR_MD_MD5,
3249 "Autoreconnect cookie not supported");
3250 log_build_warn_hmac(log, level, &firstHmacLine, WINPR_MD_SHA1,
3251 "RDP security not supported");
3252 print_last_line(log, &firstHmacLine);
3255 log_line_t firstCipherLine = WINPR_C_ARRAY_INIT;
3258 log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_ARC4_128,
3259 "assistance files with encrypted passwords, NTLM "
3260 "and autoreconnect cookies will not work",
3263 log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_ARC4_128,
3264 "RDP licensing and RDP security will not work", TRUE);
3266 log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_DES_EDE3_CBC,
3267 "RDP security will not work", TRUE);
3268 log_build_warn_cipher(
3269 log, level, &firstCipherLine, WINPR_CIPHER_AES_128_CBC,
3270 "assistance file encrypted LHTicket will not work and ARM gateway might not", FALSE);
3271 log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_AES_192_CBC,
3272 "ARM gateway might not work", FALSE);
3273 log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_AES_256_CBC,
3274 "ARM gateway might not work", FALSE);
3275 print_last_line(log, &firstCipherLine);
3278static void rdp_log_build_warnings_wlog(wLog* log, DWORD level)
3280 static unsigned count = 0;
3288 log_build_warn(log, level,
"experimental",
"might crash the application",
3289 option_is_experimental);
3290 log_build_warn(log, level,
"debug",
"might leak sensitive information (credentials, ...)",
3292 log_build_warn(log, level,
"runtime-check",
"might slow down the application",
3293 option_is_runtime_checks);
3294 log_build_warn_ssl(log, level);
3295 winpr_log_build_warn(log, level);
3298void rdp_log_build_warnings(rdpRdp* rdp)
3301 rdp_log_build_warnings_wlog(rdp->log, WLOG_WARN);
3304size_t rdp_get_event_handles(rdpRdp* rdp, HANDLE* handles, uint32_t count)
3306 size_t nCount = transport_get_event_handles(rdp->transport, handles, count);
3312 if ((nCount > count) || (count - nCount < 3))
3315 handles[nCount++] = utils_get_abort_event(rdp);
3316 handles[nCount++] = freerdp_timer_get_event(rdp->timer);
3317 handles[nCount++] = multitransport_get_event_handle(rdp->multitransport);
WINPR_API void WINPR_JSON_Delete(WINPR_JSON *item)
Delete a WinPR JSON wrapper object.
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.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_pointer_len(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id, const void *data, size_t len)
Set a pointer to value data.
FREERDP_API void freerdp_settings_free(rdpSettings *settings)
Free a settings struct with all data in it.
#define FREERDP_SETTINGS_SERVER_MODE
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val)
Sets a string settings value. The param is copied.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.