22#include <freerdp/config.h>
24#include "../settings.h"
26#include <winpr/assert.h>
27#include <winpr/cast.h>
30#include <winpr/synch.h>
31#include <winpr/print.h>
32#include <winpr/stream.h>
33#include <winpr/winsock.h>
34#include <winpr/cred.h>
36#include <freerdp/log.h>
37#include <freerdp/error.h>
38#include <freerdp/utils/ringbuffer.h>
39#include <freerdp/utils/smartcardlogon.h>
43#include "../credssp_auth.h"
46#include "../../crypto/opensslcompat.h"
50#define TAG FREERDP_TAG("core.gateway.rdg")
52#define AUTH_PKG NEGO_SSP_NAME
55#define HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID 0x1
56#define HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE 0x2
57#define HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT 0x4
60#define HTTP_EXTENDED_AUTH_NONE 0x0
61#define HTTP_EXTENDED_AUTH_SC 0x1
62#define HTTP_EXTENDED_AUTH_PAA 0x02
63#define HTTP_EXTENDED_AUTH_SSPI_NTLM 0x04
64#define HTTP_EXTENDED_AUTH_BEARER 0x08
69 PKT_TYPE_HANDSHAKE_REQUEST = 0x1,
70 PKT_TYPE_HANDSHAKE_RESPONSE = 0x2,
71 PKT_TYPE_EXTENDED_AUTH_MSG = 0x3,
72 PKT_TYPE_TUNNEL_CREATE = 0x4,
73 PKT_TYPE_TUNNEL_RESPONSE = 0x5,
74 PKT_TYPE_TUNNEL_AUTH = 0x6,
75 PKT_TYPE_TUNNEL_AUTH_RESPONSE = 0x7,
76 PKT_TYPE_CHANNEL_CREATE = 0x8,
77 PKT_TYPE_CHANNEL_RESPONSE = 0x9,
79 PKT_TYPE_SERVICE_MESSAGE = 0xB,
80 PKT_TYPE_REAUTH_MESSAGE = 0xC,
81 PKT_TYPE_KEEPALIVE = 0xD,
82 PKT_TYPE_CLOSE_CHANNEL = 0x10,
83 PKT_TYPE_CLOSE_CHANNEL_RESPONSE = 0x11
90#define HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS 0x1
91#define HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT 0x2
92#define HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE 0x4
95#define HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE 0x1
99#define HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID 0x1
100#define HTTP_TUNNEL_RESPONSE_FIELD_CAPS 0x2
101#define HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ 0x4
102#define HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG 0x10
105#define HTTP_CAPABILITY_TYPE_QUAR_SOH 0x1
106#define HTTP_CAPABILITY_IDLE_TIMEOUT 0x2
107#define HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN 0x4
108#define HTTP_CAPABILITY_MESSAGING_SERVICE_MSG 0x8
109#define HTTP_CAPABILITY_REAUTH 0x10
110#define HTTP_CAPABILITY_UDP_TRANSPORT 0x20
114 TRANSFER_ENCODING httpTransferEncoding;
115 BOOL isWebsocketTransport;
119 websocket_context* websocket;
121} rdg_http_encoding_context;
130 rdpCredsspAuth* auth;
135 UINT16 packetRemainingCount;
140 rdg_http_encoding_context transferEncoding;
148 RDG_CLIENT_STATE_INITIAL,
149 RDG_CLIENT_STATE_HANDSHAKE,
150 RDG_CLIENT_STATE_TUNNEL_CREATE,
151 RDG_CLIENT_STATE_TUNNEL_AUTHORIZE,
152 RDG_CLIENT_STATE_CHANNEL_CREATE,
153 RDG_CLIENT_STATE_OPENED,
158typedef struct rdg_packet_header
173static const t_flag_mapping tunnel_response_fields_present[] = {
174 { HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID,
"HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID" },
175 { HTTP_TUNNEL_RESPONSE_FIELD_CAPS,
"HTTP_TUNNEL_RESPONSE_FIELD_CAPS" },
176 { HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ,
"HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ" },
177 { HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG,
"HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG" }
180static const t_flag_mapping channel_response_fields_present[] = {
181 { HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID,
"HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID" },
182 { HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE,
"HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE" },
183 { HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT,
"HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT" }
186static const t_flag_mapping tunnel_authorization_response_fields_present[] = {
187 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS,
"HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS" },
188 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT,
189 "HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT" },
190 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE,
191 "HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE" }
194static const t_flag_mapping extended_auth[] = {
195 { HTTP_EXTENDED_AUTH_NONE,
"HTTP_EXTENDED_AUTH_NONE" },
196 { HTTP_EXTENDED_AUTH_SC,
"HTTP_EXTENDED_AUTH_SC" },
197 { HTTP_EXTENDED_AUTH_PAA,
"HTTP_EXTENDED_AUTH_PAA" },
198 { HTTP_EXTENDED_AUTH_SSPI_NTLM,
"HTTP_EXTENDED_AUTH_SSPI_NTLM" }
201static const t_flag_mapping capabilities_enum[] = {
202 { HTTP_CAPABILITY_TYPE_QUAR_SOH,
"HTTP_CAPABILITY_TYPE_QUAR_SOH" },
203 { HTTP_CAPABILITY_IDLE_TIMEOUT,
"HTTP_CAPABILITY_IDLE_TIMEOUT" },
204 { HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN,
"HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN" },
205 { HTTP_CAPABILITY_MESSAGING_SERVICE_MSG,
"HTTP_CAPABILITY_MESSAGING_SERVICE_MSG" },
206 { HTTP_CAPABILITY_REAUTH,
"HTTP_CAPABILITY_REAUTH" },
207 { HTTP_CAPABILITY_UDP_TRANSPORT,
"HTTP_CAPABILITY_UDP_TRANSPORT" }
211static const char* rdg_pkt_type_to_string(
int type)
219 ENTRY(PKT_TYPE_HANDSHAKE_REQUEST);
220 ENTRY(PKT_TYPE_HANDSHAKE_RESPONSE);
221 ENTRY(PKT_TYPE_EXTENDED_AUTH_MSG);
222 ENTRY(PKT_TYPE_TUNNEL_CREATE);
223 ENTRY(PKT_TYPE_TUNNEL_RESPONSE);
224 ENTRY(PKT_TYPE_TUNNEL_AUTH);
225 ENTRY(PKT_TYPE_TUNNEL_AUTH_RESPONSE);
226 ENTRY(PKT_TYPE_CHANNEL_CREATE);
227 ENTRY(PKT_TYPE_CHANNEL_RESPONSE);
228 ENTRY(PKT_TYPE_DATA);
229 ENTRY(PKT_TYPE_SERVICE_MESSAGE);
230 ENTRY(PKT_TYPE_REAUTH_MESSAGE);
231 ENTRY(PKT_TYPE_KEEPALIVE);
232 ENTRY(PKT_TYPE_CLOSE_CHANNEL);
233 ENTRY(PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
235 return "PKT_TYPE_UNKNOWN";
241static const char* flags_to_string(UINT32 flags,
const t_flag_mapping* map,
size_t elements)
243 static char buffer[1024] = WINPR_C_ARRAY_INIT;
244 char fields[12] = WINPR_C_ARRAY_INIT;
246 for (
size_t x = 0; x < elements; x++)
248 const t_flag_mapping* cur = &map[x];
250 if ((cur->code & flags) != 0)
251 winpr_str_append(cur->name, buffer,
sizeof(buffer),
"|");
254 (void)sprintf_s(fields, ARRAYSIZE(fields),
" [%04" PRIx32
"]", flags);
255 winpr_str_append(fields, buffer,
sizeof(buffer),
nullptr);
260static const char* channel_response_fields_present_to_string(UINT16 fieldsPresent)
262 return flags_to_string(fieldsPresent, channel_response_fields_present,
263 ARRAYSIZE(channel_response_fields_present));
267static const char* tunnel_response_fields_present_to_string(UINT16 fieldsPresent)
269 return flags_to_string(fieldsPresent, tunnel_response_fields_present,
270 ARRAYSIZE(tunnel_response_fields_present));
274static const char* tunnel_authorization_response_fields_present_to_string(UINT16 fieldsPresent)
276 return flags_to_string(fieldsPresent, tunnel_authorization_response_fields_present,
277 ARRAYSIZE(tunnel_authorization_response_fields_present));
281static const char* extended_auth_to_string(UINT16 auth)
283 if (auth == HTTP_EXTENDED_AUTH_NONE)
284 return "HTTP_EXTENDED_AUTH_NONE [0x0000]";
286 return flags_to_string(auth, extended_auth, ARRAYSIZE(extended_auth));
290static const char* capabilities_enum_to_string(UINT32 capabilities)
292 return flags_to_string(capabilities, capabilities_enum, ARRAYSIZE(capabilities_enum));
296static BOOL rdg_read_http_unicode_string(wLog* log,
wStream* s,
const WCHAR**
string,
297 UINT16* lengthInBytes)
299 UINT16 strLenBytes = 0;
300 size_t rem = Stream_GetRemainingLength(s);
303 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 4))
305 WLog_Print(log, WLOG_ERROR,
"Could not read stream length, only have %" PRIuz
" bytes",
309 Stream_Read_UINT16(s, strLenBytes);
312 const WCHAR* str = Stream_ConstPointer(s);
315 if (!Stream_SafeSeek(s, strLenBytes))
317 WLog_Print(log, WLOG_ERROR,
318 "Could not read stream data, only have %" PRIuz
" bytes, expected %" PRIu16,
319 rem - 4, strLenBytes);
327 *lengthInBytes = strLenBytes;
333static BOOL rdg_write_chunked(BIO* bio,
wStream* sPacket)
339 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIXz
"\r\n", Stream_Length(sPacket));
341 Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + Stream_Length(sPacket) + 2);
346 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
347 Stream_Write(sChunk, Stream_Buffer(sPacket), Stream_Length(sPacket));
348 Stream_Write(sChunk,
"\r\n", 2);
349 Stream_SealLength(sChunk);
350 len = Stream_Length(sChunk);
354 Stream_Free(sChunk, TRUE);
359 status = BIO_write(bio, Stream_Buffer(sChunk), (
int)len);
360 Stream_Free(sChunk, TRUE);
362 return (status == (SSIZE_T)len);
366static BOOL rdg_write_packet(rdpRdg* rdg,
wStream* sPacket)
368 if (rdg->transferEncoding.isWebsocketTransport)
369 return websocket_context_write_wstream(rdg->transferEncoding.context.websocket,
370 rdg->tlsOut->bio, sPacket, WebsocketBinaryOpcode);
372 return rdg_write_chunked(rdg->tlsIn->bio, sPacket);
376static int rdg_socket_read(BIO* bio, rdpContext* context, BYTE* pBuffer,
size_t size,
377 rdg_http_encoding_context* encodingContext)
379 WINPR_ASSERT(encodingContext !=
nullptr);
380 if (size > INT32_MAX)
383 if (encodingContext->isWebsocketTransport)
384 return websocket_context_read(encodingContext->context.websocket, bio, pBuffer, size);
386 switch (encodingContext->httpTransferEncoding)
388 case TransferEncodingIdentity:
390 return BIO_read(bio, pBuffer, (
int)size);
391 case TransferEncodingChunked:
392 return http_chuncked_read(bio, context, pBuffer, size,
393 &encodingContext->context.chunked);
400static BOOL rdg_shall_abort(rdpRdg* rdg)
403 return freerdp_shall_disconnect_context(rdg->context);
407static BOOL rdg_read_all(rdpContext* context, rdpTls* tls,
wStream* s,
size_t size,
408 rdg_http_encoding_context* transferEncoding)
410 size_t readCount = 0;
412 if (!Stream_EnsureRemainingCapacity(s, size))
415 BYTE* pBuffer = Stream_Pointer(s);
416 while (readCount < size)
418 if (freerdp_shall_disconnect_context(context))
422 rdg_socket_read(tls->bio, tls->context, pBuffer, size - readCount, transferEncoding);
425 if (!BIO_should_retry(tls->bio))
432 readCount += WINPR_ASSERTING_INT_CAST(uint32_t, status);
433 pBuffer += WINPR_ASSERTING_INT_CAST(uint32_t, status);
439WINPR_ATTR_MALLOC(Stream_Free, 1)
440static
wStream* rdg_receive_packet(rdpRdg* rdg)
442 const size_t header =
sizeof(RdgPacketHeader);
443 size_t packetLength = 0;
444 wStream* s = Stream_New(
nullptr, 1024);
449 if (!rdg_read_all(rdg->context, rdg->tlsOut, s, header, &rdg->transferEncoding))
453 Stream_Read_UINT32(s, packetLength);
455 if ((packetLength > INT_MAX) || (packetLength < header))
458 const size_t requestBlockSize = 4096;
459 for (
size_t offset = header; offset < packetLength; offset += requestBlockSize)
461 size_t block = requestBlockSize;
462 if (offset + block > packetLength)
463 block = packetLength - offset;
465 if (!rdg_read_all(rdg->context, rdg->tlsOut, s, block, &rdg->transferEncoding))
468 if (!Stream_SafeSeek(s, block))
472 if (!Stream_SetLength(s, packetLength))
477 Stream_Free(s, TRUE);
482static BOOL rdg_send_handshake(rdpRdg* rdg)
485 wStream* s = Stream_New(
nullptr, 14);
490 Stream_Write_UINT16(s, PKT_TYPE_HANDSHAKE_REQUEST);
491 Stream_Write_UINT16(s, 0);
492 Stream_Write_UINT32(s, 14);
493 Stream_Write_UINT8(s, 1);
494 Stream_Write_UINT8(s, 0);
495 Stream_Write_UINT16(s, 0);
496 Stream_Write_UINT16(s, rdg->extAuth);
497 Stream_SealLength(s);
498 status = rdg_write_packet(rdg, s);
499 Stream_Free(s, TRUE);
503 rdg->state = RDG_CLIENT_STATE_HANDSHAKE;
510static BOOL rdg_send_extauth_sspi(rdpRdg* rdg)
514 UINT32 packetSize = 8 + 4 + 2;
518 const SecBuffer* authToken = credssp_auth_get_output_buffer(rdg->auth);
521 packetSize += authToken->cbBuffer;
523 s = Stream_New(
nullptr, packetSize);
528 Stream_Write_UINT16(s, PKT_TYPE_EXTENDED_AUTH_MSG);
529 Stream_Write_UINT16(s, 0);
530 Stream_Write_UINT32(s, packetSize);
531 Stream_Write_UINT32(s, ERROR_SUCCESS);
532 Stream_Write_UINT16(s, (UINT16)authToken->cbBuffer);
533 Stream_Write(s, authToken->pvBuffer, authToken->cbBuffer);
535 Stream_SealLength(s);
536 status = rdg_write_packet(rdg, s);
537 Stream_Free(s, TRUE);
543static BOOL rdg_send_tunnel_request(rdpRdg* rdg)
547 UINT32 packetSize = 16;
548 UINT16 fieldsPresent = 0;
549 WCHAR* PAACookie =
nullptr;
550 size_t PAACookieLen = 0;
551 const UINT32 capabilities = HTTP_CAPABILITY_TYPE_QUAR_SOH |
552 HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN |
553 HTTP_CAPABILITY_MESSAGING_SERVICE_MSG;
555 if (rdg->extAuth == HTTP_EXTENDED_AUTH_PAA)
558 ConvertUtf8ToWCharAlloc(rdg->context->settings->GatewayAccessToken, &PAACookieLen);
560 if (!PAACookie || (PAACookieLen > UINT16_MAX /
sizeof(WCHAR)))
564 packetSize += 2 + (UINT32)(PAACookieLen) *
sizeof(WCHAR);
565 fieldsPresent = HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE;
568 s = Stream_New(
nullptr, packetSize);
573 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_CREATE);
574 Stream_Write_UINT16(s, 0);
575 Stream_Write_UINT32(s, packetSize);
576 Stream_Write_UINT32(s, capabilities);
577 Stream_Write_UINT16(s, fieldsPresent);
578 Stream_Write_UINT16(s, 0);
582 Stream_Write_UINT16(s, (UINT16)PAACookieLen *
sizeof(WCHAR));
583 if (!Stream_Write_UTF16_String(s, PAACookie, PAACookieLen))
587 Stream_SealLength(s);
588 status = rdg_write_packet(rdg, s);
591 Stream_Free(s, TRUE);
596 rdg->state = RDG_CLIENT_STATE_TUNNEL_CREATE;
603static BOOL rdg_send_tunnel_authorization(rdpRdg* rdg)
608 size_t clientNameLen = 0;
610 rdg->context->settings, FreeRDP_ClientHostname, &clientNameLen);
614 const size_t packetSize = 12ull + clientNameLen *
sizeof(WCHAR);
615 if (!clientName || (clientNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
618 s = Stream_New(
nullptr, packetSize);
623 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_AUTH);
624 Stream_Write_UINT16(s, 0);
625 Stream_Write_UINT32(s, (UINT32)packetSize);
626 Stream_Write_UINT16(s, 0);
627 Stream_Write_UINT16(s, (UINT16)clientNameLen *
sizeof(WCHAR));
628 if (!Stream_Write_UTF16_String(s, clientName, clientNameLen))
630 Stream_SealLength(s);
631 status = rdg_write_packet(rdg, s);
634 Stream_Free(s, TRUE);
638 rdg->state = RDG_CLIENT_STATE_TUNNEL_AUTHORIZE;
644static BOOL rdg_send_channel_create(rdpRdg* rdg)
648 WCHAR* serverName =
nullptr;
649 size_t serverNameLen = 0;
653 FreeRDP_ServerHostname, &serverNameLen);
656 const size_t packetSize = 16ull + serverNameLen *
sizeof(WCHAR);
657 if (!serverName || (serverNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
660 s = Stream_New(
nullptr, packetSize);
665 Stream_Write_UINT16(s, PKT_TYPE_CHANNEL_CREATE);
666 Stream_Write_UINT16(s, 0);
667 Stream_Write_UINT32(s, (UINT32)packetSize);
668 Stream_Write_UINT8(s, 1);
669 Stream_Write_UINT8(s, 0);
670 Stream_Write_UINT16(s,
671 (UINT16)rdg->context->settings->ServerPort);
672 Stream_Write_UINT16(s, 3);
673 Stream_Write_UINT16(s, (UINT16)serverNameLen *
sizeof(WCHAR));
674 if (!Stream_Write_UTF16_String(s, serverName, serverNameLen))
677 Stream_SealLength(s);
678 status = rdg_write_packet(rdg, s);
681 Stream_Free(s, TRUE);
684 rdg->state = RDG_CLIENT_STATE_CHANNEL_CREATE;
690static BOOL rdg_set_auth_header(rdpCredsspAuth* auth, HttpRequest* request)
692 const SecBuffer* authToken = credssp_auth_get_output_buffer(auth);
693 char* base64AuthToken =
nullptr;
697 if (authToken->cbBuffer > INT_MAX)
700 base64AuthToken = crypto_base64_encode(authToken->pvBuffer, authToken->cbBuffer);
705 BOOL rc = http_request_set_auth_scheme(request, credssp_auth_pkg_name(auth)) &&
706 http_request_set_auth_param(request, base64AuthToken);
707 free(base64AuthToken);
716WINPR_ATTR_MALLOC(Stream_Free, 1)
717static
wStream* rdg_build_http_request(rdpRdg* rdg, const
char* method,
718 TRANSFER_ENCODING transferEncoding)
721 HttpRequest* request =
nullptr;
722 const char* uri =
nullptr;
727 uri = http_context_get_uri(rdg->http);
728 request = http_request_new();
733 if (!http_request_set_method(request, method) || !http_request_set_uri(request, uri))
738 if (!rdg_set_auth_header(rdg->auth, request))
742 else if (rdg->extAuth == HTTP_EXTENDED_AUTH_BEARER)
744 if (!http_request_set_auth_scheme(request,
"Bearer"))
746 if (!http_request_set_auth_param(request, rdg->context->settings->GatewayHttpExtAuthBearer))
750 if (!http_request_set_transfer_encoding(request, transferEncoding))
753 s = http_request_write(rdg->http, request);
755 http_request_free(request);
758 Stream_SealLength(s);
764static BOOL rdg_recv_auth_token(wLog* log, rdpCredsspAuth* auth, HttpResponse* response,
768 size_t authTokenLength = 0;
769 BYTE* authTokenData =
nullptr;
770 SecBuffer authToken = WINPR_C_ARRAY_INIT;
773 WINPR_ASSERT(pHaveToken);
776 if (!auth || !response)
779 const UINT16 StatusCode = http_response_get_status_code(response);
782 case HTTP_STATUS_DENIED:
784 case HTTP_STATUS_SWITCH_PROTOCOLS:
787 http_response_log_error_status(log, WLOG_WARN, response);
791 const char* token64 = http_response_get_auth_token(response, credssp_auth_pkg_name(auth));
801 len = strlen(token64);
803 crypto_base64_decode(token64, len, &authTokenData, &authTokenLength);
805 if (authTokenLength && authTokenData && (authTokenLength <= UINT32_MAX))
807 authToken.pvBuffer = authTokenData;
808 authToken.cbBuffer = (UINT32)authTokenLength;
809 credssp_auth_take_input_buffer(auth, &authToken);
814 rc = credssp_auth_authenticate(auth);
819static BOOL rdg_skip_seed_payload(rdpContext* context, rdpTls* tls,
size_t lastResponseLength,
820 rdg_http_encoding_context* transferEncoding)
825 const size_t size = 10;
826 if (lastResponseLength < size)
828 wStream* s = Stream_New(
nullptr, size);
831 const BOOL rc = rdg_read_all(context, tls, s, size - lastResponseLength, transferEncoding);
832 Stream_Free(s, TRUE);
840static BOOL rdg_process_handshake_response(rdpRdg* rdg,
wStream* s)
842 UINT32 errorCode = 0;
843 UINT16 serverVersion = 0;
844 UINT16 extendedAuth = 0;
847 const char* error =
nullptr;
848 WLog_Print(rdg->log, WLOG_DEBUG,
"Handshake response received");
850 if (rdg->state != RDG_CLIENT_STATE_HANDSHAKE)
855 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
858 Stream_Read_UINT32(s, errorCode);
859 Stream_Read_UINT8(s, verMajor);
860 Stream_Read_UINT8(s, verMinor);
861 Stream_Read_UINT16(s, serverVersion);
862 Stream_Read_UINT16(s, extendedAuth);
863 error = rpc_error_to_string(errorCode);
864 WLog_Print(rdg->log, WLOG_DEBUG,
865 "errorCode=%s, verMajor=%" PRId8
", verMinor=%" PRId8
", serverVersion=%" PRId16
867 error, verMajor, verMinor, serverVersion, extended_auth_to_string(extendedAuth));
869 if (FAILED((HRESULT)errorCode))
871 WLog_Print(rdg->log, WLOG_ERROR,
"Handshake error %s", error);
872 freerdp_set_last_error_log(rdg->context, errorCode);
876 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
877 return rdg_send_extauth_sspi(rdg);
879 return rdg_send_tunnel_request(rdg);
883static BOOL rdg_process_tunnel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
885 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID)
888 if (!Stream_SafeSeek(s, 4))
890 WLog_Print(rdg->log, WLOG_ERROR,
"Short tunnelId, got %" PRIuz
", expected 4",
891 Stream_GetRemainingLength(s));
896 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CAPS)
899 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
902 Stream_Read_UINT32(s, caps);
903 WLog_Print(rdg->log, WLOG_DEBUG,
"capabilities=%s", capabilities_enum_to_string(caps));
906 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ)
909 if (!Stream_SafeSeek(s, 20))
911 WLog_Print(rdg->log, WLOG_ERROR,
"Short nonce, got %" PRIuz
", expected 20",
912 Stream_GetRemainingLength(s));
917 if (!rdg_read_http_unicode_string(rdg->log, s,
nullptr,
nullptr))
919 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read server certificate");
924 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG)
926 const WCHAR* msg =
nullptr;
927 UINT16 msgLenBytes = 0;
928 rdpContext* context = rdg->context;
930 WINPR_ASSERT(context);
931 WINPR_ASSERT(context->instance);
934 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
936 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read consent message");
940 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
941 GATEWAY_MESSAGE_CONSENT, TRUE, TRUE, msgLenBytes, msg);
948static BOOL rdg_process_tunnel_response(rdpRdg* rdg,
wStream* s)
950 UINT16 serverVersion = 0;
951 UINT16 fieldsPresent = 0;
952 UINT32 errorCode = 0;
953 const char* error =
nullptr;
954 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel response received");
956 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_CREATE)
961 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
964 Stream_Read_UINT16(s, serverVersion);
965 Stream_Read_UINT32(s, errorCode);
966 Stream_Read_UINT16(s, fieldsPresent);
967 Stream_Seek_UINT16(s);
968 error = rpc_error_to_string(errorCode);
969 WLog_Print(rdg->log, WLOG_DEBUG,
"serverVersion=%" PRId16
", errorCode=%s, fieldsPresent=%s",
970 serverVersion, error, tunnel_response_fields_present_to_string(fieldsPresent));
972 if (FAILED((HRESULT)errorCode))
974 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel creation error %s", error);
975 freerdp_set_last_error_log(rdg->context, errorCode);
979 if (!rdg_process_tunnel_response_optional(rdg, s, fieldsPresent))
982 return rdg_send_tunnel_authorization(rdg);
986static BOOL rdg_process_tunnel_authorization_response(rdpRdg* rdg,
wStream* s)
988 UINT32 errorCode = 0;
989 UINT16 fieldsPresent = 0;
990 const char* error =
nullptr;
991 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel authorization received");
993 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_AUTHORIZE)
998 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1001 Stream_Read_UINT32(s, errorCode);
1002 Stream_Read_UINT16(s, fieldsPresent);
1003 Stream_Seek_UINT16(s);
1004 error = rpc_error_to_string(errorCode);
1005 WLog_Print(rdg->log, WLOG_DEBUG,
"errorCode=%s, fieldsPresent=%s", error,
1006 tunnel_authorization_response_fields_present_to_string(fieldsPresent));
1009 if (errorCode != S_OK && errorCode != E_PROXY_QUARANTINE_ACCESSDENIED)
1011 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel authorization error %s", error);
1012 freerdp_set_last_error_log(rdg->context, errorCode);
1016 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS)
1018 UINT32 redirFlags = 0;
1019 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1021 Stream_Read_UINT32(s, redirFlags);
1023 rdpContext* context = rdg->context;
1024 if (!utils_apply_gateway_policy(rdg->log, context, redirFlags,
"RDG"))
1028 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT)
1030 UINT32 idleTimeout = 0;
1031 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1033 Stream_Read_UINT32(s, idleTimeout);
1034 WLog_Print(rdg->log, WLOG_DEBUG,
"[IDLE_TIMEOUT] idleTimeout=%" PRIu32
": TODO: unused",
1038 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE)
1041 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1043 Stream_Read_UINT16(s, cbLen);
1045 WLog_Print(rdg->log, WLOG_DEBUG,
"[SOH_RESPONSE] cbLen=%" PRIu16
": TODO: unused", cbLen);
1046 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, cbLen))
1048 Stream_Seek(s, cbLen);
1051 return rdg_send_channel_create(rdg);
1055static BOOL rdg_process_extauth_sspi(rdpRdg* rdg,
wStream* s)
1057 INT32 errorCode = 0;
1058 UINT16 authBlobLen = 0;
1059 SecBuffer authToken = WINPR_C_ARRAY_INIT;
1060 BYTE* authTokenData =
nullptr;
1064 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1066 WLog_Print(rdg->log, WLOG_ERROR,
"EXTAUTH_SSPI_NTLM but rdpRdg::extAuth=false");
1070 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 6))
1073 Stream_Read_INT32(s, errorCode);
1074 Stream_Read_UINT16(s, authBlobLen);
1076 if (errorCode != ERROR_SUCCESS)
1078 WLog_Print(rdg->log, WLOG_ERROR,
"EXTAUTH_SSPI_NTLM failed with error %s [0x%08X]",
1079 GetSecurityStatusString(errorCode), WINPR_CXX_COMPAT_CAST(UINT32, errorCode));
1083 if (authBlobLen == 0)
1085 if (credssp_auth_is_complete(rdg->auth))
1087 credssp_auth_free(rdg->auth);
1088 rdg->auth =
nullptr;
1089 return rdg_send_tunnel_request(rdg);
1094 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, authBlobLen))
1097 authTokenData = malloc(authBlobLen);
1098 if (authTokenData ==
nullptr)
1100 Stream_Read(s, authTokenData, authBlobLen);
1102 authToken.pvBuffer = authTokenData;
1103 authToken.cbBuffer = authBlobLen;
1105 credssp_auth_take_input_buffer(rdg->auth, &authToken);
1107 if (credssp_auth_authenticate(rdg->auth) < 0)
1110 if (credssp_auth_have_output_token(rdg->auth))
1111 return rdg_send_extauth_sspi(rdg);
1117static BOOL rdg_process_channel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
1119 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID) != 0)
1121 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1123 const UINT32 channelId = Stream_Get_UINT32(s);
1124 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got channelId=%" PRIu32, channelId);
1126 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT) != 0)
1128 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1130 const UINT16 udpPort = Stream_Get_UINT16(s);
1131 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got udpPort=%" PRIu32, udpPort);
1133 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE) != 0)
1135 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1137 const UINT16 blobLen = Stream_Get_UINT16(s);
1138 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, blobLen))
1140 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got UDP auth blob=%" PRIu32, blobLen);
1141 if (!Stream_SafeSeek(s, blobLen))
1149static BOOL rdg_process_channel_response(rdpRdg* rdg,
wStream* s)
1151 UINT16 fieldsPresent = 0;
1152 UINT32 errorCode = 0;
1153 const char* error =
nullptr;
1154 WLog_Print(rdg->log, WLOG_DEBUG,
"Channel response received");
1156 if (rdg->state != RDG_CLIENT_STATE_CHANNEL_CREATE)
1161 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1164 Stream_Read_UINT32(s, errorCode);
1165 Stream_Read_UINT16(s, fieldsPresent);
1166 Stream_Seek_UINT16(s);
1167 error = rpc_error_to_string(errorCode);
1168 WLog_Print(rdg->log, WLOG_DEBUG,
"channel response errorCode=%s, fieldsPresent=%s", error,
1169 channel_response_fields_present_to_string(fieldsPresent));
1171 if (FAILED((HRESULT)errorCode))
1173 WLog_Print(rdg->log, WLOG_ERROR,
"channel response errorCode=%s, fieldsPresent=%s", error,
1174 channel_response_fields_present_to_string(fieldsPresent));
1175 freerdp_set_last_error_log(rdg->context, errorCode);
1179 if (!rdg_process_channel_response_optional(rdg, s, fieldsPresent))
1182 rdg->state = RDG_CLIENT_STATE_OPENED;
1187static BOOL rdg_process_packet(rdpRdg* rdg,
wStream* s)
1191 UINT32 packetLength = 0;
1192 Stream_ResetPosition(s);
1194 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1197 Stream_Read_UINT16(s, type);
1198 Stream_Seek_UINT16(s);
1199 Stream_Read_UINT32(s, packetLength);
1201 if (Stream_Length(s) < packetLength)
1203 WLog_Print(rdg->log, WLOG_ERROR,
"Short packet %" PRIuz
", expected %" PRIu32,
1204 Stream_Length(s), packetLength);
1210 case PKT_TYPE_HANDSHAKE_RESPONSE:
1211 status = rdg_process_handshake_response(rdg, s);
1214 case PKT_TYPE_TUNNEL_RESPONSE:
1215 status = rdg_process_tunnel_response(rdg, s);
1218 case PKT_TYPE_TUNNEL_AUTH_RESPONSE:
1219 status = rdg_process_tunnel_authorization_response(rdg, s);
1222 case PKT_TYPE_CHANNEL_RESPONSE:
1223 status = rdg_process_channel_response(rdg, s);
1227 WLog_Print(rdg->log, WLOG_ERROR,
"Unexpected packet type DATA");
1231 case PKT_TYPE_EXTENDED_AUTH_MSG:
1232 status = rdg_process_extauth_sspi(rdg, s);
1236 WLog_Print(rdg->log, WLOG_ERROR,
"PKG TYPE 0x%x not implemented", type);
1243 const size_t rem = Stream_GetRemainingLength(s);
1245 WLog_Print(rdg->log, WLOG_WARN,
"[%s] unparsed data detected: %" PRIuz
" bytes",
1246 rdg_pkt_type_to_string(type), rem);
1251DWORD rdg_get_event_handles(rdpRdg* rdg, HANDLE* events, DWORD count)
1254 WINPR_ASSERT(rdg !=
nullptr);
1256 if (rdg->tlsOut && rdg->tlsOut->bio)
1258 if (events && (nCount < count))
1260 BIO_get_event(rdg->tlsOut->bio, &events[nCount]);
1273static BOOL rdg_get_gateway_credentials(rdpContext* context, rdp_auth_reason reason)
1275 freerdp* instance = context->instance;
1277 auth_status rc = utils_authenticate_gateway(instance, reason);
1283 case AUTH_CANCELLED:
1284 freerdp_set_last_error_log(instance->context, FREERDP_ERROR_CONNECT_CANCELLED);
1286 case AUTH_NO_CREDENTIALS:
1287 WLog_INFO(TAG,
"No credentials provided - using nullptr identity");
1296static BOOL rdg_auth_init(rdpRdg* rdg, rdpTls* tls, TCHAR* authPkg)
1298 rdpContext* context = rdg->context;
1299 rdpSettings* settings = context->settings;
1300 SEC_WINNT_AUTH_IDENTITY identity = WINPR_C_ARRAY_INIT;
1303 rdg->auth = credssp_auth_new(context);
1307 if (!credssp_auth_init(rdg->auth, authPkg, tls->Bindings))
1313 if (!smartcard_getCert(context, &rdg->smartcard, TRUE))
1316 if (!rdg_get_gateway_credentials(context, AUTH_SMARTCARD_PIN))
1321 if (!rdg_get_gateway_credentials(context, GW_AUTH_RDG))
1326 if (doSCLogon && !smartcard_getCert(context, &rdg->smartcard, TRUE))
1330 SEC_WINNT_AUTH_IDENTITY* identityArg = &identity;
1333 if (!identity_set_from_smartcard_hash(&identity, settings, FreeRDP_GatewayUsername,
1334 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword,
1335 rdg->smartcard->sha1Hash,
1336 sizeof(rdg->smartcard->sha1Hash)))
1341 if (!identity_set_from_settings(&identity, settings, FreeRDP_GatewayUsername,
1342 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword))
1345 if (!settings->GatewayUsername)
1346 identityArg =
nullptr;
1349 if (!credssp_auth_setup_client(rdg->auth,
"HTTP", settings->GatewayHostname, identityArg,
1350 rdg->smartcard ? rdg->smartcard->pkinitArgs : nullptr))
1352 sspi_FreeAuthIdentity(&identity);
1355 sspi_FreeAuthIdentity(&identity);
1357 credssp_auth_set_flags(rdg->auth, ISC_REQ_CONFIDENTIALITY | ISC_REQ_MUTUAL_AUTH);
1359 rc = credssp_auth_authenticate(rdg->auth);
1364static BOOL rdg_send_http_request(rdpRdg* rdg, rdpTls* tls,
const char* method,
1365 TRANSFER_ENCODING transferEncoding)
1368 wStream* s = rdg_build_http_request(rdg, method, transferEncoding);
1373 const size_t sz = Stream_Length(s);
1374 status = freerdp_tls_write_all(tls, Stream_Buffer(s), sz);
1376 Stream_Free(s, TRUE);
1377 return (status >= 0);
1381static BOOL rdg_tls_connect(rdpRdg* rdg, rdpTls* tls,
const char* peerAddress, UINT32 timeout)
1384 BIO* layerBio =
nullptr;
1385 BIO* bufferedBio =
nullptr;
1387 rdpSettings* settings = rdg->context->settings;
1388 rdpTransport* transport = freerdp_get_transport(rdg->context);
1389 const char* peerHostname = settings->GatewayHostname;
1390 UINT16 peerPort = (UINT16)settings->GatewayPort;
1391 const char* proxyUsername =
nullptr;
1392 const char* proxyPassword =
nullptr;
1393 BOOL isProxyConnection =
1394 proxy_prepare(settings, &peerHostname, &peerPort, &proxyUsername, &proxyPassword);
1396 if (settings->GatewayPort > UINT16_MAX)
1399 layer = transport_connect_layer(transport, peerAddress ? peerAddress : peerHostname, peerPort,
1407 layerBio = BIO_new(BIO_s_transport_layer());
1410 transport_layer_free(layer);
1413 BIO_set_data(layerBio, layer);
1415 bufferedBio = BIO_new(BIO_s_buffered_socket());
1418 BIO_free_all(layerBio);
1422 bufferedBio = BIO_push(bufferedBio, layerBio);
1423 status = BIO_set_nonblock(bufferedBio, TRUE);
1425 if (isProxyConnection)
1427 if (!proxy_connect(rdg->context, bufferedBio, proxyUsername, proxyPassword,
1428 settings->GatewayHostname, (UINT16)settings->GatewayPort))
1430 BIO_free_all(bufferedBio);
1437 BIO_free_all(bufferedBio);
1441 tls->hostname = settings->GatewayHostname;
1442 tls->port = WINPR_ASSERTING_INT_CAST(int32_t, MIN(UINT16_MAX, settings->GatewayPort));
1443 tls->isGatewayTransport = TRUE;
1444 status = freerdp_tls_connect(tls, bufferedBio);
1447 rdpContext* context = rdg->context;
1450 freerdp_set_last_error_if_not(context, FREERDP_ERROR_TLS_CONNECT_FAILED);
1454 freerdp_set_last_error_if_not(context, FREERDP_ERROR_CONNECT_CANCELLED);
1459 return (status >= 1);
1463static BOOL rdg_establish_data_connection(rdpRdg* rdg, rdpTls* tls,
const char* method,
1464 const char* peerAddress, UINT32 timeout,
1467 char buffer[64] = WINPR_C_ARRAY_INIT;
1468 HttpResponse* response =
nullptr;
1470 if (!rdg_tls_connect(rdg, tls, peerAddress, timeout))
1473 WINPR_ASSERT(rpcFallback);
1474 if (rdg->context->settings->GatewayHttpExtAuthBearer && rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1475 rdg->extAuth = HTTP_EXTENDED_AUTH_BEARER;
1476 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1478 if (!rdg_auth_init(rdg, tls, AUTH_PKG))
1481 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1484 response = http_response_recv(tls, TRUE);
1489 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1490 *rpcFallback = TRUE;
1494 (void)http_response_extract_cookies(response, rdg->http);
1496 const UINT16 StatusCode = http_response_get_status_code(response);
1499 case HTTP_STATUS_GONE:
1500 case HTTP_STATUS_FORBIDDEN:
1501 case HTTP_STATUS_NOT_FOUND:
1503 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway does not support HTTP transport.");
1504 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1505 *rpcFallback = TRUE;
1507 http_response_free(response);
1510 case HTTP_STATUS_OK:
1513 case HTTP_STATUS_DENIED:
1514 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1518 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1522 while (!credssp_auth_is_complete(rdg->auth))
1524 BOOL haveToken = FALSE;
1526 if (!rdg_recv_auth_token(rdg->log, rdg->auth, response, &haveToken))
1528 http_response_free(response);
1543 WLog_Print(rdg->log, WLOG_DEBUG,
1544 "No authentication token in the response, ending the exchange");
1548 if (credssp_auth_have_output_token(rdg->auth))
1550 http_response_free(response);
1552 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1555 response = http_response_recv(tls, TRUE);
1558 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1559 *rpcFallback = TRUE;
1562 (void)http_response_extract_cookies(response, rdg->http);
1567 credssp_auth_free(rdg->auth);
1568 rdg->auth =
nullptr;
1572 credssp_auth_free(rdg->auth);
1573 rdg->auth =
nullptr;
1575 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1578 response = http_response_recv(tls, TRUE);
1582 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1583 *rpcFallback = TRUE;
1586 (void)http_response_extract_cookies(response, rdg->http);
1589 const UINT16 statusCode = http_response_get_status_code(response);
1590 const size_t bodyLength = http_response_get_body_length(response);
1591 const TRANSFER_ENCODING encoding = http_response_get_transfer_encoding(response);
1592 const BOOL isWebsocket = http_response_is_websocket(rdg->http, response);
1594 WLog_Print(rdg->log, WLOG_DEBUG,
"%s authorization result: %s", method,
1595 freerdp_http_status_string_format(statusCode, buffer, ARRAYSIZE(buffer)));
1599 case HTTP_STATUS_OK:
1602 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1603 http_response_free(response);
1605 case HTTP_STATUS_DENIED:
1606 freerdp_set_last_error_log(rdg->context, FREERDP_ERROR_CONNECT_ACCESS_DENIED);
1607 http_response_free(response);
1609 case HTTP_STATUS_SWITCH_PROTOCOLS:
1610 http_response_free(response);
1617 if (http_context_is_websocket_upgrade_enabled(rdg->http))
1619 long fd = BIO_get_fd(tls->bio,
nullptr);
1621 closesocket((SOCKET)fd);
1622 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1623 return rdg_establish_data_connection(rdg, tls, method, peerAddress, timeout,
1629 rdg->transferEncoding.isWebsocketTransport = TRUE;
1630 if (!websocket_context_reset(rdg->transferEncoding.context.websocket))
1633 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1637 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1642 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1643 http_response_free(response);
1647 if (strcmp(method,
"RDG_OUT_DATA") == 0)
1649 if (encoding == TransferEncodingChunked)
1651 rdg->transferEncoding.httpTransferEncoding = TransferEncodingChunked;
1652 rdg->transferEncoding.context.chunked.nextOffset = 0;
1653 rdg->transferEncoding.context.chunked.headerFooterPos = 0;
1654 rdg->transferEncoding.context.chunked.state = ChunkStateLenghHeader;
1656 if (!rdg_skip_seed_payload(rdg->context, tls, bodyLength, &rdg->transferEncoding))
1663 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingChunked))
1666 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1670 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1679static BOOL rdg_tunnel_connect(rdpRdg* rdg)
1681 if (!rdg_send_handshake(rdg))
1684 while (rdg->state < RDG_CLIENT_STATE_OPENED)
1686 BOOL status = FALSE;
1687 wStream* s = rdg_receive_packet(rdg);
1691 status = rdg_process_packet(rdg, s);
1692 Stream_Free(s, TRUE);
1698 WINPR_ASSERT(rdg->context);
1699 WINPR_ASSERT(rdg->context->rdp);
1700 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1708BOOL rdg_connect(rdpRdg* rdg, DWORD timeout, BOOL* rpcFallback)
1711 SOCKET outConnSocket = 0;
1712 char* peerAddress =
nullptr;
1713 BOOL rpcFallbackLocal = FALSE;
1715 WINPR_ASSERT(rdg !=
nullptr);
1716 freerdp_set_last_error(rdg->context, ERROR_SUCCESS);
1717 status = rdg_establish_data_connection(rdg, rdg->tlsOut,
"RDG_OUT_DATA",
nullptr, timeout,
1722 if (rdg->transferEncoding.isWebsocketTransport)
1724 WLog_Print(rdg->log, WLOG_DEBUG,
"Upgraded to websocket. RDG_IN_DATA not required");
1731 BIO_get_socket(rdg->tlsOut->underlying, &outConnSocket);
1732 peerAddress = freerdp_tcp_get_peer_address(outConnSocket);
1733 status = rdg_establish_data_connection(rdg, rdg->tlsIn,
"RDG_IN_DATA", peerAddress,
1734 timeout, &rpcFallbackLocal);
1740 *rpcFallback = rpcFallbackLocal;
1745 WINPR_ASSERT(rdg->context);
1746 WINPR_ASSERT(rdg->context->rdp);
1747 if (rpcFallbackLocal)
1749 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1750 credssp_auth_free(rdg->auth);
1751 rdg->auth =
nullptr;
1754 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1758 status = rdg_tunnel_connect(rdg);
1764static int rdg_write_websocket_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1770 const size_t payloadSize = (size_t)isize + 10;
1778 websocket_context_packet_new(payloadSize, WebsocketBinaryOpcode, &maskingKey.u32);
1782 Stream_Write_UINT16(
1783 sWS, WINPR_ASSERTING_INT_CAST(
1784 uint16_t, PKT_TYPE_DATA ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1785 Stream_Write_UINT16(
1786 sWS, WINPR_ASSERTING_INT_CAST(
1787 uint16_t, 0 ^ (maskingKey.u8[2] | maskingKey.u8[3] << 8)));
1788 Stream_Write_UINT32(
1789 sWS, WINPR_ASSERTING_INT_CAST(uint32_t, payloadSize ^ maskingKey.u32));
1790 Stream_Write_UINT16(
1791 sWS, WINPR_ASSERTING_INT_CAST(
1792 uint16_t, isize ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1795 maskingKey.u32 = (maskingKey.u32 & 0xffff) << 16 | (maskingKey.u32 >> 16);
1797 WINPR_ASSERT(rdg->tlsOut);
1798 wStream sPacket = WINPR_C_ARRAY_INIT;
1799 Stream_StaticConstInit(&sPacket, buf, (
size_t)isize);
1800 if (!websocket_context_mask_and_send(rdg->tlsOut->bio, sWS, &sPacket, maskingKey.u32))
1807static int rdg_write_chunked_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1813 if (isize > UINT16_MAX)
1816 const size_t size = (size_t)isize;
1820 const size_t packetSize = size + 10;
1821 char chunkSize[11] = WINPR_C_ARRAY_INIT;
1822 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIxz
"\r\n", packetSize);
1823 sChunk = Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + packetSize + 2);
1828 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
1829 Stream_Write_UINT16(sChunk, PKT_TYPE_DATA);
1830 Stream_Write_UINT16(sChunk, 0);
1831 Stream_Write_UINT32(sChunk, (UINT32)packetSize);
1832 Stream_Write_UINT16(sChunk, (UINT16)size);
1833 Stream_Write(sChunk, buf, size);
1834 Stream_Write(sChunk,
"\r\n", 2);
1835 Stream_SealLength(sChunk);
1836 len = Stream_Length(sChunk);
1838 status = freerdp_tls_write_all(rdg->tlsIn, Stream_Buffer(sChunk), len);
1839 Stream_Free(sChunk, TRUE);
1848static int rdg_write_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1851 if (rdg->transferEncoding.isWebsocketTransport)
1852 return rdg_write_websocket_data_packet(rdg, buf, isize);
1854 return rdg_write_chunked_data_packet(rdg, buf, isize);
1858static BOOL rdg_process_close_packet(rdpRdg* rdg,
wStream* s)
1862 UINT32 errorCode = 0;
1863 UINT32 packetSize = 12;
1866 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1868 Stream_Read_UINT32(s, errorCode);
1871 freerdp_set_last_error_log(rdg->context, errorCode);
1873 sClose = Stream_New(
nullptr, packetSize);
1877 Stream_Write_UINT16(sClose, PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
1878 Stream_Write_UINT16(sClose, 0);
1879 Stream_Write_UINT32(sClose, packetSize);
1880 Stream_Write_UINT32(sClose, 0);
1881 Stream_SealLength(sClose);
1882 status = rdg_write_packet(rdg, sClose);
1883 Stream_Free(sClose, TRUE);
1885 return ((status >= 0));
1889static BOOL rdg_process_keep_alive_packet(rdpRdg* rdg)
1892 wStream* sKeepAlive =
nullptr;
1893 size_t packetSize = 8;
1895 sKeepAlive = Stream_New(
nullptr, packetSize);
1900 Stream_Write_UINT16(sKeepAlive, PKT_TYPE_KEEPALIVE);
1901 Stream_Write_UINT16(sKeepAlive, 0);
1902 Stream_Write_UINT32(sKeepAlive, (UINT32)packetSize);
1903 Stream_SealLength(sKeepAlive);
1904 status = rdg_write_packet(rdg, sKeepAlive);
1905 Stream_Free(sKeepAlive, TRUE);
1907 return ((status >= 0));
1911static BOOL rdg_process_service_message(rdpRdg* rdg,
wStream* s)
1913 const WCHAR* msg =
nullptr;
1914 UINT16 msgLenBytes = 0;
1915 rdpContext* context = rdg->context;
1916 WINPR_ASSERT(context);
1917 WINPR_ASSERT(context->instance);
1920 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
1922 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read string");
1926 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
1927 GATEWAY_MESSAGE_SERVICE, TRUE, FALSE, msgLenBytes, msg);
1931static BOOL rdg_process_unknown_packet(rdpRdg* rdg,
int type)
1935 WLog_Print(rdg->log, WLOG_WARN,
"Unknown Control Packet received: %" PRIX32,
1936 WINPR_CXX_COMPAT_CAST(UINT32, type));
1941static BOOL rdg_process_control_packet(rdpRdg* rdg,
int type,
size_t packetLength)
1944 size_t readCount = 0;
1946 size_t payloadSize = packetLength -
sizeof(RdgPacketHeader);
1948 if (packetLength <
sizeof(RdgPacketHeader))
1952 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1956 s = Stream_New(
nullptr, payloadSize);
1961 while (readCount < payloadSize)
1963 if (rdg_shall_abort(rdg))
1965 Stream_Free(s, TRUE);
1968 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context, Stream_Pointer(s),
1969 payloadSize - readCount, &rdg->transferEncoding);
1973 if (!BIO_should_retry(rdg->tlsOut->bio))
1975 Stream_Free(s, TRUE);
1979 BIO_wait_read(rdg->tlsOut->bio, 50);
1983 Stream_Seek(s, (
size_t)status);
1984 readCount += (size_t)status;
1986 if (readCount > INT_MAX)
1988 Stream_Free(s, TRUE);
1993 Stream_ResetPosition(s);
1998 case PKT_TYPE_CLOSE_CHANNEL:
2001 WLog_Print(rdg->log, WLOG_ERROR,
2002 "PKT_TYPE_CLOSE_CHANNEL requires payload but none was sent");
2005 EnterCriticalSection(&rdg->writeSection);
2006 status = rdg_process_close_packet(rdg, s);
2007 LeaveCriticalSection(&rdg->writeSection);
2010 case PKT_TYPE_KEEPALIVE:
2011 EnterCriticalSection(&rdg->writeSection);
2012 status = rdg_process_keep_alive_packet(rdg);
2013 LeaveCriticalSection(&rdg->writeSection);
2016 case PKT_TYPE_SERVICE_MESSAGE:
2019 WLog_Print(rdg->log, WLOG_ERROR,
2020 "PKT_TYPE_SERVICE_MESSAGE requires payload but none was sent");
2023 status = rdg_process_service_message(rdg, s);
2026 case PKT_TYPE_REAUTH_MESSAGE:
2028 status = rdg_process_unknown_packet(rdg, type);
2032 Stream_Free(s, TRUE);
2037static int rdg_read_data_packet(rdpRdg* rdg, BYTE* buffer,
size_t size)
2039 RdgPacketHeader header = WINPR_C_ARRAY_INIT;
2040 size_t readCount = 0;
2041 size_t readSize = 0;
2044 if (!rdg->packetRemainingCount)
2047 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
2049 while (readCount <
sizeof(RdgPacketHeader))
2051 if (rdg_shall_abort(rdg))
2054 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context, (BYTE*)(&header) + readCount,
2055 sizeof(RdgPacketHeader) - readCount, &rdg->transferEncoding);
2059 if (!BIO_should_retry(rdg->tlsOut->bio))
2062 BIO_wait_read(rdg->tlsOut->bio, 50);
2066 readCount += (size_t)status;
2068 if (readCount > INT_MAX)
2072 if (header.type != PKT_TYPE_DATA)
2074 status = rdg_process_control_packet(rdg, header.type, header.packetLength);
2084 while (readCount < 2)
2086 if (rdg_shall_abort(rdg))
2088 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context,
2089 (BYTE*)(&rdg->packetRemainingCount) + readCount, 2 - readCount,
2090 &rdg->transferEncoding);
2094 if (!BIO_should_retry(rdg->tlsOut->bio))
2097 BIO_wait_read(rdg->tlsOut->bio, 50);
2101 readCount += (size_t)status;
2105 readSize = (rdg->packetRemainingCount < size) ? rdg->packetRemainingCount : size;
2107 rdg_socket_read(rdg->tlsOut->bio, rdg->context, buffer, readSize, &rdg->transferEncoding);
2111 if (!BIO_should_retry(rdg->tlsOut->bio))
2117 rdg->packetRemainingCount -= status;
2122static int rdg_bio_write(BIO* bio,
const char* buf,
int num)
2125 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2129 BIO_clear_flags(bio, BIO_FLAGS_WRITE);
2130 EnterCriticalSection(&rdg->writeSection);
2131 status = rdg_write_data_packet(rdg, (
const BYTE*)buf, num);
2132 LeaveCriticalSection(&rdg->writeSection);
2136 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2139 else if (status < num)
2141 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2142 WSASetLastError(WSAEWOULDBLOCK);
2146 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2153static int rdg_bio_read(BIO* bio,
char* buf,
int size)
2156 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2159 status = rdg_read_data_packet(rdg, (BYTE*)buf, (
size_t)size);
2163 BIO_clear_retry_flags(bio);
2166 else if (status == 0)
2168 BIO_set_retry_read(bio);
2169 WSASetLastError(WSAEWOULDBLOCK);
2174 BIO_set_flags(bio, BIO_FLAGS_READ);
2181static int rdg_bio_puts(BIO* bio,
const char* str)
2190static int rdg_bio_gets(BIO* bio,
char* str,
int size)
2199static long rdg_bio_ctrl(BIO* in_bio,
int cmd,
long arg1,
void* arg2)
2202 rdpRdg* rdg = (rdpRdg*)BIO_get_data(in_bio);
2203 rdpTls* tlsOut = rdg->tlsOut;
2204 rdpTls* tlsIn = rdg->tlsIn;
2206 if (cmd == BIO_CTRL_FLUSH)
2208 (void)BIO_flush(tlsOut->bio);
2209 if (!rdg->transferEncoding.isWebsocketTransport)
2210 (void)BIO_flush(tlsIn->bio);
2213 else if (cmd == BIO_C_SET_NONBLOCK)
2217 else if (cmd == BIO_C_READ_BLOCKED)
2219 BIO* cbio = tlsOut->bio;
2220 status = BIO_read_blocked(cbio);
2222 else if (cmd == BIO_C_WRITE_BLOCKED)
2224 BIO* cbio = tlsIn->bio;
2226 if (rdg->transferEncoding.isWebsocketTransport)
2229 status = BIO_write_blocked(cbio);
2231 else if (cmd == BIO_C_WAIT_READ)
2233 int timeout = (int)arg1;
2234 BIO* cbio = tlsOut->bio;
2236 if (BIO_read_blocked(cbio))
2237 return BIO_wait_read(cbio, timeout);
2238 else if (BIO_write_blocked(cbio))
2239 return BIO_wait_write(cbio, timeout);
2243 else if (cmd == BIO_C_WAIT_WRITE)
2245 int timeout = (int)arg1;
2246 BIO* cbio = tlsIn->bio;
2248 if (rdg->transferEncoding.isWebsocketTransport)
2251 if (BIO_write_blocked(cbio))
2252 status = BIO_wait_write(cbio, timeout);
2253 else if (BIO_read_blocked(cbio))
2254 status = BIO_wait_read(cbio, timeout);
2258 else if (cmd == BIO_C_GET_EVENT || cmd == BIO_C_GET_FD)
2268 status = BIO_ctrl(tlsOut->bio, cmd, arg1, arg2);
2270#if OPENSSL_VERSION_NUMBER >= 0x30000000L
2271 else if (cmd == BIO_CTRL_GET_KTLS_SEND)
2279 else if (cmd == BIO_CTRL_GET_KTLS_RECV)
2291static int rdg_bio_new(BIO* bio)
2293 BIO_set_init(bio, 1);
2294 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2299static int rdg_bio_free(BIO* bio)
2306static BIO_METHOD* BIO_s_rdg(
void)
2308 static BIO_METHOD* bio_methods =
nullptr;
2310 if (bio_methods ==
nullptr)
2312 if (!(bio_methods = BIO_meth_new(BIO_TYPE_TSG,
"RDGateway")))
2315 BIO_meth_set_write(bio_methods, rdg_bio_write);
2316 BIO_meth_set_read(bio_methods, rdg_bio_read);
2317 BIO_meth_set_puts(bio_methods, rdg_bio_puts);
2318 BIO_meth_set_gets(bio_methods, rdg_bio_gets);
2319 BIO_meth_set_ctrl(bio_methods, rdg_bio_ctrl);
2320 BIO_meth_set_create(bio_methods, rdg_bio_new);
2321 BIO_meth_set_destroy(bio_methods, rdg_bio_free);
2327rdpRdg* rdg_new(rdpContext* context)
2332 rdpRdg* rdg = (rdpRdg*)calloc(1,
sizeof(rdpRdg));
2336 rdg->log = WLog_Get(TAG);
2337 rdg->state = RDG_CLIENT_STATE_INITIAL;
2338 rdg->context = context;
2339 rdpSettings* settings = rdg->context->settings;
2340 rdg->extAuth = (settings->GatewayHttpExtAuthSspiNtlm ? HTTP_EXTENDED_AUTH_SSPI_NTLM
2341 : HTTP_EXTENDED_AUTH_NONE);
2343 if (settings->GatewayAccessToken)
2344 rdg->extAuth = HTTP_EXTENDED_AUTH_PAA;
2346 rdg->tlsOut = freerdp_tls_new(rdg->context);
2349 goto rdg_alloc_error;
2351 rdg->tlsIn = freerdp_tls_new(rdg->context);
2354 goto rdg_alloc_error;
2356 rdg->http = http_context_new();
2359 goto rdg_alloc_error;
2361 GUID guid = WINPR_C_ARRAY_INIT;
2362 if (UuidFromStringA(settings->CorrelationId, &guid) != RPC_S_OK)
2363 goto rdg_alloc_error;
2365 if (!http_context_set_uri(rdg->http,
"/remoteDesktopGateway/") ||
2366 !http_context_set_accept(rdg->http,
"*/*") ||
2367 !http_context_set_cache_control(rdg->http,
"no-cache") ||
2368 !http_context_set_pragma(rdg->http,
"no-cache") ||
2369 !http_context_set_connection(rdg->http,
"Keep-Alive") ||
2370 !http_context_set_user_agent(rdg->http,
"MS-RDGateway/1.0") ||
2371 !http_context_set_host(rdg->http, rdg->context->settings->GatewayHostname) ||
2372 !http_context_set_rdg_connection_id(rdg->http) ||
2373 !http_context_set_rdg_correlation_id(rdg->http, &guid) ||
2374 !http_context_enable_websocket_upgrade(
2378 goto rdg_alloc_error;
2381 if (rdg->extAuth != HTTP_EXTENDED_AUTH_NONE)
2383 switch (rdg->extAuth)
2385 case HTTP_EXTENDED_AUTH_PAA:
2386 if (!http_context_set_rdg_auth_scheme(rdg->http,
"PAA"))
2387 goto rdg_alloc_error;
2391 case HTTP_EXTENDED_AUTH_SSPI_NTLM:
2392 if (!http_context_set_rdg_auth_scheme(rdg->http,
"SSPI_NTLM"))
2393 goto rdg_alloc_error;
2398 WLog_Print(rdg->log, WLOG_DEBUG,
2399 "RDG extended authentication method %d not supported", rdg->extAuth);
2403 rdg->frontBio = BIO_new(BIO_s_rdg());
2406 goto rdg_alloc_error;
2408 BIO_set_data(rdg->frontBio, rdg);
2409 InitializeCriticalSection(&rdg->writeSection);
2411 rdg->transferEncoding.httpTransferEncoding = TransferEncodingIdentity;
2412 rdg->transferEncoding.isWebsocketTransport = FALSE;
2414 rdg->transferEncoding.context.websocket = websocket_context_new();
2415 if (!rdg->transferEncoding.context.websocket)
2416 goto rdg_alloc_error;
2420 WINPR_PRAGMA_DIAG_PUSH
2421 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2423 WINPR_PRAGMA_DIAG_POP
2427void rdg_free(rdpRdg* rdg)
2432 freerdp_tls_free(rdg->tlsOut);
2433 freerdp_tls_free(rdg->tlsIn);
2434 http_context_free(rdg->http);
2435 credssp_auth_free(rdg->auth);
2438 BIO_free_all(rdg->frontBio);
2440 DeleteCriticalSection(&rdg->writeSection);
2442 smartcardCertInfo_Free(rdg->smartcard);
2444 websocket_context_free(rdg->transferEncoding.context.websocket);
2449BIO* rdg_get_front_bio_and_take_ownership(rdpRdg* rdg)
2454 rdg->attached = TRUE;
2455 return rdg->frontBio;
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.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.