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);
115 PROXY_LOG_INFO(TAG, pc,
"client activated, registering server input callbacks");
118 pf_server_register_input_callbacks(peer->context->input);
119 pf_server_register_update_callbacks(peer->context->update);
123static BOOL pf_client_load_rdpsnd(pClientContext* pc)
125 rdpContext* context = (rdpContext*)pc;
128 WINPR_ASSERT(pc->pdata);
133 if (!freerdp_static_channel_collection_find(context->settings, RDPSND_CHANNEL_NAME))
135 const char* params[2] = { RDPSND_CHANNEL_NAME,
"sys:fake" };
137 if (!freerdp_client_add_static_channel(context->settings, ARRAYSIZE(params), params))
145static BOOL pf_client_use_peer_load_balance_info(pClientContext* pc)
147 pServerContext* ps =
nullptr;
148 rdpSettings* settings =
nullptr;
149 DWORD lb_info_len = 0;
150 const char* lb_info =
nullptr;
153 WINPR_ASSERT(pc->pdata);
156 settings = pc->context.settings;
157 WINPR_ASSERT(settings);
159 lb_info = freerdp_nego_get_routing_token(&ps->context, &lb_info_len);
168static BOOL str_is_empty(
const char* str)
172 if (strlen(str) == 0)
178static BOOL pf_client_use_proxy_smartcard_auth(
const rdpSettings* settings)
187 if (str_is_empty(key))
190 if (str_is_empty(cert))
197static BOOL pf_client_pre_connect(freerdp* instance)
199 pClientContext* pc =
nullptr;
200 pServerContext* ps =
nullptr;
201 const proxyConfig* config =
nullptr;
202 rdpSettings* settings =
nullptr;
204 WINPR_ASSERT(instance);
205 pc = (pClientContext*)instance->context;
207 WINPR_ASSERT(pc->pdata);
210 WINPR_ASSERT(ps->pdata);
211 config = ps->pdata->config;
212 WINPR_ASSERT(config);
213 settings = instance->context->settings;
214 WINPR_ASSERT(settings);
227 ZeroMemory(OrderSupport, 32);
229 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, DRDYNVC_SVC_CHANNEL_NAME))
243 config->DeviceRedirection) ||
245 config->DisplayControl) ||
249 if (config->RemoteApp)
251 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, RAIL_SVC_CHANNEL_NAME))
258 if (config->DeviceRedirection)
260 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, RDPDR_SVC_CHANNEL_NAME))
271 config->DisplayControl))
274 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, ENCOMSP_SVC_CHANNEL_NAME))
280 if (config->Clipboard)
282 if (WTSVirtualChannelManagerIsChannelJoined(ps->vcm, CLIPRDR_SVC_CHANNEL_NAME))
292 if (PubSub_SubscribeErrorInfo(instance->context->pubSub, pf_client_on_error_info) < 0)
294 if (PubSub_SubscribeActivated(instance->context->pubSub, pf_client_on_activated) < 0)
296 if (!pf_client_use_peer_load_balance_info(pc))
299 return pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_PRE_CONNECT, pc->pdata, pc);
311static BOOL updateBackIdFn(WINPR_ATTR_UNUSED
const void* key,
void* value,
void* arg)
313 pServerStaticChannelContext* current = (pServerStaticChannelContext*)value;
314 UpdateBackIdArgs* updateArgs = (UpdateBackIdArgs*)arg;
316 if (strcmp(updateArgs->name, current->channel_name) != 0)
319 current->back_channel_id = updateArgs->backId;
320 if (!HashTable_Insert(updateArgs->ps->channelsByBackId, ¤t->back_channel_id, current))
322 WLog_ERR(TAG,
"error inserting channel in channelsByBackId table");
328static BOOL pf_client_update_back_id(pServerContext* ps,
const char* name, UINT32 backId)
330 UpdateBackIdArgs res = { ps, name, backId };
332 return HashTable_Foreach(ps->channelsByFrontId, updateBackIdFn, &res) == FALSE;
336static BOOL pf_client_load_channels(freerdp* instance)
338 pClientContext* pc =
nullptr;
339 pServerContext* ps =
nullptr;
340 const proxyConfig* config =
nullptr;
341 rdpSettings* settings =
nullptr;
343 WINPR_ASSERT(instance);
344 pc = (pClientContext*)instance->context;
346 WINPR_ASSERT(pc->pdata);
349 WINPR_ASSERT(ps->pdata);
350 config = ps->pdata->config;
351 WINPR_ASSERT(config);
352 settings = instance->context->settings;
353 WINPR_ASSERT(settings);
358 PROXY_LOG_INFO(TAG, pc,
"Loading addins");
360 if (!pf_client_load_rdpsnd(pc))
362 PROXY_LOG_ERR(TAG, pc,
"Failed to load rdpsnd client");
366 if (!pf_utils_is_passthrough(config))
368 if (!freerdp_client_load_addins(instance->context->channels, settings))
370 PROXY_LOG_ERR(TAG, pc,
"Failed to load addins");
376 if (!pf_channel_rdpdr_client_new(pc))
378#if defined(WITH_PROXY_EMULATE_SMARTCARD)
379 if (!pf_channel_smartcard_client_new(pc))
383 if (!freerdp_channels_from_mcs(settings, &ps->context))
389 settings, FreeRDP_ChannelDefArray, 0);
391 UINT32
id = MCS_GLOBAL_CHANNEL_ID + 1;
393 WINPR_ASSERT(channels || (size == 0));
401 dev.channel_name = cur->name;
402 dev.flags = cur->options;
405 if (!pf_modules_run_filter(pc->pdata->module,
406 FILTER_TYPE_CLIENT_PASSTHROUGH_CHANNEL_CREATE, pc->pdata,
409 const size_t s = size - MIN(size, x + 1);
415 if (!pf_client_update_back_id(ps, cur->name,
id++))
417 WLog_ERR(TAG,
"unable to update backid for channel %s", cur->name);
428 return pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_LOAD_CHANNELS, pc->pdata, pc);
432static BOOL pf_client_receive_channel_data_hook(freerdp* instance, UINT16 channelId,
433 const BYTE* xdata,
size_t xsize, UINT32 flags,
436 pClientContext* pc =
nullptr;
437 pServerContext* ps =
nullptr;
438 proxyData* pdata =
nullptr;
439 pServerStaticChannelContext* channel =
nullptr;
440 UINT64 channelId64 = channelId;
442 WINPR_ASSERT(instance);
443 WINPR_ASSERT(xdata || (xsize == 0));
445 pc = (pClientContext*)instance->context;
447 WINPR_ASSERT(pc->pdata);
455 channel = HashTable_GetItemValue(ps->channelsByBackId, &channelId64);
459 WINPR_ASSERT(channel->onBackData);
460 switch (channel->onBackData(pdata, channel, xdata, xsize, flags, totalSize))
462 case PF_CHANNEL_RESULT_PASS:
466 if (channel->front_channel_id == 0)
469 return ps->context.peer->SendChannelPacket(
470 ps->context.peer, WINPR_ASSERTING_INT_CAST(UINT16, channel->front_channel_id),
471 totalSize, flags, xdata, xsize);
472 case PF_CHANNEL_RESULT_DROP:
474 case PF_CHANNEL_RESULT_ERROR:
481static BOOL pf_client_on_server_heartbeat(freerdp* instance, BYTE period, BYTE count1, BYTE count2)
483 pClientContext* pc =
nullptr;
484 pServerContext* ps =
nullptr;
486 WINPR_ASSERT(instance);
487 pc = (pClientContext*)instance->context;
489 WINPR_ASSERT(pc->pdata);
493 return freerdp_heartbeat_send_heartbeat_pdu(ps->context.peer, period, count1, count2);
502 return Queue_Enqueue(pc->cached_server_channel_data, ev);
506static BOOL sendQueuedChannelData(pClientContext* pc)
516 Queue_Lock(pc->cached_server_channel_data);
517 while (rc && (ev = Queue_Dequeue(pc->cached_server_channel_data)))
519 UINT16 channelId = 0;
520 WINPR_ASSERT(pc->context.instance);
522 channelId = freerdp_channels_get_id_by_name(pc->context.instance, ev->channel_name);
524 if ((channelId == 0) || (channelId == UINT16_MAX))
528 WINPR_ASSERT(pc->context.instance->SendChannelPacket);
529 rc = pc->context.instance->SendChannelPacket(pc->context.instance, channelId,
530 ev->total_size, ev->flags, ev->data,
533 channel_data_free(ev);
536 Queue_Unlock(pc->cached_server_channel_data);
552static BOOL pf_client_post_connect(freerdp* instance)
554 WINPR_ASSERT(instance);
555 rdpContext* context = instance->context;
556 WINPR_ASSERT(context);
557 rdpUpdate* update = context->update;
558 WINPR_ASSERT(update);
559 pClientContext* pc = (pClientContext*)context;
561 WINPR_ASSERT(pc->pdata);
562 rdpContext* ps = (rdpContext*)pc->pdata->ps;
565 if (!pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_POST_CONNECT, pc->pdata, pc))
568 if (!gdi_init(instance, PIXEL_FORMAT_BGRA32))
573 pf_client_register_update_callbacks(update);
576 pc->client_receive_channel_data_original = instance->ReceiveChannelData;
577 instance->ReceiveChannelData = pf_client_receive_channel_data_hook;
579 instance->heartbeat->ServerHeartbeat = pf_client_on_server_heartbeat;
581 pc->connected = TRUE;
584 if (!sendQueuedChannelData(pc))
592 return proxy_server_reactivate(ps, context);
598static void pf_client_post_disconnect(freerdp* instance)
600 pClientContext* pc =
nullptr;
601 proxyData* pdata =
nullptr;
606 if (!instance->context)
609 pc = (pClientContext*)instance->context;
614#if defined(WITH_PROXY_EMULATE_SMARTCARD)
615 pf_channel_smartcard_client_free(pc);
618 pf_channel_rdpdr_client_free(pc);
620 pc->connected = FALSE;
621 (void)pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_POST_DISCONNECT, pc->pdata, pc);
623 PubSub_UnsubscribeErrorInfo(instance->context->pubSub, pf_client_on_error_info);
627 if (!pc->allow_next_conn_failure)
628 proxy_data_abort_connect(pdata);
632static BOOL pf_client_redirect(freerdp* instance)
637 if (!instance->context)
640 pClientContext* pc = (pClientContext*)instance->context;
643#if defined(WITH_PROXY_EMULATE_SMARTCARD)
644 pf_channel_smartcard_client_reset(pc);
646 pf_channel_rdpdr_client_reset(pc);
648 return pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_REDIRECT, pc->pdata, pc);
658static BOOL pf_client_should_retry_without_nla(pClientContext* pc)
660 rdpSettings* settings =
nullptr;
661 const proxyConfig* config =
nullptr;
664 WINPR_ASSERT(pc->pdata);
665 settings = pc->context.settings;
666 WINPR_ASSERT(settings);
667 config = pc->pdata->config;
668 WINPR_ASSERT(config);
670 if (!config->ClientAllowFallbackToTls ||
674 return config->ClientTlsSecurity || config->ClientRdpSecurity;
678static BOOL pf_client_set_security_settings(pClientContext* pc)
681 WINPR_ASSERT(pc->pdata);
682 rdpSettings* settings = pc->context.settings;
683 WINPR_ASSERT(settings);
684 const proxyConfig* config = pc->pdata->config;
685 WINPR_ASSERT(config);
694 if (pf_client_use_proxy_smartcard_auth(settings))
711static BOOL pf_client_connect_without_nla(pClientContext* pc)
713 freerdp* instance =
nullptr;
714 rdpSettings* settings =
nullptr;
717 instance = pc->context.instance;
718 WINPR_ASSERT(instance);
720 if (!freerdp_context_reset(instance))
723 settings = pc->context.settings;
724 WINPR_ASSERT(settings);
735 pc->allow_next_conn_failure = FALSE;
736 return freerdp_connect(instance);
740static BOOL pf_client_connect(freerdp* instance)
742 pClientContext* pc =
nullptr;
743 rdpSettings* settings =
nullptr;
747 WINPR_ASSERT(instance);
748 pc = (pClientContext*)instance->context;
750 settings = instance->context->settings;
751 WINPR_ASSERT(settings);
753 PROXY_LOG_INFO(TAG, pc,
"connecting using client info: Username: %s, Domain: %s",
757 if (!pf_client_set_security_settings(pc))
760 if (pf_client_should_retry_without_nla(pc))
761 retry = pc->allow_next_conn_failure = TRUE;
763 PROXY_LOG_INFO(TAG, pc,
"connecting using security settings: rdp=%d, tls=%d, nla=%d",
768 if (!freerdp_connect(instance))
770 if (!pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_LOGIN_FAILURE, pc->pdata, pc))
776 PROXY_LOG_ERR(TAG, pc,
"failed to connect with NLA. retrying to connect without NLA");
777 if (!pf_client_connect_without_nla(pc))
779 PROXY_LOG_ERR(TAG, pc,
"pf_client_connect_without_nla failed!");
786 pc->allow_next_conn_failure = FALSE;
796static DWORD WINAPI pf_client_thread_proc(pClientContext* pc)
798 freerdp* instance =
nullptr;
799 proxyData* pdata =
nullptr;
802 HANDLE handles[MAXIMUM_WAIT_OBJECTS] = WINPR_C_ARRAY_INIT;
806 instance = pc->context.instance;
807 WINPR_ASSERT(instance);
818 handles[nCount++] = pdata->abort_event;
820 if (!pf_modules_run_hook(pdata->module, HOOK_TYPE_CLIENT_INIT_CONNECT, pdata, pc))
822 proxy_data_abort_connect(pdata);
826 if (!pf_client_connect(instance))
828 proxy_data_abort_connect(pdata);
831 handles[nCount++] = Queue_Event(pc->cached_server_channel_data);
833 while (!freerdp_shall_disconnect_context(instance->context))
835 UINT32 tmp = freerdp_get_event_handles(instance->context, &handles[nCount],
836 ARRAYSIZE(handles) - nCount);
840 PROXY_LOG_ERR(TAG, pc,
"freerdp_get_event_handles failed!");
844 status = WaitForMultipleObjects(nCount + tmp, handles, FALSE, INFINITE);
846 if (status == WAIT_FAILED)
848 WLog_ERR(TAG,
"WaitForMultipleObjects failed with %" PRIu32
"", status);
853 if (status == WAIT_OBJECT_0)
856 if (freerdp_shall_disconnect_context(instance->context))
859 if (proxy_data_shall_disconnect(pdata))
862 if (!freerdp_check_event_handles(instance->context))
864 if (freerdp_get_last_error(instance->context) == FREERDP_ERROR_SUCCESS)
865 WLog_ERR(TAG,
"Failed to check FreeRDP event handles");
869 if (!sendQueuedChannelData(pc))
873 freerdp_disconnect(instance);
876 (void)pf_modules_run_hook(pdata->module, HOOK_TYPE_CLIENT_UNINIT_CONNECT, pdata, pc);
882static int pf_logon_error_info(freerdp* instance, UINT32 data, UINT32 type)
884 const char* str_data = freerdp_get_logon_error_info_data(data);
885 const char* str_type = freerdp_get_logon_error_info_type(type);
887 if (!instance || !instance->context)
890 WLog_INFO(TAG,
"Logon Error Info %s [%s]", str_data, str_type);
894static void pf_client_context_free(freerdp* instance, rdpContext* context)
896 pClientContext* pc = (pClientContext*)context;
897 WINPR_UNUSED(instance);
902 pc->sendChannelData =
nullptr;
903 Queue_Free(pc->cached_server_channel_data);
904 Stream_Free(pc->remote_pem, TRUE);
905 free(pc->remote_hostname);
906 free(pc->computerName.v);
907 HashTable_Free(pc->interceptContextMap);
911static int pf_client_verify_X509_certificate(freerdp* instance,
const BYTE* data,
size_t length,
912 const char* hostname, UINT16 port, DWORD flags)
914 pClientContext* pc =
nullptr;
916 WINPR_ASSERT(instance);
918 WINPR_ASSERT(length > 0);
919 WINPR_ASSERT(hostname);
921 pc = (pClientContext*)instance->context;
924 if (!Stream_EnsureCapacity(pc->remote_pem, length))
926 Stream_SetPosition(pc->remote_pem, 0);
928 free(pc->remote_hostname);
929 pc->remote_hostname =
nullptr;
932 Stream_Write(pc->remote_pem, data, length);
935 pc->remote_hostname = _strdup(hostname);
936 pc->remote_port = port;
937 pc->remote_flags = flags;
939 Stream_SealLength(pc->remote_pem);
940 if (!pf_modules_run_hook(pc->pdata->module, HOOK_TYPE_CLIENT_VERIFY_X509, pc->pdata, pc))
945void channel_data_free(
void* obj)
958 cnv.cpv = dst->channel_name;
964WINPR_ATTR_MALLOC(channel_data_free, 1)
966static
void* channel_data_copy(const
void* obj)
983 if (src->channel_name)
985 dst->channel_name = _strdup(src->channel_name);
986 if (!dst->channel_name)
989 dst->data = malloc(src->data_len);
994 memcpy(cnv.pv, src->data, src->data_len);
998 channel_data_free(dst);
1003static BOOL pf_client_client_new(freerdp* instance, rdpContext* context)
1006 pClientContext* pc = (pClientContext*)context;
1008 if (!instance || !context)
1011 instance->LoadChannels = pf_client_load_channels;
1012 instance->PreConnect = pf_client_pre_connect;
1013 instance->PostConnect = pf_client_post_connect;
1014 instance->PostDisconnect = pf_client_post_disconnect;
1015 instance->Redirect = pf_client_redirect;
1016 instance->LogonErrorInfo = pf_logon_error_info;
1017 instance->VerifyX509Certificate = pf_client_verify_X509_certificate;
1019 pc->remote_pem = Stream_New(
nullptr, 4096);
1020 if (!pc->remote_pem)
1023 pc->sendChannelData = pf_client_send_channel_data;
1024 pc->cached_server_channel_data = Queue_New(TRUE, -1, -1);
1025 if (!pc->cached_server_channel_data)
1027 obj = Queue_Object(pc->cached_server_channel_data);
1032 pc->interceptContextMap = HashTable_New(FALSE);
1033 if (!pc->interceptContextMap)
1036 if (!HashTable_SetupForStringData(pc->interceptContextMap, FALSE))
1039 obj = HashTable_ValueObject(pc->interceptContextMap);
1047static int pf_client_client_stop(rdpContext* context)
1049 pClientContext* pc = (pClientContext*)context;
1050 proxyData* pdata =
nullptr;
1054 WINPR_ASSERT(pdata);
1056 PROXY_LOG_DBG(TAG, pc,
"aborting client connection");
1057 proxy_data_abort_connect(pdata);
1058 freerdp_abort_connect_context(context);
1063int RdpClientEntry(RDP_CLIENT_ENTRY_POINTS* pEntryPoints)
1065 WINPR_ASSERT(pEntryPoints);
1067 ZeroMemory(pEntryPoints,
sizeof(RDP_CLIENT_ENTRY_POINTS));
1068 pEntryPoints->Version = RDP_CLIENT_INTERFACE_VERSION;
1069 pEntryPoints->Size =
sizeof(RDP_CLIENT_ENTRY_POINTS_V1);
1070 pEntryPoints->ContextSize =
sizeof(pClientContext);
1072 pEntryPoints->ClientNew = pf_client_client_new;
1073 pEntryPoints->ClientFree = pf_client_context_free;
1074 pEntryPoints->ClientStop = pf_client_client_stop;
1081DWORD WINAPI pf_client_start(LPVOID arg)
1084 pClientContext* pc = (pClientContext*)arg;
1087 if (freerdp_client_start(&pc->context) == 0)
1088 rc = pf_client_thread_proc(pc);
1089 freerdp_client_stop(&pc->context);
FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 val)
Sets a UINT32 settings value.
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 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_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 void * freerdp_settings_get_pointer_writable(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id)
Returns a mutable pointer settings value.
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_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
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.
This struct contains function pointer to initialize/free objects.
OBJECT_FREE_FN fnObjectFree
OBJECT_NEW_FN fnObjectNew