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 return PubSub_OnTerminate(rdp->pubSub, context, &e) >= 0;
647 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 5))
650 if (!per_read_integer16(s, &initiator, MCS_BASE_CHANNEL_ID))
653 if (!per_read_integer16(s, channelId, 0))
656 const uint8_t dataPriority = Stream_Get_UINT8(s);
657 WLog_Print(rdp->log, WLOG_TRACE,
"dataPriority=%" PRIu8, dataPriority);
659 if (!per_read_length(s, length))
662 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length))
678BOOL rdp_write_header(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 channelId, UINT16 sec_flags)
681 WINPR_ASSERT(rdp->settings);
683 WINPR_ASSERT(length >= RDP_PACKET_HEADER_MAX_LENGTH);
684 if (length > UINT16_MAX)
687 DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataIndication
688 : DomainMCSPDU_SendDataRequest;
690 if ((sec_flags & SEC_ENCRYPT) && (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS))
692 const UINT16 body_length = (UINT16)length - RDP_PACKET_HEADER_MAX_LENGTH;
693 const UINT16 pad = 8 - (body_length % 8);
699 if (!mcs_write_domain_mcspdu_header(s, MCSPDU, (UINT16)length, 0))
701 if (!per_write_integer16(s, rdp->mcs->userId, MCS_BASE_CHANNEL_ID))
703 if (!per_write_integer16(s, channelId, 0))
705 if (!Stream_EnsureRemainingCapacity(s, 3))
707 Stream_Write_UINT8(s, 0x70);
714 length = (length - RDP_PACKET_HEADER_MAX_LENGTH) | 0x8000;
715 Stream_Write_UINT16_BE(
716 s, WINPR_ASSERTING_INT_CAST(uint16_t, length));
720static BOOL rdp_security_stream_out(rdpRdp* rdp,
wStream* s,
size_t length, UINT16 sec_flags,
725 if (length > UINT16_MAX)
732 WINPR_ASSERT(sec_flags <= UINT16_MAX);
733 if (!rdp_write_security_header(rdp, s, sec_flags))
736 if (sec_flags & SEC_ENCRYPT)
738 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
740 BYTE* data = Stream_PointerAs(s, BYTE) + 12;
741 const size_t size = WINPR_ASSERTING_INT_CAST(
size_t, (data - Stream_Buffer(s)));
747 Stream_Write_UINT16(s, 0x10);
748 Stream_Write_UINT8(s, 0x1);
750 *pad = 8 - (length % 8);
756 memset(data + length, 0, *pad);
758 Stream_Write_UINT8(s, WINPR_ASSERTING_INT_CAST(uint8_t, *pad));
760 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
762 if (!security_hmac_signature(data, length, Stream_Pointer(s), 8, rdp))
766 if (!security_fips_encrypt(data, length + *pad, rdp))
771 const BYTE* data = Stream_PointerAs(s,
const BYTE) + 8;
772 const size_t diff = Stream_GetPosition(s) + 8ULL;
777 if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
779 if (sec_flags & SEC_SECURE_CHECKSUM)
780 status = security_salted_mac_signature(rdp, data, (UINT32)length, TRUE,
781 Stream_Pointer(s), 8);
783 status = security_mac_signature(rdp, data, (UINT32)length,
784 Stream_PointerAs(s, BYTE), 8);
791 if (!security_encrypt(Stream_Pointer(s), length, rdp))
800static UINT32 rdp_get_sec_bytes(rdpRdp* rdp, UINT16 sec_flags)
802 UINT32 sec_bytes = 0;
804 if (sec_flags & SEC_ENCRYPT)
808 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
811 else if (sec_flags != 0)
823BOOL rdp_send(rdpRdp* rdp,
wStream* s, UINT16 channelId, UINT16 sec_flags)
827 BOOL should_unlock = FALSE;
835 if (sec_flags & SEC_ENCRYPT)
838 should_unlock = TRUE;
842 size_t length = Stream_GetPosition(s);
843 Stream_ResetPosition(s);
844 if (!rdp_write_header(rdp, s, length, channelId, sec_flags))
847 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
851 if (!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_ResetPosition(s);
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 if (!Stream_SetPosition(s, sec_hold))
900 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
904 if (!Stream_SetPosition(s, length))
906 Stream_SealLength(s);
909 if (transport_write(rdp->transport, s) < 0)
915 security_unlock(rdp);
919BOOL rdp_send_data_pdu(rdpRdp* rdp,
wStream* s, BYTE type, UINT16 channel_id, UINT16 sec_flags)
922 UINT32 sec_bytes = 0;
925 BOOL should_unlock = FALSE;
933 if (sec_flags & SEC_ENCRYPT)
936 should_unlock = TRUE;
940 size_t length = Stream_GetPosition(s);
941 Stream_ResetPosition(s);
942 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
944 sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
945 sec_hold = Stream_GetPosition(s);
946 Stream_Seek(s, sec_bytes);
947 if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, PDU_TYPE_DATA, channel_id))
949 if (!rdp_write_share_data_header(rdp, s, length - sec_bytes, type, rdp->settings->ShareId))
951 if (!Stream_SetPosition(s, sec_hold))
954 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
958 if (!Stream_SetPosition(s, length))
960 Stream_SealLength(s);
962 WLog_Print(rdp->log, WLOG_DEBUG,
963 "sending data (type=0x%x size=%" PRIuz
" channelId=%" PRIu16
")", type,
964 Stream_Length(s), channel_id);
967 if (transport_write(rdp->transport, s) < 0)
973 security_unlock(rdp);
978BOOL rdp_send_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 sec_flags)
982 BOOL should_unlock = FALSE;
987 if (sec_flags & SEC_ENCRYPT)
990 should_unlock = TRUE;
994 size_t length = Stream_GetPosition(s);
995 Stream_ResetPosition(s);
996 if (!rdp_write_header(rdp, s, length, rdp->mcs->messageChannelId, sec_flags))
999 if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
1003 if (!Stream_SetPosition(s, length))
1006 Stream_SealLength(s);
1008 if (transport_write(rdp->transport, s) < 0)
1014 security_unlock(rdp);
1020static BOOL rdp_recv_server_shutdown_denied_pdu(WINPR_ATTR_UNUSED rdpRdp* rdp,
1026static BOOL rdp_recv_server_set_keyboard_indicators_pdu(rdpRdp* rdp,
wStream* s)
1031 rdpContext* context = rdp->context;
1032 WINPR_ASSERT(context);
1033 WINPR_ASSERT(context->update);
1035 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1038 const uint16_t unitId = Stream_Get_UINT16(s);
1041 WLog_Print(rdp->log, WLOG_WARN,
1042 "[MS-RDPBCGR] 2.2.8.2.1.1 Set Keyboard Indicators PDU Data "
1043 "(TS_SET_KEYBOARD_INDICATORS_PDU)::unitId should be 0, is %" PRIu16,
1046 const UINT16 ledFlags = Stream_Get_UINT16(s);
1047 return IFCALLRESULT(TRUE, context->update->SetKeyboardIndicators, context, ledFlags);
1050static BOOL rdp_recv_server_set_keyboard_ime_status_pdu(rdpRdp* rdp,
wStream* s)
1052 if (!rdp || !rdp->input)
1055 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 10))
1058 const uint16_t unitId = Stream_Get_UINT16(s);
1061 WLog_Print(rdp->log, WLOG_WARN,
1062 "[MS-RDPBCGR] 2.2.8.2.2.1 Set Keyboard IME Status PDU Data "
1063 "(TS_SET_KEYBOARD_IME_STATUS_PDU)::unitId should be 0, is %" PRIu16,
1066 const uint32_t imeState = Stream_Get_UINT32(s);
1067 const uint32_t imeConvMode = Stream_Get_UINT32(s);
1068 return IFCALLRESULT(TRUE, rdp->update->SetKeyboardImeStatus, rdp->context, unitId, imeState,
1072static BOOL rdp_recv_set_error_info_data_pdu(rdpRdp* rdp,
wStream* s)
1074 UINT32 errorInfo = 0;
1076 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1079 Stream_Read_UINT32(s, errorInfo);
1080 return rdp_set_error_info(rdp, errorInfo);
1083static BOOL rdp_recv_server_auto_reconnect_status_pdu(rdpRdp* rdp,
wStream* s)
1085 UINT32 arcStatus = 0;
1087 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1090 Stream_Read_UINT32(s, arcStatus);
1091 WLog_Print(rdp->log, WLOG_WARN,
"AutoReconnectStatus: 0x%08" PRIX32
"", arcStatus);
1095static BOOL rdp_recv_server_status_info_pdu(rdpRdp* rdp,
wStream* s)
1097 UINT32 statusCode = 0;
1099 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1102 Stream_Read_UINT32(s, statusCode);
1104 if (rdp->update->ServerStatusInfo)
1105 return rdp->update->ServerStatusInfo(rdp->context, statusCode);
1110static void log_monitor(
size_t idx,
const MONITOR_DEF* monitor, wLog* log, DWORD level)
1112 WINPR_ASSERT(monitor);
1114 WLog_Print(log, level,
"[%" PRIuz
"] {%dx%d-%dx%d} [0x%08" PRIx32
"]", idx, monitor->left,
1115 monitor->top, monitor->right, monitor->bottom, monitor->flags);
1118static void log_monitor_configuration(wLog* log,
const MONITOR_DEF* monitors,
size_t count)
1120 const DWORD level = WLOG_DEBUG;
1121 WLog_Print(log, level,
"[BEGIN] RemoteMonitors[%" PRIuz
"]", count);
1122 for (
size_t x = 0; x < count; x++)
1125 log_monitor(x, monitor, log, level);
1127 WLog_Print(log, level,
"[END] RemoteMonitors[%" PRIuz
"]", count);
1130static BOOL rdp_recv_monitor_layout_pdu(rdpRdp* rdp,
wStream* s)
1135 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1138 const UINT32 monitorCount = Stream_Get_UINT32(s);
1140 if (!Stream_CheckAndLogRequiredLengthOfSizeWLog(rdp->log, s, monitorCount, 20ull))
1145 if (!monitorDefArray)
1148 for (UINT32 index = 0; index < monitorCount; index++)
1151 Stream_Read_INT32(s, monitor->left);
1152 Stream_Read_INT32(s, monitor->top);
1153 Stream_Read_INT32(s, monitor->right);
1154 Stream_Read_INT32(s, monitor->bottom);
1155 Stream_Read_UINT32(s, monitor->flags);
1158 log_monitor_configuration(rdp->log, monitorDefArray, monitorCount);
1159 IFCALLRET(rdp->update->RemoteMonitors, ret, rdp->context, monitorCount, monitorDefArray);
1160 free(monitorDefArray);
1163 return rdp_set_monitor_layout_pdu_state(rdp, TRUE);
1166state_run_t rdp_recv_data_pdu(rdpRdp* rdp,
wStream* s)
1172 BYTE compressedType = 0;
1173 UINT16 compressedLength = 0;
1176 if (!rdp_read_share_data_header(rdp, s, &length, &type, &shareId, &compressedType,
1179 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_read_share_data_header() failed");
1180 return STATE_RUN_FAILED;
1185 if (compressedType & PACKET_COMPRESSED)
1187 if (compressedLength < 18)
1189 WLog_Print(rdp->log, WLOG_ERROR,
1190 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1192 return STATE_RUN_FAILED;
1196 const BYTE* pDstData =
nullptr;
1197 UINT16 SrcSize = compressedLength - 18;
1199 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, SrcSize))
1201 WLog_Print(rdp->log, WLOG_ERROR,
1202 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1204 return STATE_RUN_FAILED;
1207 if (bulk_decompress(rdp->bulk, Stream_ConstPointer(s), SrcSize, &pDstData, &DstSize,
1210 cs = transport_take_from_pool(rdp->transport, DstSize);
1213 WLog_Print(rdp->log, WLOG_ERROR,
"Couldn't take stream from pool");
1214 return STATE_RUN_FAILED;
1217 Stream_ResetPosition(cs);
1218 Stream_Write(cs, pDstData, DstSize);
1219 Stream_SealLength(cs);
1220 Stream_ResetPosition(cs);
1224 WLog_Print(rdp->log, WLOG_ERROR,
"bulk_decompress() failed");
1225 return STATE_RUN_FAILED;
1228 Stream_Seek(s, SrcSize);
1231 WLog_Print(rdp->log, WLOG_DEBUG,
"recv %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1232 data_pdu_type_to_string(type), type, length);
1236 case DATA_PDU_TYPE_UPDATE:
1237 if (!update_recv(rdp->update, cs))
1239 WLog_Print(rdp->log, WLOG_ERROR,
"DATA_PDU_TYPE_UPDATE - update_recv() failed");
1245 case DATA_PDU_TYPE_CONTROL:
1246 if (!rdp_recv_server_control_pdu(rdp, cs))
1248 WLog_Print(rdp->log, WLOG_ERROR,
1249 "DATA_PDU_TYPE_CONTROL - rdp_recv_server_control_pdu() failed");
1255 case DATA_PDU_TYPE_POINTER:
1256 if (!update_recv_pointer(rdp->update, cs))
1258 WLog_Print(rdp->log, WLOG_ERROR,
1259 "DATA_PDU_TYPE_POINTER - update_recv_pointer() failed");
1265 case DATA_PDU_TYPE_SYNCHRONIZE:
1266 if (!rdp_recv_server_synchronize_pdu(rdp, cs))
1268 WLog_Print(rdp->log, WLOG_ERROR,
1269 "DATA_PDU_TYPE_SYNCHRONIZE - rdp_recv_synchronize_pdu() failed");
1275 case DATA_PDU_TYPE_PLAY_SOUND:
1276 if (!update_recv_play_sound(rdp->update, cs))
1278 WLog_Print(rdp->log, WLOG_ERROR,
1279 "DATA_PDU_TYPE_PLAY_SOUND - update_recv_play_sound() failed");
1285 case DATA_PDU_TYPE_SHUTDOWN_DENIED:
1286 if (!rdp_recv_server_shutdown_denied_pdu(rdp, cs))
1289 rdp->log, WLOG_ERROR,
1290 "DATA_PDU_TYPE_SHUTDOWN_DENIED - rdp_recv_server_shutdown_denied_pdu() failed");
1296 case DATA_PDU_TYPE_SAVE_SESSION_INFO:
1297 if (!rdp_recv_save_session_info(rdp, cs))
1299 WLog_Print(rdp->log, WLOG_ERROR,
1300 "DATA_PDU_TYPE_SAVE_SESSION_INFO - rdp_recv_save_session_info() failed");
1306 case DATA_PDU_TYPE_FONT_MAP:
1307 if (!rdp_recv_font_map_pdu(rdp, cs))
1309 WLog_Print(rdp->log, WLOG_ERROR,
1310 "DATA_PDU_TYPE_FONT_MAP - rdp_recv_font_map_pdu() failed");
1316 case DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS:
1317 if (!rdp_recv_server_set_keyboard_indicators_pdu(rdp, cs))
1319 WLog_Print(rdp->log, WLOG_ERROR,
1320 "DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS - "
1321 "rdp_recv_server_set_keyboard_indicators_pdu() failed");
1327 case DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS:
1328 if (!rdp_recv_server_set_keyboard_ime_status_pdu(rdp, cs))
1330 WLog_Print(rdp->log, WLOG_ERROR,
1331 "DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS - "
1332 "rdp_recv_server_set_keyboard_ime_status_pdu() failed");
1338 case DATA_PDU_TYPE_SET_ERROR_INFO:
1339 if (!rdp_recv_set_error_info_data_pdu(rdp, cs))
1342 rdp->log, WLOG_ERROR,
1343 "DATA_PDU_TYPE_SET_ERROR_INFO - rdp_recv_set_error_info_data_pdu() failed");
1349 case DATA_PDU_TYPE_ARC_STATUS:
1350 if (!rdp_recv_server_auto_reconnect_status_pdu(rdp, cs))
1352 WLog_Print(rdp->log, WLOG_ERROR,
1353 "DATA_PDU_TYPE_ARC_STATUS - "
1354 "rdp_recv_server_auto_reconnect_status_pdu() failed");
1360 case DATA_PDU_TYPE_STATUS_INFO:
1361 if (!rdp_recv_server_status_info_pdu(rdp, cs))
1363 WLog_Print(rdp->log, WLOG_ERROR,
1364 "DATA_PDU_TYPE_STATUS_INFO - rdp_recv_server_status_info_pdu() failed");
1370 case DATA_PDU_TYPE_MONITOR_LAYOUT:
1371 if (!rdp_recv_monitor_layout_pdu(rdp, cs))
1373 WLog_Print(rdp->log, WLOG_ERROR,
1374 "DATA_PDU_TYPE_MONITOR_LAYOUT - rdp_recv_monitor_layout_pdu() failed");
1381 WLog_Print(rdp->log, WLOG_WARN,
1382 "[UNHANDLED] %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1383 data_pdu_type_to_string(type), type, length);
1390 return STATE_RUN_SUCCESS;
1396 return STATE_RUN_FAILED;
1399state_run_t rdp_recv_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 securityFlags)
1404 if (securityFlags & SEC_AUTODETECT_REQ)
1407 return autodetect_recv_request_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1410 if (securityFlags & SEC_AUTODETECT_RSP)
1413 return autodetect_recv_response_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1416 if (securityFlags & SEC_HEARTBEAT)
1419 return rdp_recv_heartbeat_packet(rdp, s);
1422 if (securityFlags & SEC_TRANSPORT_REQ)
1424 return multitransport_recv_request(rdp->multitransport, s);
1427 if (securityFlags & SEC_TRANSPORT_RSP)
1429 return multitransport_recv_response(rdp->multitransport, s);
1432 if (securityFlags & SEC_LICENSE_PKT)
1434 return license_recv(rdp->license, s);
1437 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
1439 return license_recv(rdp->license, s);
1442 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
1444 return license_recv(rdp->license, s);
1447 return STATE_RUN_SUCCESS;
1450state_run_t rdp_recv_out_of_sequence_pdu(rdpRdp* rdp,
wStream* s, UINT16 pduType, UINT16 length)
1452 state_run_t rc = STATE_RUN_FAILED;
1458 rc = rdp_recv_data_pdu(rdp, s);
1460 case PDU_TYPE_SERVER_REDIRECTION:
1461 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1463 case PDU_TYPE_FLOW_RESPONSE:
1464 case PDU_TYPE_FLOW_STOP:
1465 case PDU_TYPE_FLOW_TEST:
1466 rc = STATE_RUN_SUCCESS;
1470 char buffer1[256] = WINPR_C_ARRAY_INIT;
1471 char buffer2[256] = WINPR_C_ARRAY_INIT;
1473 WLog_Print(rdp->log, WLOG_ERROR,
"expected %s, got %s",
1474 pdu_type_to_str(PDU_TYPE_DEMAND_ACTIVE, buffer1,
sizeof(buffer1)),
1475 pdu_type_to_str(pduType, buffer2,
sizeof(buffer2)));
1476 rc = STATE_RUN_FAILED;
1481 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1482 return STATE_RUN_FAILED;
1486BOOL rdp_read_flow_control_pdu(rdpRdp* rdp,
wStream* s, UINT16* type, UINT16* channel_id)
1500 WINPR_ASSERT(channel_id);
1502 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 6))
1504 Stream_Read_UINT8(s, pduType);
1506 Stream_Seek_UINT8(s);
1507 Stream_Seek_UINT8(s);
1508 Stream_Seek_UINT8(s);
1509 Stream_Read_UINT16(s, *channel_id);
1524BOOL rdp_decrypt(rdpRdp* rdp,
wStream* s, UINT16* pLength, UINT16 securityFlags)
1527 BYTE cmac[8] = WINPR_C_ARRAY_INIT;
1528 BYTE wmac[8] = WINPR_C_ARRAY_INIT;
1529 BOOL status = FALSE;
1532 WINPR_ASSERT(rdp->settings);
1534 WINPR_ASSERT(pLength);
1538 INT32 length = *pLength;
1539 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_NONE)
1542 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
1544 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
1548 Stream_Read_UINT16(s, len);
1550 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS length %" PRIu16
" != 0x10",
1554 Stream_Read_UINT8(s, version);
1556 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS version %" PRIu16
" != 1",
1560 Stream_Read_UINT8(s, pad);
1561 const BYTE* sig = Stream_ConstPointer(s);
1564 const INT32 padLength = length - pad;
1566 if ((length <= 0) || (padLength <= 0) || (padLength > UINT16_MAX))
1568 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid pad length %" PRId32, padLength);
1572 if (!security_fips_decrypt(Stream_Pointer(s), (
size_t)length, rdp))
1575 if (!security_fips_check_signature(Stream_ConstPointer(s), (
size_t)padLength, sig, 8, rdp))
1578 if (!Stream_SetLength(s, Stream_Length(s) - pad))
1581 *pLength = (UINT16)padLength;
1585 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s,
sizeof(wmac)))
1588 Stream_Read(s, wmac,
sizeof(wmac));
1589 length -=
sizeof(wmac);
1593 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid length field");
1597 if (!security_decrypt(Stream_PointerAs(s, BYTE), (
size_t)length, rdp))
1600 if (securityFlags & SEC_SECURE_CHECKSUM)
1601 status = security_salted_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length,
1602 FALSE, cmac,
sizeof(cmac));
1604 status = security_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length, cmac,
1610 if (memcmp(wmac, cmac,
sizeof(wmac)) != 0)
1612 WLog_Print(rdp->log, WLOG_ERROR,
"WARNING: invalid packet signature");
1623 *pLength = (UINT16)length;
1627 security_unlock(rdp);
1631const char* pdu_type_to_str(UINT16 pduType,
char* buffer,
size_t length)
1633 const char* str =
nullptr;
1636 case PDU_TYPE_DEMAND_ACTIVE:
1637 str =
"PDU_TYPE_DEMAND_ACTIVE";
1639 case PDU_TYPE_CONFIRM_ACTIVE:
1640 str =
"PDU_TYPE_CONFIRM_ACTIVE";
1642 case PDU_TYPE_DEACTIVATE_ALL:
1643 str =
"PDU_TYPE_DEACTIVATE_ALL";
1646 str =
"PDU_TYPE_DATA";
1648 case PDU_TYPE_SERVER_REDIRECTION:
1649 str =
"PDU_TYPE_SERVER_REDIRECTION";
1651 case PDU_TYPE_FLOW_TEST:
1652 str =
"PDU_TYPE_FLOW_TEST";
1654 case PDU_TYPE_FLOW_RESPONSE:
1655 str =
"PDU_TYPE_FLOW_RESPONSE";
1657 case PDU_TYPE_FLOW_STOP:
1658 str =
"PDU_TYPE_FLOW_STOP";
1661 str =
"PDU_TYPE_UNKNOWN";
1665 winpr_str_append(str, buffer, length,
"");
1667 char msg[32] = WINPR_C_ARRAY_INIT;
1668 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", pduType);
1669 winpr_str_append(msg, buffer, length,
"");
1680static state_run_t rdp_recv_tpkt_pdu(rdpRdp* rdp,
wStream* s)
1682 state_run_t rc = STATE_RUN_SUCCESS;
1685 UINT16 pduSource = 0;
1686 UINT16 channelId = 0;
1687 UINT16 securityFlags = 0;
1690 WINPR_ASSERT(rdp->context);
1693 freerdp* instance = rdp->context->instance;
1694 WINPR_ASSERT(instance);
1696 if (!rdp_read_header(rdp, s, &length, &channelId))
1697 return STATE_RUN_FAILED;
1699 if (freerdp_shall_disconnect_context(rdp->context))
1700 return STATE_RUN_SUCCESS;
1702 if (rdp->autodetect->bandwidthMeasureStarted)
1704 rdp->autodetect->bandwidthMeasureByteCount += length;
1707 if (rdp->mcs->messageChannelId && (channelId == rdp->mcs->messageChannelId))
1710 return rdp_handle_message_channel(rdp, s, channelId, length);
1713 if (rdp->settings->UseRdpSecurityLayer)
1715 if (!rdp_read_security_header(rdp, s, &securityFlags, &length))
1716 return STATE_RUN_FAILED;
1718 if (securityFlags & (SEC_ENCRYPT | SEC_REDIRECTION_PKT))
1720 if (!rdp_decrypt(rdp, s, &length, securityFlags))
1721 return STATE_RUN_FAILED;
1724 if (securityFlags & SEC_REDIRECTION_PKT)
1730 Stream_Rewind(s, 2);
1733 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1738 if (channelId == MCS_GLOBAL_CHANNEL_ID)
1740 while (Stream_GetRemainingLength(s) > 3)
1747 if (!rdp_read_share_control_header(rdp, s,
nullptr, &remain, &pduType, &pduSource))
1748 return STATE_RUN_FAILED;
1750 sub = Stream_StaticInit(&subbuffer, Stream_Pointer(s), remain);
1751 if (!Stream_SafeSeek(s, remain))
1752 return STATE_RUN_FAILED;
1754 rdp->settings->PduSource = pduSource;
1760 rc = rdp_recv_data_pdu(rdp, sub);
1761 if (state_run_failed(rc))
1765 case PDU_TYPE_DEACTIVATE_ALL:
1766 if (!rdp_recv_deactivate_all(rdp, sub))
1768 WLog_Print(rdp->log, WLOG_ERROR,
1769 "rdp_recv_tpkt_pdu: rdp_recv_deactivate_all() fail");
1770 return STATE_RUN_FAILED;
1775 case PDU_TYPE_SERVER_REDIRECTION:
1776 return rdp_recv_enhanced_security_redirection_packet(rdp, sub);
1778 case PDU_TYPE_FLOW_RESPONSE:
1779 case PDU_TYPE_FLOW_STOP:
1780 case PDU_TYPE_FLOW_TEST:
1781 WLog_Print(rdp->log, WLOG_DEBUG,
"flow message 0x%04" PRIX16
"", pduType);
1783 if (!Stream_SafeSeek(sub, remain))
1784 return STATE_RUN_FAILED;
1789 char buffer[256] = WINPR_C_ARRAY_INIT;
1790 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect PDU type: %s",
1791 pdu_type_to_str(pduType, buffer,
sizeof(buffer)));
1796 diff = Stream_GetRemainingLength(sub);
1799 char buffer[256] = WINPR_C_ARRAY_INIT;
1800 WLog_Print(rdp->log, WLOG_WARN,
1801 "pduType %s not properly parsed, %" PRIuz
1802 " bytes remaining unhandled. Skipping.",
1803 pdu_type_to_str(pduType, buffer,
sizeof(buffer)), diff);
1811 if (!freerdp_channel_process(instance, s, channelId, length))
1812 return STATE_RUN_FAILED;
1816 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1817 return STATE_RUN_FAILED;
1821static state_run_t rdp_recv_fastpath_pdu(rdpRdp* rdp,
wStream* s)
1826 rdpFastPath* fastpath = rdp->fastpath;
1828 if (!fastpath_read_header_rdp(fastpath, s, &length))
1830 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_recv_fastpath_pdu: fastpath_read_header_rdp() fail");
1831 return STATE_RUN_FAILED;
1834 if ((length == 0) || (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, length)))
1836 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect FastPath PDU header length %" PRIu16
"",
1838 return STATE_RUN_FAILED;
1841 if (rdp->autodetect->bandwidthMeasureStarted)
1843 rdp->autodetect->bandwidthMeasureByteCount += length;
1846 if (!fastpath_decrypt(fastpath, s, &length))
1847 return STATE_RUN_FAILED;
1849 return fastpath_recv_updates(rdp->fastpath, s);
1852static state_run_t rdp_recv_pdu(rdpRdp* rdp,
wStream* s)
1854 const int rc = tpkt_verify_header(s);
1856 return rdp_recv_tpkt_pdu(rdp, s);
1858 return rdp_recv_fastpath_pdu(rdp, s);
1860 return STATE_RUN_FAILED;
1863static state_run_t rdp_handle_sc_flags(rdpRdp* rdp,
wStream* s, UINT32 flag,
1864 CONNECTION_STATE nextState)
1866 const UINT32 mask = FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
1867 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU;
1869 state_run_t status = rdp_recv_pdu(rdp, s);
1870 if (state_run_success(status))
1872 const UINT32 flags = rdp->finalize_sc_pdus & mask;
1873 if ((flags & flag) == flag)
1875 if (!rdp_client_transition_to_state(rdp, nextState))
1876 status = STATE_RUN_FAILED;
1878 status = STATE_RUN_SUCCESS;
1882 char flag_buffer[256] = WINPR_C_ARRAY_INIT;
1883 char mask_buffer[256] = WINPR_C_ARRAY_INIT;
1884 WLog_Print(rdp->log, WLOG_WARN,
1885 "[%s] unexpected server message, expected flag %s [have %s]",
1886 rdp_get_state_string(rdp),
1887 rdp_finalize_flags_to_str(flag, flag_buffer,
sizeof(flag_buffer)),
1888 rdp_finalize_flags_to_str(flags, mask_buffer,
sizeof(mask_buffer)));
1894static state_run_t rdp_client_exchange_monitor_layout(rdpRdp* rdp,
wStream* s)
1898 if (!rdp_check_monitor_layout_pdu_state(rdp, FALSE))
1899 return STATE_RUN_FAILED;
1904 const UINT32 old = rdp->finalize_sc_pdus;
1905 state_run_t status = rdp_recv_pdu(rdp, s);
1906 const UINT32 now = rdp->finalize_sc_pdus;
1907 const BOOL changed = (old != now) || rdp->monitor_layout_pdu;
1910 if (state_run_success(status) && changed)
1912 if (!rdp->monitor_layout_pdu)
1914 if (!rdp_finalize_is_flag_set(rdp, FINALIZE_SC_SYNCHRONIZE_PDU))
1915 return STATE_RUN_FAILED;
1918 status = rdp_client_connect_finalize(rdp);
1919 if (state_run_success(status) && !rdp->monitor_layout_pdu)
1920 status = STATE_RUN_TRY_AGAIN;
1925static state_run_t rdp_recv_callback_int(WINPR_ATTR_UNUSED rdpTransport* transport,
wStream* s,
1928 state_run_t status = STATE_RUN_SUCCESS;
1929 rdpRdp* rdp = (rdpRdp*)extra;
1931 WINPR_ASSERT(transport);
1935 switch (rdp_get_state(rdp))
1937 case CONNECTION_STATE_NEGO:
1938 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1939 status = STATE_RUN_FAILED;
1941 status = STATE_RUN_CONTINUE;
1943 case CONNECTION_STATE_NLA:
1944 if (nla_get_state(rdp->nla) < NLA_STATE_AUTH_INFO)
1946 if (nla_recv_pdu(rdp->nla, s) < 1)
1948 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nla_recv_pdu() fail",
1949 rdp_get_state_string(rdp));
1950 status = STATE_RUN_FAILED;
1953 else if (nla_get_state(rdp->nla) == NLA_STATE_POST_NEGO)
1955 if (nego_recv(rdp->transport, s, (
void*)rdp->nego) < 0)
1956 return STATE_RUN_FAILED;
1958 if (!nego_update_settings_from_state(rdp->nego, rdp->settings))
1959 return STATE_RUN_FAILED;
1961 if (nego_get_state(rdp->nego) != NEGO_STATE_FINAL)
1963 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nego_recv() fail",
1964 rdp_get_state_string(rdp));
1965 status = STATE_RUN_FAILED;
1967 else if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
1968 status = STATE_RUN_FAILED;
1971 if (state_run_success(status))
1973 if (nla_get_state(rdp->nla) == NLA_STATE_AUTH_INFO)
1975 transport_set_nla_mode(rdp->transport, FALSE);
1977 if (rdp->settings->VmConnectMode)
1979 if (!nego_set_state(rdp->nego, NEGO_STATE_NLA))
1980 status = STATE_RUN_FAILED;
1981 else if (!nego_set_requested_protocols(rdp->nego,
1982 PROTOCOL_HYBRID | PROTOCOL_SSL))
1983 status = STATE_RUN_FAILED;
1984 else if (!nego_send_negotiation_request(rdp->nego))
1985 status = STATE_RUN_FAILED;
1986 else if (!nla_set_state(rdp->nla, NLA_STATE_POST_NEGO))
1987 status = STATE_RUN_FAILED;
1991 if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
1992 status = STATE_RUN_FAILED;
1996 if (state_run_success(status))
1999 if (nla_get_state(rdp->nla) == NLA_STATE_FINAL)
2001 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
2002 status = STATE_RUN_FAILED;
2004 status = STATE_RUN_CONTINUE;
2009 case CONNECTION_STATE_AAD:
2010 if (aad_recv(rdp->aad, s) < 1)
2012 WLog_Print(rdp->log, WLOG_ERROR,
"%s - aad_recv() fail", rdp_get_state_string(rdp));
2013 status = STATE_RUN_FAILED;
2015 if (state_run_success(status))
2017 if (aad_get_state(rdp->aad) == AAD_STATE_FINAL)
2019 transport_set_aad_mode(rdp->transport, FALSE);
2020 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
2021 status = STATE_RUN_FAILED;
2023 status = STATE_RUN_CONTINUE;
2028 case CONNECTION_STATE_MCS_CREATE_REQUEST:
2029 if (!mcs_client_begin(rdp->mcs))
2031 WLog_Print(rdp->log, WLOG_ERROR,
"%s - mcs_client_begin() fail",
2032 rdp_get_state_string(rdp));
2033 status = STATE_RUN_FAILED;
2035 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_RESPONSE))
2036 status = STATE_RUN_FAILED;
2037 else if (Stream_GetRemainingLength(s) > 0)
2038 status = STATE_RUN_CONTINUE;
2041 case CONNECTION_STATE_MCS_CREATE_RESPONSE:
2042 if (!mcs_recv_connect_response(rdp->mcs, s))
2044 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_connect_response failure");
2045 status = STATE_RUN_FAILED;
2049 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ERECT_DOMAIN))
2050 status = STATE_RUN_FAILED;
2051 else if (!mcs_send_erect_domain_request(rdp->mcs))
2053 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_erect_domain_request failure");
2054 status = STATE_RUN_FAILED;
2056 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ATTACH_USER))
2057 status = STATE_RUN_FAILED;
2058 else if (!mcs_send_attach_user_request(rdp->mcs))
2060 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_attach_user_request failure");
2061 status = STATE_RUN_FAILED;
2063 else if (!rdp_client_transition_to_state(rdp,
2064 CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM))
2065 status = STATE_RUN_FAILED;
2069 case CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM:
2070 if (!mcs_recv_attach_user_confirm(rdp->mcs, s))
2072 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_attach_user_confirm failure");
2073 status = STATE_RUN_FAILED;
2077 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST))
2078 status = STATE_RUN_FAILED;
2079 else if (!mcs_send_channel_join_request(rdp->mcs, rdp->mcs->userId))
2081 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_channel_join_request failure");
2082 status = STATE_RUN_FAILED;
2084 else if (!rdp_client_transition_to_state(
2085 rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE))
2086 status = STATE_RUN_FAILED;
2091 if (!rdp_client_skip_mcs_channel_join(rdp))
2092 status = STATE_RUN_FAILED;
2096 case CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE:
2097 if (!rdp_client_connect_mcs_channel_join_confirm(rdp, s))
2099 WLog_Print(rdp->log, WLOG_ERROR,
2101 "rdp_client_connect_mcs_channel_join_confirm() fail",
2102 rdp_get_state_string(rdp));
2103 status = STATE_RUN_FAILED;
2108 case CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST:
2109 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2111 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_LICENSING))
2112 status = STATE_RUN_FAILED;
2114 status = STATE_RUN_TRY_AGAIN;
2118 case CONNECTION_STATE_LICENSING:
2119 status = rdp_client_connect_license(rdp, s);
2121 if (state_run_failed(status))
2123 char buffer[64] = WINPR_C_ARRAY_INIT;
2124 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_client_connect_license() - %s",
2125 rdp_get_state_string(rdp),
2126 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2131 case CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST:
2132 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2134 if (!rdp_client_transition_to_state(
2135 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE))
2136 status = STATE_RUN_FAILED;
2138 status = STATE_RUN_TRY_AGAIN;
2142 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE:
2143 status = rdp_client_connect_demand_active(rdp, s);
2145 if (state_run_failed(status))
2147 char buffer[64] = WINPR_C_ARRAY_INIT;
2148 WLog_Print(rdp->log, WLOG_DEBUG,
2150 "rdp_client_connect_demand_active() - %s",
2151 rdp_get_state_string(rdp),
2152 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2154 else if (status == STATE_RUN_ACTIVE)
2156 if (!rdp_client_transition_to_state(
2157 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE))
2158 status = STATE_RUN_FAILED;
2160 status = STATE_RUN_CONTINUE;
2164 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT:
2165 status = rdp_client_exchange_monitor_layout(rdp, s);
2168 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE:
2169 status = rdp_client_connect_confirm_active(rdp, s);
2172 case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
2173 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_SYNCHRONIZE_PDU,
2174 CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE);
2176 case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
2177 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_COOPERATE_PDU,
2178 CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL);
2180 case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
2181 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_GRANTED_PDU,
2182 CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP);
2184 case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
2185 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_FONT_MAP_PDU, CONNECTION_STATE_ACTIVE);
2188 case CONNECTION_STATE_ACTIVE:
2189 status = rdp_recv_pdu(rdp, s);
2191 if (state_run_failed(status))
2193 char buffer[64] = WINPR_C_ARRAY_INIT;
2194 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_recv_pdu() - %s",
2195 rdp_get_state_string(rdp),
2196 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2201 WLog_Print(rdp->log, WLOG_ERROR,
"%s state %u", rdp_get_state_string(rdp),
2202 rdp_get_state(rdp));
2203 status = STATE_RUN_FAILED;
2207 if (state_run_failed(status))
2209 char buffer[64] = WINPR_C_ARRAY_INIT;
2210 WLog_Print(rdp->log, WLOG_ERROR,
"%s status %s", rdp_get_state_string(rdp),
2211 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2216state_run_t rdp_recv_callback(rdpTransport* transport,
wStream* s,
void* extra)
2218 char buffer[64] = WINPR_C_ARRAY_INIT;
2219 state_run_t rc = STATE_RUN_FAILED;
2220 const size_t start = Stream_GetPosition(s);
2221 const rdpContext* context = transport_get_context(transport);
2223 WINPR_ASSERT(context);
2226 const rdpRdp* rdp = context->rdp;
2229 if (rc == STATE_RUN_TRY_AGAIN)
2231 if (!Stream_SetPosition(s, start))
2232 return STATE_RUN_FAILED;
2235 const char* old = rdp_get_state_string(rdp);
2236 const size_t orem = Stream_GetRemainingLength(s);
2237 rc = rdp_recv_callback_int(transport, s, extra);
2239 const char* now = rdp_get_state_string(rdp);
2240 const size_t rem = Stream_GetRemainingLength(s);
2242 WLog_Print(rdp->log, WLOG_TRACE,
2243 "(client)[%s -> %s] current return %s [feeding %" PRIuz
" bytes, %" PRIuz
2244 " bytes not processed]",
2245 old, now, state_run_result_string(rc, buffer,
sizeof(buffer)), orem, rem);
2246 }
while ((rc == STATE_RUN_TRY_AGAIN) || (rc == STATE_RUN_CONTINUE));
2250BOOL rdp_send_channel_data(rdpRdp* rdp, UINT16 channelId,
const BYTE* data,
size_t size)
2252 return freerdp_channel_send(rdp, channelId, data, size);
2255BOOL rdp_channel_send_packet(rdpRdp* rdp, UINT16 channelId,
size_t totalSize, UINT32 flags,
2256 const BYTE* data,
size_t chunkSize)
2258 return freerdp_channel_send_packet(rdp, channelId, totalSize, flags, data, chunkSize);
2261BOOL rdp_send_error_info(rdpRdp* rdp)
2263 UINT16 sec_flags = 0;
2267 if (rdp->errorInfo == ERRINFO_SUCCESS)
2270 s = rdp_data_pdu_init(rdp, &sec_flags);
2275 Stream_Write_UINT32(s, rdp->errorInfo);
2276 status = rdp_send_data_pdu(rdp, s, DATA_PDU_TYPE_SET_ERROR_INFO, 0, sec_flags);
2280int rdp_check_fds(rdpRdp* rdp)
2283 rdpTsg* tsg =
nullptr;
2284 rdpTransport* transport =
nullptr;
2287 transport = rdp->transport;
2289 tsg = transport_get_tsg(transport);
2292 if (!tsg_check_event_handles(tsg))
2294 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_check_fds: tsg_check_event_handles()");
2298 if (tsg_get_state(tsg) != TSG_STATE_PIPE_CREATED)
2302 status = transport_check_fds(transport);
2306 if (!rdp_client_redirect(rdp))
2311 WLog_Print(rdp->log, WLOG_DEBUG,
"transport_check_fds() - %i", status);
2313 status = freerdp_timer_poll(rdp->timer);
2318BOOL freerdp_get_stats(
const rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes, UINT64* inPackets,
2325 *inBytes = rdp->inBytes;
2327 *outBytes = rdp->outBytes;
2329 *inPackets = rdp->inPackets;
2331 *outPackets = rdp->outPackets;
2336static bool rdp_new_common(rdpRdp* rdp)
2341 rdp->transport = transport_new(rdp->context);
2342 if (!rdp->transport)
2347 if (!transport_set_io_callbacks(rdp->transport, rdp->io))
2351 rdp->aad = aad_new(rdp->context);
2355 rdp->nego = nego_new(rdp->transport);
2359 rdp->mcs = mcs_new(rdp->context);
2363 rdp->license = license_new(rdp);
2367 rdp->fastpath = fastpath_new(rdp);
2381rdpRdp* rdp_new(rdpContext* context)
2384 rdpRdp* rdp = (rdpRdp*)calloc(1,
sizeof(rdpRdp));
2389 rdp->log = WLog_Get(RDP_TAG);
2390 WINPR_ASSERT(rdp->log);
2392 (void)_snprintf(rdp->log_context,
sizeof(rdp->log_context),
"%p", (
void*)context);
2393 WLog_SetContext(rdp->log,
nullptr, rdp->log_context);
2395 InitializeCriticalSection(&rdp->critical);
2396 rdp->context = context;
2397 WINPR_ASSERT(rdp->context);
2399 if (context->ServerMode)
2402 if (!context->settings)
2410 rdp->settings = context->settings;
2413 if (!rdp_set_backup_settings(rdp))
2416 rdp->settings->instance = context->instance;
2418 context->settings = rdp->settings;
2419 if (context->instance)
2420 context->settings->instance = context->instance;
2421 else if (context->peer)
2423 rdp->settings->instance = context->peer;
2425#if defined(WITH_FREERDP_DEPRECATED)
2426 context->peer->settings = rdp->settings;
2430 if (!rdp_new_common(rdp))
2434 const rdpTransportIo* io = transport_get_io_callbacks(rdp->transport);
2437 rdp->io = calloc(1,
sizeof(rdpTransportIo));
2443 rdp->input = input_new(rdp);
2448 rdp->update = update_new(rdp);
2453 rdp->redirection = redirection_new();
2455 if (!rdp->redirection)
2458 rdp->autodetect = autodetect_new(rdp->context);
2460 if (!rdp->autodetect)
2463 rdp->heartbeat = heartbeat_new();
2465 if (!rdp->heartbeat)
2468 rdp->multitransport = multitransport_new(rdp, INITIATE_REQUEST_PROTOCOL_UDPFECL |
2469 INITIATE_REQUEST_PROTOCOL_UDPFECR);
2471 if (!rdp->multitransport)
2474 rdp->bulk = bulk_new(context);
2479 rdp->pubSub = PubSub_New(TRUE);
2483 rdp->abortEvent = CreateEvent(
nullptr, TRUE, FALSE,
nullptr);
2484 if (!rdp->abortEvent)
2487 rdp->timer = freerdp_timer_new(rdp);
2494 WINPR_PRAGMA_DIAG_PUSH
2495 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2497 WINPR_PRAGMA_DIAG_POP
2501static void rdp_reset_free(rdpRdp* rdp)
2506 rdp_free_rc4_decrypt_keys(rdp);
2507 rdp_free_rc4_encrypt_keys(rdp);
2509 winpr_Cipher_Free(rdp->fips_encrypt);
2510 winpr_Cipher_Free(rdp->fips_decrypt);
2511 rdp->fips_encrypt =
nullptr;
2512 rdp->fips_decrypt =
nullptr;
2513 security_unlock(rdp);
2517 nego_free(rdp->nego);
2518 license_free(rdp->license);
2519 transport_free(rdp->transport);
2520 fastpath_free(rdp->fastpath);
2524 rdp->nego =
nullptr;
2525 rdp->license =
nullptr;
2526 rdp->transport =
nullptr;
2527 rdp->fastpath =
nullptr;
2530BOOL rdp_reset(rdpRdp* rdp)
2536 rdpSettings* settings = rdp->settings;
2537 WINPR_ASSERT(settings);
2539 bulk_reset(rdp->bulk);
2541 rdp_reset_free(rdp);
2555 rc = rdp_new_common(rdp);
2559 if (!transport_set_layer(rdp->transport, TRANSPORT_LAYER_TCP))
2563 rc = rdp_finalize_reset_flags(rdp, TRUE);
2574void rdp_free(rdpRdp* rdp)
2578 freerdp_timer_free(rdp->timer);
2579 rdp_reset_free(rdp);
2585 input_free(rdp->input);
2586 update_free(rdp->update);
2588 redirection_free(rdp->redirection);
2589 autodetect_free(rdp->autodetect);
2590 heartbeat_free(rdp->heartbeat);
2591 multitransport_free(rdp->multitransport);
2592 bulk_free(rdp->bulk);
2594 PubSub_Free(rdp->pubSub);
2595 if (rdp->abortEvent)
2596 (void)CloseHandle(rdp->abortEvent);
2599 DeleteCriticalSection(&rdp->critical);
2604BOOL rdp_io_callback_set_event(rdpRdp* rdp, BOOL set)
2608 return transport_io_callback_set_event(rdp->transport, set);
2611const rdpTransportIo* rdp_get_io_callbacks(rdpRdp* rdp)
2618BOOL rdp_set_io_callbacks(rdpRdp* rdp,
const rdpTransportIo* io_callbacks)
2626 rdp->io = malloc(
sizeof(rdpTransportIo));
2629 *rdp->io = *io_callbacks;
2630 return transport_set_io_callbacks(rdp->transport, rdp->io);
2635BOOL rdp_set_io_callback_context(rdpRdp* rdp,
void* usercontext)
2638 rdp->ioContext = usercontext;
2642void* rdp_get_io_callback_context(rdpRdp* rdp)
2645 return rdp->ioContext;
2648const char* rdp_finalize_flags_to_str(UINT32 flags,
char* buffer,
size_t size)
2650 char number[32] = WINPR_C_ARRAY_INIT;
2652 (uint32_t)~(FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
2653 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU |
2654 FINALIZE_CS_SYNCHRONIZE_PDU | FINALIZE_CS_CONTROL_COOPERATE_PDU |
2655 FINALIZE_CS_CONTROL_REQUEST_PDU | FINALIZE_CS_PERSISTENT_KEY_LIST_PDU |
2656 FINALIZE_CS_FONT_LIST_PDU | FINALIZE_DEACTIVATE_REACTIVATE);
2658 if (flags & FINALIZE_SC_SYNCHRONIZE_PDU)
2659 winpr_str_append(
"FINALIZE_SC_SYNCHRONIZE_PDU", buffer, size,
"|");
2660 if (flags & FINALIZE_SC_CONTROL_COOPERATE_PDU)
2661 winpr_str_append(
"FINALIZE_SC_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2662 if (flags & FINALIZE_SC_CONTROL_GRANTED_PDU)
2663 winpr_str_append(
"FINALIZE_SC_CONTROL_GRANTED_PDU", buffer, size,
"|");
2664 if (flags & FINALIZE_SC_FONT_MAP_PDU)
2665 winpr_str_append(
"FINALIZE_SC_FONT_MAP_PDU", buffer, size,
"|");
2666 if (flags & FINALIZE_CS_SYNCHRONIZE_PDU)
2667 winpr_str_append(
"FINALIZE_CS_SYNCHRONIZE_PDU", buffer, size,
"|");
2668 if (flags & FINALIZE_CS_CONTROL_COOPERATE_PDU)
2669 winpr_str_append(
"FINALIZE_CS_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2670 if (flags & FINALIZE_CS_CONTROL_REQUEST_PDU)
2671 winpr_str_append(
"FINALIZE_CS_CONTROL_REQUEST_PDU", buffer, size,
"|");
2672 if (flags & FINALIZE_CS_PERSISTENT_KEY_LIST_PDU)
2673 winpr_str_append(
"FINALIZE_CS_PERSISTENT_KEY_LIST_PDU", buffer, size,
"|");
2674 if (flags & FINALIZE_CS_FONT_LIST_PDU)
2675 winpr_str_append(
"FINALIZE_CS_FONT_LIST_PDU", buffer, size,
"|");
2676 if (flags & FINALIZE_DEACTIVATE_REACTIVATE)
2677 winpr_str_append(
"FINALIZE_DEACTIVATE_REACTIVATE", buffer, size,
"|");
2679 winpr_str_append(
"UNKNOWN_FLAG", buffer, size,
"|");
2681 winpr_str_append(
"NO_FLAG_SET", buffer, size,
"|");
2682 (void)_snprintf(number,
sizeof(number),
" [0x%08" PRIx32
"]", flags);
2683 winpr_str_append(number, buffer, size,
"");
2687BOOL rdp_finalize_reset_flags(rdpRdp* rdp, BOOL clearAll)
2690 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] reset finalize_sc_pdus", rdp_get_state_string(rdp));
2692 rdp->finalize_sc_pdus = 0;
2694 rdp->finalize_sc_pdus &= FINALIZE_DEACTIVATE_REACTIVATE;
2696 return rdp_set_monitor_layout_pdu_state(rdp, FALSE);
2699BOOL rdp_finalize_set_flag(rdpRdp* rdp, UINT32 flag)
2701 char buffer[1024] = WINPR_C_ARRAY_INIT;
2705 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] received flag %s", rdp_get_state_string(rdp),
2706 rdp_finalize_flags_to_str(flag, buffer,
sizeof(buffer)));
2707 rdp->finalize_sc_pdus |= flag;
2711BOOL rdp_finalize_is_flag_set(rdpRdp* rdp, UINT32 flag)
2714 return (rdp->finalize_sc_pdus & flag) == flag;
2717BOOL rdp_reset_rc4_encrypt_keys(rdpRdp* rdp)
2720 rdp_free_rc4_encrypt_keys(rdp);
2721 rdp->rc4_encrypt_key = winpr_RC4_New(rdp->encrypt_key, rdp->rc4_key_len);
2723 rdp->encrypt_use_count = 0;
2724 return rdp->rc4_encrypt_key !=
nullptr;
2727void rdp_free_rc4_encrypt_keys(rdpRdp* rdp)
2730 winpr_RC4_Free(rdp->rc4_encrypt_key);
2731 rdp->rc4_encrypt_key =
nullptr;
2734void rdp_free_rc4_decrypt_keys(rdpRdp* rdp)
2737 winpr_RC4_Free(rdp->rc4_decrypt_key);
2738 rdp->rc4_decrypt_key =
nullptr;
2741BOOL rdp_reset_rc4_decrypt_keys(rdpRdp* rdp)
2744 rdp_free_rc4_decrypt_keys(rdp);
2745 rdp->rc4_decrypt_key = winpr_RC4_New(rdp->decrypt_key, rdp->rc4_key_len);
2747 rdp->decrypt_use_count = 0;
2748 return rdp->rc4_decrypt_key !=
nullptr;
2751const char* rdp_security_flag_string(UINT32 securityFlags,
char* buffer,
size_t size)
2753 if (securityFlags & SEC_EXCHANGE_PKT)
2754 winpr_str_append(
"SEC_EXCHANGE_PKT", buffer, size,
"|");
2755 if (securityFlags & SEC_TRANSPORT_REQ)
2756 winpr_str_append(
"SEC_TRANSPORT_REQ", buffer, size,
"|");
2757 if (securityFlags & SEC_TRANSPORT_RSP)
2758 winpr_str_append(
"SEC_TRANSPORT_RSP", buffer, size,
"|");
2759 if (securityFlags & SEC_ENCRYPT)
2760 winpr_str_append(
"SEC_ENCRYPT", buffer, size,
"|");
2761 if (securityFlags & SEC_RESET_SEQNO)
2762 winpr_str_append(
"SEC_RESET_SEQNO", buffer, size,
"|");
2763 if (securityFlags & SEC_IGNORE_SEQNO)
2764 winpr_str_append(
"SEC_IGNORE_SEQNO", buffer, size,
"|");
2765 if (securityFlags & SEC_INFO_PKT)
2766 winpr_str_append(
"SEC_INFO_PKT", buffer, size,
"|");
2767 if (securityFlags & SEC_LICENSE_PKT)
2768 winpr_str_append(
"SEC_LICENSE_PKT", buffer, size,
"|");
2769 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
2770 winpr_str_append(
"SEC_LICENSE_ENCRYPT_CS", buffer, size,
"|");
2771 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
2772 winpr_str_append(
"SEC_LICENSE_ENCRYPT_SC", buffer, size,
"|");
2773 if (securityFlags & SEC_REDIRECTION_PKT)
2774 winpr_str_append(
"SEC_REDIRECTION_PKT", buffer, size,
"|");
2775 if (securityFlags & SEC_SECURE_CHECKSUM)
2776 winpr_str_append(
"SEC_SECURE_CHECKSUM", buffer, size,
"|");
2777 if (securityFlags & SEC_AUTODETECT_REQ)
2778 winpr_str_append(
"SEC_AUTODETECT_REQ", buffer, size,
"|");
2779 if (securityFlags & SEC_AUTODETECT_RSP)
2780 winpr_str_append(
"SEC_AUTODETECT_RSP", buffer, size,
"|");
2781 if (securityFlags & SEC_HEARTBEAT)
2782 winpr_str_append(
"SEC_HEARTBEAT", buffer, size,
"|");
2783 if (securityFlags & SEC_FLAGSHI_VALID)
2784 winpr_str_append(
"SEC_FLAGSHI_VALID", buffer, size,
"|");
2786 char msg[32] = WINPR_C_ARRAY_INIT;
2788 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", securityFlags);
2789 winpr_str_append(msg, buffer, size,
"");
2794static BOOL rdp_reset_remote_settings(rdpRdp* rdp)
2796 UINT32 flags = FREERDP_SETTINGS_REMOTE_MODE;
2803 return rdp->remoteSettings !=
nullptr;
2806BOOL rdp_set_backup_settings(rdpRdp* rdp)
2811 if (!rdp->originalSettings)
2813 return rdp_reset_remote_settings(rdp);
2816BOOL rdp_reset_runtime_settings(rdpRdp* rdp)
2819 WINPR_ASSERT(rdp->context);
2826 return rdp_reset_remote_settings(rdp);
2829static BOOL starts_with(
const char* tok,
const char* val)
2831 const size_t len = strlen(val);
2832 if (strncmp(tok, val, len) != 0)
2834 if (tok[len] !=
'=')
2839static BOOL option_equals(
const char* what,
const char* val)
2841 return _stricmp(what, val) == 0;
2844static BOOL parse_on_off_option(
const char* value)
2846 WINPR_ASSERT(value);
2847 const char* sep = strchr(value,
'=');
2850 if (option_equals(
"on", &sep[1]))
2852 if (option_equals(
"true", &sep[1]))
2854 if (option_equals(
"off", &sep[1]))
2856 if (option_equals(
"false", &sep[1]))
2860 long val = strtol(value,
nullptr, 0);
2869static BOOL option_is_runtime_checks(WINPR_ATTR_UNUSED wLog* log,
const char* tok)
2871 const char* experimental[] = { STR(WITH_VERBOSE_WINPR_ASSERT) };
2872 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2874 const char* opt = experimental[x];
2875 if (starts_with(tok, opt))
2877 return parse_on_off_option(tok);
2883static BOOL option_is_experimental(WINPR_ATTR_UNUSED wLog* log,
const char* tok)
2885 const char* experimental[] = { STR(WITH_DSP_EXPERIMENTAL), STR(WITH_VAAPI),
2886 STR(WITH_GFX_AV1), STR(WITH_VAAPI_H264_ENCODING),
2887 STR(WITH_MEDIACODEC), STR(WITH_CLIENT_SDL2),
2888 STR(WITH_OPENCL), STR(WITH_LIBRESSL),
2889 STR(WITH_MBEDTLS), STR(WITH_MEDIA_FOUNDATION),
2890 STR(WITH_KRB5_HEIMDAL) };
2891 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2893 const char* opt = experimental[x];
2894 if (starts_with(tok, opt))
2896 return parse_on_off_option(tok);
2902static BOOL option_is_debug(wLog* log,
const char* tok)
2905 const char* debug[] = {
2906 STR(WITH_DEBUG_ALL), STR(WITH_DEBUG_CERTIFICATE), STR(WITH_DEBUG_CAPABILITIES),
2907 STR(WITH_DEBUG_CHANNELS), STR(WITH_DEBUG_CLIPRDR), STR(WITH_DEBUG_CODECS),
2908 STR(WITH_DEBUG_DVC), STR(WITH_DEBUG_TSMF), STR(WITH_DEBUG_KBD),
2909 STR(WITH_DEBUG_LICENSE), STR(WITH_DEBUG_NEGO), STR(WITH_DEBUG_NLA),
2910 STR(WITH_DEBUG_TSG), STR(WITH_DEBUG_RAIL), STR(WITH_DEBUG_RDP),
2911 STR(WITH_DEBUG_RDPEI), STR(WITH_DEBUG_REDIR), STR(WITH_DEBUG_RDPDR),
2912 STR(WITH_DEBUG_RFX), STR(WITH_DEBUG_SCARD), STR(WITH_DEBUG_SND),
2913 STR(WITH_DEBUG_SVC), STR(WITH_DEBUG_TRANSPORT), STR(WITH_DEBUG_TIMEZONE),
2914 STR(WITH_DEBUG_WND), STR(WITH_DEBUG_RINGBUFFER), STR(WITH_DEBUG_SYMBOLS),
2915 STR(WITH_DEBUG_EVENTS), STR(WITH_DEBUG_MUTEX), STR(WITH_DEBUG_NTLM),
2916 STR(WITH_DEBUG_SDL_EVENTS), STR(WITH_DEBUG_SDL_KBD_EVENTS), STR(WITH_DEBUG_THREADS),
2917 STR(WITH_DEBUG_URBDRC)
2920 for (
size_t x = 0; x < ARRAYSIZE(debug); x++)
2922 const char* opt = debug[x];
2923 if (starts_with(tok, opt))
2924 return parse_on_off_option(tok);
2927 if (starts_with(tok,
"WITH_DEBUG"))
2929 WLog_Print(log, WLOG_WARN,
"[BUG] Unmapped Debug-Build option '%s'.", tok);
2930 return parse_on_off_option(tok);
2936static void log_build_warn(rdpRdp* rdp,
const char* what,
const char* msg,
2937 BOOL (*cmp)(wLog* log,
const char* tok))
2940 WINPR_PRAGMA_DIAG_PUSH
2941 WINPR_PRAGMA_DIAG_IGNORED_OVERLENGTH_STRINGS
2943 size_t len =
sizeof(FREERDP_BUILD_CONFIG);
2944 char* list = calloc(len,
sizeof(
char));
2945 char* config = _strdup(FREERDP_BUILD_CONFIG);
2946 WINPR_PRAGMA_DIAG_POP
2950 char* saveptr =
nullptr;
2951 char* tok = strtok_s(config,
" ", &saveptr);
2954 if (cmp(rdp->log, tok))
2955 winpr_str_append(tok, list, len,
" ");
2957 tok = strtok_s(
nullptr,
" ", &saveptr);
2964 if (strlen(list) > 0)
2966 WLog_Print(rdp->log, WLOG_WARN,
"*************************************************");
2967 WLog_Print(rdp->log, WLOG_WARN,
"This build is using [%s] build options:", what);
2969 char* saveptr =
nullptr;
2970 char* tok = strtok_s(list,
" ", &saveptr);
2973 WLog_Print(rdp->log, WLOG_WARN,
"* '%s'", tok);
2974 tok = strtok_s(
nullptr,
" ", &saveptr);
2976 WLog_Print(rdp->log, WLOG_WARN,
"*");
2977 WLog_Print(rdp->log, WLOG_WARN,
"[%s] build options %s", what, msg);
2978 WLog_Print(rdp->log, WLOG_WARN,
"*************************************************");
2984#define print_first_line(log, firstLine, what) \
2985 print_first_line_int((log), (firstLine), (what), __FILE__, __func__, __LINE__)
2986static void print_first_line_int(wLog* log, log_line_t* firstLine,
const char* what,
2987 const char* file,
const char* fkt,
size_t line)
2989 WINPR_ASSERT(firstLine);
2990 if (!firstLine->fkt)
2992 const DWORD level = WLOG_WARN;
2993 if (WLog_IsLevelActive(log, level))
2995 WLog_PrintTextMessage(log, level, line, file, fkt,
2996 "*************************************************");
2997 WLog_PrintTextMessage(log, level, line, file, fkt,
2998 "[SSL] {%s} build or configuration missing:", what);
3000 firstLine->line = line;
3001 firstLine->file = file;
3002 firstLine->fkt = fkt;
3003 firstLine->level = level;
3007static void print_last_line(wLog* log,
const log_line_t* firstLine)
3009 WINPR_ASSERT(firstLine);
3012 if (WLog_IsLevelActive(log, firstLine->level))
3013 WLog_PrintTextMessage(log, firstLine->level, firstLine->line, firstLine->file,
3015 "*************************************************");
3019static void log_build_warn_cipher(rdpRdp* rdp, log_line_t* firstLine, WINPR_CIPHER_TYPE md,
3022 BOOL haveCipher = FALSE;
3024 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3025 char iv[WINPR_CIPHER_MAX_IV_LENGTH] = WINPR_C_ARRAY_INIT;
3029 if (md == WINPR_CIPHER_ARC4_128)
3031 WINPR_RC4_CTX* enc = winpr_RC4_New(key,
sizeof(key));
3032 haveCipher = enc !=
nullptr;
3033 winpr_RC4_Free(enc);
3037 WINPR_CIPHER_CTX* enc =
3038 winpr_Cipher_NewEx(md, WINPR_ENCRYPT, key,
sizeof(key), iv,
sizeof(iv));
3039 WINPR_CIPHER_CTX* dec =
3040 winpr_Cipher_NewEx(md, WINPR_DECRYPT, key,
sizeof(key), iv,
sizeof(iv));
3044 winpr_Cipher_Free(enc);
3045 winpr_Cipher_Free(dec);
3050 print_first_line(rdp->log, firstLine,
"Cipher");
3051 WLog_Print(rdp->log, WLOG_WARN,
"* %s: %s", winpr_cipher_type_to_string(md), what);
3055static void log_build_warn_hmac(rdpRdp* rdp, log_line_t* firstLine, WINPR_MD_TYPE md,
3058 BOOL haveHmacX = FALSE;
3059 WINPR_HMAC_CTX* hmac = winpr_HMAC_New();
3065 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3066 haveHmacX = winpr_HMAC_Init(hmac, md, key,
sizeof(key));
3068 winpr_HMAC_Free(hmac);
3072 print_first_line(rdp->log, firstLine,
"HMAC");
3073 WLog_Print(rdp->log, WLOG_WARN,
" * %s: %s", winpr_md_type_to_string(md), what);
3077static void log_build_warn_hash(rdpRdp* rdp, log_line_t* firstLine, WINPR_MD_TYPE md,
3080 BOOL haveDigestX = FALSE;
3082 WINPR_DIGEST_CTX* digest = winpr_Digest_New();
3084 haveDigestX = winpr_Digest_Init(digest, md);
3085 winpr_Digest_Free(digest);
3089 print_first_line(rdp->log, firstLine,
"Digest");
3090 WLog_Print(rdp->log, WLOG_WARN,
" * %s: %s", winpr_md_type_to_string(md), what);
3094static void log_build_warn_ssl(rdpRdp* rdp)
3098 log_line_t firstHashLine = WINPR_C_ARRAY_INIT;
3099 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD4,
"NTLM support not available");
3100 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD5,
3101 "NTLM, assistance files with encrypted passwords, autoreconnect cookies, "
3102 "licensing and RDP security will not work");
3103 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_SHA1,
3104 "assistance files with encrypted passwords, Kerberos, Smartcard Logon, RDP "
3105 "security support not available");
3106 log_build_warn_hash(
3107 rdp, &firstHashLine, WINPR_MD_SHA256,
3108 "file clipboard, AAD gateway, NLA security and certificates might not work");
3109 print_last_line(rdp->log, &firstHashLine);
3111 log_line_t firstHmacLine = WINPR_C_ARRAY_INIT;
3112 log_build_warn_hmac(rdp, &firstHmacLine, WINPR_MD_MD5,
"Autoreconnect cookie not supported");
3113 log_build_warn_hmac(rdp, &firstHmacLine, WINPR_MD_SHA1,
"RDP security not supported");
3114 print_last_line(rdp->log, &firstHmacLine);
3116 log_line_t firstCipherLine = WINPR_C_ARRAY_INIT;
3117 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_ARC4_128,
3118 "assistance files with encrypted passwords, NTLM, RDP licensing and RDP "
3119 "security will not work");
3120 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_DES_EDE3_CBC,
3121 "RDP security FIPS mode will not work");
3122 log_build_warn_cipher(
3123 rdp, &firstCipherLine, WINPR_CIPHER_AES_128_CBC,
3124 "assistance file encrypted LHTicket will not work and ARM gateway might not");
3125 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_AES_192_CBC,
3126 "ARM gateway might not work");
3127 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_AES_256_CBC,
3128 "ARM gateway might not work");
3129 print_last_line(rdp->log, &firstCipherLine);
3132void rdp_log_build_warnings(rdpRdp* rdp)
3134 static unsigned count = 0;
3143 log_build_warn(rdp,
"experimental",
"might crash the application", option_is_experimental);
3144 log_build_warn(rdp,
"debug",
"might leak sensitive information (credentials, ...)",
3146 log_build_warn(rdp,
"runtime-check",
"might slow down the application",
3147 option_is_runtime_checks);
3148 log_build_warn_ssl(rdp);
3151size_t rdp_get_event_handles(rdpRdp* rdp, HANDLE* handles, uint32_t count)
3153 size_t nCount = transport_get_event_handles(rdp->transport, handles, count);
3158 if (count < nCount + 2UL)
3161 handles[nCount++] = utils_get_abort_event(rdp);
3162 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.