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, rdpContext* context, 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, context, pBuffer, size,
382 &encodingContext->context.chunked);
388static BOOL rdg_shall_abort(rdpRdg* rdg)
391 return freerdp_shall_disconnect_context(rdg->context);
394static BOOL rdg_read_all(rdpContext* context, rdpTls* tls, BYTE* buffer,
size_t size,
395 rdg_http_encoding_context* transferEncoding)
397 size_t readCount = 0;
398 BYTE* pBuffer = buffer;
400 while (readCount < size)
402 if (freerdp_shall_disconnect_context(context))
406 rdg_socket_read(tls->bio, tls->context, 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,
734 size_t authTokenLength = 0;
735 BYTE* authTokenData =
nullptr;
736 SecBuffer authToken = WINPR_C_ARRAY_INIT;
739 WINPR_ASSERT(pHaveToken);
742 if (!auth || !response)
745 const UINT16 StatusCode = http_response_get_status_code(response);
748 case HTTP_STATUS_DENIED:
750 case HTTP_STATUS_SWITCH_PROTOCOLS:
753 http_response_log_error_status(log, WLOG_WARN, response);
757 const char* token64 = http_response_get_auth_token(response, credssp_auth_pkg_name(auth));
767 len = strlen(token64);
769 crypto_base64_decode(token64, len, &authTokenData, &authTokenLength);
771 if (authTokenLength && authTokenData && (authTokenLength <= UINT32_MAX))
773 authToken.pvBuffer = authTokenData;
774 authToken.cbBuffer = (UINT32)authTokenLength;
775 credssp_auth_take_input_buffer(auth, &authToken);
780 rc = credssp_auth_authenticate(auth);
784static BOOL rdg_skip_seed_payload(rdpContext* context, rdpTls* tls,
size_t lastResponseLength,
785 rdg_http_encoding_context* transferEncoding)
787 BYTE seed_payload[10] = WINPR_C_ARRAY_INIT;
788 const size_t size =
sizeof(seed_payload);
793 if (lastResponseLength < size)
795 if (!rdg_read_all(context, tls, seed_payload, size - lastResponseLength, transferEncoding))
804static BOOL rdg_process_handshake_response(rdpRdg* rdg,
wStream* s)
806 UINT32 errorCode = 0;
807 UINT16 serverVersion = 0;
808 UINT16 extendedAuth = 0;
811 const char* error =
nullptr;
812 WLog_Print(rdg->log, WLOG_DEBUG,
"Handshake response received");
814 if (rdg->state != RDG_CLIENT_STATE_HANDSHAKE)
819 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
822 Stream_Read_UINT32(s, errorCode);
823 Stream_Read_UINT8(s, verMajor);
824 Stream_Read_UINT8(s, verMinor);
825 Stream_Read_UINT16(s, serverVersion);
826 Stream_Read_UINT16(s, extendedAuth);
827 error = rpc_error_to_string(errorCode);
828 WLog_Print(rdg->log, WLOG_DEBUG,
829 "errorCode=%s, verMajor=%" PRId8
", verMinor=%" PRId8
", serverVersion=%" PRId16
831 error, verMajor, verMinor, serverVersion, extended_auth_to_string(extendedAuth));
833 if (FAILED((HRESULT)errorCode))
835 WLog_Print(rdg->log, WLOG_ERROR,
"Handshake error %s", error);
836 freerdp_set_last_error_log(rdg->context, errorCode);
840 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
841 return rdg_send_extauth_sspi(rdg);
843 return rdg_send_tunnel_request(rdg);
846static BOOL rdg_process_tunnel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
848 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID)
851 if (!Stream_SafeSeek(s, 4))
853 WLog_Print(rdg->log, WLOG_ERROR,
"Short tunnelId, got %" PRIuz
", expected 4",
854 Stream_GetRemainingLength(s));
859 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CAPS)
862 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
865 Stream_Read_UINT32(s, caps);
866 WLog_Print(rdg->log, WLOG_DEBUG,
"capabilities=%s", capabilities_enum_to_string(caps));
869 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ)
872 if (!Stream_SafeSeek(s, 20))
874 WLog_Print(rdg->log, WLOG_ERROR,
"Short nonce, got %" PRIuz
", expected 20",
875 Stream_GetRemainingLength(s));
880 if (!rdg_read_http_unicode_string(rdg->log, s,
nullptr,
nullptr))
882 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read server certificate");
887 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG)
889 const WCHAR* msg =
nullptr;
890 UINT16 msgLenBytes = 0;
891 rdpContext* context = rdg->context;
893 WINPR_ASSERT(context);
894 WINPR_ASSERT(context->instance);
897 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
899 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read consent message");
903 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
904 GATEWAY_MESSAGE_CONSENT, TRUE, TRUE, msgLenBytes, msg);
910static BOOL rdg_process_tunnel_response(rdpRdg* rdg,
wStream* s)
912 UINT16 serverVersion = 0;
913 UINT16 fieldsPresent = 0;
914 UINT32 errorCode = 0;
915 const char* error =
nullptr;
916 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel response received");
918 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_CREATE)
923 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
926 Stream_Read_UINT16(s, serverVersion);
927 Stream_Read_UINT32(s, errorCode);
928 Stream_Read_UINT16(s, fieldsPresent);
929 Stream_Seek_UINT16(s);
930 error = rpc_error_to_string(errorCode);
931 WLog_Print(rdg->log, WLOG_DEBUG,
"serverVersion=%" PRId16
", errorCode=%s, fieldsPresent=%s",
932 serverVersion, error, tunnel_response_fields_present_to_string(fieldsPresent));
934 if (FAILED((HRESULT)errorCode))
936 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel creation error %s", error);
937 freerdp_set_last_error_log(rdg->context, errorCode);
941 if (!rdg_process_tunnel_response_optional(rdg, s, fieldsPresent))
944 return rdg_send_tunnel_authorization(rdg);
947static BOOL rdg_process_tunnel_authorization_response(rdpRdg* rdg,
wStream* s)
949 UINT32 errorCode = 0;
950 UINT16 fieldsPresent = 0;
951 const char* error =
nullptr;
952 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel authorization received");
954 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_AUTHORIZE)
959 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
962 Stream_Read_UINT32(s, errorCode);
963 Stream_Read_UINT16(s, fieldsPresent);
964 Stream_Seek_UINT16(s);
965 error = rpc_error_to_string(errorCode);
966 WLog_Print(rdg->log, WLOG_DEBUG,
"errorCode=%s, fieldsPresent=%s", error,
967 tunnel_authorization_response_fields_present_to_string(fieldsPresent));
970 if (errorCode != S_OK && errorCode != E_PROXY_QUARANTINE_ACCESSDENIED)
972 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel authorization error %s", error);
973 freerdp_set_last_error_log(rdg->context, errorCode);
977 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS)
979 UINT32 redirFlags = 0;
980 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
982 Stream_Read_UINT32(s, redirFlags);
984 rdpContext* context = rdg->context;
985 if (!utils_apply_gateway_policy(rdg->log, context, redirFlags,
"RDG"))
989 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT)
991 UINT32 idleTimeout = 0;
992 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
994 Stream_Read_UINT32(s, idleTimeout);
995 WLog_Print(rdg->log, WLOG_DEBUG,
"[IDLE_TIMEOUT] idleTimeout=%" PRIu32
": TODO: unused",
999 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE)
1002 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1004 Stream_Read_UINT16(s, cbLen);
1006 WLog_Print(rdg->log, WLOG_DEBUG,
"[SOH_RESPONSE] cbLen=%" PRIu16
": TODO: unused", cbLen);
1007 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, cbLen))
1009 Stream_Seek(s, cbLen);
1012 return rdg_send_channel_create(rdg);
1015static BOOL rdg_process_extauth_sspi(rdpRdg* rdg,
wStream* s)
1017 INT32 errorCode = 0;
1018 UINT16 authBlobLen = 0;
1019 SecBuffer authToken = WINPR_C_ARRAY_INIT;
1020 BYTE* authTokenData =
nullptr;
1024 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 6))
1027 Stream_Read_INT32(s, errorCode);
1028 Stream_Read_UINT16(s, authBlobLen);
1030 if (errorCode != ERROR_SUCCESS)
1032 WLog_Print(rdg->log, WLOG_ERROR,
"EXTAUTH_SSPI_NTLM failed with error %s [0x%08X]",
1033 GetSecurityStatusString(errorCode), WINPR_CXX_COMPAT_CAST(UINT32, errorCode));
1037 if (authBlobLen == 0)
1039 if (credssp_auth_is_complete(rdg->auth))
1041 credssp_auth_free(rdg->auth);
1042 rdg->auth =
nullptr;
1043 return rdg_send_tunnel_request(rdg);
1048 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, authBlobLen))
1051 authTokenData = malloc(authBlobLen);
1052 if (authTokenData ==
nullptr)
1054 Stream_Read(s, authTokenData, authBlobLen);
1056 authToken.pvBuffer = authTokenData;
1057 authToken.cbBuffer = authBlobLen;
1059 credssp_auth_take_input_buffer(rdg->auth, &authToken);
1061 if (credssp_auth_authenticate(rdg->auth) < 0)
1064 if (credssp_auth_have_output_token(rdg->auth))
1065 return rdg_send_extauth_sspi(rdg);
1070static BOOL rdg_process_channel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
1072 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID) != 0)
1074 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1076 const UINT32 channelId = Stream_Get_UINT32(s);
1077 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got channelId=%" PRIu32, channelId);
1079 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT) != 0)
1081 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1083 const UINT16 udpPort = Stream_Get_UINT16(s);
1084 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got udpPort=%" PRIu32, udpPort);
1086 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE) != 0)
1088 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1090 const UINT16 blobLen = Stream_Get_UINT16(s);
1091 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, blobLen))
1093 WLog_Print(rdg->log, WLOG_DEBUG,
"TODO: Got UDP auth blob=%" PRIu32, blobLen);
1094 if (!Stream_SafeSeek(s, blobLen))
1101static BOOL rdg_process_channel_response(rdpRdg* rdg,
wStream* s)
1103 UINT16 fieldsPresent = 0;
1104 UINT32 errorCode = 0;
1105 const char* error =
nullptr;
1106 WLog_Print(rdg->log, WLOG_DEBUG,
"Channel response received");
1108 if (rdg->state != RDG_CLIENT_STATE_CHANNEL_CREATE)
1113 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1116 Stream_Read_UINT32(s, errorCode);
1117 Stream_Read_UINT16(s, fieldsPresent);
1118 Stream_Seek_UINT16(s);
1119 error = rpc_error_to_string(errorCode);
1120 WLog_Print(rdg->log, WLOG_DEBUG,
"channel response errorCode=%s, fieldsPresent=%s", error,
1121 channel_response_fields_present_to_string(fieldsPresent));
1123 if (FAILED((HRESULT)errorCode))
1125 WLog_Print(rdg->log, WLOG_ERROR,
"channel response errorCode=%s, fieldsPresent=%s", error,
1126 channel_response_fields_present_to_string(fieldsPresent));
1127 freerdp_set_last_error_log(rdg->context, errorCode);
1131 if (!rdg_process_channel_response_optional(rdg, s, fieldsPresent))
1134 rdg->state = RDG_CLIENT_STATE_OPENED;
1138static BOOL rdg_process_packet(rdpRdg* rdg,
wStream* s)
1142 UINT32 packetLength = 0;
1143 Stream_ResetPosition(s);
1145 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1148 Stream_Read_UINT16(s, type);
1149 Stream_Seek_UINT16(s);
1150 Stream_Read_UINT32(s, packetLength);
1152 if (Stream_Length(s) < packetLength)
1154 WLog_Print(rdg->log, WLOG_ERROR,
"Short packet %" PRIuz
", expected %" PRIu32,
1155 Stream_Length(s), packetLength);
1161 case PKT_TYPE_HANDSHAKE_RESPONSE:
1162 status = rdg_process_handshake_response(rdg, s);
1165 case PKT_TYPE_TUNNEL_RESPONSE:
1166 status = rdg_process_tunnel_response(rdg, s);
1169 case PKT_TYPE_TUNNEL_AUTH_RESPONSE:
1170 status = rdg_process_tunnel_authorization_response(rdg, s);
1173 case PKT_TYPE_CHANNEL_RESPONSE:
1174 status = rdg_process_channel_response(rdg, s);
1178 WLog_Print(rdg->log, WLOG_ERROR,
"Unexpected packet type DATA");
1182 case PKT_TYPE_EXTENDED_AUTH_MSG:
1183 status = rdg_process_extauth_sspi(rdg, s);
1187 WLog_Print(rdg->log, WLOG_ERROR,
"PKG TYPE 0x%x not implemented", type);
1194 const size_t rem = Stream_GetRemainingLength(s);
1196 WLog_Print(rdg->log, WLOG_WARN,
"[%s] unparsed data detected: %" PRIuz
" bytes",
1197 rdg_pkt_type_to_string(type), rem);
1202DWORD rdg_get_event_handles(rdpRdg* rdg, HANDLE* events, DWORD count)
1205 WINPR_ASSERT(rdg !=
nullptr);
1207 if (rdg->tlsOut && rdg->tlsOut->bio)
1209 if (events && (nCount < count))
1211 BIO_get_event(rdg->tlsOut->bio, &events[nCount]);
1223static BOOL rdg_get_gateway_credentials(rdpContext* context, rdp_auth_reason reason)
1225 freerdp* instance = context->instance;
1227 auth_status rc = utils_authenticate_gateway(instance, reason);
1233 case AUTH_CANCELLED:
1234 freerdp_set_last_error_log(instance->context, FREERDP_ERROR_CONNECT_CANCELLED);
1236 case AUTH_NO_CREDENTIALS:
1237 WLog_INFO(TAG,
"No credentials provided - using nullptr identity");
1245static BOOL rdg_auth_init(rdpRdg* rdg, rdpTls* tls, TCHAR* authPkg)
1247 rdpContext* context = rdg->context;
1248 rdpSettings* settings = context->settings;
1249 SEC_WINNT_AUTH_IDENTITY identity = WINPR_C_ARRAY_INIT;
1252 rdg->auth = credssp_auth_new(context);
1256 if (!credssp_auth_init(rdg->auth, authPkg, tls->Bindings))
1262 if (!smartcard_getCert(context, &rdg->smartcard, TRUE))
1265 if (!rdg_get_gateway_credentials(context, AUTH_SMARTCARD_PIN))
1270 if (!rdg_get_gateway_credentials(context, GW_AUTH_RDG))
1275 if (doSCLogon && !smartcard_getCert(context, &rdg->smartcard, TRUE))
1279 SEC_WINNT_AUTH_IDENTITY* identityArg = &identity;
1282 if (!identity_set_from_smartcard_hash(&identity, settings, FreeRDP_GatewayUsername,
1283 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword,
1284 rdg->smartcard->sha1Hash,
1285 sizeof(rdg->smartcard->sha1Hash)))
1290 if (!identity_set_from_settings(&identity, settings, FreeRDP_GatewayUsername,
1291 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword))
1294 if (!settings->GatewayUsername)
1295 identityArg =
nullptr;
1298 if (!credssp_auth_setup_client(rdg->auth,
"HTTP", settings->GatewayHostname, identityArg,
1299 rdg->smartcard ? rdg->smartcard->pkinitArgs : nullptr))
1301 sspi_FreeAuthIdentity(&identity);
1304 sspi_FreeAuthIdentity(&identity);
1306 credssp_auth_set_flags(rdg->auth, ISC_REQ_CONFIDENTIALITY | ISC_REQ_MUTUAL_AUTH);
1308 rc = credssp_auth_authenticate(rdg->auth);
1312static BOOL rdg_send_http_request(rdpRdg* rdg, rdpTls* tls,
const char* method,
1313 TRANSFER_ENCODING transferEncoding)
1316 wStream* s = rdg_build_http_request(rdg, method, transferEncoding);
1321 const size_t sz = Stream_Length(s);
1322 status = freerdp_tls_write_all(tls, Stream_Buffer(s), sz);
1324 Stream_Free(s, TRUE);
1325 return (status >= 0);
1328static BOOL rdg_tls_connect(rdpRdg* rdg, rdpTls* tls,
const char* peerAddress, UINT32 timeout)
1331 BIO* layerBio =
nullptr;
1332 BIO* bufferedBio =
nullptr;
1334 rdpSettings* settings = rdg->context->settings;
1335 rdpTransport* transport = freerdp_get_transport(rdg->context);
1336 const char* peerHostname = settings->GatewayHostname;
1337 UINT16 peerPort = (UINT16)settings->GatewayPort;
1338 const char* proxyUsername =
nullptr;
1339 const char* proxyPassword =
nullptr;
1340 BOOL isProxyConnection =
1341 proxy_prepare(settings, &peerHostname, &peerPort, &proxyUsername, &proxyPassword);
1343 if (settings->GatewayPort > UINT16_MAX)
1346 layer = transport_connect_layer(transport, peerAddress ? peerAddress : peerHostname, peerPort,
1354 layerBio = BIO_new(BIO_s_transport_layer());
1357 transport_layer_free(layer);
1360 BIO_set_data(layerBio, layer);
1362 bufferedBio = BIO_new(BIO_s_buffered_socket());
1365 BIO_free_all(layerBio);
1369 bufferedBio = BIO_push(bufferedBio, layerBio);
1370 status = BIO_set_nonblock(bufferedBio, TRUE);
1372 if (isProxyConnection)
1374 if (!proxy_connect(rdg->context, bufferedBio, proxyUsername, proxyPassword,
1375 settings->GatewayHostname, (UINT16)settings->GatewayPort))
1377 BIO_free_all(bufferedBio);
1384 BIO_free_all(bufferedBio);
1388 tls->hostname = settings->GatewayHostname;
1389 tls->port = WINPR_ASSERTING_INT_CAST(int32_t, MIN(UINT16_MAX, settings->GatewayPort));
1390 tls->isGatewayTransport = TRUE;
1391 status = freerdp_tls_connect(tls, bufferedBio);
1394 rdpContext* context = rdg->context;
1397 freerdp_set_last_error_if_not(context, FREERDP_ERROR_TLS_CONNECT_FAILED);
1401 freerdp_set_last_error_if_not(context, FREERDP_ERROR_CONNECT_CANCELLED);
1406 return (status >= 1);
1409static BOOL rdg_establish_data_connection(rdpRdg* rdg, rdpTls* tls,
const char* method,
1410 const char* peerAddress, UINT32 timeout,
1413 char buffer[64] = WINPR_C_ARRAY_INIT;
1414 HttpResponse* response =
nullptr;
1416 if (!rdg_tls_connect(rdg, tls, peerAddress, timeout))
1419 WINPR_ASSERT(rpcFallback);
1420 if (rdg->context->settings->GatewayHttpExtAuthBearer && rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1421 rdg->extAuth = HTTP_EXTENDED_AUTH_BEARER;
1422 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1424 if (!rdg_auth_init(rdg, tls, AUTH_PKG))
1427 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1430 response = http_response_recv(tls, TRUE);
1435 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1436 *rpcFallback = TRUE;
1440 (void)http_response_extract_cookies(response, rdg->http);
1442 const UINT16 StatusCode = http_response_get_status_code(response);
1445 case HTTP_STATUS_GONE:
1446 case HTTP_STATUS_FORBIDDEN:
1447 case HTTP_STATUS_NOT_FOUND:
1449 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway does not support HTTP transport.");
1450 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1451 *rpcFallback = TRUE;
1453 http_response_free(response);
1456 case HTTP_STATUS_OK:
1459 case HTTP_STATUS_DENIED:
1460 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1464 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1468 while (!credssp_auth_is_complete(rdg->auth))
1470 BOOL haveToken = FALSE;
1472 if (!rdg_recv_auth_token(rdg->log, rdg->auth, response, &haveToken))
1474 http_response_free(response);
1489 WLog_Print(rdg->log, WLOG_DEBUG,
1490 "No authentication token in the response, ending the exchange");
1494 if (credssp_auth_have_output_token(rdg->auth))
1496 http_response_free(response);
1498 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1501 response = http_response_recv(tls, TRUE);
1504 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1505 *rpcFallback = TRUE;
1508 (void)http_response_extract_cookies(response, rdg->http);
1513 credssp_auth_free(rdg->auth);
1514 rdg->auth =
nullptr;
1518 credssp_auth_free(rdg->auth);
1519 rdg->auth =
nullptr;
1521 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1524 response = http_response_recv(tls, TRUE);
1528 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1529 *rpcFallback = TRUE;
1532 (void)http_response_extract_cookies(response, rdg->http);
1535 const UINT16 statusCode = http_response_get_status_code(response);
1536 const size_t bodyLength = http_response_get_body_length(response);
1537 const TRANSFER_ENCODING encoding = http_response_get_transfer_encoding(response);
1538 const BOOL isWebsocket = http_response_is_websocket(rdg->http, response);
1540 WLog_Print(rdg->log, WLOG_DEBUG,
"%s authorization result: %s", method,
1541 freerdp_http_status_string_format(statusCode, buffer, ARRAYSIZE(buffer)));
1545 case HTTP_STATUS_OK:
1548 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1549 http_response_free(response);
1551 case HTTP_STATUS_DENIED:
1552 freerdp_set_last_error_log(rdg->context, FREERDP_ERROR_CONNECT_ACCESS_DENIED);
1553 http_response_free(response);
1555 case HTTP_STATUS_SWITCH_PROTOCOLS:
1556 http_response_free(response);
1563 if (http_context_is_websocket_upgrade_enabled(rdg->http))
1565 long fd = BIO_get_fd(tls->bio,
nullptr);
1567 closesocket((SOCKET)fd);
1568 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1569 return rdg_establish_data_connection(rdg, tls, method, peerAddress, timeout,
1575 rdg->transferEncoding.isWebsocketTransport = TRUE;
1576 if (!websocket_context_reset(rdg->transferEncoding.context.websocket))
1579 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1583 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1588 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1589 http_response_free(response);
1593 if (strcmp(method,
"RDG_OUT_DATA") == 0)
1595 if (encoding == TransferEncodingChunked)
1597 rdg->transferEncoding.httpTransferEncoding = TransferEncodingChunked;
1598 rdg->transferEncoding.context.chunked.nextOffset = 0;
1599 rdg->transferEncoding.context.chunked.headerFooterPos = 0;
1600 rdg->transferEncoding.context.chunked.state = ChunkStateLenghHeader;
1602 if (!rdg_skip_seed_payload(rdg->context, tls, bodyLength, &rdg->transferEncoding))
1609 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingChunked))
1612 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1616 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1624static BOOL rdg_tunnel_connect(rdpRdg* rdg)
1628 rdg_send_handshake(rdg);
1630 while (rdg->state < RDG_CLIENT_STATE_OPENED)
1633 s = rdg_receive_packet(rdg);
1637 status = rdg_process_packet(rdg, s);
1638 Stream_Free(s, TRUE);
1644 WINPR_ASSERT(rdg->context);
1645 WINPR_ASSERT(rdg->context->rdp);
1646 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1654BOOL rdg_connect(rdpRdg* rdg, DWORD timeout, BOOL* rpcFallback)
1657 SOCKET outConnSocket = 0;
1658 char* peerAddress =
nullptr;
1659 BOOL rpcFallbackLocal = FALSE;
1661 WINPR_ASSERT(rdg !=
nullptr);
1662 freerdp_set_last_error(rdg->context, ERROR_SUCCESS);
1663 status = rdg_establish_data_connection(rdg, rdg->tlsOut,
"RDG_OUT_DATA",
nullptr, timeout,
1668 if (rdg->transferEncoding.isWebsocketTransport)
1670 WLog_Print(rdg->log, WLOG_DEBUG,
"Upgraded to websocket. RDG_IN_DATA not required");
1677 BIO_get_socket(rdg->tlsOut->underlying, &outConnSocket);
1678 peerAddress = freerdp_tcp_get_peer_address(outConnSocket);
1679 status = rdg_establish_data_connection(rdg, rdg->tlsIn,
"RDG_IN_DATA", peerAddress,
1680 timeout, &rpcFallbackLocal);
1686 *rpcFallback = rpcFallbackLocal;
1691 WINPR_ASSERT(rdg->context);
1692 WINPR_ASSERT(rdg->context->rdp);
1693 if (rpcFallbackLocal)
1695 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1696 credssp_auth_free(rdg->auth);
1697 rdg->auth =
nullptr;
1700 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1704 status = rdg_tunnel_connect(rdg);
1709static int rdg_write_websocket_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1715 const size_t payloadSize = (size_t)isize + 10;
1723 websocket_context_packet_new(payloadSize, WebsocketBinaryOpcode, &maskingKey.u32);
1727 Stream_Write_UINT16(
1728 sWS, WINPR_ASSERTING_INT_CAST(
1729 uint16_t, PKT_TYPE_DATA ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1730 Stream_Write_UINT16(
1731 sWS, WINPR_ASSERTING_INT_CAST(
1732 uint16_t, 0 ^ (maskingKey.u8[2] | maskingKey.u8[3] << 8)));
1733 Stream_Write_UINT32(
1734 sWS, WINPR_ASSERTING_INT_CAST(uint32_t, payloadSize ^ maskingKey.u32));
1735 Stream_Write_UINT16(
1736 sWS, WINPR_ASSERTING_INT_CAST(
1737 uint16_t, isize ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1740 maskingKey.u32 = (maskingKey.u32 & 0xffff) << 16 | (maskingKey.u32 >> 16);
1742 WINPR_ASSERT(rdg->tlsOut);
1743 wStream sPacket = WINPR_C_ARRAY_INIT;
1744 Stream_StaticConstInit(&sPacket, buf, (
size_t)isize);
1745 if (!websocket_context_mask_and_send(rdg->tlsOut->bio, sWS, &sPacket, maskingKey.u32))
1751static int rdg_write_chunked_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1757 if (isize > UINT16_MAX)
1760 const size_t size = (size_t)isize;
1764 const size_t packetSize = size + 10;
1765 char chunkSize[11] = WINPR_C_ARRAY_INIT;
1766 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIxz
"\r\n", packetSize);
1767 sChunk = Stream_New(
nullptr, strnlen(chunkSize,
sizeof(chunkSize)) + packetSize + 2);
1772 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
1773 Stream_Write_UINT16(sChunk, PKT_TYPE_DATA);
1774 Stream_Write_UINT16(sChunk, 0);
1775 Stream_Write_UINT32(sChunk, (UINT32)packetSize);
1776 Stream_Write_UINT16(sChunk, (UINT16)size);
1777 Stream_Write(sChunk, buf, size);
1778 Stream_Write(sChunk,
"\r\n", 2);
1779 Stream_SealLength(sChunk);
1780 len = Stream_Length(sChunk);
1782 status = freerdp_tls_write_all(rdg->tlsIn, Stream_Buffer(sChunk), len);
1783 Stream_Free(sChunk, TRUE);
1791static int rdg_write_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1794 if (rdg->transferEncoding.isWebsocketTransport)
1795 return rdg_write_websocket_data_packet(rdg, buf, isize);
1797 return rdg_write_chunked_data_packet(rdg, buf, isize);
1800static BOOL rdg_process_close_packet(rdpRdg* rdg,
wStream* s)
1804 UINT32 errorCode = 0;
1805 UINT32 packetSize = 12;
1808 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1810 Stream_Read_UINT32(s, errorCode);
1813 freerdp_set_last_error_log(rdg->context, errorCode);
1815 sClose = Stream_New(
nullptr, packetSize);
1819 Stream_Write_UINT16(sClose, PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
1820 Stream_Write_UINT16(sClose, 0);
1821 Stream_Write_UINT32(sClose, packetSize);
1822 Stream_Write_UINT32(sClose, 0);
1823 Stream_SealLength(sClose);
1824 status = rdg_write_packet(rdg, sClose);
1825 Stream_Free(sClose, TRUE);
1827 return ((status >= 0));
1830static BOOL rdg_process_keep_alive_packet(rdpRdg* rdg)
1833 wStream* sKeepAlive =
nullptr;
1834 size_t packetSize = 8;
1836 sKeepAlive = Stream_New(
nullptr, packetSize);
1841 Stream_Write_UINT16(sKeepAlive, PKT_TYPE_KEEPALIVE);
1842 Stream_Write_UINT16(sKeepAlive, 0);
1843 Stream_Write_UINT32(sKeepAlive, (UINT32)packetSize);
1844 Stream_SealLength(sKeepAlive);
1845 status = rdg_write_packet(rdg, sKeepAlive);
1846 Stream_Free(sKeepAlive, TRUE);
1848 return ((status >= 0));
1851static BOOL rdg_process_service_message(rdpRdg* rdg,
wStream* s)
1853 const WCHAR* msg =
nullptr;
1854 UINT16 msgLenBytes = 0;
1855 rdpContext* context = rdg->context;
1856 WINPR_ASSERT(context);
1857 WINPR_ASSERT(context->instance);
1860 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
1862 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read string");
1866 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
1867 GATEWAY_MESSAGE_SERVICE, TRUE, FALSE, msgLenBytes, msg);
1870static BOOL rdg_process_unknown_packet(rdpRdg* rdg,
int type)
1874 WLog_Print(rdg->log, WLOG_WARN,
"Unknown Control Packet received: %" PRIX32,
1875 WINPR_CXX_COMPAT_CAST(UINT32, type));
1879static BOOL rdg_process_control_packet(rdpRdg* rdg,
int type,
size_t packetLength)
1882 size_t readCount = 0;
1884 size_t payloadSize = packetLength -
sizeof(RdgPacketHeader);
1886 if (packetLength <
sizeof(RdgPacketHeader))
1890 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1894 s = Stream_New(
nullptr, payloadSize);
1899 while (readCount < payloadSize)
1901 if (rdg_shall_abort(rdg))
1903 Stream_Free(s, TRUE);
1906 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context, Stream_Pointer(s),
1907 payloadSize - readCount, &rdg->transferEncoding);
1911 if (!BIO_should_retry(rdg->tlsOut->bio))
1913 Stream_Free(s, TRUE);
1920 Stream_Seek(s, (
size_t)status);
1921 readCount += (size_t)status;
1923 if (readCount > INT_MAX)
1925 Stream_Free(s, TRUE);
1930 Stream_ResetPosition(s);
1935 case PKT_TYPE_CLOSE_CHANNEL:
1938 WLog_Print(rdg->log, WLOG_ERROR,
1939 "PKT_TYPE_CLOSE_CHANNEL requires payload but none was sent");
1942 EnterCriticalSection(&rdg->writeSection);
1943 status = rdg_process_close_packet(rdg, s);
1944 LeaveCriticalSection(&rdg->writeSection);
1947 case PKT_TYPE_KEEPALIVE:
1948 EnterCriticalSection(&rdg->writeSection);
1949 status = rdg_process_keep_alive_packet(rdg);
1950 LeaveCriticalSection(&rdg->writeSection);
1953 case PKT_TYPE_SERVICE_MESSAGE:
1956 WLog_Print(rdg->log, WLOG_ERROR,
1957 "PKT_TYPE_SERVICE_MESSAGE requires payload but none was sent");
1960 status = rdg_process_service_message(rdg, s);
1963 case PKT_TYPE_REAUTH_MESSAGE:
1965 status = rdg_process_unknown_packet(rdg, type);
1969 Stream_Free(s, TRUE);
1973static int rdg_read_data_packet(rdpRdg* rdg, BYTE* buffer,
size_t size)
1975 RdgPacketHeader header = WINPR_C_ARRAY_INIT;
1976 size_t readCount = 0;
1977 size_t readSize = 0;
1980 if (!rdg->packetRemainingCount)
1983 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1985 while (readCount <
sizeof(RdgPacketHeader))
1987 if (rdg_shall_abort(rdg))
1990 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context, (BYTE*)(&header) + readCount,
1991 sizeof(RdgPacketHeader) - readCount, &rdg->transferEncoding);
1995 if (!BIO_should_retry(rdg->tlsOut->bio))
2001 BIO_wait_read(rdg->tlsOut->bio, 50);
2005 readCount += (size_t)status;
2007 if (readCount > INT_MAX)
2011 if (header.type != PKT_TYPE_DATA)
2013 status = rdg_process_control_packet(rdg, header.type, header.packetLength);
2023 while (readCount < 2)
2025 if (rdg_shall_abort(rdg))
2027 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context,
2028 (BYTE*)(&rdg->packetRemainingCount) + readCount, 2 - readCount,
2029 &rdg->transferEncoding);
2033 if (!BIO_should_retry(rdg->tlsOut->bio))
2036 BIO_wait_read(rdg->tlsOut->bio, 50);
2040 readCount += (size_t)status;
2044 readSize = (rdg->packetRemainingCount < size) ? rdg->packetRemainingCount : size;
2046 rdg_socket_read(rdg->tlsOut->bio, rdg->context, buffer, readSize, &rdg->transferEncoding);
2050 if (!BIO_should_retry(rdg->tlsOut->bio))
2058 rdg->packetRemainingCount -= status;
2062static int rdg_bio_write(BIO* bio,
const char* buf,
int num)
2065 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2069 BIO_clear_flags(bio, BIO_FLAGS_WRITE);
2070 EnterCriticalSection(&rdg->writeSection);
2071 status = rdg_write_data_packet(rdg, (
const BYTE*)buf, num);
2072 LeaveCriticalSection(&rdg->writeSection);
2076 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2079 else if (status < num)
2081 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2082 WSASetLastError(WSAEWOULDBLOCK);
2086 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2092static int rdg_bio_read(BIO* bio,
char* buf,
int size)
2095 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2098 status = rdg_read_data_packet(rdg, (BYTE*)buf, (
size_t)size);
2102 BIO_clear_retry_flags(bio);
2105 else if (status == 0)
2107 BIO_set_retry_read(bio);
2108 WSASetLastError(WSAEWOULDBLOCK);
2113 BIO_set_flags(bio, BIO_FLAGS_READ);
2119static int rdg_bio_puts(BIO* bio,
const char* str)
2127static int rdg_bio_gets(BIO* bio,
char* str,
int size)
2135static long rdg_bio_ctrl(BIO* in_bio,
int cmd,
long arg1,
void* arg2)
2138 rdpRdg* rdg = (rdpRdg*)BIO_get_data(in_bio);
2139 rdpTls* tlsOut = rdg->tlsOut;
2140 rdpTls* tlsIn = rdg->tlsIn;
2142 if (cmd == BIO_CTRL_FLUSH)
2144 (void)BIO_flush(tlsOut->bio);
2145 if (!rdg->transferEncoding.isWebsocketTransport)
2146 (void)BIO_flush(tlsIn->bio);
2149 else if (cmd == BIO_C_SET_NONBLOCK)
2153 else if (cmd == BIO_C_READ_BLOCKED)
2155 BIO* cbio = tlsOut->bio;
2156 status = BIO_read_blocked(cbio);
2158 else if (cmd == BIO_C_WRITE_BLOCKED)
2160 BIO* cbio = tlsIn->bio;
2162 if (rdg->transferEncoding.isWebsocketTransport)
2165 status = BIO_write_blocked(cbio);
2167 else if (cmd == BIO_C_WAIT_READ)
2169 int timeout = (int)arg1;
2170 BIO* cbio = tlsOut->bio;
2172 if (BIO_read_blocked(cbio))
2173 return BIO_wait_read(cbio, timeout);
2174 else if (BIO_write_blocked(cbio))
2175 return BIO_wait_write(cbio, timeout);
2179 else if (cmd == BIO_C_WAIT_WRITE)
2181 int timeout = (int)arg1;
2182 BIO* cbio = tlsIn->bio;
2184 if (rdg->transferEncoding.isWebsocketTransport)
2187 if (BIO_write_blocked(cbio))
2188 status = BIO_wait_write(cbio, timeout);
2189 else if (BIO_read_blocked(cbio))
2190 status = BIO_wait_read(cbio, timeout);
2194 else if (cmd == BIO_C_GET_EVENT || cmd == BIO_C_GET_FD)
2204 status = BIO_ctrl(tlsOut->bio, cmd, arg1, arg2);
2206#if OPENSSL_VERSION_NUMBER >= 0x30000000L
2207 else if (cmd == BIO_CTRL_GET_KTLS_SEND)
2215 else if (cmd == BIO_CTRL_GET_KTLS_RECV)
2226static int rdg_bio_new(BIO* bio)
2228 BIO_set_init(bio, 1);
2229 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2233static int rdg_bio_free(BIO* bio)
2239static BIO_METHOD* BIO_s_rdg(
void)
2241 static BIO_METHOD* bio_methods =
nullptr;
2243 if (bio_methods ==
nullptr)
2245 if (!(bio_methods = BIO_meth_new(BIO_TYPE_TSG,
"RDGateway")))
2248 BIO_meth_set_write(bio_methods, rdg_bio_write);
2249 BIO_meth_set_read(bio_methods, rdg_bio_read);
2250 BIO_meth_set_puts(bio_methods, rdg_bio_puts);
2251 BIO_meth_set_gets(bio_methods, rdg_bio_gets);
2252 BIO_meth_set_ctrl(bio_methods, rdg_bio_ctrl);
2253 BIO_meth_set_create(bio_methods, rdg_bio_new);
2254 BIO_meth_set_destroy(bio_methods, rdg_bio_free);
2260rdpRdg* rdg_new(rdpContext* context)
2265 rdpRdg* rdg = (rdpRdg*)calloc(1,
sizeof(rdpRdg));
2269 rdg->log = WLog_Get(TAG);
2270 rdg->state = RDG_CLIENT_STATE_INITIAL;
2271 rdg->context = context;
2272 rdpSettings* settings = rdg->context->settings;
2273 rdg->extAuth = (settings->GatewayHttpExtAuthSspiNtlm ? HTTP_EXTENDED_AUTH_SSPI_NTLM
2274 : HTTP_EXTENDED_AUTH_NONE);
2276 if (settings->GatewayAccessToken)
2277 rdg->extAuth = HTTP_EXTENDED_AUTH_PAA;
2279 rdg->tlsOut = freerdp_tls_new(rdg->context);
2282 goto rdg_alloc_error;
2284 rdg->tlsIn = freerdp_tls_new(rdg->context);
2287 goto rdg_alloc_error;
2289 rdg->http = http_context_new();
2292 goto rdg_alloc_error;
2294 GUID guid = WINPR_C_ARRAY_INIT;
2295 if (UuidFromStringA(settings->CorrelationId, &guid) != RPC_S_OK)
2296 goto rdg_alloc_error;
2298 if (!http_context_set_uri(rdg->http,
"/remoteDesktopGateway/") ||
2299 !http_context_set_accept(rdg->http,
"*/*") ||
2300 !http_context_set_cache_control(rdg->http,
"no-cache") ||
2301 !http_context_set_pragma(rdg->http,
"no-cache") ||
2302 !http_context_set_connection(rdg->http,
"Keep-Alive") ||
2303 !http_context_set_user_agent(rdg->http,
"MS-RDGateway/1.0") ||
2304 !http_context_set_host(rdg->http, rdg->context->settings->GatewayHostname) ||
2305 !http_context_set_rdg_connection_id(rdg->http) ||
2306 !http_context_set_rdg_correlation_id(rdg->http, &guid) ||
2307 !http_context_enable_websocket_upgrade(
2311 goto rdg_alloc_error;
2314 if (rdg->extAuth != HTTP_EXTENDED_AUTH_NONE)
2316 switch (rdg->extAuth)
2318 case HTTP_EXTENDED_AUTH_PAA:
2319 if (!http_context_set_rdg_auth_scheme(rdg->http,
"PAA"))
2320 goto rdg_alloc_error;
2324 case HTTP_EXTENDED_AUTH_SSPI_NTLM:
2325 if (!http_context_set_rdg_auth_scheme(rdg->http,
"SSPI_NTLM"))
2326 goto rdg_alloc_error;
2331 WLog_Print(rdg->log, WLOG_DEBUG,
2332 "RDG extended authentication method %d not supported", rdg->extAuth);
2336 rdg->frontBio = BIO_new(BIO_s_rdg());
2339 goto rdg_alloc_error;
2341 BIO_set_data(rdg->frontBio, rdg);
2342 InitializeCriticalSection(&rdg->writeSection);
2344 rdg->transferEncoding.httpTransferEncoding = TransferEncodingIdentity;
2345 rdg->transferEncoding.isWebsocketTransport = FALSE;
2347 rdg->transferEncoding.context.websocket = websocket_context_new();
2348 if (!rdg->transferEncoding.context.websocket)
2349 goto rdg_alloc_error;
2353 WINPR_PRAGMA_DIAG_PUSH
2354 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2356 WINPR_PRAGMA_DIAG_POP
2360void rdg_free(rdpRdg* rdg)
2365 freerdp_tls_free(rdg->tlsOut);
2366 freerdp_tls_free(rdg->tlsIn);
2367 http_context_free(rdg->http);
2368 credssp_auth_free(rdg->auth);
2371 BIO_free_all(rdg->frontBio);
2373 DeleteCriticalSection(&rdg->writeSection);
2375 smartcardCertInfo_Free(rdg->smartcard);
2377 websocket_context_free(rdg->transferEncoding.context.websocket);
2382BIO* rdg_get_front_bio_and_take_ownership(rdpRdg* rdg)
2387 rdg->attached = TRUE;
2388 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.