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