22#include <freerdp/config.h>
23#include <freerdp/version.h>
25#include <winpr/assert.h>
28#include <winpr/synch.h>
29#include <winpr/print.h>
30#include <winpr/stream.h>
31#include <winpr/winsock.h>
32#include <winpr/cred.h>
34#include "../settings.h"
36#include <freerdp/log.h>
37#include <freerdp/error.h>
38#include <freerdp/utils/ringbuffer.h>
39#include <freerdp/utils/smartcardlogon.h>
44#include "../credssp_auth.h"
47#include "../../crypto/opensslcompat.h"
51#define TAG FREERDP_TAG("core.gateway.wst")
53#define AUTH_PKG NEGO_SSP_NAME
68 websocket_context* wscontext;
72static const char arm_query_param[] =
"%s%cClmTk=Bearer%%20%s";
75static BOOL wst_uri_has_clmtk_bearer(
const char* uri)
79 for (
const char* p = uri; *p; p++)
81 if (_strnicmp(p,
"ClmTk=", 6) == 0)
87static BOOL wst_get_gateway_credentials(wLog* log, rdpContext* context, rdp_auth_reason reason)
89 WINPR_ASSERT(context);
90 freerdp* instance = context->instance;
92 auth_status rc = utils_authenticate_gateway(instance, reason);
99 freerdp_set_last_error_log(instance->context, FREERDP_ERROR_CONNECT_CANCELLED);
101 case AUTH_NO_CREDENTIALS:
102 WLog_Print(log, WLOG_INFO,
"No credentials provided - using nullptr identity");
110static BOOL wst_auth_init(rdpWst* wst, rdpTls* tls, TCHAR* authPkg)
114 WINPR_ASSERT(authPkg);
116 rdpContext* context = wst->context;
117 rdpSettings* settings = context->settings;
118 SEC_WINNT_AUTH_IDENTITY identity = WINPR_C_ARRAY_INIT;
121 wst->auth_required = TRUE;
122 if (!credssp_auth_init(wst->auth, authPkg, tls->Bindings))
125 if (!wst_get_gateway_credentials(wst->log, context, GW_AUTH_RDG))
128 if (!identity_set_from_settings(&identity, settings, FreeRDP_GatewayUsername,
129 FreeRDP_GatewayDomain, FreeRDP_GatewayPassword))
133 SEC_WINNT_AUTH_IDENTITY* identityArg = (GatewayUsername ? &identity :
nullptr);
134 if (!credssp_auth_setup_client(wst->auth,
"HTTP", wst->gwhostname, identityArg,
nullptr))
136 sspi_FreeAuthIdentity(&identity);
139 sspi_FreeAuthIdentity(&identity);
141 credssp_auth_set_flags(wst->auth, ISC_REQ_CONFIDENTIALITY | ISC_REQ_MUTUAL_AUTH);
143 rc = credssp_auth_authenticate(wst->auth);
147static BOOL wst_set_auth_header(rdpCredsspAuth* auth, HttpRequest* request)
150 WINPR_ASSERT(request);
152 const SecBuffer* authToken = credssp_auth_get_output_buffer(auth);
153 char* base64AuthToken =
nullptr;
157 if (authToken->cbBuffer > INT_MAX)
160 base64AuthToken = crypto_base64_encode(authToken->pvBuffer, authToken->cbBuffer);
165 BOOL rc = http_request_set_auth_scheme(request, credssp_auth_pkg_name(auth)) &&
166 http_request_set_auth_param(request, base64AuthToken);
167 free(base64AuthToken);
176static BOOL wst_recv_auth_token(rdpCredsspAuth* auth, HttpResponse* response)
179 size_t authTokenLength = 0;
180 BYTE* authTokenData =
nullptr;
181 SecBuffer authToken = WINPR_C_ARRAY_INIT;
184 if (!auth || !response)
187 const UINT16 StatusCode = http_response_get_status_code(response);
190 case HTTP_STATUS_DENIED:
194 http_response_log_error_status(WLog_Get(TAG), WLOG_WARN, response);
198 const char* token64 = http_response_get_auth_token(response, credssp_auth_pkg_name(auth));
203 len = strlen(token64);
205 crypto_base64_decode(token64, len, &authTokenData, &authTokenLength);
207 if (authTokenLength && (authTokenLength <= UINT32_MAX) && authTokenData)
209 authToken.pvBuffer = authTokenData;
210 authToken.cbBuffer = (UINT32)authTokenLength;
211 credssp_auth_take_input_buffer(auth, &authToken);
216 rc = credssp_auth_authenticate(auth);
220static BOOL wst_tls_connect(rdpWst* wst, rdpTls* tls, UINT32 timeout)
226 BIO* socketBio =
nullptr;
227 BIO* bufferedBio =
nullptr;
228 rdpSettings* settings = wst->context->settings;
229 const char* peerHostname = wst->gwhostname;
230 UINT16 peerPort = wst->gwport;
231 const char* proxyUsername =
nullptr;
232 const char* proxyPassword =
nullptr;
233 BOOL isProxyConnection =
234 proxy_prepare(settings, &peerHostname, &peerPort, &proxyUsername, &proxyPassword);
236 sockfd = freerdp_tcp_connect(wst->context, peerHostname, peerPort, timeout);
238 WLog_Print(wst->log, WLOG_DEBUG,
"connecting to %s %d", peerHostname, peerPort);
244 socketBio = BIO_new(BIO_s_simple_socket());
248 closesocket((SOCKET)sockfd);
252 BIO_set_fd(socketBio, sockfd, BIO_CLOSE);
253 bufferedBio = BIO_new(BIO_s_buffered_socket());
257 BIO_free_all(socketBio);
261 bufferedBio = BIO_push(bufferedBio, socketBio);
262 status = BIO_set_nonblock(bufferedBio, TRUE);
264 if (isProxyConnection)
266 if (!proxy_connect(wst->context, bufferedBio, proxyUsername, proxyPassword, wst->gwhostname,
269 BIO_free_all(bufferedBio);
276 BIO_free_all(bufferedBio);
280 tls->hostname = wst->gwhostname;
281 tls->port = MIN(UINT16_MAX, wst->gwport);
282 tls->isGatewayTransport = TRUE;
283 status = freerdp_tls_connect(tls, bufferedBio);
286 rdpContext* context = wst->context;
289 freerdp_set_last_error_if_not(context, FREERDP_ERROR_TLS_CONNECT_FAILED);
293 freerdp_set_last_error_if_not(context, FREERDP_ERROR_CONNECT_CANCELLED);
298 return (status >= 1);
301static wStream* wst_build_http_request(rdpWst* wst)
308 const char* uri = http_context_get_uri(wst->http);
309 HttpRequest* request = http_request_new();
314 if (!http_request_set_method(request,
"GET") || !http_request_set_uri(request, uri))
317 if (wst->auth_required)
319 if (!wst_set_auth_header(wst->auth, request))
326 if (!wst_uri_has_clmtk_bearer(uri))
328 if (!http_request_set_auth_scheme(request,
"Bearer"))
330 if (!http_request_set_auth_param(
332 FreeRDP_GatewayHttpExtAuthBearer)))
337 s = http_request_write(wst->http, request);
339 http_request_free(request);
342 Stream_SealLength(s);
347static BOOL wst_send_http_request(rdpWst* wst, rdpTls* tls)
352 wStream* s = wst_build_http_request(wst);
356 const size_t sz = Stream_Length(s);
357 WLog_Print(wst->log, WLOG_TRACE,
"header [%" PRIuz
"]: %s", sz, Stream_Buffer(s));
359 const int status = freerdp_tls_write_all(tls, Stream_Buffer(s), sz);
360 Stream_Free(s, TRUE);
361 return (status >= 0);
364static BOOL wst_handle_ok_or_forbidden(rdpWst* wst, HttpResponse** ppresponse, DWORD timeout,
368 WINPR_ASSERT(ppresponse);
369 WINPR_ASSERT(*ppresponse);
370 WINPR_ASSERT(pStatusCode);
373 const char* affinity = http_response_get_setcookie(*ppresponse,
"ARRAffinity");
374 const char* samesite = http_response_get_setcookie(*ppresponse,
"ARRAffinitySameSite");
375 if ((affinity || samesite) &&
378 WLog_Print(wst->log, WLOG_INFO,
"Got ARRAffinity cookie %s", affinity);
379 WLog_Print(wst->log, WLOG_INFO,
"Got ARRAffinitySameSite cookie %s", samesite);
382 if (!http_context_set_cookie(wst->http,
"ARRAffinity", affinity))
387 if (!http_context_set_cookie(wst->http,
"ARRAffinitySameSite", samesite))
390 http_response_free(*ppresponse);
391 *ppresponse =
nullptr;
393 const long fd = BIO_get_fd(wst->tls->bio,
nullptr);
394 if ((fd >= 0) && (fd <= INT32_MAX))
395 closesocket((SOCKET)fd);
396 freerdp_tls_free(wst->tls);
398 wst->tls = freerdp_tls_new(wst->context);
399 if (!wst_tls_connect(wst, wst->tls, timeout))
405 char* urlWithAuth =
nullptr;
407 char firstParam = (strchr(wst->gwpath,
'?') !=
nullptr) ?
'&' :
'?';
409 FreeRDP_GatewayHttpExtAuthBearer);
410 if (winpr_asprintf(&urlWithAuth, &urlLen, arm_query_param, wst->gwpath, firstParam,
415 wst->gwpath = urlWithAuth;
418 if (!http_context_set_uri(wst->http, wst->gwpath))
420 if (!http_context_enable_websocket_upgrade(wst->http, TRUE))
424 if (!wst_send_http_request(wst, wst->tls))
426 *ppresponse = http_response_recv(wst->tls, TRUE);
430 (void)http_response_extract_cookies(*ppresponse, wst->http);
431 *pStatusCode = http_response_get_status_code(*ppresponse);
437static BOOL wst_handle_denied(rdpWst* wst, HttpResponse** ppresponse, UINT16* pStatusCode)
440 WINPR_ASSERT(ppresponse);
441 WINPR_ASSERT(*ppresponse);
442 WINPR_ASSERT(pStatusCode);
447 if (!wst_auth_init(wst, wst->tls, AUTH_PKG))
449 if (!wst_send_http_request(wst, wst->tls))
452 http_response_free(*ppresponse);
453 *ppresponse = http_response_recv(wst->tls, TRUE);
457 (void)http_response_extract_cookies(*ppresponse, wst->http);
459 while (!credssp_auth_is_complete(wst->auth))
461 if (!wst_recv_auth_token(wst->auth, *ppresponse))
464 if (credssp_auth_have_output_token(wst->auth))
466 if (!wst_send_http_request(wst, wst->tls))
469 http_response_free(*ppresponse);
470 *ppresponse = http_response_recv(wst->tls, TRUE);
473 (void)http_response_extract_cookies(*ppresponse, wst->http);
476 *pStatusCode = http_response_get_status_code(*ppresponse);
480static BOOL wst_handle_http_code(rdpWst* wst, UINT16 StatusCode)
484 case HTTP_STATUS_PAYMENT_REQ:
485 case HTTP_STATUS_FORBIDDEN:
486 case HTTP_STATUS_DENIED:
487 freerdp_set_last_error_if_not(wst->context, FREERDP_ERROR_CONNECT_ACCESS_DENIED);
489 case HTTP_STATUS_MOVED:
490 case HTTP_STATUS_USE_PROXY:
491 case HTTP_STATUS_BAD_REQUEST:
492 case HTTP_STATUS_NOT_FOUND:
493 case HTTP_STATUS_GONE:
494 freerdp_set_last_error_if_not(wst->context, FREERDP_ERROR_CONNECT_TRANSPORT_FAILED);
496 case HTTP_STATUS_SERVER_ERROR:
497 case HTTP_STATUS_NOT_SUPPORTED:
498 case HTTP_STATUS_BAD_GATEWAY:
499 case HTTP_STATUS_SERVICE_UNAVAIL:
500 case HTTP_STATUS_VERSION_NOT_SUP:
501 freerdp_set_last_error_if_not(wst->context, FREERDP_ERROR_CONNECT_TRANSPORT_FAILED);
503 case HTTP_STATUS_GATEWAY_TIMEOUT:
504 freerdp_set_last_error_if_not(wst->context, FREERDP_ERROR_CONNECT_ACTIVATION_TIMEOUT);
510 char buffer[64] = WINPR_C_ARRAY_INIT;
511 WLog_Print(wst->log, WLOG_ERROR,
"Unexpected HTTP status: %s",
512 freerdp_http_status_string_format(StatusCode, buffer, ARRAYSIZE(buffer)));
513 freerdp_set_last_error_if_not(wst->context, FREERDP_ERROR_CONNECT_FAILED);
517BOOL wst_connect(rdpWst* wst, DWORD timeout)
520 WINPR_ASSERT(wst->context);
522 if (!wst_tls_connect(wst, wst->tls, timeout))
524 freerdp_set_last_error_if_not(wst->context, FREERDP_ERROR_CONNECT_FAILED);
535 if (!http_context_enable_websocket_upgrade(wst->http, FALSE))
537 freerdp_set_last_error_if_not(wst->context, FREERDP_ERROR_CONNECT_FAILED);
541 if (!wst_send_http_request(wst, wst->tls))
543 freerdp_set_last_error_if_not(wst->context, FREERDP_ERROR_CONNECT_FAILED);
547 HttpResponse* response = http_response_recv(wst->tls, TRUE);
550 freerdp_set_last_error_if_not(wst->context, FREERDP_ERROR_CONNECT_FAILED);
553 (void)http_response_extract_cookies(response, wst->http);
555 UINT16 StatusCode = http_response_get_status_code(response);
559 case HTTP_STATUS_FORBIDDEN:
561 success = wst_handle_ok_or_forbidden(wst, &response, timeout, &StatusCode);
564 case HTTP_STATUS_DENIED:
565 success = wst_handle_denied(wst, &response, &StatusCode);
568 http_response_log_error_status(WLog_Get(TAG), WLOG_WARN, response);
572 const BOOL isWebsocket = http_response_is_websocket(wst->http, response);
573 http_response_free(response);
575 return wst_handle_http_code(wst, StatusCode);
578 return websocket_context_reset(wst->wscontext);
580 return wst_handle_http_code(wst, StatusCode);
583DWORD wst_get_event_handles(rdpWst* wst, HANDLE* events, DWORD count)
586 WINPR_ASSERT(wst !=
nullptr);
590 if (events && (nCount < count))
592 BIO_get_event(wst->tls->bio, &events[nCount]);
602static int wst_bio_write(BIO* bio,
const char* buf,
int num)
608 rdpWst* wst = (rdpWst*)BIO_get_data(bio);
610 BIO_clear_flags(bio, BIO_FLAGS_WRITE);
611 EnterCriticalSection(&wst->writeSection);
612 status = websocket_context_write(wst->wscontext, wst->tls->bio, (
const BYTE*)buf, num,
613 WebsocketBinaryOpcode);
614 LeaveCriticalSection(&wst->writeSection);
618 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
621 else if (status < num)
623 BIO_set_flags(bio, BIO_FLAGS_WRITE);
624 WSASetLastError(WSAEWOULDBLOCK);
628 BIO_set_flags(bio, BIO_FLAGS_WRITE);
634static int wst_bio_read(BIO* bio,
char* buf,
int size)
639 WINPR_ASSERT(size >= 0);
641 rdpWst* wst = (rdpWst*)BIO_get_data(bio);
646 status = websocket_context_read(wst->wscontext, wst->tls->bio, (BYTE*)buf, (
size_t)size);
649 if (!BIO_should_retry(wst->tls->bio))
657 BIO_clear_retry_flags(bio);
660 else if (status == 0)
662 BIO_set_retry_read(bio);
663 WSASetLastError(WSAEWOULDBLOCK);
668 BIO_set_flags(bio, BIO_FLAGS_READ);
674static int wst_bio_puts(BIO* bio,
const char* str)
682static int wst_bio_gets(BIO* bio,
char* str,
int size)
690static long wst_bio_ctrl(BIO* bio,
int cmd,
long arg1,
void* arg2)
695 rdpWst* wst = (rdpWst*)BIO_get_data(bio);
697 rdpTls* tls = wst->tls;
699 if (cmd == BIO_CTRL_FLUSH)
701 (void)BIO_flush(tls->bio);
704 else if (cmd == BIO_C_SET_NONBLOCK)
708 else if (cmd == BIO_C_READ_BLOCKED)
710 status = BIO_read_blocked(tls->bio);
712 else if (cmd == BIO_C_WRITE_BLOCKED)
714 status = BIO_write_blocked(tls->bio);
716 else if (cmd == BIO_C_WAIT_READ)
718 int timeout = (int)arg1;
720 if (BIO_read_blocked(tls->bio))
721 return BIO_wait_read(tls->bio, timeout);
724 else if (cmd == BIO_C_WAIT_WRITE)
726 int timeout = (int)arg1;
728 if (BIO_write_blocked(tls->bio))
729 status = BIO_wait_write(tls->bio, timeout);
733 else if (cmd == BIO_C_GET_EVENT || cmd == BIO_C_GET_FD)
735 status = BIO_ctrl(tls->bio, cmd, arg1, arg2);
737#if OPENSSL_VERSION_NUMBER >= 0x30000000L
738 else if (cmd == BIO_CTRL_GET_KTLS_SEND)
746 else if (cmd == BIO_CTRL_GET_KTLS_RECV)
757static int wst_bio_new(BIO* bio)
759 BIO_set_init(bio, 1);
760 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
764static int wst_bio_free(BIO* bio)
770static BIO_METHOD* BIO_s_wst(
void)
772 static BIO_METHOD* bio_methods =
nullptr;
774 if (bio_methods ==
nullptr)
776 if (!(bio_methods = BIO_meth_new(BIO_TYPE_TSG,
"WSTransport")))
779 BIO_meth_set_write(bio_methods, wst_bio_write);
780 BIO_meth_set_read(bio_methods, wst_bio_read);
781 BIO_meth_set_puts(bio_methods, wst_bio_puts);
782 BIO_meth_set_gets(bio_methods, wst_bio_gets);
783 BIO_meth_set_ctrl(bio_methods, wst_bio_ctrl);
784 BIO_meth_set_create(bio_methods, wst_bio_new);
785 BIO_meth_set_destroy(bio_methods, wst_bio_free);
791static BOOL wst_parse_url(rdpWst* wst,
const char* url)
793 const char* hostStart =
nullptr;
794 const char* pos =
nullptr;
798 free(wst->gwhostname);
799 wst->gwhostname =
nullptr;
801 wst->gwpath =
nullptr;
803 if (strncmp(
"wss://", url, 6) != 0)
805 if (strncmp(
"https://", url, 8) != 0)
807 WLog_Print(wst->log, WLOG_ERROR,
808 "Websocket URL is invalid. Only wss:// or https:// URLs are supported");
818 while (*pos !=
'\0' && *pos !=
':' && *pos !=
'/')
820 free(wst->gwhostname);
821 wst->gwhostname =
nullptr;
822 if (pos - hostStart == 0)
824 wst->gwhostname = strndup(hostStart, WINPR_ASSERTING_INT_CAST(
size_t, (pos - hostStart)));
825 if (!wst->gwhostname)
830 char port[6] = WINPR_C_ARRAY_INIT;
831 char* portNumberEnd =
nullptr;
833 const char* portStart = pos;
834 while (*pos !=
'\0' && *pos !=
'/')
836 if (pos - portStart > 5 || pos - portStart == 0)
838 strncpy(port, portStart, WINPR_ASSERTING_INT_CAST(
size_t, (pos - portStart)));
839 port[pos - portStart] =
'\0';
840 long _p = strtol(port, &portNumberEnd, 10);
841 if (portNumberEnd && (*portNumberEnd ==
'\0') && (_p > 0) && (_p <= UINT16_MAX))
842 wst->gwport = (uint16_t)_p;
848 wst->gwpath = _strdup(pos);
849 return (wst->gwpath !=
nullptr);
852rdpWst* wst_new(rdpContext* context)
857 rdpWst* wst = (rdpWst*)calloc(1,
sizeof(rdpWst));
861 wst->log = WLog_Get(TAG);
862 wst->context = context;
864 wst->gwhostname =
nullptr;
866 wst->gwpath =
nullptr;
869 if (!wst_parse_url(wst, GatewayUrl))
870 goto wst_alloc_error;
872 wst->tls = freerdp_tls_new(wst->context);
874 goto wst_alloc_error;
876 wst->http = http_context_new();
879 goto wst_alloc_error;
882 const char* useragent =
884 const char* msuseragent =
886 if (!http_context_set_uri(wst->http, wst->gwpath) ||
887 !http_context_set_accept(wst->http,
"*/*") ||
888 !http_context_set_cache_control(wst->http,
"no-cache") ||
889 !http_context_set_pragma(wst->http,
"no-cache") ||
890 !http_context_set_connection(wst->http,
"Keep-Alive") ||
891 !http_context_set_user_agent(wst->http, useragent) ||
892 !http_context_set_x_ms_user_agent(wst->http, msuseragent) ||
893 !http_context_set_host(wst->http, wst->gwhostname) ||
894 !http_context_enable_websocket_upgrade(wst->http, TRUE))
896 goto wst_alloc_error;
900 wst->frontBio = BIO_new(BIO_s_wst());
903 goto wst_alloc_error;
905 BIO_set_data(wst->frontBio, wst);
906 InitializeCriticalSection(&wst->writeSection);
907 wst->auth = credssp_auth_new(context);
909 goto wst_alloc_error;
911 wst->wscontext = websocket_context_new();
913 goto wst_alloc_error;
917 WINPR_PRAGMA_DIAG_PUSH
918 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
920 WINPR_PRAGMA_DIAG_POP
924void wst_free(rdpWst* wst)
929 freerdp_tls_free(wst->tls);
930 http_context_free(wst->http);
931 credssp_auth_free(wst->auth);
932 free(wst->gwhostname);
936 BIO_free_all(wst->frontBio);
938 DeleteCriticalSection(&wst->writeSection);
940 websocket_context_free(wst->wscontext);
945BIO* wst_get_front_bio_and_take_ownership(rdpWst* wst)
950 wst->attached = TRUE;
951 return wst->frontBio;
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.