24#include <winpr/assert.h>
25#include <winpr/cast.h>
27#include <freerdp/config.h>
29#include <freerdp/freerdp.h>
30#include <freerdp/gdi/gdi.h>
31#include <freerdp/client/cmdline.h>
33#include <freerdp/server/proxy/proxy_log.h>
34#include <freerdp/channels/drdynvc.h>
35#include <freerdp/channels/encomsp.h>
36#include <freerdp/channels/rdpdr.h>
37#include <freerdp/channels/rdpsnd.h>
38#include <freerdp/channels/cliprdr.h>
39#include <freerdp/channels/channels.h>
42#include "pf_channel.h"
43#include <freerdp/server/proxy/proxy_context.h>
46#include <freerdp/server/proxy/proxy_config.h>
47#include "proxy_modules.h"
49#include "channels/pf_channel_rdpdr.h"
50#include "channels/pf_channel_smartcard.h"
52#define TAG PROXY_TAG("client")
54static void channel_data_free(
void* obj);
55static BOOL proxy_server_reactivate(rdpContext* ps,
const rdpContext* pc)
60 if (!pf_context_copy_settings(ps->settings, pc->settings))
67 WINPR_ASSERT(ps->update);
68 if (!ps->update->DesktopResize(ps))
74static void pf_client_on_error_info(
void* ctx,
const ErrorInfoEventArgs* e)
76 pClientContext* pc = (pClientContext*)ctx;
77 pServerContext* ps = NULL;
80 WINPR_ASSERT(pc->pdata);
85 if (e->code == ERRINFO_NONE)
88 PROXY_LOG_WARN(TAG, pc,
"received ErrorInfo PDU. code=0x%08" PRIu32
", message: %s", e->code,
89 freerdp_get_error_info_string(e->code));
92 freerdp_set_error_info(ps->context.rdp, e->code);
93 freerdp_send_error_info(ps->context.rdp);
96static void pf_client_on_activated(
void* ctx, WINPR_ATTR_UNUSED
const ActivatedEventArgs* e)
98 pClientContext* pc = (pClientContext*)ctx;
99 pServerContext* ps = NULL;
100 freerdp_peer* peer = NULL;
103 WINPR_ASSERT(pc->pdata);
108 peer = ps->context.peer;
110 WINPR_ASSERT(peer->context);
112 PROXY_LOG_INFO(TAG, pc,
"client activated, registering server input callbacks");
115 pf_server_register_input_callbacks(peer->context->input);
116 pf_server_register_update_callbacks(peer->context->update);
119static BOOL pf_client_load_rdpsnd(pClientContext* pc)
121 rdpContext* context = (rdpContext*)pc;
124 WINPR_ASSERT(pc->pdata);
129 if (!freerdp_static_channel_collection_find(context->settings, RDPSND_CHANNEL_NAME))
131 const char* params[2] = { RDPSND_CHANNEL_NAME,
"sys:fake" };
133 if (!freerdp_client_add_static_channel(context->settings, ARRAYSIZE(params), params))
140static BOOL pf_client_use_peer_load_balance_info(pClientContext* pc)
142 pServerContext* ps = NULL;
143 rdpSettings* settings = NULL;
144 DWORD lb_info_len = 0;
145 const char* lb_info = NULL;
148 WINPR_ASSERT(pc->pdata);
151 settings = pc->context.settings;
152 WINPR_ASSERT(settings);
154 lb_info = freerdp_nego_get_routing_token(&ps->context, &lb_info_len);
162static BOOL str_is_empty(
const char* str)
166 if (strlen(str) == 0)
171static BOOL pf_client_use_proxy_smartcard_auth(
const rdpSettings* settings)
180 if (str_is_empty(key))
183 if (str_is_empty(cert))
189static BOOL pf_client_pre_connect(freerdp* instance)
191 pClientContext* pc = NULL;
192 pServerContext* ps = NULL;
193 const proxyConfig* config = NULL;
194 rdpSettings* settings = NULL;
196 WINPR_ASSERT(instance);
197 pc = (pClientContext*)instance->context;
199 WINPR_ASSERT(pc->pdata);
202 WINPR_ASSERT(ps->pdata);
203 config = ps->pdata->config;
204 WINPR_ASSERT(config);
205 settings = instance->context->settings;
206 WINPR_ASSERT(settings);
219 ZeroMemory(OrderSupport, 32);
221 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, DRDYNVC_SVC_CHANNEL_NAME))
235 config->DeviceRedirection) ||
237 config->DisplayControl) ||
241 if (config->RemoteApp)
243 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, RAIL_SVC_CHANNEL_NAME))
250 if (config->DeviceRedirection)
252 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, RDPDR_SVC_CHANNEL_NAME))
263 config->DisplayControl))
266 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, ENCOMSP_SVC_CHANNEL_NAME))
272 if (config->Clipboard)
274 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, CLIPRDR_SVC_CHANNEL_NAME))
284 PubSub_SubscribeErrorInfo(instance->context->pubSub, pf_client_on_error_info);
285 PubSub_SubscribeActivated(instance->context->pubSub, pf_client_on_activated);
286 if (!pf_client_use_peer_load_balance_info(pc))
289 return pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_PRE_CONNECT, pc->pdata, pc);
300static BOOL updateBackIdFn(WINPR_ATTR_UNUSED
const void* key,
void* value,
void* arg)
302 pServerStaticChannelContext* current = (pServerStaticChannelContext*)value;
303 UpdateBackIdArgs* updateArgs = (UpdateBackIdArgs*)arg;
305 if (strcmp(updateArgs->name, current->channel_name) != 0)
308 current->back_channel_id = updateArgs->backId;
309 if (!HashTable_Insert(updateArgs->ps->channelsByBackId, ¤t->back_channel_id, current))
311 WLog_ERR(TAG,
"error inserting channel in channelsByBackId table");
316static BOOL pf_client_update_back_id(pServerContext* ps,
const char* name, UINT32 backId)
318 UpdateBackIdArgs res = { ps, name, backId };
320 return HashTable_Foreach(ps->channelsByFrontId, updateBackIdFn, &res) == FALSE;
323static BOOL pf_client_load_channels(freerdp* instance)
325 pClientContext* pc = NULL;
326 pServerContext* ps = NULL;
327 const proxyConfig* config = NULL;
328 rdpSettings* settings = NULL;
330 WINPR_ASSERT(instance);
331 pc = (pClientContext*)instance->context;
333 WINPR_ASSERT(pc->pdata);
336 WINPR_ASSERT(ps->pdata);
337 config = ps->pdata->config;
338 WINPR_ASSERT(config);
339 settings = instance->context->settings;
340 WINPR_ASSERT(settings);
345 PROXY_LOG_INFO(TAG, pc,
"Loading addins");
347 if (!pf_client_load_rdpsnd(pc))
349 PROXY_LOG_ERR(TAG, pc,
"Failed to load rdpsnd client");
353 if (!pf_utils_is_passthrough(config))
355 if (!freerdp_client_load_addins(instance->context->channels, settings))
357 PROXY_LOG_ERR(TAG, pc,
"Failed to load addins");
363 if (!pf_channel_rdpdr_client_new(pc))
365#if defined(WITH_PROXY_EMULATE_SMARTCARD)
366 if (!pf_channel_smartcard_client_new(pc))
370 if (!freerdp_channels_from_mcs(settings, &ps->context))
376 settings, FreeRDP_ChannelDefArray, 0);
378 UINT32
id = MCS_GLOBAL_CHANNEL_ID + 1;
380 WINPR_ASSERT(channels || (size == 0));
388 dev.channel_name = cur->name;
389 dev.flags = cur->options;
392 if (!pf_modules_run_filter(pc->pdata->module,
393 FILTER_TYPE_CLIENT_PASSTHROUGH_CHANNEL_CREATE, pc->pdata,
396 const size_t s = size - MIN(size, x + 1);
402 if (!pf_client_update_back_id(ps, cur->name,
id++))
404 WLog_ERR(TAG,
"unable to update backid for channel %s", cur->name);
415 return pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_LOAD_CHANNELS, pc->pdata, pc);
418static BOOL pf_client_receive_channel_data_hook(freerdp* instance, UINT16 channelId,
419 const BYTE* xdata,
size_t xsize, UINT32 flags,
422 pClientContext* pc = NULL;
423 pServerContext* ps = NULL;
424 proxyData* pdata = NULL;
425 pServerStaticChannelContext* channel = NULL;
426 UINT64 channelId64 = channelId;
428 WINPR_ASSERT(instance);
429 WINPR_ASSERT(xdata || (xsize == 0));
431 pc = (pClientContext*)instance->context;
433 WINPR_ASSERT(pc->pdata);
441 channel = HashTable_GetItemValue(ps->channelsByBackId, &channelId64);
445 WINPR_ASSERT(channel->onBackData);
446 switch (channel->onBackData(pdata, channel, xdata, xsize, flags, totalSize))
448 case PF_CHANNEL_RESULT_PASS:
452 if (channel->front_channel_id == 0)
455 return ps->context.peer->SendChannelPacket(
456 ps->context.peer, WINPR_ASSERTING_INT_CAST(UINT16, channel->front_channel_id),
457 totalSize, flags, xdata, xsize);
458 case PF_CHANNEL_RESULT_DROP:
460 case PF_CHANNEL_RESULT_ERROR:
466static BOOL pf_client_on_server_heartbeat(freerdp* instance, BYTE period, BYTE count1, BYTE count2)
468 pClientContext* pc = NULL;
469 pServerContext* ps = NULL;
471 WINPR_ASSERT(instance);
472 pc = (pClientContext*)instance->context;
474 WINPR_ASSERT(pc->pdata);
478 return freerdp_heartbeat_send_heartbeat_pdu(ps->context.peer, period, count1, count2);
486 return Queue_Enqueue(pc->cached_server_channel_data, ev);
489static BOOL sendQueuedChannelData(pClientContext* pc)
499 Queue_Lock(pc->cached_server_channel_data);
500 while (rc && (ev = Queue_Dequeue(pc->cached_server_channel_data)))
502 UINT16 channelId = 0;
503 WINPR_ASSERT(pc->context.instance);
505 channelId = freerdp_channels_get_id_by_name(pc->context.instance, ev->channel_name);
507 if ((channelId == 0) || (channelId == UINT16_MAX))
511 WINPR_ASSERT(pc->context.instance->SendChannelPacket);
512 rc = pc->context.instance->SendChannelPacket(pc->context.instance, channelId,
513 ev->total_size, ev->flags, ev->data,
516 channel_data_free(ev);
519 Queue_Unlock(pc->cached_server_channel_data);
534static BOOL pf_client_post_connect(freerdp* instance)
536 WINPR_ASSERT(instance);
537 rdpContext* context = instance->context;
538 WINPR_ASSERT(context);
539 rdpUpdate* update = context->update;
540 WINPR_ASSERT(update);
541 pClientContext* pc = (pClientContext*)context;
543 WINPR_ASSERT(pc->pdata);
544 rdpContext* ps = (rdpContext*)pc->pdata->ps;
547 if (!pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_POST_CONNECT, pc->pdata, pc))
550 if (!gdi_init(instance, PIXEL_FORMAT_BGRA32))
555 pf_client_register_update_callbacks(update);
558 pc->client_receive_channel_data_original = instance->ReceiveChannelData;
559 instance->ReceiveChannelData = pf_client_receive_channel_data_hook;
561 instance->heartbeat->ServerHeartbeat = pf_client_on_server_heartbeat;
563 pc->connected = TRUE;
566 sendQueuedChannelData(pc);
573 return proxy_server_reactivate(ps, context);
579static void pf_client_post_disconnect(freerdp* instance)
581 pClientContext* pc = NULL;
582 proxyData* pdata = NULL;
587 if (!instance->context)
590 pc = (pClientContext*)instance->context;
595#if defined(WITH_PROXY_EMULATE_SMARTCARD)
596 pf_channel_smartcard_client_free(pc);
599 pf_channel_rdpdr_client_free(pc);
601 pc->connected = FALSE;
602 pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_POST_DISCONNECT, pc->pdata, pc);
604 PubSub_UnsubscribeErrorInfo(instance->context->pubSub, pf_client_on_error_info);
608 if (!pc->allow_next_conn_failure)
609 proxy_data_abort_connect(pdata);
612static BOOL pf_client_redirect(freerdp* instance)
617 if (!instance->context)
620 pClientContext* pc = (pClientContext*)instance->context;
623#if defined(WITH_PROXY_EMULATE_SMARTCARD)
624 pf_channel_smartcard_client_reset(pc);
626 pf_channel_rdpdr_client_reset(pc);
628 return pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_REDIRECT, pc->pdata, pc);
637static BOOL pf_client_should_retry_without_nla(pClientContext* pc)
639 rdpSettings* settings = NULL;
640 const proxyConfig* config = NULL;
643 WINPR_ASSERT(pc->pdata);
644 settings = pc->context.settings;
645 WINPR_ASSERT(settings);
646 config = pc->pdata->config;
647 WINPR_ASSERT(config);
649 if (!config->ClientAllowFallbackToTls ||
653 return config->ClientTlsSecurity || config->ClientRdpSecurity;
656static BOOL pf_client_set_security_settings(pClientContext* pc)
659 WINPR_ASSERT(pc->pdata);
660 rdpSettings* settings = pc->context.settings;
661 WINPR_ASSERT(settings);
662 const proxyConfig* config = pc->pdata->config;
663 WINPR_ASSERT(config);
672 if (pf_client_use_proxy_smartcard_auth(settings))
688static BOOL pf_client_connect_without_nla(pClientContext* pc)
690 freerdp* instance = NULL;
691 rdpSettings* settings = NULL;
694 instance = pc->context.instance;
695 WINPR_ASSERT(instance);
697 if (!freerdp_context_reset(instance))
700 settings = pc->context.settings;
701 WINPR_ASSERT(settings);
712 pc->allow_next_conn_failure = FALSE;
713 return freerdp_connect(instance);
716static BOOL pf_client_connect(freerdp* instance)
718 pClientContext* pc = NULL;
719 rdpSettings* settings = NULL;
723 WINPR_ASSERT(instance);
724 pc = (pClientContext*)instance->context;
726 settings = instance->context->settings;
727 WINPR_ASSERT(settings);
729 PROXY_LOG_INFO(TAG, pc,
"connecting using client info: Username: %s, Domain: %s",
733 if (!pf_client_set_security_settings(pc))
736 if (pf_client_should_retry_without_nla(pc))
737 retry = pc->allow_next_conn_failure = TRUE;
739 PROXY_LOG_INFO(TAG, pc,
"connecting using security settings: rdp=%d, tls=%d, nla=%d",
744 if (!freerdp_connect(instance))
746 if (!pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_LOGIN_FAILURE, pc->pdata, pc))
752 PROXY_LOG_ERR(TAG, pc,
"failed to connect with NLA. retrying to connect without NLA");
753 if (!pf_client_connect_without_nla(pc))
755 PROXY_LOG_ERR(TAG, pc,
"pf_client_connect_without_nla failed!");
762 pc->allow_next_conn_failure = FALSE;
771static DWORD WINAPI pf_client_thread_proc(pClientContext* pc)
773 freerdp* instance = NULL;
774 proxyData* pdata = NULL;
777 HANDLE handles[MAXIMUM_WAIT_OBJECTS] = { 0 };
781 instance = pc->context.instance;
782 WINPR_ASSERT(instance);
793 handles[nCount++] = pdata->abort_event;
795 if (!pf_modules_run_hook(pdata->module, HOOK_TYPE_CLIENT_INIT_CONNECT, pdata, pc))
797 proxy_data_abort_connect(pdata);
801 if (!pf_client_connect(instance))
803 proxy_data_abort_connect(pdata);
806 handles[nCount++] = Queue_Event(pc->cached_server_channel_data);
808 while (!freerdp_shall_disconnect_context(instance->context))
810 UINT32 tmp = freerdp_get_event_handles(instance->context, &handles[nCount],
811 ARRAYSIZE(handles) - nCount);
815 PROXY_LOG_ERR(TAG, pc,
"freerdp_get_event_handles failed!");
819 status = WaitForMultipleObjects(nCount + tmp, handles, FALSE, INFINITE);
821 if (status == WAIT_FAILED)
823 WLog_ERR(TAG,
"WaitForMultipleObjects failed with %" PRIu32
"", status);
828 if (status == WAIT_OBJECT_0)
831 if (freerdp_shall_disconnect_context(instance->context))
834 if (proxy_data_shall_disconnect(pdata))
837 if (!freerdp_check_event_handles(instance->context))
839 if (freerdp_get_last_error(instance->context) == FREERDP_ERROR_SUCCESS)
840 WLog_ERR(TAG,
"Failed to check FreeRDP event handles");
844 sendQueuedChannelData(pc);
847 freerdp_disconnect(instance);
850 pf_modules_run_hook(pdata->module, HOOK_TYPE_CLIENT_UNINIT_CONNECT, pdata, pc);
855static int pf_logon_error_info(freerdp* instance, UINT32 data, UINT32 type)
857 const char* str_data = freerdp_get_logon_error_info_data(data);
858 const char* str_type = freerdp_get_logon_error_info_type(type);
860 if (!instance || !instance->context)
863 WLog_INFO(TAG,
"Logon Error Info %s [%s]", str_data, str_type);
867static void pf_client_context_free(freerdp* instance, rdpContext* context)
869 pClientContext* pc = (pClientContext*)context;
870 WINPR_UNUSED(instance);
875 pc->sendChannelData = NULL;
876 Queue_Free(pc->cached_server_channel_data);
877 Stream_Free(pc->remote_pem, TRUE);
878 free(pc->remote_hostname);
879 free(pc->computerName.v);
880 HashTable_Free(pc->interceptContextMap);
883static int pf_client_verify_X509_certificate(freerdp* instance,
const BYTE* data,
size_t length,
884 const char* hostname, UINT16 port, DWORD flags)
886 pClientContext* pc = NULL;
888 WINPR_ASSERT(instance);
890 WINPR_ASSERT(length > 0);
891 WINPR_ASSERT(hostname);
893 pc = (pClientContext*)instance->context;
896 if (!Stream_EnsureCapacity(pc->remote_pem, length))
898 Stream_SetPosition(pc->remote_pem, 0);
900 free(pc->remote_hostname);
901 pc->remote_hostname = NULL;
904 Stream_Write(pc->remote_pem, data, length);
907 pc->remote_hostname = _strdup(hostname);
908 pc->remote_port = port;
909 pc->remote_flags = flags;
911 Stream_SealLength(pc->remote_pem);
912 if (!pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_VERIFY_X509, pc->pdata, pc))
917void channel_data_free(
void* obj)
930 cnv.cpv = dst->channel_name;
936static void* channel_data_copy(
const void* obj)
953 if (src->channel_name)
955 dst->channel_name = _strdup(src->channel_name);
956 if (!dst->channel_name)
959 dst->data = malloc(src->data_len);
964 memcpy(cnv.pv, src->data, src->data_len);
968 channel_data_free(dst);
972static BOOL pf_client_client_new(freerdp* instance, rdpContext* context)
975 pClientContext* pc = (pClientContext*)context;
977 if (!instance || !context)
980 instance->LoadChannels = pf_client_load_channels;
981 instance->PreConnect = pf_client_pre_connect;
982 instance->PostConnect = pf_client_post_connect;
983 instance->PostDisconnect = pf_client_post_disconnect;
984 instance->Redirect = pf_client_redirect;
985 instance->LogonErrorInfo = pf_logon_error_info;
986 instance->VerifyX509Certificate = pf_client_verify_X509_certificate;
988 pc->remote_pem = Stream_New(NULL, 4096);
992 pc->sendChannelData = pf_client_send_channel_data;
993 pc->cached_server_channel_data = Queue_New(TRUE, -1, -1);
994 if (!pc->cached_server_channel_data)
996 obj = Queue_Object(pc->cached_server_channel_data);
998 obj->fnObjectNew = channel_data_copy;
999 obj->fnObjectFree = channel_data_free;
1001 pc->interceptContextMap = HashTable_New(FALSE);
1002 if (!pc->interceptContextMap)
1005 if (!HashTable_SetupForStringData(pc->interceptContextMap, FALSE))
1008 obj = HashTable_ValueObject(pc->interceptContextMap);
1010 obj->fnObjectFree = intercept_context_entry_free;
1015static int pf_client_client_stop(rdpContext* context)
1017 pClientContext* pc = (pClientContext*)context;
1018 proxyData* pdata = NULL;
1022 WINPR_ASSERT(pdata);
1024 PROXY_LOG_DBG(TAG, pc,
"aborting client connection");
1025 proxy_data_abort_connect(pdata);
1026 freerdp_abort_connect_context(context);
1031int RdpClientEntry(RDP_CLIENT_ENTRY_POINTS* pEntryPoints)
1033 WINPR_ASSERT(pEntryPoints);
1035 ZeroMemory(pEntryPoints,
sizeof(RDP_CLIENT_ENTRY_POINTS));
1036 pEntryPoints->Version = RDP_CLIENT_INTERFACE_VERSION;
1037 pEntryPoints->Size =
sizeof(RDP_CLIENT_ENTRY_POINTS_V1);
1038 pEntryPoints->ContextSize =
sizeof(pClientContext);
1040 pEntryPoints->ClientNew = pf_client_client_new;
1041 pEntryPoints->ClientFree = pf_client_context_free;
1042 pEntryPoints->ClientStop = pf_client_client_stop;
1049DWORD WINAPI pf_client_start(LPVOID arg)
1052 pClientContext* pc = (pClientContext*)arg;
1055 if (freerdp_client_start(&pc->context) == 0)
1056 rc = pf_client_thread_proc(pc);
1057 freerdp_client_stop(&pc->context);
FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
FREERDP_API BOOL freerdp_settings_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *param)
Sets a string settings value. The param is copied.
FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
FREERDP_API BOOL freerdp_settings_set_pointer_len(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id, const void *data, size_t len)
Set a pointer to value data.
FREERDP_API void * freerdp_settings_get_pointer_writable(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id)
Returns a mutable pointer settings value.
FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 param)
Sets a UINT32 settings value.
FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings *settings, FreeRDP_Settings_Keys_Bool id, BOOL param)
Sets a BOOL settings value.
This struct contains function pointer to initialize/free objects.