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))
436 Stream_Read_UINT32(s, packetLength);
438 if ((packetLength > INT_MAX) || !Stream_EnsureCapacity(s, packetLength) ||
439 (packetLength < header))
442 if (!rdg_read_all(rdg->context, rdg->tlsOut, Stream_Buffer(s) + header, packetLength - header,
443 &rdg->transferEncoding))
446 if (!Stream_SetLength(s, packetLength))
451 Stream_Free(s, TRUE);
455static BOOL rdg_send_handshake(rdpRdg* rdg)
458 wStream* s = Stream_New(
nullptr, 14);
463 Stream_Write_UINT16(s, PKT_TYPE_HANDSHAKE_REQUEST);
464 Stream_Write_UINT16(s, 0);
465 Stream_Write_UINT32(s, 14);
466 Stream_Write_UINT8(s, 1);
467 Stream_Write_UINT8(s, 0);
468 Stream_Write_UINT16(s, 0);
469 Stream_Write_UINT16(s, rdg->extAuth);
470 Stream_SealLength(s);
471 status = rdg_write_packet(rdg, s);
472 Stream_Free(s, TRUE);
476 rdg->state = RDG_CLIENT_STATE_HANDSHAKE;
482static BOOL rdg_send_extauth_sspi(rdpRdg* rdg)
486 UINT32 packetSize = 8 + 4 + 2;
490 const SecBuffer* authToken = credssp_auth_get_output_buffer(rdg->auth);
493 packetSize += authToken->cbBuffer;
495 s = Stream_New(
nullptr, packetSize);
500 Stream_Write_UINT16(s, PKT_TYPE_EXTENDED_AUTH_MSG);
501 Stream_Write_UINT16(s, 0);
502 Stream_Write_UINT32(s, packetSize);
503 Stream_Write_UINT32(s, ERROR_SUCCESS);
504 Stream_Write_UINT16(s, (UINT16)authToken->cbBuffer);
505 Stream_Write(s, authToken->pvBuffer, authToken->cbBuffer);
507 Stream_SealLength(s);
508 status = rdg_write_packet(rdg, s);
509 Stream_Free(s, TRUE);
514static BOOL rdg_send_tunnel_request(rdpRdg* rdg)
518 UINT32 packetSize = 16;
519 UINT16 fieldsPresent = 0;
520 WCHAR* PAACookie =
nullptr;
521 size_t PAACookieLen = 0;
522 const UINT32 capabilities = HTTP_CAPABILITY_TYPE_QUAR_SOH |
523 HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN |
524 HTTP_CAPABILITY_MESSAGING_SERVICE_MSG;
526 if (rdg->extAuth == HTTP_EXTENDED_AUTH_PAA)
529 ConvertUtf8ToWCharAlloc(rdg->context->settings->GatewayAccessToken, &PAACookieLen);
531 if (!PAACookie || (PAACookieLen > UINT16_MAX /
sizeof(WCHAR)))
535 packetSize += 2 + (UINT32)(PAACookieLen) *
sizeof(WCHAR);
536 fieldsPresent = HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE;
539 s = Stream_New(
nullptr, packetSize);
544 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_CREATE);
545 Stream_Write_UINT16(s, 0);
546 Stream_Write_UINT32(s, packetSize);
547 Stream_Write_UINT32(s, capabilities);
548 Stream_Write_UINT16(s, fieldsPresent);
549 Stream_Write_UINT16(s, 0);
553 Stream_Write_UINT16(s, (UINT16)PAACookieLen *
sizeof(WCHAR));
554 if (!Stream_Write_UTF16_String(s, PAACookie, PAACookieLen))
558 Stream_SealLength(s);
559 status = rdg_write_packet(rdg, s);
562 Stream_Free(s, TRUE);
567 rdg->state = RDG_CLIENT_STATE_TUNNEL_CREATE;
573static BOOL rdg_send_tunnel_authorization(rdpRdg* rdg)
578 size_t clientNameLen = 0;
580 rdg->context->settings, FreeRDP_ClientHostname, &clientNameLen);
584 const size_t packetSize = 12ull + clientNameLen *
sizeof(WCHAR);
585 if (!clientName || (clientNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
588 s = Stream_New(
nullptr, packetSize);
593 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_AUTH);
594 Stream_Write_UINT16(s, 0);
595 Stream_Write_UINT32(s, (UINT32)packetSize);
596 Stream_Write_UINT16(s, 0);
597 Stream_Write_UINT16(s, (UINT16)clientNameLen *
sizeof(WCHAR));
598 if (!Stream_Write_UTF16_String(s, clientName, clientNameLen))
600 Stream_SealLength(s);
601 status = rdg_write_packet(rdg, s);
604 Stream_Free(s, TRUE);
608 rdg->state = RDG_CLIENT_STATE_TUNNEL_AUTHORIZE;
613static BOOL rdg_send_channel_create(rdpRdg* rdg)
617 WCHAR* serverName =
nullptr;
618 size_t serverNameLen = 0;
622 FreeRDP_ServerHostname, &serverNameLen);
625 const size_t packetSize = 16ull + serverNameLen *
sizeof(WCHAR);
626 if (!serverName || (serverNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
629 s = Stream_New(
nullptr, packetSize);
634 Stream_Write_UINT16(s, PKT_TYPE_CHANNEL_CREATE);
635 Stream_Write_UINT16(s, 0);
636 Stream_Write_UINT32(s, (UINT32)packetSize);
637 Stream_Write_UINT8(s, 1);
638 Stream_Write_UINT8(s, 0);
639 Stream_Write_UINT16(s,
640 (UINT16)rdg->context->settings->ServerPort);
641 Stream_Write_UINT16(s, 3);
642 Stream_Write_UINT16(s, (UINT16)serverNameLen *
sizeof(WCHAR));
643 if (!Stream_Write_UTF16_String(s, serverName, serverNameLen))
646 Stream_SealLength(s);
647 status = rdg_write_packet(rdg, s);
650 Stream_Free(s, TRUE);
653 rdg->state = RDG_CLIENT_STATE_CHANNEL_CREATE;
658static BOOL rdg_set_auth_header(rdpCredsspAuth* auth, HttpRequest* request)
660 const SecBuffer* authToken = credssp_auth_get_output_buffer(auth);
661 char* base64AuthToken =
nullptr;
665 if (authToken->cbBuffer > INT_MAX)
668 base64AuthToken = crypto_base64_encode(authToken->pvBuffer, authToken->cbBuffer);
673 BOOL rc = http_request_set_auth_scheme(request, credssp_auth_pkg_name(auth)) &&
674 http_request_set_auth_param(request, base64AuthToken);
675 free(base64AuthToken);
684static wStream* rdg_build_http_request(rdpRdg* rdg,
const char* method,
685 TRANSFER_ENCODING transferEncoding)
688 HttpRequest* request =
nullptr;
689 const char* uri =
nullptr;
694 uri = http_context_get_uri(rdg->http);
695 request = http_request_new();
700 if (!http_request_set_method(request, method) || !http_request_set_uri(request, uri))
705 if (!rdg_set_auth_header(rdg->auth, request))
709 else if (rdg->extAuth == HTTP_EXTENDED_AUTH_BEARER)
711 if (!http_request_set_auth_scheme(request,
"Bearer"))
713 if (!http_request_set_auth_param(request, rdg->context->settings->GatewayHttpExtAuthBearer))
717 if (!http_request_set_transfer_encoding(request, transferEncoding))
720 s = http_request_write(rdg->http, request);
722 http_request_free(request);
725 Stream_SealLength(s);
730static BOOL rdg_recv_auth_token(wLog* log, rdpCredsspAuth* auth, HttpResponse* response)
733 size_t authTokenLength = 0;
734 BYTE* authTokenData =
nullptr;
735 SecBuffer authToken = WINPR_C_ARRAY_INIT;
738 if (!auth || !response)
741 const UINT16 StatusCode = http_response_get_status_code(response);
744 case HTTP_STATUS_DENIED:
746 case HTTP_STATUS_SWITCH_PROTOCOLS:
749 http_response_log_error_status(log, WLOG_WARN, response);
753 const char* token64 = http_response_get_auth_token(response, credssp_auth_pkg_name(auth));
757 len = strlen(token64);
759 crypto_base64_decode(token64, len, &authTokenData, &authTokenLength);
761 if (authTokenLength && authTokenData && (authTokenLength <= UINT32_MAX))
763 authToken.pvBuffer = authTokenData;
764 authToken.cbBuffer = (UINT32)authTokenLength;
765 credssp_auth_take_input_buffer(auth, &authToken);
770 rc = credssp_auth_authenticate(auth);
774static BOOL rdg_skip_seed_payload(rdpContext* context, rdpTls* tls,
size_t lastResponseLength,
775 rdg_http_encoding_context* transferEncoding)
777 BYTE seed_payload[10] = WINPR_C_ARRAY_INIT;
778 const size_t size =
sizeof(seed_payload);
783 if (lastResponseLength < size)
785 if (!rdg_read_all(context, tls, seed_payload, size - lastResponseLength, transferEncoding))
794static BOOL rdg_process_handshake_response(rdpRdg* rdg,
wStream* s)
796 UINT32 errorCode = 0;
797 UINT16 serverVersion = 0;
798 UINT16 extendedAuth = 0;
801 const char* error =
nullptr;
802 WLog_Print(rdg->log, WLOG_DEBUG,
"Handshake response received");
804 if (rdg->state != RDG_CLIENT_STATE_HANDSHAKE)
809 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
812 Stream_Read_UINT32(s, errorCode);
813 Stream_Read_UINT8(s, verMajor);
814 Stream_Read_UINT8(s, verMinor);
815 Stream_Read_UINT16(s, serverVersion);
816 Stream_Read_UINT16(s, extendedAuth);
817 error = rpc_error_to_string(errorCode);
818 WLog_Print(rdg->log, WLOG_DEBUG,
819 "errorCode=%s, verMajor=%" PRId8
", verMinor=%" PRId8
", serverVersion=%" PRId16
821 error, verMajor, verMinor, serverVersion, extended_auth_to_string(extendedAuth));
823 if (FAILED((HRESULT)errorCode))
825 WLog_Print(rdg->log, WLOG_ERROR,
"Handshake error %s", error);
826 freerdp_set_last_error_log(rdg->context, errorCode);
830 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
831 return rdg_send_extauth_sspi(rdg);
833 return rdg_send_tunnel_request(rdg);
836static BOOL rdg_process_tunnel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
838 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID)
841 if (!Stream_SafeSeek(s, 4))
843 WLog_Print(rdg->log, WLOG_ERROR,
"Short tunnelId, got %" PRIuz
", expected 4",
844 Stream_GetRemainingLength(s));
849 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CAPS)
852 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
855 Stream_Read_UINT32(s, caps);
856 WLog_Print(rdg->log, WLOG_DEBUG,
"capabilities=%s", capabilities_enum_to_string(caps));
859 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ)
862 if (!Stream_SafeSeek(s, 20))
864 WLog_Print(rdg->log, WLOG_ERROR,
"Short nonce, got %" PRIuz
", expected 20",
865 Stream_GetRemainingLength(s));
870 if (!rdg_read_http_unicode_string(rdg->log, s,
nullptr,
nullptr))
872 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read server certificate");
877 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG)
879 const WCHAR* msg =
nullptr;
880 UINT16 msgLenBytes = 0;
881 rdpContext* context = rdg->context;
883 WINPR_ASSERT(context);
884 WINPR_ASSERT(context->instance);
887 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
889 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read consent message");
893 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
894 GATEWAY_MESSAGE_CONSENT, TRUE, TRUE, msgLenBytes, msg);
900static BOOL rdg_process_tunnel_response(rdpRdg* rdg,
wStream* s)
902 UINT16 serverVersion = 0;
903 UINT16 fieldsPresent = 0;
904 UINT32 errorCode = 0;
905 const char* error =
nullptr;
906 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel response received");
908 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_CREATE)
913 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
916 Stream_Read_UINT16(s, serverVersion);
917 Stream_Read_UINT32(s, errorCode);
918 Stream_Read_UINT16(s, fieldsPresent);
919 Stream_Seek_UINT16(s);
920 error = rpc_error_to_string(errorCode);
921 WLog_Print(rdg->log, WLOG_DEBUG,
"serverVersion=%" PRId16
", errorCode=%s, fieldsPresent=%s",
922 serverVersion, error, tunnel_response_fields_present_to_string(fieldsPresent));
924 if (FAILED((HRESULT)errorCode))
926 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel creation error %s", error);
927 freerdp_set_last_error_log(rdg->context, errorCode);
931 if (!rdg_process_tunnel_response_optional(rdg, s, fieldsPresent))
934 return rdg_send_tunnel_authorization(rdg);
937static BOOL rdg_process_tunnel_authorization_response(rdpRdg* rdg,
wStream* s)
939 UINT32 errorCode = 0;
940 UINT16 fieldsPresent = 0;
941 const char* error =
nullptr;
942 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel authorization received");
944 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_AUTHORIZE)
949 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
952 Stream_Read_UINT32(s, errorCode);
953 Stream_Read_UINT16(s, fieldsPresent);
954 Stream_Seek_UINT16(s);
955 error = rpc_error_to_string(errorCode);
956 WLog_Print(rdg->log, WLOG_DEBUG,
"errorCode=%s, fieldsPresent=%s", error,
957 tunnel_authorization_response_fields_present_to_string(fieldsPresent));
960 if (errorCode != S_OK && errorCode != E_PROXY_QUARANTINE_ACCESSDENIED)
962 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel authorization error %s", error);
963 freerdp_set_last_error_log(rdg->context, errorCode);
967 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS)
969 UINT32 redirFlags = 0;
970 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
972 Stream_Read_UINT32(s, redirFlags);
974 rdpContext* context = rdg->context;
975 if (!utils_apply_gateway_policy(rdg->log, context, redirFlags,
"RDG"))
979 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT)
981 UINT32 idleTimeout = 0;
982 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
984 Stream_Read_UINT32(s, idleTimeout);
985 WLog_Print(rdg->log, WLOG_DEBUG,
"[IDLE_TIMEOUT] idleTimeout=%" PRIu32
": TODO: unused",
989 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE)
992 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 2))
994 Stream_Read_UINT16(s, cbLen);
996 WLog_Print(rdg->log, WLOG_DEBUG,
"[SOH_RESPONSE] cbLen=%" PRIu16
": TODO: unused", cbLen);
997 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, cbLen))
999 Stream_Seek(s, cbLen);
1002 return rdg_send_channel_create(rdg);
1005static BOOL rdg_process_extauth_sspi(rdpRdg* rdg,
wStream* s)
1007 INT32 errorCode = 0;
1008 UINT16 authBlobLen = 0;
1009 SecBuffer authToken = WINPR_C_ARRAY_INIT;
1010 BYTE* authTokenData =
nullptr;
1014 Stream_Read_INT32(s, errorCode);
1015 Stream_Read_UINT16(s, authBlobLen);
1017 if (errorCode != ERROR_SUCCESS)
1019 WLog_Print(rdg->log, WLOG_ERROR,
"EXTAUTH_SSPI_NTLM failed with error %s [0x%08X]",
1020 GetSecurityStatusString(errorCode), WINPR_CXX_COMPAT_CAST(UINT32, errorCode));
1024 if (authBlobLen == 0)
1026 if (credssp_auth_is_complete(rdg->auth))
1028 credssp_auth_free(rdg->auth);
1029 rdg->auth =
nullptr;
1030 return rdg_send_tunnel_request(rdg);
1035 authTokenData = malloc(authBlobLen);
1036 if (authTokenData ==
nullptr)
1038 Stream_Read(s, authTokenData, authBlobLen);
1040 authToken.pvBuffer = authTokenData;
1041 authToken.cbBuffer = authBlobLen;
1043 credssp_auth_take_input_buffer(rdg->auth, &authToken);
1045 if (credssp_auth_authenticate(rdg->auth) < 0)
1048 if (credssp_auth_have_output_token(rdg->auth))
1049 return rdg_send_extauth_sspi(rdg);
1054static BOOL rdg_process_channel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
1056 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID) != 0)
1058 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
1060 const UINT32 channelId = Stream_Get_UINT32(s);
1061 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got channelId=%" PRIu32, channelId);
1063 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT) != 0)
1065 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 2))
1067 const UINT16 udpPort = Stream_Get_UINT16(s);
1068 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got udpPort=%" PRIu32, udpPort);
1070 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE) != 0)
1072 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 2))
1074 const UINT16 blobLen = Stream_Get_UINT16(s);
1075 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, blobLen))
1077 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got UDP auth blob=%" PRIu32, blobLen);
1078 if (!Stream_SafeSeek(s, blobLen))
1085static BOOL rdg_process_channel_response(rdpRdg* rdg,
wStream* s)
1087 UINT16 fieldsPresent = 0;
1088 UINT32 errorCode = 0;
1089 const char* error =
nullptr;
1090 WLog_Print(rdg->log, WLOG_DEBUG,
"Channel response received");
1092 if (rdg->state != RDG_CLIENT_STATE_CHANNEL_CREATE)
1097 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1100 Stream_Read_UINT32(s, errorCode);
1101 Stream_Read_UINT16(s, fieldsPresent);
1102 Stream_Seek_UINT16(s);
1103 error = rpc_error_to_string(errorCode);
1104 WLog_Print(rdg->log, WLOG_DEBUG,
"channel response errorCode=%s, fieldsPresent=%s", error,
1105 channel_response_fields_present_to_string(fieldsPresent));
1107 if (FAILED((HRESULT)errorCode))
1109 WLog_Print(rdg->log, WLOG_ERROR,
"channel response errorCode=%s, fieldsPresent=%s", error,
1110 channel_response_fields_present_to_string(fieldsPresent));
1111 freerdp_set_last_error_log(rdg->context, errorCode);
1115 if (!rdg_process_channel_response_optional(rdg, s, fieldsPresent))
1118 rdg->state = RDG_CLIENT_STATE_OPENED;
1122static BOOL rdg_process_packet(rdpRdg* rdg,
wStream* s)
1126 UINT32 packetLength = 0;
1127 Stream_ResetPosition(s);
1129 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1132 Stream_Read_UINT16(s, type);
1133 Stream_Seek_UINT16(s);
1134 Stream_Read_UINT32(s, packetLength);
1136 if (Stream_Length(s) < packetLength)
1138 WLog_Print(rdg->log, WLOG_ERROR,
"Short packet %" PRIuz
", expected %" PRIu32,
1139 Stream_Length(s), packetLength);
1145 case PKT_TYPE_HANDSHAKE_RESPONSE:
1146 status = rdg_process_handshake_response(rdg, s);
1149 case PKT_TYPE_TUNNEL_RESPONSE:
1150 status = rdg_process_tunnel_response(rdg, s);
1153 case PKT_TYPE_TUNNEL_AUTH_RESPONSE:
1154 status = rdg_process_tunnel_authorization_response(rdg, s);
1157 case PKT_TYPE_CHANNEL_RESPONSE:
1158 status = rdg_process_channel_response(rdg, s);
1162 WLog_Print(rdg->log, WLOG_ERROR,
"Unexpected packet type DATA");
1166 case PKT_TYPE_EXTENDED_AUTH_MSG:
1167 status = rdg_process_extauth_sspi(rdg, s);
1171 WLog_Print(rdg->log, WLOG_ERROR,
"PKG TYPE 0x%x not implemented", type);
1178 const size_t rem = Stream_GetRemainingLength(s);
1180 WLog_Print(rdg->log, WLOG_WARN,
"[%s] unparsed data detected: %" PRIuz
" bytes",
1181 rdg_pkt_type_to_string(type), rem);
1186DWORD rdg_get_event_handles(rdpRdg* rdg, HANDLE* events, DWORD count)
1189 WINPR_ASSERT(rdg !=
nullptr);
1191 if (rdg->tlsOut && rdg->tlsOut->bio)
1193 if (events && (nCount < count))
1195 BIO_get_event(rdg->tlsOut->bio, &events[nCount]);
1207static BOOL rdg_get_gateway_credentials(rdpContext* context, rdp_auth_reason reason)
1209 freerdp* instance = context->instance;
1211 auth_status rc = utils_authenticate_gateway(instance, reason);
1217 case AUTH_CANCELLED:
1218 freerdp_set_last_error_log(instance->context, FREERDP_ERROR_CONNECT_CANCELLED);
1220 case AUTH_NO_CREDENTIALS:
1221 WLog_INFO(TAG,
"No credentials provided - using nullptr identity");
1229static BOOL rdg_auth_init(rdpRdg* rdg, rdpTls* tls, TCHAR* authPkg)
1231 rdpContext* context = rdg->context;
1232 rdpSettings* settings = context->settings;
1233 SEC_WINNT_AUTH_IDENTITY identity = WINPR_C_ARRAY_INIT;
1236 rdg->auth = credssp_auth_new(context);
1240 if (!credssp_auth_init(rdg->auth, authPkg, tls->Bindings))
1246 if (!smartcard_getCert(context, &rdg->smartcard, TRUE))
1249 if (!rdg_get_gateway_credentials(context, AUTH_SMARTCARD_PIN))
1254 if (!rdg_get_gateway_credentials(context, GW_AUTH_RDG))
1259 if (doSCLogon && !smartcard_getCert(context, &rdg->smartcard, TRUE))
1263 SEC_WINNT_AUTH_IDENTITY* identityArg = &identity;
1266 if (!identity_set_from_smartcard_hash(&identity, settings, FreeRDP_GatewayUsername,
1267 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword,
1268 rdg->smartcard->sha1Hash,
1269 sizeof(rdg->smartcard->sha1Hash)))
1274 if (!identity_set_from_settings(&identity, settings, FreeRDP_GatewayUsername,
1275 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword))
1278 if (!settings->GatewayUsername)
1279 identityArg =
nullptr;
1282 if (!credssp_auth_setup_client(rdg->auth,
"HTTP", settings->GatewayHostname, identityArg,
1283 rdg->smartcard ? rdg->smartcard->pkinitArgs : nullptr))
1285 sspi_FreeAuthIdentity(&identity);
1288 sspi_FreeAuthIdentity(&identity);
1290 credssp_auth_set_flags(rdg->auth, ISC_REQ_CONFIDENTIALITY | ISC_REQ_MUTUAL_AUTH);
1292 rc = credssp_auth_authenticate(rdg->auth);
1296static BOOL rdg_send_http_request(rdpRdg* rdg, rdpTls* tls,
const char* method,
1297 TRANSFER_ENCODING transferEncoding)
1300 wStream* s = rdg_build_http_request(rdg, method, transferEncoding);
1305 const size_t sz = Stream_Length(s);
1306 status = freerdp_tls_write_all(tls, Stream_Buffer(s), sz);
1308 Stream_Free(s, TRUE);
1309 return (status >= 0);
1312static BOOL rdg_tls_connect(rdpRdg* rdg, rdpTls* tls,
const char* peerAddress, UINT32 timeout)
1315 BIO* layerBio =
nullptr;
1316 BIO* bufferedBio =
nullptr;
1318 rdpSettings* settings = rdg->context->settings;
1319 rdpTransport* transport = freerdp_get_transport(rdg->context);
1320 const char* peerHostname = settings->GatewayHostname;
1321 UINT16 peerPort = (UINT16)settings->GatewayPort;
1322 const char* proxyUsername =
nullptr;
1323 const char* proxyPassword =
nullptr;
1324 BOOL isProxyConnection =
1325 proxy_prepare(settings, &peerHostname, &peerPort, &proxyUsername, &proxyPassword);
1327 if (settings->GatewayPort > UINT16_MAX)
1330 layer = transport_connect_layer(transport, peerAddress ? peerAddress : peerHostname, peerPort,
1338 layerBio = BIO_new(BIO_s_transport_layer());
1341 transport_layer_free(layer);
1344 BIO_set_data(layerBio, layer);
1346 bufferedBio = BIO_new(BIO_s_buffered_socket());
1349 BIO_free_all(layerBio);
1353 bufferedBio = BIO_push(bufferedBio, layerBio);
1354 status = BIO_set_nonblock(bufferedBio, TRUE);
1356 if (isProxyConnection)
1358 if (!proxy_connect(rdg->context, bufferedBio, proxyUsername, proxyPassword,
1359 settings->GatewayHostname, (UINT16)settings->GatewayPort))
1361 BIO_free_all(bufferedBio);
1368 BIO_free_all(bufferedBio);
1372 tls->hostname = settings->GatewayHostname;
1373 tls->port = WINPR_ASSERTING_INT_CAST(int32_t, MIN(UINT16_MAX, settings->GatewayPort));
1374 tls->isGatewayTransport = TRUE;
1375 status = freerdp_tls_connect(tls, bufferedBio);
1378 rdpContext* context = rdg->context;
1381 freerdp_set_last_error_if_not(context, FREERDP_ERROR_TLS_CONNECT_FAILED);
1385 freerdp_set_last_error_if_not(context, FREERDP_ERROR_CONNECT_CANCELLED);
1390 return (status >= 1);
1393static BOOL rdg_establish_data_connection(rdpRdg* rdg, rdpTls* tls,
const char* method,
1394 const char* peerAddress, UINT32 timeout,
1397 char buffer[64] = WINPR_C_ARRAY_INIT;
1398 HttpResponse* response =
nullptr;
1400 if (!rdg_tls_connect(rdg, tls, peerAddress, timeout))
1403 WINPR_ASSERT(rpcFallback);
1404 if (rdg->context->settings->GatewayHttpExtAuthBearer && rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1405 rdg->extAuth = HTTP_EXTENDED_AUTH_BEARER;
1406 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1408 if (!rdg_auth_init(rdg, tls, AUTH_PKG))
1411 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1414 response = http_response_recv(tls, TRUE);
1419 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1420 *rpcFallback = TRUE;
1424 (void)http_response_extract_cookies(response, rdg->http);
1426 const UINT16 StatusCode = http_response_get_status_code(response);
1429 case HTTP_STATUS_GONE:
1430 case HTTP_STATUS_FORBIDDEN:
1431 case HTTP_STATUS_NOT_FOUND:
1433 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway does not support HTTP transport.");
1434 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1435 *rpcFallback = TRUE;
1437 http_response_free(response);
1440 case HTTP_STATUS_OK:
1443 case HTTP_STATUS_DENIED:
1444 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1448 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1452 while (!credssp_auth_is_complete(rdg->auth))
1454 if (!rdg_recv_auth_token(rdg->log, rdg->auth, response))
1456 http_response_free(response);
1460 if (credssp_auth_have_output_token(rdg->auth))
1462 http_response_free(response);
1464 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1467 response = http_response_recv(tls, TRUE);
1470 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1471 *rpcFallback = TRUE;
1474 (void)http_response_extract_cookies(response, rdg->http);
1477 credssp_auth_free(rdg->auth);
1478 rdg->auth =
nullptr;
1482 credssp_auth_free(rdg->auth);
1483 rdg->auth =
nullptr;
1485 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1488 response = http_response_recv(tls, TRUE);
1492 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1493 *rpcFallback = TRUE;
1496 (void)http_response_extract_cookies(response, rdg->http);
1499 const UINT16 statusCode = http_response_get_status_code(response);
1500 const size_t bodyLength = http_response_get_body_length(response);
1501 const TRANSFER_ENCODING encoding = http_response_get_transfer_encoding(response);
1502 const BOOL isWebsocket = http_response_is_websocket(rdg->http, response);
1504 WLog_Print(rdg->log, WLOG_DEBUG,
"%s authorization result: %s", method,
1505 freerdp_http_status_string_format(statusCode, buffer, ARRAYSIZE(buffer)));
1509 case HTTP_STATUS_OK:
1512 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1513 http_response_free(response);
1515 case HTTP_STATUS_DENIED:
1516 freerdp_set_last_error_log(rdg->context, FREERDP_ERROR_CONNECT_ACCESS_DENIED);
1517 http_response_free(response);
1519 case HTTP_STATUS_SWITCH_PROTOCOLS:
1520 http_response_free(response);
1527 if (http_context_is_websocket_upgrade_enabled(rdg->http))
1529 long fd = BIO_get_fd(tls->bio,
nullptr);
1531 closesocket((SOCKET)fd);
1532 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1533 return rdg_establish_data_connection(rdg, tls, method, peerAddress, timeout,
1539 rdg->transferEncoding.isWebsocketTransport = TRUE;
1540 if (!websocket_context_reset(rdg->transferEncoding.context.websocket))
1543 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1547 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1552 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1553 http_response_free(response);
1557 if (strcmp(method,
"RDG_OUT_DATA") == 0)
1559 if (encoding == TransferEncodingChunked)
1561 rdg->transferEncoding.httpTransferEncoding = TransferEncodingChunked;
1562 rdg->transferEncoding.context.chunked.nextOffset = 0;
1563 rdg->transferEncoding.context.chunked.headerFooterPos = 0;
1564 rdg->transferEncoding.context.chunked.state = ChunkStateLenghHeader;
1566 if (!rdg_skip_seed_payload(rdg->context, tls, bodyLength, &rdg->transferEncoding))
1573 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingChunked))
1576 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1580 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1588static BOOL rdg_tunnel_connect(rdpRdg* rdg)
1592 rdg_send_handshake(rdg);
1594 while (rdg->state < RDG_CLIENT_STATE_OPENED)
1597 s = rdg_receive_packet(rdg);
1601 status = rdg_process_packet(rdg, s);
1602 Stream_Free(s, TRUE);
1608 WINPR_ASSERT(rdg->context);
1609 WINPR_ASSERT(rdg->context->rdp);
1610 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1618BOOL rdg_connect(rdpRdg* rdg, DWORD timeout, BOOL* rpcFallback)
1621 SOCKET outConnSocket = 0;
1622 char* peerAddress =
nullptr;
1623 BOOL rpcFallbackLocal = FALSE;
1625 WINPR_ASSERT(rdg !=
nullptr);
1626 freerdp_set_last_error(rdg->context, ERROR_SUCCESS);
1627 status = rdg_establish_data_connection(rdg, rdg->tlsOut,
"RDG_OUT_DATA",
nullptr, timeout,
1632 if (rdg->transferEncoding.isWebsocketTransport)
1634 WLog_Print(rdg->log, WLOG_DEBUG,
"Upgraded to websocket. RDG_IN_DATA not required");
1641 BIO_get_socket(rdg->tlsOut->underlying, &outConnSocket);
1642 peerAddress = freerdp_tcp_get_peer_address(outConnSocket);
1643 status = rdg_establish_data_connection(rdg, rdg->tlsIn,
"RDG_IN_DATA", peerAddress,
1644 timeout, &rpcFallbackLocal);
1650 *rpcFallback = rpcFallbackLocal;
1655 WINPR_ASSERT(rdg->context);
1656 WINPR_ASSERT(rdg->context->rdp);
1657 if (rpcFallbackLocal)
1659 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1660 credssp_auth_free(rdg->auth);
1661 rdg->auth =
nullptr;
1664 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1668 status = rdg_tunnel_connect(rdg);
1673static int rdg_write_websocket_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1679 const size_t payloadSize = (size_t)isize + 10;
1687 websocket_context_packet_new(payloadSize, WebsocketBinaryOpcode, &maskingKey.u32);
1691 Stream_Write_UINT16(
1692 sWS, WINPR_ASSERTING_INT_CAST(
1693 uint16_t, PKT_TYPE_DATA ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1694 Stream_Write_UINT16(
1695 sWS, WINPR_ASSERTING_INT_CAST(
1696 uint16_t, 0 ^ (maskingKey.u8[2] | maskingKey.u8[3] << 8)));
1697 Stream_Write_UINT32(
1698 sWS, WINPR_ASSERTING_INT_CAST(uint32_t, payloadSize ^ maskingKey.u32));
1699 Stream_Write_UINT16(
1700 sWS, WINPR_ASSERTING_INT_CAST(
1701 uint16_t, isize ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1704 maskingKey.u32 = (maskingKey.u32 & 0xffff) << 16 | (maskingKey.u32 >> 16);
1706 WINPR_ASSERT(rdg->tlsOut);
1707 wStream sPacket = WINPR_C_ARRAY_INIT;
1708 Stream_StaticConstInit(&sPacket, buf, (
size_t)isize);
1709 if (!websocket_context_mask_and_send(rdg->tlsOut->bio, sWS, &sPacket, maskingKey.u32))
1715static int rdg_write_chunked_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1721 if (isize > UINT16_MAX)
1724 const size_t size = (size_t)isize;
1728 const size_t packetSize = size + 10;
1729 char chunkSize[11] = WINPR_C_ARRAY_INIT;
1730 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIxz
"\r\n", packetSize);
1731 sChunk = Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + packetSize + 2);
1736 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
1737 Stream_Write_UINT16(sChunk, PKT_TYPE_DATA);
1738 Stream_Write_UINT16(sChunk, 0);
1739 Stream_Write_UINT32(sChunk, (UINT32)packetSize);
1740 Stream_Write_UINT16(sChunk, (UINT16)size);
1741 Stream_Write(sChunk, buf, size);
1742 Stream_Write(sChunk,
"\r\n", 2);
1743 Stream_SealLength(sChunk);
1744 len = Stream_Length(sChunk);
1746 status = freerdp_tls_write_all(rdg->tlsIn, Stream_Buffer(sChunk), len);
1747 Stream_Free(sChunk, TRUE);
1755static int rdg_write_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1758 if (rdg->transferEncoding.isWebsocketTransport)
1759 return rdg_write_websocket_data_packet(rdg, buf, isize);
1761 return rdg_write_chunked_data_packet(rdg, buf, isize);
1764static BOOL rdg_process_close_packet(rdpRdg* rdg,
wStream* s)
1768 UINT32 errorCode = 0;
1769 UINT32 packetSize = 12;
1772 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1774 Stream_Read_UINT32(s, errorCode);
1777 freerdp_set_last_error_log(rdg->context, errorCode);
1779 sClose = Stream_New(
nullptr, packetSize);
1783 Stream_Write_UINT16(sClose, PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
1784 Stream_Write_UINT16(sClose, 0);
1785 Stream_Write_UINT32(sClose, packetSize);
1786 Stream_Write_UINT32(sClose, 0);
1787 Stream_SealLength(sClose);
1788 status = rdg_write_packet(rdg, sClose);
1789 Stream_Free(sClose, TRUE);
1791 return ((status >= 0));
1794static BOOL rdg_process_keep_alive_packet(rdpRdg* rdg)
1797 wStream* sKeepAlive =
nullptr;
1798 size_t packetSize = 8;
1800 sKeepAlive = Stream_New(
nullptr, packetSize);
1805 Stream_Write_UINT16(sKeepAlive, PKT_TYPE_KEEPALIVE);
1806 Stream_Write_UINT16(sKeepAlive, 0);
1807 Stream_Write_UINT32(sKeepAlive, (UINT32)packetSize);
1808 Stream_SealLength(sKeepAlive);
1809 status = rdg_write_packet(rdg, sKeepAlive);
1810 Stream_Free(sKeepAlive, TRUE);
1812 return ((status >= 0));
1815static BOOL rdg_process_service_message(rdpRdg* rdg,
wStream* s)
1817 const WCHAR* msg =
nullptr;
1818 UINT16 msgLenBytes = 0;
1819 rdpContext* context = rdg->context;
1820 WINPR_ASSERT(context);
1821 WINPR_ASSERT(context->instance);
1824 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
1826 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read string");
1830 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
1831 GATEWAY_MESSAGE_SERVICE, TRUE, FALSE, msgLenBytes, msg);
1834static BOOL rdg_process_unknown_packet(rdpRdg* rdg,
int type)
1838 WLog_Print(rdg->log, WLOG_WARN,
"Unknown Control Packet received: %" PRIX32,
1839 WINPR_CXX_COMPAT_CAST(UINT32, type));
1843static BOOL rdg_process_control_packet(rdpRdg* rdg,
int type,
size_t packetLength)
1846 size_t readCount = 0;
1848 size_t payloadSize = packetLength -
sizeof(RdgPacketHeader);
1850 if (packetLength <
sizeof(RdgPacketHeader))
1854 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1858 s = Stream_New(
nullptr, payloadSize);
1863 while (readCount < payloadSize)
1865 if (rdg_shall_abort(rdg))
1867 Stream_Free(s, TRUE);
1870 status = rdg_socket_read(rdg->tlsOut->bio, Stream_Pointer(s), payloadSize - readCount,
1871 &rdg->transferEncoding);
1875 if (!BIO_should_retry(rdg->tlsOut->bio))
1877 Stream_Free(s, TRUE);
1884 Stream_Seek(s, (
size_t)status);
1885 readCount += (size_t)status;
1887 if (readCount > INT_MAX)
1889 Stream_Free(s, TRUE);
1894 Stream_ResetPosition(s);
1899 case PKT_TYPE_CLOSE_CHANNEL:
1900 EnterCriticalSection(&rdg->writeSection);
1901 status = rdg_process_close_packet(rdg, s);
1902 LeaveCriticalSection(&rdg->writeSection);
1905 case PKT_TYPE_KEEPALIVE:
1906 EnterCriticalSection(&rdg->writeSection);
1907 status = rdg_process_keep_alive_packet(rdg);
1908 LeaveCriticalSection(&rdg->writeSection);
1911 case PKT_TYPE_SERVICE_MESSAGE:
1914 WLog_Print(rdg->log, WLOG_ERROR,
1915 "PKT_TYPE_SERVICE_MESSAGE requires payload but none was sent");
1918 status = rdg_process_service_message(rdg, s);
1921 case PKT_TYPE_REAUTH_MESSAGE:
1923 status = rdg_process_unknown_packet(rdg, type);
1927 Stream_Free(s, TRUE);
1931static int rdg_read_data_packet(rdpRdg* rdg, BYTE* buffer,
size_t size)
1933 RdgPacketHeader header = WINPR_C_ARRAY_INIT;
1934 size_t readCount = 0;
1935 size_t readSize = 0;
1938 if (!rdg->packetRemainingCount)
1941 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1943 while (readCount <
sizeof(RdgPacketHeader))
1945 if (rdg_shall_abort(rdg))
1948 status = rdg_socket_read(rdg->tlsOut->bio, (BYTE*)(&header) + readCount,
1949 sizeof(RdgPacketHeader) - readCount, &rdg->transferEncoding);
1953 if (!BIO_should_retry(rdg->tlsOut->bio))
1959 BIO_wait_read(rdg->tlsOut->bio, 50);
1963 readCount += (size_t)status;
1965 if (readCount > INT_MAX)
1969 if (header.type != PKT_TYPE_DATA)
1971 status = rdg_process_control_packet(rdg, header.type, header.packetLength);
1981 while (readCount < 2)
1983 if (rdg_shall_abort(rdg))
1986 rdg_socket_read(rdg->tlsOut->bio, (BYTE*)(&rdg->packetRemainingCount) + readCount,
1987 2 - readCount, &rdg->transferEncoding);
1991 if (!BIO_should_retry(rdg->tlsOut->bio))
1994 BIO_wait_read(rdg->tlsOut->bio, 50);
1998 readCount += (size_t)status;
2002 readSize = (rdg->packetRemainingCount < size) ? rdg->packetRemainingCount : size;
2003 status = rdg_socket_read(rdg->tlsOut->bio, buffer, readSize, &rdg->transferEncoding);
2007 if (!BIO_should_retry(rdg->tlsOut->bio))
2015 rdg->packetRemainingCount -= status;
2019static int rdg_bio_write(BIO* bio,
const char* buf,
int num)
2022 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2026 BIO_clear_flags(bio, BIO_FLAGS_WRITE);
2027 EnterCriticalSection(&rdg->writeSection);
2028 status = rdg_write_data_packet(rdg, (
const BYTE*)buf, num);
2029 LeaveCriticalSection(&rdg->writeSection);
2033 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2036 else if (status < num)
2038 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2039 WSASetLastError(WSAEWOULDBLOCK);
2043 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2049static int rdg_bio_read(BIO* bio,
char* buf,
int size)
2052 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2055 status = rdg_read_data_packet(rdg, (BYTE*)buf, (
size_t)size);
2059 BIO_clear_retry_flags(bio);
2062 else if (status == 0)
2064 BIO_set_retry_read(bio);
2065 WSASetLastError(WSAEWOULDBLOCK);
2070 BIO_set_flags(bio, BIO_FLAGS_READ);
2076static int rdg_bio_puts(BIO* bio,
const char* str)
2084static int rdg_bio_gets(BIO* bio,
char* str,
int size)
2092static long rdg_bio_ctrl(BIO* in_bio,
int cmd,
long arg1,
void* arg2)
2095 rdpRdg* rdg = (rdpRdg*)BIO_get_data(in_bio);
2096 rdpTls* tlsOut = rdg->tlsOut;
2097 rdpTls* tlsIn = rdg->tlsIn;
2099 if (cmd == BIO_CTRL_FLUSH)
2101 (void)BIO_flush(tlsOut->bio);
2102 if (!rdg->transferEncoding.isWebsocketTransport)
2103 (void)BIO_flush(tlsIn->bio);
2106 else if (cmd == BIO_C_SET_NONBLOCK)
2110 else if (cmd == BIO_C_READ_BLOCKED)
2112 BIO* cbio = tlsOut->bio;
2113 status = BIO_read_blocked(cbio);
2115 else if (cmd == BIO_C_WRITE_BLOCKED)
2117 BIO* cbio = tlsIn->bio;
2119 if (rdg->transferEncoding.isWebsocketTransport)
2122 status = BIO_write_blocked(cbio);
2124 else if (cmd == BIO_C_WAIT_READ)
2126 int timeout = (int)arg1;
2127 BIO* cbio = tlsOut->bio;
2129 if (BIO_read_blocked(cbio))
2130 return BIO_wait_read(cbio, timeout);
2131 else if (BIO_write_blocked(cbio))
2132 return BIO_wait_write(cbio, timeout);
2136 else if (cmd == BIO_C_WAIT_WRITE)
2138 int timeout = (int)arg1;
2139 BIO* cbio = tlsIn->bio;
2141 if (rdg->transferEncoding.isWebsocketTransport)
2144 if (BIO_write_blocked(cbio))
2145 status = BIO_wait_write(cbio, timeout);
2146 else if (BIO_read_blocked(cbio))
2147 status = BIO_wait_read(cbio, timeout);
2151 else if (cmd == BIO_C_GET_EVENT || cmd == BIO_C_GET_FD)
2161 status = BIO_ctrl(tlsOut->bio, cmd, arg1, arg2);
2163#if OPENSSL_VERSION_NUMBER >= 0x30000000L
2164 else if (cmd == BIO_CTRL_GET_KTLS_SEND)
2172 else if (cmd == BIO_CTRL_GET_KTLS_RECV)
2183static int rdg_bio_new(BIO* bio)
2185 BIO_set_init(bio, 1);
2186 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2190static int rdg_bio_free(BIO* bio)
2196static BIO_METHOD* BIO_s_rdg(
void)
2198 static BIO_METHOD* bio_methods =
nullptr;
2200 if (bio_methods ==
nullptr)
2202 if (!(bio_methods = BIO_meth_new(BIO_TYPE_TSG,
"RDGateway")))
2205 BIO_meth_set_write(bio_methods, rdg_bio_write);
2206 BIO_meth_set_read(bio_methods, rdg_bio_read);
2207 BIO_meth_set_puts(bio_methods, rdg_bio_puts);
2208 BIO_meth_set_gets(bio_methods, rdg_bio_gets);
2209 BIO_meth_set_ctrl(bio_methods, rdg_bio_ctrl);
2210 BIO_meth_set_create(bio_methods, rdg_bio_new);
2211 BIO_meth_set_destroy(bio_methods, rdg_bio_free);
2217rdpRdg* rdg_new(rdpContext* context)
2222 rdpRdg* rdg = (rdpRdg*)calloc(1,
sizeof(rdpRdg));
2226 rdg->log = WLog_Get(TAG);
2227 rdg->state = RDG_CLIENT_STATE_INITIAL;
2228 rdg->context = context;
2230 (rdg->context->settings->GatewayHttpExtAuthSspiNtlm ? HTTP_EXTENDED_AUTH_SSPI_NTLM
2231 : HTTP_EXTENDED_AUTH_NONE);
2233 if (rdg->context->settings->GatewayAccessToken)
2234 rdg->extAuth = HTTP_EXTENDED_AUTH_PAA;
2236 if (UuidCreate(&rdg->guid) != RPC_S_OK)
2237 goto rdg_alloc_error;
2239 rdg->tlsOut = freerdp_tls_new(rdg->context);
2242 goto rdg_alloc_error;
2244 rdg->tlsIn = freerdp_tls_new(rdg->context);
2247 goto rdg_alloc_error;
2249 rdg->http = http_context_new();
2252 goto rdg_alloc_error;
2254 if (!http_context_set_uri(rdg->http,
"/remoteDesktopGateway/") ||
2255 !http_context_set_accept(rdg->http,
"*/*") ||
2256 !http_context_set_cache_control(rdg->http,
"no-cache") ||
2257 !http_context_set_pragma(rdg->http,
"no-cache") ||
2258 !http_context_set_connection(rdg->http,
"Keep-Alive") ||
2259 !http_context_set_user_agent(rdg->http,
"MS-RDGateway/1.0") ||
2260 !http_context_set_host(rdg->http, rdg->context->settings->GatewayHostname) ||
2261 !http_context_set_rdg_connection_id(rdg->http, &rdg->guid) ||
2262 !http_context_set_rdg_correlation_id(rdg->http, &rdg->guid) ||
2263 !http_context_enable_websocket_upgrade(
2267 goto rdg_alloc_error;
2270 if (rdg->extAuth != HTTP_EXTENDED_AUTH_NONE)
2272 switch (rdg->extAuth)
2274 case HTTP_EXTENDED_AUTH_PAA:
2275 if (!http_context_set_rdg_auth_scheme(rdg->http,
"PAA"))
2276 goto rdg_alloc_error;
2280 case HTTP_EXTENDED_AUTH_SSPI_NTLM:
2281 if (!http_context_set_rdg_auth_scheme(rdg->http,
"SSPI_NTLM"))
2282 goto rdg_alloc_error;
2287 WLog_Print(rdg->log, WLOG_DEBUG,
2288 "RDG extended authentication method %d not supported", rdg->extAuth);
2292 rdg->frontBio = BIO_new(BIO_s_rdg());
2295 goto rdg_alloc_error;
2297 BIO_set_data(rdg->frontBio, rdg);
2298 InitializeCriticalSection(&rdg->writeSection);
2300 rdg->transferEncoding.httpTransferEncoding = TransferEncodingIdentity;
2301 rdg->transferEncoding.isWebsocketTransport = FALSE;
2303 rdg->transferEncoding.context.websocket = websocket_context_new();
2304 if (!rdg->transferEncoding.context.websocket)
2305 goto rdg_alloc_error;
2309 WINPR_PRAGMA_DIAG_PUSH
2310 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2312 WINPR_PRAGMA_DIAG_POP
2316void rdg_free(rdpRdg* rdg)
2321 freerdp_tls_free(rdg->tlsOut);
2322 freerdp_tls_free(rdg->tlsIn);
2323 http_context_free(rdg->http);
2324 credssp_auth_free(rdg->auth);
2327 BIO_free_all(rdg->frontBio);
2329 DeleteCriticalSection(&rdg->writeSection);
2331 smartcardCertInfo_Free(rdg->smartcard);
2333 websocket_context_free(rdg->transferEncoding.context.websocket);
2338BIO* rdg_get_front_bio_and_take_ownership(rdpRdg* rdg)
2343 rdg->attached = TRUE;
2344 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.