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__)
127static BOOL rdp_check_monitor_layout_pdu_state_(
const rdpRdp* rdp, BOOL expected,
const char* file,
128 const char* fkt,
size_t line)
131 if (expected != rdp->monitor_layout_pdu)
133 const DWORD log_level = WLOG_ERROR;
134 if (WLog_IsLevelActive(rdp->log, log_level))
136 WLog_PrintTextMessage(rdp->log, log_level, line, file, fkt,
137 "Expected rdp->monitor_layout_pdu == %s",
138 expected ?
"TRUE" :
"FALSE");
145#define rdp_set_monitor_layout_pdu_state(rdp, expected) \
146 rdp_set_monitor_layout_pdu_state_(rdp, expected, __FILE__, __func__, __LINE__)
147static BOOL rdp_set_monitor_layout_pdu_state_(rdpRdp* rdp, BOOL value,
const char* file,
148 const char* fkt,
size_t line)
152 if (value && (value == rdp->monitor_layout_pdu))
154 const DWORD log_level = WLOG_WARN;
155 if (WLog_IsLevelActive(rdp->log, log_level))
157 WLog_PrintTextMessage(rdp->log, log_level, line, file, fkt,
158 "rdp->monitor_layout_pdu == TRUE, expected FALSE");
162 rdp->monitor_layout_pdu = value;
166const char* data_pdu_type_to_string(UINT8 type)
168 if (type >= ARRAYSIZE(DATA_PDU_TYPE_STRINGS))
170 return DATA_PDU_TYPE_STRINGS[type];
173static BOOL rdp_read_flow_control_pdu(rdpRdp* rdp,
wStream* s, UINT16* type, UINT16* channel_id);
174static BOOL rdp_write_share_control_header(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 type,
176static BOOL rdp_write_share_data_header(rdpRdp* rdp,
wStream* s,
size_t length, BYTE type,
189BOOL rdp_read_security_header(rdpRdp* rdp,
wStream* s, UINT16* flags, UINT16* length)
191 char buffer[256] = WINPR_C_ARRAY_INIT;
197 if ((length && (*length < 4)))
199 WLog_Print(rdp->log, WLOG_WARN,
200 "invalid security header length, have %" PRIu16
", must be >= 4", *length);
203 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
206 *flags = Stream_Get_UINT16(s);
207 const uint16_t flagsHi = Stream_Get_UINT16(s);
208 if ((*flags & SEC_FLAGSHI_VALID) != 0)
210 WLog_Print(rdp->log, WLOG_WARN,
211 "[MS-RDPBCGR] 2.2.8.1.1.2.1 Basic (TS_SECURITY_HEADER) SEC_FLAGSHI_VALID field "
212 "set: flagsHi=0x%04" PRIx16,
215 WLog_Print(rdp->log, WLOG_TRACE,
"%s",
216 rdp_security_flag_string(*flags, buffer,
sizeof(buffer)));
232BOOL rdp_write_security_header(rdpRdp* rdp,
wStream* s, UINT16 flags)
234 char buffer[256] = WINPR_C_ARRAY_INIT;
238 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 4))
241 WLog_Print(rdp->log, WLOG_TRACE,
"%s", rdp_security_flag_string(flags, buffer,
sizeof(buffer)));
243 WINPR_ASSERT((flags & SEC_FLAGSHI_VALID) == 0);
244 Stream_Write_UINT16(s, flags);
245 Stream_Write_UINT16(s, 0);
249BOOL rdp_read_share_control_header(rdpRdp* rdp,
wStream* s, UINT16* tpktLength,
250 UINT16* remainingLength, UINT16* type, UINT16* channel_id)
258 WINPR_ASSERT(channel_id);
260 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
264 Stream_Read_UINT16(s, len);
270 if (!rdp_read_flow_control_pdu(rdp, s, type, channel_id))
276 *remainingLength = 0;
278 char buffer[128] = WINPR_C_ARRAY_INIT;
279 WLog_Print(rdp->log, WLOG_DEBUG,
280 "[Flow control PDU] type=%s, tpktLength=%" PRIu16
", remainingLength=%" PRIu16,
281 pdu_type_to_str(*type, buffer,
sizeof(buffer)), tpktLength ? *tpktLength : 0u,
282 remainingLength ? *remainingLength : 0u);
288 WLog_Print(rdp->log, WLOG_ERROR,
289 "Invalid share control header, length is %" PRIu16
", must be >4", len);
296 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
299 Stream_Read_UINT16(s, tmp);
302 size_t remLen = len - 4;
305 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
308 Stream_Read_UINT16(s, *channel_id);
314 char buffer[128] = WINPR_C_ARRAY_INIT;
315 WLog_Print(rdp->log, WLOG_DEBUG,
"type=%s, tpktLength=%" PRIu16
", remainingLength=%" PRIuz,
316 pdu_type_to_str(*type, buffer,
sizeof(buffer)), len, remLen);
319 WINPR_ASSERT(remLen <= UINT16_MAX);
320 *remainingLength = (UINT16)remLen;
322 return Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, remLen);
325BOOL rdp_write_share_control_header(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 type,
330 if (length > UINT16_MAX)
333 if (length < RDP_PACKET_HEADER_MAX_LENGTH)
335 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 6))
337 length -= RDP_PACKET_HEADER_MAX_LENGTH;
339 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, length));
340 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, type | 0x10));
341 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, channel_id));
345BOOL rdp_read_share_data_header(rdpRdp* rdp,
wStream* s, UINT16* length, BYTE* type,
346 UINT32* shareId, BYTE* compressedType, UINT16* compressedLength)
351 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
355 Stream_Read_UINT32(s, *shareId);
356 Stream_Seek_UINT8(s);
357 Stream_Seek_UINT8(s);
358 Stream_Read_UINT16(s, *length);
359 Stream_Read_UINT8(s, *type);
360 Stream_Read_UINT8(s, *compressedType);
361 Stream_Read_UINT16(s, *compressedLength);
365BOOL rdp_write_share_data_header(rdpRdp* rdp,
wStream* s,
size_t length, BYTE type, UINT32 share_id)
367 const size_t headerLen = RDP_PACKET_HEADER_MAX_LENGTH + RDP_SHARE_CONTROL_HEADER_LENGTH +
368 RDP_SHARE_DATA_HEADER_LENGTH;
372 if (length > UINT16_MAX)
375 if (length < headerLen)
378 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 12))
382 Stream_Write_UINT32(s, share_id);
383 Stream_Write_UINT8(s, 0);
384 Stream_Write_UINT8(s, STREAM_LOW);
386 s, WINPR_ASSERTING_INT_CAST(uint16_t, length));
387 Stream_Write_UINT8(s, type);
388 Stream_Write_UINT8(s, 0);
389 Stream_Write_UINT16(s, 0);
393static BOOL rdp_security_stream_init(rdpRdp* rdp,
wStream* s, BOOL sec_header, UINT16* sec_flags)
397 WINPR_ASSERT(sec_flags);
401 if (!Stream_SafeSeek(s, 12))
404 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
406 if (!Stream_SafeSeek(s, 4))
410 *sec_flags |= SEC_ENCRYPT;
412 if (rdp->do_secure_checksum)
413 *sec_flags |= SEC_SECURE_CHECKSUM;
415 else if (*sec_flags != 0 || sec_header)
417 if (!Stream_SafeSeek(s, 4))
424wStream* rdp_send_stream_init(rdpRdp* rdp, UINT16* sec_flags)
429 WINPR_ASSERT(rdp->transport);
431 s = transport_send_stream_init(rdp->transport, 4096);
436 if (!Stream_SafeSeek(s, RDP_PACKET_HEADER_MAX_LENGTH))
439 if (!rdp_security_stream_init(rdp, s, FALSE, sec_flags))
448wStream* rdp_send_stream_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
450 wStream* s = rdp_send_stream_init(rdp, sec_flags);
455 if (!Stream_SafeSeek(s, RDP_SHARE_CONTROL_HEADER_LENGTH))
464wStream* rdp_data_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
466 wStream* s = rdp_send_stream_pdu_init(rdp, sec_flags);
471 if (!Stream_SafeSeek(s, RDP_SHARE_DATA_HEADER_LENGTH))
480BOOL rdp_set_error_info(rdpRdp* rdp, UINT32 errorInfo)
485 rdp->errorInfo = errorInfo;
487 if (rdp->errorInfo != ERRINFO_SUCCESS)
489 rdpContext* context = rdp->context;
490 WINPR_ASSERT(context);
492 rdp_print_errinfo(rdp->errorInfo);
496 freerdp_set_last_error_log(context, MAKE_FREERDP_ERROR(
ERRINFO, errorInfo));
500 ErrorInfoEventArgs e = WINPR_C_ARRAY_INIT;
501 EventArgsInit(&e,
"freerdp");
502 e.code = rdp->errorInfo;
503 rc = PubSub_OnErrorInfo(context->pubSub, context, &e) >= 0;
507 WLog_Print(rdp->log, WLOG_ERROR,
"missing context=%p", (
void*)context);
511 freerdp_set_last_error_log(rdp->context, FREERDP_ERROR_SUCCESS);
517wStream* rdp_message_channel_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
523 s = transport_send_stream_init(rdp->transport, 4096);
528 if (!Stream_SafeSeek(s, RDP_PACKET_HEADER_MAX_LENGTH))
531 if (!rdp_security_stream_init(rdp, s, TRUE, sec_flags))
550BOOL rdp_read_header(rdpRdp* rdp,
wStream* s, UINT16* length, UINT16* channelId)
555 UINT16 initiator = 0;
558 WINPR_ASSERT(rdp->settings);
560 DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataRequest
561 : DomainMCSPDU_SendDataIndication;
564 if (!tpkt_read_header(s, length))
567 if (!tpdu_read_header(s, &code, &li, *length))
570 if (code != X224_TPDU_DATA)
572 if (code == X224_TPDU_DISCONNECT_REQUEST)
574 WLog_Print(rdp->log, WLOG_WARN,
"Received X224_TPDU_DISCONNECT_REQUEST, terminating");
575 utils_abort_connect(rdp);
579 WLog_Print(rdp->log, WLOG_WARN,
580 "Unexpected X224 TPDU type %s [%08" PRIx32
"] instead of %s",
581 tpdu_type_to_string(code), code, tpdu_type_to_string(X224_TPDU_DATA));
585 if (!per_read_choice(s, &choice))
588 const DomainMCSPDU domainMCSPDU = (DomainMCSPDU)(choice >> 2);
590 if (domainMCSPDU != MCSPDU)
592 if (domainMCSPDU != DomainMCSPDU_DisconnectProviderUltimatum)
594 WLog_Print(rdp->log, WLOG_WARN,
"Received %s instead of %s",
595 mcs_domain_pdu_string(domainMCSPDU), mcs_domain_pdu_string(MCSPDU));
600 MCSPDU = domainMCSPDU;
604 WLog_Print(rdp->log, WLOG_WARN,
"TPDU invalid length, got %" PRIu16
", expected at least 8",
609 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length - 8))
612 if (MCSPDU == DomainMCSPDU_DisconnectProviderUltimatum)
615 TerminateEventArgs e = WINPR_C_ARRAY_INIT;
617 if (!mcs_recv_disconnect_provider_ultimatum(rdp->mcs, s, &reason))
620 rdpContext* context = rdp->context;
621 WINPR_ASSERT(context);
622 context->disconnectUltimatum = reason;
624 if (rdp->errorInfo == ERRINFO_SUCCESS)
631 UINT32 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
632 if (reason == Disconnect_Ultimatum_provider_initiated)
633 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
634 else if (reason == Disconnect_Ultimatum_user_requested)
635 errorInfo = ERRINFO_LOGOFF_BY_USER;
637 if (!rdp_set_error_info(rdp, errorInfo))
641 WLog_Print(rdp->log, WLOG_DEBUG,
"DisconnectProviderUltimatum: reason: %d", reason);
642 utils_abort_connect(rdp);
643 EventArgsInit(&e,
"freerdp");
645 return PubSub_OnTerminate(rdp->pubSub, context, &e) >= 0;
648 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 5))
651 if (!per_read_integer16(s, &initiator, MCS_BASE_CHANNEL_ID))
654 if (!per_read_integer16(s, channelId, 0))
657 const uint8_t dataPriority = Stream_Get_UINT8(s);
658 WLog_Print(rdp->log, WLOG_TRACE,
"dataPriority=%" PRIu8, dataPriority);
660 if (!per_read_length(s, length))
663 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length))
679BOOL rdp_write_header(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 channelId, UINT16 sec_flags)
682 WINPR_ASSERT(rdp->settings);
684 WINPR_ASSERT(length >= RDP_PACKET_HEADER_MAX_LENGTH);
685 if (length > UINT16_MAX)
688 DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataIndication
689 : DomainMCSPDU_SendDataRequest;
691 if ((sec_flags & SEC_ENCRYPT) && (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS))
693 const UINT16 body_length = (UINT16)length - RDP_PACKET_HEADER_MAX_LENGTH;
694 const UINT16 pad = 8 - (body_length % 8);
700 if (!mcs_write_domain_mcspdu_header(s, MCSPDU, (UINT16)length, 0))
702 if (!per_write_integer16(s, rdp->mcs->userId, MCS_BASE_CHANNEL_ID))
704 if (!per_write_integer16(s, channelId, 0))
706 if (!Stream_EnsureRemainingCapacity(s, 3))
708 Stream_Write_UINT8(s, 0x70);
715 length = (length - RDP_PACKET_HEADER_MAX_LENGTH) | 0x8000;
716 Stream_Write_UINT16_BE(
717 s, WINPR_ASSERTING_INT_CAST(uint16_t, length));
721static BOOL rdp_security_stream_out(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 sec_flags,
726 if (length > UINT16_MAX)
733 WINPR_ASSERT(sec_flags <= UINT16_MAX);
734 if (!rdp_write_security_header(rdp, s, sec_flags))
737 if (sec_flags & SEC_ENCRYPT)
739 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
741 BYTE* data = Stream_PointerAs(s, BYTE) + 12;
742 const size_t size = WINPR_ASSERTING_INT_CAST(
size_t, (data - Stream_Buffer(s)));
748 Stream_Write_UINT16(s, 0x10);
749 Stream_Write_UINT8(s, 0x1);
751 *pad = 8 - (length % 8);
757 memset(data + length, 0, *pad);
759 Stream_Write_UINT8(s, WINPR_ASSERTING_INT_CAST(uint8_t, *pad));
761 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
763 if (!security_hmac_signature(data, length, Stream_Pointer(s), 8, rdp))
767 if (!security_fips_encrypt(data, length + *pad, rdp))
772 const BYTE* data = Stream_PointerAs(s,
const BYTE) + 8;
773 const size_t diff = Stream_GetPosition(s) + 8ULL;
778 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
780 if (sec_flags & SEC_SECURE_CHECKSUM)
781 status = security_salted_mac_signature(rdp, data, (UINT32)length, TRUE,
782 Stream_Pointer(s), 8);
784 status = security_mac_signature(rdp, data, (UINT32)length,
785 Stream_PointerAs(s, BYTE), 8);
792 if (!security_encrypt(Stream_Pointer(s), length, rdp))
801static UINT32 rdp_get_sec_bytes(rdpRdp* rdp, UINT16 sec_flags)
803 UINT32 sec_bytes = 0;
805 if (sec_flags & SEC_ENCRYPT)
809 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
812 else if (sec_flags != 0)
824BOOL rdp_send(rdpRdp* rdp,
wStream* s, UINT16 channelId, UINT16 sec_flags)
828 BOOL should_unlock = FALSE;
836 if (sec_flags & SEC_ENCRYPT)
839 should_unlock = TRUE;
843 size_t length = Stream_GetPosition(s);
844 Stream_ResetPosition(s);
845 if (!rdp_write_header(rdp, s, length, channelId, sec_flags))
848 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
852 if (!Stream_SetPosition(s, length))
854 Stream_SealLength(s);
857 if (transport_write(rdp->transport, s) < 0)
863 security_unlock(rdp);
868BOOL rdp_send_pdu(rdpRdp* rdp,
wStream* s, UINT16 type, UINT16 channel_id, UINT16 sec_flags)
871 UINT32 sec_bytes = 0;
874 BOOL should_unlock = FALSE;
882 if (sec_flags & SEC_ENCRYPT)
885 should_unlock = TRUE;
889 size_t length = Stream_GetPosition(s);
890 Stream_ResetPosition(s);
891 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
893 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
894 sec_hold = Stream_GetPosition(s);
895 Stream_Seek(s, sec_bytes);
896 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, type, channel_id))
898 if (!Stream_SetPosition(s, sec_hold))
901 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
905 if (!Stream_SetPosition(s, length))
907 Stream_SealLength(s);
910 if (transport_write(rdp->transport, s) < 0)
916 security_unlock(rdp);
920BOOL rdp_send_data_pdu(rdpRdp* rdp,
wStream* s, BYTE type, UINT16 channel_id, UINT16 sec_flags)
923 UINT32 sec_bytes = 0;
926 BOOL should_unlock = FALSE;
934 if (sec_flags & SEC_ENCRYPT)
937 should_unlock = TRUE;
941 size_t length = Stream_GetPosition(s);
942 Stream_ResetPosition(s);
943 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
945 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
946 sec_hold = Stream_GetPosition(s);
947 Stream_Seek(s, sec_bytes);
948 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, PDU_TYPE_DATA, channel_id))
950 if (!rdp_write_share_data_header(rdp, s, length - sec_bytes, type, rdp->settings->ShareId))
952 if (!Stream_SetPosition(s, sec_hold))
955 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
959 if (!Stream_SetPosition(s, length))
961 Stream_SealLength(s);
963 WLog_Print(rdp->log, WLOG_DEBUG,
964 "sending data (type=0x%x size=%" PRIuz
" channelId=%" PRIu16
")", type,
965 Stream_Length(s), channel_id);
968 if (transport_write(rdp->transport, s) < 0)
974 security_unlock(rdp);
979BOOL rdp_send_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 sec_flags)
983 BOOL should_unlock = FALSE;
988 if (sec_flags & SEC_ENCRYPT)
991 should_unlock = TRUE;
995 size_t length = Stream_GetPosition(s);
996 Stream_ResetPosition(s);
997 if (!rdp_write_header(rdp, s, length, rdp->mcs->messageChannelId, sec_flags))
1000 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
1004 if (!Stream_SetPosition(s, length))
1007 Stream_SealLength(s);
1009 if (transport_write(rdp->transport, s) < 0)
1015 security_unlock(rdp);
1021static BOOL rdp_recv_server_shutdown_denied_pdu(WINPR_ATTR_UNUSED rdpRdp* rdp,
1027static BOOL rdp_recv_server_set_keyboard_indicators_pdu(rdpRdp* rdp,
wStream* s)
1032 rdpContext* context = rdp->context;
1033 WINPR_ASSERT(context);
1034 WINPR_ASSERT(context->update);
1036 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1039 const uint16_t unitId = Stream_Get_UINT16(s);
1042 WLog_Print(rdp->log, WLOG_WARN,
1043 "[MS-RDPBCGR] 2.2.8.2.1.1 Set Keyboard Indicators PDU Data "
1044 "(TS_SET_KEYBOARD_INDICATORS_PDU)::unitId should be 0, is %" PRIu16,
1047 const UINT16 ledFlags = Stream_Get_UINT16(s);
1048 return IFCALLRESULT(TRUE, context->update->SetKeyboardIndicators, context, ledFlags);
1051static BOOL rdp_recv_server_set_keyboard_ime_status_pdu(rdpRdp* rdp,
wStream* s)
1053 if (!rdp || !rdp->input)
1056 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 10))
1059 const uint16_t unitId = Stream_Get_UINT16(s);
1062 WLog_Print(rdp->log, WLOG_WARN,
1063 "[MS-RDPBCGR] 2.2.8.2.2.1 Set Keyboard IME Status PDU Data "
1064 "(TS_SET_KEYBOARD_IME_STATUS_PDU)::unitId should be 0, is %" PRIu16,
1067 const uint32_t imeState = Stream_Get_UINT32(s);
1068 const uint32_t imeConvMode = Stream_Get_UINT32(s);
1069 return IFCALLRESULT(TRUE, rdp->update->SetKeyboardImeStatus, rdp->context, unitId, imeState,
1073static BOOL rdp_recv_set_error_info_data_pdu(rdpRdp* rdp,
wStream* s)
1075 UINT32 errorInfo = 0;
1077 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1080 Stream_Read_UINT32(s, errorInfo);
1081 return rdp_set_error_info(rdp, errorInfo);
1084static BOOL rdp_recv_server_auto_reconnect_status_pdu(rdpRdp* rdp,
wStream* s)
1086 UINT32 arcStatus = 0;
1088 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1091 Stream_Read_UINT32(s, arcStatus);
1092 WLog_Print(rdp->log, WLOG_WARN,
"AutoReconnectStatus: 0x%08" PRIX32
"", arcStatus);
1096static BOOL rdp_recv_server_status_info_pdu(rdpRdp* rdp,
wStream* s)
1098 UINT32 statusCode = 0;
1100 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1103 Stream_Read_UINT32(s, statusCode);
1105 if (rdp->update->ServerStatusInfo)
1106 return rdp->update->ServerStatusInfo(rdp->context, statusCode);
1111static void log_monitor(
size_t idx,
const MONITOR_DEF* monitor, wLog* log, DWORD level)
1113 WINPR_ASSERT(monitor);
1115 WLog_Print(log, level,
"[%" PRIuz
"] {%dx%d-%dx%d} [0x%08" PRIx32
"]", idx, monitor->left,
1116 monitor->top, monitor->right, monitor->bottom, monitor->flags);
1119static void log_monitor_configuration(wLog* log,
const MONITOR_DEF* monitors,
size_t count)
1121 const DWORD level = WLOG_DEBUG;
1122 WLog_Print(log, level,
"[BEGIN] RemoteMonitors[%" PRIuz
"]", count);
1123 for (
size_t x = 0; x < count; x++)
1126 log_monitor(x, monitor, log, level);
1128 WLog_Print(log, level,
"[END] RemoteMonitors[%" PRIuz
"]", count);
1131static BOOL rdp_recv_monitor_layout_pdu(rdpRdp* rdp,
wStream* s)
1136 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1139 const UINT32 monitorCount = Stream_Get_UINT32(s);
1141 if (!Stream_CheckAndLogRequiredLengthOfSizeWLog(rdp->log, s, monitorCount, 20ull))
1146 if (!monitorDefArray)
1149 for (UINT32 index = 0; index < monitorCount; index++)
1152 Stream_Read_INT32(s, monitor->left);
1153 Stream_Read_INT32(s, monitor->top);
1154 Stream_Read_INT32(s, monitor->right);
1155 Stream_Read_INT32(s, monitor->bottom);
1156 Stream_Read_UINT32(s, monitor->flags);
1159 log_monitor_configuration(rdp->log, monitorDefArray, monitorCount);
1160 IFCALLRET(rdp->update->RemoteMonitors, ret, rdp->context, monitorCount, monitorDefArray);
1161 free(monitorDefArray);
1164 return rdp_set_monitor_layout_pdu_state(rdp, TRUE);
1167state_run_t rdp_recv_data_pdu(rdpRdp* rdp,
wStream* s)
1173 BYTE compressedType = 0;
1174 UINT16 compressedLength = 0;
1177 if (!rdp_read_share_data_header(rdp, s, &length, &type, &shareId, &compressedType,
1180 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_read_share_data_header() failed");
1181 return STATE_RUN_FAILED;
1186 if (compressedType & PACKET_COMPRESSED)
1188 if (compressedLength < 18)
1190 WLog_Print(rdp->log, WLOG_ERROR,
1191 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1193 return STATE_RUN_FAILED;
1197 const BYTE* pDstData =
nullptr;
1198 UINT16 SrcSize = compressedLength - 18;
1200 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, SrcSize))
1202 WLog_Print(rdp->log, WLOG_ERROR,
1203 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1205 return STATE_RUN_FAILED;
1208 if (bulk_decompress(rdp->bulk, Stream_ConstPointer(s), SrcSize, &pDstData, &DstSize,
1211 cs = transport_take_from_pool(rdp->transport, DstSize);
1214 WLog_Print(rdp->log, WLOG_ERROR,
"Couldn't take stream from pool");
1215 return STATE_RUN_FAILED;
1218 Stream_ResetPosition(cs);
1219 Stream_Write(cs, pDstData, DstSize);
1220 Stream_SealLength(cs);
1221 Stream_ResetPosition(cs);
1225 WLog_Print(rdp->log, WLOG_ERROR,
"bulk_decompress() failed");
1226 return STATE_RUN_FAILED;
1229 Stream_Seek(s, SrcSize);
1232 WLog_Print(rdp->log, WLOG_DEBUG,
"recv %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1233 data_pdu_type_to_string(type), type, length);
1237 case DATA_PDU_TYPE_UPDATE:
1238 if (!update_recv(rdp->update, cs))
1240 WLog_Print(rdp->log, WLOG_ERROR,
"DATA_PDU_TYPE_UPDATE - update_recv() failed");
1246 case DATA_PDU_TYPE_CONTROL:
1247 if (!rdp_recv_server_control_pdu(rdp, cs))
1249 WLog_Print(rdp->log, WLOG_ERROR,
1250 "DATA_PDU_TYPE_CONTROL - rdp_recv_server_control_pdu() failed");
1256 case DATA_PDU_TYPE_POINTER:
1257 if (!update_recv_pointer(rdp->update, cs))
1259 WLog_Print(rdp->log, WLOG_ERROR,
1260 "DATA_PDU_TYPE_POINTER - update_recv_pointer() failed");
1266 case DATA_PDU_TYPE_SYNCHRONIZE:
1267 if (!rdp_recv_server_synchronize_pdu(rdp, cs))
1269 WLog_Print(rdp->log, WLOG_ERROR,
1270 "DATA_PDU_TYPE_SYNCHRONIZE - rdp_recv_synchronize_pdu() failed");
1276 case DATA_PDU_TYPE_PLAY_SOUND:
1277 if (!update_recv_play_sound(rdp->update, cs))
1279 WLog_Print(rdp->log, WLOG_ERROR,
1280 "DATA_PDU_TYPE_PLAY_SOUND - update_recv_play_sound() failed");
1286 case DATA_PDU_TYPE_SHUTDOWN_DENIED:
1287 if (!rdp_recv_server_shutdown_denied_pdu(rdp, cs))
1290 rdp->log, WLOG_ERROR,
1291 "DATA_PDU_TYPE_SHUTDOWN_DENIED - rdp_recv_server_shutdown_denied_pdu() failed");
1297 case DATA_PDU_TYPE_SAVE_SESSION_INFO:
1298 if (!rdp_recv_save_session_info(rdp, cs))
1300 WLog_Print(rdp->log, WLOG_ERROR,
1301 "DATA_PDU_TYPE_SAVE_SESSION_INFO - rdp_recv_save_session_info() failed");
1307 case DATA_PDU_TYPE_FONT_MAP:
1308 if (!rdp_recv_font_map_pdu(rdp, cs))
1310 WLog_Print(rdp->log, WLOG_ERROR,
1311 "DATA_PDU_TYPE_FONT_MAP - rdp_recv_font_map_pdu() failed");
1317 case DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS:
1318 if (!rdp_recv_server_set_keyboard_indicators_pdu(rdp, cs))
1320 WLog_Print(rdp->log, WLOG_ERROR,
1321 "DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS - "
1322 "rdp_recv_server_set_keyboard_indicators_pdu() failed");
1328 case DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS:
1329 if (!rdp_recv_server_set_keyboard_ime_status_pdu(rdp, cs))
1331 WLog_Print(rdp->log, WLOG_ERROR,
1332 "DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS - "
1333 "rdp_recv_server_set_keyboard_ime_status_pdu() failed");
1339 case DATA_PDU_TYPE_SET_ERROR_INFO:
1340 if (!rdp_recv_set_error_info_data_pdu(rdp, cs))
1343 rdp->log, WLOG_ERROR,
1344 "DATA_PDU_TYPE_SET_ERROR_INFO - rdp_recv_set_error_info_data_pdu() failed");
1350 case DATA_PDU_TYPE_ARC_STATUS:
1351 if (!rdp_recv_server_auto_reconnect_status_pdu(rdp, cs))
1353 WLog_Print(rdp->log, WLOG_ERROR,
1354 "DATA_PDU_TYPE_ARC_STATUS - "
1355 "rdp_recv_server_auto_reconnect_status_pdu() failed");
1361 case DATA_PDU_TYPE_STATUS_INFO:
1362 if (!rdp_recv_server_status_info_pdu(rdp, cs))
1364 WLog_Print(rdp->log, WLOG_ERROR,
1365 "DATA_PDU_TYPE_STATUS_INFO - rdp_recv_server_status_info_pdu() failed");
1371 case DATA_PDU_TYPE_MONITOR_LAYOUT:
1372 if (!rdp_recv_monitor_layout_pdu(rdp, cs))
1374 WLog_Print(rdp->log, WLOG_ERROR,
1375 "DATA_PDU_TYPE_MONITOR_LAYOUT - rdp_recv_monitor_layout_pdu() failed");
1382 WLog_Print(rdp->log, WLOG_WARN,
1383 "[UNHANDLED] %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1384 data_pdu_type_to_string(type), type, length);
1391 return STATE_RUN_SUCCESS;
1397 return STATE_RUN_FAILED;
1400state_run_t rdp_recv_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 securityFlags)
1405 if (securityFlags & SEC_AUTODETECT_REQ)
1408 return autodetect_recv_request_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1411 if (securityFlags & SEC_AUTODETECT_RSP)
1414 return autodetect_recv_response_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1417 if (securityFlags & SEC_HEARTBEAT)
1420 return rdp_recv_heartbeat_packet(rdp, s);
1423 if (securityFlags & SEC_TRANSPORT_REQ)
1425 return multitransport_recv_request(rdp->multitransport, s);
1428 if (securityFlags & SEC_TRANSPORT_RSP)
1430 return multitransport_recv_response(rdp->multitransport, s);
1433 if (securityFlags & SEC_LICENSE_PKT)
1435 return license_recv(rdp->license, s);
1438 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
1440 return license_recv(rdp->license, s);
1443 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
1445 return license_recv(rdp->license, s);
1448 return STATE_RUN_SUCCESS;
1451state_run_t rdp_recv_out_of_sequence_pdu(rdpRdp* rdp,
wStream* s, UINT16 pduType, UINT16 length)
1453 state_run_t rc = STATE_RUN_FAILED;
1459 rc = rdp_recv_data_pdu(rdp, s);
1461 case PDU_TYPE_SERVER_REDIRECTION:
1462 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1464 case PDU_TYPE_FLOW_RESPONSE:
1465 case PDU_TYPE_FLOW_STOP:
1466 case PDU_TYPE_FLOW_TEST:
1467 rc = STATE_RUN_SUCCESS;
1471 char buffer1[256] = WINPR_C_ARRAY_INIT;
1472 char buffer2[256] = WINPR_C_ARRAY_INIT;
1474 WLog_Print(rdp->log, WLOG_ERROR,
"expected %s, got %s",
1475 pdu_type_to_str(PDU_TYPE_DEMAND_ACTIVE, buffer1,
sizeof(buffer1)),
1476 pdu_type_to_str(pduType, buffer2,
sizeof(buffer2)));
1477 rc = STATE_RUN_FAILED;
1482 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1483 return STATE_RUN_FAILED;
1487BOOL rdp_read_flow_control_pdu(rdpRdp* rdp,
wStream* s, UINT16* type, UINT16* channel_id)
1501 WINPR_ASSERT(channel_id);
1503 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 6))
1505 Stream_Read_UINT8(s, pduType);
1507 Stream_Seek_UINT8(s);
1508 Stream_Seek_UINT8(s);
1509 Stream_Seek_UINT8(s);
1510 Stream_Read_UINT16(s, *channel_id);
1525BOOL rdp_decrypt(rdpRdp* rdp,
wStream* s, UINT16* pLength, UINT16 securityFlags)
1528 BYTE cmac[8] = WINPR_C_ARRAY_INIT;
1529 BYTE wmac[8] = WINPR_C_ARRAY_INIT;
1530 BOOL status = FALSE;
1533 WINPR_ASSERT(rdp->settings);
1535 WINPR_ASSERT(pLength);
1539 INT32 length = *pLength;
1540 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_NONE)
1546 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
1548 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
1552 Stream_Read_UINT16(s, len);
1554 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS length %" PRIu16
" != 0x10",
1558 Stream_Read_UINT8(s, version);
1560 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS version %" PRIu16
" != 1",
1564 Stream_Read_UINT8(s, pad);
1565 const BYTE* sig = Stream_ConstPointer(s);
1568 const INT32 padLength = length - pad;
1570 if ((length <= 0) || (padLength <= 0) || (padLength > UINT16_MAX))
1572 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid pad length %" PRId32, padLength);
1576 if (!security_fips_decrypt(Stream_Pointer(s), (
size_t)length, rdp))
1579 if (!security_fips_check_signature(Stream_ConstPointer(s), (
size_t)padLength, sig, 8, rdp))
1582 if (!Stream_SetLength(s, Stream_Length(s) - pad))
1585 *pLength = (UINT16)padLength;
1589 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s,
sizeof(wmac)))
1592 Stream_Read(s, wmac,
sizeof(wmac));
1593 length -=
sizeof(wmac);
1597 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid length field");
1601 if (!security_decrypt(Stream_PointerAs(s, BYTE), (
size_t)length, rdp))
1604 if (securityFlags & SEC_SECURE_CHECKSUM)
1605 status = security_salted_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length,
1606 FALSE, cmac,
sizeof(cmac));
1608 status = security_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length, cmac,
1614 if (memcmp(wmac, cmac,
sizeof(wmac)) != 0)
1616 WLog_Print(rdp->log, WLOG_ERROR,
"WARNING: invalid packet signature");
1627 *pLength = (UINT16)length;
1631 security_unlock(rdp);
1635const char* pdu_type_to_str(UINT16 pduType,
char* buffer,
size_t length)
1637 const char* str =
nullptr;
1640 case PDU_TYPE_DEMAND_ACTIVE:
1641 str =
"PDU_TYPE_DEMAND_ACTIVE";
1643 case PDU_TYPE_CONFIRM_ACTIVE:
1644 str =
"PDU_TYPE_CONFIRM_ACTIVE";
1646 case PDU_TYPE_DEACTIVATE_ALL:
1647 str =
"PDU_TYPE_DEACTIVATE_ALL";
1650 str =
"PDU_TYPE_DATA";
1652 case PDU_TYPE_SERVER_REDIRECTION:
1653 str =
"PDU_TYPE_SERVER_REDIRECTION";
1655 case PDU_TYPE_FLOW_TEST:
1656 str =
"PDU_TYPE_FLOW_TEST";
1658 case PDU_TYPE_FLOW_RESPONSE:
1659 str =
"PDU_TYPE_FLOW_RESPONSE";
1661 case PDU_TYPE_FLOW_STOP:
1662 str =
"PDU_TYPE_FLOW_STOP";
1665 str =
"PDU_TYPE_UNKNOWN";
1669 winpr_str_append(str, buffer, length,
"");
1671 char msg[32] = WINPR_C_ARRAY_INIT;
1672 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", pduType);
1673 winpr_str_append(msg, buffer, length,
"");
1684static state_run_t rdp_recv_tpkt_pdu(rdpRdp* rdp,
wStream* s)
1686 state_run_t rc = STATE_RUN_SUCCESS;
1689 UINT16 pduSource = 0;
1690 UINT16 channelId = 0;
1691 UINT16 securityFlags = 0;
1694 WINPR_ASSERT(rdp->context);
1697 freerdp* instance = rdp->context->instance;
1698 WINPR_ASSERT(instance);
1700 if (!rdp_read_header(rdp, s, &length, &channelId))
1701 return STATE_RUN_FAILED;
1703 if (freerdp_shall_disconnect_context(rdp->context))
1704 return STATE_RUN_SUCCESS;
1706 if (rdp->autodetect->bandwidthMeasureStarted)
1708 rdp->autodetect->bandwidthMeasureByteCount += length;
1711 if (rdp->mcs->messageChannelId && (channelId == rdp->mcs->messageChannelId))
1714 return rdp_handle_message_channel(rdp, s, channelId, length);
1717 if (rdp->settings->UseRdpSecurityLayer)
1719 if (!rdp_read_security_header(rdp, s, &securityFlags, &length))
1720 return STATE_RUN_FAILED;
1722 if (securityFlags & (SEC_ENCRYPT | SEC_REDIRECTION_PKT))
1724 if (!rdp_decrypt(rdp, s, &length, securityFlags))
1725 return STATE_RUN_FAILED;
1728 if (securityFlags & SEC_REDIRECTION_PKT)
1734 Stream_Rewind(s, 2);
1737 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1742 if (channelId == MCS_GLOBAL_CHANNEL_ID)
1744 while (Stream_GetRemainingLength(s) > 3)
1751 if (!rdp_read_share_control_header(rdp, s,
nullptr, &remain, &pduType, &pduSource))
1752 return STATE_RUN_FAILED;
1754 sub = Stream_StaticInit(&subbuffer, Stream_Pointer(s), remain);
1755 if (!Stream_SafeSeek(s, remain))
1756 return STATE_RUN_FAILED;
1758 rdp->settings->PduSource = pduSource;
1764 rc = rdp_recv_data_pdu(rdp, sub);
1765 if (state_run_failed(rc))
1769 case PDU_TYPE_DEACTIVATE_ALL:
1770 if (!rdp_recv_deactivate_all(rdp, sub))
1772 WLog_Print(rdp->log, WLOG_ERROR,
1773 "rdp_recv_tpkt_pdu: rdp_recv_deactivate_all() fail");
1774 return STATE_RUN_FAILED;
1779 case PDU_TYPE_SERVER_REDIRECTION:
1780 return rdp_recv_enhanced_security_redirection_packet(rdp, sub);
1782 case PDU_TYPE_FLOW_RESPONSE:
1783 case PDU_TYPE_FLOW_STOP:
1784 case PDU_TYPE_FLOW_TEST:
1785 WLog_Print(rdp->log, WLOG_DEBUG,
"flow message 0x%04" PRIX16
"", pduType);
1787 if (!Stream_SafeSeek(sub, remain))
1788 return STATE_RUN_FAILED;
1793 char buffer[256] = WINPR_C_ARRAY_INIT;
1794 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect PDU type: %s",
1795 pdu_type_to_str(pduType, buffer,
sizeof(buffer)));
1800 diff = Stream_GetRemainingLength(sub);
1803 char buffer[256] = WINPR_C_ARRAY_INIT;
1804 WLog_Print(rdp->log, WLOG_WARN,
1805 "pduType %s not properly parsed, %" PRIuz
1806 " bytes remaining unhandled. Skipping.",
1807 pdu_type_to_str(pduType, buffer,
sizeof(buffer)), diff);
1815 if (!freerdp_channel_process(instance, s, channelId, length))
1816 return STATE_RUN_FAILED;
1820 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1821 return STATE_RUN_FAILED;
1825static state_run_t rdp_recv_fastpath_pdu(rdpRdp* rdp,
wStream* s)
1830 rdpFastPath* fastpath = rdp->fastpath;
1832 if (!fastpath_read_header_rdp(fastpath, s, &length))
1834 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_recv_fastpath_pdu: fastpath_read_header_rdp() fail");
1835 return STATE_RUN_FAILED;
1838 if ((length == 0) || (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, length)))
1840 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect FastPath PDU header length %" PRIu16
"",
1842 return STATE_RUN_FAILED;
1845 if (rdp->autodetect->bandwidthMeasureStarted)
1847 rdp->autodetect->bandwidthMeasureByteCount += length;
1850 if (!fastpath_decrypt(fastpath, s, &length))
1851 return STATE_RUN_FAILED;
1853 return fastpath_recv_updates(rdp->fastpath, s);
1856static state_run_t rdp_recv_pdu(rdpRdp* rdp,
wStream* s)
1858 const int rc = tpkt_verify_header(s);
1860 return rdp_recv_tpkt_pdu(rdp, s);
1862 return rdp_recv_fastpath_pdu(rdp, s);
1864 return STATE_RUN_FAILED;
1867static state_run_t rdp_handle_sc_flags(rdpRdp* rdp,
wStream* s, UINT32 flag,
1868 CONNECTION_STATE nextState)
1870 const UINT32 mask = FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
1871 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU;
1873 state_run_t status = rdp_recv_pdu(rdp, s);
1874 if (state_run_success(status))
1876 const UINT32 flags = rdp->finalize_sc_pdus & mask;
1877 if ((flags & flag) == flag)
1879 if (!rdp_client_transition_to_state(rdp, nextState))
1880 status = STATE_RUN_FAILED;
1882 status = STATE_RUN_SUCCESS;
1886 char flag_buffer[256] = WINPR_C_ARRAY_INIT;
1887 char mask_buffer[256] = WINPR_C_ARRAY_INIT;
1888 WLog_Print(rdp->log, WLOG_WARN,
1889 "[%s] unexpected server message, expected flag %s [have %s]",
1890 rdp_get_state_string(rdp),
1891 rdp_finalize_flags_to_str(flag, flag_buffer,
sizeof(flag_buffer)),
1892 rdp_finalize_flags_to_str(flags, mask_buffer,
sizeof(mask_buffer)));
1898static state_run_t rdp_client_exchange_monitor_layout(rdpRdp* rdp,
wStream* s)
1902 if (!rdp_check_monitor_layout_pdu_state(rdp, FALSE))
1903 return STATE_RUN_FAILED;
1908 const UINT32 old = rdp->finalize_sc_pdus;
1909 state_run_t status = rdp_recv_pdu(rdp, s);
1910 const UINT32 now = rdp->finalize_sc_pdus;
1911 const BOOL changed = (old != now) || rdp->monitor_layout_pdu;
1914 if (state_run_success(status) && changed)
1916 if (!rdp->monitor_layout_pdu)
1918 if (!rdp_finalize_is_flag_set(rdp, FINALIZE_SC_SYNCHRONIZE_PDU))
1919 return STATE_RUN_FAILED;
1922 status = rdp_client_connect_finalize(rdp);
1923 if (state_run_success(status) && !rdp->monitor_layout_pdu)
1924 status = STATE_RUN_TRY_AGAIN;
1929static state_run_t rdp_recv_callback_int(WINPR_ATTR_UNUSED rdpTransport* transport,
wStream* s,
1932 state_run_t status = STATE_RUN_SUCCESS;
1933 rdpRdp* rdp = (rdpRdp*)extra;
1935 WINPR_ASSERT(transport);
1939 switch (rdp_get_state(rdp))
1941 case CONNECTION_STATE_NEGO:
1942 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1943 status = STATE_RUN_FAILED;
1945 status = STATE_RUN_CONTINUE;
1947 case CONNECTION_STATE_NLA:
1948 if (nla_get_state(rdp->nla) < NLA_STATE_AUTH_INFO)
1950 if (nla_recv_pdu(rdp->nla, s) < 1)
1952 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nla_recv_pdu() fail",
1953 rdp_get_state_string(rdp));
1954 status = STATE_RUN_FAILED;
1957 else if (nla_get_state(rdp->nla) == NLA_STATE_POST_NEGO)
1959 if (nego_recv(rdp->transport, s, (
void*)rdp->nego) < 0)
1960 return STATE_RUN_FAILED;
1962 if (!nego_update_settings_from_state(rdp->nego, rdp->settings))
1963 return STATE_RUN_FAILED;
1965 if (nego_get_state(rdp->nego) != NEGO_STATE_FINAL)
1967 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nego_recv() fail",
1968 rdp_get_state_string(rdp));
1969 status = STATE_RUN_FAILED;
1971 else if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
1972 status = STATE_RUN_FAILED;
1975 if (state_run_success(status))
1977 if (nla_get_state(rdp->nla) == NLA_STATE_AUTH_INFO)
1979 transport_set_nla_mode(rdp->transport, FALSE);
1981 if (rdp->settings->VmConnectMode)
1983 if (!nego_set_state(rdp->nego, NEGO_STATE_NLA))
1984 status = STATE_RUN_FAILED;
1985 else if (!nego_set_requested_protocols(rdp->nego,
1986 PROTOCOL_HYBRID | PROTOCOL_SSL))
1987 status = STATE_RUN_FAILED;
1988 else if (!nego_send_negotiation_request(rdp->nego))
1989 status = STATE_RUN_FAILED;
1990 else if (!nla_set_state(rdp->nla, NLA_STATE_POST_NEGO))
1991 status = STATE_RUN_FAILED;
1995 if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
1996 status = STATE_RUN_FAILED;
2000 if (state_run_success(status))
2003 if (nla_get_state(rdp->nla) == NLA_STATE_FINAL)
2005 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
2006 status = STATE_RUN_FAILED;
2008 status = STATE_RUN_CONTINUE;
2013 case CONNECTION_STATE_AAD:
2014 if (aad_recv(rdp->aad, s) < 1)
2016 WLog_Print(rdp->log, WLOG_ERROR,
"%s - aad_recv() fail", rdp_get_state_string(rdp));
2017 status = STATE_RUN_FAILED;
2019 if (state_run_success(status))
2021 if (aad_get_state(rdp->aad) == AAD_STATE_FINAL)
2023 transport_set_aad_mode(rdp->transport, FALSE);
2024 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
2025 status = STATE_RUN_FAILED;
2027 status = STATE_RUN_CONTINUE;
2032 case CONNECTION_STATE_MCS_CREATE_REQUEST:
2033 if (!mcs_client_begin(rdp->mcs))
2035 WLog_Print(rdp->log, WLOG_ERROR,
"%s - mcs_client_begin() fail",
2036 rdp_get_state_string(rdp));
2037 status = STATE_RUN_FAILED;
2039 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_RESPONSE))
2040 status = STATE_RUN_FAILED;
2041 else if (Stream_GetRemainingLength(s) > 0)
2042 status = STATE_RUN_CONTINUE;
2045 case CONNECTION_STATE_MCS_CREATE_RESPONSE:
2046 if (!mcs_recv_connect_response(rdp->mcs, s))
2048 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_connect_response failure");
2049 status = STATE_RUN_FAILED;
2053 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ERECT_DOMAIN))
2054 status = STATE_RUN_FAILED;
2055 else if (!mcs_send_erect_domain_request(rdp->mcs))
2057 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_erect_domain_request failure");
2058 status = STATE_RUN_FAILED;
2060 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ATTACH_USER))
2061 status = STATE_RUN_FAILED;
2062 else if (!mcs_send_attach_user_request(rdp->mcs))
2064 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_attach_user_request failure");
2065 status = STATE_RUN_FAILED;
2067 else if (!rdp_client_transition_to_state(rdp,
2068 CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM))
2069 status = STATE_RUN_FAILED;
2073 case CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM:
2074 if (!mcs_recv_attach_user_confirm(rdp->mcs, s))
2076 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_attach_user_confirm failure");
2077 status = STATE_RUN_FAILED;
2081 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST))
2082 status = STATE_RUN_FAILED;
2083 else if (!mcs_send_channel_join_request(rdp->mcs, rdp->mcs->userId))
2085 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_channel_join_request failure");
2086 status = STATE_RUN_FAILED;
2088 else if (!rdp_client_transition_to_state(
2089 rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE))
2090 status = STATE_RUN_FAILED;
2095 if (!rdp_client_skip_mcs_channel_join(rdp))
2096 status = STATE_RUN_FAILED;
2100 case CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE:
2101 if (!rdp_client_connect_mcs_channel_join_confirm(rdp, s))
2103 WLog_Print(rdp->log, WLOG_ERROR,
2105 "rdp_client_connect_mcs_channel_join_confirm() fail",
2106 rdp_get_state_string(rdp));
2107 status = STATE_RUN_FAILED;
2112 case CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST:
2113 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2115 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_LICENSING))
2116 status = STATE_RUN_FAILED;
2118 status = STATE_RUN_TRY_AGAIN;
2122 case CONNECTION_STATE_LICENSING:
2123 status = rdp_client_connect_license(rdp, s);
2125 if (state_run_failed(status))
2127 char buffer[64] = WINPR_C_ARRAY_INIT;
2128 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_client_connect_license() - %s",
2129 rdp_get_state_string(rdp),
2130 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2135 case CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST:
2136 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2138 if (!rdp_client_transition_to_state(
2139 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE))
2140 status = STATE_RUN_FAILED;
2142 status = STATE_RUN_TRY_AGAIN;
2146 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE:
2147 status = rdp_client_connect_demand_active(rdp, s);
2149 if (state_run_failed(status))
2151 char buffer[64] = WINPR_C_ARRAY_INIT;
2152 WLog_Print(rdp->log, WLOG_DEBUG,
2154 "rdp_client_connect_demand_active() - %s",
2155 rdp_get_state_string(rdp),
2156 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2158 else if (status == STATE_RUN_ACTIVE)
2160 if (!rdp_client_transition_to_state(
2161 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE))
2162 status = STATE_RUN_FAILED;
2164 status = STATE_RUN_CONTINUE;
2168 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT:
2169 status = rdp_client_exchange_monitor_layout(rdp, s);
2172 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE:
2173 status = rdp_client_connect_confirm_active(rdp, s);
2176 case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
2177 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_SYNCHRONIZE_PDU,
2178 CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE);
2180 case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
2181 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_COOPERATE_PDU,
2182 CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL);
2184 case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
2185 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_GRANTED_PDU,
2186 CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP);
2188 case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
2189 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_FONT_MAP_PDU, CONNECTION_STATE_ACTIVE);
2192 case CONNECTION_STATE_ACTIVE:
2193 status = rdp_recv_pdu(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_recv_pdu() - %s",
2199 rdp_get_state_string(rdp),
2200 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2205 WLog_Print(rdp->log, WLOG_ERROR,
"%s state %u", rdp_get_state_string(rdp),
2206 rdp_get_state(rdp));
2207 status = STATE_RUN_FAILED;
2211 if (state_run_failed(status))
2213 char buffer[64] = WINPR_C_ARRAY_INIT;
2214 WLog_Print(rdp->log, WLOG_ERROR,
"%s status %s", rdp_get_state_string(rdp),
2215 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2220state_run_t rdp_recv_callback(rdpTransport* transport,
wStream* s,
void* extra)
2222 char buffer[64] = WINPR_C_ARRAY_INIT;
2223 state_run_t rc = STATE_RUN_FAILED;
2224 const size_t start = Stream_GetPosition(s);
2225 const rdpContext* context = transport_get_context(transport);
2227 WINPR_ASSERT(context);
2230 const rdpRdp* rdp = context->rdp;
2233 if (rc == STATE_RUN_TRY_AGAIN)
2235 if (!Stream_SetPosition(s, start))
2236 return STATE_RUN_FAILED;
2239 const char* old = rdp_get_state_string(rdp);
2240 const size_t orem = Stream_GetRemainingLength(s);
2241 rc = rdp_recv_callback_int(transport, s, extra);
2243 const char* now = rdp_get_state_string(rdp);
2244 const size_t rem = Stream_GetRemainingLength(s);
2246 WLog_Print(rdp->log, WLOG_TRACE,
2247 "(client)[%s -> %s] current return %s [feeding %" PRIuz
" bytes, %" PRIuz
2248 " bytes not processed]",
2249 old, now, state_run_result_string(rc, buffer,
sizeof(buffer)), orem, rem);
2250 }
while ((rc == STATE_RUN_TRY_AGAIN) || (rc == STATE_RUN_CONTINUE));
2254BOOL rdp_send_channel_data(rdpRdp* rdp, UINT16 channelId,
const BYTE* data,
size_t size)
2256 return freerdp_channel_send(rdp, channelId, data, size);
2259BOOL rdp_channel_send_packet(rdpRdp* rdp, UINT16 channelId,
size_t totalSize, UINT32 flags,
2260 const BYTE* data,
size_t chunkSize)
2262 return freerdp_channel_send_packet(rdp, channelId, totalSize, flags, data, chunkSize);
2265BOOL rdp_send_error_info(rdpRdp* rdp)
2267 UINT16 sec_flags = 0;
2271 if (rdp->errorInfo == ERRINFO_SUCCESS)
2274 s = rdp_data_pdu_init(rdp, &sec_flags);
2279 Stream_Write_UINT32(s, rdp->errorInfo);
2280 status = rdp_send_data_pdu(rdp, s, DATA_PDU_TYPE_SET_ERROR_INFO, 0, sec_flags);
2284int rdp_check_fds(rdpRdp* rdp)
2287 rdpTsg* tsg =
nullptr;
2288 rdpTransport* transport =
nullptr;
2291 transport = rdp->transport;
2293 tsg = transport_get_tsg(transport);
2296 if (!tsg_check_event_handles(tsg))
2298 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_check_fds: tsg_check_event_handles()");
2302 if (tsg_get_state(tsg) != TSG_STATE_PIPE_CREATED)
2306 status = transport_check_fds(transport);
2310 if (!rdp_client_redirect(rdp))
2315 WLog_Print(rdp->log, WLOG_DEBUG,
"transport_check_fds() - %i", status);
2317 status = freerdp_timer_poll(rdp->timer);
2322BOOL freerdp_get_stats(
const rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes, UINT64* inPackets,
2329 *inBytes = rdp->inBytes;
2331 *outBytes = rdp->outBytes;
2333 *inPackets = rdp->inPackets;
2335 *outPackets = rdp->outPackets;
2340static bool rdp_new_common(rdpRdp* rdp)
2345 rdp->transport = transport_new(rdp->context);
2346 if (!rdp->transport)
2351 if (!transport_set_io_callbacks(rdp->transport, rdp->io))
2355 rdp->aad = aad_new(rdp->context);
2359 rdp->nego = nego_new(rdp->transport);
2363 rdp->mcs = mcs_new(rdp->context);
2367 rdp->license = license_new(rdp);
2371 rdp->fastpath = fastpath_new(rdp);
2385rdpRdp* rdp_new(rdpContext* context)
2388 rdpRdp* rdp = (rdpRdp*)calloc(1,
sizeof(rdpRdp));
2393 rdp->log = WLog_Create(RDP_TAG, WLog_GetRoot());
2397 (void)_snprintf(rdp->log_context,
sizeof(rdp->log_context),
"%p", (
void*)context);
2398 if (!WLog_SetContext(rdp->log,
nullptr, rdp->log_context))
2401 InitializeCriticalSection(&rdp->critical);
2402 rdp->context = context;
2403 WINPR_ASSERT(rdp->context);
2405 if (context->ServerMode)
2408 if (!context->settings)
2416 rdp->settings = context->settings;
2419 if (!rdp_set_backup_settings(rdp))
2422 rdp->settings->instance = context->instance;
2424 context->settings = rdp->settings;
2425 if (context->instance)
2426 context->settings->instance = context->instance;
2427 else if (context->peer)
2429 rdp->settings->instance = context->peer;
2431#if defined(WITH_FREERDP_DEPRECATED)
2432 context->peer->settings = rdp->settings;
2436 if (!rdp_new_common(rdp))
2440 const rdpTransportIo* io = transport_get_io_callbacks(rdp->transport);
2443 rdp->io = calloc(1,
sizeof(rdpTransportIo));
2449 rdp->input = input_new(rdp);
2454 rdp->update = update_new(rdp);
2459 rdp->redirection = redirection_new();
2461 if (!rdp->redirection)
2464 rdp->autodetect = autodetect_new(rdp->context);
2466 if (!rdp->autodetect)
2469 rdp->heartbeat = heartbeat_new();
2471 if (!rdp->heartbeat)
2474 rdp->multitransport = multitransport_new(rdp, INITIATE_REQUEST_PROTOCOL_UDPFECL |
2475 INITIATE_REQUEST_PROTOCOL_UDPFECR);
2477 if (!rdp->multitransport)
2480 rdp->bulk = bulk_new(context);
2485 rdp->pubSub = PubSub_New(TRUE);
2489 rdp->abortEvent = CreateEvent(
nullptr, TRUE, FALSE,
nullptr);
2490 if (!rdp->abortEvent)
2493 rdp->timer = freerdp_timer_new(rdp);
2500 WINPR_PRAGMA_DIAG_PUSH
2501 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2503 WINPR_PRAGMA_DIAG_POP
2507static void rdp_reset_free(rdpRdp* rdp)
2512 rdp_free_rc4_decrypt_keys(rdp);
2513 rdp_free_rc4_encrypt_keys(rdp);
2515 winpr_Cipher_Free(rdp->fips_encrypt);
2516 winpr_Cipher_Free(rdp->fips_decrypt);
2517 rdp->fips_encrypt =
nullptr;
2518 rdp->fips_decrypt =
nullptr;
2519 security_unlock(rdp);
2523 nego_free(rdp->nego);
2524 license_free(rdp->license);
2525 transport_free(rdp->transport);
2526 fastpath_free(rdp->fastpath);
2530 rdp->nego =
nullptr;
2531 rdp->license =
nullptr;
2532 rdp->transport =
nullptr;
2533 rdp->fastpath =
nullptr;
2536BOOL rdp_reset(rdpRdp* rdp)
2542 rdpSettings* settings = rdp->settings;
2543 WINPR_ASSERT(settings);
2545 bulk_reset(rdp->bulk);
2547 rdp_reset_free(rdp);
2561 rc = rdp_new_common(rdp);
2565 if (!transport_set_layer(rdp->transport, TRANSPORT_LAYER_TCP))
2569 rc = rdp_finalize_reset_flags(rdp, TRUE);
2580void rdp_free(rdpRdp* rdp)
2584 freerdp_timer_free(rdp->timer);
2585 rdp_reset_free(rdp);
2591 input_free(rdp->input);
2592 update_free(rdp->update);
2594 redirection_free(rdp->redirection);
2595 autodetect_free(rdp->autodetect);
2596 heartbeat_free(rdp->heartbeat);
2597 multitransport_free(rdp->multitransport);
2598 bulk_free(rdp->bulk);
2600 PubSub_Free(rdp->pubSub);
2601 if (rdp->abortEvent)
2602 (void)CloseHandle(rdp->abortEvent);
2605 DeleteCriticalSection(&rdp->critical);
2606 WLog_Discard(rdp->log);
2611BOOL rdp_io_callback_set_event(rdpRdp* rdp, BOOL set)
2615 return transport_io_callback_set_event(rdp->transport, set);
2618const rdpTransportIo* rdp_get_io_callbacks(rdpRdp* rdp)
2625BOOL rdp_set_io_callbacks(rdpRdp* rdp,
const rdpTransportIo* io_callbacks)
2633 rdp->io = malloc(
sizeof(rdpTransportIo));
2636 *rdp->io = *io_callbacks;
2637 return transport_set_io_callbacks(rdp->transport, rdp->io);
2642BOOL rdp_set_io_callback_context(rdpRdp* rdp,
void* usercontext)
2645 rdp->ioContext = usercontext;
2649void* rdp_get_io_callback_context(rdpRdp* rdp)
2652 return rdp->ioContext;
2655const char* rdp_finalize_flags_to_str(UINT32 flags,
char* buffer,
size_t size)
2657 char number[32] = WINPR_C_ARRAY_INIT;
2659 (uint32_t)~(FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
2660 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU |
2661 FINALIZE_CS_SYNCHRONIZE_PDU | FINALIZE_CS_CONTROL_COOPERATE_PDU |
2662 FINALIZE_CS_CONTROL_REQUEST_PDU | FINALIZE_CS_PERSISTENT_KEY_LIST_PDU |
2663 FINALIZE_CS_FONT_LIST_PDU | FINALIZE_DEACTIVATE_REACTIVATE);
2665 if (flags & FINALIZE_SC_SYNCHRONIZE_PDU)
2666 winpr_str_append(
"FINALIZE_SC_SYNCHRONIZE_PDU", buffer, size,
"|");
2667 if (flags & FINALIZE_SC_CONTROL_COOPERATE_PDU)
2668 winpr_str_append(
"FINALIZE_SC_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2669 if (flags & FINALIZE_SC_CONTROL_GRANTED_PDU)
2670 winpr_str_append(
"FINALIZE_SC_CONTROL_GRANTED_PDU", buffer, size,
"|");
2671 if (flags & FINALIZE_SC_FONT_MAP_PDU)
2672 winpr_str_append(
"FINALIZE_SC_FONT_MAP_PDU", buffer, size,
"|");
2673 if (flags & FINALIZE_CS_SYNCHRONIZE_PDU)
2674 winpr_str_append(
"FINALIZE_CS_SYNCHRONIZE_PDU", buffer, size,
"|");
2675 if (flags & FINALIZE_CS_CONTROL_COOPERATE_PDU)
2676 winpr_str_append(
"FINALIZE_CS_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2677 if (flags & FINALIZE_CS_CONTROL_REQUEST_PDU)
2678 winpr_str_append(
"FINALIZE_CS_CONTROL_REQUEST_PDU", buffer, size,
"|");
2679 if (flags & FINALIZE_CS_PERSISTENT_KEY_LIST_PDU)
2680 winpr_str_append(
"FINALIZE_CS_PERSISTENT_KEY_LIST_PDU", buffer, size,
"|");
2681 if (flags & FINALIZE_CS_FONT_LIST_PDU)
2682 winpr_str_append(
"FINALIZE_CS_FONT_LIST_PDU", buffer, size,
"|");
2683 if (flags & FINALIZE_DEACTIVATE_REACTIVATE)
2684 winpr_str_append(
"FINALIZE_DEACTIVATE_REACTIVATE", buffer, size,
"|");
2686 winpr_str_append(
"UNKNOWN_FLAG", buffer, size,
"|");
2688 winpr_str_append(
"NO_FLAG_SET", buffer, size,
"|");
2689 (void)_snprintf(number,
sizeof(number),
" [0x%08" PRIx32
"]", flags);
2690 winpr_str_append(number, buffer, size,
"");
2694BOOL rdp_finalize_reset_flags(rdpRdp* rdp, BOOL clearAll)
2697 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] reset finalize_sc_pdus", rdp_get_state_string(rdp));
2699 rdp->finalize_sc_pdus = 0;
2701 rdp->finalize_sc_pdus &= FINALIZE_DEACTIVATE_REACTIVATE;
2703 return rdp_set_monitor_layout_pdu_state(rdp, FALSE);
2706BOOL rdp_finalize_set_flag(rdpRdp* rdp, UINT32 flag)
2708 char buffer[1024] = WINPR_C_ARRAY_INIT;
2712 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] received flag %s", rdp_get_state_string(rdp),
2713 rdp_finalize_flags_to_str(flag, buffer,
sizeof(buffer)));
2714 rdp->finalize_sc_pdus |= flag;
2718BOOL rdp_finalize_is_flag_set(rdpRdp* rdp, UINT32 flag)
2721 return (rdp->finalize_sc_pdus & flag) == flag;
2724BOOL rdp_reset_rc4_encrypt_keys(rdpRdp* rdp)
2727 rdp_free_rc4_encrypt_keys(rdp);
2728 rdp->rc4_encrypt_key = winpr_RC4_New(rdp->encrypt_key, rdp->rc4_key_len);
2730 rdp->encrypt_use_count = 0;
2731 return rdp->rc4_encrypt_key !=
nullptr;
2734void rdp_free_rc4_encrypt_keys(rdpRdp* rdp)
2737 winpr_RC4_Free(rdp->rc4_encrypt_key);
2738 rdp->rc4_encrypt_key =
nullptr;
2741void rdp_free_rc4_decrypt_keys(rdpRdp* rdp)
2744 winpr_RC4_Free(rdp->rc4_decrypt_key);
2745 rdp->rc4_decrypt_key =
nullptr;
2748BOOL rdp_reset_rc4_decrypt_keys(rdpRdp* rdp)
2751 rdp_free_rc4_decrypt_keys(rdp);
2752 rdp->rc4_decrypt_key = winpr_RC4_New(rdp->decrypt_key, rdp->rc4_key_len);
2754 rdp->decrypt_use_count = 0;
2755 return rdp->rc4_decrypt_key !=
nullptr;
2758const char* rdp_security_flag_string(UINT32 securityFlags,
char* buffer,
size_t size)
2760 if (securityFlags & SEC_EXCHANGE_PKT)
2761 winpr_str_append(
"SEC_EXCHANGE_PKT", buffer, size,
"|");
2762 if (securityFlags & SEC_TRANSPORT_REQ)
2763 winpr_str_append(
"SEC_TRANSPORT_REQ", buffer, size,
"|");
2764 if (securityFlags & SEC_TRANSPORT_RSP)
2765 winpr_str_append(
"SEC_TRANSPORT_RSP", buffer, size,
"|");
2766 if (securityFlags & SEC_ENCRYPT)
2767 winpr_str_append(
"SEC_ENCRYPT", buffer, size,
"|");
2768 if (securityFlags & SEC_RESET_SEQNO)
2769 winpr_str_append(
"SEC_RESET_SEQNO", buffer, size,
"|");
2770 if (securityFlags & SEC_IGNORE_SEQNO)
2771 winpr_str_append(
"SEC_IGNORE_SEQNO", buffer, size,
"|");
2772 if (securityFlags & SEC_INFO_PKT)
2773 winpr_str_append(
"SEC_INFO_PKT", buffer, size,
"|");
2774 if (securityFlags & SEC_LICENSE_PKT)
2775 winpr_str_append(
"SEC_LICENSE_PKT", buffer, size,
"|");
2776 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
2777 winpr_str_append(
"SEC_LICENSE_ENCRYPT_CS", buffer, size,
"|");
2778 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
2779 winpr_str_append(
"SEC_LICENSE_ENCRYPT_SC", buffer, size,
"|");
2780 if (securityFlags & SEC_REDIRECTION_PKT)
2781 winpr_str_append(
"SEC_REDIRECTION_PKT", buffer, size,
"|");
2782 if (securityFlags & SEC_SECURE_CHECKSUM)
2783 winpr_str_append(
"SEC_SECURE_CHECKSUM", buffer, size,
"|");
2784 if (securityFlags & SEC_AUTODETECT_REQ)
2785 winpr_str_append(
"SEC_AUTODETECT_REQ", buffer, size,
"|");
2786 if (securityFlags & SEC_AUTODETECT_RSP)
2787 winpr_str_append(
"SEC_AUTODETECT_RSP", buffer, size,
"|");
2788 if (securityFlags & SEC_HEARTBEAT)
2789 winpr_str_append(
"SEC_HEARTBEAT", buffer, size,
"|");
2790 if (securityFlags & SEC_FLAGSHI_VALID)
2791 winpr_str_append(
"SEC_FLAGSHI_VALID", buffer, size,
"|");
2793 char msg[32] = WINPR_C_ARRAY_INIT;
2795 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", securityFlags);
2796 winpr_str_append(msg, buffer, size,
"");
2801static BOOL rdp_reset_remote_settings(rdpRdp* rdp)
2803 UINT32 flags = FREERDP_SETTINGS_REMOTE_MODE;
2810 return rdp->remoteSettings !=
nullptr;
2813BOOL rdp_set_backup_settings(rdpRdp* rdp)
2818 if (!rdp->originalSettings)
2820 return rdp_reset_remote_settings(rdp);
2823BOOL rdp_reset_runtime_settings(rdpRdp* rdp)
2826 WINPR_ASSERT(rdp->context);
2833 return rdp_reset_remote_settings(rdp);
2836static BOOL starts_with(
const char* tok,
const char* val)
2838 const size_t len = strlen(val);
2839 if (strncmp(tok, val, len) != 0)
2841 if (tok[len] !=
'=')
2846static BOOL option_equals(
const char* what,
const char* val)
2848 return _stricmp(what, val) == 0;
2851static BOOL parse_on_off_option(
const char* value)
2853 WINPR_ASSERT(value);
2854 const char* sep = strchr(value,
'=');
2857 if (option_equals(
"on", &sep[1]))
2859 if (option_equals(
"true", &sep[1]))
2861 if (option_equals(
"off", &sep[1]))
2863 if (option_equals(
"false", &sep[1]))
2867 long val = strtol(value,
nullptr, 0);
2876static BOOL option_is_runtime_checks(WINPR_ATTR_UNUSED wLog* log,
const char* tok)
2878 const char* experimental[] = { STR(WITH_VERBOSE_WINPR_ASSERT) };
2879 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2881 const char* opt = experimental[x];
2882 if (starts_with(tok, opt))
2884 return parse_on_off_option(tok);
2890static BOOL option_is_experimental(WINPR_ATTR_UNUSED wLog* log,
const char* tok)
2892 const char* experimental[] = { STR(WITH_DSP_EXPERIMENTAL), STR(WITH_VAAPI),
2893 STR(WITH_GFX_AV1), STR(WITH_VAAPI_H264_ENCODING),
2894 STR(WITH_MEDIACODEC), STR(WITH_CLIENT_SDL2),
2895 STR(WITH_OPENCL), STR(WITH_LIBRESSL),
2896 STR(WITH_MBEDTLS), STR(WITH_MEDIA_FOUNDATION),
2897 STR(WITH_KRB5_HEIMDAL), STR(WITH_VIDEOTOOLBOX) };
2898 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2900 const char* opt = experimental[x];
2901 if (starts_with(tok, opt))
2903 return parse_on_off_option(tok);
2909static BOOL option_is_debug(wLog* log,
const char* tok)
2912 const char* debug[] = { STR(WITH_DEBUG_ALL),
2913 STR(WITH_DEBUG_CERTIFICATE),
2914 STR(WITH_DEBUG_CAPABILITIES),
2915 STR(WITH_DEBUG_CHANNELS),
2916 STR(WITH_DEBUG_CLIPRDR),
2917 STR(WITH_DEBUG_CODECS),
2918 STR(WITH_DEBUG_DVC),
2919 STR(WITH_DEBUG_TSMF),
2920 STR(WITH_DEBUG_KBD),
2921 STR(WITH_DEBUG_LICENSE),
2922 STR(WITH_DEBUG_NEGO),
2923 STR(WITH_DEBUG_NLA),
2924 STR(WITH_DEBUG_TSG),
2925 STR(WITH_DEBUG_RAIL),
2926 STR(WITH_DEBUG_RDP),
2927 STR(WITH_DEBUG_RDPEI),
2928 STR(WITH_DEBUG_REDIR),
2929 STR(WITH_DEBUG_RDPDR),
2930 STR(WITH_DEBUG_RFX),
2931 STR(WITH_DEBUG_SCARD),
2932 STR(WITH_DEBUG_SND),
2933 STR(WITH_DEBUG_SVC),
2934 STR(WITH_DEBUG_TRANSPORT),
2935 STR(WITH_DEBUG_TIMEZONE),
2936 STR(WITH_DEBUG_WND),
2937 STR(WITH_DEBUG_RINGBUFFER),
2938 STR(WITH_DEBUG_SYMBOLS),
2939 STR(WITH_DEBUG_EVENTS),
2940 STR(WITH_DEBUG_MUTEX),
2941 STR(WITH_DEBUG_NTLM),
2942 STR(WITH_DEBUG_SDL_KBD_EVENTS),
2943 STR(WITH_DEBUG_SDL_KBD_EVENTS),
2944 STR(WITH_DEBUG_THREADS),
2945 STR(WITH_DEBUG_URBDRC) };
2947 for (
size_t x = 0; x < ARRAYSIZE(debug); x++)
2949 const char* opt = debug[x];
2950 if (starts_with(tok, opt))
2951 return parse_on_off_option(tok);
2954 if (starts_with(tok,
"WITH_DEBUG"))
2956 WLog_Print(log, WLOG_WARN,
"[BUG] Unmapped Debug-Build option '%s'.", tok);
2957 return parse_on_off_option(tok);
2963static void log_build_warn(rdpRdp* rdp,
const char* what,
const char* msg,
2964 BOOL (*cmp)(wLog* log,
const char* tok))
2967 WINPR_PRAGMA_DIAG_PUSH
2968 WINPR_PRAGMA_DIAG_IGNORED_OVERLENGTH_STRINGS
2970 size_t len =
sizeof(FREERDP_BUILD_CONFIG);
2971 char* list = calloc(len,
sizeof(
char));
2972 char* config = _strdup(FREERDP_BUILD_CONFIG);
2973 WINPR_PRAGMA_DIAG_POP
2977 char* saveptr =
nullptr;
2978 char* tok = strtok_s(config,
" ", &saveptr);
2981 if (cmp(rdp->log, tok))
2982 winpr_str_append(tok, list, len,
" ");
2984 tok = strtok_s(
nullptr,
" ", &saveptr);
2991 if (strlen(list) > 0)
2993 WLog_Print(rdp->log, WLOG_WARN,
"*************************************************");
2994 WLog_Print(rdp->log, WLOG_WARN,
"This build is using [%s] build options:", what);
2996 char* saveptr =
nullptr;
2997 char* tok = strtok_s(list,
" ", &saveptr);
3000 WLog_Print(rdp->log, WLOG_WARN,
"* '%s'", tok);
3001 tok = strtok_s(
nullptr,
" ", &saveptr);
3003 WLog_Print(rdp->log, WLOG_WARN,
"*");
3004 WLog_Print(rdp->log, WLOG_WARN,
"[%s] build options %s", what, msg);
3005 WLog_Print(rdp->log, WLOG_WARN,
"*************************************************");
3011#define print_first_line(log, firstLine, what) \
3012 print_first_line_int((log), (firstLine), (what), __FILE__, __func__, __LINE__)
3013static void print_first_line_int(wLog* log, log_line_t* firstLine,
const char* what,
3014 const char* file,
const char* fkt,
size_t line)
3016 WINPR_ASSERT(firstLine);
3017 if (!firstLine->fkt)
3019 const DWORD level = WLOG_WARN;
3020 if (WLog_IsLevelActive(log, level))
3022 WLog_PrintTextMessage(log, level, line, file, fkt,
3023 "*************************************************");
3024 WLog_PrintTextMessage(log, level, line, file, fkt,
3025 "[SSL] {%s} build or configuration missing:", what);
3027 firstLine->line = line;
3028 firstLine->file = file;
3029 firstLine->fkt = fkt;
3030 firstLine->level = level;
3034static void print_last_line(wLog* log,
const log_line_t* firstLine)
3036 WINPR_ASSERT(firstLine);
3039 if (WLog_IsLevelActive(log, firstLine->level))
3040 WLog_PrintTextMessage(log, firstLine->level, firstLine->line, firstLine->file,
3042 "*************************************************");
3046static void log_build_warn_cipher(rdpRdp* rdp, log_line_t* firstLine, WINPR_CIPHER_TYPE md,
3047 const char* what, BOOL allowFIPS)
3049 BOOL haveCipher = FALSE;
3051 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3052 char iv[WINPR_CIPHER_MAX_IV_LENGTH] = WINPR_C_ARRAY_INIT;
3056 if (md == WINPR_CIPHER_ARC4_128)
3058 WINPR_RC4_CTX* enc =
nullptr;
3060 enc = winpr_RC4_New_Allow_FIPS(key,
sizeof(key));
3062 enc = winpr_RC4_New(key,
sizeof(key));
3063 haveCipher = enc !=
nullptr;
3064 winpr_RC4_Free(enc);
3068 WINPR_CIPHER_CTX* enc =
3069 winpr_Cipher_NewEx(md, WINPR_ENCRYPT, key,
sizeof(key), iv,
sizeof(iv));
3070 WINPR_CIPHER_CTX* dec =
3071 winpr_Cipher_NewEx(md, WINPR_DECRYPT, key,
sizeof(key), iv,
sizeof(iv));
3075 winpr_Cipher_Free(enc);
3076 winpr_Cipher_Free(dec);
3081 print_first_line(rdp->log, firstLine,
"Cipher");
3082 WLog_Print(rdp->log, WLOG_WARN,
"* %s: %s", winpr_cipher_type_to_string(md), what);
3086static void log_build_warn_hmac(rdpRdp* rdp, log_line_t* firstLine, WINPR_MD_TYPE md,
3089 BOOL haveHmacX = FALSE;
3090 WINPR_HMAC_CTX* hmac = winpr_HMAC_New();
3096 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3097 haveHmacX = winpr_HMAC_Init(hmac, md, key,
sizeof(key));
3099 winpr_HMAC_Free(hmac);
3103 print_first_line(rdp->log, firstLine,
"HMAC");
3104 WLog_Print(rdp->log, WLOG_WARN,
" * %s: %s", winpr_md_type_to_string(md), what);
3108static void log_build_warn_hash(rdpRdp* rdp, log_line_t* firstLine, WINPR_MD_TYPE md,
3109 const char* what, BOOL allowFIPS)
3111 BOOL haveDigestX = FALSE;
3112 WINPR_DIGEST_CTX* digest = winpr_Digest_New();
3116 haveDigestX = winpr_Digest_Init_Allow_FIPS(digest, md);
3118 haveDigestX = winpr_Digest_Init(digest, md);
3120 winpr_Digest_Free(digest);
3124 print_first_line(rdp->log, firstLine,
"Digest");
3125 WLog_Print(rdp->log, WLOG_WARN,
" * %s: %s", winpr_md_type_to_string(md), what);
3129static void log_build_warn_ssl(rdpRdp* rdp)
3133 const BOOL fips = winpr_FIPSMode();
3137 WLog_Print(rdp->log, WLOG_INFO,
3138 "FIPS mode active: non-approved algorithms are unavailable "
3139 "as expected. NTLM, autoreconnect cookies, assistance files "
3140 "with encrypted passwords and RDP security will not work.");
3143 log_line_t firstHashLine = WINPR_C_ARRAY_INIT;
3146 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD4,
"NTLM support not available", FALSE);
3147 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD5,
3148 "NTLM, assistance files with encrypted passwords "
3149 " and autoreconnect cookies will not work",
3152 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD5,
3153 "RDP licensing and RDP security will not work", TRUE);
3154 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_SHA1,
3155 "assistance files with encrypted passwords, Kerberos, Smartcard Logon, RDP "
3156 "security support not available",
3158 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_SHA256,
3159 "file clipboard, AAD gateway, NLA security and certificates might not work",
3161 print_last_line(rdp->log, &firstHashLine);
3165 log_line_t firstHmacLine = WINPR_C_ARRAY_INIT;
3166 log_build_warn_hmac(rdp, &firstHmacLine, WINPR_MD_MD5,
3167 "Autoreconnect cookie not supported");
3168 log_build_warn_hmac(rdp, &firstHmacLine, WINPR_MD_SHA1,
"RDP security not supported");
3169 print_last_line(rdp->log, &firstHmacLine);
3172 log_line_t firstCipherLine = WINPR_C_ARRAY_INIT;
3175 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_ARC4_128,
3176 "assistance files with encrypted passwords, NTLM "
3177 "and autoreconnect cookies will not work",
3180 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_ARC4_128,
3181 "RDP licensing and RDP security will not work", TRUE);
3183 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_DES_EDE3_CBC,
3184 "RDP security will not work", TRUE);
3185 log_build_warn_cipher(
3186 rdp, &firstCipherLine, WINPR_CIPHER_AES_128_CBC,
3187 "assistance file encrypted LHTicket will not work and ARM gateway might not", FALSE);
3188 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_AES_192_CBC,
3189 "ARM gateway might not work", FALSE);
3190 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_AES_256_CBC,
3191 "ARM gateway might not work", FALSE);
3192 print_last_line(rdp->log, &firstCipherLine);
3195void rdp_log_build_warnings(rdpRdp* rdp)
3197 static unsigned count = 0;
3206 log_build_warn(rdp,
"experimental",
"might crash the application", option_is_experimental);
3207 log_build_warn(rdp,
"debug",
"might leak sensitive information (credentials, ...)",
3209 log_build_warn(rdp,
"runtime-check",
"might slow down the application",
3210 option_is_runtime_checks);
3211 log_build_warn_ssl(rdp);
3214size_t rdp_get_event_handles(rdpRdp* rdp, HANDLE* handles, uint32_t count)
3216 size_t nCount = transport_get_event_handles(rdp->transport, handles, count);
3221 if (count < nCount + 2UL)
3224 handles[nCount++] = utils_get_abort_event(rdp);
3225 handles[nCount++] = freerdp_timer_get_event(rdp->timer);
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.