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_OPTIONAL 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
67#define PKT_TYPE_HANDSHAKE_REQUEST 0x1
68#define PKT_TYPE_HANDSHAKE_RESPONSE 0x2
69#define PKT_TYPE_EXTENDED_AUTH_MSG 0x3
70#define PKT_TYPE_TUNNEL_CREATE 0x4
71#define PKT_TYPE_TUNNEL_RESPONSE 0x5
72#define PKT_TYPE_TUNNEL_AUTH 0x6
73#define PKT_TYPE_TUNNEL_AUTH_RESPONSE 0x7
74#define PKT_TYPE_CHANNEL_CREATE 0x8
75#define PKT_TYPE_CHANNEL_RESPONSE 0x9
76#define PKT_TYPE_DATA 0xA
77#define PKT_TYPE_SERVICE_MESSAGE 0xB
78#define PKT_TYPE_REAUTH_MESSAGE 0xC
79#define PKT_TYPE_KEEPALIVE 0xD
80#define PKT_TYPE_CLOSE_CHANNEL 0x10
81#define PKT_TYPE_CLOSE_CHANNEL_RESPONSE 0x11
87#define HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS 0x1
88#define HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT 0x2
89#define HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE 0x4
92#define HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE 0x1
96#define HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID 0x1
97#define HTTP_TUNNEL_RESPONSE_FIELD_CAPS 0x2
98#define HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ 0x4
99#define HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG 0x10
102#define HTTP_CAPABILITY_TYPE_QUAR_SOH 0x1
103#define HTTP_CAPABILITY_IDLE_TIMEOUT 0x2
104#define HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN 0x4
105#define HTTP_CAPABILITY_MESSAGING_SERVICE_MSG 0x8
106#define HTTP_CAPABILITY_REAUTH 0x10
107#define HTTP_CAPABILITY_UDP_TRANSPORT 0x20
111 TRANSFER_ENCODING httpTransferEncoding;
112 BOOL isWebsocketTransport;
116 websocket_context* websocket;
118} rdg_http_encoding_context;
127 rdpCredsspAuth* auth;
134 UINT16 packetRemainingCount;
139 rdg_http_encoding_context transferEncoding;
147 RDG_CLIENT_STATE_INITIAL,
148 RDG_CLIENT_STATE_HANDSHAKE,
149 RDG_CLIENT_STATE_TUNNEL_CREATE,
150 RDG_CLIENT_STATE_TUNNEL_AUTHORIZE,
151 RDG_CLIENT_STATE_CHANNEL_CREATE,
152 RDG_CLIENT_STATE_OPENED,
157typedef struct rdg_packet_header
172static const t_flag_mapping tunnel_response_fields_present[] = {
173 { HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID,
"HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID" },
174 { HTTP_TUNNEL_RESPONSE_FIELD_CAPS,
"HTTP_TUNNEL_RESPONSE_FIELD_CAPS" },
175 { HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ,
"HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ" },
176 { HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG,
"HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG" }
179static const t_flag_mapping channel_response_fields_present[] = {
180 { HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID,
"HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID" },
181 { HTTP_CHANNEL_RESPONSE_OPTIONAL,
"HTTP_CHANNEL_RESPONSE_OPTIONAL" },
182 { HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT,
"HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT" }
185static const t_flag_mapping tunnel_authorization_response_fields_present[] = {
186 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS,
"HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS" },
187 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT,
188 "HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT" },
189 { HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE,
190 "HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE" }
193static const t_flag_mapping extended_auth[] = {
194 { HTTP_EXTENDED_AUTH_NONE,
"HTTP_EXTENDED_AUTH_NONE" },
195 { HTTP_EXTENDED_AUTH_SC,
"HTTP_EXTENDED_AUTH_SC" },
196 { HTTP_EXTENDED_AUTH_PAA,
"HTTP_EXTENDED_AUTH_PAA" },
197 { HTTP_EXTENDED_AUTH_SSPI_NTLM,
"HTTP_EXTENDED_AUTH_SSPI_NTLM" }
200static const t_flag_mapping capabilities_enum[] = {
201 { HTTP_CAPABILITY_TYPE_QUAR_SOH,
"HTTP_CAPABILITY_TYPE_QUAR_SOH" },
202 { HTTP_CAPABILITY_IDLE_TIMEOUT,
"HTTP_CAPABILITY_IDLE_TIMEOUT" },
203 { HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN,
"HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN" },
204 { HTTP_CAPABILITY_MESSAGING_SERVICE_MSG,
"HTTP_CAPABILITY_MESSAGING_SERVICE_MSG" },
205 { HTTP_CAPABILITY_REAUTH,
"HTTP_CAPABILITY_REAUTH" },
206 { HTTP_CAPABILITY_UDP_TRANSPORT,
"HTTP_CAPABILITY_UDP_TRANSPORT" }
209static const char* flags_to_string(UINT32 flags,
const t_flag_mapping* map,
size_t elements)
211 static char buffer[1024] = { 0 };
212 char fields[12] = { 0 };
214 for (
size_t x = 0; x < elements; x++)
216 const t_flag_mapping* cur = &map[x];
218 if ((cur->code & flags) != 0)
219 winpr_str_append(cur->name, buffer,
sizeof(buffer),
"|");
222 (void)sprintf_s(fields, ARRAYSIZE(fields),
" [%04" PRIx32
"]", flags);
223 winpr_str_append(fields, buffer,
sizeof(buffer), NULL);
227static const char* channel_response_fields_present_to_string(UINT16 fieldsPresent)
229 return flags_to_string(fieldsPresent, channel_response_fields_present,
230 ARRAYSIZE(channel_response_fields_present));
233static const char* tunnel_response_fields_present_to_string(UINT16 fieldsPresent)
235 return flags_to_string(fieldsPresent, tunnel_response_fields_present,
236 ARRAYSIZE(tunnel_response_fields_present));
239static const char* tunnel_authorization_response_fields_present_to_string(UINT16 fieldsPresent)
241 return flags_to_string(fieldsPresent, tunnel_authorization_response_fields_present,
242 ARRAYSIZE(tunnel_authorization_response_fields_present));
245static const char* extended_auth_to_string(UINT16 auth)
247 if (auth == HTTP_EXTENDED_AUTH_NONE)
248 return "HTTP_EXTENDED_AUTH_NONE [0x0000]";
250 return flags_to_string(auth, extended_auth, ARRAYSIZE(extended_auth));
253static const char* capabilities_enum_to_string(UINT32 capabilities)
255 return flags_to_string(capabilities, capabilities_enum, ARRAYSIZE(capabilities_enum));
258static BOOL rdg_read_http_unicode_string(wLog* log,
wStream* s,
const WCHAR**
string,
259 UINT16* lengthInBytes)
261 UINT16 strLenBytes = 0;
262 size_t rem = Stream_GetRemainingLength(s);
265 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 4))
267 WLog_Print(log, WLOG_ERROR,
"Could not read stream length, only have %" PRIuz
" bytes",
271 Stream_Read_UINT16(s, strLenBytes);
274 const WCHAR* str = Stream_ConstPointer(s);
277 if (!Stream_SafeSeek(s, strLenBytes))
279 WLog_Print(log, WLOG_ERROR,
280 "Could not read stream data, only have %" PRIuz
" bytes, expected %" PRIu16,
281 rem - 4, strLenBytes);
289 *lengthInBytes = strLenBytes;
294static BOOL rdg_write_chunked(BIO* bio,
wStream* sPacket)
300 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIXz
"\r\n", Stream_Length(sPacket));
301 sChunk = Stream_New(NULL, strnlen(chunkSize,
sizeof(chunkSize)) + Stream_Length(sPacket) + 2);
306 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
307 Stream_Write(sChunk, Stream_Buffer(sPacket), Stream_Length(sPacket));
308 Stream_Write(sChunk,
"\r\n", 2);
309 Stream_SealLength(sChunk);
310 len = Stream_Length(sChunk);
314 Stream_Free(sChunk, TRUE);
319 status = BIO_write(bio, Stream_Buffer(sChunk), (
int)len);
320 Stream_Free(sChunk, TRUE);
322 if (status != (SSIZE_T)len)
328static BOOL rdg_write_packet(rdpRdg* rdg,
wStream* sPacket)
330 if (rdg->transferEncoding.isWebsocketTransport)
331 return websocket_context_write_wstream(rdg->transferEncoding.context.websocket,
332 rdg->tlsOut->bio, sPacket, WebsocketBinaryOpcode);
334 return rdg_write_chunked(rdg->tlsIn->bio, sPacket);
337static int rdg_socket_read(BIO* bio, BYTE* pBuffer,
size_t size,
338 rdg_http_encoding_context* encodingContext)
340 WINPR_ASSERT(encodingContext != NULL);
341 if (size > INT32_MAX)
344 if (encodingContext->isWebsocketTransport)
345 return websocket_context_read(encodingContext->context.websocket, bio, pBuffer, size);
347 switch (encodingContext->httpTransferEncoding)
349 case TransferEncodingIdentity:
351 return BIO_read(bio, pBuffer, (
int)size);
352 case TransferEncodingChunked:
353 return http_chuncked_read(bio, pBuffer, size, &encodingContext->context.chunked);
359static BOOL rdg_shall_abort(rdpRdg* rdg)
362 return freerdp_shall_disconnect_context(rdg->context);
365static BOOL rdg_read_all(rdpContext* context, rdpTls* tls, BYTE* buffer,
size_t size,
366 rdg_http_encoding_context* transferEncoding)
368 size_t readCount = 0;
369 BYTE* pBuffer = buffer;
371 while (readCount < size)
373 if (freerdp_shall_disconnect_context(context))
376 int status = rdg_socket_read(tls->bio, pBuffer, size - readCount, transferEncoding);
379 if (!BIO_should_retry(tls->bio))
386 readCount += WINPR_ASSERTING_INT_CAST(uint32_t, status);
387 pBuffer += WINPR_ASSERTING_INT_CAST(uint32_t, status);
393static wStream* rdg_receive_packet(rdpRdg* rdg)
395 const size_t header =
sizeof(RdgPacketHeader);
396 size_t packetLength = 0;
397 wStream* s = Stream_New(NULL, 1024);
402 if (!rdg_read_all(rdg->context, rdg->tlsOut, Stream_Buffer(s), header, &rdg->transferEncoding))
404 Stream_Free(s, TRUE);
409 Stream_Read_UINT32(s, packetLength);
411 if ((packetLength > INT_MAX) || !Stream_EnsureCapacity(s, packetLength) ||
412 (packetLength < header))
414 Stream_Free(s, TRUE);
418 if (!rdg_read_all(rdg->context, rdg->tlsOut, Stream_Buffer(s) + header, packetLength - header,
419 &rdg->transferEncoding))
421 Stream_Free(s, TRUE);
425 Stream_SetLength(s, packetLength);
429static BOOL rdg_send_handshake(rdpRdg* rdg)
432 wStream* s = Stream_New(NULL, 14);
437 Stream_Write_UINT16(s, PKT_TYPE_HANDSHAKE_REQUEST);
438 Stream_Write_UINT16(s, 0);
439 Stream_Write_UINT32(s, 14);
440 Stream_Write_UINT8(s, 1);
441 Stream_Write_UINT8(s, 0);
442 Stream_Write_UINT16(s, 0);
443 Stream_Write_UINT16(s, rdg->extAuth);
444 Stream_SealLength(s);
445 status = rdg_write_packet(rdg, s);
446 Stream_Free(s, TRUE);
450 rdg->state = RDG_CLIENT_STATE_HANDSHAKE;
456static BOOL rdg_send_extauth_sspi(rdpRdg* rdg)
460 UINT32 packetSize = 8 + 4 + 2;
464 const SecBuffer* authToken = credssp_auth_get_output_buffer(rdg->auth);
467 packetSize += authToken->cbBuffer;
469 s = Stream_New(NULL, packetSize);
474 Stream_Write_UINT16(s, PKT_TYPE_EXTENDED_AUTH_MSG);
475 Stream_Write_UINT16(s, 0);
476 Stream_Write_UINT32(s, packetSize);
477 Stream_Write_UINT32(s, ERROR_SUCCESS);
478 Stream_Write_UINT16(s, (UINT16)authToken->cbBuffer);
479 Stream_Write(s, authToken->pvBuffer, authToken->cbBuffer);
481 Stream_SealLength(s);
482 status = rdg_write_packet(rdg, s);
483 Stream_Free(s, TRUE);
488static BOOL rdg_send_tunnel_request(rdpRdg* rdg)
492 UINT32 packetSize = 16;
493 UINT16 fieldsPresent = 0;
494 WCHAR* PAACookie = NULL;
495 size_t PAACookieLen = 0;
496 const UINT32 capabilities = HTTP_CAPABILITY_TYPE_QUAR_SOH |
497 HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN |
498 HTTP_CAPABILITY_MESSAGING_SERVICE_MSG;
500 if (rdg->extAuth == HTTP_EXTENDED_AUTH_PAA)
503 ConvertUtf8ToWCharAlloc(rdg->context->settings->GatewayAccessToken, &PAACookieLen);
505 if (!PAACookie || (PAACookieLen > UINT16_MAX /
sizeof(WCHAR)))
512 packetSize += 2 + (UINT32)(PAACookieLen) *
sizeof(WCHAR);
513 fieldsPresent = HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE;
516 s = Stream_New(NULL, packetSize);
524 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_CREATE);
525 Stream_Write_UINT16(s, 0);
526 Stream_Write_UINT32(s, packetSize);
527 Stream_Write_UINT32(s, capabilities);
528 Stream_Write_UINT16(s, fieldsPresent);
529 Stream_Write_UINT16(s, 0);
533 Stream_Write_UINT16(s, (UINT16)PAACookieLen *
sizeof(WCHAR));
534 Stream_Write_UTF16_String(s, PAACookie, PAACookieLen);
537 Stream_SealLength(s);
538 status = rdg_write_packet(rdg, s);
539 Stream_Free(s, TRUE);
544 rdg->state = RDG_CLIENT_STATE_TUNNEL_CREATE;
550static BOOL rdg_send_tunnel_authorization(rdpRdg* rdg)
555 size_t clientNameLen = 0;
557 rdg->context->settings, FreeRDP_ClientHostname, &clientNameLen);
561 const size_t packetSize = 12ull + clientNameLen *
sizeof(WCHAR);
562 if (!clientName || (clientNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
568 s = Stream_New(NULL, packetSize);
576 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_AUTH);
577 Stream_Write_UINT16(s, 0);
578 Stream_Write_UINT32(s, (UINT32)packetSize);
579 Stream_Write_UINT16(s, 0);
580 Stream_Write_UINT16(s, (UINT16)clientNameLen *
sizeof(WCHAR));
581 Stream_Write_UTF16_String(s, clientName, clientNameLen);
582 Stream_SealLength(s);
583 status = rdg_write_packet(rdg, s);
584 Stream_Free(s, TRUE);
589 rdg->state = RDG_CLIENT_STATE_TUNNEL_AUTHORIZE;
595static BOOL rdg_send_channel_create(rdpRdg* rdg)
599 WCHAR* serverName = NULL;
600 size_t serverNameLen = 0;
604 FreeRDP_ServerHostname, &serverNameLen);
607 const size_t packetSize = 16ull + serverNameLen *
sizeof(WCHAR);
608 if (!serverName || (serverNameLen >= UINT16_MAX /
sizeof(WCHAR)) || (packetSize > UINT32_MAX))
611 s = Stream_New(NULL, packetSize);
616 Stream_Write_UINT16(s, PKT_TYPE_CHANNEL_CREATE);
617 Stream_Write_UINT16(s, 0);
618 Stream_Write_UINT32(s, (UINT32)packetSize);
619 Stream_Write_UINT8(s, 1);
620 Stream_Write_UINT8(s, 0);
621 Stream_Write_UINT16(s,
622 (UINT16)rdg->context->settings->ServerPort);
623 Stream_Write_UINT16(s, 3);
624 Stream_Write_UINT16(s, (UINT16)serverNameLen *
sizeof(WCHAR));
625 Stream_Write_UTF16_String(s, serverName, serverNameLen);
626 Stream_SealLength(s);
627 status = rdg_write_packet(rdg, s);
630 Stream_Free(s, TRUE);
633 rdg->state = RDG_CLIENT_STATE_CHANNEL_CREATE;
638static BOOL rdg_set_auth_header(rdpCredsspAuth* auth, HttpRequest* request)
640 const SecBuffer* authToken = credssp_auth_get_output_buffer(auth);
641 char* base64AuthToken = NULL;
645 if (authToken->cbBuffer > INT_MAX)
648 base64AuthToken = crypto_base64_encode(authToken->pvBuffer, authToken->cbBuffer);
653 BOOL rc = http_request_set_auth_scheme(request, credssp_auth_pkg_name(auth)) &&
654 http_request_set_auth_param(request, base64AuthToken);
655 free(base64AuthToken);
664static wStream* rdg_build_http_request(rdpRdg* rdg,
const char* method,
665 TRANSFER_ENCODING transferEncoding)
668 HttpRequest* request = NULL;
669 const char* uri = NULL;
674 uri = http_context_get_uri(rdg->http);
675 request = http_request_new();
680 if (!http_request_set_method(request, method) || !http_request_set_uri(request, uri))
685 if (!rdg_set_auth_header(rdg->auth, request))
689 else if (rdg->extAuth == HTTP_EXTENDED_AUTH_BEARER)
691 http_request_set_auth_scheme(request,
"Bearer");
692 http_request_set_auth_param(request, rdg->context->settings->GatewayHttpExtAuthBearer);
695 http_request_set_transfer_encoding(request, transferEncoding);
697 s = http_request_write(rdg->http, request);
699 http_request_free(request);
702 Stream_SealLength(s);
707static BOOL rdg_recv_auth_token(wLog* log, rdpCredsspAuth* auth, HttpResponse* response)
710 size_t authTokenLength = 0;
711 BYTE* authTokenData = NULL;
715 if (!auth || !response)
718 const UINT16 StatusCode = http_response_get_status_code(response);
721 case HTTP_STATUS_DENIED:
723 case HTTP_STATUS_SWITCH_PROTOCOLS:
726 http_response_log_error_status(log, WLOG_WARN, response);
730 const char* token64 = http_response_get_auth_token(response, credssp_auth_pkg_name(auth));
734 len = strlen(token64);
736 crypto_base64_decode(token64, len, &authTokenData, &authTokenLength);
738 if (authTokenLength && authTokenData && (authTokenLength <= UINT32_MAX))
740 authToken.pvBuffer = authTokenData;
741 authToken.cbBuffer = (UINT32)authTokenLength;
742 credssp_auth_take_input_buffer(auth, &authToken);
747 rc = credssp_auth_authenticate(auth);
754static BOOL rdg_skip_seed_payload(rdpContext* context, rdpTls* tls,
size_t lastResponseLength,
755 rdg_http_encoding_context* transferEncoding)
757 BYTE seed_payload[10] = { 0 };
758 const size_t size =
sizeof(seed_payload);
763 if (lastResponseLength < size)
765 if (!rdg_read_all(context, tls, seed_payload, size - lastResponseLength, transferEncoding))
774static BOOL rdg_process_handshake_response(rdpRdg* rdg,
wStream* s)
776 UINT32 errorCode = 0;
777 UINT16 serverVersion = 0;
778 UINT16 extendedAuth = 0;
781 const char* error = NULL;
782 WLog_Print(rdg->log, WLOG_DEBUG,
"Handshake response received");
784 if (rdg->state != RDG_CLIENT_STATE_HANDSHAKE)
789 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
792 Stream_Read_UINT32(s, errorCode);
793 Stream_Read_UINT8(s, verMajor);
794 Stream_Read_UINT8(s, verMinor);
795 Stream_Read_UINT16(s, serverVersion);
796 Stream_Read_UINT16(s, extendedAuth);
797 error = rpc_error_to_string(errorCode);
798 WLog_Print(rdg->log, WLOG_DEBUG,
799 "errorCode=%s, verMajor=%" PRId8
", verMinor=%" PRId8
", serverVersion=%" PRId16
801 error, verMajor, verMinor, serverVersion, extended_auth_to_string(extendedAuth));
803 if (FAILED((HRESULT)errorCode))
805 WLog_Print(rdg->log, WLOG_ERROR,
"Handshake error %s", error);
806 freerdp_set_last_error_log(rdg->context, errorCode);
810 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
811 return rdg_send_extauth_sspi(rdg);
813 return rdg_send_tunnel_request(rdg);
816static BOOL rdg_process_tunnel_response_optional(rdpRdg* rdg,
wStream* s, UINT16 fieldsPresent)
818 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID)
821 if (!Stream_SafeSeek(s, 4))
823 WLog_Print(rdg->log, WLOG_ERROR,
"Short tunnelId, got %" PRIuz
", expected 4",
824 Stream_GetRemainingLength(s));
829 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CAPS)
832 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
835 Stream_Read_UINT32(s, caps);
836 WLog_Print(rdg->log, WLOG_DEBUG,
"capabilities=%s", capabilities_enum_to_string(caps));
839 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ)
842 if (!Stream_SafeSeek(s, 20))
844 WLog_Print(rdg->log, WLOG_ERROR,
"Short nonce, got %" PRIuz
", expected 20",
845 Stream_GetRemainingLength(s));
850 if (!rdg_read_http_unicode_string(rdg->log, s, NULL, NULL))
852 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read server certificate");
857 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG)
859 const WCHAR* msg = NULL;
860 UINT16 msgLenBytes = 0;
861 rdpContext* context = rdg->context;
863 WINPR_ASSERT(context);
864 WINPR_ASSERT(context->instance);
867 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
869 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read consent message");
873 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
874 GATEWAY_MESSAGE_CONSENT, TRUE, TRUE, msgLenBytes, msg);
880static BOOL rdg_process_tunnel_response(rdpRdg* rdg,
wStream* s)
882 UINT16 serverVersion = 0;
883 UINT16 fieldsPresent = 0;
884 UINT32 errorCode = 0;
885 const char* error = NULL;
886 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel response received");
888 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_CREATE)
893 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
896 Stream_Read_UINT16(s, serverVersion);
897 Stream_Read_UINT32(s, errorCode);
898 Stream_Read_UINT16(s, fieldsPresent);
899 Stream_Seek_UINT16(s);
900 error = rpc_error_to_string(errorCode);
901 WLog_Print(rdg->log, WLOG_DEBUG,
"serverVersion=%" PRId16
", errorCode=%s, fieldsPresent=%s",
902 serverVersion, error, tunnel_response_fields_present_to_string(fieldsPresent));
904 if (FAILED((HRESULT)errorCode))
906 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel creation error %s", error);
907 freerdp_set_last_error_log(rdg->context, errorCode);
911 if (!rdg_process_tunnel_response_optional(rdg, s, fieldsPresent))
914 return rdg_send_tunnel_authorization(rdg);
917static BOOL rdg_process_tunnel_authorization_response(rdpRdg* rdg,
wStream* s)
919 UINT32 errorCode = 0;
920 UINT16 fieldsPresent = 0;
921 const char* error = NULL;
922 WLog_Print(rdg->log, WLOG_DEBUG,
"Tunnel authorization received");
924 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_AUTHORIZE)
929 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
932 Stream_Read_UINT32(s, errorCode);
933 Stream_Read_UINT16(s, fieldsPresent);
934 Stream_Seek_UINT16(s);
935 error = rpc_error_to_string(errorCode);
936 WLog_Print(rdg->log, WLOG_DEBUG,
"errorCode=%s, fieldsPresent=%s", error,
937 tunnel_authorization_response_fields_present_to_string(fieldsPresent));
940 if (errorCode != S_OK && errorCode != E_PROXY_QUARANTINE_ACCESSDENIED)
942 WLog_Print(rdg->log, WLOG_ERROR,
"Tunnel authorization error %s", error);
943 freerdp_set_last_error_log(rdg->context, errorCode);
947 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS)
949 UINT32 redirFlags = 0;
950 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
952 Stream_Read_UINT32(s, redirFlags);
954 rdpContext* context = rdg->context;
955 if (!utils_apply_gateway_policy(rdg->log, context, redirFlags,
"RDG"))
959 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT)
961 UINT32 idleTimeout = 0;
962 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 4))
964 Stream_Read_UINT32(s, idleTimeout);
965 WLog_Print(rdg->log, WLOG_DEBUG,
"[IDLE_TIMEOUT] idleTimeout=%" PRIu32
": TODO: unused",
969 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE)
972 if (!Stream_CheckAndLogRequiredCapacityWLog(rdg->log, s, 2))
974 Stream_Read_UINT16(s, cbLen);
976 WLog_Print(rdg->log, WLOG_DEBUG,
"[SOH_RESPONSE] cbLen=%" PRIu16
": TODO: unused", cbLen);
977 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, cbLen))
979 Stream_Seek(s, cbLen);
982 return rdg_send_channel_create(rdg);
985static BOOL rdg_process_extauth_sspi(rdpRdg* rdg,
wStream* s)
988 UINT16 authBlobLen = 0;
990 BYTE* authTokenData = NULL;
994 Stream_Read_INT32(s, errorCode);
995 Stream_Read_UINT16(s, authBlobLen);
997 if (errorCode != ERROR_SUCCESS)
999 WLog_Print(rdg->log, WLOG_ERROR,
"EXTAUTH_SSPI_NTLM failed with error %s [0x%08X]",
1000 GetSecurityStatusString(errorCode), WINPR_CXX_COMPAT_CAST(UINT32, errorCode));
1004 if (authBlobLen == 0)
1006 if (credssp_auth_is_complete(rdg->auth))
1008 credssp_auth_free(rdg->auth);
1010 return rdg_send_tunnel_request(rdg);
1015 authTokenData = malloc(authBlobLen);
1016 if (authTokenData == NULL)
1018 Stream_Read(s, authTokenData, authBlobLen);
1020 authToken.pvBuffer = authTokenData;
1021 authToken.cbBuffer = authBlobLen;
1023 credssp_auth_take_input_buffer(rdg->auth, &authToken);
1025 if (credssp_auth_authenticate(rdg->auth) < 0)
1028 if (credssp_auth_have_output_token(rdg->auth))
1029 return rdg_send_extauth_sspi(rdg);
1034static BOOL rdg_process_channel_response(rdpRdg* rdg,
wStream* s)
1036 UINT16 fieldsPresent = 0;
1037 UINT32 errorCode = 0;
1038 const char* error = NULL;
1039 WLog_Print(rdg->log, WLOG_DEBUG,
"Channel response received");
1041 if (rdg->state != RDG_CLIENT_STATE_CHANNEL_CREATE)
1046 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1049 Stream_Read_UINT32(s, errorCode);
1050 Stream_Read_UINT16(s, fieldsPresent);
1051 Stream_Seek_UINT16(s);
1052 error = rpc_error_to_string(errorCode);
1053 WLog_Print(rdg->log, WLOG_DEBUG,
"channel response errorCode=%s, fieldsPresent=%s", error,
1054 channel_response_fields_present_to_string(fieldsPresent));
1056 if (FAILED((HRESULT)errorCode))
1058 WLog_Print(rdg->log, WLOG_ERROR,
"channel response errorCode=%s, fieldsPresent=%s", error,
1059 channel_response_fields_present_to_string(fieldsPresent));
1060 freerdp_set_last_error_log(rdg->context, errorCode);
1064 rdg->state = RDG_CLIENT_STATE_OPENED;
1068static BOOL rdg_process_packet(rdpRdg* rdg,
wStream* s)
1072 UINT32 packetLength = 0;
1073 Stream_SetPosition(s, 0);
1075 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1078 Stream_Read_UINT16(s, type);
1079 Stream_Seek_UINT16(s);
1080 Stream_Read_UINT32(s, packetLength);
1082 if (Stream_Length(s) < packetLength)
1084 WLog_Print(rdg->log, WLOG_ERROR,
"Short packet %" PRIuz
", expected %" PRIu32,
1085 Stream_Length(s), packetLength);
1091 case PKT_TYPE_HANDSHAKE_RESPONSE:
1092 status = rdg_process_handshake_response(rdg, s);
1095 case PKT_TYPE_TUNNEL_RESPONSE:
1096 status = rdg_process_tunnel_response(rdg, s);
1099 case PKT_TYPE_TUNNEL_AUTH_RESPONSE:
1100 status = rdg_process_tunnel_authorization_response(rdg, s);
1103 case PKT_TYPE_CHANNEL_RESPONSE:
1104 status = rdg_process_channel_response(rdg, s);
1108 WLog_Print(rdg->log, WLOG_ERROR,
"Unexpected packet type DATA");
1111 case PKT_TYPE_EXTENDED_AUTH_MSG:
1112 status = rdg_process_extauth_sspi(rdg, s);
1116 WLog_Print(rdg->log, WLOG_ERROR,
"PKG TYPE 0x%x not implemented", type);
1123DWORD rdg_get_event_handles(rdpRdg* rdg, HANDLE* events, DWORD count)
1126 WINPR_ASSERT(rdg != NULL);
1128 if (rdg->tlsOut && rdg->tlsOut->bio)
1130 if (events && (nCount < count))
1132 BIO_get_event(rdg->tlsOut->bio, &events[nCount]);
1144static BOOL rdg_get_gateway_credentials(rdpContext* context, rdp_auth_reason reason)
1146 freerdp* instance = context->instance;
1148 auth_status rc = utils_authenticate_gateway(instance, reason);
1154 case AUTH_CANCELLED:
1155 freerdp_set_last_error_log(instance->context, FREERDP_ERROR_CONNECT_CANCELLED);
1157 case AUTH_NO_CREDENTIALS:
1158 WLog_INFO(TAG,
"No credentials provided - using NULL identity");
1166static BOOL rdg_auth_init(rdpRdg* rdg, rdpTls* tls, TCHAR* authPkg)
1168 rdpContext* context = rdg->context;
1169 rdpSettings* settings = context->settings;
1170 SEC_WINNT_AUTH_IDENTITY identity = { 0 };
1173 rdg->auth = credssp_auth_new(context);
1177 if (!credssp_auth_init(rdg->auth, authPkg, tls->Bindings))
1183 if (!smartcard_getCert(context, &rdg->smartcard, TRUE))
1186 if (!rdg_get_gateway_credentials(context, AUTH_SMARTCARD_PIN))
1191 if (!rdg_get_gateway_credentials(context, GW_AUTH_RDG))
1196 if (doSCLogon && !smartcard_getCert(context, &rdg->smartcard, TRUE))
1200 SEC_WINNT_AUTH_IDENTITY* identityArg = &identity;
1203 if (!identity_set_from_smartcard_hash(&identity, settings, FreeRDP_GatewayUsername,
1204 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword,
1205 rdg->smartcard->sha1Hash,
1206 sizeof(rdg->smartcard->sha1Hash)))
1211 if (!identity_set_from_settings(&identity, settings, FreeRDP_GatewayUsername,
1212 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword))
1215 if (!settings->GatewayUsername)
1219 if (!credssp_auth_setup_client(rdg->auth,
"HTTP", settings->GatewayHostname, identityArg,
1220 rdg->smartcard ? rdg->smartcard->pkinitArgs : NULL))
1222 sspi_FreeAuthIdentity(&identity);
1225 sspi_FreeAuthIdentity(&identity);
1227 credssp_auth_set_flags(rdg->auth, ISC_REQ_CONFIDENTIALITY | ISC_REQ_MUTUAL_AUTH);
1229 rc = credssp_auth_authenticate(rdg->auth);
1236static BOOL rdg_send_http_request(rdpRdg* rdg, rdpTls* tls,
const char* method,
1237 TRANSFER_ENCODING transferEncoding)
1240 wStream* s = rdg_build_http_request(rdg, method, transferEncoding);
1245 const size_t sz = Stream_Length(s);
1246 status = freerdp_tls_write_all(tls, Stream_Buffer(s), sz);
1248 Stream_Free(s, TRUE);
1249 return (status >= 0);
1252static BOOL rdg_tls_connect(rdpRdg* rdg, rdpTls* tls,
const char* peerAddress, UINT32 timeout)
1255 BIO* layerBio = NULL;
1256 BIO* bufferedBio = NULL;
1258 rdpSettings* settings = rdg->context->settings;
1259 rdpTransport* transport = freerdp_get_transport(rdg->context);
1260 const char* peerHostname = settings->GatewayHostname;
1261 UINT16 peerPort = (UINT16)settings->GatewayPort;
1262 const char* proxyUsername = NULL;
1263 const char* proxyPassword = NULL;
1264 BOOL isProxyConnection =
1265 proxy_prepare(settings, &peerHostname, &peerPort, &proxyUsername, &proxyPassword);
1267 if (settings->GatewayPort > UINT16_MAX)
1270 layer = transport_connect_layer(transport, peerAddress ? peerAddress : peerHostname, peerPort,
1278 layerBio = BIO_new(BIO_s_transport_layer());
1281 transport_layer_free(layer);
1284 BIO_set_data(layerBio, layer);
1286 bufferedBio = BIO_new(BIO_s_buffered_socket());
1289 BIO_free_all(layerBio);
1293 bufferedBio = BIO_push(bufferedBio, layerBio);
1294 status = BIO_set_nonblock(bufferedBio, TRUE);
1296 if (isProxyConnection)
1298 if (!proxy_connect(rdg->context, bufferedBio, proxyUsername, proxyPassword,
1299 settings->GatewayHostname, (UINT16)settings->GatewayPort))
1301 BIO_free_all(bufferedBio);
1308 BIO_free_all(bufferedBio);
1312 tls->hostname = settings->GatewayHostname;
1313 tls->port = WINPR_ASSERTING_INT_CAST(int32_t, MIN(UINT16_MAX, settings->GatewayPort));
1314 tls->isGatewayTransport = TRUE;
1315 status = freerdp_tls_connect(tls, bufferedBio);
1318 rdpContext* context = rdg->context;
1321 freerdp_set_last_error_if_not(context, FREERDP_ERROR_TLS_CONNECT_FAILED);
1325 freerdp_set_last_error_if_not(context, FREERDP_ERROR_CONNECT_CANCELLED);
1330 return (status >= 1);
1333static BOOL rdg_establish_data_connection(rdpRdg* rdg, rdpTls* tls,
const char* method,
1334 const char* peerAddress, UINT32 timeout,
1337 char buffer[64] = { 0 };
1338 HttpResponse* response = NULL;
1340 if (!rdg_tls_connect(rdg, tls, peerAddress, timeout))
1343 WINPR_ASSERT(rpcFallback);
1344 if (rdg->context->settings->GatewayHttpExtAuthBearer && rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1345 rdg->extAuth = HTTP_EXTENDED_AUTH_BEARER;
1346 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1348 if (!rdg_auth_init(rdg, tls, AUTH_PKG))
1351 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1354 response = http_response_recv(tls, TRUE);
1359 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1360 *rpcFallback = TRUE;
1364 const UINT16 StatusCode = http_response_get_status_code(response);
1367 case HTTP_STATUS_GONE:
1368 case HTTP_STATUS_FORBIDDEN:
1369 case HTTP_STATUS_NOT_FOUND:
1371 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway does not support HTTP transport.");
1372 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1373 *rpcFallback = TRUE;
1375 http_response_free(response);
1378 case HTTP_STATUS_OK:
1381 case HTTP_STATUS_DENIED:
1382 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1386 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1390 while (!credssp_auth_is_complete(rdg->auth))
1392 if (!rdg_recv_auth_token(rdg->log, rdg->auth, response))
1394 http_response_free(response);
1398 if (credssp_auth_have_output_token(rdg->auth))
1400 http_response_free(response);
1402 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1405 response = http_response_recv(tls, TRUE);
1408 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1409 *rpcFallback = TRUE;
1414 credssp_auth_free(rdg->auth);
1419 credssp_auth_free(rdg->auth);
1422 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1425 response = http_response_recv(tls, TRUE);
1429 WLog_Print(rdg->log, WLOG_INFO,
"RD Gateway HTTP transport broken.");
1430 *rpcFallback = TRUE;
1435 const UINT16 statusCode = http_response_get_status_code(response);
1436 const size_t bodyLength = http_response_get_body_length(response);
1437 const TRANSFER_ENCODING encoding = http_response_get_transfer_encoding(response);
1438 const BOOL isWebsocket = http_response_is_websocket(rdg->http, response);
1440 WLog_Print(rdg->log, WLOG_DEBUG,
"%s authorization result: %s", method,
1441 freerdp_http_status_string_format(statusCode, buffer, ARRAYSIZE(buffer)));
1445 case HTTP_STATUS_OK:
1448 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1449 http_response_free(response);
1451 case HTTP_STATUS_DENIED:
1452 freerdp_set_last_error_log(rdg->context, FREERDP_ERROR_CONNECT_ACCESS_DENIED);
1453 http_response_free(response);
1455 case HTTP_STATUS_SWITCH_PROTOCOLS:
1456 http_response_free(response);
1463 if (http_context_is_websocket_upgrade_enabled(rdg->http))
1465 long fd = BIO_get_fd(tls->bio, NULL);
1467 closesocket((SOCKET)fd);
1468 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1469 return rdg_establish_data_connection(rdg, tls, method, peerAddress, timeout,
1475 rdg->transferEncoding.isWebsocketTransport = TRUE;
1476 if (!websocket_context_reset(rdg->transferEncoding.context.websocket))
1479 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1483 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1488 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1489 http_response_free(response);
1493 if (strcmp(method,
"RDG_OUT_DATA") == 0)
1495 if (encoding == TransferEncodingChunked)
1497 rdg->transferEncoding.httpTransferEncoding = TransferEncodingChunked;
1498 rdg->transferEncoding.context.chunked.nextOffset = 0;
1499 rdg->transferEncoding.context.chunked.headerFooterPos = 0;
1500 rdg->transferEncoding.context.chunked.state = ChunkStateLenghHeader;
1502 if (!rdg_skip_seed_payload(rdg->context, tls, bodyLength, &rdg->transferEncoding))
1509 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingChunked))
1512 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1516 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1524static BOOL rdg_tunnel_connect(rdpRdg* rdg)
1528 rdg_send_handshake(rdg);
1530 while (rdg->state < RDG_CLIENT_STATE_OPENED)
1533 s = rdg_receive_packet(rdg);
1537 status = rdg_process_packet(rdg, s);
1538 Stream_Free(s, TRUE);
1544 WINPR_ASSERT(rdg->context);
1545 WINPR_ASSERT(rdg->context->rdp);
1546 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1554BOOL rdg_connect(rdpRdg* rdg, DWORD timeout, BOOL* rpcFallback)
1557 SOCKET outConnSocket = 0;
1558 char* peerAddress = NULL;
1559 BOOL rpcFallbackLocal = FALSE;
1561 WINPR_ASSERT(rdg != NULL);
1562 freerdp_set_last_error(rdg->context, ERROR_SUCCESS);
1563 status = rdg_establish_data_connection(rdg, rdg->tlsOut,
"RDG_OUT_DATA", NULL, timeout,
1568 if (rdg->transferEncoding.isWebsocketTransport)
1570 WLog_Print(rdg->log, WLOG_DEBUG,
"Upgraded to websocket. RDG_IN_DATA not required");
1577 BIO_get_socket(rdg->tlsOut->underlying, &outConnSocket);
1578 peerAddress = freerdp_tcp_get_peer_address(outConnSocket);
1579 status = rdg_establish_data_connection(rdg, rdg->tlsIn,
"RDG_IN_DATA", peerAddress,
1580 timeout, &rpcFallbackLocal);
1586 *rpcFallback = rpcFallbackLocal;
1591 WINPR_ASSERT(rdg->context);
1592 WINPR_ASSERT(rdg->context->rdp);
1593 if (rpcFallbackLocal)
1595 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1596 credssp_auth_free(rdg->auth);
1600 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1604 status = rdg_tunnel_connect(rdg);
1612static int rdg_write_websocket_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1618 const size_t payloadSize = (size_t)isize + 10;
1626 websocket_context_packet_new(payloadSize, WebsocketBinaryOpcode, &maskingKey.u32);
1630 Stream_Write_UINT16(
1631 sWS, WINPR_ASSERTING_INT_CAST(
1632 uint16_t, PKT_TYPE_DATA ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1633 Stream_Write_UINT16(
1634 sWS, WINPR_ASSERTING_INT_CAST(
1635 uint16_t, 0 ^ (maskingKey.u8[2] | maskingKey.u8[3] << 8)));
1636 Stream_Write_UINT32(
1637 sWS, WINPR_ASSERTING_INT_CAST(uint32_t, payloadSize ^ maskingKey.u32));
1638 Stream_Write_UINT16(
1639 sWS, WINPR_ASSERTING_INT_CAST(
1640 uint16_t, isize ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8)));
1643 maskingKey.u32 = (maskingKey.u32 & 0xffff) << 16 | (maskingKey.u32 >> 16);
1645 WINPR_ASSERT(rdg->tlsOut);
1647 Stream_StaticConstInit(&sPacket, buf, (
size_t)isize);
1648 if (!websocket_context_mask_and_send(rdg->tlsOut->bio, sWS, &sPacket, maskingKey.u32))
1654static int rdg_write_chunked_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1660 if (isize > UINT16_MAX)
1663 const size_t size = (size_t)isize;
1667 const size_t packetSize = size + 10;
1668 char chunkSize[11] = { 0 };
1669 (void)sprintf_s(chunkSize,
sizeof(chunkSize),
"%" PRIxz
"\r\n", packetSize);
1670 sChunk = Stream_New(NULL, strnlen(chunkSize,
sizeof(chunkSize)) + packetSize + 2);
1675 Stream_Write(sChunk, chunkSize, strnlen(chunkSize,
sizeof(chunkSize)));
1676 Stream_Write_UINT16(sChunk, PKT_TYPE_DATA);
1677 Stream_Write_UINT16(sChunk, 0);
1678 Stream_Write_UINT32(sChunk, (UINT32)packetSize);
1679 Stream_Write_UINT16(sChunk, (UINT16)size);
1680 Stream_Write(sChunk, buf, size);
1681 Stream_Write(sChunk,
"\r\n", 2);
1682 Stream_SealLength(sChunk);
1683 len = Stream_Length(sChunk);
1685 status = freerdp_tls_write_all(rdg->tlsIn, Stream_Buffer(sChunk), len);
1686 Stream_Free(sChunk, TRUE);
1694static int rdg_write_data_packet(rdpRdg* rdg,
const BYTE* buf,
int isize)
1697 if (rdg->transferEncoding.isWebsocketTransport)
1698 return rdg_write_websocket_data_packet(rdg, buf, isize);
1700 return rdg_write_chunked_data_packet(rdg, buf, isize);
1703static BOOL rdg_process_close_packet(rdpRdg* rdg,
wStream* s)
1707 UINT32 errorCode = 0;
1708 UINT32 packetSize = 12;
1711 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1713 Stream_Read_UINT32(s, errorCode);
1716 freerdp_set_last_error_log(rdg->context, errorCode);
1718 sClose = Stream_New(NULL, packetSize);
1722 Stream_Write_UINT16(sClose, PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
1723 Stream_Write_UINT16(sClose, 0);
1724 Stream_Write_UINT32(sClose, packetSize);
1725 Stream_Write_UINT32(sClose, 0);
1726 Stream_SealLength(sClose);
1727 status = rdg_write_packet(rdg, sClose);
1728 Stream_Free(sClose, TRUE);
1730 return (status < 0 ? FALSE : TRUE);
1733static BOOL rdg_process_keep_alive_packet(rdpRdg* rdg)
1737 size_t packetSize = 8;
1739 sKeepAlive = Stream_New(NULL, packetSize);
1744 Stream_Write_UINT16(sKeepAlive, PKT_TYPE_KEEPALIVE);
1745 Stream_Write_UINT16(sKeepAlive, 0);
1746 Stream_Write_UINT32(sKeepAlive, (UINT32)packetSize);
1747 Stream_SealLength(sKeepAlive);
1748 status = rdg_write_packet(rdg, sKeepAlive);
1749 Stream_Free(sKeepAlive, TRUE);
1751 return (status < 0 ? FALSE : TRUE);
1754static BOOL rdg_process_service_message(rdpRdg* rdg,
wStream* s)
1756 const WCHAR* msg = NULL;
1757 UINT16 msgLenBytes = 0;
1758 rdpContext* context = rdg->context;
1759 WINPR_ASSERT(context);
1760 WINPR_ASSERT(context->instance);
1763 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
1765 WLog_Print(rdg->log, WLOG_ERROR,
"Failed to read string");
1769 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
1770 GATEWAY_MESSAGE_SERVICE, TRUE, FALSE, msgLenBytes, msg);
1773static BOOL rdg_process_unknown_packet(rdpRdg* rdg,
int type)
1777 WLog_Print(rdg->log, WLOG_WARN,
"Unknown Control Packet received: %" PRIX32,
1778 WINPR_CXX_COMPAT_CAST(UINT32, type));
1782static BOOL rdg_process_control_packet(rdpRdg* rdg,
int type,
size_t packetLength)
1785 size_t readCount = 0;
1787 size_t payloadSize = packetLength -
sizeof(RdgPacketHeader);
1789 if (packetLength <
sizeof(RdgPacketHeader))
1793 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1797 s = Stream_New(NULL, payloadSize);
1802 while (readCount < payloadSize)
1804 if (rdg_shall_abort(rdg))
1806 Stream_Free(s, TRUE);
1809 status = rdg_socket_read(rdg->tlsOut->bio, Stream_Pointer(s), payloadSize - readCount,
1810 &rdg->transferEncoding);
1814 if (!BIO_should_retry(rdg->tlsOut->bio))
1816 Stream_Free(s, TRUE);
1823 Stream_Seek(s, (
size_t)status);
1824 readCount += (size_t)status;
1826 if (readCount > INT_MAX)
1828 Stream_Free(s, TRUE);
1833 Stream_SetPosition(s, 0);
1838 case PKT_TYPE_CLOSE_CHANNEL:
1839 EnterCriticalSection(&rdg->writeSection);
1840 status = rdg_process_close_packet(rdg, s);
1841 LeaveCriticalSection(&rdg->writeSection);
1844 case PKT_TYPE_KEEPALIVE:
1845 EnterCriticalSection(&rdg->writeSection);
1846 status = rdg_process_keep_alive_packet(rdg);
1847 LeaveCriticalSection(&rdg->writeSection);
1850 case PKT_TYPE_SERVICE_MESSAGE:
1853 WLog_Print(rdg->log, WLOG_ERROR,
1854 "PKT_TYPE_SERVICE_MESSAGE requires payload but none was sent");
1857 status = rdg_process_service_message(rdg, s);
1860 case PKT_TYPE_REAUTH_MESSAGE:
1862 status = rdg_process_unknown_packet(rdg, type);
1866 Stream_Free(s, TRUE);
1870static int rdg_read_data_packet(rdpRdg* rdg, BYTE* buffer,
size_t size)
1872 RdgPacketHeader header = { 0 };
1873 size_t readCount = 0;
1874 size_t readSize = 0;
1877 if (!rdg->packetRemainingCount)
1880 WINPR_ASSERT(
sizeof(RdgPacketHeader) < INT_MAX);
1882 while (readCount <
sizeof(RdgPacketHeader))
1884 if (rdg_shall_abort(rdg))
1887 status = rdg_socket_read(rdg->tlsOut->bio, (BYTE*)(&header) + readCount,
1888 sizeof(RdgPacketHeader) - readCount, &rdg->transferEncoding);
1892 if (!BIO_should_retry(rdg->tlsOut->bio))
1898 BIO_wait_read(rdg->tlsOut->bio, 50);
1902 readCount += (size_t)status;
1904 if (readCount > INT_MAX)
1908 if (header.type != PKT_TYPE_DATA)
1910 status = rdg_process_control_packet(rdg, header.type, header.packetLength);
1920 while (readCount < 2)
1922 if (rdg_shall_abort(rdg))
1925 rdg_socket_read(rdg->tlsOut->bio, (BYTE*)(&rdg->packetRemainingCount) + readCount,
1926 2 - readCount, &rdg->transferEncoding);
1930 if (!BIO_should_retry(rdg->tlsOut->bio))
1933 BIO_wait_read(rdg->tlsOut->bio, 50);
1937 readCount += (size_t)status;
1941 readSize = (rdg->packetRemainingCount < size) ? rdg->packetRemainingCount : size;
1942 status = rdg_socket_read(rdg->tlsOut->bio, buffer, readSize, &rdg->transferEncoding);
1946 if (!BIO_should_retry(rdg->tlsOut->bio))
1954 rdg->packetRemainingCount -= status;
1958static int rdg_bio_write(BIO* bio,
const char* buf,
int num)
1961 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
1965 BIO_clear_flags(bio, BIO_FLAGS_WRITE);
1966 EnterCriticalSection(&rdg->writeSection);
1967 status = rdg_write_data_packet(rdg, (
const BYTE*)buf, num);
1968 LeaveCriticalSection(&rdg->writeSection);
1972 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
1975 else if (status < num)
1977 BIO_set_flags(bio, BIO_FLAGS_WRITE);
1978 WSASetLastError(WSAEWOULDBLOCK);
1982 BIO_set_flags(bio, BIO_FLAGS_WRITE);
1988static int rdg_bio_read(BIO* bio,
char* buf,
int size)
1991 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
1994 status = rdg_read_data_packet(rdg, (BYTE*)buf, (
size_t)size);
1998 BIO_clear_retry_flags(bio);
2001 else if (status == 0)
2003 BIO_set_retry_read(bio);
2004 WSASetLastError(WSAEWOULDBLOCK);
2009 BIO_set_flags(bio, BIO_FLAGS_READ);
2015static int rdg_bio_puts(BIO* bio,
const char* str)
2023static int rdg_bio_gets(BIO* bio,
char* str,
int size)
2031static long rdg_bio_ctrl(BIO* in_bio,
int cmd,
long arg1,
void* arg2)
2034 rdpRdg* rdg = (rdpRdg*)BIO_get_data(in_bio);
2035 rdpTls* tlsOut = rdg->tlsOut;
2036 rdpTls* tlsIn = rdg->tlsIn;
2038 if (cmd == BIO_CTRL_FLUSH)
2040 (void)BIO_flush(tlsOut->bio);
2041 if (!rdg->transferEncoding.isWebsocketTransport)
2042 (void)BIO_flush(tlsIn->bio);
2045 else if (cmd == BIO_C_SET_NONBLOCK)
2049 else if (cmd == BIO_C_READ_BLOCKED)
2051 BIO* cbio = tlsOut->bio;
2052 status = BIO_read_blocked(cbio);
2054 else if (cmd == BIO_C_WRITE_BLOCKED)
2056 BIO* cbio = tlsIn->bio;
2058 if (rdg->transferEncoding.isWebsocketTransport)
2061 status = BIO_write_blocked(cbio);
2063 else if (cmd == BIO_C_WAIT_READ)
2065 int timeout = (int)arg1;
2066 BIO* cbio = tlsOut->bio;
2068 if (BIO_read_blocked(cbio))
2069 return BIO_wait_read(cbio, timeout);
2070 else if (BIO_write_blocked(cbio))
2071 return BIO_wait_write(cbio, timeout);
2075 else if (cmd == BIO_C_WAIT_WRITE)
2077 int timeout = (int)arg1;
2078 BIO* cbio = tlsIn->bio;
2080 if (rdg->transferEncoding.isWebsocketTransport)
2083 if (BIO_write_blocked(cbio))
2084 status = BIO_wait_write(cbio, timeout);
2085 else if (BIO_read_blocked(cbio))
2086 status = BIO_wait_read(cbio, timeout);
2090 else if (cmd == BIO_C_GET_EVENT || cmd == BIO_C_GET_FD)
2100 status = BIO_ctrl(tlsOut->bio, cmd, arg1, arg2);
2102#if OPENSSL_VERSION_NUMBER >= 0x30000000L
2103 else if (cmd == BIO_CTRL_GET_KTLS_SEND)
2111 else if (cmd == BIO_CTRL_GET_KTLS_RECV)
2122static int rdg_bio_new(BIO* bio)
2124 BIO_set_init(bio, 1);
2125 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2129static int rdg_bio_free(BIO* bio)
2135static BIO_METHOD* BIO_s_rdg(
void)
2137 static BIO_METHOD* bio_methods = NULL;
2139 if (bio_methods == NULL)
2141 if (!(bio_methods = BIO_meth_new(BIO_TYPE_TSG,
"RDGateway")))
2144 BIO_meth_set_write(bio_methods, rdg_bio_write);
2145 BIO_meth_set_read(bio_methods, rdg_bio_read);
2146 BIO_meth_set_puts(bio_methods, rdg_bio_puts);
2147 BIO_meth_set_gets(bio_methods, rdg_bio_gets);
2148 BIO_meth_set_ctrl(bio_methods, rdg_bio_ctrl);
2149 BIO_meth_set_create(bio_methods, rdg_bio_new);
2150 BIO_meth_set_destroy(bio_methods, rdg_bio_free);
2156rdpRdg* rdg_new(rdpContext* context)
2161 rdpRdg* rdg = (rdpRdg*)calloc(1,
sizeof(rdpRdg));
2165 rdg->log = WLog_Get(TAG);
2166 rdg->state = RDG_CLIENT_STATE_INITIAL;
2167 rdg->context = context;
2169 (rdg->context->settings->GatewayHttpExtAuthSspiNtlm ? HTTP_EXTENDED_AUTH_SSPI_NTLM
2170 : HTTP_EXTENDED_AUTH_NONE);
2172 if (rdg->context->settings->GatewayAccessToken)
2173 rdg->extAuth = HTTP_EXTENDED_AUTH_PAA;
2175 UuidCreate(&rdg->guid);
2177 rdg->tlsOut = freerdp_tls_new(rdg->context);
2180 goto rdg_alloc_error;
2182 rdg->tlsIn = freerdp_tls_new(rdg->context);
2185 goto rdg_alloc_error;
2187 rdg->http = http_context_new();
2190 goto rdg_alloc_error;
2192 if (!http_context_set_uri(rdg->http,
"/remoteDesktopGateway/") ||
2193 !http_context_set_accept(rdg->http,
"*/*") ||
2194 !http_context_set_cache_control(rdg->http,
"no-cache") ||
2195 !http_context_set_pragma(rdg->http,
"no-cache") ||
2196 !http_context_set_connection(rdg->http,
"Keep-Alive") ||
2197 !http_context_set_user_agent(rdg->http,
"MS-RDGateway/1.0") ||
2198 !http_context_set_host(rdg->http, rdg->context->settings->GatewayHostname) ||
2199 !http_context_set_rdg_connection_id(rdg->http, &rdg->guid) ||
2200 !http_context_set_rdg_correlation_id(rdg->http, &rdg->guid) ||
2201 !http_context_enable_websocket_upgrade(
2205 goto rdg_alloc_error;
2208 if (rdg->extAuth != HTTP_EXTENDED_AUTH_NONE)
2210 switch (rdg->extAuth)
2212 case HTTP_EXTENDED_AUTH_PAA:
2213 if (!http_context_set_rdg_auth_scheme(rdg->http,
"PAA"))
2214 goto rdg_alloc_error;
2218 case HTTP_EXTENDED_AUTH_SSPI_NTLM:
2219 if (!http_context_set_rdg_auth_scheme(rdg->http,
"SSPI_NTLM"))
2220 goto rdg_alloc_error;
2225 WLog_Print(rdg->log, WLOG_DEBUG,
2226 "RDG extended authentication method %d not supported", rdg->extAuth);
2230 rdg->frontBio = BIO_new(BIO_s_rdg());
2233 goto rdg_alloc_error;
2235 BIO_set_data(rdg->frontBio, rdg);
2236 InitializeCriticalSection(&rdg->writeSection);
2238 rdg->transferEncoding.httpTransferEncoding = TransferEncodingIdentity;
2239 rdg->transferEncoding.isWebsocketTransport = FALSE;
2241 rdg->transferEncoding.context.websocket = websocket_context_new();
2242 if (!rdg->transferEncoding.context.websocket)
2243 goto rdg_alloc_error;
2247 WINPR_PRAGMA_DIAG_PUSH
2248 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2250 WINPR_PRAGMA_DIAG_POP
2254void rdg_free(rdpRdg* rdg)
2259 freerdp_tls_free(rdg->tlsOut);
2260 freerdp_tls_free(rdg->tlsIn);
2261 http_context_free(rdg->http);
2262 credssp_auth_free(rdg->auth);
2265 BIO_free_all(rdg->frontBio);
2267 DeleteCriticalSection(&rdg->writeSection);
2269 smartcardCertInfo_Free(rdg->smartcard);
2271 websocket_context_free(rdg->transferEncoding.context.websocket);
2276BIO* rdg_get_front_bio_and_take_ownership(rdpRdg* rdg)
2281 rdg->attached = TRUE;
2282 return rdg->frontBio;
FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
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.