22#include <freerdp/config.h>
24#include "../settings.h"
26#include <winpr/assert.h>
27#include <winpr/cast.h>
30#include <winpr/synch.h>
31#include <winpr/print.h>
32#include <winpr/stream.h>
33#include <winpr/winsock.h>
34#include <winpr/cred.h>
36#include <freerdp/log.h>
37#include <freerdp/error.h>
38#include <freerdp/utils/ringbuffer.h>
39#include <freerdp/utils/smartcardlogon.h>
43#include "../credssp_auth.h"
46#include "../../crypto/opensslcompat.h"
50#define TAG FREERDP_TAG("core.gateway.rdg")
52#define AUTH_PKG NEGO_SSP_NAME
55#define HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID 0x1
56#define HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE 0x2
57#define HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT 0x4
60#define HTTP_EXTENDED_AUTH_NONE 0x0
61#define HTTP_EXTENDED_AUTH_SC 0x1
62#define HTTP_EXTENDED_AUTH_PAA 0x02
63#define HTTP_EXTENDED_AUTH_SSPI_NTLM 0x04
64#define HTTP_EXTENDED_AUTH_BEARER 0x08
69 PKT_TYPE_HANDSHAKE_REQUEST = 0x1,
70 PKT_TYPE_HANDSHAKE_RESPONSE = 0x2,
71 PKT_TYPE_EXTENDED_AUTH_MSG = 0x3,
72 PKT_TYPE_TUNNEL_CREATE = 0x4,
73 PKT_TYPE_TUNNEL_RESPONSE = 0x5,
74 PKT_TYPE_TUNNEL_AUTH = 0x6,
75 PKT_TYPE_TUNNEL_AUTH_RESPONSE = 0x7,
76 PKT_TYPE_CHANNEL_CREATE = 0x8,
77 PKT_TYPE_CHANNEL_RESPONSE = 0x9,
79 PKT_TYPE_SERVICE_MESSAGE = 0xB,
80 PKT_TYPE_REAUTH_MESSAGE = 0xC,
81 PKT_TYPE_KEEPALIVE = 0xD,
82 PKT_TYPE_CLOSE_CHANNEL = 0x10,
83 PKT_TYPE_CLOSE_CHANNEL_RESPONSE = 0x11
90#define HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS 0x1
91#define HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT 0x2
92#define HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE 0x4
95#define HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE 0x1
99#define HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID 0x1
100#define HTTP_TUNNEL_RESPONSE_FIELD_CAPS 0x2
101#define HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ 0x4
102#define HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG 0x10
105#define HTTP_CAPABILITY_TYPE_QUAR_SOH 0x1
106#define HTTP_CAPABILITY_IDLE_TIMEOUT 0x2
107#define HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN 0x4
108#define HTTP_CAPABILITY_MESSAGING_SERVICE_MSG 0x8
109#define HTTP_CAPABILITY_REAUTH 0x10
110#define HTTP_CAPABILITY_UDP_TRANSPORT 0x20
114 TRANSFER_ENCODING httpTransferEncoding;
115 BOOL isWebsocketTransport;
119 websocket_context* websocket;
121} rdg_http_encoding_context;
130 rdpCredsspAuth* auth;
135 UINT16 packetRemainingCount;
140 rdg_http_encoding_context transferEncoding;
148 RDG_CLIENT_STATE_INITIAL,
149 RDG_CLIENT_STATE_HANDSHAKE,
150 RDG_CLIENT_STATE_TUNNEL_CREATE,
151 RDG_CLIENT_STATE_TUNNEL_AUTHORIZE,
152 RDG_CLIENT_STATE_CHANNEL_CREATE,
153 RDG_CLIENT_STATE_OPENED,
158typedef struct rdg_packet_header
173static const t_flag_mapping tunnel_response_fields_present[] = {
174 { HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID,
"HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID" },
175 { HTTP_TUNNEL_RESPONSE_FIELD_CAPS,
"HTTP_TUNNEL_RESPONSE_FIELD_CAPS" },
176 { HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ,
"HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ" },
177 { HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG,
"HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG" }
180static const t_flag_mapping channel_response_fields_present[] = {
181 { HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID,
"HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID" },
182 { HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE,
"HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE" },
183 { HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT,
"HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT" }
186static const t_flag_mapping tunnel_authorization_response_fields_present[] = {
187 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS,
"HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS" },
188 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT,
189 "HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT" },
190 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE,
191 "HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE" }
194static const t_flag_mapping extended_auth[] = {
195 { HTTP_EXTENDED_AUTH_NONE,
"HTTP_EXTENDED_AUTH_NONE" },
196 { HTTP_EXTENDED_AUTH_SC,
"HTTP_EXTENDED_AUTH_SC" },
197 { HTTP_EXTENDED_AUTH_PAA,
"HTTP_EXTENDED_AUTH_PAA" },
198 { HTTP_EXTENDED_AUTH_SSPI_NTLM,
"HTTP_EXTENDED_AUTH_SSPI_NTLM" }
201static const t_flag_mapping capabilities_enum[] = {
202 { HTTP_CAPABILITY_TYPE_QUAR_SOH,
"HTTP_CAPABILITY_TYPE_QUAR_SOH" },
203 { HTTP_CAPABILITY_IDLE_TIMEOUT,
"HTTP_CAPABILITY_IDLE_TIMEOUT" },
204 { HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN,
"HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN" },
205 { HTTP_CAPABILITY_MESSAGING_SERVICE_MSG,
"HTTP_CAPABILITY_MESSAGING_SERVICE_MSG" },
206 { HTTP_CAPABILITY_REAUTH,
"HTTP_CAPABILITY_REAUTH" },
207 { HTTP_CAPABILITY_UDP_TRANSPORT,
"HTTP_CAPABILITY_UDP_TRANSPORT" }
210static const char* rdg_pkt_type_to_string(
int type)
218 ENTRY(PKT_TYPE_HANDSHAKE_REQUEST);
219 ENTRY(PKT_TYPE_HANDSHAKE_RESPONSE);
220 ENTRY(PKT_TYPE_EXTENDED_AUTH_MSG);
221 ENTRY(PKT_TYPE_TUNNEL_CREATE);
222 ENTRY(PKT_TYPE_TUNNEL_RESPONSE);
223 ENTRY(PKT_TYPE_TUNNEL_AUTH);
224 ENTRY(PKT_TYPE_TUNNEL_AUTH_RESPONSE);
225 ENTRY(PKT_TYPE_CHANNEL_CREATE);
226 ENTRY(PKT_TYPE_CHANNEL_RESPONSE);
227 ENTRY(PKT_TYPE_DATA);
228 ENTRY(PKT_TYPE_SERVICE_MESSAGE);
229 ENTRY(PKT_TYPE_REAUTH_MESSAGE);
230 ENTRY(PKT_TYPE_KEEPALIVE);
231 ENTRY(PKT_TYPE_CLOSE_CHANNEL);
232 ENTRY(PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
234 return "PKT_TYPE_UNKNOWN";
239static const char* flags_to_string(UINT32 flags,
const t_flag_mapping* map,
size_t elements)
241 static char buffer[1024] = WINPR_C_ARRAY_INIT;
242 char fields[12] = WINPR_C_ARRAY_INIT;
244 for (
size_t x = 0; x < elements; x++)
246 const t_flag_mapping* cur = &map[x];
248 if ((cur->code & flags) != 0)
249 winpr_str_append(cur->name, buffer,
sizeof(buffer),
"|");
252 (void)sprintf_s(fields, ARRAYSIZE(fields),
" [%04" PRIx32
"]", flags);
253 winpr_str_append(fields, buffer,
sizeof(buffer),
nullptr);
257static const char* channel_response_fields_present_to_string(UINT16 fieldsPresent)
259 return flags_to_string(fieldsPresent, channel_response_fields_present,
260 ARRAYSIZE(channel_response_fields_present));
263static const char* tunnel_response_fields_present_to_string(UINT16 fieldsPresent)
265 return flags_to_string(fieldsPresent, tunnel_response_fields_present,
266 ARRAYSIZE(tunnel_response_fields_present));
269static const char* tunnel_authorization_response_fields_present_to_string(UINT16 fieldsPresent)
271 return flags_to_string(fieldsPresent, tunnel_authorization_response_fields_present,
272 ARRAYSIZE(tunnel_authorization_response_fields_present));
275static const char* extended_auth_to_string(UINT16 auth)
277 if (auth == HTTP_EXTENDED_AUTH_NONE)
278 return "HTTP_EXTENDED_AUTH_NONE [0x0000]";
280 return flags_to_string(auth, extended_auth, ARRAYSIZE(extended_auth));
283static const char* capabilities_enum_to_string(UINT32 capabilities)
285 return flags_to_string(capabilities, capabilities_enum, ARRAYSIZE(capabilities_enum));
288static BOOL rdg_read_http_unicode_string(wLog* log,
wStream* s,
const WCHAR**
string,
289 UINT16* lengthInBytes)
291 UINT16 strLenBytes = 0;
292 size_t rem = Stream_GetRemainingLength(s);
295 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 4))
297 WLog_Print(log, WLOG_ERROR,
"Could not read stream length, only have %" PRIuz
" bytes",
301 Stream_Read_UINT16(s, strLenBytes);
304 const WCHAR* str = Stream_ConstPointer(s);
307 if (!Stream_SafeSeek(s, strLenBytes))
309 WLog_Print(log, WLOG_ERROR,
310 "Could not read stream data, only have %" PRIuz
" bytes, expected %" PRIu16,
311 rem - 4, strLenBytes);
319 *lengthInBytes = strLenBytes;
324static BOOL rdg_write_chunked(BIO* bio,
wStream* sPacket)
330 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIXz
"\r\n", Stream_Length(sPacket));
332 Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + Stream_Length(sPacket) + 2);
337 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
338 Stream_Write(sChunk, Stream_Buffer(sPacket), Stream_Length(sPacket));
339 Stream_Write(sChunk,
"\r\n", 2);
340 Stream_SealLength(sChunk);
341 len = Stream_Length(sChunk);
345 Stream_Free(sChunk, TRUE);
350 status = BIO_write(bio, Stream_Buffer(sChunk), (
int)len);
351 Stream_Free(sChunk, TRUE);
353 return (status == (SSIZE_T)len);
356static BOOL rdg_write_packet(rdpRdg* rdg,
wStream* sPacket)
358 if (rdg->transferEncoding.isWebsocketTransport)
359 return websocket_context_write_wstream(rdg->transferEncoding.context.websocket,
360 rdg->tlsOut->bio, sPacket, WebsocketBinaryOpcode);
362 return rdg_write_chunked(rdg->tlsIn->bio, sPacket);
365static int rdg_socket_read(BIO* bio, BYTE* pBuffer,
size_t size,
366 rdg_http_encoding_context* encodingContext)
368 WINPR_ASSERT(encodingContext !=
nullptr);
369 if (size > INT32_MAX)
372 if (encodingContext->isWebsocketTransport)
373 return websocket_context_read(encodingContext->context.websocket, bio, pBuffer, size);
375 switch (encodingContext->httpTransferEncoding)
377 case TransferEncodingIdentity:
379 return BIO_read(bio, pBuffer, (
int)size);
380 case TransferEncodingChunked:
381 return http_chuncked_read(bio, pBuffer, size, &encodingContext->context.chunked);
387static BOOL rdg_shall_abort(rdpRdg* rdg)
390 return freerdp_shall_disconnect_context(rdg->context);
393static BOOL rdg_read_all(rdpContext* context, rdpTls* tls, BYTE* buffer,
size_t size,
394 rdg_http_encoding_context* transferEncoding)
396 size_t readCount = 0;
397 BYTE* pBuffer = buffer;
399 while (readCount < size)
401 if (freerdp_shall_disconnect_context(context))
404 int status = rdg_socket_read(tls->bio, pBuffer, size - readCount, transferEncoding);
407 if (!BIO_should_retry(tls->bio))
414 readCount += WINPR_ASSERTING_INT_CAST(uint32_t, status);
415 pBuffer += WINPR_ASSERTING_INT_CAST(uint32_t, status);
421static wStream* rdg_receive_packet(rdpRdg* rdg)
423 const size_t header =
sizeof(RdgPacketHeader);
424 size_t packetLength = 0;
425 wStream* s = Stream_New(
nullptr, 1024);
430 if (!rdg_read_all(rdg->context, rdg->tlsOut, Stream_Buffer(s), header, &rdg->transferEncoding))
434 Stream_Read_UINT32(s, packetLength);
436 if ((packetLength > INT_MAX) || !Stream_EnsureCapacity(s, packetLength) ||
437 (packetLength < header))
440 if (!rdg_read_all(rdg->context, rdg->tlsOut, Stream_Buffer(s) + header, packetLength - header,
441 &rdg->transferEncoding))
444 if (!Stream_SetLength(s, packetLength))
449 Stream_Free(s, TRUE);
453static BOOL rdg_send_handshake(rdpRdg* rdg)
456 wStream* s = Stream_New(
nullptr, 14);
461 Stream_Write_UINT16(s, PKT_TYPE_HANDSHAKE_REQUEST);
462 Stream_Write_UINT16(s, 0);
463 Stream_Write_UINT32(s, 14);
464 Stream_Write_UINT8(s, 1);
465 Stream_Write_UINT8(s, 0);
466 Stream_Write_UINT16(s, 0);
467 Stream_Write_UINT16(s, rdg->extAuth);
468 Stream_SealLength(s);
469 status = rdg_write_packet(rdg, s);
470 Stream_Free(s, TRUE);
474 rdg->state = RDG_CLIENT_STATE_HANDSHAKE;
480static BOOL rdg_send_extauth_sspi(rdpRdg* rdg)
484 UINT32 packetSize = 8 + 4 + 2;
488 const SecBuffer* authToken = credssp_auth_get_output_buffer(rdg->auth);
491 packetSize += authToken->cbBuffer;
493 s = Stream_New(
nullptr, packetSize);
498 Stream_Write_UINT16(s, PKT_TYPE_EXTENDED_AUTH_MSG);
499 Stream_Write_UINT16(s, 0);
500 Stream_Write_UINT32(s, packetSize);
501 Stream_Write_UINT32(s, ERROR_SUCCESS);
502 Stream_Write_UINT16(s, (UINT16)authToken->cbBuffer);
503 Stream_Write(s, authToken->pvBuffer, authToken->cbBuffer);
505 Stream_SealLength(s);
506 status = rdg_write_packet(rdg, s);
507 Stream_Free(s, TRUE);
512static BOOL rdg_send_tunnel_request(rdpRdg* rdg)
516 UINT32 packetSize = 16;
517 UINT16 fieldsPresent = 0;
518 WCHAR* PAACookie =
nullptr;
519 size_t PAACookieLen = 0;
520 const UINT32 capabilities = HTTP_CAPABILITY_TYPE_QUAR_SOH |
521 HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN |
522 HTTP_CAPABILITY_MESSAGING_SERVICE_MSG;
524 if (rdg->extAuth == HTTP_EXTENDED_AUTH_PAA)
527 ConvertUtf8ToWCharAlloc(rdg->context->settings->GatewayAccessToken, &PAACookieLen);
529 if (!PAACookie || (PAACookieLen > UINT16_MAX /
sizeof(WCHAR)))
533 packetSize += 2 + (UINT32)(PAACookieLen) *
sizeof(WCHAR);
534 fieldsPresent = HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE;
537 s = Stream_New(
nullptr, packetSize);
542 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_CREATE);
543 Stream_Write_UINT16(s, 0);
544 Stream_Write_UINT32(s, packetSize);
545 Stream_Write_UINT32(s, capabilities);
546 Stream_Write_UINT16(s, fieldsPresent);
547 Stream_Write_UINT16(s, 0);
551 Stream_Write_UINT16(s, (UINT16)PAACookieLen *
sizeof(WCHAR));
552 if (!Stream_Write_UTF16_String(s, PAACookie, PAACookieLen))
556 Stream_SealLength(s);
557 status = rdg_write_packet(rdg, s);
560 Stream_Free(s, TRUE);
565 rdg->state = RDG_CLIENT_STATE_TUNNEL_CREATE;
571static BOOL rdg_send_tunnel_authorization(rdpRdg* rdg)
576 size_t clientNameLen = 0;
578 rdg->context->settings, FreeRDP_ClientHostname, &clientNameLen);
582 const size_t packetSize = 12ull + clientNameLen *
sizeof(WCHAR);
583 if (!clientName || (clientNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
586 s = Stream_New(
nullptr, packetSize);
591 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_AUTH);
592 Stream_Write_UINT16(s, 0);
593 Stream_Write_UINT32(s, (UINT32)packetSize);
594 Stream_Write_UINT16(s, 0);
595 Stream_Write_UINT16(s, (UINT16)clientNameLen *
sizeof(WCHAR));
596 if (!Stream_Write_UTF16_String(s, clientName, clientNameLen))
598 Stream_SealLength(s);
599 status = rdg_write_packet(rdg, s);
602 Stream_Free(s, TRUE);
606 rdg->state = RDG_CLIENT_STATE_TUNNEL_AUTHORIZE;
611static BOOL rdg_send_channel_create(rdpRdg* rdg)
615 WCHAR* serverName =
nullptr;
616 size_t serverNameLen = 0;
620 FreeRDP_ServerHostname, &serverNameLen);
623 const size_t packetSize = 16ull + serverNameLen *
sizeof(WCHAR);
624 if (!serverName || (serverNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
627 s = Stream_New(
nullptr, packetSize);
632 Stream_Write_UINT16(s, PKT_TYPE_CHANNEL_CREATE);
633 Stream_Write_UINT16(s, 0);
634 Stream_Write_UINT32(s, (UINT32)packetSize);
635 Stream_Write_UINT8(s, 1);
636 Stream_Write_UINT8(s, 0);
637 Stream_Write_UINT16(s,
638 (UINT16)rdg->context->settings->ServerPort);
639 Stream_Write_UINT16(s, 3);
640 Stream_Write_UINT16(s, (UINT16)serverNameLen *
sizeof(WCHAR));
641 if (!Stream_Write_UTF16_String(s, serverName, serverNameLen))
644 Stream_SealLength(s);
645 status = rdg_write_packet(rdg, s);
648 Stream_Free(s, TRUE);
651 rdg->state = RDG_CLIENT_STATE_CHANNEL_CREATE;
656static BOOL rdg_set_auth_header(rdpCredsspAuth* auth, HttpRequest* request)
658 const SecBuffer* authToken = credssp_auth_get_output_buffer(auth);
659 char* base64AuthToken =
nullptr;
663 if (authToken->cbBuffer > INT_MAX)
666 base64AuthToken = crypto_base64_encode(authToken->pvBuffer, authToken->cbBuffer);
671 BOOL rc = http_request_set_auth_scheme(request, credssp_auth_pkg_name(auth)) &&
672 http_request_set_auth_param(request, base64AuthToken);
673 free(base64AuthToken);
682static wStream* rdg_build_http_request(rdpRdg* rdg,
const char* method,
683 TRANSFER_ENCODING transferEncoding)
686 HttpRequest* request =
nullptr;
687 const char* uri =
nullptr;
692 uri = http_context_get_uri(rdg->http);
693 request = http_request_new();
698 if (!http_request_set_method(request, method) || !http_request_set_uri(request, uri))
703 if (!rdg_set_auth_header(rdg->auth, request))
707 else if (rdg->extAuth == HTTP_EXTENDED_AUTH_BEARER)
709 if (!http_request_set_auth_scheme(request,
"Bearer"))
711 if (!http_request_set_auth_param(request, rdg->context->settings->GatewayHttpExtAuthBearer))
715 if (!http_request_set_transfer_encoding(request, transferEncoding))
718 s = http_request_write(rdg->http, request);
720 http_request_free(request);
723 Stream_SealLength(s);
728static BOOL rdg_recv_auth_token(wLog* log, rdpCredsspAuth* auth, HttpResponse* response,
732 size_t authTokenLength = 0;
733 BYTE* authTokenData =
nullptr;
734 SecBuffer authToken = WINPR_C_ARRAY_INIT;
737 WINPR_ASSERT(pHaveToken);
740 if (!auth || !response)
743 const UINT16 StatusCode = http_response_get_status_code(response);
746 case HTTP_STATUS_DENIED:
748 case HTTP_STATUS_SWITCH_PROTOCOLS:
751 http_response_log_error_status(log, WLOG_WARN, response);
755 const char* token64 = http_response_get_auth_token(response, credssp_auth_pkg_name(auth));
765 len = strlen(token64);
767 crypto_base64_decode(token64, len, &authTokenData, &authTokenLength);
769 if (authTokenLength && authTokenData && (authTokenLength <= UINT32_MAX))
771 authToken.pvBuffer = authTokenData;
772 authToken.cbBuffer = (UINT32)authTokenLength;
773 credssp_auth_take_input_buffer(auth, &authToken);
778 rc = credssp_auth_authenticate(auth);
782static BOOL rdg_skip_seed_payload(rdpContext* context, rdpTls* tls,
size_t lastResponseLength,
783 rdg_http_encoding_context* transferEncoding)
785 BYTE seed_payload[10] = WINPR_C_ARRAY_INIT;
786 const size_t size =
sizeof(seed_payload);
791 if (lastResponseLength < size)
793 if (!rdg_read_all(context, tls, seed_payload, size - lastResponseLength, transferEncoding))
802static BOOL rdg_process_handshake_response(rdpRdg* rdg,
wStream* s)
804 UINT32 errorCode = 0;
805 UINT16 serverVersion = 0;
806 UINT16 extendedAuth = 0;
809 const char* error =
nullptr;
810 WLog_Print(rdg->log, WLOG_DEBUG,
"Handshake response received");
812 if (rdg->state != RDG_CLIENT_STATE_HANDSHAKE)
817 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
820 Stream_Read_UINT32(s, errorCode);
821 Stream_Read_UINT8(s, verMajor);
822 Stream_Read_UINT8(s, verMinor);
823 Stream_Read_UINT16(s, serverVersion);
824 Stream_Read_UINT16(s, extendedAuth);
825 error = rpc_error_to_string(errorCode);
826 WLog_Print(rdg->log, WLOG_DEBUG,
827 "errorCode=%s, verMajor=%" PRId8
", verMinor=%" PRId8
", serverVersion=%" PRId16
829 error, verMajor, verMinor, serverVersion, extended_auth_to_string(extendedAuth));
831 if (FAILED((HRESULT)errorCode))
833 WLog_Print(rdg->log, WLOG_ERROR,
"Handshake error %s", error);
834 freerdp_set_last_error_log(rdg->context, errorCode);
838 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
839 return rdg_send_extauth_sspi(rdg);
841 return rdg_send_tunnel_request(rdg);
844static BOOL rdg_process_tunnel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
846 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID)
849 if (!Stream_SafeSeek(s, 4))
851 WLog_Print(rdg->log, WLOG_ERROR,
"Short tunnelId, got %" PRIuz
", expected 4",
852 Stream_GetRemainingLength(s));
857 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CAPS)
860 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
863 Stream_Read_UINT32(s, caps);
864 WLog_Print(rdg->log, WLOG_DEBUG,
"capabilities=%s", capabilities_enum_to_string(caps));
867 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ)
870 if (!Stream_SafeSeek(s, 20))
872 WLog_Print(rdg->log, WLOG_ERROR,
"Short nonce, got %" PRIuz
", expected 20",
873 Stream_GetRemainingLength(s));
878 if (!rdg_read_http_unicode_string(rdg->log, s,
nullptr,
nullptr))
880 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read server certificate");
885 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG)
887 const WCHAR* msg =
nullptr;
888 UINT16 msgLenBytes = 0;
889 rdpContext* context = rdg->context;
891 WINPR_ASSERT(context);
892 WINPR_ASSERT(context->instance);
895 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
897 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read consent message");
901 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
902 GATEWAY_MESSAGE_CONSENT, TRUE, TRUE, msgLenBytes, msg);
908static BOOL rdg_process_tunnel_response(rdpRdg* rdg,
wStream* s)
910 UINT16 serverVersion = 0;
911 UINT16 fieldsPresent = 0;
912 UINT32 errorCode = 0;
913 const char* error =
nullptr;
914 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel response received");
916 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_CREATE)
921 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
924 Stream_Read_UINT16(s, serverVersion);
925 Stream_Read_UINT32(s, errorCode);
926 Stream_Read_UINT16(s, fieldsPresent);
927 Stream_Seek_UINT16(s);
928 error = rpc_error_to_string(errorCode);
929 WLog_Print(rdg->log, WLOG_DEBUG,
"serverVersion=%" PRId16
", errorCode=%s, fieldsPresent=%s",
930 serverVersion, error, tunnel_response_fields_present_to_string(fieldsPresent));
932 if (FAILED((HRESULT)errorCode))
934 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel creation error %s", error);
935 freerdp_set_last_error_log(rdg->context, errorCode);
939 if (!rdg_process_tunnel_response_optional(rdg, s, fieldsPresent))
942 return rdg_send_tunnel_authorization(rdg);
945static BOOL rdg_process_tunnel_authorization_response(rdpRdg* rdg,
wStream* s)
947 UINT32 errorCode = 0;
948 UINT16 fieldsPresent = 0;
949 const char* error =
nullptr;
950 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel authorization received");
952 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_AUTHORIZE)
957 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
960 Stream_Read_UINT32(s, errorCode);
961 Stream_Read_UINT16(s, fieldsPresent);
962 Stream_Seek_UINT16(s);
963 error = rpc_error_to_string(errorCode);
964 WLog_Print(rdg->log, WLOG_DEBUG,
"errorCode=%s, fieldsPresent=%s", error,
965 tunnel_authorization_response_fields_present_to_string(fieldsPresent));
968 if (errorCode != S_OK && errorCode != E_PROXY_QUARANTINE_ACCESSDENIED)
970 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel authorization error %s", error);
971 freerdp_set_last_error_log(rdg->context, errorCode);
975 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS)
977 UINT32 redirFlags = 0;
978 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
980 Stream_Read_UINT32(s, redirFlags);
982 rdpContext* context = rdg->context;
983 if (!utils_apply_gateway_policy(rdg->log, context, redirFlags,
"RDG"))
987 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT)
989 UINT32 idleTimeout = 0;
990 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
992 Stream_Read_UINT32(s, idleTimeout);
993 WLog_Print(rdg->log, WLOG_DEBUG,
"[IDLE_TIMEOUT] idleTimeout=%" PRIu32
": TODO: unused",
997 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE)
1000 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1002 Stream_Read_UINT16(s, cbLen);
1004 WLog_Print(rdg->log, WLOG_DEBUG,
"[SOH_RESPONSE] cbLen=%" PRIu16
": TODO: unused", cbLen);
1005 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, cbLen))
1007 Stream_Seek(s, cbLen);
1010 return rdg_send_channel_create(rdg);
1013static BOOL rdg_process_extauth_sspi(rdpRdg* rdg,
wStream* s)
1015 INT32 errorCode = 0;
1016 UINT16 authBlobLen = 0;
1017 SecBuffer authToken = WINPR_C_ARRAY_INIT;
1018 BYTE* authTokenData =
nullptr;
1022 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 6))
1025 Stream_Read_INT32(s, errorCode);
1026 Stream_Read_UINT16(s, authBlobLen);
1028 if (errorCode != ERROR_SUCCESS)
1030 WLog_Print(rdg->log, WLOG_ERROR,
"EXTAUTH_SSPI_NTLM failed with error %s [0x%08X]",
1031 GetSecurityStatusString(errorCode), WINPR_CXX_COMPAT_CAST(UINT32, errorCode));
1035 if (authBlobLen == 0)
1037 if (credssp_auth_is_complete(rdg->auth))
1039 credssp_auth_free(rdg->auth);
1040 rdg->auth =
nullptr;
1041 return rdg_send_tunnel_request(rdg);
1046 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, authBlobLen))
1049 authTokenData = malloc(authBlobLen);
1050 if (authTokenData ==
nullptr)
1052 Stream_Read(s, authTokenData, authBlobLen);
1054 authToken.pvBuffer = authTokenData;
1055 authToken.cbBuffer = authBlobLen;
1057 credssp_auth_take_input_buffer(rdg->auth, &authToken);
1059 if (credssp_auth_authenticate(rdg->auth) < 0)
1062 if (credssp_auth_have_output_token(rdg->auth))
1063 return rdg_send_extauth_sspi(rdg);
1068static BOOL rdg_process_channel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
1070 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID) != 0)
1072 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1074 const UINT32 channelId = Stream_Get_UINT32(s);
1075 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got channelId=%" PRIu32, channelId);
1077 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT) != 0)
1079 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1081 const UINT16 udpPort = Stream_Get_UINT16(s);
1082 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got udpPort=%" PRIu32, udpPort);
1084 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE) != 0)
1086 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1088 const UINT16 blobLen = Stream_Get_UINT16(s);
1089 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, blobLen))
1091 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got UDP auth blob=%" PRIu32, blobLen);
1092 if (!Stream_SafeSeek(s, blobLen))
1099static BOOL rdg_process_channel_response(rdpRdg* rdg,
wStream* s)
1101 UINT16 fieldsPresent = 0;
1102 UINT32 errorCode = 0;
1103 const char* error =
nullptr;
1104 WLog_Print(rdg->log, WLOG_DEBUG,
"Channel response received");
1106 if (rdg->state != RDG_CLIENT_STATE_CHANNEL_CREATE)
1111 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1114 Stream_Read_UINT32(s, errorCode);
1115 Stream_Read_UINT16(s, fieldsPresent);
1116 Stream_Seek_UINT16(s);
1117 error = rpc_error_to_string(errorCode);
1118 WLog_Print(rdg->log, WLOG_DEBUG,
"channel response errorCode=%s, fieldsPresent=%s", error,
1119 channel_response_fields_present_to_string(fieldsPresent));
1121 if (FAILED((HRESULT)errorCode))
1123 WLog_Print(rdg->log, WLOG_ERROR,
"channel response errorCode=%s, fieldsPresent=%s", error,
1124 channel_response_fields_present_to_string(fieldsPresent));
1125 freerdp_set_last_error_log(rdg->context, errorCode);
1129 if (!rdg_process_channel_response_optional(rdg, s, fieldsPresent))
1132 rdg->state = RDG_CLIENT_STATE_OPENED;
1136static BOOL rdg_process_packet(rdpRdg* rdg,
wStream* s)
1140 UINT32 packetLength = 0;
1141 Stream_ResetPosition(s);
1143 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1146 Stream_Read_UINT16(s, type);
1147 Stream_Seek_UINT16(s);
1148 Stream_Read_UINT32(s, packetLength);
1150 if (Stream_Length(s) < packetLength)
1152 WLog_Print(rdg->log, WLOG_ERROR,
"Short packet %" PRIuz
", expected %" PRIu32,
1153 Stream_Length(s), packetLength);
1159 case PKT_TYPE_HANDSHAKE_RESPONSE:
1160 status = rdg_process_handshake_response(rdg, s);
1163 case PKT_TYPE_TUNNEL_RESPONSE:
1164 status = rdg_process_tunnel_response(rdg, s);
1167 case PKT_TYPE_TUNNEL_AUTH_RESPONSE:
1168 status = rdg_process_tunnel_authorization_response(rdg, s);
1171 case PKT_TYPE_CHANNEL_RESPONSE:
1172 status = rdg_process_channel_response(rdg, s);
1176 WLog_Print(rdg->log, WLOG_ERROR,
"Unexpected packet type DATA");
1180 case PKT_TYPE_EXTENDED_AUTH_MSG:
1181 status = rdg_process_extauth_sspi(rdg, s);
1185 WLog_Print(rdg->log, WLOG_ERROR,
"PKG TYPE 0x%x not implemented", type);
1192 const size_t rem = Stream_GetRemainingLength(s);
1194 WLog_Print(rdg->log, WLOG_WARN,
"[%s] unparsed data detected: %" PRIuz
" bytes",
1195 rdg_pkt_type_to_string(type), rem);
1200DWORD rdg_get_event_handles(rdpRdg* rdg, HANDLE* events, DWORD count)
1203 WINPR_ASSERT(rdg !=
nullptr);
1205 if (rdg->tlsOut && rdg->tlsOut->bio)
1207 if (events && (nCount < count))
1209 BIO_get_event(rdg->tlsOut->bio, &events[nCount]);
1221static BOOL rdg_get_gateway_credentials(rdpContext* context, rdp_auth_reason reason)
1223 freerdp* instance = context->instance;
1225 auth_status rc = utils_authenticate_gateway(instance, reason);
1231 case AUTH_CANCELLED:
1232 freerdp_set_last_error_log(instance->context, FREERDP_ERROR_CONNECT_CANCELLED);
1234 case AUTH_NO_CREDENTIALS:
1235 WLog_INFO(TAG,
"No credentials provided - using nullptr identity");
1243static BOOL rdg_auth_init(rdpRdg* rdg, rdpTls* tls, TCHAR* authPkg)
1245 rdpContext* context = rdg->context;
1246 rdpSettings* settings = context->settings;
1247 SEC_WINNT_AUTH_IDENTITY identity = WINPR_C_ARRAY_INIT;
1250 rdg->auth = credssp_auth_new(context);
1254 if (!credssp_auth_init(rdg->auth, authPkg, tls->Bindings))
1260 if (!smartcard_getCert(context, &rdg->smartcard, TRUE))
1263 if (!rdg_get_gateway_credentials(context, AUTH_SMARTCARD_PIN))
1268 if (!rdg_get_gateway_credentials(context, GW_AUTH_RDG))
1273 if (doSCLogon && !smartcard_getCert(context, &rdg->smartcard, TRUE))
1277 SEC_WINNT_AUTH_IDENTITY* identityArg = &identity;
1280 if (!identity_set_from_smartcard_hash(&identity, settings, FreeRDP_GatewayUsername,
1281 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword,
1282 rdg->smartcard->sha1Hash,
1283 sizeof(rdg->smartcard->sha1Hash)))
1288 if (!identity_set_from_settings(&identity, settings, FreeRDP_GatewayUsername,
1289 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword))
1292 if (!settings->GatewayUsername)
1293 identityArg =
nullptr;
1296 if (!credssp_auth_setup_client(rdg->auth,
"HTTP", settings->GatewayHostname, identityArg,
1297 rdg->smartcard ? rdg->smartcard->pkinitArgs : nullptr))
1299 sspi_FreeAuthIdentity(&identity);
1302 sspi_FreeAuthIdentity(&identity);
1304 credssp_auth_set_flags(rdg->auth, ISC_REQ_CONFIDENTIALITY | ISC_REQ_MUTUAL_AUTH);
1306 rc = credssp_auth_authenticate(rdg->auth);
1310static BOOL rdg_send_http_request(rdpRdg* rdg, rdpTls* tls,
const char* method,
1311 TRANSFER_ENCODING transferEncoding)
1314 wStream* s = rdg_build_http_request(rdg, method, transferEncoding);
1319 const size_t sz = Stream_Length(s);
1320 status = freerdp_tls_write_all(tls, Stream_Buffer(s), sz);
1322 Stream_Free(s, TRUE);
1323 return (status >= 0);
1326static BOOL rdg_tls_connect(rdpRdg* rdg, rdpTls* tls,
const char* peerAddress, UINT32 timeout)
1329 BIO* layerBio =
nullptr;
1330 BIO* bufferedBio =
nullptr;
1332 rdpSettings* settings = rdg->context->settings;
1333 rdpTransport* transport = freerdp_get_transport(rdg->context);
1334 const char* peerHostname = settings->GatewayHostname;
1335 UINT16 peerPort = (UINT16)settings->GatewayPort;
1336 const char* proxyUsername =
nullptr;
1337 const char* proxyPassword =
nullptr;
1338 BOOL isProxyConnection =
1339 proxy_prepare(settings, &peerHostname, &peerPort, &proxyUsername, &proxyPassword);
1341 if (settings->GatewayPort > UINT16_MAX)
1344 layer = transport_connect_layer(transport, peerAddress ? peerAddress : peerHostname, peerPort,
1352 layerBio = BIO_new(BIO_s_transport_layer());
1355 transport_layer_free(layer);
1358 BIO_set_data(layerBio, layer);
1360 bufferedBio = BIO_new(BIO_s_buffered_socket());
1363 BIO_free_all(layerBio);
1367 bufferedBio = BIO_push(bufferedBio, layerBio);
1368 status = BIO_set_nonblock(bufferedBio, TRUE);
1370 if (isProxyConnection)
1372 if (!proxy_connect(rdg->context, bufferedBio, proxyUsername, proxyPassword,
1373 settings->GatewayHostname, (UINT16)settings->GatewayPort))
1375 BIO_free_all(bufferedBio);
1382 BIO_free_all(bufferedBio);
1386 tls->hostname = settings->GatewayHostname;
1387 tls->port = WINPR_ASSERTING_INT_CAST(int32_t, MIN(UINT16_MAX, settings->GatewayPort));
1388 tls->isGatewayTransport = TRUE;
1389 status = freerdp_tls_connect(tls, bufferedBio);
1392 rdpContext* context = rdg->context;
1395 freerdp_set_last_error_if_not(context, FREERDP_ERROR_TLS_CONNECT_FAILED);
1399 freerdp_set_last_error_if_not(context, FREERDP_ERROR_CONNECT_CANCELLED);
1404 return (status >= 1);
1407static BOOL rdg_establish_data_connection(rdpRdg* rdg, rdpTls* tls,
const char* method,
1408 const char* peerAddress, UINT32 timeout,
1411 char buffer[64] = WINPR_C_ARRAY_INIT;
1412 HttpResponse* response =
nullptr;
1414 if (!rdg_tls_connect(rdg, tls, peerAddress, timeout))
1417 WINPR_ASSERT(rpcFallback);
1418 if (rdg->context->settings->GatewayHttpExtAuthBearer && rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1419 rdg->extAuth = HTTP_EXTENDED_AUTH_BEARER;
1420 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1422 if (!rdg_auth_init(rdg, tls, AUTH_PKG))
1425 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1428 response = http_response_recv(tls, TRUE);
1433 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1434 *rpcFallback = TRUE;
1438 (void)http_response_extract_cookies(response, rdg->http);
1440 const UINT16 StatusCode = http_response_get_status_code(response);
1443 case HTTP_STATUS_GONE:
1444 case HTTP_STATUS_FORBIDDEN:
1445 case HTTP_STATUS_NOT_FOUND:
1447 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway does not support HTTP transport.");
1448 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1449 *rpcFallback = TRUE;
1451 http_response_free(response);
1454 case HTTP_STATUS_OK:
1457 case HTTP_STATUS_DENIED:
1458 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1462 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1466 while (!credssp_auth_is_complete(rdg->auth))
1468 BOOL haveToken = FALSE;
1470 if (!rdg_recv_auth_token(rdg->log, rdg->auth, response, &haveToken))
1472 http_response_free(response);
1487 WLog_Print(rdg->log, WLOG_DEBUG,
1488 "No authentication token in the response, ending the exchange");
1492 if (credssp_auth_have_output_token(rdg->auth))
1494 http_response_free(response);
1496 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1499 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);
1511 credssp_auth_free(rdg->auth);
1512 rdg->auth =
nullptr;
1516 credssp_auth_free(rdg->auth);
1517 rdg->auth =
nullptr;
1519 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1522 response = http_response_recv(tls, TRUE);
1526 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1527 *rpcFallback = TRUE;
1530 (void)http_response_extract_cookies(response, rdg->http);
1533 const UINT16 statusCode = http_response_get_status_code(response);
1534 const size_t bodyLength = http_response_get_body_length(response);
1535 const TRANSFER_ENCODING encoding = http_response_get_transfer_encoding(response);
1536 const BOOL isWebsocket = http_response_is_websocket(rdg->http, response);
1538 WLog_Print(rdg->log, WLOG_DEBUG,
"%s authorization result: %s", method,
1539 freerdp_http_status_string_format(statusCode, buffer, ARRAYSIZE(buffer)));
1543 case HTTP_STATUS_OK:
1546 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1547 http_response_free(response);
1549 case HTTP_STATUS_DENIED:
1550 freerdp_set_last_error_log(rdg->context, FREERDP_ERROR_CONNECT_ACCESS_DENIED);
1551 http_response_free(response);
1553 case HTTP_STATUS_SWITCH_PROTOCOLS:
1554 http_response_free(response);
1561 if (http_context_is_websocket_upgrade_enabled(rdg->http))
1563 long fd = BIO_get_fd(tls->bio,
nullptr);
1565 closesocket((SOCKET)fd);
1566 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1567 return rdg_establish_data_connection(rdg, tls, method, peerAddress, timeout,
1573 rdg->transferEncoding.isWebsocketTransport = TRUE;
1574 if (!websocket_context_reset(rdg->transferEncoding.context.websocket))
1577 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1581 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1586 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1587 http_response_free(response);
1591 if (strcmp(method,
"RDG_OUT_DATA") == 0)
1593 if (encoding == TransferEncodingChunked)
1595 rdg->transferEncoding.httpTransferEncoding = TransferEncodingChunked;
1596 rdg->transferEncoding.context.chunked.nextOffset = 0;
1597 rdg->transferEncoding.context.chunked.headerFooterPos = 0;
1598 rdg->transferEncoding.context.chunked.state = ChunkStateLenghHeader;
1600 if (!rdg_skip_seed_payload(rdg->context, tls, bodyLength, &rdg->transferEncoding))
1607 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingChunked))
1610 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1614 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1622static BOOL rdg_tunnel_connect(rdpRdg* rdg)
1626 rdg_send_handshake(rdg);
1628 while (rdg->state < RDG_CLIENT_STATE_OPENED)
1631 s = rdg_receive_packet(rdg);
1635 status = rdg_process_packet(rdg, s);
1636 Stream_Free(s, TRUE);
1642 WINPR_ASSERT(rdg->context);
1643 WINPR_ASSERT(rdg->context->rdp);
1644 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1652BOOL rdg_connect(rdpRdg* rdg, DWORD timeout, BOOL* rpcFallback)
1655 SOCKET outConnSocket = 0;
1656 char* peerAddress =
nullptr;
1657 BOOL rpcFallbackLocal = FALSE;
1659 WINPR_ASSERT(rdg !=
nullptr);
1660 freerdp_set_last_error(rdg->context, ERROR_SUCCESS);
1661 status = rdg_establish_data_connection(rdg, rdg->tlsOut,
"RDG_OUT_DATA",
nullptr, timeout,
1666 if (rdg->transferEncoding.isWebsocketTransport)
1668 WLog_Print(rdg->log, WLOG_DEBUG,
"Upgraded to websocket. RDG_IN_DATA not required");
1675 BIO_get_socket(rdg->tlsOut->underlying, &outConnSocket);
1676 peerAddress = freerdp_tcp_get_peer_address(outConnSocket);
1677 status = rdg_establish_data_connection(rdg, rdg->tlsIn,
"RDG_IN_DATA", peerAddress,
1678 timeout, &rpcFallbackLocal);
1684 *rpcFallback = rpcFallbackLocal;
1689 WINPR_ASSERT(rdg->context);
1690 WINPR_ASSERT(rdg->context->rdp);
1691 if (rpcFallbackLocal)
1693 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1694 credssp_auth_free(rdg->auth);
1695 rdg->auth =
nullptr;
1698 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1702 status = rdg_tunnel_connect(rdg);
1707static int rdg_write_websocket_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1713 const size_t payloadSize = (size_t)isize + 10;
1721 websocket_context_packet_new(payloadSize, WebsocketBinaryOpcode, &maskingKey.u32);
1725 Stream_Write_UINT16(
1726 sWS, WINPR_ASSERTING_INT_CAST(
1727 uint16_t, PKT_TYPE_DATA ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1728 Stream_Write_UINT16(
1729 sWS, WINPR_ASSERTING_INT_CAST(
1730 uint16_t, 0 ^ (maskingKey.u8[2] | maskingKey.u8[3] << 8)));
1731 Stream_Write_UINT32(
1732 sWS, WINPR_ASSERTING_INT_CAST(uint32_t, payloadSize ^ maskingKey.u32));
1733 Stream_Write_UINT16(
1734 sWS, WINPR_ASSERTING_INT_CAST(
1735 uint16_t, isize ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1738 maskingKey.u32 = (maskingKey.u32 & 0xffff) << 16 | (maskingKey.u32 >> 16);
1740 WINPR_ASSERT(rdg->tlsOut);
1741 wStream sPacket = WINPR_C_ARRAY_INIT;
1742 Stream_StaticConstInit(&sPacket, buf, (
size_t)isize);
1743 if (!websocket_context_mask_and_send(rdg->tlsOut->bio, sWS, &sPacket, maskingKey.u32))
1749static int rdg_write_chunked_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1755 if (isize > UINT16_MAX)
1758 const size_t size = (size_t)isize;
1762 const size_t packetSize = size + 10;
1763 char chunkSize[11] = WINPR_C_ARRAY_INIT;
1764 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIxz
"\r\n", packetSize);
1765 sChunk = Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + packetSize + 2);
1770 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
1771 Stream_Write_UINT16(sChunk, PKT_TYPE_DATA);
1772 Stream_Write_UINT16(sChunk, 0);
1773 Stream_Write_UINT32(sChunk, (UINT32)packetSize);
1774 Stream_Write_UINT16(sChunk, (UINT16)size);
1775 Stream_Write(sChunk, buf, size);
1776 Stream_Write(sChunk,
"\r\n", 2);
1777 Stream_SealLength(sChunk);
1778 len = Stream_Length(sChunk);
1780 status = freerdp_tls_write_all(rdg->tlsIn, Stream_Buffer(sChunk), len);
1781 Stream_Free(sChunk, TRUE);
1789static int rdg_write_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1792 if (rdg->transferEncoding.isWebsocketTransport)
1793 return rdg_write_websocket_data_packet(rdg, buf, isize);
1795 return rdg_write_chunked_data_packet(rdg, buf, isize);
1798static BOOL rdg_process_close_packet(rdpRdg* rdg,
wStream* s)
1802 UINT32 errorCode = 0;
1803 UINT32 packetSize = 12;
1806 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1808 Stream_Read_UINT32(s, errorCode);
1811 freerdp_set_last_error_log(rdg->context, errorCode);
1813 sClose = Stream_New(
nullptr, packetSize);
1817 Stream_Write_UINT16(sClose, PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
1818 Stream_Write_UINT16(sClose, 0);
1819 Stream_Write_UINT32(sClose, packetSize);
1820 Stream_Write_UINT32(sClose, 0);
1821 Stream_SealLength(sClose);
1822 status = rdg_write_packet(rdg, sClose);
1823 Stream_Free(sClose, TRUE);
1825 return ((status >= 0));
1828static BOOL rdg_process_keep_alive_packet(rdpRdg* rdg)
1831 wStream* sKeepAlive =
nullptr;
1832 size_t packetSize = 8;
1834 sKeepAlive = Stream_New(
nullptr, packetSize);
1839 Stream_Write_UINT16(sKeepAlive, PKT_TYPE_KEEPALIVE);
1840 Stream_Write_UINT16(sKeepAlive, 0);
1841 Stream_Write_UINT32(sKeepAlive, (UINT32)packetSize);
1842 Stream_SealLength(sKeepAlive);
1843 status = rdg_write_packet(rdg, sKeepAlive);
1844 Stream_Free(sKeepAlive, TRUE);
1846 return ((status >= 0));
1849static BOOL rdg_process_service_message(rdpRdg* rdg,
wStream* s)
1851 const WCHAR* msg =
nullptr;
1852 UINT16 msgLenBytes = 0;
1853 rdpContext* context = rdg->context;
1854 WINPR_ASSERT(context);
1855 WINPR_ASSERT(context->instance);
1858 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
1860 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read string");
1864 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
1865 GATEWAY_MESSAGE_SERVICE, TRUE, FALSE, msgLenBytes, msg);
1868static BOOL rdg_process_unknown_packet(rdpRdg* rdg,
int type)
1872 WLog_Print(rdg->log, WLOG_WARN,
"Unknown Control Packet received: %" PRIX32,
1873 WINPR_CXX_COMPAT_CAST(UINT32, type));
1877static BOOL rdg_process_control_packet(rdpRdg* rdg,
int type,
size_t packetLength)
1880 size_t readCount = 0;
1882 size_t payloadSize = packetLength -
sizeof(RdgPacketHeader);
1884 if (packetLength <
sizeof(RdgPacketHeader))
1888 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1892 s = Stream_New(
nullptr, payloadSize);
1897 while (readCount < payloadSize)
1899 if (rdg_shall_abort(rdg))
1901 Stream_Free(s, TRUE);
1904 status = rdg_socket_read(rdg->tlsOut->bio, Stream_Pointer(s), payloadSize - readCount,
1905 &rdg->transferEncoding);
1909 if (!BIO_should_retry(rdg->tlsOut->bio))
1911 Stream_Free(s, TRUE);
1918 Stream_Seek(s, (
size_t)status);
1919 readCount += (size_t)status;
1921 if (readCount > INT_MAX)
1923 Stream_Free(s, TRUE);
1928 Stream_ResetPosition(s);
1933 case PKT_TYPE_CLOSE_CHANNEL:
1934 EnterCriticalSection(&rdg->writeSection);
1935 status = rdg_process_close_packet(rdg, s);
1936 LeaveCriticalSection(&rdg->writeSection);
1939 case PKT_TYPE_KEEPALIVE:
1940 EnterCriticalSection(&rdg->writeSection);
1941 status = rdg_process_keep_alive_packet(rdg);
1942 LeaveCriticalSection(&rdg->writeSection);
1945 case PKT_TYPE_SERVICE_MESSAGE:
1948 WLog_Print(rdg->log, WLOG_ERROR,
1949 "PKT_TYPE_SERVICE_MESSAGE requires payload but none was sent");
1952 status = rdg_process_service_message(rdg, s);
1955 case PKT_TYPE_REAUTH_MESSAGE:
1957 status = rdg_process_unknown_packet(rdg, type);
1961 Stream_Free(s, TRUE);
1965static int rdg_read_data_packet(rdpRdg* rdg, BYTE* buffer,
size_t size)
1967 RdgPacketHeader header = WINPR_C_ARRAY_INIT;
1968 size_t readCount = 0;
1969 size_t readSize = 0;
1972 if (!rdg->packetRemainingCount)
1975 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1977 while (readCount <
sizeof(RdgPacketHeader))
1979 if (rdg_shall_abort(rdg))
1982 status = rdg_socket_read(rdg->tlsOut->bio, (BYTE*)(&header) + readCount,
1983 sizeof(RdgPacketHeader) - readCount, &rdg->transferEncoding);
1987 if (!BIO_should_retry(rdg->tlsOut->bio))
1993 BIO_wait_read(rdg->tlsOut->bio, 50);
1997 readCount += (size_t)status;
1999 if (readCount > INT_MAX)
2003 if (header.type != PKT_TYPE_DATA)
2005 status = rdg_process_control_packet(rdg, header.type, header.packetLength);
2015 while (readCount < 2)
2017 if (rdg_shall_abort(rdg))
2020 rdg_socket_read(rdg->tlsOut->bio, (BYTE*)(&rdg->packetRemainingCount) + readCount,
2021 2 - readCount, &rdg->transferEncoding);
2025 if (!BIO_should_retry(rdg->tlsOut->bio))
2028 BIO_wait_read(rdg->tlsOut->bio, 50);
2032 readCount += (size_t)status;
2036 readSize = (rdg->packetRemainingCount < size) ? rdg->packetRemainingCount : size;
2037 status = rdg_socket_read(rdg->tlsOut->bio, buffer, readSize, &rdg->transferEncoding);
2041 if (!BIO_should_retry(rdg->tlsOut->bio))
2049 rdg->packetRemainingCount -= status;
2053static int rdg_bio_write(BIO* bio,
const char* buf,
int num)
2056 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2060 BIO_clear_flags(bio, BIO_FLAGS_WRITE);
2061 EnterCriticalSection(&rdg->writeSection);
2062 status = rdg_write_data_packet(rdg, (
const BYTE*)buf, num);
2063 LeaveCriticalSection(&rdg->writeSection);
2067 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2070 else if (status < num)
2072 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2073 WSASetLastError(WSAEWOULDBLOCK);
2077 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2083static int rdg_bio_read(BIO* bio,
char* buf,
int size)
2086 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2089 status = rdg_read_data_packet(rdg, (BYTE*)buf, (
size_t)size);
2093 BIO_clear_retry_flags(bio);
2096 else if (status == 0)
2098 BIO_set_retry_read(bio);
2099 WSASetLastError(WSAEWOULDBLOCK);
2104 BIO_set_flags(bio, BIO_FLAGS_READ);
2110static int rdg_bio_puts(BIO* bio,
const char* str)
2118static int rdg_bio_gets(BIO* bio,
char* str,
int size)
2126static long rdg_bio_ctrl(BIO* in_bio,
int cmd,
long arg1,
void* arg2)
2129 rdpRdg* rdg = (rdpRdg*)BIO_get_data(in_bio);
2130 rdpTls* tlsOut = rdg->tlsOut;
2131 rdpTls* tlsIn = rdg->tlsIn;
2133 if (cmd == BIO_CTRL_FLUSH)
2135 (void)BIO_flush(tlsOut->bio);
2136 if (!rdg->transferEncoding.isWebsocketTransport)
2137 (void)BIO_flush(tlsIn->bio);
2140 else if (cmd == BIO_C_SET_NONBLOCK)
2144 else if (cmd == BIO_C_READ_BLOCKED)
2146 BIO* cbio = tlsOut->bio;
2147 status = BIO_read_blocked(cbio);
2149 else if (cmd == BIO_C_WRITE_BLOCKED)
2151 BIO* cbio = tlsIn->bio;
2153 if (rdg->transferEncoding.isWebsocketTransport)
2156 status = BIO_write_blocked(cbio);
2158 else if (cmd == BIO_C_WAIT_READ)
2160 int timeout = (int)arg1;
2161 BIO* cbio = tlsOut->bio;
2163 if (BIO_read_blocked(cbio))
2164 return BIO_wait_read(cbio, timeout);
2165 else if (BIO_write_blocked(cbio))
2166 return BIO_wait_write(cbio, timeout);
2170 else if (cmd == BIO_C_WAIT_WRITE)
2172 int timeout = (int)arg1;
2173 BIO* cbio = tlsIn->bio;
2175 if (rdg->transferEncoding.isWebsocketTransport)
2178 if (BIO_write_blocked(cbio))
2179 status = BIO_wait_write(cbio, timeout);
2180 else if (BIO_read_blocked(cbio))
2181 status = BIO_wait_read(cbio, timeout);
2185 else if (cmd == BIO_C_GET_EVENT || cmd == BIO_C_GET_FD)
2195 status = BIO_ctrl(tlsOut->bio, cmd, arg1, arg2);
2197#if OPENSSL_VERSION_NUMBER >= 0x30000000L
2198 else if (cmd == BIO_CTRL_GET_KTLS_SEND)
2206 else if (cmd == BIO_CTRL_GET_KTLS_RECV)
2217static int rdg_bio_new(BIO* bio)
2219 BIO_set_init(bio, 1);
2220 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2224static int rdg_bio_free(BIO* bio)
2230static BIO_METHOD* BIO_s_rdg(
void)
2232 static BIO_METHOD* bio_methods =
nullptr;
2234 if (bio_methods ==
nullptr)
2236 if (!(bio_methods = BIO_meth_new(BIO_TYPE_TSG,
"RDGateway")))
2239 BIO_meth_set_write(bio_methods, rdg_bio_write);
2240 BIO_meth_set_read(bio_methods, rdg_bio_read);
2241 BIO_meth_set_puts(bio_methods, rdg_bio_puts);
2242 BIO_meth_set_gets(bio_methods, rdg_bio_gets);
2243 BIO_meth_set_ctrl(bio_methods, rdg_bio_ctrl);
2244 BIO_meth_set_create(bio_methods, rdg_bio_new);
2245 BIO_meth_set_destroy(bio_methods, rdg_bio_free);
2251rdpRdg* rdg_new(rdpContext* context)
2256 rdpRdg* rdg = (rdpRdg*)calloc(1,
sizeof(rdpRdg));
2260 rdg->log = WLog_Get(TAG);
2261 rdg->state = RDG_CLIENT_STATE_INITIAL;
2262 rdg->context = context;
2263 rdpSettings* settings = rdg->context->settings;
2264 rdg->extAuth = (settings->GatewayHttpExtAuthSspiNtlm ? HTTP_EXTENDED_AUTH_SSPI_NTLM
2265 : HTTP_EXTENDED_AUTH_NONE);
2267 if (settings->GatewayAccessToken)
2268 rdg->extAuth = HTTP_EXTENDED_AUTH_PAA;
2270 rdg->tlsOut = freerdp_tls_new(rdg->context);
2273 goto rdg_alloc_error;
2275 rdg->tlsIn = freerdp_tls_new(rdg->context);
2278 goto rdg_alloc_error;
2280 rdg->http = http_context_new();
2283 goto rdg_alloc_error;
2285 GUID guid = WINPR_C_ARRAY_INIT;
2286 if (UuidFromStringA(settings->CorrelationId, &guid) != RPC_S_OK)
2287 goto rdg_alloc_error;
2289 if (!http_context_set_uri(rdg->http,
"/remoteDesktopGateway/") ||
2290 !http_context_set_accept(rdg->http,
"*/*") ||
2291 !http_context_set_cache_control(rdg->http,
"no-cache") ||
2292 !http_context_set_pragma(rdg->http,
"no-cache") ||
2293 !http_context_set_connection(rdg->http,
"Keep-Alive") ||
2294 !http_context_set_user_agent(rdg->http,
"MS-RDGateway/1.0") ||
2295 !http_context_set_host(rdg->http, rdg->context->settings->GatewayHostname) ||
2296 !http_context_set_rdg_connection_id(rdg->http) ||
2297 !http_context_set_rdg_correlation_id(rdg->http, &guid) ||
2298 !http_context_enable_websocket_upgrade(
2302 goto rdg_alloc_error;
2305 if (rdg->extAuth != HTTP_EXTENDED_AUTH_NONE)
2307 switch (rdg->extAuth)
2309 case HTTP_EXTENDED_AUTH_PAA:
2310 if (!http_context_set_rdg_auth_scheme(rdg->http,
"PAA"))
2311 goto rdg_alloc_error;
2315 case HTTP_EXTENDED_AUTH_SSPI_NTLM:
2316 if (!http_context_set_rdg_auth_scheme(rdg->http,
"SSPI_NTLM"))
2317 goto rdg_alloc_error;
2322 WLog_Print(rdg->log, WLOG_DEBUG,
2323 "RDG extended authentication method %d not supported", rdg->extAuth);
2327 rdg->frontBio = BIO_new(BIO_s_rdg());
2330 goto rdg_alloc_error;
2332 BIO_set_data(rdg->frontBio, rdg);
2333 InitializeCriticalSection(&rdg->writeSection);
2335 rdg->transferEncoding.httpTransferEncoding = TransferEncodingIdentity;
2336 rdg->transferEncoding.isWebsocketTransport = FALSE;
2338 rdg->transferEncoding.context.websocket = websocket_context_new();
2339 if (!rdg->transferEncoding.context.websocket)
2340 goto rdg_alloc_error;
2344 WINPR_PRAGMA_DIAG_PUSH
2345 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2347 WINPR_PRAGMA_DIAG_POP
2351void rdg_free(rdpRdg* rdg)
2356 freerdp_tls_free(rdg->tlsOut);
2357 freerdp_tls_free(rdg->tlsIn);
2358 http_context_free(rdg->http);
2359 credssp_auth_free(rdg->auth);
2362 BIO_free_all(rdg->frontBio);
2364 DeleteCriticalSection(&rdg->writeSection);
2366 smartcardCertInfo_Free(rdg->smartcard);
2368 websocket_context_free(rdg->transferEncoding.context.websocket);
2373BIO* rdg_get_front_bio_and_take_ownership(rdpRdg* rdg)
2378 rdg->attached = TRUE;
2379 return rdg->frontBio;
FREERDP_API WCHAR * freerdp_settings_get_string_as_utf16(const rdpSettings *settings, FreeRDP_Settings_Keys_String id, size_t *pCharLen)
Return an allocated UTF16 string.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.