FreeRDP
Loading...
Searching...
No Matches
rdg.c
1
20#include <stdint.h>
21
22#include <freerdp/config.h>
23
24#include "../settings.h"
25
26#include <winpr/assert.h>
27#include <winpr/cast.h>
28
29#include <winpr/crt.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>
35
36#include <freerdp/log.h>
37#include <freerdp/error.h>
38#include <freerdp/utils/ringbuffer.h>
39#include <freerdp/utils/smartcardlogon.h>
40
41#include "rdg.h"
42#include "websocket.h"
43#include "../credssp_auth.h"
44#include "../proxy.h"
45#include "../rdp.h"
46#include "../../crypto/opensslcompat.h"
47#include "rpc_fault.h"
48#include "../utils.h"
49
50#define TAG FREERDP_TAG("core.gateway.rdg")
51
52#define AUTH_PKG NEGO_SSP_NAME
53
54/* HTTP channel response fields present flags. */
55#define HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID 0x1
56#define HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE 0x2
57#define HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT 0x4
58
59/* HTTP extended auth. */
60#define HTTP_EXTENDED_AUTH_NONE 0x0
61#define HTTP_EXTENDED_AUTH_SC 0x1 /* Smart card authentication. */
62#define HTTP_EXTENDED_AUTH_PAA 0x02 /* Pluggable authentication. */
63#define HTTP_EXTENDED_AUTH_SSPI_NTLM 0x04 /* NTLM extended authentication. */
64#define HTTP_EXTENDED_AUTH_BEARER 0x08 /* HTTP Bearer authentication. */
65
66/* HTTP packet types. */
67typedef enum
68{
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,
78 PKT_TYPE_DATA = 0xA,
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
84} RdgPktType;
85
86/* HTTP tunnel auth fields present flags. */
87// #define HTTP_TUNNEL_AUTH_FIELD_SOH 0x1
88
89/* HTTP tunnel auth response fields present flags. */
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
93
94/* HTTP tunnel packet fields present flags. */
95#define HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE 0x1
96// #define HTTP_TUNNEL_PACKET_FIELD_REAUTH 0x2
97
98/* HTTP tunnel response fields present flags. */
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
103
104/* HTTP capability type enumeration. */
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
111
112typedef struct
113{
114 TRANSFER_ENCODING httpTransferEncoding;
115 BOOL isWebsocketTransport;
116 union context
117 {
119 websocket_context* websocket;
120 } context;
121} rdg_http_encoding_context;
122
123struct rdp_rdg
124{
125 rdpContext* context;
126 BOOL attached;
127 BIO* frontBio;
128 rdpTls* tlsIn;
129 rdpTls* tlsOut;
130 rdpCredsspAuth* auth;
131 HttpContext* http;
132 CRITICAL_SECTION writeSection;
133
134 int state;
135 UINT16 packetRemainingCount;
136 UINT16 reserved1;
137 int timeout;
138 UINT16 extAuth;
139 UINT16 reserved2;
140 rdg_http_encoding_context transferEncoding;
141
142 SmartcardCertInfo* smartcard;
143 wLog* log;
144};
145
146enum
147{
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,
154};
155
156#pragma pack(push, 1)
157
158typedef struct rdg_packet_header
159{
160 UINT16 type;
161 UINT16 reserved;
162 UINT32 packetLength;
163} RdgPacketHeader;
164
165#pragma pack(pop)
166
167typedef struct
168{
169 UINT32 code;
170 const char* name;
171} t_flag_mapping;
172
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" }
178};
179
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" }
184};
185
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" }
192};
193
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" }
199};
200
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" }
208};
209
210WINPR_ATTR_NODISCARD
211static const char* rdg_pkt_type_to_string(int type)
212{
213#define ENTRY(x) \
214 case x: \
215 return #x
216
217 switch (type)
218 {
219 ENTRY(PKT_TYPE_HANDSHAKE_REQUEST);
220 ENTRY(PKT_TYPE_HANDSHAKE_RESPONSE);
221 ENTRY(PKT_TYPE_EXTENDED_AUTH_MSG);
222 ENTRY(PKT_TYPE_TUNNEL_CREATE);
223 ENTRY(PKT_TYPE_TUNNEL_RESPONSE);
224 ENTRY(PKT_TYPE_TUNNEL_AUTH);
225 ENTRY(PKT_TYPE_TUNNEL_AUTH_RESPONSE);
226 ENTRY(PKT_TYPE_CHANNEL_CREATE);
227 ENTRY(PKT_TYPE_CHANNEL_RESPONSE);
228 ENTRY(PKT_TYPE_DATA);
229 ENTRY(PKT_TYPE_SERVICE_MESSAGE);
230 ENTRY(PKT_TYPE_REAUTH_MESSAGE);
231 ENTRY(PKT_TYPE_KEEPALIVE);
232 ENTRY(PKT_TYPE_CLOSE_CHANNEL);
233 ENTRY(PKT_TYPE_CLOSE_CHANNEL_RESPONSE);
234 default:
235 return "PKT_TYPE_UNKNOWN";
236 }
237#undef ENTRY
238}
239
240WINPR_ATTR_NODISCARD
241static const char* flags_to_string(UINT32 flags, const t_flag_mapping* map, size_t elements)
242{
243 static char buffer[1024] = WINPR_C_ARRAY_INIT;
244 char fields[12] = WINPR_C_ARRAY_INIT;
245
246 for (size_t x = 0; x < elements; x++)
247 {
248 const t_flag_mapping* cur = &map[x];
249
250 if ((cur->code & flags) != 0)
251 winpr_str_append(cur->name, buffer, sizeof(buffer), "|");
252 }
253
254 (void)sprintf_s(fields, ARRAYSIZE(fields), " [%04" PRIx32 "]", flags);
255 winpr_str_append(fields, buffer, sizeof(buffer), nullptr);
256 return buffer;
257}
258
259WINPR_ATTR_NODISCARD
260static const char* channel_response_fields_present_to_string(UINT16 fieldsPresent)
261{
262 return flags_to_string(fieldsPresent, channel_response_fields_present,
263 ARRAYSIZE(channel_response_fields_present));
264}
265
266WINPR_ATTR_NODISCARD
267static const char* tunnel_response_fields_present_to_string(UINT16 fieldsPresent)
268{
269 return flags_to_string(fieldsPresent, tunnel_response_fields_present,
270 ARRAYSIZE(tunnel_response_fields_present));
271}
272
273WINPR_ATTR_NODISCARD
274static const char* tunnel_authorization_response_fields_present_to_string(UINT16 fieldsPresent)
275{
276 return flags_to_string(fieldsPresent, tunnel_authorization_response_fields_present,
277 ARRAYSIZE(tunnel_authorization_response_fields_present));
278}
279
280WINPR_ATTR_NODISCARD
281static const char* extended_auth_to_string(UINT16 auth)
282{
283 if (auth == HTTP_EXTENDED_AUTH_NONE)
284 return "HTTP_EXTENDED_AUTH_NONE [0x0000]";
285
286 return flags_to_string(auth, extended_auth, ARRAYSIZE(extended_auth));
287}
288
289WINPR_ATTR_NODISCARD
290static const char* capabilities_enum_to_string(UINT32 capabilities)
291{
292 return flags_to_string(capabilities, capabilities_enum, ARRAYSIZE(capabilities_enum));
293}
294
295WINPR_ATTR_NODISCARD
296static BOOL rdg_read_http_unicode_string(wLog* log, wStream* s, const WCHAR** string,
297 UINT16* lengthInBytes)
298{
299 UINT16 strLenBytes = 0;
300 size_t rem = Stream_GetRemainingLength(s);
301
302 /* Read length of the string */
303 if (!Stream_CheckAndLogRequiredLengthWLog(log, s, 4))
304 {
305 WLog_Print(log, WLOG_ERROR, "Could not read stream length, only have %" PRIuz " bytes",
306 rem);
307 return FALSE;
308 }
309 Stream_Read_UINT16(s, strLenBytes);
310
311 /* Remember position of our string */
312 const WCHAR* str = Stream_ConstPointer(s);
313
314 /* seek past the string - if this fails something is wrong */
315 if (!Stream_SafeSeek(s, strLenBytes))
316 {
317 WLog_Print(log, WLOG_ERROR,
318 "Could not read stream data, only have %" PRIuz " bytes, expected %" PRIu16,
319 rem - 4, strLenBytes);
320 return FALSE;
321 }
322
323 /* return the string data (if wanted) */
324 if (string)
325 *string = str;
326 if (lengthInBytes)
327 *lengthInBytes = strLenBytes;
328
329 return TRUE;
330}
331
332WINPR_ATTR_NODISCARD
333static BOOL rdg_write_chunked(BIO* bio, wStream* sPacket)
334{
335 size_t len = 0;
336 int status = 0;
337 wStream* sChunk = nullptr;
338 char chunkSize[11];
339 (void)sprintf_s(chunkSize, sizeof(chunkSize), "%" PRIXz "\r\n", Stream_Length(sPacket));
340 sChunk =
341 Stream_New(nullptr, strnlen(chunkSize, sizeof(chunkSize)) + Stream_Length(sPacket) + 2);
342
343 if (!sChunk)
344 return FALSE;
345
346 Stream_Write(sChunk, chunkSize, strnlen(chunkSize, sizeof(chunkSize)));
347 Stream_Write(sChunk, Stream_Buffer(sPacket), Stream_Length(sPacket));
348 Stream_Write(sChunk, "\r\n", 2);
349 Stream_SealLength(sChunk);
350 len = Stream_Length(sChunk);
351
352 if (len > INT_MAX)
353 {
354 Stream_Free(sChunk, TRUE);
355 return FALSE;
356 }
357
358 ERR_clear_error();
359 status = BIO_write(bio, Stream_Buffer(sChunk), (int)len);
360 Stream_Free(sChunk, TRUE);
361
362 return (status == (SSIZE_T)len);
363}
364
365WINPR_ATTR_NODISCARD
366static BOOL rdg_write_packet(rdpRdg* rdg, wStream* sPacket)
367{
368 if (rdg->transferEncoding.isWebsocketTransport)
369 return websocket_context_write_wstream(rdg->transferEncoding.context.websocket,
370 rdg->tlsOut->bio, sPacket, WebsocketBinaryOpcode);
371
372 return rdg_write_chunked(rdg->tlsIn->bio, sPacket);
373}
374
375WINPR_ATTR_NODISCARD
376static int rdg_socket_read(BIO* bio, rdpContext* context, BYTE* pBuffer, size_t size,
377 rdg_http_encoding_context* encodingContext)
378{
379 WINPR_ASSERT(encodingContext != nullptr);
380 if (size > INT32_MAX)
381 return -1;
382
383 if (encodingContext->isWebsocketTransport)
384 return websocket_context_read(encodingContext->context.websocket, bio, pBuffer, size);
385
386 switch (encodingContext->httpTransferEncoding)
387 {
388 case TransferEncodingIdentity:
389 ERR_clear_error();
390 return BIO_read(bio, pBuffer, (int)size);
391 case TransferEncodingChunked:
392 return http_chuncked_read(bio, context, pBuffer, size,
393 &encodingContext->context.chunked);
394 default:
395 return -1;
396 }
397}
398
399WINPR_ATTR_NODISCARD
400static BOOL rdg_shall_abort(rdpRdg* rdg)
401{
402 WINPR_ASSERT(rdg);
403 return freerdp_shall_disconnect_context(rdg->context);
404}
405
406WINPR_ATTR_NODISCARD
407static BOOL rdg_read_all(rdpContext* context, rdpTls* tls, wStream* s, size_t size,
408 rdg_http_encoding_context* transferEncoding)
409{
410 size_t readCount = 0;
411
412 if (!Stream_EnsureRemainingCapacity(s, size))
413 return FALSE;
414
415 BYTE* pBuffer = Stream_Pointer(s);
416 while (readCount < size)
417 {
418 if (freerdp_shall_disconnect_context(context))
419 return FALSE;
420
421 int status =
422 rdg_socket_read(tls->bio, tls->context, pBuffer, size - readCount, transferEncoding);
423 if (status <= 0)
424 {
425 if (!BIO_should_retry(tls->bio))
426 return FALSE;
427
428 Sleep(10);
429 continue;
430 }
431
432 readCount += WINPR_ASSERTING_INT_CAST(uint32_t, status);
433 pBuffer += WINPR_ASSERTING_INT_CAST(uint32_t, status);
434 }
435
436 return TRUE;
437}
438
439WINPR_ATTR_MALLOC(Stream_Free, 1)
440static wStream* rdg_receive_packet(rdpRdg* rdg)
441{
442 const size_t header = sizeof(RdgPacketHeader);
443 size_t packetLength = 0;
444 wStream* s = Stream_New(nullptr, 1024);
445
446 if (!s)
447 return nullptr;
448
449 if (!rdg_read_all(rdg->context, rdg->tlsOut, s, header, &rdg->transferEncoding))
450 goto fail;
451
452 Stream_Seek(s, 4);
453 Stream_Read_UINT32(s, packetLength);
454
455 if ((packetLength > INT_MAX) || (packetLength < header))
456 goto fail;
457
458 const size_t requestBlockSize = 4096;
459 for (size_t offset = header; offset < packetLength; offset += requestBlockSize)
460 {
461 size_t block = requestBlockSize;
462 if (offset + block > packetLength)
463 block = packetLength - offset;
464
465 if (!rdg_read_all(rdg->context, rdg->tlsOut, s, block, &rdg->transferEncoding))
466 goto fail;
467
468 if (!Stream_SafeSeek(s, block))
469 goto fail;
470 }
471
472 if (!Stream_SetLength(s, packetLength))
473 goto fail;
474 return s;
475
476fail:
477 Stream_Free(s, TRUE);
478 return nullptr;
479}
480
481WINPR_ATTR_NODISCARD
482static BOOL rdg_send_handshake(rdpRdg* rdg)
483{
484 BOOL status = FALSE;
485 wStream* s = Stream_New(nullptr, 14);
486
487 if (!s)
488 return FALSE;
489
490 Stream_Write_UINT16(s, PKT_TYPE_HANDSHAKE_REQUEST); /* Type (2 bytes) */
491 Stream_Write_UINT16(s, 0); /* Reserved (2 bytes) */
492 Stream_Write_UINT32(s, 14); /* PacketLength (4 bytes) */
493 Stream_Write_UINT8(s, 1); /* VersionMajor (1 byte) */
494 Stream_Write_UINT8(s, 0); /* VersionMinor (1 byte) */
495 Stream_Write_UINT16(s, 0); /* ClientVersion (2 bytes), must be 0 */
496 Stream_Write_UINT16(s, rdg->extAuth); /* ExtendedAuthentication (2 bytes) */
497 Stream_SealLength(s);
498 status = rdg_write_packet(rdg, s);
499 Stream_Free(s, TRUE);
500
501 if (status)
502 {
503 rdg->state = RDG_CLIENT_STATE_HANDSHAKE;
504 }
505
506 return status;
507}
508
509WINPR_ATTR_NODISCARD
510static BOOL rdg_send_extauth_sspi(rdpRdg* rdg)
511{
512 wStream* s = nullptr;
513 BOOL status = 0;
514 UINT32 packetSize = 8 + 4 + 2;
515
516 WINPR_ASSERT(rdg);
517
518 const SecBuffer* authToken = credssp_auth_get_output_buffer(rdg->auth);
519 if (!authToken)
520 return FALSE;
521 packetSize += authToken->cbBuffer;
522
523 s = Stream_New(nullptr, packetSize);
524
525 if (!s)
526 return FALSE;
527
528 Stream_Write_UINT16(s, PKT_TYPE_EXTENDED_AUTH_MSG); /* Type (2 bytes) */
529 Stream_Write_UINT16(s, 0); /* Reserved (2 bytes) */
530 Stream_Write_UINT32(s, packetSize); /* PacketLength (4 bytes) */
531 Stream_Write_UINT32(s, ERROR_SUCCESS); /* Error code */
532 Stream_Write_UINT16(s, (UINT16)authToken->cbBuffer);
533 Stream_Write(s, authToken->pvBuffer, authToken->cbBuffer);
534
535 Stream_SealLength(s);
536 status = rdg_write_packet(rdg, s);
537 Stream_Free(s, TRUE);
538
539 return status;
540}
541
542WINPR_ATTR_NODISCARD
543static BOOL rdg_send_tunnel_request(rdpRdg* rdg)
544{
545 wStream* s = nullptr;
546 BOOL status = FALSE;
547 UINT32 packetSize = 16;
548 UINT16 fieldsPresent = 0;
549 WCHAR* PAACookie = nullptr;
550 size_t PAACookieLen = 0;
551 const UINT32 capabilities = HTTP_CAPABILITY_TYPE_QUAR_SOH |
552 HTTP_CAPABILITY_MESSAGING_CONSENT_SIGN |
553 HTTP_CAPABILITY_MESSAGING_SERVICE_MSG;
554
555 if (rdg->extAuth == HTTP_EXTENDED_AUTH_PAA)
556 {
557 PAACookie =
558 ConvertUtf8ToWCharAlloc(rdg->context->settings->GatewayAccessToken, &PAACookieLen);
559
560 if (!PAACookie || (PAACookieLen > UINT16_MAX / sizeof(WCHAR)))
561 goto fail;
562
563 PAACookieLen += 1; /* include \0 */
564 packetSize += 2 + (UINT32)(PAACookieLen) * sizeof(WCHAR);
565 fieldsPresent = HTTP_TUNNEL_PACKET_FIELD_PAA_COOKIE;
566 }
567
568 s = Stream_New(nullptr, packetSize);
569
570 if (!s)
571 goto fail;
572
573 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_CREATE); /* Type (2 bytes) */
574 Stream_Write_UINT16(s, 0); /* Reserved (2 bytes) */
575 Stream_Write_UINT32(s, packetSize); /* PacketLength (4 bytes) */
576 Stream_Write_UINT32(s, capabilities); /* CapabilityFlags (4 bytes) */
577 Stream_Write_UINT16(s, fieldsPresent); /* FieldsPresent (2 bytes) */
578 Stream_Write_UINT16(s, 0); /* Reserved (2 bytes), must be 0 */
579
580 if (PAACookie)
581 {
582 Stream_Write_UINT16(s, (UINT16)PAACookieLen * sizeof(WCHAR)); /* PAA cookie string length */
583 if (!Stream_Write_UTF16_String(s, PAACookie, PAACookieLen))
584 goto fail;
585 }
586
587 Stream_SealLength(s);
588 status = rdg_write_packet(rdg, s);
589
590fail:
591 Stream_Free(s, TRUE);
592 free(PAACookie);
593
594 if (status)
595 {
596 rdg->state = RDG_CLIENT_STATE_TUNNEL_CREATE;
597 }
598
599 return status;
600}
601
602WINPR_ATTR_NODISCARD
603static BOOL rdg_send_tunnel_authorization(rdpRdg* rdg)
604{
605 wStream* s = nullptr;
606 BOOL status = FALSE;
607 WINPR_ASSERT(rdg);
608 size_t clientNameLen = 0;
609 WCHAR* clientName = freerdp_settings_get_string_as_utf16(
610 rdg->context->settings, FreeRDP_ClientHostname, &clientNameLen);
611
612 clientNameLen++; // length including terminating '\0'
613
614 const size_t packetSize = 12ull + clientNameLen * sizeof(WCHAR);
615 if (!clientName || (clientNameLen >= UINT16_MAX / sizeof(WCHAR)) || (packetSize > UINT32_MAX))
616 goto fail;
617
618 s = Stream_New(nullptr, packetSize);
619
620 if (!s)
621 goto fail;
622
623 Stream_Write_UINT16(s, PKT_TYPE_TUNNEL_AUTH); /* Type (2 bytes) */
624 Stream_Write_UINT16(s, 0); /* Reserved (2 bytes) */
625 Stream_Write_UINT32(s, (UINT32)packetSize); /* PacketLength (4 bytes) */
626 Stream_Write_UINT16(s, 0); /* FieldsPresent (2 bytes) */
627 Stream_Write_UINT16(s, (UINT16)clientNameLen * sizeof(WCHAR)); /* Client name string length */
628 if (!Stream_Write_UTF16_String(s, clientName, clientNameLen))
629 goto fail;
630 Stream_SealLength(s);
631 status = rdg_write_packet(rdg, s);
632
633fail:
634 Stream_Free(s, TRUE);
635 free(clientName);
636
637 if (status)
638 rdg->state = RDG_CLIENT_STATE_TUNNEL_AUTHORIZE;
639
640 return status;
641}
642
643WINPR_ATTR_NODISCARD
644static BOOL rdg_send_channel_create(rdpRdg* rdg)
645{
646 wStream* s = nullptr;
647 BOOL status = FALSE;
648 WCHAR* serverName = nullptr;
649 size_t serverNameLen = 0;
650
651 WINPR_ASSERT(rdg);
652 serverName = freerdp_settings_get_string_as_utf16(rdg->context->settings,
653 FreeRDP_ServerHostname, &serverNameLen);
654
655 serverNameLen++; // length including terminating '\0'
656 const size_t packetSize = 16ull + serverNameLen * sizeof(WCHAR);
657 if (!serverName || (serverNameLen >= UINT16_MAX / sizeof(WCHAR)) || (packetSize > UINT32_MAX))
658 goto fail;
659
660 s = Stream_New(nullptr, packetSize);
661
662 if (!s)
663 goto fail;
664
665 Stream_Write_UINT16(s, PKT_TYPE_CHANNEL_CREATE); /* Type (2 bytes) */
666 Stream_Write_UINT16(s, 0); /* Reserved (2 bytes) */
667 Stream_Write_UINT32(s, (UINT32)packetSize); /* PacketLength (4 bytes) */
668 Stream_Write_UINT8(s, 1); /* Number of resources. (1 byte) */
669 Stream_Write_UINT8(s, 0); /* Number of alternative resources (1 byte) */
670 Stream_Write_UINT16(s,
671 (UINT16)rdg->context->settings->ServerPort); /* Resource port (2 bytes) */
672 Stream_Write_UINT16(s, 3); /* Protocol number (2 bytes) */
673 Stream_Write_UINT16(s, (UINT16)serverNameLen * sizeof(WCHAR));
674 if (!Stream_Write_UTF16_String(s, serverName, serverNameLen))
675 goto fail;
676
677 Stream_SealLength(s);
678 status = rdg_write_packet(rdg, s);
679fail:
680 free(serverName);
681 Stream_Free(s, TRUE);
682
683 if (status)
684 rdg->state = RDG_CLIENT_STATE_CHANNEL_CREATE;
685
686 return status;
687}
688
689WINPR_ATTR_NODISCARD
690static BOOL rdg_set_auth_header(rdpCredsspAuth* auth, HttpRequest* request)
691{
692 const SecBuffer* authToken = credssp_auth_get_output_buffer(auth);
693 char* base64AuthToken = nullptr;
694
695 if (authToken)
696 {
697 if (authToken->cbBuffer > INT_MAX)
698 return FALSE;
699
700 base64AuthToken = crypto_base64_encode(authToken->pvBuffer, authToken->cbBuffer);
701 }
702
703 if (base64AuthToken)
704 {
705 BOOL rc = http_request_set_auth_scheme(request, credssp_auth_pkg_name(auth)) &&
706 http_request_set_auth_param(request, base64AuthToken);
707 free(base64AuthToken);
708
709 if (!rc)
710 return FALSE;
711 }
712
713 return TRUE;
714}
715
716WINPR_ATTR_MALLOC(Stream_Free, 1)
717static wStream* rdg_build_http_request(rdpRdg* rdg, const char* method,
718 TRANSFER_ENCODING transferEncoding)
719{
720 wStream* s = nullptr;
721 HttpRequest* request = nullptr;
722 const char* uri = nullptr;
723
724 if (!rdg || !method)
725 return nullptr;
726
727 uri = http_context_get_uri(rdg->http);
728 request = http_request_new();
729
730 if (!request)
731 return nullptr;
732
733 if (!http_request_set_method(request, method) || !http_request_set_uri(request, uri))
734 goto out;
735
736 if (rdg->auth)
737 {
738 if (!rdg_set_auth_header(rdg->auth, request))
739 goto out;
740 }
741
742 else if (rdg->extAuth == HTTP_EXTENDED_AUTH_BEARER)
743 {
744 if (!http_request_set_auth_scheme(request, "Bearer"))
745 goto out;
746 if (!http_request_set_auth_param(request, rdg->context->settings->GatewayHttpExtAuthBearer))
747 goto out;
748 }
749
750 if (!http_request_set_transfer_encoding(request, transferEncoding))
751 goto out;
752
753 s = http_request_write(rdg->http, request);
754out:
755 http_request_free(request);
756
757 if (s)
758 Stream_SealLength(s);
759
760 return s;
761}
762
763WINPR_ATTR_NODISCARD
764static BOOL rdg_recv_auth_token(wLog* log, rdpCredsspAuth* auth, HttpResponse* response,
765 BOOL* pHaveToken)
766{
767 size_t len = 0;
768 size_t authTokenLength = 0;
769 BYTE* authTokenData = nullptr;
770 SecBuffer authToken = WINPR_C_ARRAY_INIT;
771 int rc = 0;
772
773 WINPR_ASSERT(pHaveToken);
774 *pHaveToken = FALSE;
775
776 if (!auth || !response)
777 return FALSE;
778
779 const UINT16 StatusCode = http_response_get_status_code(response);
780 switch (StatusCode)
781 {
782 case HTTP_STATUS_DENIED:
783 case HTTP_STATUS_OK:
784 case HTTP_STATUS_SWITCH_PROTOCOLS:
785 break;
786 default:
787 http_response_log_error_status(log, WLOG_WARN, response);
788 return FALSE;
789 }
790
791 const char* token64 = http_response_get_auth_token(response, credssp_auth_pkg_name(auth));
792 if (!token64)
793 {
794 /* Not an error in itself: the server may complete the authentication without returning
795 * a final token. The caller decides what that means from the HTTP status. */
796 return TRUE;
797 }
798
799 *pHaveToken = TRUE;
800
801 len = strlen(token64);
802
803 crypto_base64_decode(token64, len, &authTokenData, &authTokenLength);
804
805 if (authTokenLength && authTokenData && (authTokenLength <= UINT32_MAX))
806 {
807 authToken.pvBuffer = authTokenData;
808 authToken.cbBuffer = (UINT32)authTokenLength;
809 credssp_auth_take_input_buffer(auth, &authToken);
810 }
811 else
812 free(authTokenData);
813
814 rc = credssp_auth_authenticate(auth);
815 return (rc >= 0);
816}
817
818WINPR_ATTR_NODISCARD
819static BOOL rdg_skip_seed_payload(rdpContext* context, rdpTls* tls, size_t lastResponseLength,
820 rdg_http_encoding_context* transferEncoding)
821{
822 /* Per [MS-TSGU] 3.3.5.1 step 4, after final OK response RDG server sends
823 * random "seed" payload of limited size. In practice it's 10 bytes.
824 */
825 const size_t size = 10;
826 if (lastResponseLength < size)
827 {
828 wStream* s = Stream_New(nullptr, size);
829 if (!s)
830 return FALSE;
831 const BOOL rc = rdg_read_all(context, tls, s, size - lastResponseLength, transferEncoding);
832 Stream_Free(s, TRUE);
833 return rc;
834 }
835
836 return TRUE;
837}
838
839WINPR_ATTR_NODISCARD
840static BOOL rdg_process_handshake_response(rdpRdg* rdg, wStream* s)
841{
842 UINT32 errorCode = 0;
843 UINT16 serverVersion = 0;
844 UINT16 extendedAuth = 0;
845 BYTE verMajor = 0;
846 BYTE verMinor = 0;
847 const char* error = nullptr;
848 WLog_Print(rdg->log, WLOG_DEBUG, "Handshake response received");
849
850 if (rdg->state != RDG_CLIENT_STATE_HANDSHAKE)
851 {
852 return FALSE;
853 }
854
855 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
856 return FALSE;
857
858 Stream_Read_UINT32(s, errorCode);
859 Stream_Read_UINT8(s, verMajor);
860 Stream_Read_UINT8(s, verMinor);
861 Stream_Read_UINT16(s, serverVersion);
862 Stream_Read_UINT16(s, extendedAuth);
863 error = rpc_error_to_string(errorCode);
864 WLog_Print(rdg->log, WLOG_DEBUG,
865 "errorCode=%s, verMajor=%" PRId8 ", verMinor=%" PRId8 ", serverVersion=%" PRId16
866 ", extendedAuth=%s",
867 error, verMajor, verMinor, serverVersion, extended_auth_to_string(extendedAuth));
868
869 if (FAILED((HRESULT)errorCode))
870 {
871 WLog_Print(rdg->log, WLOG_ERROR, "Handshake error %s", error);
872 freerdp_set_last_error_log(rdg->context, errorCode);
873 return FALSE;
874 }
875
876 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
877 return rdg_send_extauth_sspi(rdg);
878
879 return rdg_send_tunnel_request(rdg);
880}
881
882WINPR_ATTR_NODISCARD
883static BOOL rdg_process_tunnel_response_optional(rdpRdg* rdg, wStream* s, UINT16 fieldsPresent)
884{
885 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_TUNNEL_ID)
886 {
887 /* Seek over tunnelId (4 bytes) */
888 if (!Stream_SafeSeek(s, 4))
889 {
890 WLog_Print(rdg->log, WLOG_ERROR, "Short tunnelId, got %" PRIuz ", expected 4",
891 Stream_GetRemainingLength(s));
892 return FALSE;
893 }
894 }
895
896 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CAPS)
897 {
898 UINT32 caps = 0;
899 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
900 return FALSE;
901
902 Stream_Read_UINT32(s, caps);
903 WLog_Print(rdg->log, WLOG_DEBUG, "capabilities=%s", capabilities_enum_to_string(caps));
904 }
905
906 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_SOH_REQ)
907 {
908 /* Seek over nonce (20 bytes) */
909 if (!Stream_SafeSeek(s, 20))
910 {
911 WLog_Print(rdg->log, WLOG_ERROR, "Short nonce, got %" PRIuz ", expected 20",
912 Stream_GetRemainingLength(s));
913 return FALSE;
914 }
915
916 /* Read serverCert */
917 if (!rdg_read_http_unicode_string(rdg->log, s, nullptr, nullptr))
918 {
919 WLog_Print(rdg->log, WLOG_ERROR, "Failed to read server certificate");
920 return FALSE;
921 }
922 }
923
924 if (fieldsPresent & HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG)
925 {
926 const WCHAR* msg = nullptr;
927 UINT16 msgLenBytes = 0;
928 rdpContext* context = rdg->context;
929
930 WINPR_ASSERT(context);
931 WINPR_ASSERT(context->instance);
932
933 /* Read message string and invoke callback */
934 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
935 {
936 WLog_Print(rdg->log, WLOG_ERROR, "Failed to read consent message");
937 return FALSE;
938 }
939
940 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
941 GATEWAY_MESSAGE_CONSENT, TRUE, TRUE, msgLenBytes, msg);
942 }
943
944 return TRUE;
945}
946
947WINPR_ATTR_NODISCARD
948static BOOL rdg_process_tunnel_response(rdpRdg* rdg, wStream* s)
949{
950 UINT16 serverVersion = 0;
951 UINT16 fieldsPresent = 0;
952 UINT32 errorCode = 0;
953 const char* error = nullptr;
954 WLog_Print(rdg->log, WLOG_DEBUG, "Tunnel response received");
955
956 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_CREATE)
957 {
958 return FALSE;
959 }
960
961 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 10))
962 return FALSE;
963
964 Stream_Read_UINT16(s, serverVersion);
965 Stream_Read_UINT32(s, errorCode);
966 Stream_Read_UINT16(s, fieldsPresent);
967 Stream_Seek_UINT16(s); /* reserved */
968 error = rpc_error_to_string(errorCode);
969 WLog_Print(rdg->log, WLOG_DEBUG, "serverVersion=%" PRId16 ", errorCode=%s, fieldsPresent=%s",
970 serverVersion, error, tunnel_response_fields_present_to_string(fieldsPresent));
971
972 if (FAILED((HRESULT)errorCode))
973 {
974 WLog_Print(rdg->log, WLOG_ERROR, "Tunnel creation error %s", error);
975 freerdp_set_last_error_log(rdg->context, errorCode);
976 return FALSE;
977 }
978
979 if (!rdg_process_tunnel_response_optional(rdg, s, fieldsPresent))
980 return FALSE;
981
982 return rdg_send_tunnel_authorization(rdg);
983}
984
985WINPR_ATTR_NODISCARD
986static BOOL rdg_process_tunnel_authorization_response(rdpRdg* rdg, wStream* s)
987{
988 UINT32 errorCode = 0;
989 UINT16 fieldsPresent = 0;
990 const char* error = nullptr;
991 WLog_Print(rdg->log, WLOG_DEBUG, "Tunnel authorization received");
992
993 if (rdg->state != RDG_CLIENT_STATE_TUNNEL_AUTHORIZE)
994 {
995 return FALSE;
996 }
997
998 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
999 return FALSE;
1000
1001 Stream_Read_UINT32(s, errorCode);
1002 Stream_Read_UINT16(s, fieldsPresent);
1003 Stream_Seek_UINT16(s); /* reserved */
1004 error = rpc_error_to_string(errorCode);
1005 WLog_Print(rdg->log, WLOG_DEBUG, "errorCode=%s, fieldsPresent=%s", error,
1006 tunnel_authorization_response_fields_present_to_string(fieldsPresent));
1007
1008 /* [MS-TSGU] 3.7.5.2.7 */
1009 if (errorCode != S_OK && errorCode != E_PROXY_QUARANTINE_ACCESSDENIED)
1010 {
1011 WLog_Print(rdg->log, WLOG_ERROR, "Tunnel authorization error %s", error);
1012 freerdp_set_last_error_log(rdg->context, errorCode);
1013 return FALSE;
1014 }
1015
1016 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_REDIR_FLAGS)
1017 {
1018 UINT32 redirFlags = 0;
1019 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1020 return FALSE;
1021 Stream_Read_UINT32(s, redirFlags);
1022
1023 rdpContext* context = rdg->context;
1024 if (!utils_apply_gateway_policy(rdg->log, context, redirFlags, "RDG"))
1025 return FALSE;
1026 }
1027
1028 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_IDLE_TIMEOUT)
1029 {
1030 UINT32 idleTimeout = 0;
1031 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1032 return FALSE;
1033 Stream_Read_UINT32(s, idleTimeout);
1034 WLog_Print(rdg->log, WLOG_DEBUG, "[IDLE_TIMEOUT] idleTimeout=%" PRIu32 ": TODO: unused",
1035 idleTimeout);
1036 }
1037
1038 if (fieldsPresent & HTTP_TUNNEL_AUTH_RESPONSE_FIELD_SOH_RESPONSE)
1039 {
1040 UINT16 cbLen = 0;
1041 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1042 return FALSE;
1043 Stream_Read_UINT16(s, cbLen);
1044
1045 WLog_Print(rdg->log, WLOG_DEBUG, "[SOH_RESPONSE] cbLen=%" PRIu16 ": TODO: unused", cbLen);
1046 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, cbLen))
1047 return FALSE;
1048 Stream_Seek(s, cbLen);
1049 }
1050
1051 return rdg_send_channel_create(rdg);
1052}
1053
1054WINPR_ATTR_NODISCARD
1055static BOOL rdg_process_extauth_sspi(rdpRdg* rdg, wStream* s)
1056{
1057 INT32 errorCode = 0;
1058 UINT16 authBlobLen = 0;
1059 SecBuffer authToken = WINPR_C_ARRAY_INIT;
1060 BYTE* authTokenData = nullptr;
1061
1062 WINPR_ASSERT(rdg);
1063
1064 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1065 {
1066 WLog_Print(rdg->log, WLOG_ERROR, "EXTAUTH_SSPI_NTLM but rdpRdg::extAuth=false");
1067 return FALSE;
1068 }
1069
1070 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 6))
1071 return FALSE;
1072
1073 Stream_Read_INT32(s, errorCode);
1074 Stream_Read_UINT16(s, authBlobLen);
1075
1076 if (errorCode != ERROR_SUCCESS)
1077 {
1078 WLog_Print(rdg->log, WLOG_ERROR, "EXTAUTH_SSPI_NTLM failed with error %s [0x%08X]",
1079 GetSecurityStatusString(errorCode), WINPR_CXX_COMPAT_CAST(UINT32, errorCode));
1080 return FALSE;
1081 }
1082
1083 if (authBlobLen == 0)
1084 {
1085 if (credssp_auth_is_complete(rdg->auth))
1086 {
1087 credssp_auth_free(rdg->auth);
1088 rdg->auth = nullptr;
1089 return rdg_send_tunnel_request(rdg);
1090 }
1091 return FALSE;
1092 }
1093
1094 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, authBlobLen))
1095 return FALSE;
1096
1097 authTokenData = malloc(authBlobLen);
1098 if (authTokenData == nullptr)
1099 return FALSE;
1100 Stream_Read(s, authTokenData, authBlobLen);
1101
1102 authToken.pvBuffer = authTokenData;
1103 authToken.cbBuffer = authBlobLen;
1104
1105 credssp_auth_take_input_buffer(rdg->auth, &authToken);
1106
1107 if (credssp_auth_authenticate(rdg->auth) < 0)
1108 return FALSE;
1109
1110 if (credssp_auth_have_output_token(rdg->auth))
1111 return rdg_send_extauth_sspi(rdg);
1112
1113 return FALSE;
1114}
1115
1116WINPR_ATTR_NODISCARD
1117static BOOL rdg_process_channel_response_optional(rdpRdg* rdg, wStream* s, UINT16 fieldsPresent)
1118{
1119 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_CHANNELID) != 0)
1120 {
1121 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1122 return FALSE;
1123 const UINT32 channelId = Stream_Get_UINT32(s);
1124 WLog_Print(rdg->log, WLOG_DEBUG, "TODO: Got channelId=%" PRIu32, channelId);
1125 }
1126 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_UDPPORT) != 0)
1127 {
1128 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1129 return FALSE;
1130 const UINT16 udpPort = Stream_Get_UINT16(s);
1131 WLog_Print(rdg->log, WLOG_DEBUG, "TODO: Got udpPort=%" PRIu32, udpPort);
1132 }
1133 if ((fieldsPresent & HTTP_CHANNEL_RESPONSE_FIELD_AUTHNCOOKIE) != 0)
1134 {
1135 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 2))
1136 return FALSE;
1137 const UINT16 blobLen = Stream_Get_UINT16(s);
1138 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, blobLen))
1139 return FALSE;
1140 WLog_Print(rdg->log, WLOG_DEBUG, "TODO: Got UDP auth blob=%" PRIu32, blobLen);
1141 if (!Stream_SafeSeek(s, blobLen))
1142 return FALSE;
1143 }
1144
1145 return TRUE;
1146}
1147
1148WINPR_ATTR_NODISCARD
1149static BOOL rdg_process_channel_response(rdpRdg* rdg, wStream* s)
1150{
1151 UINT16 fieldsPresent = 0;
1152 UINT32 errorCode = 0;
1153 const char* error = nullptr;
1154 WLog_Print(rdg->log, WLOG_DEBUG, "Channel response received");
1155
1156 if (rdg->state != RDG_CLIENT_STATE_CHANNEL_CREATE)
1157 {
1158 return FALSE;
1159 }
1160
1161 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1162 return FALSE;
1163
1164 Stream_Read_UINT32(s, errorCode);
1165 Stream_Read_UINT16(s, fieldsPresent);
1166 Stream_Seek_UINT16(s); /* reserved */
1167 error = rpc_error_to_string(errorCode);
1168 WLog_Print(rdg->log, WLOG_DEBUG, "channel response errorCode=%s, fieldsPresent=%s", error,
1169 channel_response_fields_present_to_string(fieldsPresent));
1170
1171 if (FAILED((HRESULT)errorCode))
1172 {
1173 WLog_Print(rdg->log, WLOG_ERROR, "channel response errorCode=%s, fieldsPresent=%s", error,
1174 channel_response_fields_present_to_string(fieldsPresent));
1175 freerdp_set_last_error_log(rdg->context, errorCode);
1176 return FALSE;
1177 }
1178
1179 if (!rdg_process_channel_response_optional(rdg, s, fieldsPresent))
1180 return FALSE;
1181
1182 rdg->state = RDG_CLIENT_STATE_OPENED;
1183 return TRUE;
1184}
1185
1186WINPR_ATTR_NODISCARD
1187static BOOL rdg_process_packet(rdpRdg* rdg, wStream* s)
1188{
1189 BOOL status = TRUE;
1190 UINT16 type = 0;
1191 UINT32 packetLength = 0;
1192 Stream_ResetPosition(s);
1193
1194 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 8))
1195 return FALSE;
1196
1197 Stream_Read_UINT16(s, type);
1198 Stream_Seek_UINT16(s); /* reserved */
1199 Stream_Read_UINT32(s, packetLength);
1200
1201 if (Stream_Length(s) < packetLength)
1202 {
1203 WLog_Print(rdg->log, WLOG_ERROR, "Short packet %" PRIuz ", expected %" PRIu32,
1204 Stream_Length(s), packetLength);
1205 return FALSE;
1206 }
1207
1208 switch (type)
1209 {
1210 case PKT_TYPE_HANDSHAKE_RESPONSE:
1211 status = rdg_process_handshake_response(rdg, s);
1212 break;
1213
1214 case PKT_TYPE_TUNNEL_RESPONSE:
1215 status = rdg_process_tunnel_response(rdg, s);
1216 break;
1217
1218 case PKT_TYPE_TUNNEL_AUTH_RESPONSE:
1219 status = rdg_process_tunnel_authorization_response(rdg, s);
1220 break;
1221
1222 case PKT_TYPE_CHANNEL_RESPONSE:
1223 status = rdg_process_channel_response(rdg, s);
1224 break;
1225
1226 case PKT_TYPE_DATA:
1227 WLog_Print(rdg->log, WLOG_ERROR, "Unexpected packet type DATA");
1228 status = FALSE;
1229 break;
1230
1231 case PKT_TYPE_EXTENDED_AUTH_MSG:
1232 status = rdg_process_extauth_sspi(rdg, s);
1233 break;
1234
1235 default:
1236 WLog_Print(rdg->log, WLOG_ERROR, "PKG TYPE 0x%x not implemented", type);
1237 status = FALSE;
1238 break;
1239 }
1240
1241 if (status)
1242 {
1243 const size_t rem = Stream_GetRemainingLength(s);
1244 if (rem > 0)
1245 WLog_Print(rdg->log, WLOG_WARN, "[%s] unparsed data detected: %" PRIuz " bytes",
1246 rdg_pkt_type_to_string(type), rem);
1247 }
1248 return status;
1249}
1250
1251DWORD rdg_get_event_handles(rdpRdg* rdg, HANDLE* events, DWORD count)
1252{
1253 DWORD nCount = 0;
1254 WINPR_ASSERT(rdg != nullptr);
1255
1256 if (rdg->tlsOut && rdg->tlsOut->bio)
1257 {
1258 if (events && (nCount < count))
1259 {
1260 BIO_get_event(rdg->tlsOut->bio, &events[nCount]);
1261 nCount++;
1262 }
1263 else
1264 return 0;
1265 }
1266
1267 /* We just need the read event handle even in non-websocket mode. */
1268
1269 return nCount;
1270}
1271
1272WINPR_ATTR_NODISCARD
1273static BOOL rdg_get_gateway_credentials(rdpContext* context, rdp_auth_reason reason)
1274{
1275 freerdp* instance = context->instance;
1276
1277 auth_status rc = utils_authenticate_gateway(instance, reason);
1278 switch (rc)
1279 {
1280 case AUTH_SUCCESS:
1281 case AUTH_SKIP:
1282 return TRUE;
1283 case AUTH_CANCELLED:
1284 freerdp_set_last_error_log(instance->context, FREERDP_ERROR_CONNECT_CANCELLED);
1285 return FALSE;
1286 case AUTH_NO_CREDENTIALS:
1287 WLog_INFO(TAG, "No credentials provided - using nullptr identity");
1288 return TRUE;
1289 case AUTH_FAILED:
1290 default:
1291 return FALSE;
1292 }
1293}
1294
1295WINPR_ATTR_NODISCARD
1296static BOOL rdg_auth_init(rdpRdg* rdg, rdpTls* tls, TCHAR* authPkg)
1297{
1298 rdpContext* context = rdg->context;
1299 rdpSettings* settings = context->settings;
1300 SEC_WINNT_AUTH_IDENTITY identity = WINPR_C_ARRAY_INIT;
1301 int rc = 0;
1302
1303 rdg->auth = credssp_auth_new(context);
1304 if (!rdg->auth)
1305 return FALSE;
1306
1307 if (!credssp_auth_init(rdg->auth, authPkg, tls->Bindings))
1308 return FALSE;
1309
1310 BOOL doSCLogon = freerdp_settings_get_bool(settings, FreeRDP_SmartcardLogon);
1311 if (doSCLogon)
1312 {
1313 if (!smartcard_getCert(context, &rdg->smartcard, TRUE))
1314 return FALSE;
1315
1316 if (!rdg_get_gateway_credentials(context, AUTH_SMARTCARD_PIN))
1317 return FALSE;
1318 }
1319 else
1320 {
1321 if (!rdg_get_gateway_credentials(context, GW_AUTH_RDG))
1322 return FALSE;
1323
1324 /* Auth callback might changed logon to smartcard so check again */
1325 doSCLogon = freerdp_settings_get_bool(settings, FreeRDP_SmartcardLogon);
1326 if (doSCLogon && !smartcard_getCert(context, &rdg->smartcard, TRUE))
1327 return FALSE;
1328 }
1329
1330 SEC_WINNT_AUTH_IDENTITY* identityArg = &identity;
1331 if (doSCLogon)
1332 {
1333 if (!identity_set_from_smartcard_hash(&identity, settings, FreeRDP_GatewayUsername,
1334 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword,
1335 rdg->smartcard->sha1Hash,
1336 sizeof(rdg->smartcard->sha1Hash)))
1337 return FALSE;
1338 }
1339 else
1340 {
1341 if (!identity_set_from_settings(&identity, settings, FreeRDP_GatewayUsername,
1342 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword))
1343 return FALSE;
1344
1345 if (!settings->GatewayUsername)
1346 identityArg = nullptr;
1347 }
1348
1349 if (!credssp_auth_setup_client(rdg->auth, "HTTP", settings->GatewayHostname, identityArg,
1350 rdg->smartcard ? rdg->smartcard->pkinitArgs : nullptr))
1351 {
1352 sspi_FreeAuthIdentity(&identity);
1353 return FALSE;
1354 }
1355 sspi_FreeAuthIdentity(&identity);
1356
1357 credssp_auth_set_flags(rdg->auth, ISC_REQ_CONFIDENTIALITY | ISC_REQ_MUTUAL_AUTH);
1358
1359 rc = credssp_auth_authenticate(rdg->auth);
1360 return (rc >= 0);
1361}
1362
1363WINPR_ATTR_NODISCARD
1364static BOOL rdg_send_http_request(rdpRdg* rdg, rdpTls* tls, const char* method,
1365 TRANSFER_ENCODING transferEncoding)
1366{
1367 int status = -1;
1368 wStream* s = rdg_build_http_request(rdg, method, transferEncoding);
1369
1370 if (!s)
1371 return FALSE;
1372
1373 const size_t sz = Stream_Length(s);
1374 status = freerdp_tls_write_all(tls, Stream_Buffer(s), sz);
1375
1376 Stream_Free(s, TRUE);
1377 return (status >= 0);
1378}
1379
1380WINPR_ATTR_NODISCARD
1381static BOOL rdg_tls_connect(rdpRdg* rdg, rdpTls* tls, const char* peerAddress, UINT32 timeout)
1382{
1383 long status = 0;
1384 BIO* layerBio = nullptr;
1385 BIO* bufferedBio = nullptr;
1386 rdpTransportLayer* layer = nullptr;
1387 rdpSettings* settings = rdg->context->settings;
1388 rdpTransport* transport = freerdp_get_transport(rdg->context);
1389 const char* peerHostname = settings->GatewayHostname;
1390 UINT16 peerPort = (UINT16)settings->GatewayPort;
1391 const char* proxyUsername = nullptr;
1392 const char* proxyPassword = nullptr;
1393 BOOL isProxyConnection =
1394 proxy_prepare(settings, &peerHostname, &peerPort, &proxyUsername, &proxyPassword);
1395
1396 if (settings->GatewayPort > UINT16_MAX)
1397 return FALSE;
1398
1399 layer = transport_connect_layer(transport, peerAddress ? peerAddress : peerHostname, peerPort,
1400 timeout);
1401
1402 if (!layer)
1403 {
1404 return FALSE;
1405 }
1406
1407 layerBio = BIO_new(BIO_s_transport_layer());
1408 if (!layerBio)
1409 {
1410 transport_layer_free(layer);
1411 return FALSE;
1412 }
1413 BIO_set_data(layerBio, layer);
1414
1415 bufferedBio = BIO_new(BIO_s_buffered_socket());
1416 if (!bufferedBio)
1417 {
1418 BIO_free_all(layerBio);
1419 return FALSE;
1420 }
1421
1422 bufferedBio = BIO_push(bufferedBio, layerBio);
1423 status = BIO_set_nonblock(bufferedBio, TRUE);
1424
1425 if (isProxyConnection)
1426 {
1427 if (!proxy_connect(rdg->context, bufferedBio, proxyUsername, proxyPassword,
1428 settings->GatewayHostname, (UINT16)settings->GatewayPort))
1429 {
1430 BIO_free_all(bufferedBio);
1431 return FALSE;
1432 }
1433 }
1434
1435 if (!status)
1436 {
1437 BIO_free_all(bufferedBio);
1438 return FALSE;
1439 }
1440
1441 tls->hostname = settings->GatewayHostname;
1442 tls->port = WINPR_ASSERTING_INT_CAST(int32_t, MIN(UINT16_MAX, settings->GatewayPort));
1443 tls->isGatewayTransport = TRUE;
1444 status = freerdp_tls_connect(tls, bufferedBio);
1445 if (status < 1)
1446 {
1447 rdpContext* context = rdg->context;
1448 if (status < 0)
1449 {
1450 freerdp_set_last_error_if_not(context, FREERDP_ERROR_TLS_CONNECT_FAILED);
1451 }
1452 else
1453 {
1454 freerdp_set_last_error_if_not(context, FREERDP_ERROR_CONNECT_CANCELLED);
1455 }
1456
1457 return FALSE;
1458 }
1459 return (status >= 1);
1460}
1461
1462WINPR_ATTR_NODISCARD
1463static BOOL rdg_establish_data_connection(rdpRdg* rdg, rdpTls* tls, const char* method,
1464 const char* peerAddress, UINT32 timeout,
1465 BOOL* rpcFallback)
1466{
1467 char buffer[64] = WINPR_C_ARRAY_INIT;
1468 HttpResponse* response = nullptr;
1469
1470 if (!rdg_tls_connect(rdg, tls, peerAddress, timeout))
1471 return FALSE;
1472
1473 WINPR_ASSERT(rpcFallback);
1474 if (rdg->context->settings->GatewayHttpExtAuthBearer && rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1475 rdg->extAuth = HTTP_EXTENDED_AUTH_BEARER;
1476 if (rdg->extAuth == HTTP_EXTENDED_AUTH_NONE)
1477 {
1478 if (!rdg_auth_init(rdg, tls, AUTH_PKG))
1479 return FALSE;
1480
1481 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1482 return FALSE;
1483
1484 response = http_response_recv(tls, TRUE);
1485 /* MS RD Gateway seems to just terminate the tls connection without
1486 * sending an answer if it is not happy with the http request */
1487 if (!response)
1488 {
1489 WLog_Print(rdg->log, WLOG_INFO, "RD Gateway HTTP transport broken.");
1490 *rpcFallback = TRUE;
1491 return FALSE;
1492 }
1493
1494 (void)http_response_extract_cookies(response, rdg->http);
1495
1496 const UINT16 StatusCode = http_response_get_status_code(response);
1497 switch (StatusCode)
1498 {
1499 case HTTP_STATUS_GONE:
1500 case HTTP_STATUS_FORBIDDEN:
1501 case HTTP_STATUS_NOT_FOUND:
1502 {
1503 WLog_Print(rdg->log, WLOG_INFO, "RD Gateway does not support HTTP transport.");
1504 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1505 *rpcFallback = TRUE;
1506
1507 http_response_free(response);
1508 return FALSE;
1509 }
1510 case HTTP_STATUS_OK:
1511 break;
1512
1513 case HTTP_STATUS_DENIED:
1514 http_response_log_error_status(rdg->log, WLOG_DEBUG, response);
1515 break;
1516
1517 default:
1518 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1519 break;
1520 }
1521
1522 while (!credssp_auth_is_complete(rdg->auth))
1523 {
1524 BOOL haveToken = FALSE;
1525
1526 if (!rdg_recv_auth_token(rdg->log, rdg->auth, response, &haveToken))
1527 {
1528 http_response_free(response);
1529 return FALSE;
1530 }
1531
1532 if (!haveToken)
1533 {
1534 /* The server answered without an authentication token, so there is nothing left
1535 * to negotiate. If it still refuses the request the status handling below reports
1536 * that; otherwise the authentication succeeded as far as the transport is
1537 * concerned, and the security context freed just below is not needed any more.
1538 *
1539 * MS RD Gateway takes this path when it answers the last authentication request
1540 * with the WebSocket upgrade: an HTTP 101 response carries no WWW-Authenticate
1541 * header, so a mechanism still waiting for a final token, such as Kerberos waiting
1542 * for the AP_REP, never reports SEC_E_OK. */
1543 WLog_Print(rdg->log, WLOG_DEBUG,
1544 "No authentication token in the response, ending the exchange");
1545 break;
1546 }
1547
1548 if (credssp_auth_have_output_token(rdg->auth))
1549 {
1550 http_response_free(response);
1551
1552 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1553 return FALSE;
1554
1555 response = http_response_recv(tls, TRUE);
1556 if (!response)
1557 {
1558 WLog_Print(rdg->log, WLOG_INFO, "RD Gateway HTTP transport broken.");
1559 *rpcFallback = TRUE;
1560 return FALSE;
1561 }
1562 (void)http_response_extract_cookies(response, rdg->http);
1563 }
1564 else
1565 break; /* nothing more to send: do not re-parse the same response */
1566 }
1567 credssp_auth_free(rdg->auth);
1568 rdg->auth = nullptr;
1569 }
1570 else
1571 {
1572 credssp_auth_free(rdg->auth);
1573 rdg->auth = nullptr;
1574
1575 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingIdentity))
1576 return FALSE;
1577
1578 response = http_response_recv(tls, TRUE);
1579
1580 if (!response)
1581 {
1582 WLog_Print(rdg->log, WLOG_INFO, "RD Gateway HTTP transport broken.");
1583 *rpcFallback = TRUE;
1584 return FALSE;
1585 }
1586 (void)http_response_extract_cookies(response, rdg->http);
1587 }
1588
1589 const UINT16 statusCode = http_response_get_status_code(response);
1590 const size_t bodyLength = http_response_get_body_length(response);
1591 const TRANSFER_ENCODING encoding = http_response_get_transfer_encoding(response);
1592 const BOOL isWebsocket = http_response_is_websocket(rdg->http, response);
1593
1594 WLog_Print(rdg->log, WLOG_DEBUG, "%s authorization result: %s", method,
1595 freerdp_http_status_string_format(statusCode, buffer, ARRAYSIZE(buffer)));
1596
1597 switch (statusCode)
1598 {
1599 case HTTP_STATUS_OK:
1600 /* old rdg endpoint without websocket support, don't request websocket for RDG_IN_DATA
1601 */
1602 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1603 http_response_free(response);
1604 break;
1605 case HTTP_STATUS_DENIED:
1606 freerdp_set_last_error_log(rdg->context, FREERDP_ERROR_CONNECT_ACCESS_DENIED);
1607 http_response_free(response);
1608 return FALSE;
1609 case HTTP_STATUS_SWITCH_PROTOCOLS:
1610 http_response_free(response);
1611 if (!isWebsocket)
1612 {
1613 /*
1614 * webserver is broken, a fallback may be possible here
1615 * but only if already tested with oppurtonistic upgrade
1616 */
1617 if (http_context_is_websocket_upgrade_enabled(rdg->http))
1618 {
1619 long fd = BIO_get_fd(tls->bio, nullptr);
1620 if (fd >= 0)
1621 closesocket((SOCKET)fd);
1622 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1623 return rdg_establish_data_connection(rdg, tls, method, peerAddress, timeout,
1624 rpcFallback);
1625 }
1626 return FALSE;
1627 }
1628
1629 rdg->transferEncoding.isWebsocketTransport = TRUE;
1630 if (!websocket_context_reset(rdg->transferEncoding.context.websocket))
1631 return FALSE;
1632
1633 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1634 {
1635 /* create a new auth context for SSPI_NTLM. This must be done after the last
1636 * rdg_send_http_request */
1637 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1638 return FALSE;
1639 }
1640 return TRUE;
1641 default:
1642 http_response_log_error_status(rdg->log, WLOG_WARN, response);
1643 http_response_free(response);
1644 return FALSE;
1645 }
1646
1647 if (strcmp(method, "RDG_OUT_DATA") == 0)
1648 {
1649 if (encoding == TransferEncodingChunked)
1650 {
1651 rdg->transferEncoding.httpTransferEncoding = TransferEncodingChunked;
1652 rdg->transferEncoding.context.chunked.nextOffset = 0;
1653 rdg->transferEncoding.context.chunked.headerFooterPos = 0;
1654 rdg->transferEncoding.context.chunked.state = ChunkStateLenghHeader;
1655 }
1656 if (!rdg_skip_seed_payload(rdg->context, tls, bodyLength, &rdg->transferEncoding))
1657 {
1658 return FALSE;
1659 }
1660 }
1661 else
1662 {
1663 if (!rdg_send_http_request(rdg, tls, method, TransferEncodingChunked))
1664 return FALSE;
1665
1666 if (rdg->extAuth == HTTP_EXTENDED_AUTH_SSPI_NTLM)
1667 {
1668 /* create a new auth context for SSPI_NTLM. This must be done after the last
1669 * rdg_send_http_request (RDG_IN_DATA is always after RDG_OUT_DATA) */
1670 if (!rdg_auth_init(rdg, tls, NTLM_SSP_NAME))
1671 return FALSE;
1672 }
1673 }
1674
1675 return TRUE;
1676}
1677
1678WINPR_ATTR_NODISCARD
1679static BOOL rdg_tunnel_connect(rdpRdg* rdg)
1680{
1681 if (!rdg_send_handshake(rdg))
1682 return FALSE;
1683
1684 while (rdg->state < RDG_CLIENT_STATE_OPENED)
1685 {
1686 BOOL status = FALSE;
1687 wStream* s = rdg_receive_packet(rdg);
1688
1689 if (s)
1690 {
1691 status = rdg_process_packet(rdg, s);
1692 Stream_Free(s, TRUE);
1693 }
1694
1695 if (!status)
1696 {
1697 WINPR_ASSERT(rdg);
1698 WINPR_ASSERT(rdg->context);
1699 WINPR_ASSERT(rdg->context->rdp);
1700 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1701 return FALSE;
1702 }
1703 }
1704
1705 return TRUE;
1706}
1707
1708BOOL rdg_connect(rdpRdg* rdg, DWORD timeout, BOOL* rpcFallback)
1709{
1710 BOOL status = 0;
1711 SOCKET outConnSocket = 0;
1712 char* peerAddress = nullptr;
1713 BOOL rpcFallbackLocal = FALSE;
1714
1715 WINPR_ASSERT(rdg != nullptr);
1716 freerdp_set_last_error(rdg->context, ERROR_SUCCESS);
1717 status = rdg_establish_data_connection(rdg, rdg->tlsOut, "RDG_OUT_DATA", nullptr, timeout,
1718 &rpcFallbackLocal);
1719
1720 if (status)
1721 {
1722 if (rdg->transferEncoding.isWebsocketTransport)
1723 {
1724 WLog_Print(rdg->log, WLOG_DEBUG, "Upgraded to websocket. RDG_IN_DATA not required");
1725 }
1726 else
1727 {
1728 /* Establish IN connection with the same peer/server as OUT connection,
1729 * even when server hostname resolves to different IP addresses.
1730 */
1731 BIO_get_socket(rdg->tlsOut->underlying, &outConnSocket);
1732 peerAddress = freerdp_tcp_get_peer_address(outConnSocket);
1733 status = rdg_establish_data_connection(rdg, rdg->tlsIn, "RDG_IN_DATA", peerAddress,
1734 timeout, &rpcFallbackLocal);
1735 free(peerAddress);
1736 }
1737 }
1738
1739 if (rpcFallback)
1740 *rpcFallback = rpcFallbackLocal;
1741
1742 if (!status)
1743 {
1744 WINPR_ASSERT(rdg);
1745 WINPR_ASSERT(rdg->context);
1746 WINPR_ASSERT(rdg->context->rdp);
1747 if (rpcFallbackLocal)
1748 {
1749 http_context_enable_websocket_upgrade(rdg->http, FALSE);
1750 credssp_auth_free(rdg->auth);
1751 rdg->auth = nullptr;
1752 }
1753
1754 transport_set_layer(rdg->context->rdp->transport, TRANSPORT_LAYER_CLOSED);
1755 return FALSE;
1756 }
1757
1758 status = rdg_tunnel_connect(rdg);
1759
1760 return (status);
1761}
1762
1763WINPR_ATTR_NODISCARD
1764static int rdg_write_websocket_data_packet(rdpRdg* rdg, const BYTE* buf, int isize)
1765{
1766 WINPR_ASSERT(rdg);
1767 if (isize < 0)
1768 return -1;
1769
1770 const size_t payloadSize = (size_t)isize + 10;
1771 union
1772 {
1773 UINT32 u32;
1774 UINT8 u8[4];
1775 } maskingKey;
1776
1777 wStream* sWS =
1778 websocket_context_packet_new(payloadSize, WebsocketBinaryOpcode, &maskingKey.u32);
1779 if (!sWS)
1780 return -1;
1781
1782 Stream_Write_UINT16(
1783 sWS, WINPR_ASSERTING_INT_CAST(
1784 uint16_t, PKT_TYPE_DATA ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8))); /* Type */
1785 Stream_Write_UINT16(
1786 sWS, WINPR_ASSERTING_INT_CAST(
1787 uint16_t, 0 ^ (maskingKey.u8[2] | maskingKey.u8[3] << 8))); /* Reserved */
1788 Stream_Write_UINT32(
1789 sWS, WINPR_ASSERTING_INT_CAST(uint32_t, payloadSize ^ maskingKey.u32)); /* Packet length */
1790 Stream_Write_UINT16(
1791 sWS, WINPR_ASSERTING_INT_CAST(
1792 uint16_t, isize ^ (maskingKey.u8[0] | maskingKey.u8[1] << 8))); /* Data size */
1793
1794 /* masking key is now off by 2 bytes. fix that */
1795 maskingKey.u32 = (maskingKey.u32 & 0xffff) << 16 | (maskingKey.u32 >> 16);
1796
1797 WINPR_ASSERT(rdg->tlsOut);
1798 wStream sPacket = WINPR_C_ARRAY_INIT;
1799 Stream_StaticConstInit(&sPacket, buf, (size_t)isize);
1800 if (!websocket_context_mask_and_send(rdg->tlsOut->bio, sWS, &sPacket, maskingKey.u32))
1801 return -1;
1802
1803 return isize;
1804}
1805
1806WINPR_ATTR_NODISCARD
1807static int rdg_write_chunked_data_packet(rdpRdg* rdg, const BYTE* buf, int isize)
1808{
1809 int status = 0;
1810 size_t len = 0;
1811 wStream* sChunk = nullptr;
1812
1813 if (isize > UINT16_MAX)
1814 return -1;
1815
1816 const size_t size = (size_t)isize;
1817 if (size < 1)
1818 return 0;
1819
1820 const size_t packetSize = size + 10;
1821 char chunkSize[11] = WINPR_C_ARRAY_INIT;
1822 (void)sprintf_s(chunkSize, sizeof(chunkSize), "%" PRIxz "\r\n", packetSize);
1823 sChunk = Stream_New(nullptr, strnlen(chunkSize, sizeof(chunkSize)) + packetSize + 2);
1824
1825 if (!sChunk)
1826 return -1;
1827
1828 Stream_Write(sChunk, chunkSize, strnlen(chunkSize, sizeof(chunkSize)));
1829 Stream_Write_UINT16(sChunk, PKT_TYPE_DATA); /* Type */
1830 Stream_Write_UINT16(sChunk, 0); /* Reserved */
1831 Stream_Write_UINT32(sChunk, (UINT32)packetSize); /* Packet length */
1832 Stream_Write_UINT16(sChunk, (UINT16)size); /* Data size */
1833 Stream_Write(sChunk, buf, size); /* Data */
1834 Stream_Write(sChunk, "\r\n", 2);
1835 Stream_SealLength(sChunk);
1836 len = Stream_Length(sChunk);
1837
1838 status = freerdp_tls_write_all(rdg->tlsIn, Stream_Buffer(sChunk), len);
1839 Stream_Free(sChunk, TRUE);
1840
1841 if (status < 0)
1842 return -1;
1843
1844 return (int)size;
1845}
1846
1847WINPR_ATTR_NODISCARD
1848static int rdg_write_data_packet(rdpRdg* rdg, const BYTE* buf, int isize)
1849{
1850 WINPR_ASSERT(rdg);
1851 if (rdg->transferEncoding.isWebsocketTransport)
1852 return rdg_write_websocket_data_packet(rdg, buf, isize);
1853 else
1854 return rdg_write_chunked_data_packet(rdg, buf, isize);
1855}
1856
1857WINPR_ATTR_NODISCARD
1858static BOOL rdg_process_close_packet(rdpRdg* rdg, wStream* s)
1859{
1860 int status = -1;
1861 wStream* sClose = nullptr;
1862 UINT32 errorCode = 0;
1863 UINT32 packetSize = 12;
1864
1865 /* Read error code */
1866 if (!Stream_CheckAndLogRequiredLengthWLog(rdg->log, s, 4))
1867 return FALSE;
1868 Stream_Read_UINT32(s, errorCode);
1869
1870 if (errorCode != 0)
1871 freerdp_set_last_error_log(rdg->context, errorCode);
1872
1873 sClose = Stream_New(nullptr, packetSize);
1874 if (!sClose)
1875 return FALSE;
1876
1877 Stream_Write_UINT16(sClose, PKT_TYPE_CLOSE_CHANNEL_RESPONSE); /* Type */
1878 Stream_Write_UINT16(sClose, 0); /* Reserved */
1879 Stream_Write_UINT32(sClose, packetSize); /* Packet length */
1880 Stream_Write_UINT32(sClose, 0); /* Status code */
1881 Stream_SealLength(sClose);
1882 status = rdg_write_packet(rdg, sClose);
1883 Stream_Free(sClose, TRUE);
1884
1885 return ((status >= 0));
1886}
1887
1888WINPR_ATTR_NODISCARD
1889static BOOL rdg_process_keep_alive_packet(rdpRdg* rdg)
1890{
1891 int status = -1;
1892 wStream* sKeepAlive = nullptr;
1893 size_t packetSize = 8;
1894
1895 sKeepAlive = Stream_New(nullptr, packetSize);
1896
1897 if (!sKeepAlive)
1898 return FALSE;
1899
1900 Stream_Write_UINT16(sKeepAlive, PKT_TYPE_KEEPALIVE); /* Type */
1901 Stream_Write_UINT16(sKeepAlive, 0); /* Reserved */
1902 Stream_Write_UINT32(sKeepAlive, (UINT32)packetSize); /* Packet length */
1903 Stream_SealLength(sKeepAlive);
1904 status = rdg_write_packet(rdg, sKeepAlive);
1905 Stream_Free(sKeepAlive, TRUE);
1906
1907 return ((status >= 0));
1908}
1909
1910WINPR_ATTR_NODISCARD
1911static BOOL rdg_process_service_message(rdpRdg* rdg, wStream* s)
1912{
1913 const WCHAR* msg = nullptr;
1914 UINT16 msgLenBytes = 0;
1915 rdpContext* context = rdg->context;
1916 WINPR_ASSERT(context);
1917 WINPR_ASSERT(context->instance);
1918
1919 /* Read message string */
1920 if (!rdg_read_http_unicode_string(rdg->log, s, &msg, &msgLenBytes))
1921 {
1922 WLog_Print(rdg->log, WLOG_ERROR, "Failed to read string");
1923 return FALSE;
1924 }
1925
1926 return IFCALLRESULT(TRUE, context->instance->PresentGatewayMessage, context->instance,
1927 GATEWAY_MESSAGE_SERVICE, TRUE, FALSE, msgLenBytes, msg);
1928}
1929
1930WINPR_ATTR_NODISCARD
1931static BOOL rdg_process_unknown_packet(rdpRdg* rdg, int type)
1932{
1933 WINPR_UNUSED(rdg);
1934 WINPR_UNUSED(type);
1935 WLog_Print(rdg->log, WLOG_WARN, "Unknown Control Packet received: %" PRIX32,
1936 WINPR_CXX_COMPAT_CAST(UINT32, type));
1937 return TRUE;
1938}
1939
1940WINPR_ATTR_NODISCARD
1941static BOOL rdg_process_control_packet(rdpRdg* rdg, int type, size_t packetLength)
1942{
1943 wStream* s = nullptr;
1944 size_t readCount = 0;
1945 int status = 0;
1946 size_t payloadSize = packetLength - sizeof(RdgPacketHeader);
1947
1948 if (packetLength < sizeof(RdgPacketHeader))
1949 return FALSE;
1950
1951 // NOLINTNEXTLINE(bugprone-sizeof-expression)
1952 WINPR_ASSERT(sizeof(RdgPacketHeader) < INT_MAX);
1953
1954 if (payloadSize)
1955 {
1956 s = Stream_New(nullptr, payloadSize);
1957
1958 if (!s)
1959 return FALSE;
1960
1961 while (readCount < payloadSize)
1962 {
1963 if (rdg_shall_abort(rdg))
1964 {
1965 Stream_Free(s, TRUE);
1966 return FALSE;
1967 }
1968 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context, Stream_Pointer(s),
1969 payloadSize - readCount, &rdg->transferEncoding);
1970
1971 if (status <= 0)
1972 {
1973 if (!BIO_should_retry(rdg->tlsOut->bio))
1974 {
1975 Stream_Free(s, TRUE);
1976 return FALSE;
1977 }
1978
1979 BIO_wait_read(rdg->tlsOut->bio, 50);
1980 continue;
1981 }
1982
1983 Stream_Seek(s, (size_t)status);
1984 readCount += (size_t)status;
1985
1986 if (readCount > INT_MAX)
1987 {
1988 Stream_Free(s, TRUE);
1989 return FALSE;
1990 }
1991 }
1992
1993 Stream_ResetPosition(s);
1994 }
1995
1996 switch (type)
1997 {
1998 case PKT_TYPE_CLOSE_CHANNEL:
1999 if (!s)
2000 {
2001 WLog_Print(rdg->log, WLOG_ERROR,
2002 "PKT_TYPE_CLOSE_CHANNEL requires payload but none was sent");
2003 return FALSE;
2004 }
2005 EnterCriticalSection(&rdg->writeSection);
2006 status = rdg_process_close_packet(rdg, s);
2007 LeaveCriticalSection(&rdg->writeSection);
2008 break;
2009
2010 case PKT_TYPE_KEEPALIVE:
2011 EnterCriticalSection(&rdg->writeSection);
2012 status = rdg_process_keep_alive_packet(rdg);
2013 LeaveCriticalSection(&rdg->writeSection);
2014 break;
2015
2016 case PKT_TYPE_SERVICE_MESSAGE:
2017 if (!s)
2018 {
2019 WLog_Print(rdg->log, WLOG_ERROR,
2020 "PKT_TYPE_SERVICE_MESSAGE requires payload but none was sent");
2021 return FALSE;
2022 }
2023 status = rdg_process_service_message(rdg, s);
2024 break;
2025
2026 case PKT_TYPE_REAUTH_MESSAGE:
2027 default:
2028 status = rdg_process_unknown_packet(rdg, type);
2029 break;
2030 }
2031
2032 Stream_Free(s, TRUE);
2033 return status;
2034}
2035
2036WINPR_ATTR_NODISCARD
2037static int rdg_read_data_packet(rdpRdg* rdg, BYTE* buffer, size_t size)
2038{
2039 RdgPacketHeader header = WINPR_C_ARRAY_INIT;
2040 size_t readCount = 0;
2041 size_t readSize = 0;
2042 int status = 0;
2043
2044 if (!rdg->packetRemainingCount)
2045 {
2046 // NOLINTNEXTLINE(bugprone-sizeof-expression)
2047 WINPR_ASSERT(sizeof(RdgPacketHeader) < INT_MAX);
2048
2049 while (readCount < sizeof(RdgPacketHeader))
2050 {
2051 if (rdg_shall_abort(rdg))
2052 return -1;
2053
2054 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context, (BYTE*)(&header) + readCount,
2055 sizeof(RdgPacketHeader) - readCount, &rdg->transferEncoding);
2056
2057 if (status <= 0)
2058 {
2059 if (!BIO_should_retry(rdg->tlsOut->bio))
2060 return -1;
2061
2062 BIO_wait_read(rdg->tlsOut->bio, 50);
2063 continue;
2064 }
2065
2066 readCount += (size_t)status;
2067
2068 if (readCount > INT_MAX)
2069 return -1;
2070 }
2071
2072 if (header.type != PKT_TYPE_DATA)
2073 {
2074 status = rdg_process_control_packet(rdg, header.type, header.packetLength);
2075
2076 if (!status)
2077 return -1;
2078
2079 return 0;
2080 }
2081
2082 readCount = 0;
2083
2084 while (readCount < 2)
2085 {
2086 if (rdg_shall_abort(rdg))
2087 return -1;
2088 status = rdg_socket_read(rdg->tlsOut->bio, rdg->context,
2089 (BYTE*)(&rdg->packetRemainingCount) + readCount, 2 - readCount,
2090 &rdg->transferEncoding);
2091
2092 if (status <= 0)
2093 {
2094 if (!BIO_should_retry(rdg->tlsOut->bio))
2095 return -1;
2096
2097 BIO_wait_read(rdg->tlsOut->bio, 50);
2098 continue;
2099 }
2100
2101 readCount += (size_t)status;
2102 }
2103 }
2104
2105 readSize = (rdg->packetRemainingCount < size) ? rdg->packetRemainingCount : size;
2106 status =
2107 rdg_socket_read(rdg->tlsOut->bio, rdg->context, buffer, readSize, &rdg->transferEncoding);
2108
2109 if (status <= 0)
2110 {
2111 if (!BIO_should_retry(rdg->tlsOut->bio))
2112 return -1;
2113
2114 return 0;
2115 }
2116
2117 rdg->packetRemainingCount -= status;
2118 return status;
2119}
2120
2121WINPR_ATTR_NODISCARD
2122static int rdg_bio_write(BIO* bio, const char* buf, int num)
2123{
2124 int status = 0;
2125 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2126 if (num < 0)
2127 return num;
2128
2129 BIO_clear_flags(bio, BIO_FLAGS_WRITE);
2130 EnterCriticalSection(&rdg->writeSection);
2131 status = rdg_write_data_packet(rdg, (const BYTE*)buf, num);
2132 LeaveCriticalSection(&rdg->writeSection);
2133
2134 if (status < 0)
2135 {
2136 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2137 return -1;
2138 }
2139 else if (status < num)
2140 {
2141 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2142 WSASetLastError(WSAEWOULDBLOCK);
2143 }
2144 else
2145 {
2146 BIO_set_flags(bio, BIO_FLAGS_WRITE);
2147 }
2148
2149 return status;
2150}
2151
2152WINPR_ATTR_NODISCARD
2153static int rdg_bio_read(BIO* bio, char* buf, int size)
2154{
2155 int status = 0;
2156 rdpRdg* rdg = (rdpRdg*)BIO_get_data(bio);
2157 if (size < 0)
2158 return size;
2159 status = rdg_read_data_packet(rdg, (BYTE*)buf, (size_t)size);
2160
2161 if (status < 0)
2162 {
2163 BIO_clear_retry_flags(bio);
2164 return -1;
2165 }
2166 else if (status == 0)
2167 {
2168 BIO_set_retry_read(bio);
2169 WSASetLastError(WSAEWOULDBLOCK);
2170 return -1;
2171 }
2172 else
2173 {
2174 BIO_set_flags(bio, BIO_FLAGS_READ);
2175 }
2176
2177 return status;
2178}
2179
2180WINPR_ATTR_NODISCARD
2181static int rdg_bio_puts(BIO* bio, const char* str)
2182{
2183 WINPR_UNUSED(bio);
2184 WINPR_UNUSED(str);
2185 return -2;
2186}
2187
2188WINPR_ATTR_NODISCARD
2189// NOLINTNEXTLINE(readability-non-const-parameter)
2190static int rdg_bio_gets(BIO* bio, char* str, int size)
2191{
2192 WINPR_UNUSED(bio);
2193 WINPR_UNUSED(str);
2194 WINPR_UNUSED(size);
2195 return -2;
2196}
2197
2198WINPR_ATTR_NODISCARD
2199static long rdg_bio_ctrl(BIO* in_bio, int cmd, long arg1, void* arg2)
2200{
2201 long status = -1;
2202 rdpRdg* rdg = (rdpRdg*)BIO_get_data(in_bio);
2203 rdpTls* tlsOut = rdg->tlsOut;
2204 rdpTls* tlsIn = rdg->tlsIn;
2205
2206 if (cmd == BIO_CTRL_FLUSH)
2207 {
2208 (void)BIO_flush(tlsOut->bio);
2209 if (!rdg->transferEncoding.isWebsocketTransport)
2210 (void)BIO_flush(tlsIn->bio);
2211 status = 1;
2212 }
2213 else if (cmd == BIO_C_SET_NONBLOCK)
2214 {
2215 status = 1;
2216 }
2217 else if (cmd == BIO_C_READ_BLOCKED)
2218 {
2219 BIO* cbio = tlsOut->bio;
2220 status = BIO_read_blocked(cbio);
2221 }
2222 else if (cmd == BIO_C_WRITE_BLOCKED)
2223 {
2224 BIO* cbio = tlsIn->bio;
2225
2226 if (rdg->transferEncoding.isWebsocketTransport)
2227 cbio = tlsOut->bio;
2228
2229 status = BIO_write_blocked(cbio);
2230 }
2231 else if (cmd == BIO_C_WAIT_READ)
2232 {
2233 int timeout = (int)arg1;
2234 BIO* cbio = tlsOut->bio;
2235
2236 if (BIO_read_blocked(cbio))
2237 return BIO_wait_read(cbio, timeout);
2238 else if (BIO_write_blocked(cbio))
2239 return BIO_wait_write(cbio, timeout);
2240 else
2241 status = 1;
2242 }
2243 else if (cmd == BIO_C_WAIT_WRITE)
2244 {
2245 int timeout = (int)arg1;
2246 BIO* cbio = tlsIn->bio;
2247
2248 if (rdg->transferEncoding.isWebsocketTransport)
2249 cbio = tlsOut->bio;
2250
2251 if (BIO_write_blocked(cbio))
2252 status = BIO_wait_write(cbio, timeout);
2253 else if (BIO_read_blocked(cbio))
2254 status = BIO_wait_read(cbio, timeout);
2255 else
2256 status = 1;
2257 }
2258 else if (cmd == BIO_C_GET_EVENT || cmd == BIO_C_GET_FD)
2259 {
2260 /*
2261 * A note about BIO_C_GET_FD:
2262 * Even if two FDs are part of RDG, only one FD can be returned here.
2263 *
2264 * In FreeRDP, BIO FDs are only used for polling, so it is safe to use the outgoing FD only
2265 *
2266 * See issue #3602
2267 */
2268 status = BIO_ctrl(tlsOut->bio, cmd, arg1, arg2);
2269 }
2270#if OPENSSL_VERSION_NUMBER >= 0x30000000L
2271 else if (cmd == BIO_CTRL_GET_KTLS_SEND)
2272 {
2273 /* Even though BIO_get_ktls_send says that returning negative values is valid
2274 * openssl internal sources are full of if(!BIO_get_ktls_send && ) stuff. This has some
2275 * nasty sideeffects. return 0 as proper no KTLS offloading flag
2276 */
2277 status = 0;
2278 }
2279 else if (cmd == BIO_CTRL_GET_KTLS_RECV)
2280 {
2281 /* Even though BIO_get_ktls_recv says that returning negative values is valid
2282 * there is no reason to trust trust negative values are implemented right everywhere
2283 */
2284 status = 0;
2285 }
2286#endif
2287 return status;
2288}
2289
2290WINPR_ATTR_NODISCARD
2291static int rdg_bio_new(BIO* bio)
2292{
2293 BIO_set_init(bio, 1);
2294 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
2295 return 1;
2296}
2297
2298WINPR_ATTR_NODISCARD
2299static int rdg_bio_free(BIO* bio)
2300{
2301 WINPR_UNUSED(bio);
2302 return 1;
2303}
2304
2305WINPR_ATTR_NODISCARD
2306static BIO_METHOD* BIO_s_rdg(void)
2307{
2308 static BIO_METHOD* bio_methods = nullptr;
2309
2310 if (bio_methods == nullptr)
2311 {
2312 if (!(bio_methods = BIO_meth_new(BIO_TYPE_TSG, "RDGateway")))
2313 return nullptr;
2314
2315 BIO_meth_set_write(bio_methods, rdg_bio_write);
2316 BIO_meth_set_read(bio_methods, rdg_bio_read);
2317 BIO_meth_set_puts(bio_methods, rdg_bio_puts);
2318 BIO_meth_set_gets(bio_methods, rdg_bio_gets);
2319 BIO_meth_set_ctrl(bio_methods, rdg_bio_ctrl);
2320 BIO_meth_set_create(bio_methods, rdg_bio_new);
2321 BIO_meth_set_destroy(bio_methods, rdg_bio_free);
2322 }
2323
2324 return bio_methods;
2325}
2326
2327rdpRdg* rdg_new(rdpContext* context)
2328{
2329 if (!context)
2330 return nullptr;
2331
2332 rdpRdg* rdg = (rdpRdg*)calloc(1, sizeof(rdpRdg));
2333 if (!rdg)
2334 return nullptr;
2335
2336 rdg->log = WLog_Get(TAG);
2337 rdg->state = RDG_CLIENT_STATE_INITIAL;
2338 rdg->context = context;
2339 rdpSettings* settings = rdg->context->settings;
2340 rdg->extAuth = (settings->GatewayHttpExtAuthSspiNtlm ? HTTP_EXTENDED_AUTH_SSPI_NTLM
2341 : HTTP_EXTENDED_AUTH_NONE);
2342
2343 if (settings->GatewayAccessToken)
2344 rdg->extAuth = HTTP_EXTENDED_AUTH_PAA;
2345
2346 rdg->tlsOut = freerdp_tls_new(rdg->context);
2347
2348 if (!rdg->tlsOut)
2349 goto rdg_alloc_error;
2350
2351 rdg->tlsIn = freerdp_tls_new(rdg->context);
2352
2353 if (!rdg->tlsIn)
2354 goto rdg_alloc_error;
2355
2356 rdg->http = http_context_new();
2357
2358 if (!rdg->http)
2359 goto rdg_alloc_error;
2360
2361 GUID guid = WINPR_C_ARRAY_INIT;
2362 if (UuidFromStringA(settings->CorrelationId, &guid) != RPC_S_OK)
2363 goto rdg_alloc_error;
2364
2365 if (!http_context_set_uri(rdg->http, "/remoteDesktopGateway/") ||
2366 !http_context_set_accept(rdg->http, "*/*") ||
2367 !http_context_set_cache_control(rdg->http, "no-cache") ||
2368 !http_context_set_pragma(rdg->http, "no-cache") ||
2369 !http_context_set_connection(rdg->http, "Keep-Alive") ||
2370 !http_context_set_user_agent(rdg->http, "MS-RDGateway/1.0") ||
2371 !http_context_set_host(rdg->http, rdg->context->settings->GatewayHostname) ||
2372 !http_context_set_rdg_connection_id(rdg->http) ||
2373 !http_context_set_rdg_correlation_id(rdg->http, &guid) ||
2374 !http_context_enable_websocket_upgrade(
2375 rdg->http,
2376 freerdp_settings_get_bool(rdg->context->settings, FreeRDP_GatewayHttpUseWebsockets)))
2377 {
2378 goto rdg_alloc_error;
2379 }
2380
2381 if (rdg->extAuth != HTTP_EXTENDED_AUTH_NONE)
2382 {
2383 switch (rdg->extAuth)
2384 {
2385 case HTTP_EXTENDED_AUTH_PAA:
2386 if (!http_context_set_rdg_auth_scheme(rdg->http, "PAA"))
2387 goto rdg_alloc_error;
2388
2389 break;
2390
2391 case HTTP_EXTENDED_AUTH_SSPI_NTLM:
2392 if (!http_context_set_rdg_auth_scheme(rdg->http, "SSPI_NTLM"))
2393 goto rdg_alloc_error;
2394
2395 break;
2396
2397 default:
2398 WLog_Print(rdg->log, WLOG_DEBUG,
2399 "RDG extended authentication method %d not supported", rdg->extAuth);
2400 }
2401 }
2402
2403 rdg->frontBio = BIO_new(BIO_s_rdg());
2404
2405 if (!rdg->frontBio)
2406 goto rdg_alloc_error;
2407
2408 BIO_set_data(rdg->frontBio, rdg);
2409 InitializeCriticalSection(&rdg->writeSection);
2410
2411 rdg->transferEncoding.httpTransferEncoding = TransferEncodingIdentity;
2412 rdg->transferEncoding.isWebsocketTransport = FALSE;
2413
2414 rdg->transferEncoding.context.websocket = websocket_context_new();
2415 if (!rdg->transferEncoding.context.websocket)
2416 goto rdg_alloc_error;
2417
2418 return rdg;
2419rdg_alloc_error:
2420 WINPR_PRAGMA_DIAG_PUSH
2421 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2422 rdg_free(rdg);
2423 WINPR_PRAGMA_DIAG_POP
2424 return nullptr;
2425}
2426
2427void rdg_free(rdpRdg* rdg)
2428{
2429 if (!rdg)
2430 return;
2431
2432 freerdp_tls_free(rdg->tlsOut);
2433 freerdp_tls_free(rdg->tlsIn);
2434 http_context_free(rdg->http);
2435 credssp_auth_free(rdg->auth);
2436
2437 if (!rdg->attached)
2438 BIO_free_all(rdg->frontBio);
2439
2440 DeleteCriticalSection(&rdg->writeSection);
2441
2442 smartcardCertInfo_Free(rdg->smartcard);
2443
2444 websocket_context_free(rdg->transferEncoding.context.websocket);
2445
2446 free(rdg);
2447}
2448
2449BIO* rdg_get_front_bio_and_take_ownership(rdpRdg* rdg)
2450{
2451 if (!rdg)
2452 return nullptr;
2453
2454 rdg->attached = TRUE;
2455 return rdg->frontBio;
2456}
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.