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);
57static BOOL proxy_server_reactivate(rdpContext* ps,
const rdpContext* pc)
62 if (!pf_context_copy_settings(ps->settings, pc->settings))
69 WINPR_ASSERT(ps->update);
70 return (ps->update->DesktopResize(ps));
73static void pf_client_on_error_info(
void* ctx,
const ErrorInfoEventArgs* e)
75 pClientContext* pc = (pClientContext*)ctx;
76 pServerContext* ps =
nullptr;
79 WINPR_ASSERT(pc->pdata);
84 if (e->code == ERRINFO_NONE)
87 PROXY_LOG_WARN(TAG, pc,
"received ErrorInfo PDU. code=0x%08" PRIu32
", message: %s", e->code,
88 freerdp_get_error_info_string(e->code));
91 freerdp_set_error_info(ps->context.rdp, e->code);
92 if (!freerdp_send_error_info(ps->context.rdp))
94 PROXY_LOG_WARN(TAG, pc,
"[fail] reply ErrorInfo PDU. code=0x%08" PRIu32
", message: %s",
95 e->code, freerdp_get_error_info_string(e->code));
99static void pf_client_on_activated(
void* ctx, WINPR_ATTR_UNUSED
const ActivatedEventArgs* e)
101 pClientContext* pc = (pClientContext*)ctx;
102 pServerContext* ps =
nullptr;
103 freerdp_peer* peer =
nullptr;
106 WINPR_ASSERT(pc->pdata);
111 peer = ps->context.peer;
113 WINPR_ASSERT(peer->context);
117static BOOL pf_client_load_rdpsnd(pClientContext* pc)
119 rdpContext* context = (rdpContext*)pc;
122 WINPR_ASSERT(pc->pdata);
127 if (!freerdp_static_channel_collection_find(context->settings, RDPSND_CHANNEL_NAME))
129 const char* params[2] = { RDPSND_CHANNEL_NAME,
"sys:fake" };
131 if (!freerdp_client_add_static_channel(context->settings, ARRAYSIZE(params), params))
139static BOOL pf_client_use_peer_load_balance_info(pClientContext* pc)
141 pServerContext* ps =
nullptr;
142 rdpSettings* settings =
nullptr;
143 DWORD lb_info_len = 0;
144 const char* lb_info =
nullptr;
147 WINPR_ASSERT(pc->pdata);
150 settings = pc->context.settings;
151 WINPR_ASSERT(settings);
153 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)
172static BOOL pf_client_use_proxy_smartcard_auth(
const rdpSettings* settings)
181 if (str_is_empty(key))
184 if (str_is_empty(cert))
191static BOOL pf_client_pre_connect(freerdp* instance)
193 pClientContext* pc =
nullptr;
194 pServerContext* ps =
nullptr;
195 const proxyConfig* config =
nullptr;
196 rdpSettings* settings =
nullptr;
198 WINPR_ASSERT(instance);
199 pc = (pClientContext*)instance->context;
201 WINPR_ASSERT(pc->pdata);
204 WINPR_ASSERT(ps->pdata);
205 config = ps->pdata->config;
206 WINPR_ASSERT(config);
207 settings = instance->context->settings;
208 WINPR_ASSERT(settings);
221 ZeroMemory(OrderSupport, 32);
223 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, DRDYNVC_SVC_CHANNEL_NAME))
237 config->DeviceRedirection) ||
239 config->DisplayControl) ||
243 if (config->RemoteApp)
245 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, RAIL_SVC_CHANNEL_NAME))
252 if (config->DeviceRedirection)
254 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, RDPDR_SVC_CHANNEL_NAME))
265 config->DisplayControl))
268 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, ENCOMSP_SVC_CHANNEL_NAME))
274 if (config->Clipboard)
276 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, CLIPRDR_SVC_CHANNEL_NAME))
286 if (PubSub_SubscribeErrorInfo(instance->context->pubSub, pf_client_on_error_info) < 0)
288 if (PubSub_SubscribeActivated(instance->context->pubSub, pf_client_on_activated) < 0)
290 if (!pf_client_use_peer_load_balance_info(pc))
293 return pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_PRE_CONNECT, pc->pdata, pc);
305static BOOL updateBackIdFn(WINPR_ATTR_UNUSED
const void* key,
void* value,
void* arg)
307 pServerStaticChannelContext* current = (pServerStaticChannelContext*)value;
308 UpdateBackIdArgs* updateArgs = (UpdateBackIdArgs*)arg;
310 if (strcmp(updateArgs->name, current->channel_name) != 0)
313 current->back_channel_id = updateArgs->backId;
314 if (!HashTable_Insert(updateArgs->ps->channelsByBackId, ¤t->back_channel_id, current))
316 WLog_ERR(TAG,
"error inserting channel in channelsByBackId table");
322static BOOL pf_client_update_back_id(pServerContext* ps,
const char* name, UINT32 backId)
324 UpdateBackIdArgs res = { ps, name, backId };
326 return HashTable_Foreach(ps->channelsByFrontId, updateBackIdFn, &res) == FALSE;
330static BOOL pf_client_load_channels(freerdp* instance)
332 pClientContext* pc =
nullptr;
333 pServerContext* ps =
nullptr;
334 const proxyConfig* config =
nullptr;
335 rdpSettings* settings =
nullptr;
337 WINPR_ASSERT(instance);
338 pc = (pClientContext*)instance->context;
340 WINPR_ASSERT(pc->pdata);
343 WINPR_ASSERT(ps->pdata);
344 config = ps->pdata->config;
345 WINPR_ASSERT(config);
346 settings = instance->context->settings;
347 WINPR_ASSERT(settings);
352 PROXY_LOG_INFO(TAG, pc,
"Loading addins");
354 if (!pf_client_load_rdpsnd(pc))
356 PROXY_LOG_ERR(TAG, pc,
"Failed to load rdpsnd client");
360 if (!pf_utils_is_passthrough(config))
362 if (!freerdp_client_load_addins(instance->context->channels, settings))
364 PROXY_LOG_ERR(TAG, pc,
"Failed to load addins");
370 if (!pf_channel_rdpdr_client_new(pc))
372#if defined(WITH_PROXY_EMULATE_SMARTCARD)
373 if (!pf_channel_smartcard_client_new(pc))
377 if (!freerdp_channels_from_mcs(settings, &ps->context))
383 settings, FreeRDP_ChannelDefArray, 0);
385 UINT32
id = MCS_GLOBAL_CHANNEL_ID + 1;
387 WINPR_ASSERT(channels || (size == 0));
395 dev.channel_name = cur->name;
396 dev.flags = cur->options;
399 if (!pf_modules_run_filter(pc->pdata->module,
400 FILTER_TYPE_CLIENT_PASSTHROUGH_CHANNEL_CREATE, pc->pdata,
403 const size_t s = size - MIN(size, x + 1);
409 if (!pf_client_update_back_id(ps, cur->name,
id++))
411 WLog_ERR(TAG,
"unable to update backid for channel %s", cur->name);
422 return pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_LOAD_CHANNELS, pc->pdata, pc);
426static BOOL pf_client_receive_channel_data_hook(freerdp* instance, UINT16 channelId,
427 const BYTE* xdata,
size_t xsize, UINT32 flags,
430 pClientContext* pc =
nullptr;
431 pServerContext* ps =
nullptr;
432 proxyData* pdata =
nullptr;
433 pServerStaticChannelContext* channel =
nullptr;
434 UINT64 channelId64 = channelId;
436 WINPR_ASSERT(instance);
437 WINPR_ASSERT(xdata || (xsize == 0));
439 pc = (pClientContext*)instance->context;
441 WINPR_ASSERT(pc->pdata);
449 channel = HashTable_GetItemValue(ps->channelsByBackId, &channelId64);
453 WINPR_ASSERT(channel->onBackData);
454 switch (channel->onBackData(pdata, channel, xdata, xsize, flags, totalSize))
456 case PF_CHANNEL_RESULT_PASS:
460 if (channel->front_channel_id == 0)
463 return ps->context.peer->SendChannelPacket(
464 ps->context.peer, WINPR_ASSERTING_INT_CAST(UINT16, channel->front_channel_id),
465 totalSize, flags, xdata, xsize);
466 case PF_CHANNEL_RESULT_DROP:
468 case PF_CHANNEL_RESULT_ERROR:
475static BOOL pf_client_on_server_heartbeat(freerdp* instance, BYTE period, BYTE count1, BYTE count2)
477 pClientContext* pc =
nullptr;
478 pServerContext* ps =
nullptr;
480 WINPR_ASSERT(instance);
481 pc = (pClientContext*)instance->context;
483 WINPR_ASSERT(pc->pdata);
487 return freerdp_heartbeat_send_heartbeat_pdu(ps->context.peer, period, count1, count2);
496 return Queue_Enqueue(pc->cached_server_channel_data, ev);
500static BOOL sendQueuedChannelData(pClientContext* pc)
510 Queue_Lock(pc->cached_server_channel_data);
511 while (rc && (ev = Queue_Dequeue(pc->cached_server_channel_data)))
513 UINT16 channelId = 0;
514 WINPR_ASSERT(pc->context.instance);
516 channelId = freerdp_channels_get_id_by_name(pc->context.instance, ev->channel_name);
518 if ((channelId == 0) || (channelId == UINT16_MAX))
522 WINPR_ASSERT(pc->context.instance->SendChannelPacket);
523 rc = pc->context.instance->SendChannelPacket(pc->context.instance, channelId,
524 ev->total_size, ev->flags, ev->data,
527 channel_data_free(ev);
530 Queue_Unlock(pc->cached_server_channel_data);
546static BOOL pf_client_post_connect(freerdp* instance)
548 WINPR_ASSERT(instance);
549 rdpContext* context = instance->context;
550 WINPR_ASSERT(context);
551 rdpUpdate* update = context->update;
552 WINPR_ASSERT(update);
553 pClientContext* pc = (pClientContext*)context;
555 WINPR_ASSERT(pc->pdata);
556 rdpContext* ps = (rdpContext*)pc->pdata->ps;
559 if (!pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_POST_CONNECT, pc->pdata, pc))
562 if (!gdi_init(instance, PIXEL_FORMAT_BGRA32))
567 pf_client_register_update_callbacks(update);
570 pc->client_receive_channel_data_original = instance->ReceiveChannelData;
571 instance->ReceiveChannelData = pf_client_receive_channel_data_hook;
573 instance->heartbeat->ServerHeartbeat = pf_client_on_server_heartbeat;
575 pc->connected = TRUE;
578 if (!sendQueuedChannelData(pc))
586 return proxy_server_reactivate(ps, context);
592static void pf_client_post_disconnect(freerdp* instance)
594 pClientContext* pc =
nullptr;
595 proxyData* pdata =
nullptr;
600 if (!instance->context)
603 pc = (pClientContext*)instance->context;
608#if defined(WITH_PROXY_EMULATE_SMARTCARD)
609 pf_channel_smartcard_client_free(pc);
612 pf_channel_rdpdr_client_free(pc);
614 pc->connected = FALSE;
615 (void)pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_POST_DISCONNECT, pc->pdata, pc);
617 PubSub_UnsubscribeErrorInfo(instance->context->pubSub, pf_client_on_error_info);
621 if (!pc->allow_next_conn_failure)
622 proxy_data_abort_connect(pdata);
626static BOOL pf_client_redirect(freerdp* instance)
631 if (!instance->context)
634 pClientContext* pc = (pClientContext*)instance->context;
637#if defined(WITH_PROXY_EMULATE_SMARTCARD)
638 pf_channel_smartcard_client_reset(pc);
640 pf_channel_rdpdr_client_reset(pc);
642 return pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_REDIRECT, pc->pdata, pc);
652static BOOL pf_client_should_retry_without_nla(pClientContext* pc)
654 rdpSettings* settings =
nullptr;
655 const proxyConfig* config =
nullptr;
658 WINPR_ASSERT(pc->pdata);
659 settings = pc->context.settings;
660 WINPR_ASSERT(settings);
661 config = pc->pdata->config;
662 WINPR_ASSERT(config);
664 if (!config->ClientAllowFallbackToTls ||
668 return config->ClientTlsSecurity || config->ClientRdpSecurity;
672static BOOL pf_client_set_security_settings(pClientContext* pc)
675 WINPR_ASSERT(pc->pdata);
676 rdpSettings* settings = pc->context.settings;
677 WINPR_ASSERT(settings);
678 const proxyConfig* config = pc->pdata->config;
679 WINPR_ASSERT(config);
688 if (pf_client_use_proxy_smartcard_auth(settings))
705static BOOL pf_client_connect_without_nla(pClientContext* pc)
707 freerdp* instance =
nullptr;
708 rdpSettings* settings =
nullptr;
711 instance = pc->context.instance;
712 WINPR_ASSERT(instance);
714 if (!freerdp_context_reset(instance))
717 settings = pc->context.settings;
718 WINPR_ASSERT(settings);
729 pc->allow_next_conn_failure = FALSE;
730 return freerdp_connect(instance);
734static BOOL pf_client_connect(freerdp* instance)
736 pClientContext* pc =
nullptr;
737 rdpSettings* settings =
nullptr;
741 WINPR_ASSERT(instance);
742 pc = (pClientContext*)instance->context;
744 settings = instance->context->settings;
745 WINPR_ASSERT(settings);
747 PROXY_LOG_INFO(TAG, pc,
"connecting using client info: Username: %s, Domain: %s",
751 if (!pf_client_set_security_settings(pc))
754 if (pf_client_should_retry_without_nla(pc))
755 retry = pc->allow_next_conn_failure = TRUE;
757 PROXY_LOG_INFO(TAG, pc,
"connecting using security settings: rdp=%d, tls=%d, nla=%d",
762 if (!freerdp_connect(instance))
764 if (!pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_LOGIN_FAILURE, pc->pdata, pc))
770 PROXY_LOG_ERR(TAG, pc,
"failed to connect with NLA. retrying to connect without NLA");
771 if (!pf_client_connect_without_nla(pc))
773 PROXY_LOG_ERR(TAG, pc,
"pf_client_connect_without_nla failed!");
780 pc->allow_next_conn_failure = FALSE;
790static DWORD WINAPI pf_client_thread_proc(pClientContext* pc)
792 freerdp* instance =
nullptr;
793 proxyData* pdata =
nullptr;
796 HANDLE handles[MAXIMUM_WAIT_OBJECTS] = WINPR_C_ARRAY_INIT;
800 instance = pc->context.instance;
801 WINPR_ASSERT(instance);
812 handles[nCount++] = pdata->abort_event;
814 if (!pf_modules_run_hook(pdata->module, HOOK_TYPE_CLIENT_INIT_CONNECT, pdata, pc))
816 proxy_data_abort_connect(pdata);
820 if (!pf_client_connect(instance))
822 proxy_data_abort_connect(pdata);
825 handles[nCount++] = Queue_Event(pc->cached_server_channel_data);
827 while (!freerdp_shall_disconnect_context(instance->context))
829 UINT32 tmp = freerdp_get_event_handles(instance->context, &handles[nCount],
830 ARRAYSIZE(handles) - nCount);
834 PROXY_LOG_ERR(TAG, pc,
"freerdp_get_event_handles failed!");
838 status = WaitForMultipleObjects(nCount + tmp, handles, FALSE, INFINITE);
840 if (status == WAIT_FAILED)
842 WLog_ERR(TAG,
"WaitForMultipleObjects failed with %" PRIu32
"", status);
847 if (status == WAIT_OBJECT_0)
850 if (freerdp_shall_disconnect_context(instance->context))
853 if (proxy_data_shall_disconnect(pdata))
856 if (!freerdp_check_event_handles(instance->context))
858 if (freerdp_get_last_error(instance->context) == FREERDP_ERROR_SUCCESS)
859 WLog_ERR(TAG,
"Failed to check FreeRDP event handles");
863 if (!sendQueuedChannelData(pc))
867 freerdp_disconnect(instance);
870 (void)pf_modules_run_hook(pdata->module, HOOK_TYPE_CLIENT_UNINIT_CONNECT, pdata, pc);
876static int pf_logon_error_info(freerdp* instance, UINT32 data, UINT32 type)
878 const char* str_data = freerdp_get_logon_error_info_data(data);
879 const char* str_type = freerdp_get_logon_error_info_type(type);
881 if (!instance || !instance->context)
884 WLog_INFO(TAG,
"Logon Error Info %s [%s]", str_data, str_type);
888static void pf_client_context_free(freerdp* instance, rdpContext* context)
890 pClientContext* pc = (pClientContext*)context;
891 WINPR_UNUSED(instance);
896 pc->sendChannelData =
nullptr;
897 Queue_Free(pc->cached_server_channel_data);
898 Stream_Free(pc->remote_pem, TRUE);
899 free(pc->remote_hostname);
900 free(pc->computerName.v);
901 HashTable_Free(pc->interceptContextMap);
905static int pf_client_verify_X509_certificate(freerdp* instance,
const BYTE* data,
size_t length,
906 const char* hostname, UINT16 port, DWORD flags)
908 pClientContext* pc =
nullptr;
910 WINPR_ASSERT(instance);
912 WINPR_ASSERT(length > 0);
913 WINPR_ASSERT(hostname);
915 pc = (pClientContext*)instance->context;
918 if (!Stream_EnsureCapacity(pc->remote_pem, length))
920 Stream_ResetPosition(pc->remote_pem);
922 free(pc->remote_hostname);
923 pc->remote_hostname =
nullptr;
926 Stream_Write(pc->remote_pem, data, length);
929 pc->remote_hostname = _strdup(hostname);
930 pc->remote_port = port;
931 pc->remote_flags = flags;
933 Stream_SealLength(pc->remote_pem);
934 if (!pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_VERIFY_X509, pc->pdata, pc))
939void channel_data_free(
void* obj)
952 cnv.cpv = dst->channel_name;
958WINPR_ATTR_MALLOC(channel_data_free, 1)
960static
void* channel_data_copy(const
void* obj)
977 if (src->channel_name)
979 dst->channel_name = _strdup(src->channel_name);
980 if (!dst->channel_name)
983 dst->data = malloc(src->data_len);
988 memcpy(cnv.pv, src->data, src->data_len);
992 channel_data_free(dst);
997static BOOL pf_client_client_new(freerdp* instance, rdpContext* context)
1000 pClientContext* pc = (pClientContext*)context;
1002 if (!instance || !context)
1005 instance->LoadChannels = pf_client_load_channels;
1006 instance->PreConnect = pf_client_pre_connect;
1007 instance->PostConnect = pf_client_post_connect;
1008 instance->PostDisconnect = pf_client_post_disconnect;
1009 instance->Redirect = pf_client_redirect;
1010 instance->LogonErrorInfo = pf_logon_error_info;
1011 instance->VerifyX509Certificate = pf_client_verify_X509_certificate;
1013 pc->remote_pem = Stream_New(
nullptr, 4096);
1014 if (!pc->remote_pem)
1017 pc->sendChannelData = pf_client_send_channel_data;
1018 pc->cached_server_channel_data = Queue_New(TRUE, -1, -1);
1019 if (!pc->cached_server_channel_data)
1021 obj = Queue_Object(pc->cached_server_channel_data);
1026 pc->interceptContextMap = HashTable_New(FALSE);
1027 if (!pc->interceptContextMap)
1030 if (!HashTable_SetupForStringData(pc->interceptContextMap, FALSE))
1033 obj = HashTable_ValueObject(pc->interceptContextMap);
1041static int pf_client_client_stop(rdpContext* context)
1043 pClientContext* pc = (pClientContext*)context;
1044 proxyData* pdata =
nullptr;
1048 WINPR_ASSERT(pdata);
1050 PROXY_LOG_DBG(TAG, pc,
"aborting client connection");
1051 proxy_data_abort_connect(pdata);
1052 freerdp_abort_connect_context(context);
1057int RdpClientEntry(RDP_CLIENT_ENTRY_POINTS* pEntryPoints)
1059 WINPR_ASSERT(pEntryPoints);
1061 ZeroMemory(pEntryPoints,
sizeof(RDP_CLIENT_ENTRY_POINTS));
1062 pEntryPoints->Version = RDP_CLIENT_INTERFACE_VERSION;
1063 pEntryPoints->Size =
sizeof(RDP_CLIENT_ENTRY_POINTS_V1);
1064 pEntryPoints->ContextSize =
sizeof(pClientContext);
1066 pEntryPoints->ClientNew = pf_client_client_new;
1067 pEntryPoints->ClientFree = pf_client_context_free;
1068 pEntryPoints->ClientStop = pf_client_client_stop;
1075DWORD WINAPI pf_client_start(LPVOID arg)
1078 pClientContext* pc = (pClientContext*)arg;
1081 if (freerdp_client_start(&pc->context) == 0)
1082 rc = pf_client_thread_proc(pc);
1083 freerdp_client_stop(&pc->context);
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_set_bool(rdpSettings *settings, FreeRDP_Settings_Keys_Bool id, BOOL val)
Sets a BOOL settings value.
WINPR_ATTR_NODISCARD FREERDP_API void * freerdp_settings_get_pointer_writable(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id)
Returns a mutable pointer settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 val)
Sets a UINT32 settings value.
WINPR_ATTR_NODISCARD 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.
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val)
Sets a string settings value. The param is copied.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
This struct contains function pointer to initialize/free objects.
OBJECT_FREE_FN fnObjectFree
WINPR_ATTR_NODISCARD OBJECT_NEW_FN fnObjectNew