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