20#include <freerdp/config.h>
24#include <freerdp/log.h>
25#include <freerdp/error.h>
26#include <freerdp/settings.h>
28#include <winpr/assert.h>
29#include <winpr/stream.h>
30#include <winpr/wlog.h>
36#define RDSTLS_VERSION_1 0x01u
37#define RDSTLS_VERSION_2 0x02u
39#define RDSTLS_TYPE_CAPABILITIES 0x01
40#define RDSTLS_TYPE_AUTHREQ 0x02
41#define RDSTLS_TYPE_AUTHRSP 0x04
43#define RDSTLS_DATA_CAPABILITIES 0x01
44#define RDSTLS_DATA_PASSWORD_CREDS 0x01
45#define RDSTLS_DATA_AUTORECONNECT_COOKIE 0x02
46#define RDSTLS_DATA_FEDAUTH_TOKEN 0x03
47#define RDSTLS_DATA_RESULT_CODE 0x01
52 RDSTLS_STATE_CAPABILITIES,
53 RDSTLS_STATE_AUTH_REQ,
54 RDSTLS_STATE_AUTH_RSP,
61 RDSTLS_RESULT_SUCCESS = 0x00000000,
62 RDSTLS_RESULT_ACCESS_DENIED = 0x00000005,
63 RDSTLS_RESULT_LOGON_FAILURE = 0x0000052e,
64 RDSTLS_RESULT_INVALID_LOGON_HOURS = 0x00000530,
65 RDSTLS_RESULT_PASSWORD_EXPIRED = 0x00000532,
66 RDSTLS_RESULT_ACCOUNT_DISABLED = 0x00000533,
67 RDSTLS_RESULT_PASSWORD_MUST_CHANGE = 0x00000773,
68 RDSTLS_RESULT_ACCOUNT_LOCKED_OUT = 0x00000775
76 rdpTransport* transport;
78 RDSTLS_RESULT_CODE resultCode;
80 uint16_t supportedVersions;
83static const uint16_t RDSTLS_VERSION_MASK = RDSTLS_VERSION_1 | RDSTLS_VERSION_2;
86static const char* rdstls_result_code_str(UINT32 resultCode)
90 case RDSTLS_RESULT_SUCCESS:
91 return "RDSTLS_RESULT_SUCCESS";
92 case RDSTLS_RESULT_ACCESS_DENIED:
93 return "RDSTLS_RESULT_ACCESS_DENIED";
94 case RDSTLS_RESULT_LOGON_FAILURE:
95 return "RDSTLS_RESULT_LOGON_FAILURE";
96 case RDSTLS_RESULT_INVALID_LOGON_HOURS:
97 return "RDSTLS_RESULT_INVALID_LOGON_HOURS";
98 case RDSTLS_RESULT_PASSWORD_EXPIRED:
99 return "RDSTLS_RESULT_PASSWORD_EXPIRED";
100 case RDSTLS_RESULT_ACCOUNT_DISABLED:
101 return "RDSTLS_RESULT_ACCOUNT_DISABLED";
102 case RDSTLS_RESULT_PASSWORD_MUST_CHANGE:
103 return "RDSTLS_RESULT_PASSWORD_MUST_CHANGE";
104 case RDSTLS_RESULT_ACCOUNT_LOCKED_OUT:
105 return "RDSTLS_RESULT_ACCOUNT_LOCKED_OUT";
107 return "RDSTLS_RESULT_UNKNOWN";
111#define rdstls_required_role_is_server(rdstls, isServer) \
112 rdstls_required_role_is_server_((rdstls), (isServer), __FILE__, __func__, __LINE__)
115static BOOL rdstls_required_role_is_server_(
const rdpRdstls* rdstls, BOOL isServer,
116 const char* file,
const char* fkt,
size_t line)
118 WINPR_ASSERT(rdstls);
119 const BOOL rc = rdstls->server == isServer;
122 const DWORD level = WLOG_ERROR;
123 if (WLog_IsLevelActive(rdstls->log, level))
124 WLog_PrintTextMessage(rdstls->log, level, line, file, fkt,
125 "Message not allowed in current role '%s'",
126 rdstls->server ?
"server" :
"client");
139rdpRdstls* rdstls_new(rdpContext* context, rdpTransport* transport)
141 WINPR_ASSERT(context);
142 WINPR_ASSERT(transport);
144 rdpSettings* settings = context->settings;
145 WINPR_ASSERT(settings);
147 rdpRdstls* rdstls = (rdpRdstls*)calloc(1,
sizeof(rdpRdstls));
151 rdstls->log = WLog_Get(FREERDP_TAG(
"core.rdstls"));
152 rdstls->supportedVersions = RDSTLS_VERSION_MASK;
153 rdstls->context = context;
154 rdstls->transport = transport;
155 rdstls->server = settings->ServerMode;
157 rdstls->resultCode = RDSTLS_RESULT_ACCESS_DENIED;
158 rdstls->state = RDSTLS_STATE_INITIAL;
168void rdstls_free(rdpRdstls* rdstls)
174static const char* rdstls_get_state_str(RDSTLS_STATE state)
178 case RDSTLS_STATE_INITIAL:
179 return "RDSTLS_STATE_INITIAL";
180 case RDSTLS_STATE_CAPABILITIES:
181 return "RDSTLS_STATE_CAPABILITIES";
182 case RDSTLS_STATE_AUTH_REQ:
183 return "RDSTLS_STATE_AUTH_REQ";
184 case RDSTLS_STATE_AUTH_RSP:
185 return "RDSTLS_STATE_AUTH_RSP";
186 case RDSTLS_STATE_FINAL:
187 return "RDSTLS_STATE_FINAL";
194static RDSTLS_STATE rdstls_get_state(rdpRdstls* rdstls)
196 WINPR_ASSERT(rdstls);
197 return rdstls->state;
201static BOOL check_transition(wLog* log, RDSTLS_STATE current, RDSTLS_STATE expected,
202 RDSTLS_STATE requested)
204 if (requested != expected)
206 WLog_Print(log, WLOG_ERROR,
207 "Unexpected rdstls state transition from %s [%u] to %s [%u], expected %s [%u]",
208 rdstls_get_state_str(current), current, rdstls_get_state_str(requested),
209 requested, rdstls_get_state_str(expected), expected);
216static BOOL rdstls_set_state(rdpRdstls* rdstls, RDSTLS_STATE state)
219 WINPR_ASSERT(rdstls);
221 WLog_Print(rdstls->log, WLOG_DEBUG,
"-- %s\t--> %s", rdstls_get_state_str(rdstls->state),
222 rdstls_get_state_str(state));
224 switch (rdstls->state)
226 case RDSTLS_STATE_INITIAL:
227 rc = check_transition(rdstls->log, rdstls->state, RDSTLS_STATE_CAPABILITIES, state);
229 case RDSTLS_STATE_CAPABILITIES:
230 rc = check_transition(rdstls->log, rdstls->state, RDSTLS_STATE_AUTH_REQ, state);
232 case RDSTLS_STATE_AUTH_REQ:
233 rc = check_transition(rdstls->log, rdstls->state, RDSTLS_STATE_AUTH_RSP, state);
235 case RDSTLS_STATE_AUTH_RSP:
236 rc = check_transition(rdstls->log, rdstls->state, RDSTLS_STATE_FINAL, state);
238 case RDSTLS_STATE_FINAL:
239 rc = check_transition(rdstls->log, rdstls->state, RDSTLS_STATE_CAPABILITIES, state);
242 WLog_Print(rdstls->log, WLOG_ERROR,
243 "Invalid rdstls state %s [%u], requested transition to %s [%u]",
244 rdstls_get_state_str(rdstls->state), rdstls->state,
245 rdstls_get_state_str(state), state);
249 rdstls->state = state;
254#define rdstls_check_state_requirements(rdstls, expected) \
255 rdstls_check_state_requirements_((rdstls), (expected), __FILE__, __func__, __LINE__)
258static BOOL rdstls_check_state_requirements_(rdpRdstls* rdstls, RDSTLS_STATE expected,
259 const char* file,
const char* fkt,
size_t line)
261 const RDSTLS_STATE current = rdstls_get_state(rdstls);
262 if (current == expected)
265 WINPR_ASSERT(rdstls);
267 const DWORD log_level = WLOG_ERROR;
268 if (WLog_IsLevelActive(rdstls->log, log_level))
269 WLog_PrintTextMessage(rdstls->log, log_level, line, file, fkt,
270 "Unexpected rdstls state %s [%u], expected %s [%u]",
271 rdstls_get_state_str(current), current,
272 rdstls_get_state_str(expected), expected);
278static BOOL rdstls_write_capabilities(WINPR_ATTR_UNUSED rdpRdstls* rdstls,
wStream* s)
280 if (!Stream_EnsureRemainingCapacity(s, 8))
283 Stream_Write_UINT16(s, RDSTLS_VERSION_1);
284 Stream_Write_UINT16(s, RDSTLS_TYPE_CAPABILITIES);
285 Stream_Write_UINT16(s, RDSTLS_DATA_CAPABILITIES);
286 Stream_Write_UINT16(s, rdstls->supportedVersions);
292static SSIZE_T rdstls_write_string(
wStream* s,
const char* str)
294 const size_t pos = Stream_GetPosition(s);
296 if (!Stream_EnsureRemainingCapacity(s, 2))
302 Stream_Write_UINT16(s, 2);
303 if (!Stream_EnsureRemainingCapacity(s, 2))
306 Stream_Write_UINT16(s, 0);
307 return (SSIZE_T)(Stream_GetPosition(s) - pos);
310 const SSIZE_T devNameWLen = ConvertUtf8ToWChar(str,
nullptr, 0);
313 const size_t length = WINPR_ASSERTING_INT_CAST(
size_t, devNameWLen) + 1;
314 const size_t slen = strlen(str);
316 Stream_Write_UINT16(s, (UINT16)length *
sizeof(WCHAR));
318 if (!Stream_EnsureRemainingCapacity(s, length *
sizeof(WCHAR)))
321 if (Stream_Write_UTF16_String_From_UTF8(s, length, str, slen, TRUE) < 0)
324 return (SSIZE_T)(Stream_GetPosition(s) - pos);
328static BOOL rdstls_write_data(
wStream* s, UINT32 length,
const BYTE* data)
330 WINPR_ASSERT(data || (length == 0));
332 if (!Stream_EnsureRemainingCapacity(s, 2) || (length > UINT16_MAX))
335 Stream_Write_UINT16(s, (UINT16)length);
337 if (!Stream_EnsureRemainingCapacity(s, length))
340 Stream_Write(s, data, length);
348 WINPR_ASSERT(cookie);
352 if (!Stream_EnsureRemainingCapacity(s, 2))
355 Stream_Write_UINT16(s, length);
357 if (!Stream_EnsureRemainingCapacity(s, length))
360 Stream_Write_UINT32(s, cookie->cbLen);
361 Stream_Write_UINT32(s, cookie->version);
362 Stream_Write_UINT32(s, cookie->logonId);
363 Stream_Write(s, cookie->arcRandomBits,
sizeof(cookie->arcRandomBits));
370 WINPR_ASSERT(cookie);
374 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, length + 2ull))
377 const uint16_t len = Stream_Get_UINT16(s);
380 WLog_Print(log, WLOG_ERROR,
381 "RDSTLS Cookie: Unexpected length %" PRIu16
", expected %" PRIu16, len, length);
385 cookie->cbLen = Stream_Get_UINT32(s);
386 cookie->version = Stream_Get_UINT32(s);
387 cookie->logonId = Stream_Get_UINT32(s);
388 Stream_Read(s, cookie->arcRandomBits,
sizeof(cookie->arcRandomBits));
393static BOOL rdstls_write_authentication_request_with_password(rdpRdstls* rdstls,
wStream* s)
395 WINPR_ASSERT(rdstls);
396 WINPR_ASSERT(rdstls->context);
398 if (!rdstls_required_role_is_server(rdstls, FALSE))
400 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_REQ))
403 WLog_Print(rdstls->log, WLOG_DEBUG,
"Writing RDSTLS password authentication message");
405 rdpSettings* settings = rdstls->context->settings;
406 WINPR_ASSERT(settings);
408 if (!Stream_EnsureRemainingCapacity(s, 4))
411 Stream_Write_UINT16(s, RDSTLS_TYPE_AUTHREQ);
412 Stream_Write_UINT16(s, RDSTLS_DATA_PASSWORD_CREDS);
414 if (!rdstls_write_data(s, settings->RedirectionGuidLength, settings->RedirectionGuid))
417 if (rdstls_write_string(s, settings->Username) < 0)
420 if (rdstls_write_string(s, settings->Domain) < 0)
423 if (!rdstls_write_data(s, settings->RedirectionPasswordLength, settings->RedirectionPassword))
430static BOOL rdstls_write_authentication_request_with_cookie(WINPR_ATTR_UNUSED rdpRdstls* rdstls,
433 WINPR_ASSERT(rdstls);
434 WINPR_ASSERT(rdstls->context);
436 WLog_Print(rdstls->log, WLOG_DEBUG,
"Writing RDSTLS cookie authentication message");
438 if (!rdstls_required_role_is_server(rdstls, FALSE))
440 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_REQ))
443 rdpSettings* settings = rdstls->context->settings;
444 WINPR_ASSERT(settings);
446 if (!Stream_EnsureRemainingCapacity(s, 8))
449 Stream_Write_UINT16(s, RDSTLS_TYPE_AUTHREQ);
450 Stream_Write_UINT16(s, RDSTLS_DATA_AUTORECONNECT_COOKIE);
451 Stream_Write_UINT32(s, settings->RedirectedSessionId);
453 return (rdstls_write_cookie(s, settings->ServerAutoReconnectCookie));
463static void rdstls_check_fedauth_vmid(rdpRdstls* rdstls,
const char* token,
const char* selectedVm)
465 WINPR_ASSERT(rdstls);
468 if (!selectedVm || !*selectedVm)
471 const char* vmidField = strstr(token,
"VMID=");
476 const size_t vmLen = strlen(selectedVm);
477 const BOOL matches = (_strnicmp(vmidField, selectedVm, vmLen) == 0) &&
478 (vmidField[vmLen] ==
'\0' || vmidField[vmLen] ==
'&');
481 WLog_Print(rdstls->log, WLOG_WARN,
482 "endpoint FedAuth token is issued for a different virtual machine "
483 "than the one selected for connection");
488static BOOL rdstls_write_authentication_request_with_fedauth_token(rdpRdstls* rdstls,
wStream* s)
490 WINPR_ASSERT(rdstls);
491 WINPR_ASSERT(rdstls->context);
493 WLog_Print(rdstls->log, WLOG_DEBUG,
"Writing RDSTLS FedAuth token authentication message");
495 if (!rdstls_required_role_is_server(rdstls, FALSE))
497 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_REQ))
500 const rdpSettings* settings = rdstls->context->settings;
501 WINPR_ASSERT(settings);
504 if (!token || !*token)
506 WLog_Print(rdstls->log, WLOG_ERROR,
"EndpointFedAuthToken not set");
510 rdstls_check_fedauth_vmid(rdstls, token,
513 const size_t utf8Length = strlen(token);
516 if (utf8Length >= UINT16_MAX /
sizeof(WCHAR))
518 WLog_Print(rdstls->log, WLOG_ERROR,
519 "EndpointFedAuthToken length %" PRIuz
" exceeds RDSTLS wire limit", utf8Length);
523 const size_t wideLength = utf8Length + 1;
524 const size_t wideBytes = wideLength *
sizeof(WCHAR);
526 if (!Stream_EnsureRemainingCapacity(s, 6 + wideBytes))
529 Stream_Write_UINT16(s, RDSTLS_TYPE_AUTHREQ);
530 Stream_Write_UINT16(s, RDSTLS_DATA_FEDAUTH_TOKEN);
531 Stream_Write_UINT16(s, (UINT16)wideBytes);
533 return Stream_Write_UTF16_String_From_UTF8(s, wideLength, token, utf8Length, TRUE) >= 0;
537static BOOL rdstls_write_authentication_response(rdpRdstls* rdstls,
wStream* s)
539 WINPR_ASSERT(rdstls);
541 if (!rdstls_required_role_is_server(rdstls, TRUE))
543 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_RSP))
545 if (!Stream_EnsureRemainingCapacity(s, 8))
548 Stream_Write_UINT16(s, RDSTLS_TYPE_AUTHRSP);
549 Stream_Write_UINT16(s, RDSTLS_DATA_RESULT_CODE);
550 Stream_Write_UINT32(s, rdstls->resultCode);
555#define rdstls_version_required(log, expected, actual) \
556 rdstls_version_required_((log), (expected), (actual), __FILE__, __func__, __LINE__)
558static BOOL rdstls_version_required_(wLog* log, uint16_t expected, uint16_t actual,
559 const char* file,
const char* fkt,
size_t line)
561 if (actual < expected)
563 const DWORD level = WLOG_ERROR;
564 if (WLog_IsLevelActive(log, level))
566 WLog_PrintTextMessage(log, WLOG_ERROR, line, file, fkt,
567 "version=0x%04" PRIx16
", expected at least 0x%04" PRIx16, actual,
575#define rdstls_are_some_versions_supported(log, version, mask) \
576 rdstls_are_some_versions_supported_((log), (version), (mask), __FILE__, __func__, __LINE__)
578static BOOL rdstls_are_some_versions_supported_(wLog* log, uint16_t version, BOOL isMask,
579 const char* file,
const char* fkt,
size_t line)
584 for (
size_t x = 0; x < 16; x++)
586 const unsigned val = 1 << x;
587 if ((version & val) != 0)
592 WLog_PrintTextMessage(log, WLOG_ERROR, line, file, fkt,
593 "received invalid version mask=0x%04" PRIx16
594 ", expected { 0x%04" PRIx32
", 0x%04" PRIx32
"}",
595 version, RDSTLS_VERSION_1, RDSTLS_VERSION_2);
600 if ((version & RDSTLS_VERSION_MASK) == 0)
602 const DWORD level = WLOG_ERROR;
603 if (WLog_IsLevelActive(log, level))
605 WLog_PrintTextMessage(log, WLOG_ERROR, line, file, fkt,
606 "received invalid version mask=0x%04" PRIx16
607 ", expected { 0x%04" PRIx32
", 0x%04" PRIx32
"}",
608 version, RDSTLS_VERSION_1, RDSTLS_VERSION_2);
615#define rdstls_is_version_supported(rdstls, versions) \
616 rdstls_is_version_supported_((rdstls), (version), __FILE__, __func__, __LINE__)
618static BOOL rdstls_is_version_supported_(rdpRdstls* rdstls, uint16_t version,
const char* file,
619 const char* fkt,
size_t line)
621 WINPR_ASSERT(rdstls);
623 if ((rdstls->supportedVersions & version) == 0)
625 const DWORD level = WLOG_ERROR;
626 if (WLog_IsLevelActive(rdstls->log, level))
628 WLog_PrintTextMessage(rdstls->log, WLOG_ERROR, line, file, fkt,
629 "received invalid version=0x%04" PRIx16
630 ", expected { 0x%04" PRIx32
", 0x%04" PRIx32
"}",
631 version, RDSTLS_VERSION_1, RDSTLS_VERSION_2);
639static BOOL rdstls_process_capabilities(rdpRdstls* rdstls,
wStream* s)
641 WINPR_ASSERT(rdstls);
642 if (!rdstls_required_role_is_server(rdstls, FALSE))
644 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_CAPABILITIES))
647 if (!Stream_CheckAndLogRequiredLengthWLog(rdstls->log, s, 4))
650 const UINT16 dataType = Stream_Get_UINT16(s);
651 if (dataType != RDSTLS_DATA_CAPABILITIES)
653 WLog_Print(rdstls->log, WLOG_ERROR,
654 "received invalid DataType=0x%04" PRIX16
", expected 0x%04" PRIX32, dataType,
655 WINPR_CXX_COMPAT_CAST(UINT32, RDSTLS_DATA_CAPABILITIES));
659 const UINT16 supportedVersions = Stream_Get_UINT16(s);
660 if (!rdstls_are_some_versions_supported(rdstls->log, supportedVersions, TRUE))
662 rdstls->supportedVersions = supportedVersions & RDSTLS_VERSION_MASK;
668static BOOL rdstls_read_unicode_string(WINPR_ATTR_UNUSED wLog* log,
wStream* s,
char** str)
672 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 2))
675 const UINT16 length = Stream_Get_UINT16(s);
677 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, length))
683 Stream_Seek(s, length);
687 *str = Stream_Read_UTF16_String_As_UTF8(s, length /
sizeof(WCHAR),
nullptr);
688 return (*str) !=
nullptr;
692static BOOL rdstls_read_data(WINPR_ATTR_UNUSED wLog* log,
wStream* s, UINT16* pLength,
695 WINPR_ASSERT(pLength);
700 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 2))
703 const UINT16 length = Stream_Get_UINT16(s);
705 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, length))
710 Stream_Seek(s, length);
714 *pData = Stream_ConstPointer(s);
716 Stream_Seek(s, length);
721static BOOL rdstls_cmp_data(wLog* log,
const char* field,
const BYTE* serverData,
722 const UINT32 serverDataLength,
const BYTE* clientData,
723 const UINT16 clientDataLength)
725 if (serverDataLength > 0)
727 if (clientDataLength == 0)
729 WLog_Print(log, WLOG_ERROR,
"expected %s", field);
733 if (serverDataLength > UINT16_MAX || serverDataLength != clientDataLength ||
734 memcmp(serverData, clientData, serverDataLength) != 0)
736 WLog_Print(log, WLOG_ERROR,
"%s verification failed", field);
745static BOOL rdstls_cmp_str(wLog* log,
const char* field,
const char* serverStr,
746 const char* clientStr)
748 if (!utils_str_is_empty(serverStr))
750 if (utils_str_is_empty(clientStr))
752 WLog_Print(log, WLOG_ERROR,
"expected %s", field);
756 WINPR_ASSERT(serverStr);
757 WINPR_ASSERT(clientStr);
758 if (strcmp(serverStr, clientStr) != 0)
760 WLog_Print(log, WLOG_ERROR,
"%s verification failed", field);
769static BOOL rdstls_process_authentication_request_with_password(rdpRdstls* rdstls,
wStream* s,
772 WINPR_ASSERT(rdstls);
773 WINPR_ASSERT(rdstls->context);
775 if (!rdstls_version_required(rdstls->log, RDSTLS_VERSION_1, version))
777 if (!rdstls_required_role_is_server(rdstls, TRUE))
779 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_REQ))
784 const BYTE* clientRedirectionGuid =
nullptr;
785 UINT16 clientRedirectionGuidLength = 0;
786 char* clientPassword =
nullptr;
787 char* clientUsername =
nullptr;
788 char* clientDomain =
nullptr;
790 const rdpSettings* settings = rdstls->context->settings;
791 WINPR_ASSERT(settings);
793 if (!rdstls_read_data(rdstls->log, s, &clientRedirectionGuidLength, &clientRedirectionGuid))
796 if (!rdstls_read_unicode_string(rdstls->log, s, &clientUsername))
799 if (!rdstls_read_unicode_string(rdstls->log, s, &clientDomain))
802 if (!rdstls_read_unicode_string(rdstls->log, s, &clientPassword))
806 const BYTE* serverRedirectionGuid =
808 const UINT32 serverRedirectionGuidLength =
814 if (!rdstls_cmp_data(rdstls->log,
"RedirectionGuid", serverRedirectionGuid,
815 serverRedirectionGuidLength, clientRedirectionGuid,
816 clientRedirectionGuidLength))
817 rdstls->resultCode = RDSTLS_RESULT_ACCESS_DENIED;
818 else if (!rdstls_cmp_str(rdstls->log,
"UserName", serverUsername, clientUsername))
819 rdstls->resultCode = RDSTLS_RESULT_LOGON_FAILURE;
820 else if (!rdstls_cmp_str(rdstls->log,
"Domain", serverDomain, clientDomain))
821 rdstls->resultCode = RDSTLS_RESULT_LOGON_FAILURE;
822 else if (!rdstls_cmp_str(rdstls->log,
"Password", serverPassword, clientPassword))
823 rdstls->resultCode = RDSTLS_RESULT_LOGON_FAILURE;
825 rdstls->resultCode = RDSTLS_RESULT_SUCCESS;
833static BOOL rdstls_process_authentication_request_with_cookie(rdpRdstls* rdstls,
wStream* s,
836 if (!rdstls_version_required(rdstls->log, RDSTLS_VERSION_1, version))
839 if (!rdstls_required_role_is_server(rdstls, TRUE))
841 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_REQ))
844 if (!Stream_CheckAndLogRequiredLengthWLog(rdstls->log, s, 2))
847 const rdpSettings* settings = rdstls->context->settings;
848 WINPR_ASSERT(settings);
850 const uint32_t
id = Stream_Get_UINT32(s);
854 WLog_Print(rdstls->log, WLOG_ERROR,
855 "RDSTLS Cookie SessionId does not match RedirectedSessionId. Deny access.");
860 if (!rdstls_read_cookie(rdstls->log, s, &cookie))
867 WLog_Print(rdstls->log, WLOG_ERROR,
"No RDSTLS Cookie provided by server. Deny access.");
873 WLog_Print(rdstls->log, WLOG_ERROR,
"RDSTLS Cookie does not match. Deny access.");
877 WLog_Print(rdstls->log, WLOG_DEBUG,
"RDSTLS Cookie matches. Grant access.");
882static BOOL rdstls_process_authentication_request_with_fedauth_token(rdpRdstls* rdstls,
wStream* s,
885 WINPR_ASSERT(rdstls);
887 if (!rdstls_version_required(rdstls->log, RDSTLS_VERSION_2, version))
889 if (!rdstls_required_role_is_server(rdstls, TRUE))
891 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_REQ))
893 if ((rdstls->supportedVersions & RDSTLS_VERSION_2) == 0)
895 WLog_Print(rdstls->log, WLOG_ERROR,
"FedAuth token only supported with RDSTLS_VERSION_2");
899 if (!Stream_CheckAndLogRequiredLengthWLog(rdstls->log, s, 2))
901 const uint16_t wbytes = Stream_Get_UINT16(s);
904 WLog_Print(rdstls->log, WLOG_ERROR,
"Empty FedAuth token given by client. Deny access");
907 if ((wbytes %
sizeof(WCHAR)) != 0)
909 WLog_Print(rdstls->log, WLOG_ERROR,
910 "Invalid FedAuth token length %" PRIu16
"given by client. Must be even", wbytes);
913 const size_t wcharlen = wbytes /
sizeof(WCHAR);
914 if (!Stream_CheckAndLogRequiredLengthWLog(rdstls->log, s, wbytes))
917 const rdpSettings* settings = rdstls->context->settings;
918 WINPR_ASSERT(settings);
923 if (!token || (len == 0))
926 WLog_Print(rdstls->log, WLOG_ERROR,
927 "No FedAuth token provided by server to compare. Deny access");
933 WLog_Print(rdstls->log, WLOG_ERROR,
"FedAuth token length does not match. Deny access");
938 const int rc = memcmp(token, Stream_Pointer(s), len *
sizeof(WCHAR));
942 WLog_Print(rdstls->log, WLOG_ERROR,
"FedAuth token does not match. Deny access");
946 WLog_Print(rdstls->log, WLOG_INFO,
"FedAuth token does match. Grant access");
951static BOOL rdstls_process_authentication_request(rdpRdstls* rdstls,
wStream* s, uint16_t version)
953 if (!rdstls_required_role_is_server(rdstls, TRUE))
956 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_REQ))
959 if (!Stream_CheckAndLogRequiredLengthWLog(rdstls->log, s, 2))
962 const UINT16 dataType = Stream_Get_UINT16(s);
965 case RDSTLS_DATA_PASSWORD_CREDS:
966 if (!rdstls_process_authentication_request_with_password(rdstls, s, version))
969 case RDSTLS_DATA_AUTORECONNECT_COOKIE:
970 if (!rdstls_process_authentication_request_with_cookie(rdstls, s, version))
973 case RDSTLS_DATA_FEDAUTH_TOKEN:
974 if (!rdstls_process_authentication_request_with_fedauth_token(rdstls, s, version))
978 WLog_Print(rdstls->log, WLOG_ERROR,
979 "received invalid DataType=0x%04" PRIX16
", expected 0x%04" PRIX32
981 dataType, WINPR_CXX_COMPAT_CAST(UINT32, RDSTLS_DATA_PASSWORD_CREDS),
982 WINPR_CXX_COMPAT_CAST(UINT32, RDSTLS_DATA_AUTORECONNECT_COOKIE));
990static BOOL rdstls_process_authentication_response(rdpRdstls* rdstls,
wStream* s)
992 if (!rdstls_required_role_is_server(rdstls, FALSE))
994 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_RSP))
997 if (!Stream_CheckAndLogRequiredLengthWLog(rdstls->log, s, 6))
1000 const UINT16 dataType = Stream_Get_UINT16(s);
1001 if (dataType != RDSTLS_DATA_RESULT_CODE)
1003 WLog_Print(rdstls->log, WLOG_ERROR,
1004 "received invalid DataType=0x%04" PRIX16
", expected 0x%04" PRIX32, dataType,
1005 WINPR_CXX_COMPAT_CAST(UINT32, RDSTLS_DATA_RESULT_CODE));
1009 const UINT32 resultCode = Stream_Get_UINT32(s);
1010 if (resultCode != RDSTLS_RESULT_SUCCESS)
1012 WLog_Print(rdstls->log, WLOG_ERROR,
"resultCode: %s [0x%08" PRIX32
"]",
1013 rdstls_result_code_str(resultCode), resultCode);
1015 UINT32 error = FREERDP_ERROR_CONNECT_UNDEFINED;
1018 case RDSTLS_RESULT_ACCESS_DENIED:
1019 error = FREERDP_ERROR_CONNECT_ACCESS_DENIED;
1021 case RDSTLS_RESULT_ACCOUNT_DISABLED:
1022 error = FREERDP_ERROR_CONNECT_ACCOUNT_DISABLED;
1024 case RDSTLS_RESULT_ACCOUNT_LOCKED_OUT:
1025 error = FREERDP_ERROR_CONNECT_ACCOUNT_LOCKED_OUT;
1027 case RDSTLS_RESULT_LOGON_FAILURE:
1028 error = FREERDP_ERROR_CONNECT_LOGON_FAILURE;
1030 case RDSTLS_RESULT_INVALID_LOGON_HOURS:
1031 error = FREERDP_ERROR_CONNECT_ACCOUNT_RESTRICTION;
1033 case RDSTLS_RESULT_PASSWORD_EXPIRED:
1034 error = FREERDP_ERROR_CONNECT_PASSWORD_EXPIRED;
1036 case RDSTLS_RESULT_PASSWORD_MUST_CHANGE:
1037 error = FREERDP_ERROR_CONNECT_PASSWORD_MUST_CHANGE;
1040 WLog_Print(rdstls->log, WLOG_ERROR,
1041 "Unexpected resultCode: [0x%08" PRIX32
"], NTSTATUS=%s, Win32Error=%s",
1042 resultCode, GetSecurityStatusString((SECURITY_STATUS)resultCode),
1043 Win32ErrorCode2Tag(resultCode & 0xFFFF));
1044 error = FREERDP_ERROR_CONNECT_UNDEFINED;
1048 freerdp_set_last_error_if_not(rdstls->context, error);
1056static BOOL rdstls_send_capabilities(rdpRdstls* rdstls)
1060 if (!rdstls_required_role_is_server(rdstls, TRUE))
1063 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_CAPABILITIES))
1066 wStream* s = Stream_New(
nullptr, 512);
1070 if (!rdstls_write_capabilities(rdstls, s))
1072 if (transport_write(rdstls->transport, s) < 0)
1075 rc = rdstls_set_state(rdstls, RDSTLS_STATE_AUTH_REQ);
1077 Stream_Free(s, TRUE);
1082static BOOL rdstls_recv_authentication_request(rdpRdstls* rdstls, uint16_t* pVersion)
1085 WINPR_ASSERT(pVersion);
1087 if (!rdstls_required_role_is_server(rdstls, TRUE))
1089 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_REQ))
1092 wStream* s = Stream_New(
nullptr, 4096);
1096 WINPR_ASSERT(rdstls);
1099 const int res = transport_read_pdu(rdstls->transport, s);
1104 if (!Stream_CheckAndLogRequiredLengthWLog(rdstls->log, s, 4))
1107 const UINT16 version = Stream_Get_UINT16(s);
1108 if (!rdstls_is_version_supported(rdstls, version))
1110 *pVersion = version;
1112 const UINT16 pduType = Stream_Get_UINT16(s);
1115 case RDSTLS_TYPE_AUTHREQ:
1116 if (!rdstls_process_authentication_request(rdstls, s, version))
1120 WLog_Print(rdstls->log, WLOG_ERROR,
1121 "Invalid RDSTLS PDU type [0x%04" PRIx16
"] while reading AUTHREQ", pduType);
1125 rc = rdstls_set_state(rdstls, RDSTLS_STATE_AUTH_RSP);
1127 Stream_Free(s, TRUE);
1132static BOOL rdstls_send_authentication_response(rdpRdstls* rdstls, uint16_t version)
1136 if (!rdstls_required_role_is_server(rdstls, TRUE))
1139 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_RSP))
1142 wStream* s = Stream_New(
nullptr, 512);
1146 if (!Stream_EnsureRemainingCapacity(s, 2))
1149 Stream_Write_UINT16(s, version);
1151 if (!rdstls_write_authentication_response(rdstls, s))
1154 if (transport_write(rdstls->transport, s) < 0)
1157 rc = rdstls_set_state(rdstls, RDSTLS_STATE_FINAL);
1159 Stream_Free(s, TRUE);
1164static BOOL rdstls_recv_capabilities(rdpRdstls* rdstls)
1168 if (!rdstls_required_role_is_server(rdstls, FALSE))
1171 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_CAPABILITIES))
1174 wStream* s = Stream_New(
nullptr, 512);
1178 WINPR_ASSERT(rdstls);
1181 const int res = transport_read_pdu(rdstls->transport, s);
1186 if (!Stream_CheckAndLogRequiredLengthWLog(rdstls->log, s, 4))
1189 const UINT16 version = Stream_Get_UINT16(s);
1190 if (!rdstls_is_version_supported(rdstls, version))
1193 const UINT16 pduType = Stream_Get_UINT16(s);
1196 case RDSTLS_TYPE_CAPABILITIES:
1197 if (!rdstls_process_capabilities(rdstls, s))
1201 WLog_Print(rdstls->log, WLOG_ERROR,
1202 "Invalid pduType 0x%04" PRIx16
" while reading capability", pduType);
1206 rc = rdstls_set_state(rdstls, RDSTLS_STATE_AUTH_REQ);
1208 Stream_Free(s, TRUE);
1213static BOOL rdstls_send_authentication_request(rdpRdstls* rdstls, uint16_t* pVersion)
1215 WINPR_ASSERT(pVersion);
1219 if (!rdstls_required_role_is_server(rdstls, FALSE))
1222 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_REQ))
1225 wStream* s = Stream_New(
nullptr, 4096);
1229 WINPR_ASSERT(rdstls->context);
1231 const rdpSettings* settings = rdstls->context->settings;
1232 WINPR_ASSERT(settings);
1234 if (!Stream_EnsureRemainingCapacity(s, 2))
1237 const RDSTLS_STATE state = rdstls_get_state(rdstls);
1239 BOOL useFedAuth = (state == RDSTLS_STATE_AUTH_REQ) && !utils_str_is_empty(fedAuthToken);
1240 if ((rdstls->supportedVersions & RDSTLS_VERSION_2) == 0)
1243 WLog_Print(rdstls->log, WLOG_WARN,
1244 "Client has FedAuthToken ready, but server did not announce RDSTLS_VERSION_2.");
1247 *pVersion = useFedAuth ? RDSTLS_VERSION_2 : RDSTLS_VERSION_1;
1248 Stream_Write_UINT16(s, *pVersion);
1252 if (!rdstls_write_authentication_request_with_fedauth_token(rdstls, s))
1255 else if (settings->RedirectionFlags & LB_PASSWORD_IS_PK_ENCRYPTED)
1257 if (!rdstls_write_authentication_request_with_password(rdstls, s))
1260 else if (settings->ServerAutoReconnectCookie !=
nullptr)
1262 if (!rdstls_write_authentication_request_with_cookie(rdstls, s))
1267 WLog_Print(rdstls->log, WLOG_ERROR,
1268 "cannot authenticate with FedAuth token, password or "
1269 "auto-reconnect cookie");
1273 WINPR_ASSERT(rdstls);
1274 if (transport_write(rdstls->transport, s) < 0)
1277 rc = rdstls_set_state(rdstls, RDSTLS_STATE_AUTH_RSP);
1279 Stream_Free(s, TRUE);
1284static BOOL rdstls_recv_authentication_response(rdpRdstls* rdstls, uint16_t expected)
1288 WINPR_ASSERT(rdstls);
1290 if (!rdstls_required_role_is_server(rdstls, FALSE))
1293 if (!rdstls_check_state_requirements(rdstls, RDSTLS_STATE_AUTH_RSP))
1296 wStream* s = Stream_New(
nullptr, 512);
1301 const int res = transport_read_pdu(rdstls->transport, s);
1306 if (!Stream_CheckAndLogRequiredLengthWLog(rdstls->log, s, 4))
1309 const UINT16 version = Stream_Get_UINT16(s);
1310 if (!rdstls_is_version_supported(rdstls, version))
1312 if (version != expected)
1315 const UINT16 pduType = Stream_Get_UINT16(s);
1318 case RDSTLS_TYPE_AUTHRSP:
1319 if (!rdstls_process_authentication_response(rdstls, s))
1323 WLog_Print(rdstls->log, WLOG_ERROR,
1324 "Invalid RDSTLS PDU type [0x%04" PRIx16
"] while reading AUTHRSP", pduType);
1328 rc = rdstls_set_state(rdstls, RDSTLS_STATE_FINAL);
1330 Stream_Free(s, TRUE);
1335static int rdstls_server_authenticate(rdpRdstls* rdstls)
1337 WINPR_ASSERT(rdstls);
1338 uint16_t version = 0;
1340 if (!rdstls_set_state(rdstls, RDSTLS_STATE_CAPABILITIES))
1343 if (!rdstls_send_capabilities(rdstls))
1346 if (!rdstls_recv_authentication_request(rdstls, &version))
1349 if (!rdstls_send_authentication_response(rdstls, version))
1352 if (rdstls->resultCode != RDSTLS_RESULT_SUCCESS)
1359static int rdstls_client_authenticate(rdpRdstls* rdstls)
1361 if (!rdstls_set_state(rdstls, RDSTLS_STATE_CAPABILITIES))
1364 if (!rdstls_recv_capabilities(rdstls))
1367 uint16_t version = 0;
1368 if (!rdstls_send_authentication_request(rdstls, &version))
1371 if (!rdstls_recv_authentication_response(rdstls, version))
1384int rdstls_authenticate(rdpRdstls* rdstls)
1386 WINPR_ASSERT(rdstls);
1389 return rdstls_server_authenticate(rdstls);
1391 return rdstls_client_authenticate(rdstls);
1395static SSIZE_T rdstls_parse_pdu_data_type(wLog* log, UINT16 dataType,
wStream* s)
1397 size_t pduLength = 0;
1401 case RDSTLS_DATA_PASSWORD_CREDS:
1403 if (Stream_GetRemainingLength(s) < 2)
1406 const UINT16 redirGuidLength = Stream_Get_UINT16(s);
1408 if (Stream_GetRemainingLength(s) < redirGuidLength)
1410 Stream_Seek(s, redirGuidLength);
1412 if (Stream_GetRemainingLength(s) < 2)
1415 const UINT16 usernameLength = Stream_Get_UINT16(s);
1417 if (Stream_GetRemainingLength(s) < usernameLength)
1419 Stream_Seek(s, usernameLength);
1421 if (Stream_GetRemainingLength(s) < 2)
1423 const UINT16 domainLength = Stream_Get_UINT16(s);
1425 if (Stream_GetRemainingLength(s) < domainLength)
1427 Stream_Seek(s, domainLength);
1429 if (Stream_GetRemainingLength(s) < 2)
1431 const UINT16 passwordLength = Stream_Get_UINT16(s);
1433 if (passwordLength == 0)
1435 WLog_Print(log, WLOG_ERROR,
"invalid RDSLTS PASSWORD_CREDS: empty password");
1438 else if ((redirGuidLength == 0) && (usernameLength == 0) && (domainLength == 0) &&
1439 (passwordLength == 0))
1441 WLog_Print(log, WLOG_ERROR,
"invalid RDSLTS PASSWORD_CREDS: lengths 0");
1444 pduLength = Stream_GetPosition(s) + passwordLength;
1447 case RDSTLS_DATA_AUTORECONNECT_COOKIE:
1449 if (Stream_GetRemainingLength(s) < 6)
1452 const UINT16 cookieLength = Stream_Get_UINT16(s);
1453 if (cookieLength == 0)
1455 WLog_Print(log, WLOG_ERROR,
"invalid RDSLTS COOKIE::length");
1458 pduLength = Stream_GetPosition(s) + cookieLength;
1461 case RDSTLS_DATA_FEDAUTH_TOKEN:
1463 if (Stream_GetRemainingLength(s) < 6)
1466 const UINT16 tokenLength = Stream_Get_UINT16(s);
1467 if (tokenLength == 0)
1469 WLog_Print(log, WLOG_ERROR,
"invalid RDSLTS FEDAUTH_TOKEN::length");
1472 pduLength = Stream_GetPosition(s) + tokenLength;
1476 WLog_Print(log, WLOG_ERROR,
"invalid RDSLTS dataType");
1480 if (pduLength > SSIZE_MAX)
1482 return (SSIZE_T)pduLength;
1485SSIZE_T rdstls_parse_pdu(wLog* log,
wStream* stream)
1487 SSIZE_T pduLength = -1;
1488 wStream sbuffer = WINPR_C_ARRAY_INIT;
1489 wStream* s = Stream_StaticConstInit(&sbuffer, Stream_Buffer(stream), Stream_Length(stream));
1491 if (Stream_GetRemainingLength(s) < 2)
1494 const UINT16 version = Stream_Get_UINT16(s);
1495 if (!rdstls_are_some_versions_supported(log, version, FALSE))
1498 if (Stream_GetRemainingLength(s) < 2)
1501 const UINT16 pduType = Stream_Get_UINT16(s);
1504 case RDSTLS_TYPE_CAPABILITIES:
1507 case RDSTLS_TYPE_AUTHREQ:
1509 if (Stream_GetRemainingLength(s) < 2)
1512 const UINT16 dataType = Stream_Get_UINT16(s);
1513 pduLength = rdstls_parse_pdu_data_type(log, dataType, s);
1516 case RDSTLS_TYPE_AUTHRSP:
1520 WLog_Print(log, WLOG_ERROR,
"invalid RDSTLS PDU type");
WINPR_ATTR_NODISCARD FREERDP_API const void * freerdp_settings_get_pointer(const rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id)
Returns a immutable pointer settings value.
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
FREERDP_API WCHAR * freerdp_settings_get_string_as_utf16(const rdpSettings *settings, FreeRDP_Settings_Keys_String id, size_t *pCharLen)
Return an allocated UTF16 string.