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;
137 UINT16 packetRemainingCount;
142 rdg_http_encoding_context transferEncoding;
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" }
212static const char* rdg_pkt_type_to_string(
int type)
220 ENTRY(PKT_TYPE_HANDSHAKE_REQUEST);
221 ENTRY(PKT_TYPE_HANDSHAKE_RESPONSE);
222 ENTRY(PKT_TYPE_EXTENDED_AUTH_MSG);
223 ENTRY(PKT_TYPE_TUNNEL_CREATE);
224 ENTRY(PKT_TYPE_TUNNEL_RESPONSE);
225 ENTRY(PKT_TYPE_TUNNEL_AUTH);
226 ENTRY(PKT_TYPE_TUNNEL_AUTH_RESPONSE);
227 ENTRY(PKT_TYPE_CHANNEL_CREATE);
228 ENTRY(PKT_TYPE_CHANNEL_RESPONSE);
229 ENTRY(PKT_TYPE_DATA);
230 ENTRY(PKT_TYPE_SERVICE_MESSAGE);
231 ENTRY(PKT_TYPE_REAUTH_MESSAGE);
232 ENTRY(PKT_TYPE_KEEPALIVE);
233 ENTRY(PKT_TYPE_CLOSE_CHANNEL);
234 ENTRY(PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
236 return "PKT_TYPE_UNKNOWN";
241static const char* flags_to_string(UINT32 flags,
const t_flag_mapping* map,
size_t elements)
243 static char buffer[1024] = WINPR_C_ARRAY_INIT;
244 char fields[12] = WINPR_C_ARRAY_INIT;
246 for (
size_t x = 0; x < elements; x++)
248 const t_flag_mapping* cur = &map[x];
250 if ((cur->code & flags) != 0)
251 winpr_str_append(cur->name, buffer,
sizeof(buffer),
"|");
254 (void)sprintf_s(fields, ARRAYSIZE(fields),
" [%04" PRIx32
"]", flags);
255 winpr_str_append(fields, buffer,
sizeof(buffer),
nullptr);
259static const char* channel_response_fields_present_to_string(UINT16 fieldsPresent)
261 return flags_to_string(fieldsPresent, channel_response_fields_present,
262 ARRAYSIZE(channel_response_fields_present));
265static const char* tunnel_response_fields_present_to_string(UINT16 fieldsPresent)
267 return flags_to_string(fieldsPresent, tunnel_response_fields_present,
268 ARRAYSIZE(tunnel_response_fields_present));
271static const char* tunnel_authorization_response_fields_present_to_string(UINT16 fieldsPresent)
273 return flags_to_string(fieldsPresent, tunnel_authorization_response_fields_present,
274 ARRAYSIZE(tunnel_authorization_response_fields_present));
277static const char* extended_auth_to_string(UINT16 auth)
279 if (auth == HTTP_EXTENDED_AUTH_NONE)
280 return "HTTP_EXTENDED_AUTH_NONE [0x0000]";
282 return flags_to_string(auth, extended_auth, ARRAYSIZE(extended_auth));
285static const char* capabilities_enum_to_string(UINT32 capabilities)
287 return flags_to_string(capabilities, capabilities_enum, ARRAYSIZE(capabilities_enum));
290static BOOL rdg_read_http_unicode_string(wLog* log,
wStream* s,
const WCHAR**
string,
291 UINT16* lengthInBytes)
293 UINT16 strLenBytes = 0;
294 size_t rem = Stream_GetRemainingLength(s);
297 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 4))
299 WLog_Print(log, WLOG_ERROR,
"Could not read stream length, only have %" PRIuz
" bytes",
303 Stream_Read_UINT16(s, strLenBytes);
306 const WCHAR* str = Stream_ConstPointer(s);
309 if (!Stream_SafeSeek(s, strLenBytes))
311 WLog_Print(log, WLOG_ERROR,
312 "Could not read stream data, only have %" PRIuz
" bytes, expected %" PRIu16,
313 rem - 4, strLenBytes);
321 *lengthInBytes = strLenBytes;
326static BOOL rdg_write_chunked(BIO* bio,
wStream* sPacket)
332 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIXz
"\r\n", Stream_Length(sPacket));
334 Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + Stream_Length(sPacket) + 2);
339 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
340 Stream_Write(sChunk, Stream_Buffer(sPacket), Stream_Length(sPacket));
341 Stream_Write(sChunk,
"\r\n", 2);
342 Stream_SealLength(sChunk);
343 len = Stream_Length(sChunk);
347 Stream_Free(sChunk, TRUE);
352 status = BIO_write(bio, Stream_Buffer(sChunk), (
int)len);
353 Stream_Free(sChunk, TRUE);
355 return (status == (SSIZE_T)len);
358static BOOL rdg_write_packet(rdpRdg* rdg,
wStream* sPacket)
360 if (rdg->transferEncoding.isWebsocketTransport)
361 return websocket_context_write_wstream(rdg->transferEncoding.context.websocket,
362 rdg->tlsOut->bio, sPacket, WebsocketBinaryOpcode);
364 return rdg_write_chunked(rdg->tlsIn->bio, sPacket);
367static int rdg_socket_read(BIO* bio, BYTE* pBuffer,
size_t size,
368 rdg_http_encoding_context* encodingContext)
370 WINPR_ASSERT(encodingContext !=
nullptr);
371 if (size > INT32_MAX)
374 if (encodingContext->isWebsocketTransport)
375 return websocket_context_read(encodingContext->context.websocket, bio, pBuffer, size);
377 switch (encodingContext->httpTransferEncoding)
379 case TransferEncodingIdentity:
381 return BIO_read(bio, pBuffer, (
int)size);
382 case TransferEncodingChunked:
383 return http_chuncked_read(bio, pBuffer, size, &encodingContext->context.chunked);
389static BOOL rdg_shall_abort(rdpRdg* rdg)
392 return freerdp_shall_disconnect_context(rdg->context);
395static BOOL rdg_read_all(rdpContext* context, rdpTls* tls, BYTE* buffer,
size_t size,
396 rdg_http_encoding_context* transferEncoding)
398 size_t readCount = 0;
399 BYTE* pBuffer = buffer;
401 while (readCount < size)
403 if (freerdp_shall_disconnect_context(context))
406 int status = rdg_socket_read(tls->bio, pBuffer, size - readCount, transferEncoding);
409 if (!BIO_should_retry(tls->bio))
416 readCount += WINPR_ASSERTING_INT_CAST(uint32_t, status);
417 pBuffer += WINPR_ASSERTING_INT_CAST(uint32_t, status);
423static wStream* rdg_receive_packet(rdpRdg* rdg)
425 const size_t header =
sizeof(RdgPacketHeader);
426 size_t packetLength = 0;
427 wStream* s = Stream_New(
nullptr, 1024);
432 if (!rdg_read_all(rdg->context, rdg->tlsOut, Stream_Buffer(s), header, &rdg->transferEncoding))
434 Stream_Free(s, TRUE);
439 Stream_Read_UINT32(s, packetLength);
441 if ((packetLength > INT_MAX) || !Stream_EnsureCapacity(s, packetLength) ||
442 (packetLength < header))
444 Stream_Free(s, TRUE);
448 if (!rdg_read_all(rdg->context, rdg->tlsOut, Stream_Buffer(s) + header, packetLength - header,
449 &rdg->transferEncoding))
451 Stream_Free(s, TRUE);
455 Stream_SetLength(s, packetLength);
459static BOOL rdg_send_handshake(rdpRdg* rdg)
462 wStream* s = Stream_New(
nullptr, 14);
467 Stream_Write_UINT16(s, PKT_TYPE_HANDSHAKE_REQUEST);
468 Stream_Write_UINT16(s, 0);
469 Stream_Write_UINT32(s, 14);
470 Stream_Write_UINT8(s, 1);
471 Stream_Write_UINT8(s, 0);
472 Stream_Write_UINT16(s, 0);
473 Stream_Write_UINT16(s, rdg->extAuth);
474 Stream_SealLength(s);
475 status = rdg_write_packet(rdg, s);
476 Stream_Free(s, TRUE);
480 rdg->state = RDG_CLIENT_STATE_HANDSHAKE;
486static BOOL rdg_send_extauth_sspi(rdpRdg* rdg)
490 UINT32 packetSize = 8 + 4 + 2;
494 const SecBuffer* authToken = credssp_auth_get_output_buffer(rdg->auth);
497 packetSize += authToken->cbBuffer;
499 s = Stream_New(
nullptr, packetSize);
504 Stream_Write_UINT16(s, PKT_TYPE_EXTENDED_AUTH_MSG);
505 Stream_Write_UINT16(s, 0);
506 Stream_Write_UINT32(s, packetSize);
507 Stream_Write_UINT32(s, ERROR_SUCCESS);
508 Stream_Write_UINT16(s, (UINT16)authToken->cbBuffer);
509 Stream_Write(s, authToken->pvBuffer, authToken->cbBuffer);
511 Stream_SealLength(s);
512 status = rdg_write_packet(rdg, s);
513 Stream_Free(s, TRUE);
518static BOOL rdg_send_tunnel_request(rdpRdg* rdg)
522 UINT32 packetSize = 16;
523 UINT16 fieldsPresent = 0;
524 WCHAR* PAACookie =
nullptr;
525 size_t PAACookieLen = 0;
526 const UINT32 capabilities = HTTP_CAPABILITY_TYPE_QUAR_SOH |
527 HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN |
528 HTTP_CAPABILITY_MESSAGING_SERVICE_MSG;
530 if (rdg->extAuth == HTTP_EXTENDED_AUTH_PAA)
533 ConvertUtf8ToWCharAlloc(rdg->context->settings->GatewayAccessToken, &PAACookieLen);
535 if (!PAACookie || (PAACookieLen > UINT16_MAX /
sizeof(WCHAR)))
542 packetSize += 2 + (UINT32)(PAACookieLen) *
sizeof(WCHAR);
543 fieldsPresent = HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE;
546 s = Stream_New(
nullptr, packetSize);
554 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_CREATE);
555 Stream_Write_UINT16(s, 0);
556 Stream_Write_UINT32(s, packetSize);
557 Stream_Write_UINT32(s, capabilities);
558 Stream_Write_UINT16(s, fieldsPresent);
559 Stream_Write_UINT16(s, 0);
563 Stream_Write_UINT16(s, (UINT16)PAACookieLen *
sizeof(WCHAR));
564 Stream_Write_UTF16_String(s, PAACookie, PAACookieLen);
567 Stream_SealLength(s);
568 status = rdg_write_packet(rdg, s);
569 Stream_Free(s, TRUE);
574 rdg->state = RDG_CLIENT_STATE_TUNNEL_CREATE;
580static BOOL rdg_send_tunnel_authorization(rdpRdg* rdg)
585 size_t clientNameLen = 0;
587 rdg->context->settings, FreeRDP_ClientHostname, &clientNameLen);
591 const size_t packetSize = 12ull + clientNameLen *
sizeof(WCHAR);
592 if (!clientName || (clientNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
598 s = Stream_New(
nullptr, packetSize);
606 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_AUTH);
607 Stream_Write_UINT16(s, 0);
608 Stream_Write_UINT32(s, (UINT32)packetSize);
609 Stream_Write_UINT16(s, 0);
610 Stream_Write_UINT16(s, (UINT16)clientNameLen *
sizeof(WCHAR));
611 Stream_Write_UTF16_String(s, clientName, clientNameLen);
612 Stream_SealLength(s);
613 status = rdg_write_packet(rdg, s);
614 Stream_Free(s, TRUE);
619 rdg->state = RDG_CLIENT_STATE_TUNNEL_AUTHORIZE;
625static BOOL rdg_send_channel_create(rdpRdg* rdg)
629 WCHAR* serverName =
nullptr;
630 size_t serverNameLen = 0;
634 FreeRDP_ServerHostname, &serverNameLen);
637 const size_t packetSize = 16ull + serverNameLen *
sizeof(WCHAR);
638 if (!serverName || (serverNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
641 s = Stream_New(
nullptr, packetSize);
646 Stream_Write_UINT16(s, PKT_TYPE_CHANNEL_CREATE);
647 Stream_Write_UINT16(s, 0);
648 Stream_Write_UINT32(s, (UINT32)packetSize);
649 Stream_Write_UINT8(s, 1);
650 Stream_Write_UINT8(s, 0);
651 Stream_Write_UINT16(s,
652 (UINT16)rdg->context->settings->ServerPort);
653 Stream_Write_UINT16(s, 3);
654 Stream_Write_UINT16(s, (UINT16)serverNameLen *
sizeof(WCHAR));
655 Stream_Write_UTF16_String(s, serverName, serverNameLen);
656 Stream_SealLength(s);
657 status = rdg_write_packet(rdg, s);
660 Stream_Free(s, TRUE);
663 rdg->state = RDG_CLIENT_STATE_CHANNEL_CREATE;
668static BOOL rdg_set_auth_header(rdpCredsspAuth* auth, HttpRequest* request)
670 const SecBuffer* authToken = credssp_auth_get_output_buffer(auth);
671 char* base64AuthToken =
nullptr;
675 if (authToken->cbBuffer > INT_MAX)
678 base64AuthToken = crypto_base64_encode(authToken->pvBuffer, authToken->cbBuffer);
683 BOOL rc = http_request_set_auth_scheme(request, credssp_auth_pkg_name(auth)) &&
684 http_request_set_auth_param(request, base64AuthToken);
685 free(base64AuthToken);
694static wStream* rdg_build_http_request(rdpRdg* rdg,
const char* method,
695 TRANSFER_ENCODING transferEncoding)
698 HttpRequest* request =
nullptr;
699 const char* uri =
nullptr;
704 uri = http_context_get_uri(rdg->http);
705 request = http_request_new();
710 if (!http_request_set_method(request, method) || !http_request_set_uri(request, uri))
715 if (!rdg_set_auth_header(rdg->auth, request))
719 else if (rdg->extAuth == HTTP_EXTENDED_AUTH_BEARER)
721 if (!http_request_set_auth_scheme(request,
"Bearer"))
723 if (!http_request_set_auth_param(request, rdg->context->settings->GatewayHttpExtAuthBearer))
727 if (!http_request_set_transfer_encoding(request, transferEncoding))
730 s = http_request_write(rdg->http, request);
732 http_request_free(request);
735 Stream_SealLength(s);
740static BOOL rdg_recv_auth_token(wLog* log, rdpCredsspAuth* auth, HttpResponse* response)
743 size_t authTokenLength = 0;
744 BYTE* authTokenData =
nullptr;
745 SecBuffer authToken = WINPR_C_ARRAY_INIT;
748 if (!auth || !response)
751 const UINT16 StatusCode = http_response_get_status_code(response);
754 case HTTP_STATUS_DENIED:
756 case HTTP_STATUS_SWITCH_PROTOCOLS:
759 http_response_log_error_status(log, WLOG_WARN, response);
763 const char* token64 = http_response_get_auth_token(response, credssp_auth_pkg_name(auth));
767 len = strlen(token64);
769 crypto_base64_decode(token64, len, &authTokenData, &authTokenLength);
771 if (authTokenLength && authTokenData && (authTokenLength <= UINT32_MAX))
773 authToken.pvBuffer = authTokenData;
774 authToken.cbBuffer = (UINT32)authTokenLength;
775 credssp_auth_take_input_buffer(auth, &authToken);
780 rc = credssp_auth_authenticate(auth);
784static BOOL rdg_skip_seed_payload(rdpContext* context, rdpTls* tls,
size_t lastResponseLength,
785 rdg_http_encoding_context* transferEncoding)
787 BYTE seed_payload[10] = WINPR_C_ARRAY_INIT;
788 const size_t size =
sizeof(seed_payload);
793 if (lastResponseLength < size)
795 if (!rdg_read_all(context, tls, seed_payload, size - lastResponseLength, transferEncoding))
804static BOOL rdg_process_handshake_response(rdpRdg* rdg,
wStream* s)
806 UINT32 errorCode = 0;
807 UINT16 serverVersion = 0;
808 UINT16 extendedAuth = 0;
811 const char* error =
nullptr;
812 WLog_Print(rdg->log, WLOG_DEBUG,
"Handshake response received");
814 if (rdg->state != RDG_CLIENT_STATE_HANDSHAKE)
819 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
822 Stream_Read_UINT32(s, errorCode);
823 Stream_Read_UINT8(s, verMajor);
824 Stream_Read_UINT8(s, verMinor);
825 Stream_Read_UINT16(s, serverVersion);
826 Stream_Read_UINT16(s, extendedAuth);
827 error = rpc_error_to_string(errorCode);
828 WLog_Print(rdg->log, WLOG_DEBUG,
829 "errorCode=%s, verMajor=%" PRId8
", verMinor=%" PRId8
", serverVersion=%" PRId16
831 error, verMajor, verMinor, serverVersion, extended_auth_to_string(extendedAuth));
833 if (FAILED((HRESULT)errorCode))
835 WLog_Print(rdg->log, WLOG_ERROR,
"Handshake error %s", error);
836 freerdp_set_last_error_log(rdg->context, errorCode);
840 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
841 return rdg_send_extauth_sspi(rdg);
843 return rdg_send_tunnel_request(rdg);
846static BOOL rdg_process_tunnel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
848 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID)
851 if (!Stream_SafeSeek(s, 4))
853 WLog_Print(rdg->log, WLOG_ERROR,
"Short tunnelId, got %" PRIuz
", expected 4",
854 Stream_GetRemainingLength(s));
859 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CAPS)
862 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
865 Stream_Read_UINT32(s, caps);
866 WLog_Print(rdg->log, WLOG_DEBUG,
"capabilities=%s", capabilities_enum_to_string(caps));
869 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ)
872 if (!Stream_SafeSeek(s, 20))
874 WLog_Print(rdg->log, WLOG_ERROR,
"Short nonce, got %" PRIuz
", expected 20",
875 Stream_GetRemainingLength(s));
880 if (!rdg_read_http_unicode_string(rdg->log, s,
nullptr,
nullptr))
882 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read server certificate");
887 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG)
889 const WCHAR* msg =
nullptr;
890 UINT16 msgLenBytes = 0;
891 rdpContext* context = rdg->context;
893 WINPR_ASSERT(context);
894 WINPR_ASSERT(context->instance);
897 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
899 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read consent message");
903 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
904 GATEWAY_MESSAGE_CONSENT, TRUE, TRUE, msgLenBytes, msg);
910static BOOL rdg_process_tunnel_response(rdpRdg* rdg,
wStream* s)
912 UINT16 serverVersion = 0;
913 UINT16 fieldsPresent = 0;
914 UINT32 errorCode = 0;
915 const char* error =
nullptr;
916 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel response received");
918 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_CREATE)
923 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
926 Stream_Read_UINT16(s, serverVersion);
927 Stream_Read_UINT32(s, errorCode);
928 Stream_Read_UINT16(s, fieldsPresent);
929 Stream_Seek_UINT16(s);
930 error = rpc_error_to_string(errorCode);
931 WLog_Print(rdg->log, WLOG_DEBUG,
"serverVersion=%" PRId16
", errorCode=%s, fieldsPresent=%s",
932 serverVersion, error, tunnel_response_fields_present_to_string(fieldsPresent));
934 if (FAILED((HRESULT)errorCode))
936 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel creation error %s", error);
937 freerdp_set_last_error_log(rdg->context, errorCode);
941 if (!rdg_process_tunnel_response_optional(rdg, s, fieldsPresent))
944 return rdg_send_tunnel_authorization(rdg);
947static BOOL rdg_process_tunnel_authorization_response(rdpRdg* rdg,
wStream* s)
949 UINT32 errorCode = 0;
950 UINT16 fieldsPresent = 0;
951 const char* error =
nullptr;
952 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel authorization received");
954 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_AUTHORIZE)
959 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
962 Stream_Read_UINT32(s, errorCode);
963 Stream_Read_UINT16(s, fieldsPresent);
964 Stream_Seek_UINT16(s);
965 error = rpc_error_to_string(errorCode);
966 WLog_Print(rdg->log, WLOG_DEBUG,
"errorCode=%s, fieldsPresent=%s", error,
967 tunnel_authorization_response_fields_present_to_string(fieldsPresent));
970 if (errorCode != S_OK && errorCode != E_PROXY_QUARANTINE_ACCESSDENIED)
972 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel authorization error %s", error);
973 freerdp_set_last_error_log(rdg->context, errorCode);
977 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS)
979 UINT32 redirFlags = 0;
980 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
982 Stream_Read_UINT32(s, redirFlags);
984 rdpContext* context = rdg->context;
985 if (!utils_apply_gateway_policy(rdg->log, context, redirFlags,
"RDG"))
989 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT)
991 UINT32 idleTimeout = 0;
992 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
994 Stream_Read_UINT32(s, idleTimeout);
995 WLog_Print(rdg->log, WLOG_DEBUG,
"[IDLE_TIMEOUT] idleTimeout=%" PRIu32
": TODO: unused",
999 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE)
1002 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 2))
1004 Stream_Read_UINT16(s, cbLen);
1006 WLog_Print(rdg->log, WLOG_DEBUG,
"[SOH_RESPONSE] cbLen=%" PRIu16
": TODO: unused", cbLen);
1007 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, cbLen))
1009 Stream_Seek(s, cbLen);
1012 return rdg_send_channel_create(rdg);
1015static BOOL rdg_process_extauth_sspi(rdpRdg* rdg,
wStream* s)
1017 INT32 errorCode = 0;
1018 UINT16 authBlobLen = 0;
1019 SecBuffer authToken = WINPR_C_ARRAY_INIT;
1020 BYTE* authTokenData =
nullptr;
1024 Stream_Read_INT32(s, errorCode);
1025 Stream_Read_UINT16(s, authBlobLen);
1027 if (errorCode != ERROR_SUCCESS)
1029 WLog_Print(rdg->log, WLOG_ERROR,
"EXTAUTH_SSPI_NTLM failed with error %s [0x%08X]",
1030 GetSecurityStatusString(errorCode), WINPR_CXX_COMPAT_CAST(UINT32, errorCode));
1034 if (authBlobLen == 0)
1036 if (credssp_auth_is_complete(rdg->auth))
1038 credssp_auth_free(rdg->auth);
1039 rdg->auth =
nullptr;
1040 return rdg_send_tunnel_request(rdg);
1045 authTokenData = malloc(authBlobLen);
1046 if (authTokenData ==
nullptr)
1048 Stream_Read(s, authTokenData, authBlobLen);
1050 authToken.pvBuffer = authTokenData;
1051 authToken.cbBuffer = authBlobLen;
1053 credssp_auth_take_input_buffer(rdg->auth, &authToken);
1055 if (credssp_auth_authenticate(rdg->auth) < 0)
1058 if (credssp_auth_have_output_token(rdg->auth))
1059 return rdg_send_extauth_sspi(rdg);
1064static BOOL rdg_process_channel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
1066 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID) != 0)
1068 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
1070 const UINT32 channelId = Stream_Get_UINT32(s);
1071 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got channelId=%" PRIu32, channelId);
1073 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT) != 0)
1075 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 2))
1077 const UINT16 udpPort = Stream_Get_UINT16(s);
1078 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got udpPort=%" PRIu32, udpPort);
1080 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE) != 0)
1082 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 2))
1084 const UINT16 blobLen = Stream_Get_UINT16(s);
1085 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, blobLen))
1087 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got UDP auth blob=%" PRIu32, blobLen);
1088 if (!Stream_SafeSeek(s, blobLen))
1095static BOOL rdg_process_channel_response(rdpRdg* rdg,
wStream* s)
1097 UINT16 fieldsPresent = 0;
1098 UINT32 errorCode = 0;
1099 const char* error =
nullptr;
1100 WLog_Print(rdg->log, WLOG_DEBUG,
"Channel response received");
1102 if (rdg->state != RDG_CLIENT_STATE_CHANNEL_CREATE)
1107 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1110 Stream_Read_UINT32(s, errorCode);
1111 Stream_Read_UINT16(s, fieldsPresent);
1112 Stream_Seek_UINT16(s);
1113 error = rpc_error_to_string(errorCode);
1114 WLog_Print(rdg->log, WLOG_DEBUG,
"channel response errorCode=%s, fieldsPresent=%s", error,
1115 channel_response_fields_present_to_string(fieldsPresent));
1117 if (FAILED((HRESULT)errorCode))
1119 WLog_Print(rdg->log, WLOG_ERROR,
"channel response errorCode=%s, fieldsPresent=%s", error,
1120 channel_response_fields_present_to_string(fieldsPresent));
1121 freerdp_set_last_error_log(rdg->context, errorCode);
1125 if (!rdg_process_channel_response_optional(rdg, s, fieldsPresent))
1128 rdg->state = RDG_CLIENT_STATE_OPENED;
1132static BOOL rdg_process_packet(rdpRdg* rdg,
wStream* s)
1136 UINT32 packetLength = 0;
1137 Stream_SetPosition(s, 0);
1139 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1142 Stream_Read_UINT16(s, type);
1143 Stream_Seek_UINT16(s);
1144 Stream_Read_UINT32(s, packetLength);
1146 if (Stream_Length(s) < packetLength)
1148 WLog_Print(rdg->log, WLOG_ERROR,
"Short packet %" PRIuz
", expected %" PRIu32,
1149 Stream_Length(s), packetLength);
1155 case PKT_TYPE_HANDSHAKE_RESPONSE:
1156 status = rdg_process_handshake_response(rdg, s);
1159 case PKT_TYPE_TUNNEL_RESPONSE:
1160 status = rdg_process_tunnel_response(rdg, s);
1163 case PKT_TYPE_TUNNEL_AUTH_RESPONSE:
1164 status = rdg_process_tunnel_authorization_response(rdg, s);
1167 case PKT_TYPE_CHANNEL_RESPONSE:
1168 status = rdg_process_channel_response(rdg, s);
1172 WLog_Print(rdg->log, WLOG_ERROR,
"Unexpected packet type DATA");
1176 case PKT_TYPE_EXTENDED_AUTH_MSG:
1177 status = rdg_process_extauth_sspi(rdg, s);
1181 WLog_Print(rdg->log, WLOG_ERROR,
"PKG TYPE 0x%x not implemented", type);
1188 const size_t rem = Stream_GetRemainingLength(s);
1190 WLog_Print(rdg->log, WLOG_WARN,
"[%s] unparsed data detected: %" PRIuz
" bytes",
1191 rdg_pkt_type_to_string(type), rem);
1196DWORD rdg_get_event_handles(rdpRdg* rdg, HANDLE* events, DWORD count)
1199 WINPR_ASSERT(rdg !=
nullptr);
1201 if (rdg->tlsOut && rdg->tlsOut->bio)
1203 if (events && (nCount < count))
1205 BIO_get_event(rdg->tlsOut->bio, &events[nCount]);
1217static BOOL rdg_get_gateway_credentials(rdpContext* context, rdp_auth_reason reason)
1219 freerdp* instance = context->instance;
1221 auth_status rc = utils_authenticate_gateway(instance, reason);
1227 case AUTH_CANCELLED:
1228 freerdp_set_last_error_log(instance->context, FREERDP_ERROR_CONNECT_CANCELLED);
1230 case AUTH_NO_CREDENTIALS:
1231 WLog_INFO(TAG,
"No credentials provided - using nullptr identity");
1239static BOOL rdg_auth_init(rdpRdg* rdg, rdpTls* tls, TCHAR* authPkg)
1241 rdpContext* context = rdg->context;
1242 rdpSettings* settings = context->settings;
1243 SEC_WINNT_AUTH_IDENTITY identity = WINPR_C_ARRAY_INIT;
1246 rdg->auth = credssp_auth_new(context);
1250 if (!credssp_auth_init(rdg->auth, authPkg, tls->Bindings))
1256 if (!smartcard_getCert(context, &rdg->smartcard, TRUE))
1259 if (!rdg_get_gateway_credentials(context, AUTH_SMARTCARD_PIN))
1264 if (!rdg_get_gateway_credentials(context, GW_AUTH_RDG))
1269 if (doSCLogon && !smartcard_getCert(context, &rdg->smartcard, TRUE))
1273 SEC_WINNT_AUTH_IDENTITY* identityArg = &identity;
1276 if (!identity_set_from_smartcard_hash(&identity, settings, FreeRDP_GatewayUsername,
1277 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword,
1278 rdg->smartcard->sha1Hash,
1279 sizeof(rdg->smartcard->sha1Hash)))
1284 if (!identity_set_from_settings(&identity, settings, FreeRDP_GatewayUsername,
1285 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword))
1288 if (!settings->GatewayUsername)
1289 identityArg =
nullptr;
1292 if (!credssp_auth_setup_client(rdg->auth,
"HTTP", settings->GatewayHostname, identityArg,
1293 rdg->smartcard ? rdg->smartcard->pkinitArgs : nullptr))
1295 sspi_FreeAuthIdentity(&identity);
1298 sspi_FreeAuthIdentity(&identity);
1300 credssp_auth_set_flags(rdg->auth, ISC_REQ_CONFIDENTIALITY | ISC_REQ_MUTUAL_AUTH);
1302 rc = credssp_auth_authenticate(rdg->auth);
1306static BOOL rdg_send_http_request(rdpRdg* rdg, rdpTls* tls,
const char* method,
1307 TRANSFER_ENCODING transferEncoding)
1310 wStream* s = rdg_build_http_request(rdg, method, transferEncoding);
1315 const size_t sz = Stream_Length(s);
1316 status = freerdp_tls_write_all(tls, Stream_Buffer(s), sz);
1318 Stream_Free(s, TRUE);
1319 return (status >= 0);
1322static BOOL rdg_tls_connect(rdpRdg* rdg, rdpTls* tls,
const char* peerAddress, UINT32 timeout)
1325 BIO* layerBio =
nullptr;
1326 BIO* bufferedBio =
nullptr;
1328 rdpSettings* settings = rdg->context->settings;
1329 rdpTransport* transport = freerdp_get_transport(rdg->context);
1330 const char* peerHostname = settings->GatewayHostname;
1331 UINT16 peerPort = (UINT16)settings->GatewayPort;
1332 const char* proxyUsername =
nullptr;
1333 const char* proxyPassword =
nullptr;
1334 BOOL isProxyConnection =
1335 proxy_prepare(settings, &peerHostname, &peerPort, &proxyUsername, &proxyPassword);
1337 if (settings->GatewayPort > UINT16_MAX)
1340 layer = transport_connect_layer(transport, peerAddress ? peerAddress : peerHostname, peerPort,
1348 layerBio = BIO_new(BIO_s_transport_layer());
1351 transport_layer_free(layer);
1354 BIO_set_data(layerBio, layer);
1356 bufferedBio = BIO_new(BIO_s_buffered_socket());
1359 BIO_free_all(layerBio);
1363 bufferedBio = BIO_push(bufferedBio, layerBio);
1364 status = BIO_set_nonblock(bufferedBio, TRUE);
1366 if (isProxyConnection)
1368 if (!proxy_connect(rdg->context, bufferedBio, proxyUsername, proxyPassword,
1369 settings->GatewayHostname, (UINT16)settings->GatewayPort))
1371 BIO_free_all(bufferedBio);
1378 BIO_free_all(bufferedBio);
1382 tls->hostname = settings->GatewayHostname;
1383 tls->port = WINPR_ASSERTING_INT_CAST(int32_t, MIN(UINT16_MAX, settings->GatewayPort));
1384 tls->isGatewayTransport = TRUE;
1385 status = freerdp_tls_connect(tls, bufferedBio);
1388 rdpContext* context = rdg->context;
1391 freerdp_set_last_error_if_not(context, FREERDP_ERROR_TLS_CONNECT_FAILED);
1395 freerdp_set_last_error_if_not(context, FREERDP_ERROR_CONNECT_CANCELLED);
1400 return (status >= 1);
1403static BOOL rdg_establish_data_connection(rdpRdg* rdg, rdpTls* tls,
const char* method,
1404 const char* peerAddress, UINT32 timeout,
1407 char buffer[64] = WINPR_C_ARRAY_INIT;
1408 HttpResponse* response =
nullptr;
1410 if (!rdg_tls_connect(rdg, tls, peerAddress, timeout))
1413 WINPR_ASSERT(rpcFallback);
1414 if (rdg->context->settings->GatewayHttpExtAuthBearer && rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1415 rdg->extAuth = HTTP_EXTENDED_AUTH_BEARER;
1416 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1418 if (!rdg_auth_init(rdg, tls, AUTH_PKG))
1421 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1424 response = http_response_recv(tls, TRUE);
1429 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1430 *rpcFallback = TRUE;
1434 (void)http_response_extract_cookies(response, rdg->http);
1436 const UINT16 StatusCode = http_response_get_status_code(response);
1439 case HTTP_STATUS_GONE:
1440 case HTTP_STATUS_FORBIDDEN:
1441 case HTTP_STATUS_NOT_FOUND:
1443 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway does not support HTTP transport.");
1444 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1445 *rpcFallback = TRUE;
1447 http_response_free(response);
1450 case HTTP_STATUS_OK:
1453 case HTTP_STATUS_DENIED:
1454 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1458 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1462 while (!credssp_auth_is_complete(rdg->auth))
1464 if (!rdg_recv_auth_token(rdg->log, rdg->auth, response))
1466 http_response_free(response);
1470 if (credssp_auth_have_output_token(rdg->auth))
1472 http_response_free(response);
1474 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1477 response = http_response_recv(tls, TRUE);
1480 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1481 *rpcFallback = TRUE;
1484 (void)http_response_extract_cookies(response, rdg->http);
1487 credssp_auth_free(rdg->auth);
1488 rdg->auth =
nullptr;
1492 credssp_auth_free(rdg->auth);
1493 rdg->auth =
nullptr;
1495 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1498 response = http_response_recv(tls, TRUE);
1502 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1503 *rpcFallback = TRUE;
1506 (void)http_response_extract_cookies(response, rdg->http);
1509 const UINT16 statusCode = http_response_get_status_code(response);
1510 const size_t bodyLength = http_response_get_body_length(response);
1511 const TRANSFER_ENCODING encoding = http_response_get_transfer_encoding(response);
1512 const BOOL isWebsocket = http_response_is_websocket(rdg->http, response);
1514 WLog_Print(rdg->log, WLOG_DEBUG,
"%s authorization result: %s", method,
1515 freerdp_http_status_string_format(statusCode, buffer, ARRAYSIZE(buffer)));
1519 case HTTP_STATUS_OK:
1522 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1523 http_response_free(response);
1525 case HTTP_STATUS_DENIED:
1526 freerdp_set_last_error_log(rdg->context, FREERDP_ERROR_CONNECT_ACCESS_DENIED);
1527 http_response_free(response);
1529 case HTTP_STATUS_SWITCH_PROTOCOLS:
1530 http_response_free(response);
1537 if (http_context_is_websocket_upgrade_enabled(rdg->http))
1539 long fd = BIO_get_fd(tls->bio,
nullptr);
1541 closesocket((SOCKET)fd);
1542 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1543 return rdg_establish_data_connection(rdg, tls, method, peerAddress, timeout,
1549 rdg->transferEncoding.isWebsocketTransport = TRUE;
1550 if (!websocket_context_reset(rdg->transferEncoding.context.websocket))
1553 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1557 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1562 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1563 http_response_free(response);
1567 if (strcmp(method,
"RDG_OUT_DATA") == 0)
1569 if (encoding == TransferEncodingChunked)
1571 rdg->transferEncoding.httpTransferEncoding = TransferEncodingChunked;
1572 rdg->transferEncoding.context.chunked.nextOffset = 0;
1573 rdg->transferEncoding.context.chunked.headerFooterPos = 0;
1574 rdg->transferEncoding.context.chunked.state = ChunkStateLenghHeader;
1576 if (!rdg_skip_seed_payload(rdg->context, tls, bodyLength, &rdg->transferEncoding))
1583 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingChunked))
1586 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1590 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1598static BOOL rdg_tunnel_connect(rdpRdg* rdg)
1602 rdg_send_handshake(rdg);
1604 while (rdg->state < RDG_CLIENT_STATE_OPENED)
1607 s = rdg_receive_packet(rdg);
1611 status = rdg_process_packet(rdg, s);
1612 Stream_Free(s, TRUE);
1618 WINPR_ASSERT(rdg->context);
1619 WINPR_ASSERT(rdg->context->rdp);
1620 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1628BOOL rdg_connect(rdpRdg* rdg, DWORD timeout, BOOL* rpcFallback)
1631 SOCKET outConnSocket = 0;
1632 char* peerAddress =
nullptr;
1633 BOOL rpcFallbackLocal = FALSE;
1635 WINPR_ASSERT(rdg !=
nullptr);
1636 freerdp_set_last_error(rdg->context, ERROR_SUCCESS);
1637 status = rdg_establish_data_connection(rdg, rdg->tlsOut,
"RDG_OUT_DATA",
nullptr, timeout,
1642 if (rdg->transferEncoding.isWebsocketTransport)
1644 WLog_Print(rdg->log, WLOG_DEBUG,
"Upgraded to websocket. RDG_IN_DATA not required");
1651 BIO_get_socket(rdg->tlsOut->underlying, &outConnSocket);
1652 peerAddress = freerdp_tcp_get_peer_address(outConnSocket);
1653 status = rdg_establish_data_connection(rdg, rdg->tlsIn,
"RDG_IN_DATA", peerAddress,
1654 timeout, &rpcFallbackLocal);
1660 *rpcFallback = rpcFallbackLocal;
1665 WINPR_ASSERT(rdg->context);
1666 WINPR_ASSERT(rdg->context->rdp);
1667 if (rpcFallbackLocal)
1669 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1670 credssp_auth_free(rdg->auth);
1671 rdg->auth =
nullptr;
1674 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1678 status = rdg_tunnel_connect(rdg);
1683static int rdg_write_websocket_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1689 const size_t payloadSize = (size_t)isize + 10;
1697 websocket_context_packet_new(payloadSize, WebsocketBinaryOpcode, &maskingKey.u32);
1701 Stream_Write_UINT16(
1702 sWS, WINPR_ASSERTING_INT_CAST(
1703 uint16_t, PKT_TYPE_DATA ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1704 Stream_Write_UINT16(
1705 sWS, WINPR_ASSERTING_INT_CAST(
1706 uint16_t, 0 ^ (maskingKey.u8[2] | maskingKey.u8[3] << 8)));
1707 Stream_Write_UINT32(
1708 sWS, WINPR_ASSERTING_INT_CAST(uint32_t, payloadSize ^ maskingKey.u32));
1709 Stream_Write_UINT16(
1710 sWS, WINPR_ASSERTING_INT_CAST(
1711 uint16_t, isize ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1714 maskingKey.u32 = (maskingKey.u32 & 0xffff) << 16 | (maskingKey.u32 >> 16);
1716 WINPR_ASSERT(rdg->tlsOut);
1717 wStream sPacket = WINPR_C_ARRAY_INIT;
1718 Stream_StaticConstInit(&sPacket, buf, (
size_t)isize);
1719 if (!websocket_context_mask_and_send(rdg->tlsOut->bio, sWS, &sPacket, maskingKey.u32))
1725static int rdg_write_chunked_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1731 if (isize > UINT16_MAX)
1734 const size_t size = (size_t)isize;
1738 const size_t packetSize = size + 10;
1739 char chunkSize[11] = WINPR_C_ARRAY_INIT;
1740 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIxz
"\r\n", packetSize);
1741 sChunk = Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + packetSize + 2);
1746 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
1747 Stream_Write_UINT16(sChunk, PKT_TYPE_DATA);
1748 Stream_Write_UINT16(sChunk, 0);
1749 Stream_Write_UINT32(sChunk, (UINT32)packetSize);
1750 Stream_Write_UINT16(sChunk, (UINT16)size);
1751 Stream_Write(sChunk, buf, size);
1752 Stream_Write(sChunk,
"\r\n", 2);
1753 Stream_SealLength(sChunk);
1754 len = Stream_Length(sChunk);
1756 status = freerdp_tls_write_all(rdg->tlsIn, Stream_Buffer(sChunk), len);
1757 Stream_Free(sChunk, TRUE);
1765static int rdg_write_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1768 if (rdg->transferEncoding.isWebsocketTransport)
1769 return rdg_write_websocket_data_packet(rdg, buf, isize);
1771 return rdg_write_chunked_data_packet(rdg, buf, isize);
1774static BOOL rdg_process_close_packet(rdpRdg* rdg,
wStream* s)
1778 UINT32 errorCode = 0;
1779 UINT32 packetSize = 12;
1782 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1784 Stream_Read_UINT32(s, errorCode);
1787 freerdp_set_last_error_log(rdg->context, errorCode);
1789 sClose = Stream_New(
nullptr, packetSize);
1793 Stream_Write_UINT16(sClose, PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
1794 Stream_Write_UINT16(sClose, 0);
1795 Stream_Write_UINT32(sClose, packetSize);
1796 Stream_Write_UINT32(sClose, 0);
1797 Stream_SealLength(sClose);
1798 status = rdg_write_packet(rdg, sClose);
1799 Stream_Free(sClose, TRUE);
1801 return ((status >= 0));
1804static BOOL rdg_process_keep_alive_packet(rdpRdg* rdg)
1807 wStream* sKeepAlive =
nullptr;
1808 size_t packetSize = 8;
1810 sKeepAlive = Stream_New(
nullptr, packetSize);
1815 Stream_Write_UINT16(sKeepAlive, PKT_TYPE_KEEPALIVE);
1816 Stream_Write_UINT16(sKeepAlive, 0);
1817 Stream_Write_UINT32(sKeepAlive, (UINT32)packetSize);
1818 Stream_SealLength(sKeepAlive);
1819 status = rdg_write_packet(rdg, sKeepAlive);
1820 Stream_Free(sKeepAlive, TRUE);
1822 return ((status >= 0));
1825static BOOL rdg_process_service_message(rdpRdg* rdg,
wStream* s)
1827 const WCHAR* msg =
nullptr;
1828 UINT16 msgLenBytes = 0;
1829 rdpContext* context = rdg->context;
1830 WINPR_ASSERT(context);
1831 WINPR_ASSERT(context->instance);
1834 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
1836 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read string");
1840 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
1841 GATEWAY_MESSAGE_SERVICE, TRUE, FALSE, msgLenBytes, msg);
1844static BOOL rdg_process_unknown_packet(rdpRdg* rdg,
int type)
1848 WLog_Print(rdg->log, WLOG_WARN,
"Unknown Control Packet received: %" PRIX32,
1849 WINPR_CXX_COMPAT_CAST(UINT32, type));
1853static BOOL rdg_process_control_packet(rdpRdg* rdg,
int type,
size_t packetLength)
1856 size_t readCount = 0;
1858 size_t payloadSize = packetLength -
sizeof(RdgPacketHeader);
1860 if (packetLength <
sizeof(RdgPacketHeader))
1864 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1868 s = Stream_New(
nullptr, payloadSize);
1873 while (readCount < payloadSize)
1875 if (rdg_shall_abort(rdg))
1877 Stream_Free(s, TRUE);
1880 status = rdg_socket_read(rdg->tlsOut->bio, Stream_Pointer(s), payloadSize - readCount,
1881 &rdg->transferEncoding);
1885 if (!BIO_should_retry(rdg->tlsOut->bio))
1887 Stream_Free(s, TRUE);
1894 Stream_Seek(s, (
size_t)status);
1895 readCount += (size_t)status;
1897 if (readCount > INT_MAX)
1899 Stream_Free(s, TRUE);
1904 Stream_SetPosition(s, 0);
1909 case PKT_TYPE_CLOSE_CHANNEL:
1910 EnterCriticalSection(&rdg->writeSection);
1911 status = rdg_process_close_packet(rdg, s);
1912 LeaveCriticalSection(&rdg->writeSection);
1915 case PKT_TYPE_KEEPALIVE:
1916 EnterCriticalSection(&rdg->writeSection);
1917 status = rdg_process_keep_alive_packet(rdg);
1918 LeaveCriticalSection(&rdg->writeSection);
1921 case PKT_TYPE_SERVICE_MESSAGE:
1924 WLog_Print(rdg->log, WLOG_ERROR,
1925 "PKT_TYPE_SERVICE_MESSAGE requires payload but none was sent");
1928 status = rdg_process_service_message(rdg, s);
1931 case PKT_TYPE_REAUTH_MESSAGE:
1933 status = rdg_process_unknown_packet(rdg, type);
1937 Stream_Free(s, TRUE);
1941static int rdg_read_data_packet(rdpRdg* rdg, BYTE* buffer,
size_t size)
1943 RdgPacketHeader header = WINPR_C_ARRAY_INIT;
1944 size_t readCount = 0;
1945 size_t readSize = 0;
1948 if (!rdg->packetRemainingCount)
1951 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1953 while (readCount <
sizeof(RdgPacketHeader))
1955 if (rdg_shall_abort(rdg))
1958 status = rdg_socket_read(rdg->tlsOut->bio, (BYTE*)(&header) + readCount,
1959 sizeof(RdgPacketHeader) - readCount, &rdg->transferEncoding);
1963 if (!BIO_should_retry(rdg->tlsOut->bio))
1969 BIO_wait_read(rdg->tlsOut->bio, 50);
1973 readCount += (size_t)status;
1975 if (readCount > INT_MAX)
1979 if (header.type != PKT_TYPE_DATA)
1981 status = rdg_process_control_packet(rdg, header.type, header.packetLength);
1991 while (readCount < 2)
1993 if (rdg_shall_abort(rdg))
1996 rdg_socket_read(rdg->tlsOut->bio, (BYTE*)(&rdg->packetRemainingCount) + readCount,
1997 2 - readCount, &rdg->transferEncoding);
2001 if (!BIO_should_retry(rdg->tlsOut->bio))
2004 BIO_wait_read(rdg->tlsOut->bio, 50);
2008 readCount += (size_t)status;
2012 readSize = (rdg->packetRemainingCount < size) ? rdg->packetRemainingCount : size;
2013 status = rdg_socket_read(rdg->tlsOut->bio, buffer, readSize, &rdg->transferEncoding);
2017 if (!BIO_should_retry(rdg->tlsOut->bio))
2025 rdg->packetRemainingCount -= status;
2029static int rdg_bio_write(BIO* bio,
const char* buf,
int num)
2032 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2036 BIO_clear_flags(bio, BIO_FLAGS_WRITE);
2037 EnterCriticalSection(&rdg->writeSection);
2038 status = rdg_write_data_packet(rdg, (
const BYTE*)buf, num);
2039 LeaveCriticalSection(&rdg->writeSection);
2043 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2046 else if (status < num)
2048 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2049 WSASetLastError(WSAEWOULDBLOCK);
2053 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2059static int rdg_bio_read(BIO* bio,
char* buf,
int size)
2062 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2065 status = rdg_read_data_packet(rdg, (BYTE*)buf, (
size_t)size);
2069 BIO_clear_retry_flags(bio);
2072 else if (status == 0)
2074 BIO_set_retry_read(bio);
2075 WSASetLastError(WSAEWOULDBLOCK);
2080 BIO_set_flags(bio, BIO_FLAGS_READ);
2086static int rdg_bio_puts(BIO* bio,
const char* str)
2094static int rdg_bio_gets(BIO* bio,
char* str,
int size)
2102static long rdg_bio_ctrl(BIO* in_bio,
int cmd,
long arg1,
void* arg2)
2105 rdpRdg* rdg = (rdpRdg*)BIO_get_data(in_bio);
2106 rdpTls* tlsOut = rdg->tlsOut;
2107 rdpTls* tlsIn = rdg->tlsIn;
2109 if (cmd == BIO_CTRL_FLUSH)
2111 (void)BIO_flush(tlsOut->bio);
2112 if (!rdg->transferEncoding.isWebsocketTransport)
2113 (void)BIO_flush(tlsIn->bio);
2116 else if (cmd == BIO_C_SET_NONBLOCK)
2120 else if (cmd == BIO_C_READ_BLOCKED)
2122 BIO* cbio = tlsOut->bio;
2123 status = BIO_read_blocked(cbio);
2125 else if (cmd == BIO_C_WRITE_BLOCKED)
2127 BIO* cbio = tlsIn->bio;
2129 if (rdg->transferEncoding.isWebsocketTransport)
2132 status = BIO_write_blocked(cbio);
2134 else if (cmd == BIO_C_WAIT_READ)
2136 int timeout = (int)arg1;
2137 BIO* cbio = tlsOut->bio;
2139 if (BIO_read_blocked(cbio))
2140 return BIO_wait_read(cbio, timeout);
2141 else if (BIO_write_blocked(cbio))
2142 return BIO_wait_write(cbio, timeout);
2146 else if (cmd == BIO_C_WAIT_WRITE)
2148 int timeout = (int)arg1;
2149 BIO* cbio = tlsIn->bio;
2151 if (rdg->transferEncoding.isWebsocketTransport)
2154 if (BIO_write_blocked(cbio))
2155 status = BIO_wait_write(cbio, timeout);
2156 else if (BIO_read_blocked(cbio))
2157 status = BIO_wait_read(cbio, timeout);
2161 else if (cmd == BIO_C_GET_EVENT || cmd == BIO_C_GET_FD)
2171 status = BIO_ctrl(tlsOut->bio, cmd, arg1, arg2);
2173#if OPENSSL_VERSION_NUMBER >= 0x30000000L
2174 else if (cmd == BIO_CTRL_GET_KTLS_SEND)
2182 else if (cmd == BIO_CTRL_GET_KTLS_RECV)
2193static int rdg_bio_new(BIO* bio)
2195 BIO_set_init(bio, 1);
2196 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2200static int rdg_bio_free(BIO* bio)
2206static BIO_METHOD* BIO_s_rdg(
void)
2208 static BIO_METHOD* bio_methods =
nullptr;
2210 if (bio_methods ==
nullptr)
2212 if (!(bio_methods = BIO_meth_new(BIO_TYPE_TSG,
"RDGateway")))
2215 BIO_meth_set_write(bio_methods, rdg_bio_write);
2216 BIO_meth_set_read(bio_methods, rdg_bio_read);
2217 BIO_meth_set_puts(bio_methods, rdg_bio_puts);
2218 BIO_meth_set_gets(bio_methods, rdg_bio_gets);
2219 BIO_meth_set_ctrl(bio_methods, rdg_bio_ctrl);
2220 BIO_meth_set_create(bio_methods, rdg_bio_new);
2221 BIO_meth_set_destroy(bio_methods, rdg_bio_free);
2227rdpRdg* rdg_new(rdpContext* context)
2232 rdpRdg* rdg = (rdpRdg*)calloc(1,
sizeof(rdpRdg));
2236 rdg->log = WLog_Get(TAG);
2237 rdg->state = RDG_CLIENT_STATE_INITIAL;
2238 rdg->context = context;
2240 (rdg->context->settings->GatewayHttpExtAuthSspiNtlm ? HTTP_EXTENDED_AUTH_SSPI_NTLM
2241 : HTTP_EXTENDED_AUTH_NONE);
2243 if (rdg->context->settings->GatewayAccessToken)
2244 rdg->extAuth = HTTP_EXTENDED_AUTH_PAA;
2246 UuidCreate(&rdg->guid);
2248 rdg->tlsOut = freerdp_tls_new(rdg->context);
2251 goto rdg_alloc_error;
2253 rdg->tlsIn = freerdp_tls_new(rdg->context);
2256 goto rdg_alloc_error;
2258 rdg->http = http_context_new();
2261 goto rdg_alloc_error;
2263 if (!http_context_set_uri(rdg->http,
"/remoteDesktopGateway/") ||
2264 !http_context_set_accept(rdg->http,
"*/*") ||
2265 !http_context_set_cache_control(rdg->http,
"no-cache") ||
2266 !http_context_set_pragma(rdg->http,
"no-cache") ||
2267 !http_context_set_connection(rdg->http,
"Keep-Alive") ||
2268 !http_context_set_user_agent(rdg->http,
"MS-RDGateway/1.0") ||
2269 !http_context_set_host(rdg->http, rdg->context->settings->GatewayHostname) ||
2270 !http_context_set_rdg_connection_id(rdg->http, &rdg->guid) ||
2271 !http_context_set_rdg_correlation_id(rdg->http, &rdg->guid) ||
2272 !http_context_enable_websocket_upgrade(
2276 goto rdg_alloc_error;
2279 if (rdg->extAuth != HTTP_EXTENDED_AUTH_NONE)
2281 switch (rdg->extAuth)
2283 case HTTP_EXTENDED_AUTH_PAA:
2284 if (!http_context_set_rdg_auth_scheme(rdg->http,
"PAA"))
2285 goto rdg_alloc_error;
2289 case HTTP_EXTENDED_AUTH_SSPI_NTLM:
2290 if (!http_context_set_rdg_auth_scheme(rdg->http,
"SSPI_NTLM"))
2291 goto rdg_alloc_error;
2296 WLog_Print(rdg->log, WLOG_DEBUG,
2297 "RDG extended authentication method %d not supported", rdg->extAuth);
2301 rdg->frontBio = BIO_new(BIO_s_rdg());
2304 goto rdg_alloc_error;
2306 BIO_set_data(rdg->frontBio, rdg);
2307 InitializeCriticalSection(&rdg->writeSection);
2309 rdg->transferEncoding.httpTransferEncoding = TransferEncodingIdentity;
2310 rdg->transferEncoding.isWebsocketTransport = FALSE;
2312 rdg->transferEncoding.context.websocket = websocket_context_new();
2313 if (!rdg->transferEncoding.context.websocket)
2314 goto rdg_alloc_error;
2318 WINPR_PRAGMA_DIAG_PUSH
2319 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2321 WINPR_PRAGMA_DIAG_POP
2325void rdg_free(rdpRdg* rdg)
2330 freerdp_tls_free(rdg->tlsOut);
2331 freerdp_tls_free(rdg->tlsIn);
2332 http_context_free(rdg->http);
2333 credssp_auth_free(rdg->auth);
2336 BIO_free_all(rdg->frontBio);
2338 DeleteCriticalSection(&rdg->writeSection);
2340 smartcardCertInfo_Free(rdg->smartcard);
2342 websocket_context_free(rdg->transferEncoding.context.websocket);
2347BIO* rdg_get_front_bio_and_take_ownership(rdpRdg* rdg)
2352 rdg->attached = TRUE;
2353 return rdg->frontBio;
WINPR_ATTR_NODISCARD 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.