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>
38#include "redirection.h"
40#include <freerdp/codec/bulk.h>
41#include <freerdp/crypto/per.h>
42#include <freerdp/log.h>
43#include <freerdp/buildflags.h>
45#define RDP_TAG FREERDP_TAG("core.rdp")
55static const char* DATA_PDU_TYPE_STRINGS[80] = {
97 "Set Keyboard Indicators",
99 "Bitmap Cache Persistent List",
100 "Bitmap Cache Error",
101 "Set Keyboard IME Status",
102 "Offscreen Cache Error",
104 "Draw Nine Grid Error",
123#define rdp_check_monitor_layout_pdu_state(rdp, expected) \
124 rdp_check_monitor_layout_pdu_state_(rdp, expected, __FILE__, __func__, __LINE__)
126static BOOL rdp_check_monitor_layout_pdu_state_(
const rdpRdp* rdp, BOOL expected,
const char* file,
127 const char* fkt,
size_t line)
130 if (expected != rdp->monitor_layout_pdu)
132 const DWORD log_level = WLOG_ERROR;
133 if (WLog_IsLevelActive(rdp->log, log_level))
135 WLog_PrintTextMessage(rdp->log, log_level, line, file, fkt,
136 "Expected rdp->monitor_layout_pdu == %s",
137 expected ?
"TRUE" :
"FALSE");
144#define rdp_set_monitor_layout_pdu_state(rdp, expected) \
145 rdp_set_monitor_layout_pdu_state_(rdp, expected, __FILE__, __func__, __LINE__)
146static BOOL rdp_set_monitor_layout_pdu_state_(rdpRdp* rdp, BOOL value,
const char* file,
147 const char* fkt,
size_t line)
151 if (value && (value == rdp->monitor_layout_pdu))
153 const DWORD log_level = WLOG_WARN;
154 if (WLog_IsLevelActive(rdp->log, log_level))
156 WLog_PrintTextMessage(rdp->log, log_level, line, file, fkt,
157 "rdp->monitor_layout_pdu == TRUE, expected FALSE");
161 rdp->monitor_layout_pdu = value;
165const char* data_pdu_type_to_string(UINT8 type)
167 if (type >= ARRAYSIZE(DATA_PDU_TYPE_STRINGS))
169 return DATA_PDU_TYPE_STRINGS[type];
172static BOOL rdp_read_flow_control_pdu(rdpRdp* rdp,
wStream* s, UINT16* type, UINT16* channel_id);
173static BOOL rdp_write_share_control_header(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 type,
175static BOOL rdp_write_share_data_header(rdpRdp* rdp,
wStream* s,
size_t length, BYTE type,
188BOOL rdp_read_security_header(rdpRdp* rdp,
wStream* s, UINT16* flags, UINT16* length)
190 char buffer[256] = WINPR_C_ARRAY_INIT;
196 if ((length && (*length < 4)))
198 WLog_Print(rdp->log, WLOG_WARN,
199 "invalid security header length, have %" PRIu16
", must be >= 4", *length);
202 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
205 *flags = Stream_Get_UINT16(s);
206 const uint16_t flagsHi = Stream_Get_UINT16(s);
207 if ((*flags & SEC_FLAGSHI_VALID) != 0)
209 WLog_Print(rdp->log, WLOG_WARN,
210 "[MS-RDPBCGR] 2.2.8.1.1.2.1 Basic (TS_SECURITY_HEADER) SEC_FLAGSHI_VALID field "
211 "set: flagsHi=0x%04" PRIx16,
214 WLog_Print(rdp->log, WLOG_TRACE,
"%s",
215 rdp_security_flag_string(*flags, buffer,
sizeof(buffer)));
231BOOL rdp_write_security_header(rdpRdp* rdp,
wStream* s, UINT16 flags)
233 char buffer[256] = WINPR_C_ARRAY_INIT;
237 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 4))
240 WLog_Print(rdp->log, WLOG_TRACE,
"%s", rdp_security_flag_string(flags, buffer,
sizeof(buffer)));
242 WINPR_ASSERT((flags & SEC_FLAGSHI_VALID) == 0);
243 Stream_Write_UINT16(s, flags);
244 Stream_Write_UINT16(s, 0);
248BOOL rdp_read_share_control_header(rdpRdp* rdp,
wStream* s, UINT16* tpktLength,
249 UINT16* remainingLength, UINT16* type, UINT16* channel_id)
257 WINPR_ASSERT(channel_id);
259 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
263 Stream_Read_UINT16(s, len);
269 if (!rdp_read_flow_control_pdu(rdp, s, type, channel_id))
275 *remainingLength = 0;
277 char buffer[128] = WINPR_C_ARRAY_INIT;
278 WLog_Print(rdp->log, WLOG_DEBUG,
279 "[Flow control PDU] type=%s, tpktLength=%" PRIu16
", remainingLength=%" PRIu16,
280 pdu_type_to_str(*type, buffer,
sizeof(buffer)), tpktLength ? *tpktLength : 0u,
281 remainingLength ? *remainingLength : 0u);
287 WLog_Print(rdp->log, WLOG_ERROR,
288 "Invalid share control header, length is %" PRIu16
", must be >4", len);
295 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
298 Stream_Read_UINT16(s, tmp);
301 size_t remLen = len - 4;
304 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
307 Stream_Read_UINT16(s, *channel_id);
313 char buffer[128] = WINPR_C_ARRAY_INIT;
314 WLog_Print(rdp->log, WLOG_DEBUG,
"type=%s, tpktLength=%" PRIu16
", remainingLength=%" PRIuz,
315 pdu_type_to_str(*type, buffer,
sizeof(buffer)), len, remLen);
318 WINPR_ASSERT(remLen <= UINT16_MAX);
319 *remainingLength = (UINT16)remLen;
321 return Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, remLen);
324BOOL rdp_write_share_control_header(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 type,
329 if (length > UINT16_MAX)
332 if (length < RDP_PACKET_HEADER_MAX_LENGTH)
334 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 6))
336 length -= RDP_PACKET_HEADER_MAX_LENGTH;
338 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, length));
339 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, type | 0x10));
340 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, channel_id));
344BOOL rdp_read_share_data_header(rdpRdp* rdp,
wStream* s, UINT16* length, BYTE* type,
345 UINT32* shareId, BYTE* compressedType, UINT16* compressedLength)
350 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
354 Stream_Read_UINT32(s, *shareId);
355 Stream_Seek_UINT8(s);
356 Stream_Seek_UINT8(s);
357 Stream_Read_UINT16(s, *length);
358 Stream_Read_UINT8(s, *type);
359 Stream_Read_UINT8(s, *compressedType);
360 Stream_Read_UINT16(s, *compressedLength);
364BOOL rdp_write_share_data_header(rdpRdp* rdp,
wStream* s,
size_t length, BYTE type, UINT32 share_id)
366 const size_t headerLen = RDP_PACKET_HEADER_MAX_LENGTH + RDP_SHARE_CONTROL_HEADER_LENGTH +
367 RDP_SHARE_DATA_HEADER_LENGTH;
371 if (length > UINT16_MAX)
374 if (length < headerLen)
377 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 12))
381 Stream_Write_UINT32(s, share_id);
382 Stream_Write_UINT8(s, 0);
383 Stream_Write_UINT8(s, STREAM_LOW);
385 s, WINPR_ASSERTING_INT_CAST(uint16_t, length));
386 Stream_Write_UINT8(s, type);
387 Stream_Write_UINT8(s, 0);
388 Stream_Write_UINT16(s, 0);
392static BOOL rdp_security_stream_init(rdpRdp* rdp,
wStream* s, BOOL sec_header, UINT16* sec_flags)
396 WINPR_ASSERT(sec_flags);
400 if (!Stream_SafeSeek(s, 12))
403 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
405 if (!Stream_SafeSeek(s, 4))
409 *sec_flags |= SEC_ENCRYPT;
411 if (rdp->do_secure_checksum)
412 *sec_flags |= SEC_SECURE_CHECKSUM;
414 else if (*sec_flags != 0 || sec_header)
416 if (!Stream_SafeSeek(s, 4))
423wStream* rdp_send_stream_init(rdpRdp* rdp, UINT16* sec_flags)
428 WINPR_ASSERT(rdp->transport);
430 s = transport_send_stream_init(rdp->transport, 4096);
435 if (!Stream_SafeSeek(s, RDP_PACKET_HEADER_MAX_LENGTH))
438 if (!rdp_security_stream_init(rdp, s, FALSE, sec_flags))
447wStream* rdp_send_stream_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
449 wStream* s = rdp_send_stream_init(rdp, sec_flags);
454 if (!Stream_SafeSeek(s, RDP_SHARE_CONTROL_HEADER_LENGTH))
463wStream* rdp_data_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
465 wStream* s = rdp_send_stream_pdu_init(rdp, sec_flags);
470 if (!Stream_SafeSeek(s, RDP_SHARE_DATA_HEADER_LENGTH))
479BOOL rdp_set_error_info(rdpRdp* rdp, UINT32 errorInfo)
484 rdp->errorInfo = errorInfo;
486 if (rdp->errorInfo != ERRINFO_SUCCESS)
488 rdpContext* context = rdp->context;
489 WINPR_ASSERT(context);
491 rdp_print_errinfo(rdp->errorInfo);
495 freerdp_set_last_error_log(context, MAKE_FREERDP_ERROR(
ERRINFO, errorInfo));
499 ErrorInfoEventArgs e = WINPR_C_ARRAY_INIT;
500 EventArgsInit(&e,
"freerdp");
501 e.code = rdp->errorInfo;
502 rc = PubSub_OnErrorInfo(context->pubSub, context, &e) >= 0;
506 WLog_Print(rdp->log, WLOG_ERROR,
"missing context=%p", (
void*)context);
510 freerdp_set_last_error_log(rdp->context, FREERDP_ERROR_SUCCESS);
516wStream* rdp_message_channel_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
522 s = transport_send_stream_init(rdp->transport, 4096);
527 if (!Stream_SafeSeek(s, RDP_PACKET_HEADER_MAX_LENGTH))
530 if (!rdp_security_stream_init(rdp, s, TRUE, sec_flags))
549BOOL rdp_read_header(rdpRdp* rdp,
wStream* s, UINT16* length, UINT16* channelId)
554 UINT16 initiator = 0;
557 WINPR_ASSERT(rdp->settings);
559 DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataRequest
560 : DomainMCSPDU_SendDataIndication;
563 if (!tpkt_read_header(s, length))
566 if (!tpdu_read_header(s, &code, &li, *length))
569 if (code != X224_TPDU_DATA)
571 if (code == X224_TPDU_DISCONNECT_REQUEST)
573 WLog_Print(rdp->log, WLOG_WARN,
"Received X224_TPDU_DISCONNECT_REQUEST, terminating");
574 utils_abort_connect(rdp);
578 WLog_Print(rdp->log, WLOG_WARN,
579 "Unexpected X224 TPDU type %s [%08" PRIx32
"] instead of %s",
580 tpdu_type_to_string(code), code, tpdu_type_to_string(X224_TPDU_DATA));
584 if (!per_read_choice(s, &choice))
587 const DomainMCSPDU domainMCSPDU = (DomainMCSPDU)(choice >> 2);
589 if (domainMCSPDU != MCSPDU)
591 if (domainMCSPDU != DomainMCSPDU_DisconnectProviderUltimatum)
593 WLog_Print(rdp->log, WLOG_WARN,
"Received %s instead of %s",
594 mcs_domain_pdu_string(domainMCSPDU), mcs_domain_pdu_string(MCSPDU));
599 MCSPDU = domainMCSPDU;
603 WLog_Print(rdp->log, WLOG_WARN,
"TPDU invalid length, got %" PRIu16
", expected at least 8",
608 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length - 8))
611 if (MCSPDU == DomainMCSPDU_DisconnectProviderUltimatum)
614 TerminateEventArgs e = WINPR_C_ARRAY_INIT;
616 if (!mcs_recv_disconnect_provider_ultimatum(rdp->mcs, s, &reason))
619 rdpContext* context = rdp->context;
620 WINPR_ASSERT(context);
621 context->disconnectUltimatum = reason;
623 if (rdp->errorInfo == ERRINFO_SUCCESS)
630 UINT32 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
631 if (reason == Disconnect_Ultimatum_provider_initiated)
632 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
633 else if (reason == Disconnect_Ultimatum_user_requested)
634 errorInfo = ERRINFO_LOGOFF_BY_USER;
636 if (!rdp_set_error_info(rdp, errorInfo))
640 WLog_Print(rdp->log, WLOG_DEBUG,
"DisconnectProviderUltimatum: reason: %d", reason);
641 utils_abort_connect(rdp);
642 EventArgsInit(&e,
"freerdp");
644 PubSub_OnTerminate(rdp->pubSub, context, &e);
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_SetPosition(s, 0);
845 if (!rdp_write_header(rdp, s, length, channelId, sec_flags))
848 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
852 Stream_SetPosition(s, length);
853 Stream_SealLength(s);
856 if (transport_write(rdp->transport, s) < 0)
862 security_unlock(rdp);
867BOOL rdp_send_pdu(rdpRdp* rdp,
wStream* s, UINT16 type, UINT16 channel_id, UINT16 sec_flags)
870 UINT32 sec_bytes = 0;
873 BOOL should_unlock = FALSE;
881 if (sec_flags & SEC_ENCRYPT)
884 should_unlock = TRUE;
888 size_t length = Stream_GetPosition(s);
889 Stream_SetPosition(s, 0);
890 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
892 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
893 sec_hold = Stream_GetPosition(s);
894 Stream_Seek(s, sec_bytes);
895 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, type, channel_id))
897 Stream_SetPosition(s, sec_hold);
899 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
903 Stream_SetPosition(s, length);
904 Stream_SealLength(s);
907 if (transport_write(rdp->transport, s) < 0)
913 security_unlock(rdp);
917BOOL rdp_send_data_pdu(rdpRdp* rdp,
wStream* s, BYTE type, UINT16 channel_id, UINT16 sec_flags)
920 UINT32 sec_bytes = 0;
923 BOOL should_unlock = FALSE;
931 if (sec_flags & SEC_ENCRYPT)
934 should_unlock = TRUE;
938 size_t length = Stream_GetPosition(s);
939 Stream_SetPosition(s, 0);
940 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
942 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
943 sec_hold = Stream_GetPosition(s);
944 Stream_Seek(s, sec_bytes);
945 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, PDU_TYPE_DATA, channel_id))
947 if (!rdp_write_share_data_header(rdp, s, length - sec_bytes, type, rdp->settings->ShareId))
949 Stream_SetPosition(s, sec_hold);
951 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
955 Stream_SetPosition(s, length);
956 Stream_SealLength(s);
958 WLog_Print(rdp->log, WLOG_DEBUG,
959 "sending data (type=0x%x size=%" PRIuz
" channelId=%" PRIu16
")", type,
960 Stream_Length(s), channel_id);
963 if (transport_write(rdp->transport, s) < 0)
969 security_unlock(rdp);
974BOOL rdp_send_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 sec_flags)
978 BOOL should_unlock = FALSE;
983 if (sec_flags & SEC_ENCRYPT)
986 should_unlock = TRUE;
990 size_t length = Stream_GetPosition(s);
991 Stream_SetPosition(s, 0);
992 if (!rdp_write_header(rdp, s, length, rdp->mcs->messageChannelId, sec_flags))
995 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
999 Stream_SetPosition(s, length);
1001 Stream_SealLength(s);
1003 if (transport_write(rdp->transport, s) < 0)
1009 security_unlock(rdp);
1015static BOOL rdp_recv_server_shutdown_denied_pdu(WINPR_ATTR_UNUSED rdpRdp* rdp,
1021static BOOL rdp_recv_server_set_keyboard_indicators_pdu(rdpRdp* rdp,
wStream* s)
1026 rdpContext* context = rdp->context;
1027 WINPR_ASSERT(context);
1028 WINPR_ASSERT(context->update);
1030 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1033 const uint16_t unitId = Stream_Get_UINT16(s);
1036 WLog_Print(rdp->log, WLOG_WARN,
1037 "[MS-RDPBCGR] 2.2.8.2.1.1 Set Keyboard Indicators PDU Data "
1038 "(TS_SET_KEYBOARD_INDICATORS_PDU)::unitId should be 0, is %" PRIu16,
1041 const UINT16 ledFlags = Stream_Get_UINT16(s);
1042 return IFCALLRESULT(TRUE, context->update->SetKeyboardIndicators, context, ledFlags);
1045static BOOL rdp_recv_server_set_keyboard_ime_status_pdu(rdpRdp* rdp,
wStream* s)
1047 if (!rdp || !rdp->input)
1050 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 10))
1053 const uint16_t unitId = Stream_Get_UINT16(s);
1056 WLog_Print(rdp->log, WLOG_WARN,
1057 "[MS-RDPBCGR] 2.2.8.2.2.1 Set Keyboard IME Status PDU Data "
1058 "(TS_SET_KEYBOARD_IME_STATUS_PDU)::unitId should be 0, is %" PRIu16,
1061 const uint32_t imeState = Stream_Get_UINT32(s);
1062 const uint32_t imeConvMode = Stream_Get_UINT32(s);
1063 return IFCALLRESULT(TRUE, rdp->update->SetKeyboardImeStatus, rdp->context, unitId, imeState,
1067static BOOL rdp_recv_set_error_info_data_pdu(rdpRdp* rdp,
wStream* s)
1069 UINT32 errorInfo = 0;
1071 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1074 Stream_Read_UINT32(s, errorInfo);
1075 return rdp_set_error_info(rdp, errorInfo);
1078static BOOL rdp_recv_server_auto_reconnect_status_pdu(rdpRdp* rdp,
wStream* s)
1080 UINT32 arcStatus = 0;
1082 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1085 Stream_Read_UINT32(s, arcStatus);
1086 WLog_Print(rdp->log, WLOG_WARN,
"AutoReconnectStatus: 0x%08" PRIX32
"", arcStatus);
1090static BOOL rdp_recv_server_status_info_pdu(rdpRdp* rdp,
wStream* s)
1092 UINT32 statusCode = 0;
1094 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1097 Stream_Read_UINT32(s, statusCode);
1099 if (rdp->update->ServerStatusInfo)
1100 return rdp->update->ServerStatusInfo(rdp->context, statusCode);
1105static BOOL rdp_recv_monitor_layout_pdu(rdpRdp* rdp,
wStream* s)
1107 UINT32 monitorCount = 0;
1112 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1115 Stream_Read_UINT32(s, monitorCount);
1117 if (!Stream_CheckAndLogRequiredLengthOfSizeWLog(rdp->log, s, monitorCount, 20ull))
1122 if (!monitorDefArray)
1125 for (UINT32 index = 0; index < monitorCount; index++)
1128 Stream_Read_INT32(s, monitor->left);
1129 Stream_Read_INT32(s, monitor->top);
1130 Stream_Read_INT32(s, monitor->right);
1131 Stream_Read_INT32(s, monitor->bottom);
1132 Stream_Read_UINT32(s, monitor->flags);
1135 IFCALLRET(rdp->update->RemoteMonitors, ret, rdp->context, monitorCount, monitorDefArray);
1136 free(monitorDefArray);
1139 return rdp_set_monitor_layout_pdu_state(rdp, TRUE);
1142state_run_t rdp_recv_data_pdu(rdpRdp* rdp,
wStream* s)
1148 BYTE compressedType = 0;
1149 UINT16 compressedLength = 0;
1152 if (!rdp_read_share_data_header(rdp, s, &length, &type, &shareId, &compressedType,
1155 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_read_share_data_header() failed");
1156 return STATE_RUN_FAILED;
1161 if (compressedType & PACKET_COMPRESSED)
1163 if (compressedLength < 18)
1165 WLog_Print(rdp->log, WLOG_ERROR,
1166 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1168 return STATE_RUN_FAILED;
1172 const BYTE* pDstData =
nullptr;
1173 UINT16 SrcSize = compressedLength - 18;
1175 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, SrcSize))
1177 WLog_Print(rdp->log, WLOG_ERROR,
1178 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1180 return STATE_RUN_FAILED;
1183 if (bulk_decompress(rdp->bulk, Stream_ConstPointer(s), SrcSize, &pDstData, &DstSize,
1186 cs = transport_take_from_pool(rdp->transport, DstSize);
1189 WLog_Print(rdp->log, WLOG_ERROR,
"Couldn't take stream from pool");
1190 return STATE_RUN_FAILED;
1193 Stream_SetPosition(cs, 0);
1194 Stream_Write(cs, pDstData, DstSize);
1195 Stream_SealLength(cs);
1196 Stream_SetPosition(cs, 0);
1200 WLog_Print(rdp->log, WLOG_ERROR,
"bulk_decompress() failed");
1201 return STATE_RUN_FAILED;
1204 Stream_Seek(s, SrcSize);
1207 WLog_Print(rdp->log, WLOG_DEBUG,
"recv %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1208 data_pdu_type_to_string(type), type, length);
1212 case DATA_PDU_TYPE_UPDATE:
1213 if (!update_recv(rdp->update, cs))
1215 WLog_Print(rdp->log, WLOG_ERROR,
"DATA_PDU_TYPE_UPDATE - update_recv() failed");
1221 case DATA_PDU_TYPE_CONTROL:
1222 if (!rdp_recv_server_control_pdu(rdp, cs))
1224 WLog_Print(rdp->log, WLOG_ERROR,
1225 "DATA_PDU_TYPE_CONTROL - rdp_recv_server_control_pdu() failed");
1231 case DATA_PDU_TYPE_POINTER:
1232 if (!update_recv_pointer(rdp->update, cs))
1234 WLog_Print(rdp->log, WLOG_ERROR,
1235 "DATA_PDU_TYPE_POINTER - update_recv_pointer() failed");
1241 case DATA_PDU_TYPE_SYNCHRONIZE:
1242 if (!rdp_recv_server_synchronize_pdu(rdp, cs))
1244 WLog_Print(rdp->log, WLOG_ERROR,
1245 "DATA_PDU_TYPE_SYNCHRONIZE - rdp_recv_synchronize_pdu() failed");
1251 case DATA_PDU_TYPE_PLAY_SOUND:
1252 if (!update_recv_play_sound(rdp->update, cs))
1254 WLog_Print(rdp->log, WLOG_ERROR,
1255 "DATA_PDU_TYPE_PLAY_SOUND - update_recv_play_sound() failed");
1261 case DATA_PDU_TYPE_SHUTDOWN_DENIED:
1262 if (!rdp_recv_server_shutdown_denied_pdu(rdp, cs))
1265 rdp->log, WLOG_ERROR,
1266 "DATA_PDU_TYPE_SHUTDOWN_DENIED - rdp_recv_server_shutdown_denied_pdu() failed");
1272 case DATA_PDU_TYPE_SAVE_SESSION_INFO:
1273 if (!rdp_recv_save_session_info(rdp, cs))
1275 WLog_Print(rdp->log, WLOG_ERROR,
1276 "DATA_PDU_TYPE_SAVE_SESSION_INFO - rdp_recv_save_session_info() failed");
1282 case DATA_PDU_TYPE_FONT_MAP:
1283 if (!rdp_recv_font_map_pdu(rdp, cs))
1285 WLog_Print(rdp->log, WLOG_ERROR,
1286 "DATA_PDU_TYPE_FONT_MAP - rdp_recv_font_map_pdu() failed");
1292 case DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS:
1293 if (!rdp_recv_server_set_keyboard_indicators_pdu(rdp, cs))
1295 WLog_Print(rdp->log, WLOG_ERROR,
1296 "DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS - "
1297 "rdp_recv_server_set_keyboard_indicators_pdu() failed");
1303 case DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS:
1304 if (!rdp_recv_server_set_keyboard_ime_status_pdu(rdp, cs))
1306 WLog_Print(rdp->log, WLOG_ERROR,
1307 "DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS - "
1308 "rdp_recv_server_set_keyboard_ime_status_pdu() failed");
1314 case DATA_PDU_TYPE_SET_ERROR_INFO:
1315 if (!rdp_recv_set_error_info_data_pdu(rdp, cs))
1318 rdp->log, WLOG_ERROR,
1319 "DATA_PDU_TYPE_SET_ERROR_INFO - rdp_recv_set_error_info_data_pdu() failed");
1325 case DATA_PDU_TYPE_ARC_STATUS:
1326 if (!rdp_recv_server_auto_reconnect_status_pdu(rdp, cs))
1328 WLog_Print(rdp->log, WLOG_ERROR,
1329 "DATA_PDU_TYPE_ARC_STATUS - "
1330 "rdp_recv_server_auto_reconnect_status_pdu() failed");
1336 case DATA_PDU_TYPE_STATUS_INFO:
1337 if (!rdp_recv_server_status_info_pdu(rdp, cs))
1339 WLog_Print(rdp->log, WLOG_ERROR,
1340 "DATA_PDU_TYPE_STATUS_INFO - rdp_recv_server_status_info_pdu() failed");
1346 case DATA_PDU_TYPE_MONITOR_LAYOUT:
1347 if (!rdp_recv_monitor_layout_pdu(rdp, cs))
1349 WLog_Print(rdp->log, WLOG_ERROR,
1350 "DATA_PDU_TYPE_MONITOR_LAYOUT - rdp_recv_monitor_layout_pdu() failed");
1357 WLog_Print(rdp->log, WLOG_WARN,
1358 "[UNHANDLED] %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1359 data_pdu_type_to_string(type), type, length);
1366 return STATE_RUN_SUCCESS;
1372 return STATE_RUN_FAILED;
1375state_run_t rdp_recv_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 securityFlags)
1380 if (securityFlags & SEC_AUTODETECT_REQ)
1383 return autodetect_recv_request_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1386 if (securityFlags & SEC_AUTODETECT_RSP)
1389 return autodetect_recv_response_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1392 if (securityFlags & SEC_HEARTBEAT)
1395 return rdp_recv_heartbeat_packet(rdp, s);
1398 if (securityFlags & SEC_TRANSPORT_REQ)
1400 return multitransport_recv_request(rdp->multitransport, s);
1403 if (securityFlags & SEC_TRANSPORT_RSP)
1405 return multitransport_recv_response(rdp->multitransport, s);
1408 if (securityFlags & SEC_LICENSE_PKT)
1410 return license_recv(rdp->license, s);
1413 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
1415 return license_recv(rdp->license, s);
1418 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
1420 return license_recv(rdp->license, s);
1423 return STATE_RUN_SUCCESS;
1426state_run_t rdp_recv_out_of_sequence_pdu(rdpRdp* rdp,
wStream* s, UINT16 pduType, UINT16 length)
1428 state_run_t rc = STATE_RUN_FAILED;
1434 rc = rdp_recv_data_pdu(rdp, s);
1436 case PDU_TYPE_SERVER_REDIRECTION:
1437 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1439 case PDU_TYPE_FLOW_RESPONSE:
1440 case PDU_TYPE_FLOW_STOP:
1441 case PDU_TYPE_FLOW_TEST:
1442 rc = STATE_RUN_SUCCESS;
1446 char buffer1[256] = WINPR_C_ARRAY_INIT;
1447 char buffer2[256] = WINPR_C_ARRAY_INIT;
1449 WLog_Print(rdp->log, WLOG_ERROR,
"expected %s, got %s",
1450 pdu_type_to_str(PDU_TYPE_DEMAND_ACTIVE, buffer1,
sizeof(buffer1)),
1451 pdu_type_to_str(pduType, buffer2,
sizeof(buffer2)));
1452 rc = STATE_RUN_FAILED;
1457 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1458 return STATE_RUN_FAILED;
1462BOOL rdp_read_flow_control_pdu(rdpRdp* rdp,
wStream* s, UINT16* type, UINT16* channel_id)
1476 WINPR_ASSERT(channel_id);
1478 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 6))
1480 Stream_Read_UINT8(s, pduType);
1482 Stream_Seek_UINT8(s);
1483 Stream_Seek_UINT8(s);
1484 Stream_Seek_UINT8(s);
1485 Stream_Read_UINT16(s, *channel_id);
1500BOOL rdp_decrypt(rdpRdp* rdp,
wStream* s, UINT16* pLength, UINT16 securityFlags)
1503 BYTE cmac[8] = WINPR_C_ARRAY_INIT;
1504 BYTE wmac[8] = WINPR_C_ARRAY_INIT;
1505 BOOL status = FALSE;
1508 WINPR_ASSERT(rdp->settings);
1510 WINPR_ASSERT(pLength);
1514 INT32 length = *pLength;
1515 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_NONE)
1518 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
1520 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
1524 Stream_Read_UINT16(s, len);
1526 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS length %" PRIu16
" != 0x10",
1530 Stream_Read_UINT8(s, version);
1532 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS version %" PRIu16
" != 1",
1536 Stream_Read_UINT8(s, pad);
1537 const BYTE* sig = Stream_ConstPointer(s);
1540 const INT32 padLength = length - pad;
1542 if ((length <= 0) || (padLength <= 0) || (padLength > UINT16_MAX))
1544 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid pad length %" PRId32, padLength);
1548 if (!security_fips_decrypt(Stream_Pointer(s), (
size_t)length, rdp))
1551 if (!security_fips_check_signature(Stream_ConstPointer(s), (
size_t)padLength, sig, 8, rdp))
1554 Stream_SetLength(s, Stream_Length(s) - pad);
1555 *pLength = (UINT16)padLength;
1559 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s,
sizeof(wmac)))
1562 Stream_Read(s, wmac,
sizeof(wmac));
1563 length -=
sizeof(wmac);
1567 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid length field");
1571 if (!security_decrypt(Stream_PointerAs(s, BYTE), (
size_t)length, rdp))
1574 if (securityFlags & SEC_SECURE_CHECKSUM)
1575 status = security_salted_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length,
1576 FALSE, cmac,
sizeof(cmac));
1578 status = security_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length, cmac,
1584 if (memcmp(wmac, cmac,
sizeof(wmac)) != 0)
1586 WLog_Print(rdp->log, WLOG_ERROR,
"WARNING: invalid packet signature");
1597 *pLength = (UINT16)length;
1601 security_unlock(rdp);
1605const char* pdu_type_to_str(UINT16 pduType,
char* buffer,
size_t length)
1607 const char* str =
nullptr;
1610 case PDU_TYPE_DEMAND_ACTIVE:
1611 str =
"PDU_TYPE_DEMAND_ACTIVE";
1613 case PDU_TYPE_CONFIRM_ACTIVE:
1614 str =
"PDU_TYPE_CONFIRM_ACTIVE";
1616 case PDU_TYPE_DEACTIVATE_ALL:
1617 str =
"PDU_TYPE_DEACTIVATE_ALL";
1620 str =
"PDU_TYPE_DATA";
1622 case PDU_TYPE_SERVER_REDIRECTION:
1623 str =
"PDU_TYPE_SERVER_REDIRECTION";
1625 case PDU_TYPE_FLOW_TEST:
1626 str =
"PDU_TYPE_FLOW_TEST";
1628 case PDU_TYPE_FLOW_RESPONSE:
1629 str =
"PDU_TYPE_FLOW_RESPONSE";
1631 case PDU_TYPE_FLOW_STOP:
1632 str =
"PDU_TYPE_FLOW_STOP";
1635 str =
"PDU_TYPE_UNKNOWN";
1639 winpr_str_append(str, buffer, length,
"");
1641 char msg[32] = WINPR_C_ARRAY_INIT;
1642 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", pduType);
1643 winpr_str_append(msg, buffer, length,
"");
1654static state_run_t rdp_recv_tpkt_pdu(rdpRdp* rdp,
wStream* s)
1656 state_run_t rc = STATE_RUN_SUCCESS;
1659 UINT16 pduSource = 0;
1660 UINT16 channelId = 0;
1661 UINT16 securityFlags = 0;
1664 WINPR_ASSERT(rdp->context);
1667 freerdp* instance = rdp->context->instance;
1668 WINPR_ASSERT(instance);
1670 if (!rdp_read_header(rdp, s, &length, &channelId))
1671 return STATE_RUN_FAILED;
1673 if (freerdp_shall_disconnect_context(rdp->context))
1674 return STATE_RUN_SUCCESS;
1676 if (rdp->autodetect->bandwidthMeasureStarted)
1678 rdp->autodetect->bandwidthMeasureByteCount += length;
1681 if (rdp->mcs->messageChannelId && (channelId == rdp->mcs->messageChannelId))
1684 return rdp_handle_message_channel(rdp, s, channelId, length);
1687 if (rdp->settings->UseRdpSecurityLayer)
1689 if (!rdp_read_security_header(rdp, s, &securityFlags, &length))
1690 return STATE_RUN_FAILED;
1692 if (securityFlags & (SEC_ENCRYPT | SEC_REDIRECTION_PKT))
1694 if (!rdp_decrypt(rdp, s, &length, securityFlags))
1695 return STATE_RUN_FAILED;
1698 if (securityFlags & SEC_REDIRECTION_PKT)
1704 Stream_Rewind(s, 2);
1707 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1712 if (channelId == MCS_GLOBAL_CHANNEL_ID)
1714 while (Stream_GetRemainingLength(s) > 3)
1721 if (!rdp_read_share_control_header(rdp, s,
nullptr, &remain, &pduType, &pduSource))
1722 return STATE_RUN_FAILED;
1724 sub = Stream_StaticInit(&subbuffer, Stream_Pointer(s), remain);
1725 if (!Stream_SafeSeek(s, remain))
1726 return STATE_RUN_FAILED;
1728 rdp->settings->PduSource = pduSource;
1734 rc = rdp_recv_data_pdu(rdp, sub);
1735 if (state_run_failed(rc))
1739 case PDU_TYPE_DEACTIVATE_ALL:
1740 if (!rdp_recv_deactivate_all(rdp, sub))
1742 WLog_Print(rdp->log, WLOG_ERROR,
1743 "rdp_recv_tpkt_pdu: rdp_recv_deactivate_all() fail");
1744 return STATE_RUN_FAILED;
1749 case PDU_TYPE_SERVER_REDIRECTION:
1750 return rdp_recv_enhanced_security_redirection_packet(rdp, sub);
1752 case PDU_TYPE_FLOW_RESPONSE:
1753 case PDU_TYPE_FLOW_STOP:
1754 case PDU_TYPE_FLOW_TEST:
1755 WLog_Print(rdp->log, WLOG_DEBUG,
"flow message 0x%04" PRIX16
"", pduType);
1757 if (!Stream_SafeSeek(sub, remain))
1758 return STATE_RUN_FAILED;
1763 char buffer[256] = WINPR_C_ARRAY_INIT;
1764 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect PDU type: %s",
1765 pdu_type_to_str(pduType, buffer,
sizeof(buffer)));
1770 diff = Stream_GetRemainingLength(sub);
1773 char buffer[256] = WINPR_C_ARRAY_INIT;
1774 WLog_Print(rdp->log, WLOG_WARN,
1775 "pduType %s not properly parsed, %" PRIuz
1776 " bytes remaining unhandled. Skipping.",
1777 pdu_type_to_str(pduType, buffer,
sizeof(buffer)), diff);
1785 if (!freerdp_channel_process(instance, s, channelId, length))
1786 return STATE_RUN_FAILED;
1790 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1791 return STATE_RUN_FAILED;
1795static state_run_t rdp_recv_fastpath_pdu(rdpRdp* rdp,
wStream* s)
1800 rdpFastPath* fastpath = rdp->fastpath;
1802 if (!fastpath_read_header_rdp(fastpath, s, &length))
1804 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_recv_fastpath_pdu: fastpath_read_header_rdp() fail");
1805 return STATE_RUN_FAILED;
1808 if ((length == 0) || (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, length)))
1810 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect FastPath PDU header length %" PRIu16
"",
1812 return STATE_RUN_FAILED;
1815 if (rdp->autodetect->bandwidthMeasureStarted)
1817 rdp->autodetect->bandwidthMeasureByteCount += length;
1820 if (!fastpath_decrypt(fastpath, s, &length))
1821 return STATE_RUN_FAILED;
1823 return fastpath_recv_updates(rdp->fastpath, s);
1826static state_run_t rdp_recv_pdu(rdpRdp* rdp,
wStream* s)
1828 const int rc = tpkt_verify_header(s);
1830 return rdp_recv_tpkt_pdu(rdp, s);
1832 return rdp_recv_fastpath_pdu(rdp, s);
1834 return STATE_RUN_FAILED;
1837static state_run_t rdp_handle_sc_flags(rdpRdp* rdp,
wStream* s, UINT32 flag,
1838 CONNECTION_STATE nextState)
1840 const UINT32 mask = FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
1841 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU;
1843 state_run_t status = rdp_recv_pdu(rdp, s);
1844 if (state_run_success(status))
1846 const UINT32 flags = rdp->finalize_sc_pdus & mask;
1847 if ((flags & flag) == flag)
1849 if (!rdp_client_transition_to_state(rdp, nextState))
1850 status = STATE_RUN_FAILED;
1852 status = STATE_RUN_SUCCESS;
1856 char flag_buffer[256] = WINPR_C_ARRAY_INIT;
1857 char mask_buffer[256] = WINPR_C_ARRAY_INIT;
1858 WLog_Print(rdp->log, WLOG_WARN,
1859 "[%s] unexpected server message, expected flag %s [have %s]",
1860 rdp_get_state_string(rdp),
1861 rdp_finalize_flags_to_str(flag, flag_buffer,
sizeof(flag_buffer)),
1862 rdp_finalize_flags_to_str(flags, mask_buffer,
sizeof(mask_buffer)));
1868static state_run_t rdp_client_exchange_monitor_layout(rdpRdp* rdp,
wStream* s)
1872 if (!rdp_check_monitor_layout_pdu_state(rdp, FALSE))
1873 return STATE_RUN_FAILED;
1878 const UINT32 old = rdp->finalize_sc_pdus;
1879 state_run_t status = rdp_recv_pdu(rdp, s);
1880 const UINT32 now = rdp->finalize_sc_pdus;
1881 const BOOL changed = (old != now) || rdp->monitor_layout_pdu;
1884 if (state_run_success(status) && changed)
1886 if (!rdp->monitor_layout_pdu)
1888 if (!rdp_finalize_is_flag_set(rdp, FINALIZE_SC_SYNCHRONIZE_PDU))
1889 return STATE_RUN_FAILED;
1892 status = rdp_client_connect_finalize(rdp);
1893 if (state_run_success(status) && !rdp->monitor_layout_pdu)
1894 status = STATE_RUN_TRY_AGAIN;
1899static state_run_t rdp_recv_callback_int(WINPR_ATTR_UNUSED rdpTransport* transport,
wStream* s,
1902 state_run_t status = STATE_RUN_SUCCESS;
1903 rdpRdp* rdp = (rdpRdp*)extra;
1905 WINPR_ASSERT(transport);
1909 switch (rdp_get_state(rdp))
1911 case CONNECTION_STATE_NEGO:
1912 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1913 status = STATE_RUN_FAILED;
1915 status = STATE_RUN_CONTINUE;
1917 case CONNECTION_STATE_NLA:
1918 if (nla_get_state(rdp->nla) < NLA_STATE_AUTH_INFO)
1920 if (nla_recv_pdu(rdp->nla, s) < 1)
1922 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nla_recv_pdu() fail",
1923 rdp_get_state_string(rdp));
1924 status = STATE_RUN_FAILED;
1927 else if (nla_get_state(rdp->nla) == NLA_STATE_POST_NEGO)
1929 if (nego_recv(rdp->transport, s, (
void*)rdp->nego) < 0)
1930 return STATE_RUN_FAILED;
1932 if (!nego_update_settings_from_state(rdp->nego, rdp->settings))
1933 return STATE_RUN_FAILED;
1935 if (nego_get_state(rdp->nego) != NEGO_STATE_FINAL)
1937 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nego_recv() fail",
1938 rdp_get_state_string(rdp));
1939 status = STATE_RUN_FAILED;
1941 else if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
1942 status = STATE_RUN_FAILED;
1945 if (state_run_success(status))
1947 if (nla_get_state(rdp->nla) == NLA_STATE_AUTH_INFO)
1949 transport_set_nla_mode(rdp->transport, FALSE);
1951 if (rdp->settings->VmConnectMode)
1953 if (!nego_set_state(rdp->nego, NEGO_STATE_NLA))
1954 status = STATE_RUN_FAILED;
1955 else if (!nego_set_requested_protocols(rdp->nego,
1956 PROTOCOL_HYBRID | PROTOCOL_SSL))
1957 status = STATE_RUN_FAILED;
1958 else if (!nego_send_negotiation_request(rdp->nego))
1959 status = STATE_RUN_FAILED;
1960 else if (!nla_set_state(rdp->nla, NLA_STATE_POST_NEGO))
1961 status = STATE_RUN_FAILED;
1965 if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
1966 status = STATE_RUN_FAILED;
1970 if (state_run_success(status))
1973 if (nla_get_state(rdp->nla) == NLA_STATE_FINAL)
1975 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1976 status = STATE_RUN_FAILED;
1978 status = STATE_RUN_CONTINUE;
1983 case CONNECTION_STATE_AAD:
1984 if (aad_recv(rdp->aad, s) < 1)
1986 WLog_Print(rdp->log, WLOG_ERROR,
"%s - aad_recv() fail", rdp_get_state_string(rdp));
1987 status = STATE_RUN_FAILED;
1989 if (state_run_success(status))
1991 if (aad_get_state(rdp->aad) == AAD_STATE_FINAL)
1993 transport_set_aad_mode(rdp->transport, FALSE);
1994 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1995 status = STATE_RUN_FAILED;
1997 status = STATE_RUN_CONTINUE;
2002 case CONNECTION_STATE_MCS_CREATE_REQUEST:
2003 if (!mcs_client_begin(rdp->mcs))
2005 WLog_Print(rdp->log, WLOG_ERROR,
"%s - mcs_client_begin() fail",
2006 rdp_get_state_string(rdp));
2007 status = STATE_RUN_FAILED;
2009 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_RESPONSE))
2010 status = STATE_RUN_FAILED;
2011 else if (Stream_GetRemainingLength(s) > 0)
2012 status = STATE_RUN_CONTINUE;
2015 case CONNECTION_STATE_MCS_CREATE_RESPONSE:
2016 if (!mcs_recv_connect_response(rdp->mcs, s))
2018 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_connect_response failure");
2019 status = STATE_RUN_FAILED;
2023 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ERECT_DOMAIN))
2024 status = STATE_RUN_FAILED;
2025 else if (!mcs_send_erect_domain_request(rdp->mcs))
2027 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_erect_domain_request failure");
2028 status = STATE_RUN_FAILED;
2030 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ATTACH_USER))
2031 status = STATE_RUN_FAILED;
2032 else if (!mcs_send_attach_user_request(rdp->mcs))
2034 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_attach_user_request failure");
2035 status = STATE_RUN_FAILED;
2037 else if (!rdp_client_transition_to_state(rdp,
2038 CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM))
2039 status = STATE_RUN_FAILED;
2043 case CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM:
2044 if (!mcs_recv_attach_user_confirm(rdp->mcs, s))
2046 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_attach_user_confirm failure");
2047 status = STATE_RUN_FAILED;
2051 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST))
2052 status = STATE_RUN_FAILED;
2053 else if (!mcs_send_channel_join_request(rdp->mcs, rdp->mcs->userId))
2055 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_channel_join_request failure");
2056 status = STATE_RUN_FAILED;
2058 else if (!rdp_client_transition_to_state(
2059 rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE))
2060 status = STATE_RUN_FAILED;
2065 if (!rdp_client_skip_mcs_channel_join(rdp))
2066 status = STATE_RUN_FAILED;
2070 case CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE:
2071 if (!rdp_client_connect_mcs_channel_join_confirm(rdp, s))
2073 WLog_Print(rdp->log, WLOG_ERROR,
2075 "rdp_client_connect_mcs_channel_join_confirm() fail",
2076 rdp_get_state_string(rdp));
2077 status = STATE_RUN_FAILED;
2082 case CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST:
2083 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2085 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_LICENSING))
2086 status = STATE_RUN_FAILED;
2088 status = STATE_RUN_TRY_AGAIN;
2092 case CONNECTION_STATE_LICENSING:
2093 status = rdp_client_connect_license(rdp, s);
2095 if (state_run_failed(status))
2097 char buffer[64] = WINPR_C_ARRAY_INIT;
2098 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_client_connect_license() - %s",
2099 rdp_get_state_string(rdp),
2100 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2105 case CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST:
2106 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2108 if (!rdp_client_transition_to_state(
2109 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE))
2110 status = STATE_RUN_FAILED;
2112 status = STATE_RUN_TRY_AGAIN;
2116 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE:
2117 status = rdp_client_connect_demand_active(rdp, s);
2119 if (state_run_failed(status))
2121 char buffer[64] = WINPR_C_ARRAY_INIT;
2122 WLog_Print(rdp->log, WLOG_DEBUG,
2124 "rdp_client_connect_demand_active() - %s",
2125 rdp_get_state_string(rdp),
2126 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2128 else if (status == STATE_RUN_ACTIVE)
2130 if (!rdp_client_transition_to_state(
2131 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE))
2132 status = STATE_RUN_FAILED;
2134 status = STATE_RUN_CONTINUE;
2138 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT:
2139 status = rdp_client_exchange_monitor_layout(rdp, s);
2142 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE:
2143 status = rdp_client_connect_confirm_active(rdp, s);
2146 case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
2147 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_SYNCHRONIZE_PDU,
2148 CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE);
2150 case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
2151 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_COOPERATE_PDU,
2152 CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL);
2154 case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
2155 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_GRANTED_PDU,
2156 CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP);
2158 case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
2159 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_FONT_MAP_PDU, CONNECTION_STATE_ACTIVE);
2162 case CONNECTION_STATE_ACTIVE:
2163 status = rdp_recv_pdu(rdp, s);
2165 if (state_run_failed(status))
2167 char buffer[64] = WINPR_C_ARRAY_INIT;
2168 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_recv_pdu() - %s",
2169 rdp_get_state_string(rdp),
2170 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2175 WLog_Print(rdp->log, WLOG_ERROR,
"%s state %u", rdp_get_state_string(rdp),
2176 rdp_get_state(rdp));
2177 status = STATE_RUN_FAILED;
2181 if (state_run_failed(status))
2183 char buffer[64] = WINPR_C_ARRAY_INIT;
2184 WLog_Print(rdp->log, WLOG_ERROR,
"%s status %s", rdp_get_state_string(rdp),
2185 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2190state_run_t rdp_recv_callback(rdpTransport* transport,
wStream* s,
void* extra)
2192 char buffer[64] = WINPR_C_ARRAY_INIT;
2193 state_run_t rc = STATE_RUN_FAILED;
2194 const size_t start = Stream_GetPosition(s);
2195 const rdpContext* context = transport_get_context(transport);
2197 WINPR_ASSERT(context);
2200 const rdpRdp* rdp = context->rdp;
2203 if (rc == STATE_RUN_TRY_AGAIN)
2204 Stream_SetPosition(s, start);
2206 const char* old = rdp_get_state_string(rdp);
2207 const size_t orem = Stream_GetRemainingLength(s);
2208 rc = rdp_recv_callback_int(transport, s, extra);
2210 const char* now = rdp_get_state_string(rdp);
2211 const size_t rem = Stream_GetRemainingLength(s);
2213 WLog_Print(rdp->log, WLOG_TRACE,
2214 "(client)[%s -> %s] current return %s [feeding %" PRIuz
" bytes, %" PRIuz
2215 " bytes not processed]",
2216 old, now, state_run_result_string(rc, buffer,
sizeof(buffer)), orem, rem);
2217 }
while ((rc == STATE_RUN_TRY_AGAIN) || (rc == STATE_RUN_CONTINUE));
2221BOOL rdp_send_channel_data(rdpRdp* rdp, UINT16 channelId,
const BYTE* data,
size_t size)
2223 return freerdp_channel_send(rdp, channelId, data, size);
2226BOOL rdp_channel_send_packet(rdpRdp* rdp, UINT16 channelId,
size_t totalSize, UINT32 flags,
2227 const BYTE* data,
size_t chunkSize)
2229 return freerdp_channel_send_packet(rdp, channelId, totalSize, flags, data, chunkSize);
2232BOOL rdp_send_error_info(rdpRdp* rdp)
2234 UINT16 sec_flags = 0;
2238 if (rdp->errorInfo == ERRINFO_SUCCESS)
2241 s = rdp_data_pdu_init(rdp, &sec_flags);
2246 Stream_Write_UINT32(s, rdp->errorInfo);
2247 status = rdp_send_data_pdu(rdp, s, DATA_PDU_TYPE_SET_ERROR_INFO, 0, sec_flags);
2251int rdp_check_fds(rdpRdp* rdp)
2254 rdpTsg* tsg =
nullptr;
2255 rdpTransport* transport =
nullptr;
2258 transport = rdp->transport;
2260 tsg = transport_get_tsg(transport);
2263 if (!tsg_check_event_handles(tsg))
2265 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_check_fds: tsg_check_event_handles()");
2269 if (tsg_get_state(tsg) != TSG_STATE_PIPE_CREATED)
2273 status = transport_check_fds(transport);
2277 if (!rdp_client_redirect(rdp))
2282 WLog_Print(rdp->log, WLOG_DEBUG,
"transport_check_fds() - %i", status);
2284 status = freerdp_timer_poll(rdp->timer);
2289BOOL freerdp_get_stats(
const rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes, UINT64* inPackets,
2296 *inBytes = rdp->inBytes;
2298 *outBytes = rdp->outBytes;
2300 *inPackets = rdp->inPackets;
2302 *outPackets = rdp->outPackets;
2307static bool rdp_new_common(rdpRdp* rdp)
2312 rdp->transport = transport_new(rdp->context);
2313 if (!rdp->transport)
2318 if (!transport_set_io_callbacks(rdp->transport, rdp->io))
2322 rdp->aad = aad_new(rdp->context);
2326 rdp->nego = nego_new(rdp->transport);
2330 rdp->mcs = mcs_new(rdp->context);
2334 rdp->license = license_new(rdp);
2338 rdp->fastpath = fastpath_new(rdp);
2352rdpRdp* rdp_new(rdpContext* context)
2355 rdpRdp* rdp = (rdpRdp*)calloc(1,
sizeof(rdpRdp));
2360 rdp->log = WLog_Get(RDP_TAG);
2361 WINPR_ASSERT(rdp->log);
2363 (void)_snprintf(rdp->log_context,
sizeof(rdp->log_context),
"%p", (
void*)context);
2364 WLog_SetContext(rdp->log,
nullptr, rdp->log_context);
2366 InitializeCriticalSection(&rdp->critical);
2367 rdp->context = context;
2368 WINPR_ASSERT(rdp->context);
2370 if (context->ServerMode)
2373 if (!context->settings)
2381 rdp->settings = context->settings;
2384 if (!rdp_set_backup_settings(rdp))
2387 rdp->settings->instance = context->instance;
2389 context->settings = rdp->settings;
2390 if (context->instance)
2391 context->settings->instance = context->instance;
2392 else if (context->peer)
2394 rdp->settings->instance = context->peer;
2396#if defined(WITH_FREERDP_DEPRECATED)
2397 context->peer->settings = rdp->settings;
2401 if (!rdp_new_common(rdp))
2405 const rdpTransportIo* io = transport_get_io_callbacks(rdp->transport);
2408 rdp->io = calloc(1,
sizeof(rdpTransportIo));
2414 rdp->input = input_new(rdp);
2419 rdp->update = update_new(rdp);
2424 rdp->redirection = redirection_new();
2426 if (!rdp->redirection)
2429 rdp->autodetect = autodetect_new(rdp->context);
2431 if (!rdp->autodetect)
2434 rdp->heartbeat = heartbeat_new();
2436 if (!rdp->heartbeat)
2439 rdp->multitransport = multitransport_new(rdp, INITIATE_REQUEST_PROTOCOL_UDPFECL |
2440 INITIATE_REQUEST_PROTOCOL_UDPFECR);
2442 if (!rdp->multitransport)
2445 rdp->bulk = bulk_new(context);
2450 rdp->pubSub = PubSub_New(TRUE);
2454 rdp->abortEvent = CreateEvent(
nullptr, TRUE, FALSE,
nullptr);
2455 if (!rdp->abortEvent)
2458 rdp->timer = freerdp_timer_new(rdp);
2465 WINPR_PRAGMA_DIAG_PUSH
2466 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2468 WINPR_PRAGMA_DIAG_POP
2472static void rdp_reset_free(rdpRdp* rdp)
2477 rdp_free_rc4_decrypt_keys(rdp);
2478 rdp_free_rc4_encrypt_keys(rdp);
2480 winpr_Cipher_Free(rdp->fips_encrypt);
2481 winpr_Cipher_Free(rdp->fips_decrypt);
2482 rdp->fips_encrypt =
nullptr;
2483 rdp->fips_decrypt =
nullptr;
2484 security_unlock(rdp);
2488 nego_free(rdp->nego);
2489 license_free(rdp->license);
2490 transport_free(rdp->transport);
2491 fastpath_free(rdp->fastpath);
2495 rdp->nego =
nullptr;
2496 rdp->license =
nullptr;
2497 rdp->transport =
nullptr;
2498 rdp->fastpath =
nullptr;
2501BOOL rdp_reset(rdpRdp* rdp)
2507 rdpSettings* settings = rdp->settings;
2508 WINPR_ASSERT(settings);
2510 bulk_reset(rdp->bulk);
2512 rdp_reset_free(rdp);
2526 rc = rdp_new_common(rdp);
2530 if (!transport_set_layer(rdp->transport, TRANSPORT_LAYER_TCP))
2534 rc = rdp_finalize_reset_flags(rdp, TRUE);
2545void rdp_free(rdpRdp* rdp)
2549 freerdp_timer_free(rdp->timer);
2550 rdp_reset_free(rdp);
2556 input_free(rdp->input);
2557 update_free(rdp->update);
2559 redirection_free(rdp->redirection);
2560 autodetect_free(rdp->autodetect);
2561 heartbeat_free(rdp->heartbeat);
2562 multitransport_free(rdp->multitransport);
2563 bulk_free(rdp->bulk);
2565 PubSub_Free(rdp->pubSub);
2566 if (rdp->abortEvent)
2567 (void)CloseHandle(rdp->abortEvent);
2570 DeleteCriticalSection(&rdp->critical);
2575BOOL rdp_io_callback_set_event(rdpRdp* rdp, BOOL set)
2579 return transport_io_callback_set_event(rdp->transport, set);
2582const rdpTransportIo* rdp_get_io_callbacks(rdpRdp* rdp)
2589BOOL rdp_set_io_callbacks(rdpRdp* rdp,
const rdpTransportIo* io_callbacks)
2597 rdp->io = malloc(
sizeof(rdpTransportIo));
2600 *rdp->io = *io_callbacks;
2601 return transport_set_io_callbacks(rdp->transport, rdp->io);
2606BOOL rdp_set_io_callback_context(rdpRdp* rdp,
void* usercontext)
2609 rdp->ioContext = usercontext;
2613void* rdp_get_io_callback_context(rdpRdp* rdp)
2616 return rdp->ioContext;
2619const char* rdp_finalize_flags_to_str(UINT32 flags,
char* buffer,
size_t size)
2621 char number[32] = WINPR_C_ARRAY_INIT;
2623 (uint32_t)~(FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
2624 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU |
2625 FINALIZE_CS_SYNCHRONIZE_PDU | FINALIZE_CS_CONTROL_COOPERATE_PDU |
2626 FINALIZE_CS_CONTROL_REQUEST_PDU | FINALIZE_CS_PERSISTENT_KEY_LIST_PDU |
2627 FINALIZE_CS_FONT_LIST_PDU | FINALIZE_DEACTIVATE_REACTIVATE);
2629 if (flags & FINALIZE_SC_SYNCHRONIZE_PDU)
2630 winpr_str_append(
"FINALIZE_SC_SYNCHRONIZE_PDU", buffer, size,
"|");
2631 if (flags & FINALIZE_SC_CONTROL_COOPERATE_PDU)
2632 winpr_str_append(
"FINALIZE_SC_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2633 if (flags & FINALIZE_SC_CONTROL_GRANTED_PDU)
2634 winpr_str_append(
"FINALIZE_SC_CONTROL_GRANTED_PDU", buffer, size,
"|");
2635 if (flags & FINALIZE_SC_FONT_MAP_PDU)
2636 winpr_str_append(
"FINALIZE_SC_FONT_MAP_PDU", buffer, size,
"|");
2637 if (flags & FINALIZE_CS_SYNCHRONIZE_PDU)
2638 winpr_str_append(
"FINALIZE_CS_SYNCHRONIZE_PDU", buffer, size,
"|");
2639 if (flags & FINALIZE_CS_CONTROL_COOPERATE_PDU)
2640 winpr_str_append(
"FINALIZE_CS_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2641 if (flags & FINALIZE_CS_CONTROL_REQUEST_PDU)
2642 winpr_str_append(
"FINALIZE_CS_CONTROL_REQUEST_PDU", buffer, size,
"|");
2643 if (flags & FINALIZE_CS_PERSISTENT_KEY_LIST_PDU)
2644 winpr_str_append(
"FINALIZE_CS_PERSISTENT_KEY_LIST_PDU", buffer, size,
"|");
2645 if (flags & FINALIZE_CS_FONT_LIST_PDU)
2646 winpr_str_append(
"FINALIZE_CS_FONT_LIST_PDU", buffer, size,
"|");
2647 if (flags & FINALIZE_DEACTIVATE_REACTIVATE)
2648 winpr_str_append(
"FINALIZE_DEACTIVATE_REACTIVATE", buffer, size,
"|");
2650 winpr_str_append(
"UNKNOWN_FLAG", buffer, size,
"|");
2652 winpr_str_append(
"NO_FLAG_SET", buffer, size,
"|");
2653 (void)_snprintf(number,
sizeof(number),
" [0x%08" PRIx32
"]", flags);
2654 winpr_str_append(number, buffer, size,
"");
2658BOOL rdp_finalize_reset_flags(rdpRdp* rdp, BOOL clearAll)
2661 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] reset finalize_sc_pdus", rdp_get_state_string(rdp));
2663 rdp->finalize_sc_pdus = 0;
2665 rdp->finalize_sc_pdus &= FINALIZE_DEACTIVATE_REACTIVATE;
2667 return rdp_set_monitor_layout_pdu_state(rdp, FALSE);
2670BOOL rdp_finalize_set_flag(rdpRdp* rdp, UINT32 flag)
2672 char buffer[1024] = WINPR_C_ARRAY_INIT;
2676 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] received flag %s", rdp_get_state_string(rdp),
2677 rdp_finalize_flags_to_str(flag, buffer,
sizeof(buffer)));
2678 rdp->finalize_sc_pdus |= flag;
2682BOOL rdp_finalize_is_flag_set(rdpRdp* rdp, UINT32 flag)
2685 return (rdp->finalize_sc_pdus & flag) == flag;
2688BOOL rdp_reset_rc4_encrypt_keys(rdpRdp* rdp)
2691 rdp_free_rc4_encrypt_keys(rdp);
2692 rdp->rc4_encrypt_key = winpr_RC4_New(rdp->encrypt_key, rdp->rc4_key_len);
2694 rdp->encrypt_use_count = 0;
2695 return rdp->rc4_encrypt_key !=
nullptr;
2698void rdp_free_rc4_encrypt_keys(rdpRdp* rdp)
2701 winpr_RC4_Free(rdp->rc4_encrypt_key);
2702 rdp->rc4_encrypt_key =
nullptr;
2705void rdp_free_rc4_decrypt_keys(rdpRdp* rdp)
2708 winpr_RC4_Free(rdp->rc4_decrypt_key);
2709 rdp->rc4_decrypt_key =
nullptr;
2712BOOL rdp_reset_rc4_decrypt_keys(rdpRdp* rdp)
2715 rdp_free_rc4_decrypt_keys(rdp);
2716 rdp->rc4_decrypt_key = winpr_RC4_New(rdp->decrypt_key, rdp->rc4_key_len);
2718 rdp->decrypt_use_count = 0;
2719 return rdp->rc4_decrypt_key !=
nullptr;
2722const char* rdp_security_flag_string(UINT32 securityFlags,
char* buffer,
size_t size)
2724 if (securityFlags & SEC_EXCHANGE_PKT)
2725 winpr_str_append(
"SEC_EXCHANGE_PKT", buffer, size,
"|");
2726 if (securityFlags & SEC_TRANSPORT_REQ)
2727 winpr_str_append(
"SEC_TRANSPORT_REQ", buffer, size,
"|");
2728 if (securityFlags & SEC_TRANSPORT_RSP)
2729 winpr_str_append(
"SEC_TRANSPORT_RSP", buffer, size,
"|");
2730 if (securityFlags & SEC_ENCRYPT)
2731 winpr_str_append(
"SEC_ENCRYPT", buffer, size,
"|");
2732 if (securityFlags & SEC_RESET_SEQNO)
2733 winpr_str_append(
"SEC_RESET_SEQNO", buffer, size,
"|");
2734 if (securityFlags & SEC_IGNORE_SEQNO)
2735 winpr_str_append(
"SEC_IGNORE_SEQNO", buffer, size,
"|");
2736 if (securityFlags & SEC_INFO_PKT)
2737 winpr_str_append(
"SEC_INFO_PKT", buffer, size,
"|");
2738 if (securityFlags & SEC_LICENSE_PKT)
2739 winpr_str_append(
"SEC_LICENSE_PKT", buffer, size,
"|");
2740 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
2741 winpr_str_append(
"SEC_LICENSE_ENCRYPT_CS", buffer, size,
"|");
2742 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
2743 winpr_str_append(
"SEC_LICENSE_ENCRYPT_SC", buffer, size,
"|");
2744 if (securityFlags & SEC_REDIRECTION_PKT)
2745 winpr_str_append(
"SEC_REDIRECTION_PKT", buffer, size,
"|");
2746 if (securityFlags & SEC_SECURE_CHECKSUM)
2747 winpr_str_append(
"SEC_SECURE_CHECKSUM", buffer, size,
"|");
2748 if (securityFlags & SEC_AUTODETECT_REQ)
2749 winpr_str_append(
"SEC_AUTODETECT_REQ", buffer, size,
"|");
2750 if (securityFlags & SEC_AUTODETECT_RSP)
2751 winpr_str_append(
"SEC_AUTODETECT_RSP", buffer, size,
"|");
2752 if (securityFlags & SEC_HEARTBEAT)
2753 winpr_str_append(
"SEC_HEARTBEAT", buffer, size,
"|");
2754 if (securityFlags & SEC_FLAGSHI_VALID)
2755 winpr_str_append(
"SEC_FLAGSHI_VALID", buffer, size,
"|");
2757 char msg[32] = WINPR_C_ARRAY_INIT;
2759 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", securityFlags);
2760 winpr_str_append(msg, buffer, size,
"");
2765static BOOL rdp_reset_remote_settings(rdpRdp* rdp)
2767 UINT32 flags = FREERDP_SETTINGS_REMOTE_MODE;
2774 return rdp->remoteSettings !=
nullptr;
2777BOOL rdp_set_backup_settings(rdpRdp* rdp)
2782 if (!rdp->originalSettings)
2784 return rdp_reset_remote_settings(rdp);
2787BOOL rdp_reset_runtime_settings(rdpRdp* rdp)
2790 WINPR_ASSERT(rdp->context);
2797 return rdp_reset_remote_settings(rdp);
2800static BOOL starts_with(
const char* tok,
const char* val)
2802 const size_t len = strlen(val);
2803 if (strncmp(tok, val, len) != 0)
2805 if (tok[len] !=
'=')
2810static BOOL option_equals(
const char* what,
const char* val)
2812 return _stricmp(what, val) == 0;
2815static BOOL parse_on_off_option(
const char* value)
2817 WINPR_ASSERT(value);
2818 const char* sep = strchr(value,
'=');
2821 if (option_equals(
"on", &sep[1]))
2823 if (option_equals(
"true", &sep[1]))
2825 if (option_equals(
"off", &sep[1]))
2827 if (option_equals(
"false", &sep[1]))
2831 long val = strtol(value,
nullptr, 0);
2840static BOOL option_is_runtime_checks(WINPR_ATTR_UNUSED wLog* log,
const char* tok)
2842 const char* experimental[] = { STR(WITH_VERBOSE_WINPR_ASSERT) };
2843 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2845 const char* opt = experimental[x];
2846 if (starts_with(tok, opt))
2848 return parse_on_off_option(tok);
2854static BOOL option_is_experimental(WINPR_ATTR_UNUSED wLog* log,
const char* tok)
2856 const char* experimental[] = { STR(WITH_DSP_EXPERIMENTAL), STR(WITH_VAAPI) };
2857 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2859 const char* opt = experimental[x];
2860 if (starts_with(tok, opt))
2862 return parse_on_off_option(tok);
2868static BOOL option_is_debug(wLog* log,
const char* tok)
2871 const char* debug[] = { STR(WITH_DEBUG_ALL),
2872 STR(WITH_DEBUG_CERTIFICATE),
2873 STR(WITH_DEBUG_CAPABILITIES),
2874 STR(WITH_DEBUG_CHANNELS),
2875 STR(WITH_DEBUG_CLIPRDR),
2876 STR(WITH_DEBUG_CODECS),
2877 STR(WITH_DEBUG_RDPGFX),
2878 STR(WITH_DEBUG_DVC),
2879 STR(WITH_DEBUG_TSMF),
2880 STR(WITH_DEBUG_KBD),
2881 STR(WITH_DEBUG_LICENSE),
2882 STR(WITH_DEBUG_NEGO),
2883 STR(WITH_DEBUG_NLA),
2884 STR(WITH_DEBUG_TSG),
2885 STR(WITH_DEBUG_RAIL),
2886 STR(WITH_DEBUG_RDP),
2887 STR(WITH_DEBUG_RDPEI),
2888 STR(WITH_DEBUG_REDIR),
2889 STR(WITH_DEBUG_RDPDR),
2890 STR(WITH_DEBUG_RFX),
2891 STR(WITH_DEBUG_SCARD),
2892 STR(WITH_DEBUG_SND),
2893 STR(WITH_DEBUG_SVC),
2894 STR(WITH_DEBUG_TRANSPORT),
2895 STR(WITH_DEBUG_TIMEZONE),
2896 STR(WITH_DEBUG_WND),
2897 STR(WITH_DEBUG_X11_CLIPRDR),
2898 STR(WITH_DEBUG_X11_LOCAL_MOVESIZE),
2899 STR(WITH_DEBUG_X11),
2901 STR(WITH_DEBUG_RINGBUFFER),
2902 STR(WITH_DEBUG_SYMBOLS),
2903 STR(WITH_DEBUG_EVENTS),
2904 STR(WITH_DEBUG_MUTEX),
2905 STR(WITH_DEBUG_NTLM),
2906 STR(WITH_DEBUG_SDL_EVENTS),
2907 STR(WITH_DEBUG_SDL_KBD_EVENTS),
2908 STR(WITH_DEBUG_THREADS),
2909 STR(WITH_DEBUG_URBDRC) };
2911 for (
size_t x = 0; x < ARRAYSIZE(debug); x++)
2913 const char* opt = debug[x];
2914 if (starts_with(tok, opt))
2915 return parse_on_off_option(tok);
2918 if (starts_with(tok,
"WITH_DEBUG"))
2920 WLog_Print(log, WLOG_WARN,
"[BUG] Unmapped Debug-Build option '%s'.", tok);
2921 return parse_on_off_option(tok);
2927static void log_build_warn(rdpRdp* rdp,
const char* what,
const char* msg,
2928 BOOL (*cmp)(wLog* log,
const char* tok))
2931 WINPR_PRAGMA_DIAG_PUSH
2932 WINPR_PRAGMA_DIAG_IGNORED_OVERLENGTH_STRINGS
2934 size_t len =
sizeof(FREERDP_BUILD_CONFIG);
2935 char* list = calloc(len,
sizeof(
char));
2936 char* config = _strdup(FREERDP_BUILD_CONFIG);
2937 WINPR_PRAGMA_DIAG_POP
2941 char* saveptr =
nullptr;
2942 char* tok = strtok_s(config,
" ", &saveptr);
2945 if (cmp(rdp->log, tok))
2946 winpr_str_append(tok, list, len,
" ");
2948 tok = strtok_s(
nullptr,
" ", &saveptr);
2955 if (strlen(list) > 0)
2957 WLog_Print(rdp->log, WLOG_WARN,
"*************************************************");
2958 WLog_Print(rdp->log, WLOG_WARN,
"This build is using [%s] build options:", what);
2960 char* saveptr =
nullptr;
2961 char* tok = strtok_s(list,
" ", &saveptr);
2964 WLog_Print(rdp->log, WLOG_WARN,
"* '%s'", tok);
2965 tok = strtok_s(
nullptr,
" ", &saveptr);
2967 WLog_Print(rdp->log, WLOG_WARN,
"*");
2968 WLog_Print(rdp->log, WLOG_WARN,
"[%s] build options %s", what, msg);
2969 WLog_Print(rdp->log, WLOG_WARN,
"*************************************************");
2975#define print_first_line(log, firstLine, what) \
2976 print_first_line_int((log), (firstLine), (what), __FILE__, __func__, __LINE__)
2977static void print_first_line_int(wLog* log, log_line_t* firstLine,
const char* what,
2978 const char* file,
const char* fkt,
size_t line)
2980 WINPR_ASSERT(firstLine);
2981 if (!firstLine->fkt)
2983 const DWORD level = WLOG_WARN;
2984 if (WLog_IsLevelActive(log, level))
2986 WLog_PrintTextMessage(log, level, line, file, fkt,
2987 "*************************************************");
2988 WLog_PrintTextMessage(log, level, line, file, fkt,
2989 "[SSL] {%s} build or configuration missing:", what);
2991 firstLine->line = line;
2992 firstLine->file = file;
2993 firstLine->fkt = fkt;
2994 firstLine->level = level;
2998static void print_last_line(wLog* log,
const log_line_t* firstLine)
3000 WINPR_ASSERT(firstLine);
3003 if (WLog_IsLevelActive(log, firstLine->level))
3004 WLog_PrintTextMessage(log, firstLine->level, firstLine->line, firstLine->file,
3006 "*************************************************");
3010static void log_build_warn_cipher(rdpRdp* rdp, log_line_t* firstLine, WINPR_CIPHER_TYPE md,
3013 BOOL haveCipher = FALSE;
3015 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3016 char iv[WINPR_CIPHER_MAX_IV_LENGTH] = WINPR_C_ARRAY_INIT;
3020 if (md == WINPR_CIPHER_ARC4_128)
3022 WINPR_RC4_CTX* enc = winpr_RC4_New(key,
sizeof(key));
3023 haveCipher = enc !=
nullptr;
3024 winpr_RC4_Free(enc);
3028 WINPR_CIPHER_CTX* enc =
3029 winpr_Cipher_NewEx(md, WINPR_ENCRYPT, key,
sizeof(key), iv,
sizeof(iv));
3030 WINPR_CIPHER_CTX* dec =
3031 winpr_Cipher_NewEx(md, WINPR_DECRYPT, key,
sizeof(key), iv,
sizeof(iv));
3035 winpr_Cipher_Free(enc);
3036 winpr_Cipher_Free(dec);
3041 print_first_line(rdp->log, firstLine,
"Cipher");
3042 WLog_Print(rdp->log, WLOG_WARN,
"* %s: %s", winpr_cipher_type_to_string(md), what);
3046static void log_build_warn_hmac(rdpRdp* rdp, log_line_t* firstLine, WINPR_MD_TYPE md,
3049 BOOL haveHmacX = FALSE;
3050 WINPR_HMAC_CTX* hmac = winpr_HMAC_New();
3056 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3057 haveHmacX = winpr_HMAC_Init(hmac, md, key,
sizeof(key));
3059 winpr_HMAC_Free(hmac);
3063 print_first_line(rdp->log, firstLine,
"HMAC");
3064 WLog_Print(rdp->log, WLOG_WARN,
" * %s: %s", winpr_md_type_to_string(md), what);
3068static void log_build_warn_hash(rdpRdp* rdp, log_line_t* firstLine, WINPR_MD_TYPE md,
3071 BOOL haveDigestX = FALSE;
3073 WINPR_DIGEST_CTX* digest = winpr_Digest_New();
3075 haveDigestX = winpr_Digest_Init(digest, md);
3076 winpr_Digest_Free(digest);
3080 print_first_line(rdp->log, firstLine,
"Digest");
3081 WLog_Print(rdp->log, WLOG_WARN,
" * %s: %s", winpr_md_type_to_string(md), what);
3085static void log_build_warn_ssl(rdpRdp* rdp)
3089 log_line_t firstHashLine = WINPR_C_ARRAY_INIT;
3090 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD4,
"NTLM support not available");
3091 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD5,
3092 "NTLM, assistance files with encrypted passwords, autoreconnect cookies, "
3093 "licensing and RDP security will not work");
3094 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_SHA1,
3095 "assistance files with encrypted passwords, Kerberos, Smartcard Logon, RDP "
3096 "security support not available");
3097 log_build_warn_hash(
3098 rdp, &firstHashLine, WINPR_MD_SHA256,
3099 "file clipboard, AAD gateway, NLA security and certificates might not work");
3100 print_last_line(rdp->log, &firstHashLine);
3102 log_line_t firstHmacLine = WINPR_C_ARRAY_INIT;
3103 log_build_warn_hmac(rdp, &firstHmacLine, WINPR_MD_MD5,
"Autoreconnect cookie not supported");
3104 log_build_warn_hmac(rdp, &firstHmacLine, WINPR_MD_SHA1,
"RDP security not supported");
3105 print_last_line(rdp->log, &firstHmacLine);
3107 log_line_t firstCipherLine = WINPR_C_ARRAY_INIT;
3108 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_ARC4_128,
3109 "assistance files with encrypted passwords, NTLM, RDP licensing and RDP "
3110 "security will not work");
3111 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_DES_EDE3_CBC,
3112 "RDP security FIPS mode will not work");
3113 log_build_warn_cipher(
3114 rdp, &firstCipherLine, WINPR_CIPHER_AES_128_CBC,
3115 "assistance file encrypted LHTicket will not work and ARM gateway might not");
3116 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_AES_192_CBC,
3117 "ARM gateway might not work");
3118 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_AES_256_CBC,
3119 "ARM gateway might not work");
3120 print_last_line(rdp->log, &firstCipherLine);
3123void rdp_log_build_warnings(rdpRdp* rdp)
3125 static unsigned count = 0;
3134 log_build_warn(rdp,
"experimental",
"might crash the application", option_is_experimental);
3135 log_build_warn(rdp,
"debug",
"might leak sensitive information (credentials, ...)",
3137 log_build_warn(rdp,
"runtime-check",
"might slow down the application",
3138 option_is_runtime_checks);
3139 log_build_warn_ssl(rdp);
3142size_t rdp_get_event_handles(rdpRdp* rdp, HANDLE* handles, uint32_t count)
3144 size_t nCount = transport_get_event_handles(rdp->transport, handles, count);
3149 if (count < nCount + 2UL)
3152 handles[nCount++] = utils_get_abort_event(rdp);
3153 handles[nCount++] = freerdp_timer_get_event(rdp->timer);
WINPR_API void WINPR_JSON_Delete(WINPR_JSON *item)
Delete a WinPR JSON wrapper object.
WINPR_ATTR_NODISCARD FREERDP_API rdpSettings * freerdp_settings_clone(const rdpSettings *settings)
Creates a deep copy of settings.
FREERDP_API BOOL freerdp_settings_set_pointer_len(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id, const void *data, size_t len)
Set a pointer to value data.
FREERDP_API void freerdp_settings_free(rdpSettings *settings)
Free a settings struct with all data in it.
#define FREERDP_SETTINGS_SERVER_MODE
WINPR_ATTR_NODISCARD FREERDP_API rdpSettings * freerdp_settings_new(DWORD flags)
creates a new setting struct
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
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.