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 BOOL rdp_recv_monitor_layout_pdu(rdpRdp* rdp,
wStream* s)
1112 UINT32 monitorCount = 0;
1117 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1120 Stream_Read_UINT32(s, monitorCount);
1122 if (!Stream_CheckAndLogRequiredLengthOfSizeWLog(rdp->log, s, monitorCount, 20ull))
1127 if (!monitorDefArray)
1130 for (UINT32 index = 0; index < monitorCount; index++)
1133 Stream_Read_INT32(s, monitor->left);
1134 Stream_Read_INT32(s, monitor->top);
1135 Stream_Read_INT32(s, monitor->right);
1136 Stream_Read_INT32(s, monitor->bottom);
1137 Stream_Read_UINT32(s, monitor->flags);
1140 IFCALLRET(rdp->update->RemoteMonitors, ret, rdp->context, monitorCount, monitorDefArray);
1141 free(monitorDefArray);
1144 return rdp_set_monitor_layout_pdu_state(rdp, TRUE);
1147state_run_t rdp_recv_data_pdu(rdpRdp* rdp,
wStream* s)
1153 BYTE compressedType = 0;
1154 UINT16 compressedLength = 0;
1157 if (!rdp_read_share_data_header(rdp, s, &length, &type, &shareId, &compressedType,
1160 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_read_share_data_header() failed");
1161 return STATE_RUN_FAILED;
1166 if (compressedType & PACKET_COMPRESSED)
1168 if (compressedLength < 18)
1170 WLog_Print(rdp->log, WLOG_ERROR,
1171 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1173 return STATE_RUN_FAILED;
1177 const BYTE* pDstData =
nullptr;
1178 UINT16 SrcSize = compressedLength - 18;
1180 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, SrcSize))
1182 WLog_Print(rdp->log, WLOG_ERROR,
1183 "bulk_decompress: not enough bytes for compressedLength %" PRIu16
"",
1185 return STATE_RUN_FAILED;
1188 if (bulk_decompress(rdp->bulk, Stream_ConstPointer(s), SrcSize, &pDstData, &DstSize,
1191 cs = transport_take_from_pool(rdp->transport, DstSize);
1194 WLog_Print(rdp->log, WLOG_ERROR,
"Couldn't take stream from pool");
1195 return STATE_RUN_FAILED;
1198 Stream_ResetPosition(cs);
1199 Stream_Write(cs, pDstData, DstSize);
1200 Stream_SealLength(cs);
1201 Stream_ResetPosition(cs);
1205 WLog_Print(rdp->log, WLOG_ERROR,
"bulk_decompress() failed");
1206 return STATE_RUN_FAILED;
1209 Stream_Seek(s, SrcSize);
1212 WLog_Print(rdp->log, WLOG_DEBUG,
"recv %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1213 data_pdu_type_to_string(type), type, length);
1217 case DATA_PDU_TYPE_UPDATE:
1218 if (!update_recv(rdp->update, cs))
1220 WLog_Print(rdp->log, WLOG_ERROR,
"DATA_PDU_TYPE_UPDATE - update_recv() failed");
1226 case DATA_PDU_TYPE_CONTROL:
1227 if (!rdp_recv_server_control_pdu(rdp, cs))
1229 WLog_Print(rdp->log, WLOG_ERROR,
1230 "DATA_PDU_TYPE_CONTROL - rdp_recv_server_control_pdu() failed");
1236 case DATA_PDU_TYPE_POINTER:
1237 if (!update_recv_pointer(rdp->update, cs))
1239 WLog_Print(rdp->log, WLOG_ERROR,
1240 "DATA_PDU_TYPE_POINTER - update_recv_pointer() failed");
1246 case DATA_PDU_TYPE_SYNCHRONIZE:
1247 if (!rdp_recv_server_synchronize_pdu(rdp, cs))
1249 WLog_Print(rdp->log, WLOG_ERROR,
1250 "DATA_PDU_TYPE_SYNCHRONIZE - rdp_recv_synchronize_pdu() failed");
1256 case DATA_PDU_TYPE_PLAY_SOUND:
1257 if (!update_recv_play_sound(rdp->update, cs))
1259 WLog_Print(rdp->log, WLOG_ERROR,
1260 "DATA_PDU_TYPE_PLAY_SOUND - update_recv_play_sound() failed");
1266 case DATA_PDU_TYPE_SHUTDOWN_DENIED:
1267 if (!rdp_recv_server_shutdown_denied_pdu(rdp, cs))
1270 rdp->log, WLOG_ERROR,
1271 "DATA_PDU_TYPE_SHUTDOWN_DENIED - rdp_recv_server_shutdown_denied_pdu() failed");
1277 case DATA_PDU_TYPE_SAVE_SESSION_INFO:
1278 if (!rdp_recv_save_session_info(rdp, cs))
1280 WLog_Print(rdp->log, WLOG_ERROR,
1281 "DATA_PDU_TYPE_SAVE_SESSION_INFO - rdp_recv_save_session_info() failed");
1287 case DATA_PDU_TYPE_FONT_MAP:
1288 if (!rdp_recv_font_map_pdu(rdp, cs))
1290 WLog_Print(rdp->log, WLOG_ERROR,
1291 "DATA_PDU_TYPE_FONT_MAP - rdp_recv_font_map_pdu() failed");
1297 case DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS:
1298 if (!rdp_recv_server_set_keyboard_indicators_pdu(rdp, cs))
1300 WLog_Print(rdp->log, WLOG_ERROR,
1301 "DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS - "
1302 "rdp_recv_server_set_keyboard_indicators_pdu() failed");
1308 case DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS:
1309 if (!rdp_recv_server_set_keyboard_ime_status_pdu(rdp, cs))
1311 WLog_Print(rdp->log, WLOG_ERROR,
1312 "DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS - "
1313 "rdp_recv_server_set_keyboard_ime_status_pdu() failed");
1319 case DATA_PDU_TYPE_SET_ERROR_INFO:
1320 if (!rdp_recv_set_error_info_data_pdu(rdp, cs))
1323 rdp->log, WLOG_ERROR,
1324 "DATA_PDU_TYPE_SET_ERROR_INFO - rdp_recv_set_error_info_data_pdu() failed");
1330 case DATA_PDU_TYPE_ARC_STATUS:
1331 if (!rdp_recv_server_auto_reconnect_status_pdu(rdp, cs))
1333 WLog_Print(rdp->log, WLOG_ERROR,
1334 "DATA_PDU_TYPE_ARC_STATUS - "
1335 "rdp_recv_server_auto_reconnect_status_pdu() failed");
1341 case DATA_PDU_TYPE_STATUS_INFO:
1342 if (!rdp_recv_server_status_info_pdu(rdp, cs))
1344 WLog_Print(rdp->log, WLOG_ERROR,
1345 "DATA_PDU_TYPE_STATUS_INFO - rdp_recv_server_status_info_pdu() failed");
1351 case DATA_PDU_TYPE_MONITOR_LAYOUT:
1352 if (!rdp_recv_monitor_layout_pdu(rdp, cs))
1354 WLog_Print(rdp->log, WLOG_ERROR,
1355 "DATA_PDU_TYPE_MONITOR_LAYOUT - rdp_recv_monitor_layout_pdu() failed");
1362 WLog_Print(rdp->log, WLOG_WARN,
1363 "[UNHANDLED] %s Data PDU (0x%02" PRIX8
"), length: %" PRIu16
"",
1364 data_pdu_type_to_string(type), type, length);
1371 return STATE_RUN_SUCCESS;
1377 return STATE_RUN_FAILED;
1380state_run_t rdp_recv_message_channel_pdu(rdpRdp* rdp,
wStream* s, UINT16 securityFlags)
1385 if (securityFlags & SEC_AUTODETECT_REQ)
1388 return autodetect_recv_request_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1391 if (securityFlags & SEC_AUTODETECT_RSP)
1394 return autodetect_recv_response_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
1397 if (securityFlags & SEC_HEARTBEAT)
1400 return rdp_recv_heartbeat_packet(rdp, s);
1403 if (securityFlags & SEC_TRANSPORT_REQ)
1405 return multitransport_recv_request(rdp->multitransport, s);
1408 if (securityFlags & SEC_TRANSPORT_RSP)
1410 return multitransport_recv_response(rdp->multitransport, s);
1413 if (securityFlags & SEC_LICENSE_PKT)
1415 return license_recv(rdp->license, s);
1418 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
1420 return license_recv(rdp->license, s);
1423 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
1425 return license_recv(rdp->license, s);
1428 return STATE_RUN_SUCCESS;
1431state_run_t rdp_recv_out_of_sequence_pdu(rdpRdp* rdp,
wStream* s, UINT16 pduType, UINT16 length)
1433 state_run_t rc = STATE_RUN_FAILED;
1439 rc = rdp_recv_data_pdu(rdp, s);
1441 case PDU_TYPE_SERVER_REDIRECTION:
1442 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1444 case PDU_TYPE_FLOW_RESPONSE:
1445 case PDU_TYPE_FLOW_STOP:
1446 case PDU_TYPE_FLOW_TEST:
1447 rc = STATE_RUN_SUCCESS;
1451 char buffer1[256] = WINPR_C_ARRAY_INIT;
1452 char buffer2[256] = WINPR_C_ARRAY_INIT;
1454 WLog_Print(rdp->log, WLOG_ERROR,
"expected %s, got %s",
1455 pdu_type_to_str(PDU_TYPE_DEMAND_ACTIVE, buffer1,
sizeof(buffer1)),
1456 pdu_type_to_str(pduType, buffer2,
sizeof(buffer2)));
1457 rc = STATE_RUN_FAILED;
1462 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1463 return STATE_RUN_FAILED;
1467BOOL rdp_read_flow_control_pdu(rdpRdp* rdp,
wStream* s, UINT16* type, UINT16* channel_id)
1481 WINPR_ASSERT(channel_id);
1483 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 6))
1485 Stream_Read_UINT8(s, pduType);
1487 Stream_Seek_UINT8(s);
1488 Stream_Seek_UINT8(s);
1489 Stream_Seek_UINT8(s);
1490 Stream_Read_UINT16(s, *channel_id);
1505BOOL rdp_decrypt(rdpRdp* rdp,
wStream* s, UINT16* pLength, UINT16 securityFlags)
1508 BYTE cmac[8] = WINPR_C_ARRAY_INIT;
1509 BYTE wmac[8] = WINPR_C_ARRAY_INIT;
1510 BOOL status = FALSE;
1513 WINPR_ASSERT(rdp->settings);
1515 WINPR_ASSERT(pLength);
1519 INT32 length = *pLength;
1520 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_NONE)
1523 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
1525 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
1529 Stream_Read_UINT16(s, len);
1531 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS length %" PRIu16
" != 0x10",
1535 Stream_Read_UINT8(s, version);
1537 WLog_Print(rdp->log, WLOG_WARN,
"ENCRYPTION_METHOD_FIPS version %" PRIu16
" != 1",
1541 Stream_Read_UINT8(s, pad);
1542 const BYTE* sig = Stream_ConstPointer(s);
1545 const INT32 padLength = length - pad;
1547 if ((length <= 0) || (padLength <= 0) || (padLength > UINT16_MAX))
1549 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid pad length %" PRId32, padLength);
1553 if (!security_fips_decrypt(Stream_Pointer(s), (
size_t)length, rdp))
1556 if (!security_fips_check_signature(Stream_ConstPointer(s), (
size_t)padLength, sig, 8, rdp))
1559 if (!Stream_SetLength(s, Stream_Length(s) - pad))
1562 *pLength = (UINT16)padLength;
1566 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s,
sizeof(wmac)))
1569 Stream_Read(s, wmac,
sizeof(wmac));
1570 length -=
sizeof(wmac);
1574 WLog_Print(rdp->log, WLOG_ERROR,
"FATAL: invalid length field");
1578 if (!security_decrypt(Stream_PointerAs(s, BYTE), (
size_t)length, rdp))
1581 if (securityFlags & SEC_SECURE_CHECKSUM)
1582 status = security_salted_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length,
1583 FALSE, cmac,
sizeof(cmac));
1585 status = security_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length, cmac,
1591 if (memcmp(wmac, cmac,
sizeof(wmac)) != 0)
1593 WLog_Print(rdp->log, WLOG_ERROR,
"WARNING: invalid packet signature");
1604 *pLength = (UINT16)length;
1608 security_unlock(rdp);
1612const char* pdu_type_to_str(UINT16 pduType,
char* buffer,
size_t length)
1614 const char* str =
nullptr;
1617 case PDU_TYPE_DEMAND_ACTIVE:
1618 str =
"PDU_TYPE_DEMAND_ACTIVE";
1620 case PDU_TYPE_CONFIRM_ACTIVE:
1621 str =
"PDU_TYPE_CONFIRM_ACTIVE";
1623 case PDU_TYPE_DEACTIVATE_ALL:
1624 str =
"PDU_TYPE_DEACTIVATE_ALL";
1627 str =
"PDU_TYPE_DATA";
1629 case PDU_TYPE_SERVER_REDIRECTION:
1630 str =
"PDU_TYPE_SERVER_REDIRECTION";
1632 case PDU_TYPE_FLOW_TEST:
1633 str =
"PDU_TYPE_FLOW_TEST";
1635 case PDU_TYPE_FLOW_RESPONSE:
1636 str =
"PDU_TYPE_FLOW_RESPONSE";
1638 case PDU_TYPE_FLOW_STOP:
1639 str =
"PDU_TYPE_FLOW_STOP";
1642 str =
"PDU_TYPE_UNKNOWN";
1646 winpr_str_append(str, buffer, length,
"");
1648 char msg[32] = WINPR_C_ARRAY_INIT;
1649 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", pduType);
1650 winpr_str_append(msg, buffer, length,
"");
1661static state_run_t rdp_recv_tpkt_pdu(rdpRdp* rdp,
wStream* s)
1663 state_run_t rc = STATE_RUN_SUCCESS;
1666 UINT16 pduSource = 0;
1667 UINT16 channelId = 0;
1668 UINT16 securityFlags = 0;
1671 WINPR_ASSERT(rdp->context);
1674 freerdp* instance = rdp->context->instance;
1675 WINPR_ASSERT(instance);
1677 if (!rdp_read_header(rdp, s, &length, &channelId))
1678 return STATE_RUN_FAILED;
1680 if (freerdp_shall_disconnect_context(rdp->context))
1681 return STATE_RUN_SUCCESS;
1683 if (rdp->autodetect->bandwidthMeasureStarted)
1685 rdp->autodetect->bandwidthMeasureByteCount += length;
1688 if (rdp->mcs->messageChannelId && (channelId == rdp->mcs->messageChannelId))
1691 return rdp_handle_message_channel(rdp, s, channelId, length);
1694 if (rdp->settings->UseRdpSecurityLayer)
1696 if (!rdp_read_security_header(rdp, s, &securityFlags, &length))
1697 return STATE_RUN_FAILED;
1699 if (securityFlags & (SEC_ENCRYPT | SEC_REDIRECTION_PKT))
1701 if (!rdp_decrypt(rdp, s, &length, securityFlags))
1702 return STATE_RUN_FAILED;
1705 if (securityFlags & SEC_REDIRECTION_PKT)
1711 Stream_Rewind(s, 2);
1714 rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
1719 if (channelId == MCS_GLOBAL_CHANNEL_ID)
1721 while (Stream_GetRemainingLength(s) > 3)
1728 if (!rdp_read_share_control_header(rdp, s,
nullptr, &remain, &pduType, &pduSource))
1729 return STATE_RUN_FAILED;
1731 sub = Stream_StaticInit(&subbuffer, Stream_Pointer(s), remain);
1732 if (!Stream_SafeSeek(s, remain))
1733 return STATE_RUN_FAILED;
1735 rdp->settings->PduSource = pduSource;
1741 rc = rdp_recv_data_pdu(rdp, sub);
1742 if (state_run_failed(rc))
1746 case PDU_TYPE_DEACTIVATE_ALL:
1747 if (!rdp_recv_deactivate_all(rdp, sub))
1749 WLog_Print(rdp->log, WLOG_ERROR,
1750 "rdp_recv_tpkt_pdu: rdp_recv_deactivate_all() fail");
1751 return STATE_RUN_FAILED;
1756 case PDU_TYPE_SERVER_REDIRECTION:
1757 return rdp_recv_enhanced_security_redirection_packet(rdp, sub);
1759 case PDU_TYPE_FLOW_RESPONSE:
1760 case PDU_TYPE_FLOW_STOP:
1761 case PDU_TYPE_FLOW_TEST:
1762 WLog_Print(rdp->log, WLOG_DEBUG,
"flow message 0x%04" PRIX16
"", pduType);
1764 if (!Stream_SafeSeek(sub, remain))
1765 return STATE_RUN_FAILED;
1770 char buffer[256] = WINPR_C_ARRAY_INIT;
1771 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect PDU type: %s",
1772 pdu_type_to_str(pduType, buffer,
sizeof(buffer)));
1777 diff = Stream_GetRemainingLength(sub);
1780 char buffer[256] = WINPR_C_ARRAY_INIT;
1781 WLog_Print(rdp->log, WLOG_WARN,
1782 "pduType %s not properly parsed, %" PRIuz
1783 " bytes remaining unhandled. Skipping.",
1784 pdu_type_to_str(pduType, buffer,
sizeof(buffer)), diff);
1792 if (!freerdp_channel_process(instance, s, channelId, length))
1793 return STATE_RUN_FAILED;
1797 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1798 return STATE_RUN_FAILED;
1802static state_run_t rdp_recv_fastpath_pdu(rdpRdp* rdp,
wStream* s)
1807 rdpFastPath* fastpath = rdp->fastpath;
1809 if (!fastpath_read_header_rdp(fastpath, s, &length))
1811 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_recv_fastpath_pdu: fastpath_read_header_rdp() fail");
1812 return STATE_RUN_FAILED;
1815 if ((length == 0) || (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, length)))
1817 WLog_Print(rdp->log, WLOG_ERROR,
"incorrect FastPath PDU header length %" PRIu16
"",
1819 return STATE_RUN_FAILED;
1822 if (rdp->autodetect->bandwidthMeasureStarted)
1824 rdp->autodetect->bandwidthMeasureByteCount += length;
1827 if (!fastpath_decrypt(fastpath, s, &length))
1828 return STATE_RUN_FAILED;
1830 return fastpath_recv_updates(rdp->fastpath, s);
1833static state_run_t rdp_recv_pdu(rdpRdp* rdp,
wStream* s)
1835 const int rc = tpkt_verify_header(s);
1837 return rdp_recv_tpkt_pdu(rdp, s);
1839 return rdp_recv_fastpath_pdu(rdp, s);
1841 return STATE_RUN_FAILED;
1844static state_run_t rdp_handle_sc_flags(rdpRdp* rdp,
wStream* s, UINT32 flag,
1845 CONNECTION_STATE nextState)
1847 const UINT32 mask = FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
1848 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU;
1850 state_run_t status = rdp_recv_pdu(rdp, s);
1851 if (state_run_success(status))
1853 const UINT32 flags = rdp->finalize_sc_pdus & mask;
1854 if ((flags & flag) == flag)
1856 if (!rdp_client_transition_to_state(rdp, nextState))
1857 status = STATE_RUN_FAILED;
1859 status = STATE_RUN_SUCCESS;
1863 char flag_buffer[256] = WINPR_C_ARRAY_INIT;
1864 char mask_buffer[256] = WINPR_C_ARRAY_INIT;
1865 WLog_Print(rdp->log, WLOG_WARN,
1866 "[%s] unexpected server message, expected flag %s [have %s]",
1867 rdp_get_state_string(rdp),
1868 rdp_finalize_flags_to_str(flag, flag_buffer,
sizeof(flag_buffer)),
1869 rdp_finalize_flags_to_str(flags, mask_buffer,
sizeof(mask_buffer)));
1875static state_run_t rdp_client_exchange_monitor_layout(rdpRdp* rdp,
wStream* s)
1879 if (!rdp_check_monitor_layout_pdu_state(rdp, FALSE))
1880 return STATE_RUN_FAILED;
1885 const UINT32 old = rdp->finalize_sc_pdus;
1886 state_run_t status = rdp_recv_pdu(rdp, s);
1887 const UINT32 now = rdp->finalize_sc_pdus;
1888 const BOOL changed = (old != now) || rdp->monitor_layout_pdu;
1891 if (state_run_success(status) && changed)
1893 if (!rdp->monitor_layout_pdu)
1895 if (!rdp_finalize_is_flag_set(rdp, FINALIZE_SC_SYNCHRONIZE_PDU))
1896 return STATE_RUN_FAILED;
1899 status = rdp_client_connect_finalize(rdp);
1900 if (state_run_success(status) && !rdp->monitor_layout_pdu)
1901 status = STATE_RUN_TRY_AGAIN;
1906static state_run_t rdp_recv_callback_int(WINPR_ATTR_UNUSED rdpTransport* transport,
wStream* s,
1909 state_run_t status = STATE_RUN_SUCCESS;
1910 rdpRdp* rdp = (rdpRdp*)extra;
1912 WINPR_ASSERT(transport);
1916 switch (rdp_get_state(rdp))
1918 case CONNECTION_STATE_NEGO:
1919 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1920 status = STATE_RUN_FAILED;
1922 status = STATE_RUN_CONTINUE;
1924 case CONNECTION_STATE_NLA:
1925 if (nla_get_state(rdp->nla) < NLA_STATE_AUTH_INFO)
1927 if (nla_recv_pdu(rdp->nla, s) < 1)
1929 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nla_recv_pdu() fail",
1930 rdp_get_state_string(rdp));
1931 status = STATE_RUN_FAILED;
1934 else if (nla_get_state(rdp->nla) == NLA_STATE_POST_NEGO)
1936 if (nego_recv(rdp->transport, s, (
void*)rdp->nego) < 0)
1937 return STATE_RUN_FAILED;
1939 if (!nego_update_settings_from_state(rdp->nego, rdp->settings))
1940 return STATE_RUN_FAILED;
1942 if (nego_get_state(rdp->nego) != NEGO_STATE_FINAL)
1944 WLog_Print(rdp->log, WLOG_ERROR,
"%s - nego_recv() fail",
1945 rdp_get_state_string(rdp));
1946 status = STATE_RUN_FAILED;
1948 else if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
1949 status = STATE_RUN_FAILED;
1952 if (state_run_success(status))
1954 if (nla_get_state(rdp->nla) == NLA_STATE_AUTH_INFO)
1956 transport_set_nla_mode(rdp->transport, FALSE);
1958 if (rdp->settings->VmConnectMode)
1960 if (!nego_set_state(rdp->nego, NEGO_STATE_NLA))
1961 status = STATE_RUN_FAILED;
1962 else if (!nego_set_requested_protocols(rdp->nego,
1963 PROTOCOL_HYBRID | PROTOCOL_SSL))
1964 status = STATE_RUN_FAILED;
1965 else if (!nego_send_negotiation_request(rdp->nego))
1966 status = STATE_RUN_FAILED;
1967 else if (!nla_set_state(rdp->nla, NLA_STATE_POST_NEGO))
1968 status = STATE_RUN_FAILED;
1972 if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
1973 status = STATE_RUN_FAILED;
1977 if (state_run_success(status))
1980 if (nla_get_state(rdp->nla) == NLA_STATE_FINAL)
1982 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
1983 status = STATE_RUN_FAILED;
1985 status = STATE_RUN_CONTINUE;
1990 case CONNECTION_STATE_AAD:
1991 if (aad_recv(rdp->aad, s) < 1)
1993 WLog_Print(rdp->log, WLOG_ERROR,
"%s - aad_recv() fail", rdp_get_state_string(rdp));
1994 status = STATE_RUN_FAILED;
1996 if (state_run_success(status))
1998 if (aad_get_state(rdp->aad) == AAD_STATE_FINAL)
2000 transport_set_aad_mode(rdp->transport, FALSE);
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_MCS_CREATE_REQUEST:
2010 if (!mcs_client_begin(rdp->mcs))
2012 WLog_Print(rdp->log, WLOG_ERROR,
"%s - mcs_client_begin() fail",
2013 rdp_get_state_string(rdp));
2014 status = STATE_RUN_FAILED;
2016 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_RESPONSE))
2017 status = STATE_RUN_FAILED;
2018 else if (Stream_GetRemainingLength(s) > 0)
2019 status = STATE_RUN_CONTINUE;
2022 case CONNECTION_STATE_MCS_CREATE_RESPONSE:
2023 if (!mcs_recv_connect_response(rdp->mcs, s))
2025 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_connect_response failure");
2026 status = STATE_RUN_FAILED;
2030 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ERECT_DOMAIN))
2031 status = STATE_RUN_FAILED;
2032 else if (!mcs_send_erect_domain_request(rdp->mcs))
2034 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_erect_domain_request failure");
2035 status = STATE_RUN_FAILED;
2037 else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ATTACH_USER))
2038 status = STATE_RUN_FAILED;
2039 else if (!mcs_send_attach_user_request(rdp->mcs))
2041 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_attach_user_request failure");
2042 status = STATE_RUN_FAILED;
2044 else if (!rdp_client_transition_to_state(rdp,
2045 CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM))
2046 status = STATE_RUN_FAILED;
2050 case CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM:
2051 if (!mcs_recv_attach_user_confirm(rdp->mcs, s))
2053 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_recv_attach_user_confirm failure");
2054 status = STATE_RUN_FAILED;
2058 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST))
2059 status = STATE_RUN_FAILED;
2060 else if (!mcs_send_channel_join_request(rdp->mcs, rdp->mcs->userId))
2062 WLog_Print(rdp->log, WLOG_ERROR,
"mcs_send_channel_join_request failure");
2063 status = STATE_RUN_FAILED;
2065 else if (!rdp_client_transition_to_state(
2066 rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE))
2067 status = STATE_RUN_FAILED;
2072 if (!rdp_client_skip_mcs_channel_join(rdp))
2073 status = STATE_RUN_FAILED;
2077 case CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE:
2078 if (!rdp_client_connect_mcs_channel_join_confirm(rdp, s))
2080 WLog_Print(rdp->log, WLOG_ERROR,
2082 "rdp_client_connect_mcs_channel_join_confirm() fail",
2083 rdp_get_state_string(rdp));
2084 status = STATE_RUN_FAILED;
2089 case CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST:
2090 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2092 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_LICENSING))
2093 status = STATE_RUN_FAILED;
2095 status = STATE_RUN_TRY_AGAIN;
2099 case CONNECTION_STATE_LICENSING:
2100 status = rdp_client_connect_license(rdp, s);
2102 if (state_run_failed(status))
2104 char buffer[64] = WINPR_C_ARRAY_INIT;
2105 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_client_connect_license() - %s",
2106 rdp_get_state_string(rdp),
2107 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2112 case CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST:
2113 if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
2115 if (!rdp_client_transition_to_state(
2116 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE))
2117 status = STATE_RUN_FAILED;
2119 status = STATE_RUN_TRY_AGAIN;
2123 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE:
2124 status = rdp_client_connect_demand_active(rdp, s);
2126 if (state_run_failed(status))
2128 char buffer[64] = WINPR_C_ARRAY_INIT;
2129 WLog_Print(rdp->log, WLOG_DEBUG,
2131 "rdp_client_connect_demand_active() - %s",
2132 rdp_get_state_string(rdp),
2133 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2135 else if (status == STATE_RUN_ACTIVE)
2137 if (!rdp_client_transition_to_state(
2138 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE))
2139 status = STATE_RUN_FAILED;
2141 status = STATE_RUN_CONTINUE;
2145 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT:
2146 status = rdp_client_exchange_monitor_layout(rdp, s);
2149 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE:
2150 status = rdp_client_connect_confirm_active(rdp, s);
2153 case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
2154 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_SYNCHRONIZE_PDU,
2155 CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE);
2157 case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
2158 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_COOPERATE_PDU,
2159 CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL);
2161 case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
2162 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_GRANTED_PDU,
2163 CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP);
2165 case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
2166 status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_FONT_MAP_PDU, CONNECTION_STATE_ACTIVE);
2169 case CONNECTION_STATE_ACTIVE:
2170 status = rdp_recv_pdu(rdp, s);
2172 if (state_run_failed(status))
2174 char buffer[64] = WINPR_C_ARRAY_INIT;
2175 WLog_Print(rdp->log, WLOG_DEBUG,
"%s - rdp_recv_pdu() - %s",
2176 rdp_get_state_string(rdp),
2177 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2182 WLog_Print(rdp->log, WLOG_ERROR,
"%s state %u", rdp_get_state_string(rdp),
2183 rdp_get_state(rdp));
2184 status = STATE_RUN_FAILED;
2188 if (state_run_failed(status))
2190 char buffer[64] = WINPR_C_ARRAY_INIT;
2191 WLog_Print(rdp->log, WLOG_ERROR,
"%s status %s", rdp_get_state_string(rdp),
2192 state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
2197state_run_t rdp_recv_callback(rdpTransport* transport,
wStream* s,
void* extra)
2199 char buffer[64] = WINPR_C_ARRAY_INIT;
2200 state_run_t rc = STATE_RUN_FAILED;
2201 const size_t start = Stream_GetPosition(s);
2202 const rdpContext* context = transport_get_context(transport);
2204 WINPR_ASSERT(context);
2207 const rdpRdp* rdp = context->rdp;
2210 if (rc == STATE_RUN_TRY_AGAIN)
2212 if (!Stream_SetPosition(s, start))
2213 return STATE_RUN_FAILED;
2216 const char* old = rdp_get_state_string(rdp);
2217 const size_t orem = Stream_GetRemainingLength(s);
2218 rc = rdp_recv_callback_int(transport, s, extra);
2220 const char* now = rdp_get_state_string(rdp);
2221 const size_t rem = Stream_GetRemainingLength(s);
2223 WLog_Print(rdp->log, WLOG_TRACE,
2224 "(client)[%s -> %s] current return %s [feeding %" PRIuz
" bytes, %" PRIuz
2225 " bytes not processed]",
2226 old, now, state_run_result_string(rc, buffer,
sizeof(buffer)), orem, rem);
2227 }
while ((rc == STATE_RUN_TRY_AGAIN) || (rc == STATE_RUN_CONTINUE));
2231BOOL rdp_send_channel_data(rdpRdp* rdp, UINT16 channelId,
const BYTE* data,
size_t size)
2233 return freerdp_channel_send(rdp, channelId, data, size);
2236BOOL rdp_channel_send_packet(rdpRdp* rdp, UINT16 channelId,
size_t totalSize, UINT32 flags,
2237 const BYTE* data,
size_t chunkSize)
2239 return freerdp_channel_send_packet(rdp, channelId, totalSize, flags, data, chunkSize);
2242BOOL rdp_send_error_info(rdpRdp* rdp)
2244 UINT16 sec_flags = 0;
2248 if (rdp->errorInfo == ERRINFO_SUCCESS)
2251 s = rdp_data_pdu_init(rdp, &sec_flags);
2256 Stream_Write_UINT32(s, rdp->errorInfo);
2257 status = rdp_send_data_pdu(rdp, s, DATA_PDU_TYPE_SET_ERROR_INFO, 0, sec_flags);
2261int rdp_check_fds(rdpRdp* rdp)
2264 rdpTsg* tsg =
nullptr;
2265 rdpTransport* transport =
nullptr;
2268 transport = rdp->transport;
2270 tsg = transport_get_tsg(transport);
2273 if (!tsg_check_event_handles(tsg))
2275 WLog_Print(rdp->log, WLOG_ERROR,
"rdp_check_fds: tsg_check_event_handles()");
2279 if (tsg_get_state(tsg) != TSG_STATE_PIPE_CREATED)
2283 status = transport_check_fds(transport);
2287 if (!rdp_client_redirect(rdp))
2292 WLog_Print(rdp->log, WLOG_DEBUG,
"transport_check_fds() - %i", status);
2294 status = freerdp_timer_poll(rdp->timer);
2299BOOL freerdp_get_stats(
const rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes, UINT64* inPackets,
2306 *inBytes = rdp->inBytes;
2308 *outBytes = rdp->outBytes;
2310 *inPackets = rdp->inPackets;
2312 *outPackets = rdp->outPackets;
2317static bool rdp_new_common(rdpRdp* rdp)
2322 rdp->transport = transport_new(rdp->context);
2323 if (!rdp->transport)
2328 if (!transport_set_io_callbacks(rdp->transport, rdp->io))
2332 rdp->aad = aad_new(rdp->context);
2336 rdp->nego = nego_new(rdp->transport);
2340 rdp->mcs = mcs_new(rdp->context);
2344 rdp->license = license_new(rdp);
2348 rdp->fastpath = fastpath_new(rdp);
2362rdpRdp* rdp_new(rdpContext* context)
2365 rdpRdp* rdp = (rdpRdp*)calloc(1,
sizeof(rdpRdp));
2370 rdp->log = WLog_Get(RDP_TAG);
2371 WINPR_ASSERT(rdp->log);
2373 (void)_snprintf(rdp->log_context,
sizeof(rdp->log_context),
"%p", (
void*)context);
2374 WLog_SetContext(rdp->log,
nullptr, rdp->log_context);
2376 InitializeCriticalSection(&rdp->critical);
2377 rdp->context = context;
2378 WINPR_ASSERT(rdp->context);
2380 if (context->ServerMode)
2383 if (!context->settings)
2391 rdp->settings = context->settings;
2394 if (!rdp_set_backup_settings(rdp))
2397 rdp->settings->instance = context->instance;
2399 context->settings = rdp->settings;
2400 if (context->instance)
2401 context->settings->instance = context->instance;
2402 else if (context->peer)
2404 rdp->settings->instance = context->peer;
2406#if defined(WITH_FREERDP_DEPRECATED)
2407 context->peer->settings = rdp->settings;
2411 if (!rdp_new_common(rdp))
2415 const rdpTransportIo* io = transport_get_io_callbacks(rdp->transport);
2418 rdp->io = calloc(1,
sizeof(rdpTransportIo));
2424 rdp->input = input_new(rdp);
2429 rdp->update = update_new(rdp);
2434 rdp->redirection = redirection_new();
2436 if (!rdp->redirection)
2439 rdp->autodetect = autodetect_new(rdp->context);
2441 if (!rdp->autodetect)
2444 rdp->heartbeat = heartbeat_new();
2446 if (!rdp->heartbeat)
2449 rdp->multitransport = multitransport_new(rdp, INITIATE_REQUEST_PROTOCOL_UDPFECL |
2450 INITIATE_REQUEST_PROTOCOL_UDPFECR);
2452 if (!rdp->multitransport)
2455 rdp->bulk = bulk_new(context);
2460 rdp->pubSub = PubSub_New(TRUE);
2464 rdp->abortEvent = CreateEvent(
nullptr, TRUE, FALSE,
nullptr);
2465 if (!rdp->abortEvent)
2468 rdp->timer = freerdp_timer_new(rdp);
2475 WINPR_PRAGMA_DIAG_PUSH
2476 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2478 WINPR_PRAGMA_DIAG_POP
2482static void rdp_reset_free(rdpRdp* rdp)
2487 rdp_free_rc4_decrypt_keys(rdp);
2488 rdp_free_rc4_encrypt_keys(rdp);
2490 winpr_Cipher_Free(rdp->fips_encrypt);
2491 winpr_Cipher_Free(rdp->fips_decrypt);
2492 rdp->fips_encrypt =
nullptr;
2493 rdp->fips_decrypt =
nullptr;
2494 security_unlock(rdp);
2498 nego_free(rdp->nego);
2499 license_free(rdp->license);
2500 transport_free(rdp->transport);
2501 fastpath_free(rdp->fastpath);
2505 rdp->nego =
nullptr;
2506 rdp->license =
nullptr;
2507 rdp->transport =
nullptr;
2508 rdp->fastpath =
nullptr;
2511BOOL rdp_reset(rdpRdp* rdp)
2517 rdpSettings* settings = rdp->settings;
2518 WINPR_ASSERT(settings);
2520 bulk_reset(rdp->bulk);
2522 rdp_reset_free(rdp);
2536 rc = rdp_new_common(rdp);
2540 if (!transport_set_layer(rdp->transport, TRANSPORT_LAYER_TCP))
2544 rc = rdp_finalize_reset_flags(rdp, TRUE);
2555void rdp_free(rdpRdp* rdp)
2559 freerdp_timer_free(rdp->timer);
2560 rdp_reset_free(rdp);
2566 input_free(rdp->input);
2567 update_free(rdp->update);
2569 redirection_free(rdp->redirection);
2570 autodetect_free(rdp->autodetect);
2571 heartbeat_free(rdp->heartbeat);
2572 multitransport_free(rdp->multitransport);
2573 bulk_free(rdp->bulk);
2575 PubSub_Free(rdp->pubSub);
2576 if (rdp->abortEvent)
2577 (void)CloseHandle(rdp->abortEvent);
2580 DeleteCriticalSection(&rdp->critical);
2585BOOL rdp_io_callback_set_event(rdpRdp* rdp, BOOL set)
2589 return transport_io_callback_set_event(rdp->transport, set);
2592const rdpTransportIo* rdp_get_io_callbacks(rdpRdp* rdp)
2599BOOL rdp_set_io_callbacks(rdpRdp* rdp,
const rdpTransportIo* io_callbacks)
2607 rdp->io = malloc(
sizeof(rdpTransportIo));
2610 *rdp->io = *io_callbacks;
2611 return transport_set_io_callbacks(rdp->transport, rdp->io);
2616BOOL rdp_set_io_callback_context(rdpRdp* rdp,
void* usercontext)
2619 rdp->ioContext = usercontext;
2623void* rdp_get_io_callback_context(rdpRdp* rdp)
2626 return rdp->ioContext;
2629const char* rdp_finalize_flags_to_str(UINT32 flags,
char* buffer,
size_t size)
2631 char number[32] = WINPR_C_ARRAY_INIT;
2633 (uint32_t)~(FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
2634 FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU |
2635 FINALIZE_CS_SYNCHRONIZE_PDU | FINALIZE_CS_CONTROL_COOPERATE_PDU |
2636 FINALIZE_CS_CONTROL_REQUEST_PDU | FINALIZE_CS_PERSISTENT_KEY_LIST_PDU |
2637 FINALIZE_CS_FONT_LIST_PDU | FINALIZE_DEACTIVATE_REACTIVATE);
2639 if (flags & FINALIZE_SC_SYNCHRONIZE_PDU)
2640 winpr_str_append(
"FINALIZE_SC_SYNCHRONIZE_PDU", buffer, size,
"|");
2641 if (flags & FINALIZE_SC_CONTROL_COOPERATE_PDU)
2642 winpr_str_append(
"FINALIZE_SC_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2643 if (flags & FINALIZE_SC_CONTROL_GRANTED_PDU)
2644 winpr_str_append(
"FINALIZE_SC_CONTROL_GRANTED_PDU", buffer, size,
"|");
2645 if (flags & FINALIZE_SC_FONT_MAP_PDU)
2646 winpr_str_append(
"FINALIZE_SC_FONT_MAP_PDU", buffer, size,
"|");
2647 if (flags & FINALIZE_CS_SYNCHRONIZE_PDU)
2648 winpr_str_append(
"FINALIZE_CS_SYNCHRONIZE_PDU", buffer, size,
"|");
2649 if (flags & FINALIZE_CS_CONTROL_COOPERATE_PDU)
2650 winpr_str_append(
"FINALIZE_CS_CONTROL_COOPERATE_PDU", buffer, size,
"|");
2651 if (flags & FINALIZE_CS_CONTROL_REQUEST_PDU)
2652 winpr_str_append(
"FINALIZE_CS_CONTROL_REQUEST_PDU", buffer, size,
"|");
2653 if (flags & FINALIZE_CS_PERSISTENT_KEY_LIST_PDU)
2654 winpr_str_append(
"FINALIZE_CS_PERSISTENT_KEY_LIST_PDU", buffer, size,
"|");
2655 if (flags & FINALIZE_CS_FONT_LIST_PDU)
2656 winpr_str_append(
"FINALIZE_CS_FONT_LIST_PDU", buffer, size,
"|");
2657 if (flags & FINALIZE_DEACTIVATE_REACTIVATE)
2658 winpr_str_append(
"FINALIZE_DEACTIVATE_REACTIVATE", buffer, size,
"|");
2660 winpr_str_append(
"UNKNOWN_FLAG", buffer, size,
"|");
2662 winpr_str_append(
"NO_FLAG_SET", buffer, size,
"|");
2663 (void)_snprintf(number,
sizeof(number),
" [0x%08" PRIx32
"]", flags);
2664 winpr_str_append(number, buffer, size,
"");
2668BOOL rdp_finalize_reset_flags(rdpRdp* rdp, BOOL clearAll)
2671 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] reset finalize_sc_pdus", rdp_get_state_string(rdp));
2673 rdp->finalize_sc_pdus = 0;
2675 rdp->finalize_sc_pdus &= FINALIZE_DEACTIVATE_REACTIVATE;
2677 return rdp_set_monitor_layout_pdu_state(rdp, FALSE);
2680BOOL rdp_finalize_set_flag(rdpRdp* rdp, UINT32 flag)
2682 char buffer[1024] = WINPR_C_ARRAY_INIT;
2686 WLog_Print(rdp->log, WLOG_DEBUG,
"[%s] received flag %s", rdp_get_state_string(rdp),
2687 rdp_finalize_flags_to_str(flag, buffer,
sizeof(buffer)));
2688 rdp->finalize_sc_pdus |= flag;
2692BOOL rdp_finalize_is_flag_set(rdpRdp* rdp, UINT32 flag)
2695 return (rdp->finalize_sc_pdus & flag) == flag;
2698BOOL rdp_reset_rc4_encrypt_keys(rdpRdp* rdp)
2701 rdp_free_rc4_encrypt_keys(rdp);
2702 rdp->rc4_encrypt_key = winpr_RC4_New(rdp->encrypt_key, rdp->rc4_key_len);
2704 rdp->encrypt_use_count = 0;
2705 return rdp->rc4_encrypt_key !=
nullptr;
2708void rdp_free_rc4_encrypt_keys(rdpRdp* rdp)
2711 winpr_RC4_Free(rdp->rc4_encrypt_key);
2712 rdp->rc4_encrypt_key =
nullptr;
2715void rdp_free_rc4_decrypt_keys(rdpRdp* rdp)
2718 winpr_RC4_Free(rdp->rc4_decrypt_key);
2719 rdp->rc4_decrypt_key =
nullptr;
2722BOOL rdp_reset_rc4_decrypt_keys(rdpRdp* rdp)
2725 rdp_free_rc4_decrypt_keys(rdp);
2726 rdp->rc4_decrypt_key = winpr_RC4_New(rdp->decrypt_key, rdp->rc4_key_len);
2728 rdp->decrypt_use_count = 0;
2729 return rdp->rc4_decrypt_key !=
nullptr;
2732const char* rdp_security_flag_string(UINT32 securityFlags,
char* buffer,
size_t size)
2734 if (securityFlags & SEC_EXCHANGE_PKT)
2735 winpr_str_append(
"SEC_EXCHANGE_PKT", buffer, size,
"|");
2736 if (securityFlags & SEC_TRANSPORT_REQ)
2737 winpr_str_append(
"SEC_TRANSPORT_REQ", buffer, size,
"|");
2738 if (securityFlags & SEC_TRANSPORT_RSP)
2739 winpr_str_append(
"SEC_TRANSPORT_RSP", buffer, size,
"|");
2740 if (securityFlags & SEC_ENCRYPT)
2741 winpr_str_append(
"SEC_ENCRYPT", buffer, size,
"|");
2742 if (securityFlags & SEC_RESET_SEQNO)
2743 winpr_str_append(
"SEC_RESET_SEQNO", buffer, size,
"|");
2744 if (securityFlags & SEC_IGNORE_SEQNO)
2745 winpr_str_append(
"SEC_IGNORE_SEQNO", buffer, size,
"|");
2746 if (securityFlags & SEC_INFO_PKT)
2747 winpr_str_append(
"SEC_INFO_PKT", buffer, size,
"|");
2748 if (securityFlags & SEC_LICENSE_PKT)
2749 winpr_str_append(
"SEC_LICENSE_PKT", buffer, size,
"|");
2750 if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
2751 winpr_str_append(
"SEC_LICENSE_ENCRYPT_CS", buffer, size,
"|");
2752 if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
2753 winpr_str_append(
"SEC_LICENSE_ENCRYPT_SC", buffer, size,
"|");
2754 if (securityFlags & SEC_REDIRECTION_PKT)
2755 winpr_str_append(
"SEC_REDIRECTION_PKT", buffer, size,
"|");
2756 if (securityFlags & SEC_SECURE_CHECKSUM)
2757 winpr_str_append(
"SEC_SECURE_CHECKSUM", buffer, size,
"|");
2758 if (securityFlags & SEC_AUTODETECT_REQ)
2759 winpr_str_append(
"SEC_AUTODETECT_REQ", buffer, size,
"|");
2760 if (securityFlags & SEC_AUTODETECT_RSP)
2761 winpr_str_append(
"SEC_AUTODETECT_RSP", buffer, size,
"|");
2762 if (securityFlags & SEC_HEARTBEAT)
2763 winpr_str_append(
"SEC_HEARTBEAT", buffer, size,
"|");
2764 if (securityFlags & SEC_FLAGSHI_VALID)
2765 winpr_str_append(
"SEC_FLAGSHI_VALID", buffer, size,
"|");
2767 char msg[32] = WINPR_C_ARRAY_INIT;
2769 (void)_snprintf(msg,
sizeof(msg),
"[0x%08" PRIx32
"]", securityFlags);
2770 winpr_str_append(msg, buffer, size,
"");
2775static BOOL rdp_reset_remote_settings(rdpRdp* rdp)
2777 UINT32 flags = FREERDP_SETTINGS_REMOTE_MODE;
2784 return rdp->remoteSettings !=
nullptr;
2787BOOL rdp_set_backup_settings(rdpRdp* rdp)
2792 if (!rdp->originalSettings)
2794 return rdp_reset_remote_settings(rdp);
2797BOOL rdp_reset_runtime_settings(rdpRdp* rdp)
2800 WINPR_ASSERT(rdp->context);
2807 return rdp_reset_remote_settings(rdp);
2810static BOOL starts_with(
const char* tok,
const char* val)
2812 const size_t len = strlen(val);
2813 if (strncmp(tok, val, len) != 0)
2815 if (tok[len] !=
'=')
2820static BOOL option_equals(
const char* what,
const char* val)
2822 return _stricmp(what, val) == 0;
2825static BOOL parse_on_off_option(
const char* value)
2827 WINPR_ASSERT(value);
2828 const char* sep = strchr(value,
'=');
2831 if (option_equals(
"on", &sep[1]))
2833 if (option_equals(
"true", &sep[1]))
2835 if (option_equals(
"off", &sep[1]))
2837 if (option_equals(
"false", &sep[1]))
2841 long val = strtol(value,
nullptr, 0);
2850static BOOL option_is_runtime_checks(WINPR_ATTR_UNUSED wLog* log,
const char* tok)
2852 const char* experimental[] = { STR(WITH_VERBOSE_WINPR_ASSERT) };
2853 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2855 const char* opt = experimental[x];
2856 if (starts_with(tok, opt))
2858 return parse_on_off_option(tok);
2864static BOOL option_is_experimental(WINPR_ATTR_UNUSED wLog* log,
const char* tok)
2866 const char* experimental[] = { STR(WITH_DSP_EXPERIMENTAL), STR(WITH_VAAPI) };
2867 for (
size_t x = 0; x < ARRAYSIZE(experimental); x++)
2869 const char* opt = experimental[x];
2870 if (starts_with(tok, opt))
2872 return parse_on_off_option(tok);
2878static BOOL option_is_debug(wLog* log,
const char* tok)
2881 const char* debug[] = { STR(WITH_DEBUG_ALL),
2882 STR(WITH_DEBUG_CERTIFICATE),
2883 STR(WITH_DEBUG_CAPABILITIES),
2884 STR(WITH_DEBUG_CHANNELS),
2885 STR(WITH_DEBUG_CLIPRDR),
2886 STR(WITH_DEBUG_CODECS),
2887 STR(WITH_DEBUG_RDPGFX),
2888 STR(WITH_DEBUG_DVC),
2889 STR(WITH_DEBUG_TSMF),
2890 STR(WITH_DEBUG_KBD),
2891 STR(WITH_DEBUG_LICENSE),
2892 STR(WITH_DEBUG_NEGO),
2893 STR(WITH_DEBUG_NLA),
2894 STR(WITH_DEBUG_TSG),
2895 STR(WITH_DEBUG_RAIL),
2896 STR(WITH_DEBUG_RDP),
2897 STR(WITH_DEBUG_RDPEI),
2898 STR(WITH_DEBUG_REDIR),
2899 STR(WITH_DEBUG_RDPDR),
2900 STR(WITH_DEBUG_RFX),
2901 STR(WITH_DEBUG_SCARD),
2902 STR(WITH_DEBUG_SND),
2903 STR(WITH_DEBUG_SVC),
2904 STR(WITH_DEBUG_TRANSPORT),
2905 STR(WITH_DEBUG_TIMEZONE),
2906 STR(WITH_DEBUG_WND),
2907 STR(WITH_DEBUG_X11_CLIPRDR),
2908 STR(WITH_DEBUG_X11_LOCAL_MOVESIZE),
2909 STR(WITH_DEBUG_X11),
2911 STR(WITH_DEBUG_RINGBUFFER),
2912 STR(WITH_DEBUG_SYMBOLS),
2913 STR(WITH_DEBUG_EVENTS),
2914 STR(WITH_DEBUG_MUTEX),
2915 STR(WITH_DEBUG_NTLM),
2916 STR(WITH_DEBUG_SDL_EVENTS),
2917 STR(WITH_DEBUG_SDL_KBD_EVENTS),
2918 STR(WITH_DEBUG_THREADS),
2919 STR(WITH_DEBUG_URBDRC) };
2921 for (
size_t x = 0; x < ARRAYSIZE(debug); x++)
2923 const char* opt = debug[x];
2924 if (starts_with(tok, opt))
2925 return parse_on_off_option(tok);
2928 if (starts_with(tok,
"WITH_DEBUG"))
2930 WLog_Print(log, WLOG_WARN,
"[BUG] Unmapped Debug-Build option '%s'.", tok);
2931 return parse_on_off_option(tok);
2937static void log_build_warn(rdpRdp* rdp,
const char* what,
const char* msg,
2938 BOOL (*cmp)(wLog* log,
const char* tok))
2941 WINPR_PRAGMA_DIAG_PUSH
2942 WINPR_PRAGMA_DIAG_IGNORED_OVERLENGTH_STRINGS
2944 size_t len =
sizeof(FREERDP_BUILD_CONFIG);
2945 char* list = calloc(len,
sizeof(
char));
2946 char* config = _strdup(FREERDP_BUILD_CONFIG);
2947 WINPR_PRAGMA_DIAG_POP
2951 char* saveptr =
nullptr;
2952 char* tok = strtok_s(config,
" ", &saveptr);
2955 if (cmp(rdp->log, tok))
2956 winpr_str_append(tok, list, len,
" ");
2958 tok = strtok_s(
nullptr,
" ", &saveptr);
2965 if (strlen(list) > 0)
2967 WLog_Print(rdp->log, WLOG_WARN,
"*************************************************");
2968 WLog_Print(rdp->log, WLOG_WARN,
"This build is using [%s] build options:", what);
2970 char* saveptr =
nullptr;
2971 char* tok = strtok_s(list,
" ", &saveptr);
2974 WLog_Print(rdp->log, WLOG_WARN,
"* '%s'", tok);
2975 tok = strtok_s(
nullptr,
" ", &saveptr);
2977 WLog_Print(rdp->log, WLOG_WARN,
"*");
2978 WLog_Print(rdp->log, WLOG_WARN,
"[%s] build options %s", what, msg);
2979 WLog_Print(rdp->log, WLOG_WARN,
"*************************************************");
2985#define print_first_line(log, firstLine, what) \
2986 print_first_line_int((log), (firstLine), (what), __FILE__, __func__, __LINE__)
2987static void print_first_line_int(wLog* log, log_line_t* firstLine,
const char* what,
2988 const char* file,
const char* fkt,
size_t line)
2990 WINPR_ASSERT(firstLine);
2991 if (!firstLine->fkt)
2993 const DWORD level = WLOG_WARN;
2994 if (WLog_IsLevelActive(log, level))
2996 WLog_PrintTextMessage(log, level, line, file, fkt,
2997 "*************************************************");
2998 WLog_PrintTextMessage(log, level, line, file, fkt,
2999 "[SSL] {%s} build or configuration missing:", what);
3001 firstLine->line = line;
3002 firstLine->file = file;
3003 firstLine->fkt = fkt;
3004 firstLine->level = level;
3008static void print_last_line(wLog* log,
const log_line_t* firstLine)
3010 WINPR_ASSERT(firstLine);
3013 if (WLog_IsLevelActive(log, firstLine->level))
3014 WLog_PrintTextMessage(log, firstLine->level, firstLine->line, firstLine->file,
3016 "*************************************************");
3020static void log_build_warn_cipher(rdpRdp* rdp, log_line_t* firstLine, WINPR_CIPHER_TYPE md,
3023 BOOL haveCipher = FALSE;
3025 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3026 char iv[WINPR_CIPHER_MAX_IV_LENGTH] = WINPR_C_ARRAY_INIT;
3030 if (md == WINPR_CIPHER_ARC4_128)
3032 WINPR_RC4_CTX* enc = winpr_RC4_New(key,
sizeof(key));
3033 haveCipher = enc !=
nullptr;
3034 winpr_RC4_Free(enc);
3038 WINPR_CIPHER_CTX* enc =
3039 winpr_Cipher_NewEx(md, WINPR_ENCRYPT, key,
sizeof(key), iv,
sizeof(iv));
3040 WINPR_CIPHER_CTX* dec =
3041 winpr_Cipher_NewEx(md, WINPR_DECRYPT, key,
sizeof(key), iv,
sizeof(iv));
3045 winpr_Cipher_Free(enc);
3046 winpr_Cipher_Free(dec);
3051 print_first_line(rdp->log, firstLine,
"Cipher");
3052 WLog_Print(rdp->log, WLOG_WARN,
"* %s: %s", winpr_cipher_type_to_string(md), what);
3056static void log_build_warn_hmac(rdpRdp* rdp, log_line_t* firstLine, WINPR_MD_TYPE md,
3059 BOOL haveHmacX = FALSE;
3060 WINPR_HMAC_CTX* hmac = winpr_HMAC_New();
3066 char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
3067 haveHmacX = winpr_HMAC_Init(hmac, md, key,
sizeof(key));
3069 winpr_HMAC_Free(hmac);
3073 print_first_line(rdp->log, firstLine,
"HMAC");
3074 WLog_Print(rdp->log, WLOG_WARN,
" * %s: %s", winpr_md_type_to_string(md), what);
3078static void log_build_warn_hash(rdpRdp* rdp, log_line_t* firstLine, WINPR_MD_TYPE md,
3081 BOOL haveDigestX = FALSE;
3083 WINPR_DIGEST_CTX* digest = winpr_Digest_New();
3085 haveDigestX = winpr_Digest_Init(digest, md);
3086 winpr_Digest_Free(digest);
3090 print_first_line(rdp->log, firstLine,
"Digest");
3091 WLog_Print(rdp->log, WLOG_WARN,
" * %s: %s", winpr_md_type_to_string(md), what);
3095static void log_build_warn_ssl(rdpRdp* rdp)
3099 log_line_t firstHashLine = WINPR_C_ARRAY_INIT;
3100 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD4,
"NTLM support not available");
3101 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_MD5,
3102 "NTLM, assistance files with encrypted passwords, autoreconnect cookies, "
3103 "licensing and RDP security will not work");
3104 log_build_warn_hash(rdp, &firstHashLine, WINPR_MD_SHA1,
3105 "assistance files with encrypted passwords, Kerberos, Smartcard Logon, RDP "
3106 "security support not available");
3107 log_build_warn_hash(
3108 rdp, &firstHashLine, WINPR_MD_SHA256,
3109 "file clipboard, AAD gateway, NLA security and certificates might not work");
3110 print_last_line(rdp->log, &firstHashLine);
3112 log_line_t firstHmacLine = WINPR_C_ARRAY_INIT;
3113 log_build_warn_hmac(rdp, &firstHmacLine, WINPR_MD_MD5,
"Autoreconnect cookie not supported");
3114 log_build_warn_hmac(rdp, &firstHmacLine, WINPR_MD_SHA1,
"RDP security not supported");
3115 print_last_line(rdp->log, &firstHmacLine);
3117 log_line_t firstCipherLine = WINPR_C_ARRAY_INIT;
3118 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_ARC4_128,
3119 "assistance files with encrypted passwords, NTLM, RDP licensing and RDP "
3120 "security will not work");
3121 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_DES_EDE3_CBC,
3122 "RDP security FIPS mode will not work");
3123 log_build_warn_cipher(
3124 rdp, &firstCipherLine, WINPR_CIPHER_AES_128_CBC,
3125 "assistance file encrypted LHTicket will not work and ARM gateway might not");
3126 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_AES_192_CBC,
3127 "ARM gateway might not work");
3128 log_build_warn_cipher(rdp, &firstCipherLine, WINPR_CIPHER_AES_256_CBC,
3129 "ARM gateway might not work");
3130 print_last_line(rdp->log, &firstCipherLine);
3133void rdp_log_build_warnings(rdpRdp* rdp)
3135 static unsigned count = 0;
3144 log_build_warn(rdp,
"experimental",
"might crash the application", option_is_experimental);
3145 log_build_warn(rdp,
"debug",
"might leak sensitive information (credentials, ...)",
3147 log_build_warn(rdp,
"runtime-check",
"might slow down the application",
3148 option_is_runtime_checks);
3149 log_build_warn_ssl(rdp);
3152size_t rdp_get_event_handles(rdpRdp* rdp, HANDLE* handles, uint32_t count)
3154 size_t nCount = transport_get_event_handles(rdp->transport, handles, count);
3159 if (count < nCount + 2UL)
3162 handles[nCount++] = utils_get_abort_event(rdp);
3163 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.