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" }
210static const char* rdg_pkt_type_to_string(
int type)
218 ENTRY(PKT_TYPE_HANDSHAKE_REQUEST);
219 ENTRY(PKT_TYPE_HANDSHAKE_RESPONSE);
220 ENTRY(PKT_TYPE_EXTENDED_AUTH_MSG);
221 ENTRY(PKT_TYPE_TUNNEL_CREATE);
222 ENTRY(PKT_TYPE_TUNNEL_RESPONSE);
223 ENTRY(PKT_TYPE_TUNNEL_AUTH);
224 ENTRY(PKT_TYPE_TUNNEL_AUTH_RESPONSE);
225 ENTRY(PKT_TYPE_CHANNEL_CREATE);
226 ENTRY(PKT_TYPE_CHANNEL_RESPONSE);
227 ENTRY(PKT_TYPE_DATA);
228 ENTRY(PKT_TYPE_SERVICE_MESSAGE);
229 ENTRY(PKT_TYPE_REAUTH_MESSAGE);
230 ENTRY(PKT_TYPE_KEEPALIVE);
231 ENTRY(PKT_TYPE_CLOSE_CHANNEL);
232 ENTRY(PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
234 return "PKT_TYPE_UNKNOWN";
239static const char* flags_to_string(UINT32 flags,
const t_flag_mapping* map,
size_t elements)
241 static char buffer[1024] = WINPR_C_ARRAY_INIT;
242 char fields[12] = WINPR_C_ARRAY_INIT;
244 for (
size_t x = 0; x < elements; x++)
246 const t_flag_mapping* cur = &map[x];
248 if ((cur->code & flags) != 0)
249 winpr_str_append(cur->name, buffer,
sizeof(buffer),
"|");
252 (void)sprintf_s(fields, ARRAYSIZE(fields),
" [%04" PRIx32
"]", flags);
253 winpr_str_append(fields, buffer,
sizeof(buffer),
nullptr);
257static const char* channel_response_fields_present_to_string(UINT16 fieldsPresent)
259 return flags_to_string(fieldsPresent, channel_response_fields_present,
260 ARRAYSIZE(channel_response_fields_present));
263static const char* tunnel_response_fields_present_to_string(UINT16 fieldsPresent)
265 return flags_to_string(fieldsPresent, tunnel_response_fields_present,
266 ARRAYSIZE(tunnel_response_fields_present));
269static const char* tunnel_authorization_response_fields_present_to_string(UINT16 fieldsPresent)
271 return flags_to_string(fieldsPresent, tunnel_authorization_response_fields_present,
272 ARRAYSIZE(tunnel_authorization_response_fields_present));
275static const char* extended_auth_to_string(UINT16 auth)
277 if (auth == HTTP_EXTENDED_AUTH_NONE)
278 return "HTTP_EXTENDED_AUTH_NONE [0x0000]";
280 return flags_to_string(auth, extended_auth, ARRAYSIZE(extended_auth));
283static const char* capabilities_enum_to_string(UINT32 capabilities)
285 return flags_to_string(capabilities, capabilities_enum, ARRAYSIZE(capabilities_enum));
288static BOOL rdg_read_http_unicode_string(wLog* log,
wStream* s,
const WCHAR**
string,
289 UINT16* lengthInBytes)
291 UINT16 strLenBytes = 0;
292 size_t rem = Stream_GetRemainingLength(s);
295 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 4))
297 WLog_Print(log, WLOG_ERROR,
"Could not read stream length, only have %" PRIuz
" bytes",
301 Stream_Read_UINT16(s, strLenBytes);
304 const WCHAR* str = Stream_ConstPointer(s);
307 if (!Stream_SafeSeek(s, strLenBytes))
309 WLog_Print(log, WLOG_ERROR,
310 "Could not read stream data, only have %" PRIuz
" bytes, expected %" PRIu16,
311 rem - 4, strLenBytes);
319 *lengthInBytes = strLenBytes;
324static BOOL rdg_write_chunked(BIO* bio,
wStream* sPacket)
330 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIXz
"\r\n", Stream_Length(sPacket));
332 Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + Stream_Length(sPacket) + 2);
337 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
338 Stream_Write(sChunk, Stream_Buffer(sPacket), Stream_Length(sPacket));
339 Stream_Write(sChunk,
"\r\n", 2);
340 Stream_SealLength(sChunk);
341 len = Stream_Length(sChunk);
345 Stream_Free(sChunk, TRUE);
350 status = BIO_write(bio, Stream_Buffer(sChunk), (
int)len);
351 Stream_Free(sChunk, TRUE);
353 return (status == (SSIZE_T)len);
356static BOOL rdg_write_packet(rdpRdg* rdg,
wStream* sPacket)
358 if (rdg->transferEncoding.isWebsocketTransport)
359 return websocket_context_write_wstream(rdg->transferEncoding.context.websocket,
360 rdg->tlsOut->bio, sPacket, WebsocketBinaryOpcode);
362 return rdg_write_chunked(rdg->tlsIn->bio, sPacket);
365static int rdg_socket_read(BIO* bio, BYTE* pBuffer,
size_t size,
366 rdg_http_encoding_context* encodingContext)
368 WINPR_ASSERT(encodingContext !=
nullptr);
369 if (size > INT32_MAX)
372 if (encodingContext->isWebsocketTransport)
373 return websocket_context_read(encodingContext->context.websocket, bio, pBuffer, size);
375 switch (encodingContext->httpTransferEncoding)
377 case TransferEncodingIdentity:
379 return BIO_read(bio, pBuffer, (
int)size);
380 case TransferEncodingChunked:
381 return http_chuncked_read(bio, pBuffer, size, &encodingContext->context.chunked);
387static BOOL rdg_shall_abort(rdpRdg* rdg)
390 return freerdp_shall_disconnect_context(rdg->context);
393static BOOL rdg_read_all(rdpContext* context, rdpTls* tls, BYTE* buffer,
size_t size,
394 rdg_http_encoding_context* transferEncoding)
396 size_t readCount = 0;
397 BYTE* pBuffer = buffer;
399 while (readCount < size)
401 if (freerdp_shall_disconnect_context(context))
404 int status = rdg_socket_read(tls->bio, pBuffer, size - readCount, transferEncoding);
407 if (!BIO_should_retry(tls->bio))
414 readCount += WINPR_ASSERTING_INT_CAST(uint32_t, status);
415 pBuffer += WINPR_ASSERTING_INT_CAST(uint32_t, status);
421static wStream* rdg_receive_packet(rdpRdg* rdg)
423 const size_t header =
sizeof(RdgPacketHeader);
424 size_t packetLength = 0;
425 wStream* s = Stream_New(
nullptr, 1024);
430 if (!rdg_read_all(rdg->context, rdg->tlsOut, Stream_Buffer(s), header, &rdg->transferEncoding))
434 Stream_Read_UINT32(s, packetLength);
436 if ((packetLength > INT_MAX) || !Stream_EnsureCapacity(s, packetLength) ||
437 (packetLength < header))
440 if (!rdg_read_all(rdg->context, rdg->tlsOut, Stream_Buffer(s) + header, packetLength - header,
441 &rdg->transferEncoding))
444 if (!Stream_SetLength(s, packetLength))
449 Stream_Free(s, TRUE);
453static BOOL rdg_send_handshake(rdpRdg* rdg)
456 wStream* s = Stream_New(
nullptr, 14);
461 Stream_Write_UINT16(s, PKT_TYPE_HANDSHAKE_REQUEST);
462 Stream_Write_UINT16(s, 0);
463 Stream_Write_UINT32(s, 14);
464 Stream_Write_UINT8(s, 1);
465 Stream_Write_UINT8(s, 0);
466 Stream_Write_UINT16(s, 0);
467 Stream_Write_UINT16(s, rdg->extAuth);
468 Stream_SealLength(s);
469 status = rdg_write_packet(rdg, s);
470 Stream_Free(s, TRUE);
474 rdg->state = RDG_CLIENT_STATE_HANDSHAKE;
480static BOOL rdg_send_extauth_sspi(rdpRdg* rdg)
484 UINT32 packetSize = 8 + 4 + 2;
488 const SecBuffer* authToken = credssp_auth_get_output_buffer(rdg->auth);
491 packetSize += authToken->cbBuffer;
493 s = Stream_New(
nullptr, packetSize);
498 Stream_Write_UINT16(s, PKT_TYPE_EXTENDED_AUTH_MSG);
499 Stream_Write_UINT16(s, 0);
500 Stream_Write_UINT32(s, packetSize);
501 Stream_Write_UINT32(s, ERROR_SUCCESS);
502 Stream_Write_UINT16(s, (UINT16)authToken->cbBuffer);
503 Stream_Write(s, authToken->pvBuffer, authToken->cbBuffer);
505 Stream_SealLength(s);
506 status = rdg_write_packet(rdg, s);
507 Stream_Free(s, TRUE);
512static BOOL rdg_send_tunnel_request(rdpRdg* rdg)
516 UINT32 packetSize = 16;
517 UINT16 fieldsPresent = 0;
518 WCHAR* PAACookie =
nullptr;
519 size_t PAACookieLen = 0;
520 const UINT32 capabilities = HTTP_CAPABILITY_TYPE_QUAR_SOH |
521 HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN |
522 HTTP_CAPABILITY_MESSAGING_SERVICE_MSG;
524 if (rdg->extAuth == HTTP_EXTENDED_AUTH_PAA)
527 ConvertUtf8ToWCharAlloc(rdg->context->settings->GatewayAccessToken, &PAACookieLen);
529 if (!PAACookie || (PAACookieLen > UINT16_MAX /
sizeof(WCHAR)))
533 packetSize += 2 + (UINT32)(PAACookieLen) *
sizeof(WCHAR);
534 fieldsPresent = HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE;
537 s = Stream_New(
nullptr, packetSize);
542 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_CREATE);
543 Stream_Write_UINT16(s, 0);
544 Stream_Write_UINT32(s, packetSize);
545 Stream_Write_UINT32(s, capabilities);
546 Stream_Write_UINT16(s, fieldsPresent);
547 Stream_Write_UINT16(s, 0);
551 Stream_Write_UINT16(s, (UINT16)PAACookieLen *
sizeof(WCHAR));
552 if (!Stream_Write_UTF16_String(s, PAACookie, PAACookieLen))
556 Stream_SealLength(s);
557 status = rdg_write_packet(rdg, s);
560 Stream_Free(s, TRUE);
565 rdg->state = RDG_CLIENT_STATE_TUNNEL_CREATE;
571static BOOL rdg_send_tunnel_authorization(rdpRdg* rdg)
576 size_t clientNameLen = 0;
578 rdg->context->settings, FreeRDP_ClientHostname, &clientNameLen);
582 const size_t packetSize = 12ull + clientNameLen *
sizeof(WCHAR);
583 if (!clientName || (clientNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
586 s = Stream_New(
nullptr, packetSize);
591 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_AUTH);
592 Stream_Write_UINT16(s, 0);
593 Stream_Write_UINT32(s, (UINT32)packetSize);
594 Stream_Write_UINT16(s, 0);
595 Stream_Write_UINT16(s, (UINT16)clientNameLen *
sizeof(WCHAR));
596 if (!Stream_Write_UTF16_String(s, clientName, clientNameLen))
598 Stream_SealLength(s);
599 status = rdg_write_packet(rdg, s);
602 Stream_Free(s, TRUE);
606 rdg->state = RDG_CLIENT_STATE_TUNNEL_AUTHORIZE;
611static BOOL rdg_send_channel_create(rdpRdg* rdg)
615 WCHAR* serverName =
nullptr;
616 size_t serverNameLen = 0;
620 FreeRDP_ServerHostname, &serverNameLen);
623 const size_t packetSize = 16ull + serverNameLen *
sizeof(WCHAR);
624 if (!serverName || (serverNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
627 s = Stream_New(
nullptr, packetSize);
632 Stream_Write_UINT16(s, PKT_TYPE_CHANNEL_CREATE);
633 Stream_Write_UINT16(s, 0);
634 Stream_Write_UINT32(s, (UINT32)packetSize);
635 Stream_Write_UINT8(s, 1);
636 Stream_Write_UINT8(s, 0);
637 Stream_Write_UINT16(s,
638 (UINT16)rdg->context->settings->ServerPort);
639 Stream_Write_UINT16(s, 3);
640 Stream_Write_UINT16(s, (UINT16)serverNameLen *
sizeof(WCHAR));
641 if (!Stream_Write_UTF16_String(s, serverName, serverNameLen))
644 Stream_SealLength(s);
645 status = rdg_write_packet(rdg, s);
648 Stream_Free(s, TRUE);
651 rdg->state = RDG_CLIENT_STATE_CHANNEL_CREATE;
656static BOOL rdg_set_auth_header(rdpCredsspAuth* auth, HttpRequest* request)
658 const SecBuffer* authToken = credssp_auth_get_output_buffer(auth);
659 char* base64AuthToken =
nullptr;
663 if (authToken->cbBuffer > INT_MAX)
666 base64AuthToken = crypto_base64_encode(authToken->pvBuffer, authToken->cbBuffer);
671 BOOL rc = http_request_set_auth_scheme(request, credssp_auth_pkg_name(auth)) &&
672 http_request_set_auth_param(request, base64AuthToken);
673 free(base64AuthToken);
682static wStream* rdg_build_http_request(rdpRdg* rdg,
const char* method,
683 TRANSFER_ENCODING transferEncoding)
686 HttpRequest* request =
nullptr;
687 const char* uri =
nullptr;
692 uri = http_context_get_uri(rdg->http);
693 request = http_request_new();
698 if (!http_request_set_method(request, method) || !http_request_set_uri(request, uri))
703 if (!rdg_set_auth_header(rdg->auth, request))
707 else if (rdg->extAuth == HTTP_EXTENDED_AUTH_BEARER)
709 if (!http_request_set_auth_scheme(request,
"Bearer"))
711 if (!http_request_set_auth_param(request, rdg->context->settings->GatewayHttpExtAuthBearer))
715 if (!http_request_set_transfer_encoding(request, transferEncoding))
718 s = http_request_write(rdg->http, request);
720 http_request_free(request);
723 Stream_SealLength(s);
728static BOOL rdg_recv_auth_token(wLog* log, rdpCredsspAuth* auth, HttpResponse* response)
731 size_t authTokenLength = 0;
732 BYTE* authTokenData =
nullptr;
733 SecBuffer authToken = WINPR_C_ARRAY_INIT;
736 if (!auth || !response)
739 const UINT16 StatusCode = http_response_get_status_code(response);
742 case HTTP_STATUS_DENIED:
744 case HTTP_STATUS_SWITCH_PROTOCOLS:
747 http_response_log_error_status(log, WLOG_WARN, response);
751 const char* token64 = http_response_get_auth_token(response, credssp_auth_pkg_name(auth));
755 len = strlen(token64);
757 crypto_base64_decode(token64, len, &authTokenData, &authTokenLength);
759 if (authTokenLength && authTokenData && (authTokenLength <= UINT32_MAX))
761 authToken.pvBuffer = authTokenData;
762 authToken.cbBuffer = (UINT32)authTokenLength;
763 credssp_auth_take_input_buffer(auth, &authToken);
768 rc = credssp_auth_authenticate(auth);
772static BOOL rdg_skip_seed_payload(rdpContext* context, rdpTls* tls,
size_t lastResponseLength,
773 rdg_http_encoding_context* transferEncoding)
775 BYTE seed_payload[10] = WINPR_C_ARRAY_INIT;
776 const size_t size =
sizeof(seed_payload);
781 if (lastResponseLength < size)
783 if (!rdg_read_all(context, tls, seed_payload, size - lastResponseLength, transferEncoding))
792static BOOL rdg_process_handshake_response(rdpRdg* rdg,
wStream* s)
794 UINT32 errorCode = 0;
795 UINT16 serverVersion = 0;
796 UINT16 extendedAuth = 0;
799 const char* error =
nullptr;
800 WLog_Print(rdg->log, WLOG_DEBUG,
"Handshake response received");
802 if (rdg->state != RDG_CLIENT_STATE_HANDSHAKE)
807 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
810 Stream_Read_UINT32(s, errorCode);
811 Stream_Read_UINT8(s, verMajor);
812 Stream_Read_UINT8(s, verMinor);
813 Stream_Read_UINT16(s, serverVersion);
814 Stream_Read_UINT16(s, extendedAuth);
815 error = rpc_error_to_string(errorCode);
816 WLog_Print(rdg->log, WLOG_DEBUG,
817 "errorCode=%s, verMajor=%" PRId8
", verMinor=%" PRId8
", serverVersion=%" PRId16
819 error, verMajor, verMinor, serverVersion, extended_auth_to_string(extendedAuth));
821 if (FAILED((HRESULT)errorCode))
823 WLog_Print(rdg->log, WLOG_ERROR,
"Handshake error %s", error);
824 freerdp_set_last_error_log(rdg->context, errorCode);
828 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
829 return rdg_send_extauth_sspi(rdg);
831 return rdg_send_tunnel_request(rdg);
834static BOOL rdg_process_tunnel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
836 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID)
839 if (!Stream_SafeSeek(s, 4))
841 WLog_Print(rdg->log, WLOG_ERROR,
"Short tunnelId, got %" PRIuz
", expected 4",
842 Stream_GetRemainingLength(s));
847 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CAPS)
850 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
853 Stream_Read_UINT32(s, caps);
854 WLog_Print(rdg->log, WLOG_DEBUG,
"capabilities=%s", capabilities_enum_to_string(caps));
857 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ)
860 if (!Stream_SafeSeek(s, 20))
862 WLog_Print(rdg->log, WLOG_ERROR,
"Short nonce, got %" PRIuz
", expected 20",
863 Stream_GetRemainingLength(s));
868 if (!rdg_read_http_unicode_string(rdg->log, s,
nullptr,
nullptr))
870 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read server certificate");
875 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG)
877 const WCHAR* msg =
nullptr;
878 UINT16 msgLenBytes = 0;
879 rdpContext* context = rdg->context;
881 WINPR_ASSERT(context);
882 WINPR_ASSERT(context->instance);
885 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
887 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read consent message");
891 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
892 GATEWAY_MESSAGE_CONSENT, TRUE, TRUE, msgLenBytes, msg);
898static BOOL rdg_process_tunnel_response(rdpRdg* rdg,
wStream* s)
900 UINT16 serverVersion = 0;
901 UINT16 fieldsPresent = 0;
902 UINT32 errorCode = 0;
903 const char* error =
nullptr;
904 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel response received");
906 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_CREATE)
911 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
914 Stream_Read_UINT16(s, serverVersion);
915 Stream_Read_UINT32(s, errorCode);
916 Stream_Read_UINT16(s, fieldsPresent);
917 Stream_Seek_UINT16(s);
918 error = rpc_error_to_string(errorCode);
919 WLog_Print(rdg->log, WLOG_DEBUG,
"serverVersion=%" PRId16
", errorCode=%s, fieldsPresent=%s",
920 serverVersion, error, tunnel_response_fields_present_to_string(fieldsPresent));
922 if (FAILED((HRESULT)errorCode))
924 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel creation error %s", error);
925 freerdp_set_last_error_log(rdg->context, errorCode);
929 if (!rdg_process_tunnel_response_optional(rdg, s, fieldsPresent))
932 return rdg_send_tunnel_authorization(rdg);
935static BOOL rdg_process_tunnel_authorization_response(rdpRdg* rdg,
wStream* s)
937 UINT32 errorCode = 0;
938 UINT16 fieldsPresent = 0;
939 const char* error =
nullptr;
940 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel authorization received");
942 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_AUTHORIZE)
947 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
950 Stream_Read_UINT32(s, errorCode);
951 Stream_Read_UINT16(s, fieldsPresent);
952 Stream_Seek_UINT16(s);
953 error = rpc_error_to_string(errorCode);
954 WLog_Print(rdg->log, WLOG_DEBUG,
"errorCode=%s, fieldsPresent=%s", error,
955 tunnel_authorization_response_fields_present_to_string(fieldsPresent));
958 if (errorCode != S_OK && errorCode != E_PROXY_QUARANTINE_ACCESSDENIED)
960 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel authorization error %s", error);
961 freerdp_set_last_error_log(rdg->context, errorCode);
965 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS)
967 UINT32 redirFlags = 0;
968 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
970 Stream_Read_UINT32(s, redirFlags);
972 rdpContext* context = rdg->context;
973 if (!utils_apply_gateway_policy(rdg->log, context, redirFlags,
"RDG"))
977 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT)
979 UINT32 idleTimeout = 0;
980 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
982 Stream_Read_UINT32(s, idleTimeout);
983 WLog_Print(rdg->log, WLOG_DEBUG,
"[IDLE_TIMEOUT] idleTimeout=%" PRIu32
": TODO: unused",
987 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE)
990 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 2))
992 Stream_Read_UINT16(s, cbLen);
994 WLog_Print(rdg->log, WLOG_DEBUG,
"[SOH_RESPONSE] cbLen=%" PRIu16
": TODO: unused", cbLen);
995 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, cbLen))
997 Stream_Seek(s, cbLen);
1000 return rdg_send_channel_create(rdg);
1003static BOOL rdg_process_extauth_sspi(rdpRdg* rdg,
wStream* s)
1005 INT32 errorCode = 0;
1006 UINT16 authBlobLen = 0;
1007 SecBuffer authToken = WINPR_C_ARRAY_INIT;
1008 BYTE* authTokenData =
nullptr;
1012 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 6))
1015 Stream_Read_INT32(s, errorCode);
1016 Stream_Read_UINT16(s, authBlobLen);
1018 if (errorCode != ERROR_SUCCESS)
1020 WLog_Print(rdg->log, WLOG_ERROR,
"EXTAUTH_SSPI_NTLM failed with error %s [0x%08X]",
1021 GetSecurityStatusString(errorCode), WINPR_CXX_COMPAT_CAST(UINT32, errorCode));
1025 if (authBlobLen == 0)
1027 if (credssp_auth_is_complete(rdg->auth))
1029 credssp_auth_free(rdg->auth);
1030 rdg->auth =
nullptr;
1031 return rdg_send_tunnel_request(rdg);
1036 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, authBlobLen))
1039 authTokenData = malloc(authBlobLen);
1040 if (authTokenData ==
nullptr)
1042 Stream_Read(s, authTokenData, authBlobLen);
1044 authToken.pvBuffer = authTokenData;
1045 authToken.cbBuffer = authBlobLen;
1047 credssp_auth_take_input_buffer(rdg->auth, &authToken);
1049 if (credssp_auth_authenticate(rdg->auth) < 0)
1052 if (credssp_auth_have_output_token(rdg->auth))
1053 return rdg_send_extauth_sspi(rdg);
1058static BOOL rdg_process_channel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
1060 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID) != 0)
1062 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
1064 const UINT32 channelId = Stream_Get_UINT32(s);
1065 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got channelId=%" PRIu32, channelId);
1067 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT) != 0)
1069 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 2))
1071 const UINT16 udpPort = Stream_Get_UINT16(s);
1072 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got udpPort=%" PRIu32, udpPort);
1074 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE) != 0)
1076 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 2))
1078 const UINT16 blobLen = Stream_Get_UINT16(s);
1079 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, blobLen))
1081 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got UDP auth blob=%" PRIu32, blobLen);
1082 if (!Stream_SafeSeek(s, blobLen))
1089static BOOL rdg_process_channel_response(rdpRdg* rdg,
wStream* s)
1091 UINT16 fieldsPresent = 0;
1092 UINT32 errorCode = 0;
1093 const char* error =
nullptr;
1094 WLog_Print(rdg->log, WLOG_DEBUG,
"Channel response received");
1096 if (rdg->state != RDG_CLIENT_STATE_CHANNEL_CREATE)
1101 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1104 Stream_Read_UINT32(s, errorCode);
1105 Stream_Read_UINT16(s, fieldsPresent);
1106 Stream_Seek_UINT16(s);
1107 error = rpc_error_to_string(errorCode);
1108 WLog_Print(rdg->log, WLOG_DEBUG,
"channel response errorCode=%s, fieldsPresent=%s", error,
1109 channel_response_fields_present_to_string(fieldsPresent));
1111 if (FAILED((HRESULT)errorCode))
1113 WLog_Print(rdg->log, WLOG_ERROR,
"channel response errorCode=%s, fieldsPresent=%s", error,
1114 channel_response_fields_present_to_string(fieldsPresent));
1115 freerdp_set_last_error_log(rdg->context, errorCode);
1119 if (!rdg_process_channel_response_optional(rdg, s, fieldsPresent))
1122 rdg->state = RDG_CLIENT_STATE_OPENED;
1126static BOOL rdg_process_packet(rdpRdg* rdg,
wStream* s)
1130 UINT32 packetLength = 0;
1131 Stream_ResetPosition(s);
1133 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1136 Stream_Read_UINT16(s, type);
1137 Stream_Seek_UINT16(s);
1138 Stream_Read_UINT32(s, packetLength);
1140 if (Stream_Length(s) < packetLength)
1142 WLog_Print(rdg->log, WLOG_ERROR,
"Short packet %" PRIuz
", expected %" PRIu32,
1143 Stream_Length(s), packetLength);
1149 case PKT_TYPE_HANDSHAKE_RESPONSE:
1150 status = rdg_process_handshake_response(rdg, s);
1153 case PKT_TYPE_TUNNEL_RESPONSE:
1154 status = rdg_process_tunnel_response(rdg, s);
1157 case PKT_TYPE_TUNNEL_AUTH_RESPONSE:
1158 status = rdg_process_tunnel_authorization_response(rdg, s);
1161 case PKT_TYPE_CHANNEL_RESPONSE:
1162 status = rdg_process_channel_response(rdg, s);
1166 WLog_Print(rdg->log, WLOG_ERROR,
"Unexpected packet type DATA");
1170 case PKT_TYPE_EXTENDED_AUTH_MSG:
1171 status = rdg_process_extauth_sspi(rdg, s);
1175 WLog_Print(rdg->log, WLOG_ERROR,
"PKG TYPE 0x%x not implemented", type);
1182 const size_t rem = Stream_GetRemainingLength(s);
1184 WLog_Print(rdg->log, WLOG_WARN,
"[%s] unparsed data detected: %" PRIuz
" bytes",
1185 rdg_pkt_type_to_string(type), rem);
1190DWORD rdg_get_event_handles(rdpRdg* rdg, HANDLE* events, DWORD count)
1193 WINPR_ASSERT(rdg !=
nullptr);
1195 if (rdg->tlsOut && rdg->tlsOut->bio)
1197 if (events && (nCount < count))
1199 BIO_get_event(rdg->tlsOut->bio, &events[nCount]);
1211static BOOL rdg_get_gateway_credentials(rdpContext* context, rdp_auth_reason reason)
1213 freerdp* instance = context->instance;
1215 auth_status rc = utils_authenticate_gateway(instance, reason);
1221 case AUTH_CANCELLED:
1222 freerdp_set_last_error_log(instance->context, FREERDP_ERROR_CONNECT_CANCELLED);
1224 case AUTH_NO_CREDENTIALS:
1225 WLog_INFO(TAG,
"No credentials provided - using nullptr identity");
1233static BOOL rdg_auth_init(rdpRdg* rdg, rdpTls* tls, TCHAR* authPkg)
1235 rdpContext* context = rdg->context;
1236 rdpSettings* settings = context->settings;
1237 SEC_WINNT_AUTH_IDENTITY identity = WINPR_C_ARRAY_INIT;
1240 rdg->auth = credssp_auth_new(context);
1244 if (!credssp_auth_init(rdg->auth, authPkg, tls->Bindings))
1250 if (!smartcard_getCert(context, &rdg->smartcard, TRUE))
1253 if (!rdg_get_gateway_credentials(context, AUTH_SMARTCARD_PIN))
1258 if (!rdg_get_gateway_credentials(context, GW_AUTH_RDG))
1263 if (doSCLogon && !smartcard_getCert(context, &rdg->smartcard, TRUE))
1267 SEC_WINNT_AUTH_IDENTITY* identityArg = &identity;
1270 if (!identity_set_from_smartcard_hash(&identity, settings, FreeRDP_GatewayUsername,
1271 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword,
1272 rdg->smartcard->sha1Hash,
1273 sizeof(rdg->smartcard->sha1Hash)))
1278 if (!identity_set_from_settings(&identity, settings, FreeRDP_GatewayUsername,
1279 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword))
1282 if (!settings->GatewayUsername)
1283 identityArg =
nullptr;
1286 if (!credssp_auth_setup_client(rdg->auth,
"HTTP", settings->GatewayHostname, identityArg,
1287 rdg->smartcard ? rdg->smartcard->pkinitArgs : nullptr))
1289 sspi_FreeAuthIdentity(&identity);
1292 sspi_FreeAuthIdentity(&identity);
1294 credssp_auth_set_flags(rdg->auth, ISC_REQ_CONFIDENTIALITY | ISC_REQ_MUTUAL_AUTH);
1296 rc = credssp_auth_authenticate(rdg->auth);
1300static BOOL rdg_send_http_request(rdpRdg* rdg, rdpTls* tls,
const char* method,
1301 TRANSFER_ENCODING transferEncoding)
1304 wStream* s = rdg_build_http_request(rdg, method, transferEncoding);
1309 const size_t sz = Stream_Length(s);
1310 status = freerdp_tls_write_all(tls, Stream_Buffer(s), sz);
1312 Stream_Free(s, TRUE);
1313 return (status >= 0);
1316static BOOL rdg_tls_connect(rdpRdg* rdg, rdpTls* tls,
const char* peerAddress, UINT32 timeout)
1319 BIO* layerBio =
nullptr;
1320 BIO* bufferedBio =
nullptr;
1322 rdpSettings* settings = rdg->context->settings;
1323 rdpTransport* transport = freerdp_get_transport(rdg->context);
1324 const char* peerHostname = settings->GatewayHostname;
1325 UINT16 peerPort = (UINT16)settings->GatewayPort;
1326 const char* proxyUsername =
nullptr;
1327 const char* proxyPassword =
nullptr;
1328 BOOL isProxyConnection =
1329 proxy_prepare(settings, &peerHostname, &peerPort, &proxyUsername, &proxyPassword);
1331 if (settings->GatewayPort > UINT16_MAX)
1334 layer = transport_connect_layer(transport, peerAddress ? peerAddress : peerHostname, peerPort,
1342 layerBio = BIO_new(BIO_s_transport_layer());
1345 transport_layer_free(layer);
1348 BIO_set_data(layerBio, layer);
1350 bufferedBio = BIO_new(BIO_s_buffered_socket());
1353 BIO_free_all(layerBio);
1357 bufferedBio = BIO_push(bufferedBio, layerBio);
1358 status = BIO_set_nonblock(bufferedBio, TRUE);
1360 if (isProxyConnection)
1362 if (!proxy_connect(rdg->context, bufferedBio, proxyUsername, proxyPassword,
1363 settings->GatewayHostname, (UINT16)settings->GatewayPort))
1365 BIO_free_all(bufferedBio);
1372 BIO_free_all(bufferedBio);
1376 tls->hostname = settings->GatewayHostname;
1377 tls->port = WINPR_ASSERTING_INT_CAST(int32_t, MIN(UINT16_MAX, settings->GatewayPort));
1378 tls->isGatewayTransport = TRUE;
1379 status = freerdp_tls_connect(tls, bufferedBio);
1382 rdpContext* context = rdg->context;
1385 freerdp_set_last_error_if_not(context, FREERDP_ERROR_TLS_CONNECT_FAILED);
1389 freerdp_set_last_error_if_not(context, FREERDP_ERROR_CONNECT_CANCELLED);
1394 return (status >= 1);
1397static BOOL rdg_establish_data_connection(rdpRdg* rdg, rdpTls* tls,
const char* method,
1398 const char* peerAddress, UINT32 timeout,
1401 char buffer[64] = WINPR_C_ARRAY_INIT;
1402 HttpResponse* response =
nullptr;
1404 if (!rdg_tls_connect(rdg, tls, peerAddress, timeout))
1407 WINPR_ASSERT(rpcFallback);
1408 if (rdg->context->settings->GatewayHttpExtAuthBearer && rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1409 rdg->extAuth = HTTP_EXTENDED_AUTH_BEARER;
1410 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1412 if (!rdg_auth_init(rdg, tls, AUTH_PKG))
1415 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1418 response = http_response_recv(tls, TRUE);
1423 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1424 *rpcFallback = TRUE;
1428 (void)http_response_extract_cookies(response, rdg->http);
1430 const UINT16 StatusCode = http_response_get_status_code(response);
1433 case HTTP_STATUS_GONE:
1434 case HTTP_STATUS_FORBIDDEN:
1435 case HTTP_STATUS_NOT_FOUND:
1437 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway does not support HTTP transport.");
1438 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1439 *rpcFallback = TRUE;
1441 http_response_free(response);
1444 case HTTP_STATUS_OK:
1447 case HTTP_STATUS_DENIED:
1448 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1452 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1456 while (!credssp_auth_is_complete(rdg->auth))
1458 if (!rdg_recv_auth_token(rdg->log, rdg->auth, response))
1460 http_response_free(response);
1464 if (credssp_auth_have_output_token(rdg->auth))
1466 http_response_free(response);
1468 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1471 response = http_response_recv(tls, TRUE);
1474 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1475 *rpcFallback = TRUE;
1478 (void)http_response_extract_cookies(response, rdg->http);
1481 credssp_auth_free(rdg->auth);
1482 rdg->auth =
nullptr;
1486 credssp_auth_free(rdg->auth);
1487 rdg->auth =
nullptr;
1489 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1492 response = http_response_recv(tls, TRUE);
1496 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1497 *rpcFallback = TRUE;
1500 (void)http_response_extract_cookies(response, rdg->http);
1503 const UINT16 statusCode = http_response_get_status_code(response);
1504 const size_t bodyLength = http_response_get_body_length(response);
1505 const TRANSFER_ENCODING encoding = http_response_get_transfer_encoding(response);
1506 const BOOL isWebsocket = http_response_is_websocket(rdg->http, response);
1508 WLog_Print(rdg->log, WLOG_DEBUG,
"%s authorization result: %s", method,
1509 freerdp_http_status_string_format(statusCode, buffer, ARRAYSIZE(buffer)));
1513 case HTTP_STATUS_OK:
1516 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1517 http_response_free(response);
1519 case HTTP_STATUS_DENIED:
1520 freerdp_set_last_error_log(rdg->context, FREERDP_ERROR_CONNECT_ACCESS_DENIED);
1521 http_response_free(response);
1523 case HTTP_STATUS_SWITCH_PROTOCOLS:
1524 http_response_free(response);
1531 if (http_context_is_websocket_upgrade_enabled(rdg->http))
1533 long fd = BIO_get_fd(tls->bio,
nullptr);
1535 closesocket((SOCKET)fd);
1536 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1537 return rdg_establish_data_connection(rdg, tls, method, peerAddress, timeout,
1543 rdg->transferEncoding.isWebsocketTransport = TRUE;
1544 if (!websocket_context_reset(rdg->transferEncoding.context.websocket))
1547 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1551 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1556 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1557 http_response_free(response);
1561 if (strcmp(method,
"RDG_OUT_DATA") == 0)
1563 if (encoding == TransferEncodingChunked)
1565 rdg->transferEncoding.httpTransferEncoding = TransferEncodingChunked;
1566 rdg->transferEncoding.context.chunked.nextOffset = 0;
1567 rdg->transferEncoding.context.chunked.headerFooterPos = 0;
1568 rdg->transferEncoding.context.chunked.state = ChunkStateLenghHeader;
1570 if (!rdg_skip_seed_payload(rdg->context, tls, bodyLength, &rdg->transferEncoding))
1577 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingChunked))
1580 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1584 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1592static BOOL rdg_tunnel_connect(rdpRdg* rdg)
1596 rdg_send_handshake(rdg);
1598 while (rdg->state < RDG_CLIENT_STATE_OPENED)
1601 s = rdg_receive_packet(rdg);
1605 status = rdg_process_packet(rdg, s);
1606 Stream_Free(s, TRUE);
1612 WINPR_ASSERT(rdg->context);
1613 WINPR_ASSERT(rdg->context->rdp);
1614 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1622BOOL rdg_connect(rdpRdg* rdg, DWORD timeout, BOOL* rpcFallback)
1625 SOCKET outConnSocket = 0;
1626 char* peerAddress =
nullptr;
1627 BOOL rpcFallbackLocal = FALSE;
1629 WINPR_ASSERT(rdg !=
nullptr);
1630 freerdp_set_last_error(rdg->context, ERROR_SUCCESS);
1631 status = rdg_establish_data_connection(rdg, rdg->tlsOut,
"RDG_OUT_DATA",
nullptr, timeout,
1636 if (rdg->transferEncoding.isWebsocketTransport)
1638 WLog_Print(rdg->log, WLOG_DEBUG,
"Upgraded to websocket. RDG_IN_DATA not required");
1645 BIO_get_socket(rdg->tlsOut->underlying, &outConnSocket);
1646 peerAddress = freerdp_tcp_get_peer_address(outConnSocket);
1647 status = rdg_establish_data_connection(rdg, rdg->tlsIn,
"RDG_IN_DATA", peerAddress,
1648 timeout, &rpcFallbackLocal);
1654 *rpcFallback = rpcFallbackLocal;
1659 WINPR_ASSERT(rdg->context);
1660 WINPR_ASSERT(rdg->context->rdp);
1661 if (rpcFallbackLocal)
1663 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1664 credssp_auth_free(rdg->auth);
1665 rdg->auth =
nullptr;
1668 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1672 status = rdg_tunnel_connect(rdg);
1677static int rdg_write_websocket_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1683 const size_t payloadSize = (size_t)isize + 10;
1691 websocket_context_packet_new(payloadSize, WebsocketBinaryOpcode, &maskingKey.u32);
1695 Stream_Write_UINT16(
1696 sWS, WINPR_ASSERTING_INT_CAST(
1697 uint16_t, PKT_TYPE_DATA ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1698 Stream_Write_UINT16(
1699 sWS, WINPR_ASSERTING_INT_CAST(
1700 uint16_t, 0 ^ (maskingKey.u8[2] | maskingKey.u8[3] << 8)));
1701 Stream_Write_UINT32(
1702 sWS, WINPR_ASSERTING_INT_CAST(uint32_t, payloadSize ^ maskingKey.u32));
1703 Stream_Write_UINT16(
1704 sWS, WINPR_ASSERTING_INT_CAST(
1705 uint16_t, isize ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1708 maskingKey.u32 = (maskingKey.u32 & 0xffff) << 16 | (maskingKey.u32 >> 16);
1710 WINPR_ASSERT(rdg->tlsOut);
1711 wStream sPacket = WINPR_C_ARRAY_INIT;
1712 Stream_StaticConstInit(&sPacket, buf, (
size_t)isize);
1713 if (!websocket_context_mask_and_send(rdg->tlsOut->bio, sWS, &sPacket, maskingKey.u32))
1719static int rdg_write_chunked_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1725 if (isize > UINT16_MAX)
1728 const size_t size = (size_t)isize;
1732 const size_t packetSize = size + 10;
1733 char chunkSize[11] = WINPR_C_ARRAY_INIT;
1734 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIxz
"\r\n", packetSize);
1735 sChunk = Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + packetSize + 2);
1740 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
1741 Stream_Write_UINT16(sChunk, PKT_TYPE_DATA);
1742 Stream_Write_UINT16(sChunk, 0);
1743 Stream_Write_UINT32(sChunk, (UINT32)packetSize);
1744 Stream_Write_UINT16(sChunk, (UINT16)size);
1745 Stream_Write(sChunk, buf, size);
1746 Stream_Write(sChunk,
"\r\n", 2);
1747 Stream_SealLength(sChunk);
1748 len = Stream_Length(sChunk);
1750 status = freerdp_tls_write_all(rdg->tlsIn, Stream_Buffer(sChunk), len);
1751 Stream_Free(sChunk, TRUE);
1759static int rdg_write_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1762 if (rdg->transferEncoding.isWebsocketTransport)
1763 return rdg_write_websocket_data_packet(rdg, buf, isize);
1765 return rdg_write_chunked_data_packet(rdg, buf, isize);
1768static BOOL rdg_process_close_packet(rdpRdg* rdg,
wStream* s)
1772 UINT32 errorCode = 0;
1773 UINT32 packetSize = 12;
1776 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1778 Stream_Read_UINT32(s, errorCode);
1781 freerdp_set_last_error_log(rdg->context, errorCode);
1783 sClose = Stream_New(
nullptr, packetSize);
1787 Stream_Write_UINT16(sClose, PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
1788 Stream_Write_UINT16(sClose, 0);
1789 Stream_Write_UINT32(sClose, packetSize);
1790 Stream_Write_UINT32(sClose, 0);
1791 Stream_SealLength(sClose);
1792 status = rdg_write_packet(rdg, sClose);
1793 Stream_Free(sClose, TRUE);
1795 return ((status >= 0));
1798static BOOL rdg_process_keep_alive_packet(rdpRdg* rdg)
1801 wStream* sKeepAlive =
nullptr;
1802 size_t packetSize = 8;
1804 sKeepAlive = Stream_New(
nullptr, packetSize);
1809 Stream_Write_UINT16(sKeepAlive, PKT_TYPE_KEEPALIVE);
1810 Stream_Write_UINT16(sKeepAlive, 0);
1811 Stream_Write_UINT32(sKeepAlive, (UINT32)packetSize);
1812 Stream_SealLength(sKeepAlive);
1813 status = rdg_write_packet(rdg, sKeepAlive);
1814 Stream_Free(sKeepAlive, TRUE);
1816 return ((status >= 0));
1819static BOOL rdg_process_service_message(rdpRdg* rdg,
wStream* s)
1821 const WCHAR* msg =
nullptr;
1822 UINT16 msgLenBytes = 0;
1823 rdpContext* context = rdg->context;
1824 WINPR_ASSERT(context);
1825 WINPR_ASSERT(context->instance);
1828 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
1830 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read string");
1834 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
1835 GATEWAY_MESSAGE_SERVICE, TRUE, FALSE, msgLenBytes, msg);
1838static BOOL rdg_process_unknown_packet(rdpRdg* rdg,
int type)
1842 WLog_Print(rdg->log, WLOG_WARN,
"Unknown Control Packet received: %" PRIX32,
1843 WINPR_CXX_COMPAT_CAST(UINT32, type));
1847static BOOL rdg_process_control_packet(rdpRdg* rdg,
int type,
size_t packetLength)
1850 size_t readCount = 0;
1852 size_t payloadSize = packetLength -
sizeof(RdgPacketHeader);
1854 if (packetLength <
sizeof(RdgPacketHeader))
1858 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1862 s = Stream_New(
nullptr, payloadSize);
1867 while (readCount < payloadSize)
1869 if (rdg_shall_abort(rdg))
1871 Stream_Free(s, TRUE);
1874 status = rdg_socket_read(rdg->tlsOut->bio, Stream_Pointer(s), payloadSize - readCount,
1875 &rdg->transferEncoding);
1879 if (!BIO_should_retry(rdg->tlsOut->bio))
1881 Stream_Free(s, TRUE);
1888 Stream_Seek(s, (
size_t)status);
1889 readCount += (size_t)status;
1891 if (readCount > INT_MAX)
1893 Stream_Free(s, TRUE);
1898 Stream_ResetPosition(s);
1903 case PKT_TYPE_CLOSE_CHANNEL:
1904 EnterCriticalSection(&rdg->writeSection);
1905 status = rdg_process_close_packet(rdg, s);
1906 LeaveCriticalSection(&rdg->writeSection);
1909 case PKT_TYPE_KEEPALIVE:
1910 EnterCriticalSection(&rdg->writeSection);
1911 status = rdg_process_keep_alive_packet(rdg);
1912 LeaveCriticalSection(&rdg->writeSection);
1915 case PKT_TYPE_SERVICE_MESSAGE:
1918 WLog_Print(rdg->log, WLOG_ERROR,
1919 "PKT_TYPE_SERVICE_MESSAGE requires payload but none was sent");
1922 status = rdg_process_service_message(rdg, s);
1925 case PKT_TYPE_REAUTH_MESSAGE:
1927 status = rdg_process_unknown_packet(rdg, type);
1931 Stream_Free(s, TRUE);
1935static int rdg_read_data_packet(rdpRdg* rdg, BYTE* buffer,
size_t size)
1937 RdgPacketHeader header = WINPR_C_ARRAY_INIT;
1938 size_t readCount = 0;
1939 size_t readSize = 0;
1942 if (!rdg->packetRemainingCount)
1945 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1947 while (readCount <
sizeof(RdgPacketHeader))
1949 if (rdg_shall_abort(rdg))
1952 status = rdg_socket_read(rdg->tlsOut->bio, (BYTE*)(&header) + readCount,
1953 sizeof(RdgPacketHeader) - readCount, &rdg->transferEncoding);
1957 if (!BIO_should_retry(rdg->tlsOut->bio))
1963 BIO_wait_read(rdg->tlsOut->bio, 50);
1967 readCount += (size_t)status;
1969 if (readCount > INT_MAX)
1973 if (header.type != PKT_TYPE_DATA)
1975 status = rdg_process_control_packet(rdg, header.type, header.packetLength);
1985 while (readCount < 2)
1987 if (rdg_shall_abort(rdg))
1990 rdg_socket_read(rdg->tlsOut->bio, (BYTE*)(&rdg->packetRemainingCount) + readCount,
1991 2 - readCount, &rdg->transferEncoding);
1995 if (!BIO_should_retry(rdg->tlsOut->bio))
1998 BIO_wait_read(rdg->tlsOut->bio, 50);
2002 readCount += (size_t)status;
2006 readSize = (rdg->packetRemainingCount < size) ? rdg->packetRemainingCount : size;
2007 status = rdg_socket_read(rdg->tlsOut->bio, buffer, readSize, &rdg->transferEncoding);
2011 if (!BIO_should_retry(rdg->tlsOut->bio))
2019 rdg->packetRemainingCount -= status;
2023static int rdg_bio_write(BIO* bio,
const char* buf,
int num)
2026 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2030 BIO_clear_flags(bio, BIO_FLAGS_WRITE);
2031 EnterCriticalSection(&rdg->writeSection);
2032 status = rdg_write_data_packet(rdg, (
const BYTE*)buf, num);
2033 LeaveCriticalSection(&rdg->writeSection);
2037 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2040 else if (status < num)
2042 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2043 WSASetLastError(WSAEWOULDBLOCK);
2047 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2053static int rdg_bio_read(BIO* bio,
char* buf,
int size)
2056 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2059 status = rdg_read_data_packet(rdg, (BYTE*)buf, (
size_t)size);
2063 BIO_clear_retry_flags(bio);
2066 else if (status == 0)
2068 BIO_set_retry_read(bio);
2069 WSASetLastError(WSAEWOULDBLOCK);
2074 BIO_set_flags(bio, BIO_FLAGS_READ);
2080static int rdg_bio_puts(BIO* bio,
const char* str)
2088static int rdg_bio_gets(BIO* bio,
char* str,
int size)
2096static long rdg_bio_ctrl(BIO* in_bio,
int cmd,
long arg1,
void* arg2)
2099 rdpRdg* rdg = (rdpRdg*)BIO_get_data(in_bio);
2100 rdpTls* tlsOut = rdg->tlsOut;
2101 rdpTls* tlsIn = rdg->tlsIn;
2103 if (cmd == BIO_CTRL_FLUSH)
2105 (void)BIO_flush(tlsOut->bio);
2106 if (!rdg->transferEncoding.isWebsocketTransport)
2107 (void)BIO_flush(tlsIn->bio);
2110 else if (cmd == BIO_C_SET_NONBLOCK)
2114 else if (cmd == BIO_C_READ_BLOCKED)
2116 BIO* cbio = tlsOut->bio;
2117 status = BIO_read_blocked(cbio);
2119 else if (cmd == BIO_C_WRITE_BLOCKED)
2121 BIO* cbio = tlsIn->bio;
2123 if (rdg->transferEncoding.isWebsocketTransport)
2126 status = BIO_write_blocked(cbio);
2128 else if (cmd == BIO_C_WAIT_READ)
2130 int timeout = (int)arg1;
2131 BIO* cbio = tlsOut->bio;
2133 if (BIO_read_blocked(cbio))
2134 return BIO_wait_read(cbio, timeout);
2135 else if (BIO_write_blocked(cbio))
2136 return BIO_wait_write(cbio, timeout);
2140 else if (cmd == BIO_C_WAIT_WRITE)
2142 int timeout = (int)arg1;
2143 BIO* cbio = tlsIn->bio;
2145 if (rdg->transferEncoding.isWebsocketTransport)
2148 if (BIO_write_blocked(cbio))
2149 status = BIO_wait_write(cbio, timeout);
2150 else if (BIO_read_blocked(cbio))
2151 status = BIO_wait_read(cbio, timeout);
2155 else if (cmd == BIO_C_GET_EVENT || cmd == BIO_C_GET_FD)
2165 status = BIO_ctrl(tlsOut->bio, cmd, arg1, arg2);
2167#if OPENSSL_VERSION_NUMBER >= 0x30000000L
2168 else if (cmd == BIO_CTRL_GET_KTLS_SEND)
2176 else if (cmd == BIO_CTRL_GET_KTLS_RECV)
2187static int rdg_bio_new(BIO* bio)
2189 BIO_set_init(bio, 1);
2190 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2194static int rdg_bio_free(BIO* bio)
2200static BIO_METHOD* BIO_s_rdg(
void)
2202 static BIO_METHOD* bio_methods =
nullptr;
2204 if (bio_methods ==
nullptr)
2206 if (!(bio_methods = BIO_meth_new(BIO_TYPE_TSG,
"RDGateway")))
2209 BIO_meth_set_write(bio_methods, rdg_bio_write);
2210 BIO_meth_set_read(bio_methods, rdg_bio_read);
2211 BIO_meth_set_puts(bio_methods, rdg_bio_puts);
2212 BIO_meth_set_gets(bio_methods, rdg_bio_gets);
2213 BIO_meth_set_ctrl(bio_methods, rdg_bio_ctrl);
2214 BIO_meth_set_create(bio_methods, rdg_bio_new);
2215 BIO_meth_set_destroy(bio_methods, rdg_bio_free);
2221rdpRdg* rdg_new(rdpContext* context)
2226 rdpRdg* rdg = (rdpRdg*)calloc(1,
sizeof(rdpRdg));
2230 rdg->log = WLog_Get(TAG);
2231 rdg->state = RDG_CLIENT_STATE_INITIAL;
2232 rdg->context = context;
2233 rdpSettings* settings = rdg->context->settings;
2234 rdg->extAuth = (settings->GatewayHttpExtAuthSspiNtlm ? HTTP_EXTENDED_AUTH_SSPI_NTLM
2235 : HTTP_EXTENDED_AUTH_NONE);
2237 if (settings->GatewayAccessToken)
2238 rdg->extAuth = HTTP_EXTENDED_AUTH_PAA;
2240 rdg->tlsOut = freerdp_tls_new(rdg->context);
2243 goto rdg_alloc_error;
2245 rdg->tlsIn = freerdp_tls_new(rdg->context);
2248 goto rdg_alloc_error;
2250 rdg->http = http_context_new();
2253 goto rdg_alloc_error;
2255 GUID guid = WINPR_C_ARRAY_INIT;
2256 if (UuidFromStringA(settings->CorrelationId, &guid) != RPC_S_OK)
2257 goto rdg_alloc_error;
2259 if (!http_context_set_uri(rdg->http,
"/remoteDesktopGateway/") ||
2260 !http_context_set_accept(rdg->http,
"*/*") ||
2261 !http_context_set_cache_control(rdg->http,
"no-cache") ||
2262 !http_context_set_pragma(rdg->http,
"no-cache") ||
2263 !http_context_set_connection(rdg->http,
"Keep-Alive") ||
2264 !http_context_set_user_agent(rdg->http,
"MS-RDGateway/1.0") ||
2265 !http_context_set_host(rdg->http, rdg->context->settings->GatewayHostname) ||
2266 !http_context_set_rdg_connection_id(rdg->http, &guid) ||
2267 !http_context_set_rdg_correlation_id(rdg->http, &guid) ||
2268 !http_context_enable_websocket_upgrade(
2272 goto rdg_alloc_error;
2275 if (rdg->extAuth != HTTP_EXTENDED_AUTH_NONE)
2277 switch (rdg->extAuth)
2279 case HTTP_EXTENDED_AUTH_PAA:
2280 if (!http_context_set_rdg_auth_scheme(rdg->http,
"PAA"))
2281 goto rdg_alloc_error;
2285 case HTTP_EXTENDED_AUTH_SSPI_NTLM:
2286 if (!http_context_set_rdg_auth_scheme(rdg->http,
"SSPI_NTLM"))
2287 goto rdg_alloc_error;
2292 WLog_Print(rdg->log, WLOG_DEBUG,
2293 "RDG extended authentication method %d not supported", rdg->extAuth);
2297 rdg->frontBio = BIO_new(BIO_s_rdg());
2300 goto rdg_alloc_error;
2302 BIO_set_data(rdg->frontBio, rdg);
2303 InitializeCriticalSection(&rdg->writeSection);
2305 rdg->transferEncoding.httpTransferEncoding = TransferEncodingIdentity;
2306 rdg->transferEncoding.isWebsocketTransport = FALSE;
2308 rdg->transferEncoding.context.websocket = websocket_context_new();
2309 if (!rdg->transferEncoding.context.websocket)
2310 goto rdg_alloc_error;
2314 WINPR_PRAGMA_DIAG_PUSH
2315 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2317 WINPR_PRAGMA_DIAG_POP
2321void rdg_free(rdpRdg* rdg)
2326 freerdp_tls_free(rdg->tlsOut);
2327 freerdp_tls_free(rdg->tlsIn);
2328 http_context_free(rdg->http);
2329 credssp_auth_free(rdg->auth);
2332 BIO_free_all(rdg->frontBio);
2334 DeleteCriticalSection(&rdg->writeSection);
2336 smartcardCertInfo_Free(rdg->smartcard);
2338 websocket_context_free(rdg->transferEncoding.context.websocket);
2343BIO* rdg_get_front_bio_and_take_ownership(rdpRdg* rdg)
2348 rdg->attached = TRUE;
2349 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.