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;
572 if (!tpkt_read_header(s, length))
575 if (!tpdu_read_header(s, &code, &li, *length))
578 if (code != X224_TPDU_DATA)
580 if (code == X224_TPDU_DISCONNECT_REQUEST)
582 WLog_Print(rdp->log, WLOG_WARN,
"Received X224_TPDU_DISCONNECT_REQUEST, terminating");
583 utils_abort_connect(rdp);
587 WLog_Print(rdp->log, WLOG_WARN,
588 "Unexpected X224 TPDU type %s [%08" PRIx32
"] instead of %s",
589 tpdu_type_to_string(code), code, tpdu_type_to_string(X224_TPDU_DATA));
593 if (!per_read_choice(s, &choice))
596 const DomainMCSPDU domainMCSPDU = (DomainMCSPDU)(choice >> 2);
598 if (domainMCSPDU != MCSPDU)
600 if (domainMCSPDU != DomainMCSPDU_DisconnectProviderUltimatum)
602 WLog_Print(rdp->log, WLOG_WARN,
"Received %s instead of %s",
603 mcs_domain_pdu_string(domainMCSPDU), mcs_domain_pdu_string(MCSPDU));
608 MCSPDU = domainMCSPDU;
612 WLog_Print(rdp->log, WLOG_WARN,
"TPDU invalid length, got %" PRIu16
", expected at least 8",
617 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length - 8))
620 if (MCSPDU == DomainMCSPDU_DisconnectProviderUltimatum)
623 TerminateEventArgs e = WINPR_C_ARRAY_INIT;
625 if (!mcs_recv_disconnect_provider_ultimatum(rdp->mcs, s, &reason))
628 rdpContext* context = rdp->context;
629 WINPR_ASSERT(context);
630 context->disconnectUltimatum = reason;
632 if (rdp->errorInfo == ERRINFO_SUCCESS)
639 UINT32 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
640 if (reason == Disconnect_Ultimatum_provider_initiated)
641 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
642 else if (reason == Disconnect_Ultimatum_user_requested)
643 errorInfo = ERRINFO_LOGOFF_BY_USER;
645 if (!rdp_set_error_info(rdp, errorInfo))
649 WLog_Print(rdp->log, WLOG_DEBUG,
"DisconnectProviderUltimatum: reason: %d", reason);
650 utils_abort_connect(rdp);
651 EventArgsInit(&e,
"freerdp");
653 return PubSub_OnTerminate(rdp->pubSub, context, &e) >= 0;
656 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 5))
659 if (!per_read_integer16(s, &initiator, MCS_BASE_CHANNEL_ID))
662 if (!per_read_integer16(s, channelId, 0))
665 const uint8_t dataPriority = Stream_Get_UINT8(s);
666 WLog_Print(rdp->log, WLOG_TRACE,
"dataPriority=%" PRIu8, dataPriority);
668 if (!per_read_length(s, length))
671 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length))
687BOOL rdp_write_header(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 channelId, UINT16 sec_flags)
690 WINPR_ASSERT(rdp->settings);
692 WINPR_ASSERT(length >= RDP_PACKET_HEADER_MAX_LENGTH);
693 if (length > UINT16_MAX)
696 DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataIndication
697 : DomainMCSPDU_SendDataRequest;
699 if ((sec_flags & SEC_ENCRYPT) && (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS))
701 const UINT16 body_length = (UINT16)length - RDP_PACKET_HEADER_MAX_LENGTH;
702 const UINT16 pad = 8 - (body_length % 8);
708 if (!mcs_write_domain_mcspdu_header(s, MCSPDU, (UINT16)length, 0))
710 if (!per_write_integer16(s, rdp->mcs->userId, MCS_BASE_CHANNEL_ID))
712 if (!per_write_integer16(s, channelId, 0))
714 if (!Stream_EnsureRemainingCapacity(s, 3))
716 Stream_Write_UINT8(s, 0x70);
723 length = (length - RDP_PACKET_HEADER_MAX_LENGTH) | 0x8000;
724 Stream_Write_UINT16_BE(
725 s, WINPR_ASSERTING_INT_CAST(uint16_t, length));
730static BOOL rdp_security_stream_out(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 sec_flags,
735 if (length > UINT16_MAX)
742 WINPR_ASSERT(sec_flags <= UINT16_MAX);
743 if (!rdp_write_security_header(rdp, s, sec_flags))
746 if (sec_flags & SEC_ENCRYPT)
748 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
750 BYTE* data = Stream_PointerAs(s, BYTE) + 12;
751 const size_t size = WINPR_ASSERTING_INT_CAST(
size_t, (data - Stream_Buffer(s)));
757 Stream_Write_UINT16(s, 0x10);
758 Stream_Write_UINT8(s, 0x1);
760 *pad = 8 - (length % 8);
766 memset(data + length, 0, *pad);
768 Stream_Write_UINT8(s, WINPR_ASSERTING_INT_CAST(uint8_t, *pad));
770 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
772 if (!security_hmac_signature(data, length, Stream_Pointer(s), 8, rdp))
776 if (!security_fips_encrypt(data, length + *pad, rdp))
781 const BYTE* data = Stream_PointerAs(s,
const BYTE) + 8;
782 const size_t diff = Stream_GetPosition(s) + 8ULL;
787 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
789 if (sec_flags & SEC_SECURE_CHECKSUM)
790 status = security_salted_mac_signature(rdp, data, (UINT32)length, TRUE,
791 Stream_Pointer(s), 8);
793 status = security_mac_signature(rdp, data, (UINT32)length,
794 Stream_PointerAs(s, BYTE), 8);
801 if (!security_encrypt(Stream_Pointer(s), length, rdp))
811static UINT32 rdp_get_sec_bytes(rdpRdp* rdp, UINT16 sec_flags)
813 UINT32 sec_bytes = 0;
815 if (sec_flags & SEC_ENCRYPT)
819 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
822 else if (sec_flags != 0)
834BOOL rdp_send(rdpRdp* rdp,
wStream* s, UINT16 channelId, UINT16 sec_flags)
838 BOOL should_unlock = FALSE;
846 if (sec_flags & SEC_ENCRYPT)
849 should_unlock = TRUE;
853 size_t length = Stream_GetPosition(s);
854 Stream_ResetPosition(s);
855 if (!rdp_write_header(rdp, s, length, channelId, sec_flags))
858 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
862 if (!Stream_SetPosition(s, length))
864 Stream_SealLength(s);
867 if (transport_write(rdp->transport, s) < 0)
873 security_unlock(rdp);
878BOOL rdp_send_pdu(rdpRdp* rdp,
wStream* s, UINT16 type, UINT16 channel_id, UINT16 sec_flags)
881 UINT32 sec_bytes = 0;
884 BOOL should_unlock = FALSE;
892 if (sec_flags & SEC_ENCRYPT)
895 should_unlock = TRUE;
899 size_t length = Stream_GetPosition(s);
900 Stream_ResetPosition(s);
901 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
903 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
904 sec_hold = Stream_GetPosition(s);
905 Stream_Seek(s, sec_bytes);
906 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, type, channel_id))
908 if (!Stream_SetPosition(s, sec_hold))
911 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
915 if (!Stream_SetPosition(s, length))
917 Stream_SealLength(s);
920 if (transport_write(rdp->transport, s) < 0)
926 security_unlock(rdp);
930BOOL rdp_send_data_pdu(rdpRdp* rdp,
wStream* s, BYTE type, UINT16 channel_id, UINT16 sec_flags)
933 UINT32 sec_bytes = 0;
936 BOOL should_unlock = FALSE;
944 if (sec_flags & SEC_ENCRYPT)
947 should_unlock = TRUE;
951 size_t length = Stream_GetPosition(s);
952 Stream_ResetPosition(s);
953 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
955 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
956 sec_hold = Stream_GetPosition(s);
957 Stream_Seek(s, sec_bytes);
958 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, PDU_TYPE_DATA, channel_id))
960 if (!rdp_write_share_data_header(rdp, s, length - sec_bytes, type, rdp->settings->ShareId))
962 if (!Stream_SetPosition(s, sec_hold))
965 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
969 if (!Stream_SetPosition(s, length))
971 Stream_SealLength(s);
973 WLog_Print(rdp->log, WLOG_DEBUG,
974 "sending data (type=0x%x size=%" PRIuz
" channelId=%" PRIu16
")", type,
975 Stream_Length(s), channel_id);
978 if (transport_write(rdp->transport, s) < 0)
984 security_unlock(rdp);
989BOOL rdp_send_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 sec_flags)
993 BOOL should_unlock = FALSE;
998 if (sec_flags & SEC_ENCRYPT)
1001 should_unlock = TRUE;
1005 size_t length = Stream_GetPosition(s);
1006 Stream_ResetPosition(s);
1007 if (!rdp_write_header(rdp, s, length, rdp->mcs->messageChannelId, sec_flags))
1010 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
1014 if (!Stream_SetPosition(s, length))
1017 Stream_SealLength(s);
1019 if (transport_write(rdp->transport, s) < 0)
1025 security_unlock(rdp);
1032static BOOL rdp_recv_server_shutdown_denied_pdu(WINPR_ATTR_UNUSED rdpRdp* rdp,
1039static BOOL rdp_recv_server_set_keyboard_indicators_pdu(rdpRdp* rdp,
wStream* s)
1044 rdpContext* context = rdp->context;
1045 WINPR_ASSERT(context);
1046 WINPR_ASSERT(context->update);
1048 if (!rdp_has_reached_state(rdp, CONNECTION_STATE_ACTIVE))
1051 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1054 const uint16_t unitId = Stream_Get_UINT16(s);
1057 WLog_Print(rdp->log, WLOG_WARN,
1058 "[MS-RDPBCGR] 2.2.8.2.1.1 Set Keyboard Indicators PDU Data "
1059 "(TS_SET_KEYBOARD_INDICATORS_PDU)::unitId should be 0, is %" PRIu16,
1062 const UINT16 ledFlags = Stream_Get_UINT16(s);
1063 return IFCALLRESULT(TRUE, context->update->SetKeyboardIndicators, context, ledFlags);
1067static BOOL rdp_recv_server_set_keyboard_ime_status_pdu(rdpRdp* rdp,
wStream* s)
1069 if (!rdp || !rdp->input)
1072 if (!rdp_has_reached_state(rdp, CONNECTION_STATE_ACTIVE))
1075 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 10))
1078 const uint16_t unitId = Stream_Get_UINT16(s);
1081 WLog_Print(rdp->log, WLOG_WARN,
1082 "[MS-RDPBCGR] 2.2.8.2.2.1 Set Keyboard IME Status PDU Data "
1083 "(TS_SET_KEYBOARD_IME_STATUS_PDU)::unitId should be 0, is %" PRIu16,
1086 const uint32_t imeState = Stream_Get_UINT32(s);
1087 const uint32_t imeConvMode = Stream_Get_UINT32(s);
1088 return IFCALLRESULT(TRUE, rdp->update->SetKeyboardImeStatus, rdp->context, unitId, imeState,
1093static BOOL rdp_recv_set_error_info_data_pdu(rdpRdp* rdp,
wStream* s)
1095 UINT32 errorInfo = 0;
1097 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1100 Stream_Read_UINT32(s, errorInfo);
1101 return rdp_set_error_info(rdp, errorInfo);
1105static BOOL rdp_recv_server_auto_reconnect_status_pdu(rdpRdp* rdp,
wStream* s)
1107 UINT32 arcStatus = 0;
1109 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1112 Stream_Read_UINT32(s, arcStatus);
1113 WLog_Print(rdp->log, WLOG_WARN,
"AutoReconnectStatus: 0x%08" PRIX32
"", arcStatus);
1118static BOOL rdp_recv_server_status_info_pdu(rdpRdp* rdp,
wStream* s)
1120 UINT32 statusCode = 0;
1122 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1125 Stream_Read_UINT32(s, statusCode);
1127 if (rdp->update->ServerStatusInfo)
1128 return rdp->update->ServerStatusInfo(rdp->context, statusCode);
1133static void log_monitor(
size_t idx,
const MONITOR_DEF* monitor, wLog* log, DWORD level)
1135 WINPR_ASSERT(monitor);
1137 WLog_Print(log, level,
"[%" PRIuz
"] {%dx%d-%dx%d} [0x%08" PRIx32
"]", idx, monitor->left,
1138 monitor->top, monitor->right, monitor->bottom, monitor->flags);
1141static void log_monitor_configuration(wLog* log,
const MONITOR_DEF* monitors,
size_t count)
1143 const DWORD level = WLOG_DEBUG;
1144 WLog_Print(log, level,
"[BEGIN] RemoteMonitors[%" PRIuz
"]", count);
1145 for (
size_t x = 0; x < count; x++)
1148 log_monitor(x, monitor, log, level);
1150 WLog_Print(log, level,
"[END] RemoteMonitors[%" PRIuz
"]", count);
1154static BOOL rdp_recv_monitor_layout_pdu(rdpRdp* rdp,
wStream* s)
1160 if (!rdp_has_reached_state(rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT))
1163 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1166 const UINT32 monitorCount = Stream_Get_UINT32(s);
1168 if (!Stream_CheckAndLogRequiredLengthOfSizeWLog(rdp->log, s, monitorCount, 20ull))
1173 if (!monitorDefArray)
1176 for (UINT32 index = 0; index < monitorCount; index++)
1179 Stream_Read_INT32(s, monitor->left);
1180 Stream_Read_INT32(s, monitor->top);
1181 Stream_Read_INT32(s, monitor->right);
1182 Stream_Read_INT32(s, monitor->bottom);
1183 Stream_Read_UINT32(s, monitor->flags);
1186 log_monitor_configuration(rdp->log, monitorDefArray, monitorCount);
1187 IFCALLRET(rdp->update->RemoteMonitors, ret, rdp->context, monitorCount, monitorDefArray);
1188 free(monitorDefArray);
1191 return rdp_set_monitor_layout_pdu_state(rdp, TRUE);
1194state_run_t rdp_recv_data_pdu(rdpRdp* rdp,
wStream* s)
1200 BYTE compressedType = 0;
1201 UINT16 compressedLength = 0;
1204 if (!rdp_read_share_data_header(rdp, s, &length, &type, &shareId, &compressedType,
1207 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_read_share_data_header() failed");
1208 return STATE_RUN_FAILED;
1213 if (compressedType & PACKET_COMPRESSED)
1215 if (compressedLength < 18)
1217 WLog_Print(rdp->log, WLOG_ERROR,
1218 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1220 return STATE_RUN_FAILED;
1224 const BYTE* pDstData =
nullptr;
1225 UINT16 SrcSize = compressedLength - 18;
1227 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, SrcSize))
1229 WLog_Print(rdp->log, WLOG_ERROR,
1230 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1232 return STATE_RUN_FAILED;
1235 if (bulk_decompress(rdp->bulk, Stream_ConstPointer(s), SrcSize, &pDstData, &DstSize,
1238 cs = transport_take_from_pool(rdp->transport, DstSize);
1241 WLog_Print(rdp->log, WLOG_ERROR,
"Couldn't take stream from pool");
1242 return STATE_RUN_FAILED;
1245 Stream_ResetPosition(cs);
1246 Stream_Write(cs, pDstData, DstSize);
1247 Stream_SealLength(cs);
1248 Stream_ResetPosition(cs);
1252 WLog_Print(rdp->log, WLOG_ERROR,
"bulk_decompress() failed");
1253 return STATE_RUN_FAILED;
1256 Stream_Seek(s, SrcSize);
1259 WLog_Print(rdp->log, WLOG_DEBUG,
"recv %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1260 data_pdu_type_to_string(type), type, length);
1264 case DATA_PDU_TYPE_UPDATE:
1265 if (!update_recv(rdp->update, cs))
1267 WLog_Print(rdp->log, WLOG_ERROR,
"DATA_PDU_TYPE_UPDATE - update_recv() failed");
1273 case DATA_PDU_TYPE_CONTROL:
1274 if (!rdp_recv_server_control_pdu(rdp, cs))
1276 WLog_Print(rdp->log, WLOG_ERROR,
1277 "DATA_PDU_TYPE_CONTROL - rdp_recv_server_control_pdu() failed");
1283 case DATA_PDU_TYPE_POINTER:
1284 if (!update_recv_pointer(rdp->update, cs))
1286 WLog_Print(rdp->log, WLOG_ERROR,
1287 "DATA_PDU_TYPE_POINTER - update_recv_pointer() failed");
1293 case DATA_PDU_TYPE_SYNCHRONIZE:
1294 if (!rdp_recv_server_synchronize_pdu(rdp, cs))
1296 WLog_Print(rdp->log, WLOG_ERROR,
1297 "DATA_PDU_TYPE_SYNCHRONIZE - rdp_recv_synchronize_pdu() failed");
1303 case DATA_PDU_TYPE_PLAY_SOUND:
1304 if (!update_recv_play_sound(rdp->update, cs))
1306 WLog_Print(rdp->log, WLOG_ERROR,
1307 "DATA_PDU_TYPE_PLAY_SOUND - update_recv_play_sound() failed");
1313 case DATA_PDU_TYPE_SHUTDOWN_DENIED:
1314 if (!rdp_recv_server_shutdown_denied_pdu(rdp, cs))
1317 rdp->log, WLOG_ERROR,
1318 "DATA_PDU_TYPE_SHUTDOWN_DENIED - rdp_recv_server_shutdown_denied_pdu() failed");
1324 case DATA_PDU_TYPE_SAVE_SESSION_INFO:
1325 if (!rdp_recv_save_session_info(rdp, cs))
1327 WLog_Print(rdp->log, WLOG_ERROR,
1328 "DATA_PDU_TYPE_SAVE_SESSION_INFO - rdp_recv_save_session_info() failed");
1334 case DATA_PDU_TYPE_FONT_MAP:
1335 if (!rdp_recv_font_map_pdu(rdp, cs))
1337 WLog_Print(rdp->log, WLOG_ERROR,
1338 "DATA_PDU_TYPE_FONT_MAP - rdp_recv_font_map_pdu() failed");
1344 case DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS:
1345 if (!rdp_recv_server_set_keyboard_indicators_pdu(rdp, cs))
1347 WLog_Print(rdp->log, WLOG_ERROR,
1348 "DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS - "
1349 "rdp_recv_server_set_keyboard_indicators_pdu() failed");
1355 case DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS:
1356 if (!rdp_recv_server_set_keyboard_ime_status_pdu(rdp, cs))
1358 WLog_Print(rdp->log, WLOG_ERROR,
1359 "DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS - "
1360 "rdp_recv_server_set_keyboard_ime_status_pdu() failed");
1366 case DATA_PDU_TYPE_SET_ERROR_INFO:
1367 if (!rdp_recv_set_error_info_data_pdu(rdp, cs))
1370 rdp->log, WLOG_ERROR,
1371 "DATA_PDU_TYPE_SET_ERROR_INFO - rdp_recv_set_error_info_data_pdu() failed");
1377 case DATA_PDU_TYPE_ARC_STATUS:
1378 if (!rdp_recv_server_auto_reconnect_status_pdu(rdp, cs))
1380 WLog_Print(rdp->log, WLOG_ERROR,
1381 "DATA_PDU_TYPE_ARC_STATUS - "
1382 "rdp_recv_server_auto_reconnect_status_pdu() failed");
1388 case DATA_PDU_TYPE_STATUS_INFO:
1389 if (!rdp_recv_server_status_info_pdu(rdp, cs))
1391 WLog_Print(rdp->log, WLOG_ERROR,
1392 "DATA_PDU_TYPE_STATUS_INFO - rdp_recv_server_status_info_pdu() failed");
1398 case DATA_PDU_TYPE_MONITOR_LAYOUT:
1399 if (!rdp_recv_monitor_layout_pdu(rdp, cs))
1401 WLog_Print(rdp->log, WLOG_ERROR,
1402 "DATA_PDU_TYPE_MONITOR_LAYOUT - rdp_recv_monitor_layout_pdu() failed");
1409 WLog_Print(rdp->log, WLOG_WARN,
1410 "[UNHANDLED] %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1411 data_pdu_type_to_string(type), type, length);
1418 return STATE_RUN_SUCCESS;
1424 return STATE_RUN_FAILED;
1427state_run_t rdp_recv_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 securityFlags)
1432 if (securityFlags & SEC_AUTODETECT_REQ)
1435 return autodetect_recv_request_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1438 if (securityFlags & SEC_AUTODETECT_RSP)
1441 return autodetect_recv_response_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1444 if (securityFlags & SEC_HEARTBEAT)
1447 return rdp_recv_heartbeat_packet(rdp, s);
1450 if (securityFlags & SEC_TRANSPORT_REQ)
1452 return multitransport_recv_request(rdp->multitransport, s);
1455 if (securityFlags & SEC_TRANSPORT_RSP)
1457 return multitransport_recv_response(rdp->multitransport, s);
1460 if (securityFlags & SEC_LICENSE_PKT)
1462 return license_recv(rdp->license, s);
1465 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
1467 return license_recv(rdp->license, s);
1470 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
1472 return license_recv(rdp->license, s);
1475 return STATE_RUN_SUCCESS;
1478state_run_t rdp_recv_out_of_sequence_pdu(rdpRdp* rdp,
wStream* s, UINT16 pduType, UINT16 length)
1480 state_run_t rc = STATE_RUN_FAILED;
1486 rc = rdp_recv_data_pdu(rdp, s);
1488 case PDU_TYPE_SERVER_REDIRECTION:
1489 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1491 case PDU_TYPE_FLOW_RESPONSE:
1492 case PDU_TYPE_FLOW_STOP:
1493 case PDU_TYPE_FLOW_TEST:
1494 rc = STATE_RUN_SUCCESS;
1498 char buffer1[256] = WINPR_C_ARRAY_INIT;
1499 char buffer2[256] = WINPR_C_ARRAY_INIT;
1501 WLog_Print(rdp->log, WLOG_ERROR,
"expected %s, got %s",
1502 pdu_type_to_str(PDU_TYPE_DEMAND_ACTIVE, buffer1,
sizeof(buffer1)),
1503 pdu_type_to_str(pduType, buffer2,
sizeof(buffer2)));
1504 rc = STATE_RUN_FAILED;
1509 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1510 return STATE_RUN_FAILED;
1514BOOL rdp_read_flow_control_pdu(rdpRdp* rdp,
wStream* s, UINT16* type, UINT16* channel_id)
1528 WINPR_ASSERT(channel_id);
1530 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 6))
1532 Stream_Read_UINT8(s, pduType);
1534 Stream_Seek_UINT8(s);
1535 Stream_Seek_UINT8(s);
1536 Stream_Seek_UINT8(s);
1537 Stream_Read_UINT16(s, *channel_id);
1552BOOL rdp_decrypt(rdpRdp* rdp,
wStream* s, UINT16* pLength, UINT16 securityFlags)
1555 BYTE cmac[8] = WINPR_C_ARRAY_INIT;
1556 BYTE wmac[8] = WINPR_C_ARRAY_INIT;
1557 BOOL status = FALSE;
1560 WINPR_ASSERT(rdp->settings);
1562 WINPR_ASSERT(pLength);
1566 INT32 length = *pLength;
1567 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_NONE)
1573 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
1575 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
1579 Stream_Read_UINT16(s, len);
1581 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS length %" PRIu16
" != 0x10",
1585 Stream_Read_UINT8(s, version);
1587 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS version %" PRIu16
" != 1",
1591 Stream_Read_UINT8(s, pad);
1592 const BYTE* sig = Stream_ConstPointer(s);
1595 const INT32 padLength = length - pad;
1597 if ((length <= 0) || (padLength <= 0) || (padLength > UINT16_MAX))
1599 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid pad length %" PRId32, padLength);
1603 if (!security_fips_decrypt(Stream_Pointer(s), (
size_t)length, rdp))
1606 if (!security_fips_check_signature(Stream_ConstPointer(s), (
size_t)padLength, sig, 8, rdp))
1609 if (!Stream_SetLength(s, Stream_Length(s) - pad))
1612 *pLength = (UINT16)padLength;
1616 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s,
sizeof(wmac)))
1619 Stream_Read(s, wmac,
sizeof(wmac));
1620 length -=
sizeof(wmac);
1624 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid length field");
1628 if (!security_decrypt(Stream_PointerAs(s, BYTE), (
size_t)length, rdp))
1631 if (securityFlags & SEC_SECURE_CHECKSUM)
1632 status = security_salted_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length,
1633 FALSE, cmac,
sizeof(cmac));
1635 status = security_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length, cmac,
1641 if (memcmp(wmac, cmac,
sizeof(wmac)) != 0)
1643 WLog_Print(rdp->log, WLOG_ERROR,
"WARNING: invalid packet signature");
1654 *pLength = (UINT16)length;
1658 security_unlock(rdp);
1662const char* pdu_type_to_str(UINT16 pduType,
char* buffer,
size_t length)
1664 const char* str =
nullptr;
1667 case PDU_TYPE_DEMAND_ACTIVE:
1668 str =
"PDU_TYPE_DEMAND_ACTIVE";
1670 case PDU_TYPE_CONFIRM_ACTIVE:
1671 str =
"PDU_TYPE_CONFIRM_ACTIVE";
1673 case PDU_TYPE_DEACTIVATE_ALL:
1674 str =
"PDU_TYPE_DEACTIVATE_ALL";
1677 str =
"PDU_TYPE_DATA";
1679 case PDU_TYPE_SERVER_REDIRECTION:
1680 str =
"PDU_TYPE_SERVER_REDIRECTION";
1682 case PDU_TYPE_FLOW_TEST:
1683 str =
"PDU_TYPE_FLOW_TEST";
1685 case PDU_TYPE_FLOW_RESPONSE:
1686 str =
"PDU_TYPE_FLOW_RESPONSE";
1688 case PDU_TYPE_FLOW_STOP:
1689 str =
"PDU_TYPE_FLOW_STOP";
1692 str =
"PDU_TYPE_UNKNOWN";
1696 winpr_str_append(str, buffer, length,
"");
1698 char msg[32] = WINPR_C_ARRAY_INIT;
1699 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", pduType);
1700 winpr_str_append(msg, buffer, length,
"");
1711static state_run_t rdp_recv_tpkt_pdu(rdpRdp* rdp,
wStream* s)
1713 state_run_t rc = STATE_RUN_SUCCESS;
1716 UINT16 pduSource = 0;
1717 UINT16 channelId = 0;
1718 UINT16 securityFlags = 0;
1721 WINPR_ASSERT(rdp->context);
1724 freerdp* instance = rdp->context->instance;
1725 WINPR_ASSERT(instance);
1727 if (!rdp_read_header(rdp, s, &length, &channelId))
1728 return STATE_RUN_FAILED;
1730 if (freerdp_shall_disconnect_context(rdp->context))
1731 return STATE_RUN_SUCCESS;
1733 if (rdp->autodetect->bandwidthMeasureStarted)
1735 rdp->autodetect->bandwidthMeasureByteCount += length;
1738 if (rdp->mcs->messageChannelId && (channelId == rdp->mcs->messageChannelId))
1741 return rdp_handle_message_channel(rdp, s, channelId, length);
1744 if (rdp->settings->UseRdpSecurityLayer)
1746 if (!rdp_read_security_header(rdp, s, &securityFlags, &length))
1747 return STATE_RUN_FAILED;
1749 if (securityFlags & (SEC_ENCRYPT | SEC_REDIRECTION_PKT))
1751 if (!rdp_decrypt(rdp, s, &length, securityFlags))
1752 return STATE_RUN_FAILED;
1755 if (securityFlags & SEC_REDIRECTION_PKT)
1761 Stream_Rewind(s, 2);
1764 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1769 if (channelId == MCS_GLOBAL_CHANNEL_ID)
1771 while (Stream_GetRemainingLength(s) > 3)
1778 if (!rdp_read_share_control_header(rdp, s,
nullptr, &remain, &pduType, &pduSource))
1779 return STATE_RUN_FAILED;
1781 sub = Stream_StaticInit(&subbuffer, Stream_Pointer(s), remain);
1782 if (!Stream_SafeSeek(s, remain))
1783 return STATE_RUN_FAILED;
1785 rdp->settings->PduSource = pduSource;
1791 rc = rdp_recv_data_pdu(rdp, sub);
1792 if (state_run_failed(rc))
1796 case PDU_TYPE_DEACTIVATE_ALL:
1797 if (!rdp_recv_deactivate_all(rdp, sub))
1799 WLog_Print(rdp->log, WLOG_ERROR,
1800 "rdp_recv_tpkt_pdu: rdp_recv_deactivate_all() fail");
1801 return STATE_RUN_FAILED;
1806 case PDU_TYPE_SERVER_REDIRECTION:
1807 return rdp_recv_enhanced_security_redirection_packet(rdp, sub);
1809 case PDU_TYPE_FLOW_RESPONSE:
1810 case PDU_TYPE_FLOW_STOP:
1811 case PDU_TYPE_FLOW_TEST:
1812 WLog_Print(rdp->log, WLOG_DEBUG,
"flow message 0x%04" PRIX16
"", pduType);
1814 if (!Stream_SafeSeek(sub, remain))
1815 return STATE_RUN_FAILED;
1820 char buffer[256] = WINPR_C_ARRAY_INIT;
1821 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect PDU type: %s",
1822 pdu_type_to_str(pduType, buffer,
sizeof(buffer)));
1827 diff = Stream_GetRemainingLength(sub);
1830 char buffer[256] = WINPR_C_ARRAY_INIT;
1831 WLog_Print(rdp->log, WLOG_WARN,
1832 "pduType %s not properly parsed, %" PRIuz
1833 " bytes remaining unhandled. Skipping.",
1834 pdu_type_to_str(pduType, buffer,
sizeof(buffer)), diff);
1842 if (!freerdp_channel_process(instance, s, channelId, length))
1843 return STATE_RUN_FAILED;
1847 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1848 return STATE_RUN_FAILED;
1853static state_run_t rdp_recv_fastpath_pdu(rdpRdp* rdp,
wStream* s)
1858 rdpFastPath* fastpath = rdp->fastpath;
1860 if (!fastpath_read_header_rdp(fastpath, s, &length))
1862 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_recv_fastpath_pdu: fastpath_read_header_rdp() fail");
1863 return STATE_RUN_FAILED;
1866 if ((length == 0) || (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, length)))
1868 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect FastPath PDU header length %" PRIu16
"",
1870 return STATE_RUN_FAILED;
1873 if (rdp->autodetect->bandwidthMeasureStarted)
1875 rdp->autodetect->bandwidthMeasureByteCount += length;
1878 if (!fastpath_decrypt(fastpath, s, &length))
1879 return STATE_RUN_FAILED;
1881 return fastpath_recv_updates(rdp->fastpath, s);
1885static state_run_t rdp_recv_pdu(rdpRdp* rdp,
wStream* s)
1887 const int rc = tpkt_verify_header(s);
1889 return rdp_recv_tpkt_pdu(rdp, s);
1891 return rdp_recv_fastpath_pdu(rdp, s);
1893 return STATE_RUN_FAILED;
1897static state_run_t rdp_handle_sc_flags(rdpRdp* rdp,
wStream* s, UINT32 flag,
1898 CONNECTION_STATE nextState)
1900 const UINT32 mask = FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
1901 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU;
1903 state_run_t status = rdp_recv_pdu(rdp, s);
1904 if (state_run_success(status))
1906 const UINT32 flags = rdp->finalize_sc_pdus & mask;
1907 if ((flags & flag) == flag)
1909 if (!rdp_client_transition_to_state(rdp, nextState))
1910 status = STATE_RUN_FAILED;
1912 status = STATE_RUN_SUCCESS;
1916 char flag_buffer[256] = WINPR_C_ARRAY_INIT;
1917 char mask_buffer[256] = WINPR_C_ARRAY_INIT;
1918 WLog_Print(rdp->log, WLOG_WARN,
1919 "[%s] unexpected server message, expected flag %s [have %s]",
1920 rdp_get_state_string(rdp),
1921 rdp_finalize_flags_to_str(flag, flag_buffer,
sizeof(flag_buffer)),
1922 rdp_finalize_flags_to_str(flags, mask_buffer,
sizeof(mask_buffer)));
1929static state_run_t rdp_client_exchange_monitor_layout(rdpRdp* rdp,
wStream* s)
1933 if (!rdp_check_monitor_layout_pdu_state(rdp, FALSE))
1934 return STATE_RUN_FAILED;
1939 const UINT32 old = rdp->finalize_sc_pdus;
1940 state_run_t status = rdp_recv_pdu(rdp, s);
1941 const UINT32 now = rdp->finalize_sc_pdus;
1942 const BOOL changed = (old != now) || rdp->monitor_layout_pdu;
1945 if (state_run_success(status) && changed)
1947 if (!rdp->monitor_layout_pdu)
1949 if (!rdp_finalize_is_flag_set(rdp, FINALIZE_SC_SYNCHRONIZE_PDU))
1950 return STATE_RUN_FAILED;
1951 else if (!rdp_client_transition_to_state(rdp,
1952 CONNECTION_STATE_FINALIZATION_CLIENT_SYNC))
1953 return STATE_RUN_FAILED;
1955 return STATE_RUN_TRY_AGAIN;
1960 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_CLIENT_SYNC))
1961 return STATE_RUN_FAILED;
1967static state_run_t rdp_recv_callback_int(WINPR_ATTR_UNUSED rdpTransport* transport,
wStream* s,
1970 state_run_t status = STATE_RUN_SUCCESS;
1971 rdpRdp* rdp = (rdpRdp*)extra;
1973 WINPR_ASSERT(transport);
1977 switch (rdp_get_state(rdp))
1979 case CONNECTION_STATE_NEGO:
1980 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1981 status = STATE_RUN_FAILED;
1983 status = STATE_RUN_CONTINUE;
1985 case CONNECTION_STATE_NLA:
1986 if (nla_get_state(rdp->nla) < NLA_STATE_AUTH_INFO)
1988 if (nla_recv_pdu(rdp->nla, s) < 1)
1990 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nla_recv_pdu() fail",
1991 rdp_get_state_string(rdp));
1992 status = STATE_RUN_FAILED;
1995 else if (nla_get_state(rdp->nla) == NLA_STATE_POST_NEGO)
1997 if (nego_recv(rdp->transport, s, (
void*)rdp->nego) < 0)
1998 return STATE_RUN_FAILED;
2000 if (!nego_update_settings_from_state(rdp->nego, rdp->settings))
2001 return STATE_RUN_FAILED;
2003 if (nego_get_state(rdp->nego) != NEGO_STATE_FINAL)
2005 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nego_recv() fail",
2006 rdp_get_state_string(rdp));
2007 status = STATE_RUN_FAILED;
2009 else if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
2010 status = STATE_RUN_FAILED;
2013 if (state_run_success(status))
2015 if (nla_get_state(rdp->nla) == NLA_STATE_AUTH_INFO)
2017 transport_set_nla_mode(rdp->transport, FALSE);
2019 if (rdp->settings->VmConnectMode)
2021 if (!nego_set_state(rdp->nego, NEGO_STATE_NLA))
2022 status = STATE_RUN_FAILED;
2023 else if (!nego_set_requested_protocols(rdp->nego,
2024 PROTOCOL_HYBRID | PROTOCOL_SSL))
2025 status = STATE_RUN_FAILED;
2026 else if (!nego_send_negotiation_request(rdp->nego))
2027 status = STATE_RUN_FAILED;
2028 else if (!nla_set_state(rdp->nla, NLA_STATE_POST_NEGO))
2029 status = STATE_RUN_FAILED;
2033 if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
2034 status = STATE_RUN_FAILED;
2038 if (state_run_success(status))
2041 if (nla_get_state(rdp->nla) == NLA_STATE_FINAL)
2043 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
2044 status = STATE_RUN_FAILED;
2046 status = STATE_RUN_CONTINUE;
2051 case CONNECTION_STATE_AAD:
2052 if (aad_recv(rdp->aad, s) < 1)
2054 WLog_Print(rdp->log, WLOG_ERROR,
"%s - aad_recv() fail", rdp_get_state_string(rdp));
2055 status = STATE_RUN_FAILED;
2057 if (state_run_success(status))
2059 if (aad_get_state(rdp->aad) == AAD_STATE_FINAL)
2061 transport_set_aad_mode(rdp->transport, FALSE);
2062 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
2063 status = STATE_RUN_FAILED;
2065 status = STATE_RUN_CONTINUE;
2070 case CONNECTION_STATE_MCS_CREATE_REQUEST:
2071 if (!mcs_client_begin(rdp->mcs))
2073 WLog_Print(rdp->log, WLOG_ERROR,
"%s - mcs_client_begin() fail",
2074 rdp_get_state_string(rdp));
2075 status = STATE_RUN_FAILED;
2077 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_RESPONSE))
2078 status = STATE_RUN_FAILED;
2079 else if (Stream_GetRemainingLength(s) > 0)
2080 status = STATE_RUN_CONTINUE;
2083 case CONNECTION_STATE_MCS_CREATE_RESPONSE:
2084 if (!mcs_recv_connect_response(rdp->mcs, s))
2086 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_connect_response failure");
2087 status = STATE_RUN_FAILED;
2091 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ERECT_DOMAIN))
2092 status = STATE_RUN_FAILED;
2093 else if (!mcs_send_erect_domain_request(rdp->mcs))
2095 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_erect_domain_request failure");
2096 status = STATE_RUN_FAILED;
2098 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ATTACH_USER))
2099 status = STATE_RUN_FAILED;
2100 else if (!mcs_send_attach_user_request(rdp->mcs))
2102 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_attach_user_request failure");
2103 status = STATE_RUN_FAILED;
2105 else if (!rdp_client_transition_to_state(rdp,
2106 CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM))
2107 status = STATE_RUN_FAILED;
2111 case CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM:
2112 if (!mcs_recv_attach_user_confirm(rdp->mcs, s))
2114 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_attach_user_confirm failure");
2115 status = STATE_RUN_FAILED;
2119 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST))
2120 status = STATE_RUN_FAILED;
2121 else if (!mcs_send_channel_join_request(rdp->mcs, rdp->mcs->userId))
2123 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_channel_join_request failure");
2124 status = STATE_RUN_FAILED;
2126 else if (!rdp_client_transition_to_state(
2127 rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE))
2128 status = STATE_RUN_FAILED;
2133 if (!rdp_client_skip_mcs_channel_join(rdp))
2134 status = STATE_RUN_FAILED;
2138 case CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE:
2139 if (!rdp_client_connect_mcs_channel_join_confirm(rdp, s))
2141 WLog_Print(rdp->log, WLOG_ERROR,
2143 "rdp_client_connect_mcs_channel_join_confirm() fail",
2144 rdp_get_state_string(rdp));
2145 status = STATE_RUN_FAILED;
2150 case CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST:
2151 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2153 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_LICENSING))
2154 status = STATE_RUN_FAILED;
2156 status = STATE_RUN_TRY_AGAIN;
2160 case CONNECTION_STATE_LICENSING:
2161 status = rdp_client_connect_license(rdp, s);
2163 if (state_run_failed(status))
2165 char buffer[64] = WINPR_C_ARRAY_INIT;
2166 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_client_connect_license() - %s",
2167 rdp_get_state_string(rdp),
2168 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2173 case CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST:
2174 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2176 if (!rdp_client_transition_to_state(
2177 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE))
2178 status = STATE_RUN_FAILED;
2180 status = STATE_RUN_TRY_AGAIN;
2184 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE:
2185 status = rdp_client_connect_demand_active(rdp, s);
2187 if (state_run_failed(status))
2189 char buffer[64] = WINPR_C_ARRAY_INIT;
2190 WLog_Print(rdp->log, WLOG_DEBUG,
2192 "rdp_client_connect_demand_active() - %s",
2193 rdp_get_state_string(rdp),
2194 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2196 else if (status == STATE_RUN_ACTIVE)
2198 if (!rdp_client_transition_to_state(
2199 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE))
2200 status = STATE_RUN_FAILED;
2202 status = STATE_RUN_CONTINUE;
2206 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT:
2207 status = rdp_client_exchange_monitor_layout(rdp, s);
2210 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE:
2211 status = rdp_client_connect_confirm_active(rdp, s);
2214 case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
2215 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_SYNCHRONIZE_PDU,
2216 CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE);
2218 case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
2219 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_COOPERATE_PDU,
2220 CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL);
2222 case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
2223 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_GRANTED_PDU,
2224 CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP);
2226 case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
2227 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_FONT_MAP_PDU, CONNECTION_STATE_ACTIVE);
2230 case CONNECTION_STATE_ACTIVE:
2231 status = rdp_recv_pdu(rdp, s);
2233 if (state_run_failed(status))
2235 char buffer[64] = WINPR_C_ARRAY_INIT;
2236 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_recv_pdu() - %s",
2237 rdp_get_state_string(rdp),
2238 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2243 WLog_Print(rdp->log, WLOG_ERROR,
"%s state %u", rdp_get_state_string(rdp),
2244 rdp_get_state(rdp));
2245 status = STATE_RUN_FAILED;
2249 if (state_run_failed(status))
2251 char buffer[64] = WINPR_C_ARRAY_INIT;
2252 WLog_Print(rdp->log, WLOG_ERROR,
"%s status %s", rdp_get_state_string(rdp),
2253 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2258state_run_t rdp_recv_callback(rdpTransport* transport,
wStream* s,
void* extra)
2260 char buffer[64] = WINPR_C_ARRAY_INIT;
2261 state_run_t rc = STATE_RUN_FAILED;
2262 const size_t start = Stream_GetPosition(s);
2263 const rdpContext* context = transport_get_context(transport);
2265 WINPR_ASSERT(context);
2268 const rdpRdp* rdp = context->rdp;
2271 if (rc == STATE_RUN_TRY_AGAIN)
2273 if (!Stream_SetPosition(s, start))
2274 return STATE_RUN_FAILED;
2277 const char* old = rdp_get_state_string(rdp);
2278 const size_t orem = Stream_GetRemainingLength(s);
2279 rc = rdp_recv_callback_int(transport, s, extra);
2281 const char* now = rdp_get_state_string(rdp);
2282 const size_t rem = Stream_GetRemainingLength(s);
2284 WLog_Print(rdp->log, WLOG_TRACE,
2285 "(client)[%s -> %s] current return %s [feeding %" PRIuz
" bytes, %" PRIuz
2286 " bytes not processed]",
2287 old, now, state_run_result_string(rc, buffer,
sizeof(buffer)), orem, rem);
2288 }
while ((rc == STATE_RUN_TRY_AGAIN) || (rc == STATE_RUN_CONTINUE));
2292BOOL rdp_send_channel_data(rdpRdp* rdp, UINT16 channelId,
const BYTE* data,
size_t size)
2294 return freerdp_channel_send(rdp, channelId, data, size);
2297BOOL rdp_channel_send_packet(rdpRdp* rdp, UINT16 channelId,
size_t totalSize, UINT32 flags,
2298 const BYTE* data,
size_t chunkSize)
2300 return freerdp_channel_send_packet(rdp, channelId, totalSize, flags, data, chunkSize);
2303BOOL rdp_send_error_info(rdpRdp* rdp)
2305 UINT16 sec_flags = 0;
2309 if (rdp->errorInfo == ERRINFO_SUCCESS)
2312 s = rdp_data_pdu_init(rdp, &sec_flags);
2317 Stream_Write_UINT32(s, rdp->errorInfo);
2318 status = rdp_send_data_pdu(rdp, s, DATA_PDU_TYPE_SET_ERROR_INFO, 0, sec_flags);
2322int rdp_check_fds(rdpRdp* rdp)
2325 rdpTsg* tsg =
nullptr;
2326 rdpTransport* transport =
nullptr;
2329 transport = rdp->transport;
2331 tsg = transport_get_tsg(transport);
2334 if (!tsg_check_event_handles(tsg))
2336 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_check_fds: tsg_check_event_handles()");
2340 if (tsg_get_state(tsg) != TSG_STATE_PIPE_CREATED)
2344 status = transport_check_fds(transport);
2348 if (!rdp_client_redirect(rdp))
2353 WLog_Print(rdp->log, WLOG_DEBUG,
"transport_check_fds() - %i", status);
2355 status = freerdp_timer_poll(rdp->timer);
2357 if ((status >= 0) && !multitransport_check(rdp->multitransport))
2363BOOL freerdp_get_stats(
const rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes, UINT64* inPackets,
2370 *inBytes = rdp->inBytes;
2372 *outBytes = rdp->outBytes;
2374 *inPackets = rdp->inPackets;
2376 *outPackets = rdp->outPackets;
2382static bool rdp_new_common(rdpRdp* rdp)
2387 rdp->transport = transport_new(rdp->context);
2388 if (!rdp->transport)
2393 if (!transport_set_io_callbacks(rdp->transport, rdp->io))
2397 rdp->aad = aad_new(rdp->context);
2401 rdp->nego = nego_new(rdp->transport);
2405 rdp->mcs = mcs_new(rdp->context);
2409 rdp->license = license_new(rdp);
2413 rdp->fastpath = fastpath_new(rdp);
2427rdpRdp* rdp_new(rdpContext* context)
2430 rdpRdp* rdp = (rdpRdp*)calloc(1,
sizeof(rdpRdp));
2435 rdp->log = WLog_Create(RDP_TAG, WLog_GetRoot());
2439 (void)_snprintf(rdp->log_context,
sizeof(rdp->log_context),
"%p", (
void*)context);
2440 if (!WLog_SetContext(rdp->log,
nullptr, rdp->log_context))
2443 InitializeCriticalSection(&rdp->critical);
2444 rdp->context = context;
2445 WINPR_ASSERT(rdp->context);
2447 if (context->ServerMode)
2450 if (!context->settings)
2458 rdp->settings = context->settings;
2461 if (!rdp_set_backup_settings(rdp))
2464 rdp->settings->instance = context->instance;
2466 context->settings = rdp->settings;
2467 if (context->instance)
2468 context->settings->instance = context->instance;
2469 else if (context->peer)
2471 rdp->settings->instance = context->peer;
2473#if defined(WITH_FREERDP_DEPRECATED)
2474 context->peer->settings = rdp->settings;
2478 if (!rdp_new_common(rdp))
2482 const rdpTransportIo* io = transport_get_io_callbacks(rdp->transport);
2485 rdp->io = calloc(1,
sizeof(rdpTransportIo));
2491 rdp->input = input_new(rdp);
2496 rdp->update = update_new(rdp);
2501 rdp->redirection = redirection_new();
2503 if (!rdp->redirection)
2506 rdp->autodetect = autodetect_new(rdp->context);
2508 if (!rdp->autodetect)
2511 rdp->heartbeat = heartbeat_new();
2513 if (!rdp->heartbeat)
2516 rdp->multitransport = multitransport_new(rdp, INITIATE_REQUEST_PROTOCOL_UDPFECL |
2517 INITIATE_REQUEST_PROTOCOL_UDPFECR);
2519 if (!rdp->multitransport)
2522 rdp->bulk = bulk_new(context);
2527 rdp->pubSub = PubSub_New(TRUE);
2531 rdp->abortEvent = CreateEvent(
nullptr, TRUE, FALSE,
nullptr);
2532 if (!rdp->abortEvent)
2535 rdp->timer = freerdp_timer_new(rdp);
2542 WINPR_PRAGMA_DIAG_PUSH
2543 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2545 WINPR_PRAGMA_DIAG_POP
2549static void rdp_reset_free(rdpRdp* rdp)
2554 rdp_free_rc4_decrypt_keys(rdp);
2555 rdp_free_rc4_encrypt_keys(rdp);
2557 winpr_Cipher_Free(rdp->fips_encrypt);
2558 winpr_Cipher_Free(rdp->fips_decrypt);
2559 rdp->fips_encrypt =
nullptr;
2560 rdp->fips_decrypt =
nullptr;
2561 security_unlock(rdp);
2565 nego_free(rdp->nego);
2566 license_free(rdp->license);
2567 transport_free(rdp->transport);
2568 fastpath_free(rdp->fastpath);
2572 rdp->nego =
nullptr;
2573 rdp->license =
nullptr;
2574 rdp->transport =
nullptr;
2575 rdp->fastpath =
nullptr;
2578BOOL rdp_reset(rdpRdp* rdp)
2584 rdpSettings* settings = rdp->settings;
2585 WINPR_ASSERT(settings);
2587 bulk_reset(rdp->bulk);
2588 multitransport_reset(rdp->multitransport);
2590 rdp_reset_free(rdp);
2604 rc = rdp_new_common(rdp);
2608 if (!transport_set_layer(rdp->transport, TRANSPORT_LAYER_TCP))
2612 rc = rdp_finalize_reset_flags(rdp, TRUE);
2623void rdp_free(rdpRdp* rdp)
2627 freerdp_timer_free(rdp->timer);
2628 rdp_reset_free(rdp);
2634 input_free(rdp->input);
2635 update_free(rdp->update);
2637 redirection_free(rdp->redirection);
2638 autodetect_free(rdp->autodetect);
2639 heartbeat_free(rdp->heartbeat);
2640 multitransport_free(rdp->multitransport);
2641 freerdp_bulk_free(rdp->bulk);
2643 PubSub_Free(rdp->pubSub);
2644 if (rdp->abortEvent)
2645 (void)CloseHandle(rdp->abortEvent);
2648 DeleteCriticalSection(&rdp->critical);
2649 WLog_Discard(rdp->log);
2654BOOL rdp_io_callback_set_event(rdpRdp* rdp, BOOL set)
2658 return transport_io_callback_set_event(rdp->transport, set);
2661const rdpTransportIo* rdp_get_io_callbacks(rdpRdp* rdp)
2668BOOL rdp_set_io_callbacks(rdpRdp* rdp,
const rdpTransportIo* io_callbacks)
2676 rdp->io = malloc(
sizeof(rdpTransportIo));
2679 *rdp->io = *io_callbacks;
2680 return transport_set_io_callbacks(rdp->transport, rdp->io);
2685BOOL rdp_set_io_callback_context(rdpRdp* rdp,
void* usercontext)
2688 rdp->ioContext = usercontext;
2692void* rdp_get_io_callback_context(rdpRdp* rdp)
2695 return rdp->ioContext;
2698const char* rdp_finalize_flags_to_str(UINT32 flags,
char* buffer,
size_t size)
2700 char number[32] = WINPR_C_ARRAY_INIT;
2702 (uint32_t)~(FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
2703 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU |
2704 FINALIZE_CS_SYNCHRONIZE_PDU | FINALIZE_CS_CONTROL_COOPERATE_PDU |
2705 FINALIZE_CS_CONTROL_REQUEST_PDU | FINALIZE_CS_PERSISTENT_KEY_LIST_PDU |
2706 FINALIZE_CS_FONT_LIST_PDU | FINALIZE_DEACTIVATE_REACTIVATE);
2708 if (flags & FINALIZE_SC_SYNCHRONIZE_PDU)
2709 winpr_str_append(
"FINALIZE_SC_SYNCHRONIZE_PDU", buffer, size,
"|");
2710 if (flags & FINALIZE_SC_CONTROL_COOPERATE_PDU)
2711 winpr_str_append(
"FINALIZE_SC_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2712 if (flags & FINALIZE_SC_CONTROL_GRANTED_PDU)
2713 winpr_str_append(
"FINALIZE_SC_CONTROL_GRANTED_PDU", buffer, size,
"|");
2714 if (flags & FINALIZE_SC_FONT_MAP_PDU)
2715 winpr_str_append(
"FINALIZE_SC_FONT_MAP_PDU", buffer, size,
"|");
2716 if (flags & FINALIZE_CS_SYNCHRONIZE_PDU)
2717 winpr_str_append(
"FINALIZE_CS_SYNCHRONIZE_PDU", buffer, size,
"|");
2718 if (flags & FINALIZE_CS_CONTROL_COOPERATE_PDU)
2719 winpr_str_append(
"FINALIZE_CS_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2720 if (flags & FINALIZE_CS_CONTROL_REQUEST_PDU)
2721 winpr_str_append(
"FINALIZE_CS_CONTROL_REQUEST_PDU", buffer, size,
"|");
2722 if (flags & FINALIZE_CS_PERSISTENT_KEY_LIST_PDU)
2723 winpr_str_append(
"FINALIZE_CS_PERSISTENT_KEY_LIST_PDU", buffer, size,
"|");
2724 if (flags & FINALIZE_CS_FONT_LIST_PDU)
2725 winpr_str_append(
"FINALIZE_CS_FONT_LIST_PDU", buffer, size,
"|");
2726 if (flags & FINALIZE_DEACTIVATE_REACTIVATE)
2727 winpr_str_append(
"FINALIZE_DEACTIVATE_REACTIVATE", buffer, size,
"|");
2729 winpr_str_append(
"UNKNOWN_FLAG", buffer, size,
"|");
2731 winpr_str_append(
"NO_FLAG_SET", buffer, size,
"|");
2732 (void)_snprintf(number,
sizeof(number),
" [0x%08" PRIx32
"]", flags);
2733 winpr_str_append(number, buffer, size,
"");
2737BOOL rdp_finalize_reset_flags(rdpRdp* rdp, BOOL clearAll)
2740 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] reset finalize_sc_pdus", rdp_get_state_string(rdp));
2742 rdp->finalize_sc_pdus = 0;
2744 rdp->finalize_sc_pdus &= FINALIZE_DEACTIVATE_REACTIVATE;
2746 return rdp_set_monitor_layout_pdu_state(rdp, FALSE);
2749BOOL rdp_finalize_set_flag(rdpRdp* rdp, UINT32 flag)
2751 char buffer[1024] = WINPR_C_ARRAY_INIT;
2755 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] received flag %s", rdp_get_state_string(rdp),
2756 rdp_finalize_flags_to_str(flag, buffer,
sizeof(buffer)));
2757 rdp->finalize_sc_pdus |= flag;
2761BOOL rdp_finalize_is_flag_set(rdpRdp* rdp, UINT32 flag)
2764 return (rdp->finalize_sc_pdus & flag) == flag;
2767BOOL rdp_reset_rc4_encrypt_keys(rdpRdp* rdp)
2770 rdp_free_rc4_encrypt_keys(rdp);
2771 rdp->rc4_encrypt_key = winpr_RC4_New(rdp->encrypt_key, rdp->rc4_key_len);
2773 rdp->encrypt_use_count = 0;
2774 return rdp->rc4_encrypt_key !=
nullptr;
2777void rdp_free_rc4_encrypt_keys(rdpRdp* rdp)
2780 winpr_RC4_Free(rdp->rc4_encrypt_key);
2781 rdp->rc4_encrypt_key =
nullptr;
2784void rdp_free_rc4_decrypt_keys(rdpRdp* rdp)
2787 winpr_RC4_Free(rdp->rc4_decrypt_key);
2788 rdp->rc4_decrypt_key =
nullptr;
2791BOOL rdp_reset_rc4_decrypt_keys(rdpRdp* rdp)
2794 rdp_free_rc4_decrypt_keys(rdp);
2795 rdp->rc4_decrypt_key = winpr_RC4_New(rdp->decrypt_key, rdp->rc4_key_len);
2797 rdp->decrypt_use_count = 0;
2798 return rdp->rc4_decrypt_key !=
nullptr;
2801const char* rdp_security_flag_string(UINT32 securityFlags,
char* buffer,
size_t size)
2803 if (securityFlags & SEC_EXCHANGE_PKT)
2804 winpr_str_append(
"SEC_EXCHANGE_PKT", buffer, size,
"|");
2805 if (securityFlags & SEC_TRANSPORT_REQ)
2806 winpr_str_append(
"SEC_TRANSPORT_REQ", buffer, size,
"|");
2807 if (securityFlags & SEC_TRANSPORT_RSP)
2808 winpr_str_append(
"SEC_TRANSPORT_RSP", buffer, size,
"|");
2809 if (securityFlags & SEC_ENCRYPT)
2810 winpr_str_append(
"SEC_ENCRYPT", buffer, size,
"|");
2811 if (securityFlags & SEC_RESET_SEQNO)
2812 winpr_str_append(
"SEC_RESET_SEQNO", buffer, size,
"|");
2813 if (securityFlags & SEC_IGNORE_SEQNO)
2814 winpr_str_append(
"SEC_IGNORE_SEQNO", buffer, size,
"|");
2815 if (securityFlags & SEC_INFO_PKT)
2816 winpr_str_append(
"SEC_INFO_PKT", buffer, size,
"|");
2817 if (securityFlags & SEC_LICENSE_PKT)
2818 winpr_str_append(
"SEC_LICENSE_PKT", buffer, size,
"|");
2819 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
2820 winpr_str_append(
"SEC_LICENSE_ENCRYPT_CS", buffer, size,
"|");
2821 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
2822 winpr_str_append(
"SEC_LICENSE_ENCRYPT_SC", buffer, size,
"|");
2823 if (securityFlags & SEC_REDIRECTION_PKT)
2824 winpr_str_append(
"SEC_REDIRECTION_PKT", buffer, size,
"|");
2825 if (securityFlags & SEC_SECURE_CHECKSUM)
2826 winpr_str_append(
"SEC_SECURE_CHECKSUM", buffer, size,
"|");
2827 if (securityFlags & SEC_AUTODETECT_REQ)
2828 winpr_str_append(
"SEC_AUTODETECT_REQ", buffer, size,
"|");
2829 if (securityFlags & SEC_AUTODETECT_RSP)
2830 winpr_str_append(
"SEC_AUTODETECT_RSP", buffer, size,
"|");
2831 if (securityFlags & SEC_HEARTBEAT)
2832 winpr_str_append(
"SEC_HEARTBEAT", buffer, size,
"|");
2833 if (securityFlags & SEC_FLAGSHI_VALID)
2834 winpr_str_append(
"SEC_FLAGSHI_VALID", buffer, size,
"|");
2836 char msg[32] = WINPR_C_ARRAY_INIT;
2838 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", securityFlags);
2839 winpr_str_append(msg, buffer, size,
"");
2845static BOOL rdp_reset_remote_settings(rdpRdp* rdp)
2847 UINT32 flags = FREERDP_SETTINGS_REMOTE_MODE;
2854 return rdp->remoteSettings !=
nullptr;
2857BOOL rdp_set_backup_settings(rdpRdp* rdp)
2862 if (!rdp->originalSettings)
2864 return rdp_reset_remote_settings(rdp);
2867BOOL rdp_reset_runtime_settings(rdpRdp* rdp)
2870 WINPR_ASSERT(rdp->context);
2877 return rdp_reset_remote_settings(rdp);
2881static BOOL starts_with(
const char* tok,
const char* val)
2883 const size_t len = strlen(val);
2884 if (strncmp(tok, val, len) != 0)
2886 if (tok[len] !=
'=')
2892static BOOL option_equals(
const char* what,
const char* val)
2894 return _stricmp(what, val) == 0;
2898static BOOL parse_on_off_option(
const char* value)
2900 WINPR_ASSERT(value);
2901 const char* sep = strchr(value,
'=');
2904 if (option_equals(
"on", &sep[1]))
2906 if (option_equals(
"true", &sep[1]))
2908 if (option_equals(
"off", &sep[1]))
2910 if (option_equals(
"false", &sep[1]))
2914 long val = strtol(value,
nullptr, 0);
2924static BOOL option_is_runtime_checks(WINPR_ATTR_UNUSED wLog* log, WINPR_ATTR_UNUSED DWORD level,
2927 const char* experimental[] = { STR(WITH_VERBOSE_WINPR_ASSERT) };
2928 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2930 const char* opt = experimental[x];
2931 if (starts_with(tok, opt))
2933 return parse_on_off_option(tok);
2940static BOOL option_is_experimental(WINPR_ATTR_UNUSED wLog* log, WINPR_ATTR_UNUSED DWORD level,
2943 const char* experimental[] = { STR(WITH_DSP_EXPERIMENTAL), STR(WITH_FFMPEG_HWACCEL),
2944 STR(WITH_GFX_AV1), STR(WITH_MEDIACODEC),
2945 STR(WITH_CLIENT_SDL2), STR(WITH_OPENCL),
2946 STR(WITH_LIBRESSL), STR(WITH_MBEDTLS),
2947 STR(WITH_MEDIA_FOUNDATION), STR(WITH_KRB5_HEIMDAL),
2948 STR(WITH_RDPEUDP) };
2949 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2951 const char* opt = experimental[x];
2952 if (starts_with(tok, opt))
2954 return parse_on_off_option(tok);
2961static BOOL option_is_debug(wLog* log, WINPR_ATTR_UNUSED DWORD level,
const char* tok)
2964 const char* debug[] = { STR(WITH_DEBUG_ALL),
2965 STR(WITH_DEBUG_CERTIFICATE),
2966 STR(WITH_DEBUG_CAPABILITIES),
2967 STR(WITH_DEBUG_CHANNELS),
2968 STR(WITH_DEBUG_CLIPRDR),
2969 STR(WITH_DEBUG_CODECS),
2970 STR(WITH_DEBUG_DVC),
2971 STR(WITH_DEBUG_TSMF),
2972 STR(WITH_DEBUG_KBD),
2973 STR(WITH_DEBUG_LICENSE),
2974 STR(WITH_DEBUG_NEGO),
2975 STR(WITH_DEBUG_NLA),
2976 STR(WITH_DEBUG_TSG),
2977 STR(WITH_DEBUG_RAIL),
2978 STR(WITH_DEBUG_RDP),
2979 STR(WITH_DEBUG_RDPEI),
2980 STR(WITH_DEBUG_REDIR),
2981 STR(WITH_DEBUG_RDPDR),
2982 STR(WITH_DEBUG_RFX),
2983 STR(WITH_DEBUG_SCARD),
2984 STR(WITH_DEBUG_SND),
2985 STR(WITH_DEBUG_SVC),
2986 STR(WITH_DEBUG_TRANSPORT),
2987 STR(WITH_DEBUG_TIMEZONE),
2988 STR(WITH_DEBUG_WND),
2989 STR(WITH_DEBUG_RINGBUFFER),
2990 STR(WITH_DEBUG_SYMBOLS),
2991 STR(WITH_DEBUG_EVENTS),
2992 STR(WITH_DEBUG_MUTEX),
2993 STR(WITH_DEBUG_NTLM),
2994 STR(WITH_DEBUG_SDL_KBD_EVENTS),
2995 STR(WITH_DEBUG_SDL_KBD_EVENTS),
2996 STR(WITH_DEBUG_THREADS),
2997 STR(WITH_DEBUG_URBDRC) };
2999 for (
size_t x = 0; x < ARRAYSIZE(debug); x++)
3001 const char* opt = debug[x];
3002 if (starts_with(tok, opt))
3003 return parse_on_off_option(tok);
3006 if (starts_with(tok,
"WITH_DEBUG"))
3008 WLog_Print(log, level,
"[BUG] Unmapped Debug-Build option '%s'.", tok);
3009 return parse_on_off_option(tok);
3015static void log_build_warn(wLog* log, DWORD level,
const char* what,
const char* msg,
3016 BOOL (*cmp)(wLog* log, DWORD level,
const char* tok))
3018 WINPR_PRAGMA_DIAG_PUSH
3019 WINPR_PRAGMA_DIAG_IGNORED_OVERLENGTH_STRINGS
3021 size_t len =
sizeof(FREERDP_BUILD_CONFIG);
3022 char* list = calloc(len,
sizeof(
char));
3023 char* config = _strdup(FREERDP_BUILD_CONFIG);
3024 WINPR_PRAGMA_DIAG_POP
3028 char* saveptr =
nullptr;
3029 char* tok = strtok_s(config,
" ", &saveptr);
3032 if (cmp(log, level, tok))
3033 winpr_str_append(tok, list, len,
" ");
3035 tok = strtok_s(
nullptr,
" ", &saveptr);
3042 if (strlen(list) > 0)
3044 WLog_Print(log, level,
"*************************************************");
3045 WLog_Print(log, level,
"This build is using [%s] build options:", what);
3047 char* saveptr =
nullptr;
3048 char* tok = strtok_s(list,
" ", &saveptr);
3051 WLog_Print(log, level,
"* '%s'", tok);
3052 tok = strtok_s(
nullptr,
" ", &saveptr);
3054 WLog_Print(log, level,
"*");
3055 WLog_Print(log, level,
"[%s] build options %s", what, msg);
3056 WLog_Print(log, level,
"*************************************************");
3062#define print_first_line(log, level, firstLine, what) \
3063 print_first_line_int((log), (level), (firstLine), (what), __FILE__, __func__, __LINE__)
3064static void print_first_line_int(wLog* log, DWORD level, log_line_t* firstLine,
const char* what,
3065 const char* file,
const char* fkt,
size_t line)
3067 WINPR_ASSERT(firstLine);
3068 if (!firstLine->fkt)
3070 if (WLog_IsLevelActive(log, level))
3072 WLog_PrintTextMessage(log, level, line, file, fkt,
3073 "*************************************************");
3074 WLog_PrintTextMessage(log, level, line, file, fkt,
3075 "[SSL] {%s} build or configuration missing:", what);
3077 firstLine->line = line;
3078 firstLine->file = file;
3079 firstLine->fkt = fkt;
3080 firstLine->level = level;
3084static void print_last_line(wLog* log,
const log_line_t* firstLine)
3086 WINPR_ASSERT(firstLine);
3089 if (WLog_IsLevelActive(log, firstLine->level))
3090 WLog_PrintTextMessage(log, firstLine->level, firstLine->line, firstLine->file,
3092 "*************************************************");
3096static void log_build_warn_cipher(wLog* log, DWORD level, log_line_t* firstLine,
3097 WINPR_CIPHER_TYPE md,
const char* what, BOOL allowFIPS)
3099 BOOL haveCipher = FALSE;
3101 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3102 char iv[WINPR_CIPHER_MAX_IV_LENGTH] = WINPR_C_ARRAY_INIT;
3106 if (md == WINPR_CIPHER_ARC4_128)
3108 WINPR_RC4_CTX* enc =
nullptr;
3110 enc = winpr_RC4_New_Allow_FIPS(key,
sizeof(key));
3112 enc = winpr_RC4_New(key,
sizeof(key));
3113 haveCipher = enc !=
nullptr;
3114 winpr_RC4_Free(enc);
3118 WINPR_CIPHER_CTX* enc =
3119 winpr_Cipher_NewEx(md, WINPR_ENCRYPT, key,
sizeof(key), iv,
sizeof(iv));
3120 WINPR_CIPHER_CTX* dec =
3121 winpr_Cipher_NewEx(md, WINPR_DECRYPT, key,
sizeof(key), iv,
sizeof(iv));
3125 winpr_Cipher_Free(enc);
3126 winpr_Cipher_Free(dec);
3131 print_first_line(log, level, firstLine,
"Cipher");
3132 WLog_Print(log, level,
"* %s: %s", winpr_cipher_type_to_string(md), what);
3136static void log_build_warn_hmac(wLog* log, DWORD level, log_line_t* firstLine, WINPR_MD_TYPE md,
3139 BOOL haveHmacX = FALSE;
3140 WINPR_HMAC_CTX* hmac = winpr_HMAC_New();
3146 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3147 haveHmacX = winpr_HMAC_Init(hmac, md, key,
sizeof(key));
3149 winpr_HMAC_Free(hmac);
3153 print_first_line(log, level, firstLine,
"HMAC");
3154 WLog_Print(log, level,
" * %s: %s", winpr_md_type_to_string(md), what);
3158static void log_build_warn_hash(wLog* log, DWORD level, log_line_t* firstLine, WINPR_MD_TYPE md,
3159 const char* what, BOOL allowFIPS)
3161 BOOL haveDigestX = FALSE;
3162 WINPR_DIGEST_CTX* digest = winpr_Digest_New();
3166 haveDigestX = winpr_Digest_Init_Allow_FIPS(digest, md);
3168 haveDigestX = winpr_Digest_Init(digest, md);
3170 winpr_Digest_Free(digest);
3174 print_first_line(log, level, firstLine,
"Digest");
3175 WLog_Print(log, level,
" * %s: %s", winpr_md_type_to_string(md), what);
3179static void log_build_warn_ssl(wLog* log, DWORD level)
3181 const BOOL fips = winpr_FIPSMode();
3185 WLog_Print(log, WLOG_INFO,
3186 "FIPS mode active: non-approved algorithms are unavailable "
3187 "as expected. NTLM, autoreconnect cookies, assistance files "
3188 "with encrypted passwords and RDP security will not work.");
3191 log_line_t firstHashLine = WINPR_C_ARRAY_INIT;
3194 log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_MD4,
"NTLM support not available",
3196 log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_MD5,
3197 "NTLM, assistance files with encrypted passwords "
3198 " and autoreconnect cookies will not work",
3201 log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_MD5,
3202 "RDP licensing and RDP security will not work", TRUE);
3203 log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_SHA1,
3204 "assistance files with encrypted passwords, Kerberos, Smartcard Logon, RDP "
3205 "security support not available",
3207 log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_SHA256,
3208 "file clipboard, AAD gateway, NLA security and certificates might not work",
3210 print_last_line(log, &firstHashLine);
3214 log_line_t firstHmacLine = WINPR_C_ARRAY_INIT;
3215 log_build_warn_hmac(log, level, &firstHmacLine, WINPR_MD_MD5,
3216 "Autoreconnect cookie not supported");
3217 log_build_warn_hmac(log, level, &firstHmacLine, WINPR_MD_SHA1,
3218 "RDP security not supported");
3219 print_last_line(log, &firstHmacLine);
3222 log_line_t firstCipherLine = WINPR_C_ARRAY_INIT;
3225 log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_ARC4_128,
3226 "assistance files with encrypted passwords, NTLM "
3227 "and autoreconnect cookies will not work",
3230 log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_ARC4_128,
3231 "RDP licensing and RDP security will not work", TRUE);
3233 log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_DES_EDE3_CBC,
3234 "RDP security will not work", TRUE);
3235 log_build_warn_cipher(
3236 log, level, &firstCipherLine, WINPR_CIPHER_AES_128_CBC,
3237 "assistance file encrypted LHTicket will not work and ARM gateway might not", FALSE);
3238 log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_AES_192_CBC,
3239 "ARM gateway might not work", FALSE);
3240 log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_AES_256_CBC,
3241 "ARM gateway might not work", FALSE);
3242 print_last_line(log, &firstCipherLine);
3245static void rdp_log_build_warnings_wlog(wLog* log, DWORD level)
3247 static unsigned count = 0;
3255 log_build_warn(log, level,
"experimental",
"might crash the application",
3256 option_is_experimental);
3257 log_build_warn(log, level,
"debug",
"might leak sensitive information (credentials, ...)",
3259 log_build_warn(log, level,
"runtime-check",
"might slow down the application",
3260 option_is_runtime_checks);
3261 log_build_warn_ssl(log, level);
3262 winpr_log_build_warn(log, level);
3265void rdp_log_build_warnings(rdpRdp* rdp)
3268 rdp_log_build_warnings_wlog(rdp->log, WLOG_WARN);
3271size_t rdp_get_event_handles(rdpRdp* rdp, HANDLE* handles, uint32_t count)
3273 size_t nCount = transport_get_event_handles(rdp->transport, handles, count);
3279 if ((nCount > count) || (count - nCount < 3))
3282 handles[nCount++] = utils_get_abort_event(rdp);
3283 handles[nCount++] = freerdp_timer_get_event(rdp->timer);
3284 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.