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;
117 websocket_context* websocket;
118} rdg_http_encoding_context;
127 rdpCredsspAuth* auth;
132 UINT16 packetRemainingCount;
137 rdg_http_encoding_context transferEncoding;
145 size_t nextHeaderLengthRead;
150 RDG_CLIENT_STATE_INITIAL,
151 RDG_CLIENT_STATE_HANDSHAKE,
152 RDG_CLIENT_STATE_TUNNEL_CREATE,
153 RDG_CLIENT_STATE_TUNNEL_AUTHORIZE,
154 RDG_CLIENT_STATE_CHANNEL_CREATE,
155 RDG_CLIENT_STATE_OPENED,
160typedef struct rdg_packet_header
175static const t_flag_mapping tunnel_response_fields_present[] = {
176 { HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID,
"HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID" },
177 { HTTP_TUNNEL_RESPONSE_FIELD_CAPS,
"HTTP_TUNNEL_RESPONSE_FIELD_CAPS" },
178 { HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ,
"HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ" },
179 { HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG,
"HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG" }
182static const t_flag_mapping channel_response_fields_present[] = {
183 { HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID,
"HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID" },
184 { HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE,
"HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE" },
185 { HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT,
"HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT" }
188static const t_flag_mapping tunnel_authorization_response_fields_present[] = {
189 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS,
"HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS" },
190 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT,
191 "HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT" },
192 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE,
193 "HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE" }
196static const t_flag_mapping extended_auth[] = {
197 { HTTP_EXTENDED_AUTH_NONE,
"HTTP_EXTENDED_AUTH_NONE" },
198 { HTTP_EXTENDED_AUTH_SC,
"HTTP_EXTENDED_AUTH_SC" },
199 { HTTP_EXTENDED_AUTH_PAA,
"HTTP_EXTENDED_AUTH_PAA" },
200 { HTTP_EXTENDED_AUTH_SSPI_NTLM,
"HTTP_EXTENDED_AUTH_SSPI_NTLM" }
203static const t_flag_mapping capabilities_enum[] = {
204 { HTTP_CAPABILITY_TYPE_QUAR_SOH,
"HTTP_CAPABILITY_TYPE_QUAR_SOH" },
205 { HTTP_CAPABILITY_IDLE_TIMEOUT,
"HTTP_CAPABILITY_IDLE_TIMEOUT" },
206 { HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN,
"HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN" },
207 { HTTP_CAPABILITY_MESSAGING_SERVICE_MSG,
"HTTP_CAPABILITY_MESSAGING_SERVICE_MSG" },
208 { HTTP_CAPABILITY_REAUTH,
"HTTP_CAPABILITY_REAUTH" },
209 { HTTP_CAPABILITY_UDP_TRANSPORT,
"HTTP_CAPABILITY_UDP_TRANSPORT" }
213static const char* rdg_pkt_type_to_string(
int type)
221 ENTRY(PKT_TYPE_HANDSHAKE_REQUEST);
222 ENTRY(PKT_TYPE_HANDSHAKE_RESPONSE);
223 ENTRY(PKT_TYPE_EXTENDED_AUTH_MSG);
224 ENTRY(PKT_TYPE_TUNNEL_CREATE);
225 ENTRY(PKT_TYPE_TUNNEL_RESPONSE);
226 ENTRY(PKT_TYPE_TUNNEL_AUTH);
227 ENTRY(PKT_TYPE_TUNNEL_AUTH_RESPONSE);
228 ENTRY(PKT_TYPE_CHANNEL_CREATE);
229 ENTRY(PKT_TYPE_CHANNEL_RESPONSE);
230 ENTRY(PKT_TYPE_DATA);
231 ENTRY(PKT_TYPE_SERVICE_MESSAGE);
232 ENTRY(PKT_TYPE_REAUTH_MESSAGE);
233 ENTRY(PKT_TYPE_KEEPALIVE);
234 ENTRY(PKT_TYPE_CLOSE_CHANNEL);
235 ENTRY(PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
237 return "PKT_TYPE_UNKNOWN";
243static const char* flags_to_string(UINT32 flags,
const t_flag_mapping* map,
size_t elements)
245 static char buffer[1024] = WINPR_C_ARRAY_INIT;
246 char fields[12] = WINPR_C_ARRAY_INIT;
248 for (
size_t x = 0; x < elements; x++)
250 const t_flag_mapping* cur = &map[x];
252 if ((cur->code & flags) != 0)
253 winpr_str_append(cur->name, buffer,
sizeof(buffer),
"|");
256 (void)sprintf_s(fields, ARRAYSIZE(fields),
" [%04" PRIx32
"]", flags);
257 winpr_str_append(fields, buffer,
sizeof(buffer),
nullptr);
262static const char* channel_response_fields_present_to_string(UINT16 fieldsPresent)
264 return flags_to_string(fieldsPresent, channel_response_fields_present,
265 ARRAYSIZE(channel_response_fields_present));
269static const char* tunnel_response_fields_present_to_string(UINT16 fieldsPresent)
271 return flags_to_string(fieldsPresent, tunnel_response_fields_present,
272 ARRAYSIZE(tunnel_response_fields_present));
276static const char* tunnel_authorization_response_fields_present_to_string(UINT16 fieldsPresent)
278 return flags_to_string(fieldsPresent, tunnel_authorization_response_fields_present,
279 ARRAYSIZE(tunnel_authorization_response_fields_present));
283static const char* extended_auth_to_string(UINT16 auth)
285 if (auth == HTTP_EXTENDED_AUTH_NONE)
286 return "HTTP_EXTENDED_AUTH_NONE [0x0000]";
288 return flags_to_string(auth, extended_auth, ARRAYSIZE(extended_auth));
292static const char* capabilities_enum_to_string(UINT32 capabilities)
294 return flags_to_string(capabilities, capabilities_enum, ARRAYSIZE(capabilities_enum));
298static BOOL rdg_read_http_unicode_string(wLog* log,
wStream* s,
const WCHAR**
string,
299 UINT16* lengthInBytes)
301 UINT16 strLenBytes = 0;
302 size_t rem = Stream_GetRemainingLength(s);
305 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 4))
307 WLog_Print(log, WLOG_ERROR,
"Could not read stream length, only have %" PRIuz
" bytes",
311 Stream_Read_UINT16(s, strLenBytes);
314 const WCHAR* str = Stream_ConstPointer(s);
317 if (!Stream_SafeSeek(s, strLenBytes))
319 WLog_Print(log, WLOG_ERROR,
320 "Could not read stream data, only have %" PRIuz
" bytes, expected %" PRIu16,
321 rem - 4, strLenBytes);
329 *lengthInBytes = strLenBytes;
335static BOOL rdg_write_chunked(BIO* bio,
wStream* sPacket)
341 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIXz
"\r\n", Stream_Length(sPacket));
343 Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + Stream_Length(sPacket) + 2);
348 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
349 Stream_Write(sChunk, Stream_Buffer(sPacket), Stream_Length(sPacket));
350 Stream_Write(sChunk,
"\r\n", 2);
351 Stream_SealLength(sChunk);
352 len = Stream_Length(sChunk);
356 Stream_Free(sChunk, TRUE);
361 status = BIO_write(bio, Stream_Buffer(sChunk), (
int)len);
362 Stream_Free(sChunk, TRUE);
364 return (status == (SSIZE_T)len);
368static BOOL rdg_write_packet(rdpRdg* rdg,
wStream* sPacket)
370 if (rdg->transferEncoding.isWebsocketTransport)
371 return websocket_context_write_wstream(rdg->transferEncoding.websocket, rdg->tlsOut->bio,
372 sPacket, WebsocketBinaryOpcode);
374 return rdg_write_chunked(rdg->tlsIn->bio, sPacket);
378static int rdg_socket_read(BIO* bio, rdpContext* context, BYTE* pBuffer,
size_t size,
379 rdg_http_encoding_context* encodingContext)
381 WINPR_ASSERT(encodingContext !=
nullptr);
382 if (size > INT32_MAX)
385 if (encodingContext->isWebsocketTransport)
386 return websocket_context_read(encodingContext->websocket, bio, pBuffer, size);
388 switch (encodingContext->httpTransferEncoding)
390 case TransferEncodingIdentity:
392 return BIO_read(bio, pBuffer, (
int)size);
393 case TransferEncodingChunked:
394 return http_chuncked_read(bio, context, pBuffer, size, &encodingContext->chunked);
396 WLog_ERR(TAG,
"Unknown HTTP transfer encoding %u, aborting",
397 encodingContext->httpTransferEncoding);
403static BOOL rdg_shall_abort(rdpRdg* rdg)
406 return freerdp_shall_disconnect_context(rdg->context);
410static BOOL rdg_read_all(rdpContext* context, rdpTls* tls,
wStream* s,
size_t size,
411 rdg_http_encoding_context* transferEncoding)
413 size_t readCount = 0;
415 if (!Stream_EnsureRemainingCapacity(s, size))
418 BYTE* pBuffer = Stream_Pointer(s);
419 while (readCount < size)
421 if (freerdp_shall_disconnect_context(context))
425 rdg_socket_read(tls->bio, tls->context, pBuffer, size - readCount, transferEncoding);
428 if (!BIO_should_retry(tls->bio))
431 BIO_wait_read(tls->bio, 50);
435 readCount += WINPR_ASSERTING_INT_CAST(uint32_t, status);
436 pBuffer += WINPR_ASSERTING_INT_CAST(uint32_t, status);
442WINPR_ATTR_MALLOC(Stream_Free, 1)
443static
wStream* rdg_receive_packet(rdpRdg* rdg)
445 const size_t header =
sizeof(RdgPacketHeader);
446 size_t packetLength = 0;
447 wStream* s = Stream_New(
nullptr, 1024);
452 if (!rdg_read_all(rdg->context, rdg->tlsOut, s, header, &rdg->transferEncoding))
456 Stream_Read_UINT32(s, packetLength);
458 if ((packetLength > INT_MAX) || (packetLength < header))
461 const size_t requestBlockSize = 4096;
462 for (
size_t offset = header; offset < packetLength; offset += requestBlockSize)
464 size_t block = requestBlockSize;
465 if (offset + block > packetLength)
466 block = packetLength - offset;
468 if (!rdg_read_all(rdg->context, rdg->tlsOut, s, block, &rdg->transferEncoding))
471 if (!Stream_SafeSeek(s, block))
475 if (!Stream_SetLength(s, packetLength))
480 Stream_Free(s, TRUE);
485static BOOL rdg_send_handshake(rdpRdg* rdg)
488 wStream* s = Stream_New(
nullptr, 14);
493 Stream_Write_UINT16(s, PKT_TYPE_HANDSHAKE_REQUEST);
494 Stream_Write_UINT16(s, 0);
495 Stream_Write_UINT32(s, 14);
496 Stream_Write_UINT8(s, 1);
497 Stream_Write_UINT8(s, 0);
498 Stream_Write_UINT16(s, 0);
499 Stream_Write_UINT16(s, rdg->extAuth);
500 Stream_SealLength(s);
501 status = rdg_write_packet(rdg, s);
502 Stream_Free(s, TRUE);
506 rdg->state = RDG_CLIENT_STATE_HANDSHAKE;
513static BOOL rdg_send_extauth_sspi(rdpRdg* rdg)
517 UINT32 packetSize = 8 + 4 + 2;
521 const SecBuffer* authToken = credssp_auth_get_output_buffer(rdg->auth);
524 packetSize += authToken->cbBuffer;
526 s = Stream_New(
nullptr, packetSize);
531 Stream_Write_UINT16(s, PKT_TYPE_EXTENDED_AUTH_MSG);
532 Stream_Write_UINT16(s, 0);
533 Stream_Write_UINT32(s, packetSize);
534 Stream_Write_UINT32(s, ERROR_SUCCESS);
535 Stream_Write_UINT16(s, (UINT16)authToken->cbBuffer);
536 Stream_Write(s, authToken->pvBuffer, authToken->cbBuffer);
538 Stream_SealLength(s);
539 status = rdg_write_packet(rdg, s);
540 Stream_Free(s, TRUE);
546static BOOL rdg_send_tunnel_request(rdpRdg* rdg)
550 UINT32 packetSize = 16;
551 UINT16 fieldsPresent = 0;
552 WCHAR* PAACookie =
nullptr;
553 size_t PAACookieLen = 0;
554 const UINT32 capabilities = HTTP_CAPABILITY_TYPE_QUAR_SOH |
555 HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN |
556 HTTP_CAPABILITY_MESSAGING_SERVICE_MSG;
558 if (rdg->extAuth == HTTP_EXTENDED_AUTH_PAA)
561 ConvertUtf8ToWCharAlloc(rdg->context->settings->GatewayAccessToken, &PAACookieLen);
563 if (!PAACookie || (PAACookieLen > UINT16_MAX /
sizeof(WCHAR)))
567 packetSize += 2 + (UINT32)(PAACookieLen) *
sizeof(WCHAR);
568 fieldsPresent = HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE;
571 s = Stream_New(
nullptr, packetSize);
576 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_CREATE);
577 Stream_Write_UINT16(s, 0);
578 Stream_Write_UINT32(s, packetSize);
579 Stream_Write_UINT32(s, capabilities);
580 Stream_Write_UINT16(s, fieldsPresent);
581 Stream_Write_UINT16(s, 0);
585 Stream_Write_UINT16(s, (UINT16)PAACookieLen *
sizeof(WCHAR));
586 if (!Stream_Write_UTF16_String(s, PAACookie, PAACookieLen))
590 Stream_SealLength(s);
591 status = rdg_write_packet(rdg, s);
594 Stream_Free(s, TRUE);
599 rdg->state = RDG_CLIENT_STATE_TUNNEL_CREATE;
606static BOOL rdg_send_tunnel_authorization(rdpRdg* rdg)
611 size_t clientNameLen = 0;
613 rdg->context->settings, FreeRDP_ClientHostname, &clientNameLen);
617 const size_t packetSize = 12ull + clientNameLen *
sizeof(WCHAR);
618 if (!clientName || (clientNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
621 s = Stream_New(
nullptr, packetSize);
626 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_AUTH);
627 Stream_Write_UINT16(s, 0);
628 Stream_Write_UINT32(s, (UINT32)packetSize);
629 Stream_Write_UINT16(s, 0);
630 Stream_Write_UINT16(s, (UINT16)clientNameLen *
sizeof(WCHAR));
631 if (!Stream_Write_UTF16_String(s, clientName, clientNameLen))
633 Stream_SealLength(s);
634 status = rdg_write_packet(rdg, s);
637 Stream_Free(s, TRUE);
641 rdg->state = RDG_CLIENT_STATE_TUNNEL_AUTHORIZE;
647static BOOL rdg_send_channel_create(rdpRdg* rdg)
651 WCHAR* serverName =
nullptr;
652 size_t serverNameLen = 0;
656 FreeRDP_ServerHostname, &serverNameLen);
659 const size_t packetSize = 16ull + serverNameLen *
sizeof(WCHAR);
660 if (!serverName || (serverNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
663 s = Stream_New(
nullptr, packetSize);
668 Stream_Write_UINT16(s, PKT_TYPE_CHANNEL_CREATE);
669 Stream_Write_UINT16(s, 0);
670 Stream_Write_UINT32(s, (UINT32)packetSize);
671 Stream_Write_UINT8(s, 1);
672 Stream_Write_UINT8(s, 0);
673 Stream_Write_UINT16(s,
674 (UINT16)rdg->context->settings->ServerPort);
675 Stream_Write_UINT16(s, 3);
676 Stream_Write_UINT16(s, (UINT16)serverNameLen *
sizeof(WCHAR));
677 if (!Stream_Write_UTF16_String(s, serverName, serverNameLen))
680 Stream_SealLength(s);
681 status = rdg_write_packet(rdg, s);
684 Stream_Free(s, TRUE);
687 rdg->state = RDG_CLIENT_STATE_CHANNEL_CREATE;
693static BOOL rdg_set_auth_header(rdpCredsspAuth* auth, HttpRequest* request)
695 const SecBuffer* authToken = credssp_auth_get_output_buffer(auth);
696 char* base64AuthToken =
nullptr;
700 if (authToken->cbBuffer > INT_MAX)
703 base64AuthToken = crypto_base64_encode(authToken->pvBuffer, authToken->cbBuffer);
708 BOOL rc = http_request_set_auth_scheme(request, credssp_auth_pkg_name(auth)) &&
709 http_request_set_auth_param(request, base64AuthToken);
710 free(base64AuthToken);
719WINPR_ATTR_MALLOC(Stream_Free, 1)
720static
wStream* rdg_build_http_request(rdpRdg* rdg, const
char* method,
721 TRANSFER_ENCODING transferEncoding)
724 HttpRequest* request =
nullptr;
725 const char* uri =
nullptr;
730 uri = http_context_get_uri(rdg->http);
731 request = http_request_new();
736 if (!http_request_set_method(request, method) || !http_request_set_uri(request, uri))
741 if (!rdg_set_auth_header(rdg->auth, request))
745 else if (rdg->extAuth == HTTP_EXTENDED_AUTH_BEARER)
747 if (!http_request_set_auth_scheme(request,
"Bearer"))
749 if (!http_request_set_auth_param(request, rdg->context->settings->GatewayHttpExtAuthBearer))
753 if (!http_request_set_transfer_encoding(request, transferEncoding))
756 s = http_request_write(rdg->http, request);
758 http_request_free(request);
761 Stream_SealLength(s);
767static BOOL rdg_recv_auth_token(wLog* log, rdpCredsspAuth* auth, HttpResponse* response,
771 size_t authTokenLength = 0;
772 BYTE* authTokenData =
nullptr;
773 SecBuffer authToken = WINPR_C_ARRAY_INIT;
776 WINPR_ASSERT(pHaveToken);
779 if (!auth || !response)
782 const UINT16 StatusCode = http_response_get_status_code(response);
785 case HTTP_STATUS_DENIED:
787 case HTTP_STATUS_SWITCH_PROTOCOLS:
790 http_response_log_error_status(log, WLOG_WARN, response);
794 const char* token64 = http_response_get_auth_token(response, credssp_auth_pkg_name(auth));
804 len = strlen(token64);
806 crypto_base64_decode(token64, len, &authTokenData, &authTokenLength);
808 if (authTokenLength && authTokenData && (authTokenLength <= UINT32_MAX))
810 authToken.pvBuffer = authTokenData;
811 authToken.cbBuffer = (UINT32)authTokenLength;
812 credssp_auth_take_input_buffer(auth, &authToken);
817 rc = credssp_auth_authenticate(auth);
822static BOOL rdg_skip_seed_payload(rdpContext* context, rdpTls* tls,
size_t lastResponseLength,
823 rdg_http_encoding_context* transferEncoding)
828 const size_t size = 10;
829 if (lastResponseLength < size)
831 wStream* s = Stream_New(
nullptr, size);
834 const BOOL rc = rdg_read_all(context, tls, s, size - lastResponseLength, transferEncoding);
835 Stream_Free(s, TRUE);
843static BOOL rdg_process_handshake_response(rdpRdg* rdg,
wStream* s)
845 UINT32 errorCode = 0;
846 UINT16 serverVersion = 0;
847 UINT16 extendedAuth = 0;
850 const char* error =
nullptr;
851 WLog_Print(rdg->log, WLOG_DEBUG,
"Handshake response received");
853 if (rdg->state != RDG_CLIENT_STATE_HANDSHAKE)
858 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
861 Stream_Read_UINT32(s, errorCode);
862 Stream_Read_UINT8(s, verMajor);
863 Stream_Read_UINT8(s, verMinor);
864 Stream_Read_UINT16(s, serverVersion);
865 Stream_Read_UINT16(s, extendedAuth);
866 error = rpc_error_to_string(errorCode);
867 WLog_Print(rdg->log, WLOG_DEBUG,
868 "errorCode=%s, verMajor=%" PRId8
", verMinor=%" PRId8
", serverVersion=%" PRId16
870 error, verMajor, verMinor, serverVersion, extended_auth_to_string(extendedAuth));
872 if (FAILED((HRESULT)errorCode))
874 WLog_Print(rdg->log, WLOG_ERROR,
"Handshake error %s", error);
875 freerdp_set_last_error_log(rdg->context, errorCode);
879 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
880 return rdg_send_extauth_sspi(rdg);
882 return rdg_send_tunnel_request(rdg);
886static BOOL rdg_process_tunnel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
888 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID)
891 if (!Stream_SafeSeek(s, 4))
893 WLog_Print(rdg->log, WLOG_ERROR,
"Short tunnelId, got %" PRIuz
", expected 4",
894 Stream_GetRemainingLength(s));
899 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CAPS)
902 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
905 Stream_Read_UINT32(s, caps);
906 WLog_Print(rdg->log, WLOG_DEBUG,
"capabilities=%s", capabilities_enum_to_string(caps));
909 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ)
912 if (!Stream_SafeSeek(s, 20))
914 WLog_Print(rdg->log, WLOG_ERROR,
"Short nonce, got %" PRIuz
", expected 20",
915 Stream_GetRemainingLength(s));
920 if (!rdg_read_http_unicode_string(rdg->log, s,
nullptr,
nullptr))
922 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read server certificate");
927 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG)
929 const WCHAR* msg =
nullptr;
930 UINT16 msgLenBytes = 0;
931 rdpContext* context = rdg->context;
933 WINPR_ASSERT(context);
934 WINPR_ASSERT(context->instance);
937 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
939 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read consent message");
943 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
944 GATEWAY_MESSAGE_CONSENT, TRUE, TRUE, msgLenBytes, msg);
951static BOOL rdg_process_tunnel_response(rdpRdg* rdg,
wStream* s)
953 UINT16 serverVersion = 0;
954 UINT16 fieldsPresent = 0;
955 UINT32 errorCode = 0;
956 const char* error =
nullptr;
957 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel response received");
959 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_CREATE)
964 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
967 Stream_Read_UINT16(s, serverVersion);
968 Stream_Read_UINT32(s, errorCode);
969 Stream_Read_UINT16(s, fieldsPresent);
970 Stream_Seek_UINT16(s);
971 error = rpc_error_to_string(errorCode);
972 WLog_Print(rdg->log, WLOG_DEBUG,
"serverVersion=%" PRId16
", errorCode=%s, fieldsPresent=%s",
973 serverVersion, error, tunnel_response_fields_present_to_string(fieldsPresent));
975 if (FAILED((HRESULT)errorCode))
977 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel creation error %s", error);
978 freerdp_set_last_error_log(rdg->context, errorCode);
982 if (!rdg_process_tunnel_response_optional(rdg, s, fieldsPresent))
985 return rdg_send_tunnel_authorization(rdg);
989static BOOL rdg_process_tunnel_authorization_response(rdpRdg* rdg,
wStream* s)
991 UINT32 errorCode = 0;
992 UINT16 fieldsPresent = 0;
993 const char* error =
nullptr;
994 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel authorization received");
996 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_AUTHORIZE)
1001 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1004 Stream_Read_UINT32(s, errorCode);
1005 Stream_Read_UINT16(s, fieldsPresent);
1006 Stream_Seek_UINT16(s);
1007 error = rpc_error_to_string(errorCode);
1008 WLog_Print(rdg->log, WLOG_DEBUG,
"errorCode=%s, fieldsPresent=%s", error,
1009 tunnel_authorization_response_fields_present_to_string(fieldsPresent));
1012 if (errorCode != S_OK && errorCode != E_PROXY_QUARANTINE_ACCESSDENIED)
1014 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel authorization error %s", error);
1015 freerdp_set_last_error_log(rdg->context, errorCode);
1019 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS)
1021 UINT32 redirFlags = 0;
1022 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1024 Stream_Read_UINT32(s, redirFlags);
1026 rdpContext* context = rdg->context;
1027 if (!utils_apply_gateway_policy(rdg->log, context, redirFlags,
"RDG"))
1031 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT)
1033 UINT32 idleTimeout = 0;
1034 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1036 Stream_Read_UINT32(s, idleTimeout);
1037 WLog_Print(rdg->log, WLOG_DEBUG,
"[IDLE_TIMEOUT] idleTimeout=%" PRIu32
": TODO: unused",
1041 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE)
1044 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1046 Stream_Read_UINT16(s, cbLen);
1048 WLog_Print(rdg->log, WLOG_DEBUG,
"[SOH_RESPONSE] cbLen=%" PRIu16
": TODO: unused", cbLen);
1049 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, cbLen))
1051 Stream_Seek(s, cbLen);
1054 return rdg_send_channel_create(rdg);
1058static BOOL rdg_process_extauth_sspi(rdpRdg* rdg,
wStream* s)
1060 INT32 errorCode = 0;
1061 UINT16 authBlobLen = 0;
1062 SecBuffer authToken = WINPR_C_ARRAY_INIT;
1063 BYTE* authTokenData =
nullptr;
1067 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1069 WLog_Print(rdg->log, WLOG_ERROR,
"EXTAUTH_SSPI_NTLM but rdpRdg::extAuth=false");
1073 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 6))
1076 Stream_Read_INT32(s, errorCode);
1077 Stream_Read_UINT16(s, authBlobLen);
1079 if (errorCode != ERROR_SUCCESS)
1081 WLog_Print(rdg->log, WLOG_ERROR,
"EXTAUTH_SSPI_NTLM failed with error %s [0x%08X]",
1082 GetSecurityStatusString(errorCode), WINPR_CXX_COMPAT_CAST(UINT32, errorCode));
1086 if (authBlobLen == 0)
1088 if (credssp_auth_is_complete(rdg->auth))
1090 credssp_auth_free(rdg->auth);
1091 rdg->auth =
nullptr;
1092 return rdg_send_tunnel_request(rdg);
1097 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, authBlobLen))
1100 authTokenData = malloc(authBlobLen);
1101 if (authTokenData ==
nullptr)
1103 Stream_Read(s, authTokenData, authBlobLen);
1105 authToken.pvBuffer = authTokenData;
1106 authToken.cbBuffer = authBlobLen;
1108 credssp_auth_take_input_buffer(rdg->auth, &authToken);
1110 if (credssp_auth_authenticate(rdg->auth) < 0)
1113 if (credssp_auth_have_output_token(rdg->auth))
1114 return rdg_send_extauth_sspi(rdg);
1120static BOOL rdg_process_channel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
1122 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID) != 0)
1124 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1126 const UINT32 channelId = Stream_Get_UINT32(s);
1127 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got channelId=%" PRIu32, channelId);
1129 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT) != 0)
1131 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1133 const UINT16 udpPort = Stream_Get_UINT16(s);
1134 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got udpPort=%" PRIu32, udpPort);
1136 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE) != 0)
1138 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1140 const UINT16 blobLen = Stream_Get_UINT16(s);
1141 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, blobLen))
1143 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got UDP auth blob=%" PRIu32, blobLen);
1144 if (!Stream_SafeSeek(s, blobLen))
1152static BOOL rdg_process_channel_response(rdpRdg* rdg,
wStream* s)
1154 UINT16 fieldsPresent = 0;
1155 UINT32 errorCode = 0;
1156 const char* error =
nullptr;
1157 WLog_Print(rdg->log, WLOG_DEBUG,
"Channel response received");
1159 if (rdg->state != RDG_CLIENT_STATE_CHANNEL_CREATE)
1164 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1167 Stream_Read_UINT32(s, errorCode);
1168 Stream_Read_UINT16(s, fieldsPresent);
1169 Stream_Seek_UINT16(s);
1170 error = rpc_error_to_string(errorCode);
1171 WLog_Print(rdg->log, WLOG_DEBUG,
"channel response errorCode=%s, fieldsPresent=%s", error,
1172 channel_response_fields_present_to_string(fieldsPresent));
1174 if (FAILED((HRESULT)errorCode))
1176 WLog_Print(rdg->log, WLOG_ERROR,
"channel response errorCode=%s, fieldsPresent=%s", error,
1177 channel_response_fields_present_to_string(fieldsPresent));
1178 freerdp_set_last_error_log(rdg->context, errorCode);
1182 if (!rdg_process_channel_response_optional(rdg, s, fieldsPresent))
1185 rdg->state = RDG_CLIENT_STATE_OPENED;
1190static BOOL rdg_process_packet(rdpRdg* rdg,
wStream* s)
1194 UINT32 packetLength = 0;
1195 Stream_ResetPosition(s);
1197 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1200 Stream_Read_UINT16(s, type);
1201 Stream_Seek_UINT16(s);
1202 Stream_Read_UINT32(s, packetLength);
1204 if (Stream_Length(s) < packetLength)
1206 WLog_Print(rdg->log, WLOG_ERROR,
"Short packet %" PRIuz
", expected %" PRIu32,
1207 Stream_Length(s), packetLength);
1213 case PKT_TYPE_HANDSHAKE_RESPONSE:
1214 status = rdg_process_handshake_response(rdg, s);
1217 case PKT_TYPE_TUNNEL_RESPONSE:
1218 status = rdg_process_tunnel_response(rdg, s);
1221 case PKT_TYPE_TUNNEL_AUTH_RESPONSE:
1222 status = rdg_process_tunnel_authorization_response(rdg, s);
1225 case PKT_TYPE_CHANNEL_RESPONSE:
1226 status = rdg_process_channel_response(rdg, s);
1230 WLog_Print(rdg->log, WLOG_ERROR,
"Unexpected packet type DATA");
1234 case PKT_TYPE_EXTENDED_AUTH_MSG:
1235 status = rdg_process_extauth_sspi(rdg, s);
1239 WLog_Print(rdg->log, WLOG_ERROR,
"PKG TYPE 0x%x not implemented", type);
1246 const size_t rem = Stream_GetRemainingLength(s);
1248 WLog_Print(rdg->log, WLOG_WARN,
"[%s] unparsed data detected: %" PRIuz
" bytes",
1249 rdg_pkt_type_to_string(type), rem);
1254DWORD rdg_get_event_handles(rdpRdg* rdg, HANDLE* events, DWORD count)
1257 WINPR_ASSERT(rdg !=
nullptr);
1259 if (rdg->tlsOut && rdg->tlsOut->bio)
1261 if (events && (nCount < count))
1263 BIO_get_event(rdg->tlsOut->bio, &events[nCount]);
1276static BOOL rdg_get_gateway_credentials(rdpContext* context, rdp_auth_reason reason)
1278 freerdp* instance = context->instance;
1280 auth_status rc = utils_authenticate_gateway(instance, reason);
1286 case AUTH_CANCELLED:
1287 freerdp_set_last_error_log(instance->context, FREERDP_ERROR_CONNECT_CANCELLED);
1289 case AUTH_NO_CREDENTIALS:
1290 WLog_INFO(TAG,
"No credentials provided - using nullptr identity");
1299static BOOL rdg_auth_init(rdpRdg* rdg, rdpTls* tls, TCHAR* authPkg)
1301 rdpContext* context = rdg->context;
1302 rdpSettings* settings = context->settings;
1303 SEC_WINNT_AUTH_IDENTITY identity = WINPR_C_ARRAY_INIT;
1306 rdg->auth = credssp_auth_new(context);
1310 if (!credssp_auth_init(rdg->auth, authPkg, tls->Bindings))
1316 if (!smartcard_getCert(context, &rdg->smartcard, TRUE))
1319 if (!rdg_get_gateway_credentials(context, AUTH_SMARTCARD_PIN))
1324 if (!rdg_get_gateway_credentials(context, GW_AUTH_RDG))
1329 if (doSCLogon && !smartcard_getCert(context, &rdg->smartcard, TRUE))
1333 SEC_WINNT_AUTH_IDENTITY* identityArg = &identity;
1336 if (!identity_set_from_smartcard_hash(&identity, settings, FreeRDP_GatewayUsername,
1337 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword,
1338 rdg->smartcard->sha1Hash,
1339 sizeof(rdg->smartcard->sha1Hash)))
1344 if (!identity_set_from_settings(&identity, settings, FreeRDP_GatewayUsername,
1345 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword))
1348 if (!settings->GatewayUsername)
1349 identityArg =
nullptr;
1352 if (!credssp_auth_setup_client(rdg->auth,
"HTTP", settings->GatewayHostname, identityArg,
1353 rdg->smartcard ? rdg->smartcard->pkinitArgs : nullptr))
1355 sspi_FreeAuthIdentity(&identity);
1358 sspi_FreeAuthIdentity(&identity);
1360 credssp_auth_set_flags(rdg->auth, ISC_REQ_CONFIDENTIALITY | ISC_REQ_MUTUAL_AUTH);
1362 rc = credssp_auth_authenticate(rdg->auth);
1367static BOOL rdg_send_http_request(rdpRdg* rdg, rdpTls* tls,
const char* method,
1368 TRANSFER_ENCODING transferEncoding)
1371 wStream* s = rdg_build_http_request(rdg, method, transferEncoding);
1376 const size_t sz = Stream_Length(s);
1377 status = freerdp_tls_write_all(tls, Stream_Buffer(s), sz);
1379 Stream_Free(s, TRUE);
1380 return (status >= 0);
1384static BOOL rdg_tls_connect(rdpRdg* rdg, rdpTls* tls,
const char* peerAddress, UINT32 timeout)
1387 BIO* layerBio =
nullptr;
1388 BIO* bufferedBio =
nullptr;
1390 rdpSettings* settings = rdg->context->settings;
1391 rdpTransport* transport = freerdp_get_transport(rdg->context);
1392 const char* peerHostname = settings->GatewayHostname;
1393 UINT16 peerPort = (UINT16)settings->GatewayPort;
1394 const char* proxyUsername =
nullptr;
1395 const char* proxyPassword =
nullptr;
1396 BOOL isProxyConnection =
1397 proxy_prepare(settings, &peerHostname, &peerPort, &proxyUsername, &proxyPassword);
1399 if (settings->GatewayPort > UINT16_MAX)
1402 layer = transport_connect_layer(transport, peerAddress ? peerAddress : peerHostname, peerPort,
1410 layerBio = BIO_new(BIO_s_transport_layer());
1413 transport_layer_free(layer);
1416 BIO_set_data(layerBio, layer);
1418 bufferedBio = BIO_new(BIO_s_buffered_socket());
1421 BIO_free_all(layerBio);
1425 bufferedBio = BIO_push(bufferedBio, layerBio);
1426 status = BIO_set_nonblock(bufferedBio, TRUE);
1428 if (isProxyConnection)
1430 if (!proxy_connect(rdg->context, bufferedBio, proxyUsername, proxyPassword,
1431 settings->GatewayHostname, (UINT16)settings->GatewayPort))
1433 BIO_free_all(bufferedBio);
1440 BIO_free_all(bufferedBio);
1444 tls->hostname = settings->GatewayHostname;
1445 tls->port = WINPR_ASSERTING_INT_CAST(int32_t, MIN(UINT16_MAX, settings->GatewayPort));
1446 tls->isGatewayTransport = TRUE;
1447 status = freerdp_tls_connect(tls, bufferedBio);
1450 rdpContext* context = rdg->context;
1453 freerdp_set_last_error_if_not(context, FREERDP_ERROR_TLS_CONNECT_FAILED);
1457 freerdp_set_last_error_if_not(context, FREERDP_ERROR_CONNECT_CANCELLED);
1462 return (status >= 1);
1466static BOOL rdg_establish_data_connection(rdpRdg* rdg, rdpTls* tls,
const char* method,
1467 const char* peerAddress, UINT32 timeout,
1470 char buffer[64] = WINPR_C_ARRAY_INIT;
1471 HttpResponse* response =
nullptr;
1473 if (!rdg_tls_connect(rdg, tls, peerAddress, timeout))
1476 WINPR_ASSERT(rpcFallback);
1477 if (rdg->context->settings->GatewayHttpExtAuthBearer && rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1478 rdg->extAuth = HTTP_EXTENDED_AUTH_BEARER;
1479 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1481 if (!rdg_auth_init(rdg, tls, AUTH_PKG))
1484 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1487 response = http_response_recv(tls, TRUE);
1492 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1493 *rpcFallback = TRUE;
1497 (void)http_response_extract_cookies(response, rdg->http);
1499 const UINT16 StatusCode = http_response_get_status_code(response);
1502 case HTTP_STATUS_GONE:
1503 case HTTP_STATUS_FORBIDDEN:
1504 case HTTP_STATUS_NOT_FOUND:
1506 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway does not support HTTP transport.");
1507 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1508 *rpcFallback = TRUE;
1510 http_response_free(response);
1513 case HTTP_STATUS_OK:
1516 case HTTP_STATUS_DENIED:
1517 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1521 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1525 while (!credssp_auth_is_complete(rdg->auth))
1527 BOOL haveToken = FALSE;
1529 if (!rdg_recv_auth_token(rdg->log, rdg->auth, response, &haveToken))
1531 http_response_free(response);
1546 WLog_Print(rdg->log, WLOG_DEBUG,
1547 "No authentication token in the response, ending the exchange");
1551 if (credssp_auth_have_output_token(rdg->auth))
1553 http_response_free(response);
1555 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1558 response = http_response_recv(tls, TRUE);
1561 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1562 *rpcFallback = TRUE;
1565 (void)http_response_extract_cookies(response, rdg->http);
1570 credssp_auth_free(rdg->auth);
1571 rdg->auth =
nullptr;
1575 credssp_auth_free(rdg->auth);
1576 rdg->auth =
nullptr;
1578 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1581 response = http_response_recv(tls, TRUE);
1585 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1586 *rpcFallback = TRUE;
1589 (void)http_response_extract_cookies(response, rdg->http);
1592 const UINT16 statusCode = http_response_get_status_code(response);
1593 const size_t bodyLength = http_response_get_body_length(response);
1594 const TRANSFER_ENCODING encoding = http_response_get_transfer_encoding(response);
1595 const BOOL isWebsocket = http_response_is_websocket(rdg->http, response);
1597 WLog_Print(rdg->log, WLOG_DEBUG,
"%s authorization result: %s", method,
1598 freerdp_http_status_string_format(statusCode, buffer, ARRAYSIZE(buffer)));
1602 case HTTP_STATUS_OK:
1605 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1606 http_response_free(response);
1608 case HTTP_STATUS_DENIED:
1609 freerdp_set_last_error_log(rdg->context, FREERDP_ERROR_CONNECT_ACCESS_DENIED);
1610 http_response_free(response);
1612 case HTTP_STATUS_SWITCH_PROTOCOLS:
1613 http_response_free(response);
1620 if (http_context_is_websocket_upgrade_enabled(rdg->http))
1622 long fd = BIO_get_fd(tls->bio,
nullptr);
1624 closesocket((SOCKET)fd);
1625 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1626 return rdg_establish_data_connection(rdg, tls, method, peerAddress, timeout,
1632 rdg->transferEncoding.isWebsocketTransport = TRUE;
1633 if (!websocket_context_reset(rdg->transferEncoding.websocket))
1636 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1640 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1645 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1646 http_response_free(response);
1650 if (strcmp(method,
"RDG_OUT_DATA") == 0)
1652 if (encoding == TransferEncodingChunked)
1654 rdg->transferEncoding.httpTransferEncoding = TransferEncodingChunked;
1655 rdg->transferEncoding.chunked.nextOffset = 0;
1656 rdg->transferEncoding.chunked.headerFooterPos = 0;
1657 rdg->transferEncoding.chunked.state = ChunkStateLenghHeader;
1659 if (!rdg_skip_seed_payload(rdg->context, tls, bodyLength, &rdg->transferEncoding))
1666 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingChunked))
1669 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1673 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1682static BOOL rdg_tunnel_connect(rdpRdg* rdg)
1684 if (!rdg_send_handshake(rdg))
1687 while (rdg->state < RDG_CLIENT_STATE_OPENED)
1689 BOOL status = FALSE;
1690 wStream* s = rdg_receive_packet(rdg);
1694 status = rdg_process_packet(rdg, s);
1695 Stream_Free(s, TRUE);
1701 WINPR_ASSERT(rdg->context);
1702 WINPR_ASSERT(rdg->context->rdp);
1703 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1711BOOL rdg_connect(rdpRdg* rdg, DWORD timeout, BOOL* rpcFallback)
1714 SOCKET outConnSocket = 0;
1715 char* peerAddress =
nullptr;
1716 BOOL rpcFallbackLocal = FALSE;
1718 WINPR_ASSERT(rdg !=
nullptr);
1719 freerdp_set_last_error(rdg->context, ERROR_SUCCESS);
1720 status = rdg_establish_data_connection(rdg, rdg->tlsOut,
"RDG_OUT_DATA",
nullptr, timeout,
1725 if (rdg->transferEncoding.isWebsocketTransport)
1727 WLog_Print(rdg->log, WLOG_DEBUG,
"Upgraded to websocket. RDG_IN_DATA not required");
1734 BIO_get_socket(rdg->tlsOut->underlying, &outConnSocket);
1735 peerAddress = freerdp_tcp_get_peer_address(outConnSocket);
1736 status = rdg_establish_data_connection(rdg, rdg->tlsIn,
"RDG_IN_DATA", peerAddress,
1737 timeout, &rpcFallbackLocal);
1743 *rpcFallback = rpcFallbackLocal;
1748 WINPR_ASSERT(rdg->context);
1749 WINPR_ASSERT(rdg->context->rdp);
1750 if (rpcFallbackLocal)
1752 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1753 credssp_auth_free(rdg->auth);
1754 rdg->auth =
nullptr;
1757 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1761 status = rdg_tunnel_connect(rdg);
1767static int rdg_write_websocket_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1773 const size_t payloadSize = (size_t)isize + 10;
1781 websocket_context_packet_new(payloadSize, WebsocketBinaryOpcode, &maskingKey.u32);
1785 Stream_Write_UINT16(
1786 sWS, WINPR_ASSERTING_INT_CAST(
1787 uint16_t, PKT_TYPE_DATA ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1788 Stream_Write_UINT16(
1789 sWS, WINPR_ASSERTING_INT_CAST(
1790 uint16_t, 0 ^ (maskingKey.u8[2] | maskingKey.u8[3] << 8)));
1791 Stream_Write_UINT32(
1792 sWS, WINPR_ASSERTING_INT_CAST(uint32_t, payloadSize ^ maskingKey.u32));
1793 Stream_Write_UINT16(
1794 sWS, WINPR_ASSERTING_INT_CAST(
1795 uint16_t, isize ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1798 maskingKey.u32 = (maskingKey.u32 & 0xffff) << 16 | (maskingKey.u32 >> 16);
1800 WINPR_ASSERT(rdg->tlsOut);
1801 wStream sPacket = WINPR_C_ARRAY_INIT;
1802 Stream_StaticConstInit(&sPacket, buf, (
size_t)isize);
1803 if (!websocket_context_mask_and_send(rdg->tlsOut->bio, sWS, &sPacket, maskingKey.u32))
1810static int rdg_write_chunked_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1816 if (isize > UINT16_MAX)
1819 const size_t size = (size_t)isize;
1823 const size_t packetSize = size + 10;
1824 char chunkSize[11] = WINPR_C_ARRAY_INIT;
1825 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIxz
"\r\n", packetSize);
1826 sChunk = Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + packetSize + 2);
1831 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
1832 Stream_Write_UINT16(sChunk, PKT_TYPE_DATA);
1833 Stream_Write_UINT16(sChunk, 0);
1834 Stream_Write_UINT32(sChunk, (UINT32)packetSize);
1835 Stream_Write_UINT16(sChunk, (UINT16)size);
1836 Stream_Write(sChunk, buf, size);
1837 Stream_Write(sChunk,
"\r\n", 2);
1838 Stream_SealLength(sChunk);
1839 len = Stream_Length(sChunk);
1841 status = freerdp_tls_write_all(rdg->tlsIn, Stream_Buffer(sChunk), len);
1842 Stream_Free(sChunk, TRUE);
1851static int rdg_write_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1854 if (rdg->transferEncoding.isWebsocketTransport)
1855 return rdg_write_websocket_data_packet(rdg, buf, isize);
1857 return rdg_write_chunked_data_packet(rdg, buf, isize);
1861static BOOL rdg_process_close_packet(rdpRdg* rdg,
wStream* s)
1865 UINT32 errorCode = 0;
1866 UINT32 packetSize = 12;
1869 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1871 Stream_Read_UINT32(s, errorCode);
1874 freerdp_set_last_error_log(rdg->context, errorCode);
1876 sClose = Stream_New(
nullptr, packetSize);
1880 Stream_Write_UINT16(sClose, PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
1881 Stream_Write_UINT16(sClose, 0);
1882 Stream_Write_UINT32(sClose, packetSize);
1883 Stream_Write_UINT32(sClose, 0);
1884 Stream_SealLength(sClose);
1885 status = rdg_write_packet(rdg, sClose);
1886 Stream_Free(sClose, TRUE);
1888 return ((status >= 0));
1892static BOOL rdg_process_keep_alive_packet(rdpRdg* rdg)
1895 wStream* sKeepAlive =
nullptr;
1896 size_t packetSize = 8;
1898 sKeepAlive = Stream_New(
nullptr, packetSize);
1903 Stream_Write_UINT16(sKeepAlive, PKT_TYPE_KEEPALIVE);
1904 Stream_Write_UINT16(sKeepAlive, 0);
1905 Stream_Write_UINT32(sKeepAlive, (UINT32)packetSize);
1906 Stream_SealLength(sKeepAlive);
1907 status = rdg_write_packet(rdg, sKeepAlive);
1908 Stream_Free(sKeepAlive, TRUE);
1910 return ((status >= 0));
1914static BOOL rdg_process_service_message(rdpRdg* rdg,
wStream* s)
1916 const WCHAR* msg =
nullptr;
1917 UINT16 msgLenBytes = 0;
1918 rdpContext* context = rdg->context;
1919 WINPR_ASSERT(context);
1920 WINPR_ASSERT(context->instance);
1923 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
1925 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read string");
1929 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
1930 GATEWAY_MESSAGE_SERVICE, TRUE, FALSE, msgLenBytes, msg);
1934static BOOL rdg_process_unknown_packet(rdpRdg* rdg,
int type)
1938 WLog_Print(rdg->log, WLOG_WARN,
"Unknown Control Packet received: %" PRIX32,
1939 WINPR_CXX_COMPAT_CAST(UINT32, type));
1944static BOOL rdg_process_control_packet(rdpRdg* rdg,
int type,
size_t packetLength)
1947 size_t readCount = 0;
1949 size_t payloadSize = packetLength -
sizeof(RdgPacketHeader);
1951 if (packetLength <
sizeof(RdgPacketHeader))
1955 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1959 s = Stream_New(
nullptr, payloadSize);
1964 while (readCount < payloadSize)
1966 if (rdg_shall_abort(rdg))
1968 Stream_Free(s, TRUE);
1971 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context, Stream_Pointer(s),
1972 payloadSize - readCount, &rdg->transferEncoding);
1976 if (!BIO_should_retry(rdg->tlsOut->bio))
1978 Stream_Free(s, TRUE);
1982 BIO_wait_read(rdg->tlsOut->bio, 50);
1986 Stream_Seek(s, (
size_t)status);
1987 readCount += (size_t)status;
1989 if (readCount > INT_MAX)
1991 Stream_Free(s, TRUE);
1996 Stream_ResetPosition(s);
2001 case PKT_TYPE_CLOSE_CHANNEL:
2004 WLog_Print(rdg->log, WLOG_ERROR,
2005 "PKT_TYPE_CLOSE_CHANNEL requires payload but none was sent");
2008 EnterCriticalSection(&rdg->writeSection);
2009 status = rdg_process_close_packet(rdg, s);
2010 LeaveCriticalSection(&rdg->writeSection);
2013 case PKT_TYPE_KEEPALIVE:
2014 EnterCriticalSection(&rdg->writeSection);
2015 status = rdg_process_keep_alive_packet(rdg);
2016 LeaveCriticalSection(&rdg->writeSection);
2019 case PKT_TYPE_SERVICE_MESSAGE:
2022 WLog_Print(rdg->log, WLOG_ERROR,
2023 "PKT_TYPE_SERVICE_MESSAGE requires payload but none was sent");
2026 status = rdg_process_service_message(rdg, s);
2029 case PKT_TYPE_REAUTH_MESSAGE:
2031 status = rdg_process_unknown_packet(rdg, type);
2035 Stream_Free(s, TRUE);
2040static int rdg_read_data_packet(rdpRdg* rdg, BYTE* buffer,
size_t size)
2042 RdgPacketHeader header = WINPR_C_ARRAY_INIT;
2043 size_t readCount = 0;
2044 size_t readSize = 0;
2047 if (!rdg->packetRemainingCount)
2050 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
2052 while (rdg->nextHeaderLengthRead <
sizeof(RdgPacketHeader))
2054 if (rdg_shall_abort(rdg))
2057 status = rdg_socket_read(
2058 rdg->tlsOut->bio, rdg->context, &rdg->nextHeader[rdg->nextHeaderLengthRead],
2059 sizeof(RdgPacketHeader) - rdg->nextHeaderLengthRead, &rdg->transferEncoding);
2068 if (BIO_should_retry(rdg->tlsOut->bio))
2074 if ((
size_t)status >
sizeof(RdgPacketHeader) - rdg->nextHeaderLengthRead)
2076 rdg->nextHeaderLengthRead += (size_t)status;
2079 WINPR_STATIC_ASSERT(
sizeof(RdgPacketHeader) ==
sizeof(rdg->nextHeader));
2080 if (rdg->nextHeaderLengthRead ==
sizeof(RdgPacketHeader))
2081 memcpy(&header, rdg->nextHeader,
sizeof(header));
2083 if (header.type != PKT_TYPE_DATA)
2085 status = rdg_process_control_packet(rdg, header.type, header.packetLength);
2090 rdg->nextHeaderLengthRead = 0;
2096 while (readCount < 2)
2098 if (rdg_shall_abort(rdg))
2100 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context,
2101 (BYTE*)(&rdg->packetRemainingCount) + readCount, 2 - readCount,
2102 &rdg->transferEncoding);
2106 if (!BIO_should_retry(rdg->tlsOut->bio))
2109 BIO_wait_read(rdg->tlsOut->bio, 50);
2113 readCount += (size_t)status;
2116 rdg->nextHeaderLengthRead = 0;
2119 readSize = (rdg->packetRemainingCount < size) ? rdg->packetRemainingCount : size;
2121 rdg_socket_read(rdg->tlsOut->bio, rdg->context, buffer, readSize, &rdg->transferEncoding);
2125 if (!BIO_should_retry(rdg->tlsOut->bio))
2131 rdg->packetRemainingCount -= status;
2136static int rdg_bio_write(BIO* bio,
const char* buf,
int num)
2139 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2143 BIO_clear_flags(bio, BIO_FLAGS_WRITE);
2144 EnterCriticalSection(&rdg->writeSection);
2145 status = rdg_write_data_packet(rdg, (
const BYTE*)buf, num);
2146 LeaveCriticalSection(&rdg->writeSection);
2150 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2153 else if (status < num)
2155 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2156 WSASetLastError(WSAEWOULDBLOCK);
2160 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2167static int rdg_bio_read(BIO* bio,
char* buf,
int size)
2170 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2173 status = rdg_read_data_packet(rdg, (BYTE*)buf, (
size_t)size);
2177 BIO_clear_retry_flags(bio);
2180 else if (status == 0)
2182 BIO_set_retry_read(bio);
2183 WSASetLastError(WSAEWOULDBLOCK);
2188 BIO_set_flags(bio, BIO_FLAGS_READ);
2195static int rdg_bio_puts(BIO* bio,
const char* str)
2204static int rdg_bio_gets(BIO* bio,
char* str,
int size)
2213static long rdg_bio_ctrl(BIO* in_bio,
int cmd,
long arg1,
void* arg2)
2216 rdpRdg* rdg = (rdpRdg*)BIO_get_data(in_bio);
2217 rdpTls* tlsOut = rdg->tlsOut;
2218 rdpTls* tlsIn = rdg->tlsIn;
2220 if (cmd == BIO_CTRL_FLUSH)
2222 (void)BIO_flush(tlsOut->bio);
2223 if (!rdg->transferEncoding.isWebsocketTransport)
2224 (void)BIO_flush(tlsIn->bio);
2227 else if (cmd == BIO_C_SET_NONBLOCK)
2231 else if (cmd == BIO_C_READ_BLOCKED)
2233 BIO* cbio = tlsOut->bio;
2234 status = BIO_read_blocked(cbio);
2236 else if (cmd == BIO_C_WRITE_BLOCKED)
2238 BIO* cbio = tlsIn->bio;
2240 if (rdg->transferEncoding.isWebsocketTransport)
2243 status = BIO_write_blocked(cbio);
2245 else if (cmd == BIO_C_WAIT_READ)
2247 int timeout = (int)arg1;
2248 BIO* cbio = tlsOut->bio;
2250 if (BIO_read_blocked(cbio))
2251 return BIO_wait_read(cbio, timeout);
2252 else if (BIO_write_blocked(cbio))
2253 return BIO_wait_write(cbio, timeout);
2257 else if (cmd == BIO_C_WAIT_WRITE)
2259 int timeout = (int)arg1;
2260 BIO* cbio = tlsIn->bio;
2262 if (rdg->transferEncoding.isWebsocketTransport)
2265 if (BIO_write_blocked(cbio))
2266 status = BIO_wait_write(cbio, timeout);
2267 else if (BIO_read_blocked(cbio))
2268 status = BIO_wait_read(cbio, timeout);
2272 else if (cmd == BIO_C_GET_EVENT || cmd == BIO_C_GET_FD)
2282 status = BIO_ctrl(tlsOut->bio, cmd, arg1, arg2);
2284#if OPENSSL_VERSION_NUMBER >= 0x30000000L
2285 else if (cmd == BIO_CTRL_GET_KTLS_SEND)
2293 else if (cmd == BIO_CTRL_GET_KTLS_RECV)
2305static int rdg_bio_new(BIO* bio)
2307 BIO_set_init(bio, 1);
2308 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2313static int rdg_bio_free(BIO* bio)
2320static BIO_METHOD* BIO_s_rdg(
void)
2322 static BIO_METHOD* bio_methods =
nullptr;
2324 if (bio_methods ==
nullptr)
2326 if (!(bio_methods = BIO_meth_new(BIO_TYPE_TSG,
"RDGateway")))
2329 BIO_meth_set_write(bio_methods, rdg_bio_write);
2330 BIO_meth_set_read(bio_methods, rdg_bio_read);
2331 BIO_meth_set_puts(bio_methods, rdg_bio_puts);
2332 BIO_meth_set_gets(bio_methods, rdg_bio_gets);
2333 BIO_meth_set_ctrl(bio_methods, rdg_bio_ctrl);
2334 BIO_meth_set_create(bio_methods, rdg_bio_new);
2335 BIO_meth_set_destroy(bio_methods, rdg_bio_free);
2341rdpRdg* rdg_new(rdpContext* context)
2346 rdpRdg* rdg = (rdpRdg*)calloc(1,
sizeof(rdpRdg));
2350 rdg->log = WLog_Get(TAG);
2351 rdg->state = RDG_CLIENT_STATE_INITIAL;
2352 rdg->context = context;
2353 rdpSettings* settings = rdg->context->settings;
2354 rdg->extAuth = (settings->GatewayHttpExtAuthSspiNtlm ? HTTP_EXTENDED_AUTH_SSPI_NTLM
2355 : HTTP_EXTENDED_AUTH_NONE);
2357 if (settings->GatewayAccessToken)
2358 rdg->extAuth = HTTP_EXTENDED_AUTH_PAA;
2360 rdg->tlsOut = freerdp_tls_new(rdg->context);
2363 goto rdg_alloc_error;
2365 rdg->tlsIn = freerdp_tls_new(rdg->context);
2368 goto rdg_alloc_error;
2370 rdg->http = http_context_new();
2373 goto rdg_alloc_error;
2375 GUID guid = WINPR_C_ARRAY_INIT;
2376 if (UuidFromStringA(settings->CorrelationId, &guid) != RPC_S_OK)
2377 goto rdg_alloc_error;
2379 if (!http_context_set_uri(rdg->http,
"/remoteDesktopGateway/") ||
2380 !http_context_set_accept(rdg->http,
"*/*") ||
2381 !http_context_set_cache_control(rdg->http,
"no-cache") ||
2382 !http_context_set_pragma(rdg->http,
"no-cache") ||
2383 !http_context_set_connection(rdg->http,
"Keep-Alive") ||
2384 !http_context_set_user_agent(rdg->http,
"MS-RDGateway/1.0") ||
2385 !http_context_set_host(rdg->http, rdg->context->settings->GatewayHostname) ||
2386 !http_context_set_rdg_connection_id(rdg->http) ||
2387 !http_context_set_rdg_correlation_id(rdg->http, &guid) ||
2388 !http_context_enable_websocket_upgrade(
2392 goto rdg_alloc_error;
2395 if (rdg->extAuth != HTTP_EXTENDED_AUTH_NONE)
2397 switch (rdg->extAuth)
2399 case HTTP_EXTENDED_AUTH_PAA:
2400 if (!http_context_set_rdg_auth_scheme(rdg->http,
"PAA"))
2401 goto rdg_alloc_error;
2405 case HTTP_EXTENDED_AUTH_SSPI_NTLM:
2406 if (!http_context_set_rdg_auth_scheme(rdg->http,
"SSPI_NTLM"))
2407 goto rdg_alloc_error;
2412 WLog_Print(rdg->log, WLOG_DEBUG,
2413 "RDG extended authentication method %d not supported", rdg->extAuth);
2417 rdg->frontBio = BIO_new(BIO_s_rdg());
2420 goto rdg_alloc_error;
2422 BIO_set_data(rdg->frontBio, rdg);
2423 InitializeCriticalSection(&rdg->writeSection);
2425 rdg->transferEncoding.httpTransferEncoding = TransferEncodingIdentity;
2426 rdg->transferEncoding.isWebsocketTransport = FALSE;
2428 rdg->transferEncoding.websocket = websocket_context_new();
2429 if (!rdg->transferEncoding.websocket)
2430 goto rdg_alloc_error;
2434 WINPR_PRAGMA_DIAG_PUSH
2435 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2437 WINPR_PRAGMA_DIAG_POP
2441void rdg_free(rdpRdg* rdg)
2446 freerdp_tls_free(rdg->tlsOut);
2447 freerdp_tls_free(rdg->tlsIn);
2448 http_context_free(rdg->http);
2449 credssp_auth_free(rdg->auth);
2452 BIO_free_all(rdg->frontBio);
2454 DeleteCriticalSection(&rdg->writeSection);
2456 smartcardCertInfo_Free(rdg->smartcard);
2458 websocket_context_free(rdg->transferEncoding.websocket);
2463BIO* rdg_get_front_bio_and_take_ownership(rdpRdg* rdg)
2468 rdg->attached = TRUE;
2469 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.