23#include <winpr/assert.h>
25#include <winpr/file.h>
26#include <winpr/wlog.h>
27#include <winpr/path.h>
28#include <winpr/library.h>
29#include <freerdp/api.h>
30#include <freerdp/build-config.h>
32#include <freerdp/server/proxy/proxy_log.h>
33#include <freerdp/server/proxy/proxy_modules_api.h>
35#include <freerdp/server/proxy/proxy_context.h>
36#include "proxy_modules.h"
38#define TAG PROXY_TAG("modules")
40#define MODULE_ENTRY_POINT "proxy_module_entry_point"
44 proxyPluginsManager mgr;
49static const char* pf_modules_get_filter_type_string(PF_FILTER_TYPE result)
53 case FILTER_TYPE_KEYBOARD:
54 return "FILTER_TYPE_KEYBOARD";
55 case FILTER_TYPE_UNICODE:
56 return "FILTER_TYPE_UNICODE";
57 case FILTER_TYPE_MOUSE:
58 return "FILTER_TYPE_MOUSE";
59 case FILTER_TYPE_MOUSE_EX:
60 return "FILTER_TYPE_MOUSE_EX";
61 case FILTER_TYPE_CLIENT_PASSTHROUGH_CHANNEL_DATA:
62 return "FILTER_TYPE_CLIENT_PASSTHROUGH_CHANNEL_DATA";
63 case FILTER_TYPE_SERVER_PASSTHROUGH_CHANNEL_DATA:
64 return "FILTER_TYPE_SERVER_PASSTHROUGH_CHANNEL_DATA";
65 case FILTER_TYPE_CLIENT_PASSTHROUGH_DYN_CHANNEL_CREATE:
66 return "FILTER_TYPE_CLIENT_PASSTHROUGH_DYN_CHANNEL_CREATE";
67 case FILTER_TYPE_SERVER_FETCH_TARGET_ADDR:
68 return "FILTER_TYPE_SERVER_FETCH_TARGET_ADDR";
69 case FILTER_TYPE_SERVER_PEER_LOGON:
70 return "FILTER_TYPE_SERVER_PEER_LOGON";
71 case FILTER_TYPE_CLIENT_PASSTHROUGH_CHANNEL_CREATE:
72 return "FILTER_TYPE_CLIENT_PASSTHROUGH_CHANNEL_CREATE";
73 case FILTER_TYPE_STATIC_INTERCEPT_LIST:
74 return "FILTER_TYPE_STATIC_INTERCEPT_LIST";
75 case FILTER_TYPE_DYN_INTERCEPT_LIST:
76 return "FILTER_TYPE_DYN_INTERCEPT_LIST";
77 case FILTER_TYPE_INTERCEPT_CHANNEL:
78 return "FILTER_TYPE_INTERCEPT_CHANNEL";
82 return "FILTER_UNKNOWN";
86static const char* pf_modules_get_hook_type_string(PF_HOOK_TYPE result)
90 case HOOK_TYPE_CLIENT_INIT_CONNECT:
91 return "HOOK_TYPE_CLIENT_INIT_CONNECT";
92 case HOOK_TYPE_CLIENT_UNINIT_CONNECT:
93 return "HOOK_TYPE_CLIENT_UNINIT_CONNECT";
94 case HOOK_TYPE_CLIENT_PRE_CONNECT:
95 return "HOOK_TYPE_CLIENT_PRE_CONNECT";
96 case HOOK_TYPE_CLIENT_POST_CONNECT:
97 return "HOOK_TYPE_CLIENT_POST_CONNECT";
98 case HOOK_TYPE_CLIENT_POST_DISCONNECT:
99 return "HOOK_TYPE_CLIENT_POST_DISCONNECT";
100 case HOOK_TYPE_CLIENT_REDIRECT:
101 return "HOOK_TYPE_CLIENT_REDIRECT";
102 case HOOK_TYPE_CLIENT_VERIFY_X509:
103 return "HOOK_TYPE_CLIENT_VERIFY_X509";
104 case HOOK_TYPE_CLIENT_LOGIN_FAILURE:
105 return "HOOK_TYPE_CLIENT_LOGIN_FAILURE";
106 case HOOK_TYPE_CLIENT_END_PAINT:
107 return "HOOK_TYPE_CLIENT_END_PAINT";
108 case HOOK_TYPE_SERVER_POST_CONNECT:
109 return "HOOK_TYPE_SERVER_POST_CONNECT";
110 case HOOK_TYPE_SERVER_ACTIVATE:
111 return "HOOK_TYPE_SERVER_ACTIVATE";
112 case HOOK_TYPE_SERVER_CHANNELS_INIT:
113 return "HOOK_TYPE_SERVER_CHANNELS_INIT";
114 case HOOK_TYPE_SERVER_CHANNELS_FREE:
115 return "HOOK_TYPE_SERVER_CHANNELS_FREE";
116 case HOOK_TYPE_SERVER_SESSION_END:
117 return "HOOK_TYPE_SERVER_SESSION_END";
118 case HOOK_TYPE_CLIENT_LOAD_CHANNELS:
119 return "HOOK_TYPE_CLIENT_LOAD_CHANNELS";
120 case HOOK_TYPE_SERVER_SESSION_INITIALIZE:
121 return "HOOK_TYPE_SERVER_SESSION_INITIALIZE";
122 case HOOK_TYPE_SERVER_SESSION_STARTED:
123 return "HOOK_TYPE_SERVER_SESSION_STARTED";
127 return "HOOK_TYPE_UNKNOWN";
131static BOOL pf_modules_proxy_ArrayList_ForEachFkt(
void* data,
size_t index, va_list ap)
133 proxyPlugin* plugin = (proxyPlugin*)data;
138 PF_HOOK_TYPE type = va_arg(ap, PF_HOOK_TYPE);
139 proxyData* pdata = va_arg(ap, proxyData*);
140 void* custom = va_arg(ap,
void*);
142 WLog_VRB(TAG,
"running hook %s.%s", plugin->name, pf_modules_get_hook_type_string(type));
146 case HOOK_TYPE_CLIENT_INIT_CONNECT:
147 ok = IFCALLRESULT(TRUE, plugin->ClientInitConnect, plugin, pdata, custom);
149 case HOOK_TYPE_CLIENT_UNINIT_CONNECT:
150 ok = IFCALLRESULT(TRUE, plugin->ClientUninitConnect, plugin, pdata, custom);
152 case HOOK_TYPE_CLIENT_PRE_CONNECT:
153 ok = IFCALLRESULT(TRUE, plugin->ClientPreConnect, plugin, pdata, custom);
156 case HOOK_TYPE_CLIENT_POST_CONNECT:
157 ok = IFCALLRESULT(TRUE, plugin->ClientPostConnect, plugin, pdata, custom);
160 case HOOK_TYPE_CLIENT_REDIRECT:
161 ok = IFCALLRESULT(TRUE, plugin->ClientRedirect, plugin, pdata, custom);
164 case HOOK_TYPE_CLIENT_POST_DISCONNECT:
165 ok = IFCALLRESULT(TRUE, plugin->ClientPostDisconnect, plugin, pdata, custom);
168 case HOOK_TYPE_CLIENT_VERIFY_X509:
169 ok = IFCALLRESULT(TRUE, plugin->ClientX509Certificate, plugin, pdata, custom);
172 case HOOK_TYPE_CLIENT_LOGIN_FAILURE:
173 ok = IFCALLRESULT(TRUE, plugin->ClientLoginFailure, plugin, pdata, custom);
176 case HOOK_TYPE_CLIENT_END_PAINT:
177 ok = IFCALLRESULT(TRUE, plugin->ClientEndPaint, plugin, pdata, custom);
180 case HOOK_TYPE_CLIENT_LOAD_CHANNELS:
181 ok = IFCALLRESULT(TRUE, plugin->ClientLoadChannels, plugin, pdata, custom);
184 case HOOK_TYPE_SERVER_POST_CONNECT:
185 ok = IFCALLRESULT(TRUE, plugin->ServerPostConnect, plugin, pdata, custom);
188 case HOOK_TYPE_SERVER_ACTIVATE:
189 ok = IFCALLRESULT(TRUE, plugin->ServerPeerActivate, plugin, pdata, custom);
192 case HOOK_TYPE_SERVER_CHANNELS_INIT:
193 ok = IFCALLRESULT(TRUE, plugin->ServerChannelsInit, plugin, pdata, custom);
196 case HOOK_TYPE_SERVER_CHANNELS_FREE:
197 ok = IFCALLRESULT(TRUE, plugin->ServerChannelsFree, plugin, pdata, custom);
200 case HOOK_TYPE_SERVER_SESSION_END:
201 ok = IFCALLRESULT(TRUE, plugin->ServerSessionEnd, plugin, pdata, custom);
204 case HOOK_TYPE_SERVER_SESSION_INITIALIZE:
205 ok = IFCALLRESULT(TRUE, plugin->ServerSessionInitialize, plugin, pdata, custom);
208 case HOOK_TYPE_SERVER_SESSION_STARTED:
209 ok = IFCALLRESULT(TRUE, plugin->ServerSessionStarted, plugin, pdata, custom);
214 WLog_ERR(TAG,
"invalid hook called");
219 WLog_INFO(TAG,
"plugin %s, hook %s failed!", plugin->name,
220 pf_modules_get_hook_type_string(type));
232BOOL pf_modules_run_hook(proxyModule* module, PF_HOOK_TYPE type, proxyData* pdata,
void* custom)
234 WINPR_ASSERT(module);
235 WINPR_ASSERT(module->plugins);
236 return ArrayList_ForEach(module->plugins, pf_modules_proxy_ArrayList_ForEachFkt, type, pdata,
240static BOOL pf_modules_ArrayList_ForEachFkt(
void* data,
size_t index, va_list ap)
242 proxyPlugin* plugin = (proxyPlugin*)data;
247 PF_FILTER_TYPE type = va_arg(ap, PF_FILTER_TYPE);
248 proxyData* pdata = va_arg(ap, proxyData*);
249 void* param = va_arg(ap,
void*);
251 WLog_VRB(TAG,
"running filter: %s", plugin->name);
255 case FILTER_TYPE_KEYBOARD:
256 result = IFCALLRESULT(TRUE, plugin->KeyboardEvent, plugin, pdata, param);
259 case FILTER_TYPE_UNICODE:
260 result = IFCALLRESULT(TRUE, plugin->UnicodeEvent, plugin, pdata, param);
263 case FILTER_TYPE_MOUSE:
264 result = IFCALLRESULT(TRUE, plugin->MouseEvent, plugin, pdata, param);
267 case FILTER_TYPE_MOUSE_EX:
268 result = IFCALLRESULT(TRUE, plugin->MouseExEvent, plugin, pdata, param);
271 case FILTER_TYPE_CLIENT_PASSTHROUGH_CHANNEL_DATA:
272 result = IFCALLRESULT(TRUE, plugin->ClientChannelData, plugin, pdata, param);
275 case FILTER_TYPE_SERVER_PASSTHROUGH_CHANNEL_DATA:
276 result = IFCALLRESULT(TRUE, plugin->ServerChannelData, plugin, pdata, param);
279 case FILTER_TYPE_CLIENT_PASSTHROUGH_CHANNEL_CREATE:
280 result = IFCALLRESULT(TRUE, plugin->ChannelCreate, plugin, pdata, param);
283 case FILTER_TYPE_CLIENT_PASSTHROUGH_DYN_CHANNEL_CREATE:
284 result = IFCALLRESULT(TRUE, plugin->DynamicChannelCreate, plugin, pdata, param);
287 case FILTER_TYPE_SERVER_FETCH_TARGET_ADDR:
288 result = IFCALLRESULT(TRUE, plugin->ServerFetchTargetAddr, plugin, pdata, param);
291 case FILTER_TYPE_SERVER_PEER_LOGON:
292 result = IFCALLRESULT(TRUE, plugin->ServerPeerLogon, plugin, pdata, param);
295 case FILTER_TYPE_INTERCEPT_CHANNEL:
296 result = IFCALLRESULT(TRUE, plugin->DynChannelIntercept, plugin, pdata, param);
299 case FILTER_TYPE_DYN_INTERCEPT_LIST:
300 result = IFCALLRESULT(TRUE, plugin->DynChannelToIntercept, plugin, pdata, param);
303 case FILTER_TYPE_STATIC_INTERCEPT_LIST:
304 result = IFCALLRESULT(TRUE, plugin->StaticChannelToIntercept, plugin, pdata, param);
309 WLog_ERR(TAG,
"invalid filter called");
315 WLog_DBG(TAG,
"plugin %s, filter type [%s] returned FALSE", plugin->name,
316 pf_modules_get_filter_type_string(type));
327BOOL pf_modules_run_filter(proxyModule* module, PF_FILTER_TYPE type, proxyData* pdata,
void* param)
329 WINPR_ASSERT(module);
330 WINPR_ASSERT(module->plugins);
332 return ArrayList_ForEach(module->plugins, pf_modules_ArrayList_ForEachFkt, type, pdata, param);
341static BOOL pf_modules_set_plugin_data(WINPR_ATTR_UNUSED proxyPluginsManager* mgr,
342 const char* plugin_name, proxyData* pdata,
void* data)
350 WINPR_ASSERT(plugin_name);
352 ccharconv.ccp = plugin_name;
356 if (!HashTable_Insert(pdata->modules_info, ccharconv.cp, data))
358 WLog_ERR(TAG,
"[%s]: HashTable_Insert failed!");
372static void* pf_modules_get_plugin_data(WINPR_ATTR_UNUSED proxyPluginsManager* mgr,
373 const char* plugin_name, proxyData* pdata)
380 WINPR_ASSERT(plugin_name);
382 ccharconv.ccp = plugin_name;
384 return HashTable_GetItemValue(pdata->modules_info, ccharconv.cp);
387static void pf_modules_abort_connect(WINPR_ATTR_UNUSED proxyPluginsManager* mgr, proxyData* pdata)
390 WLog_DBG(TAG,
"is called!");
391 proxy_data_abort_connect(pdata);
394static BOOL pf_modules_register_ArrayList_ForEachFkt(
void* data,
size_t index, va_list ap)
396 proxyPlugin* plugin = (proxyPlugin*)data;
397 proxyPlugin* plugin_to_register = va_arg(ap, proxyPlugin*);
401 if (strcmp(plugin->name, plugin_to_register->name) == 0)
403 WLog_ERR(TAG,
"can not register plugin '%s', it is already registered!", plugin->name);
409static BOOL pf_modules_register_plugin(proxyPluginsManager* mgr,
410 const proxyPlugin* plugin_to_register)
412 proxyPlugin internal = { 0 };
413 proxyModule*
module = (proxyModule*)mgr;
414 WINPR_ASSERT(module);
416 if (!plugin_to_register)
419 internal = *plugin_to_register;
423 if (!ArrayList_ForEach(module->plugins, pf_modules_register_ArrayList_ForEachFkt, &internal))
426 if (!ArrayList_Append(module->plugins, &internal))
428 WLog_ERR(TAG,
"failed adding plugin to list: %s", plugin_to_register->name);
435static BOOL pf_modules_load_ArrayList_ForEachFkt(
void* data,
size_t index, va_list ap)
437 proxyPlugin* plugin = (proxyPlugin*)data;
438 const char* plugin_name = va_arg(ap,
const char*);
439 BOOL* res = va_arg(ap, BOOL*);
445 if (strcmp(plugin->name, plugin_name) == 0)
450BOOL pf_modules_is_plugin_loaded(proxyModule* module,
const char* plugin_name)
453 WINPR_ASSERT(module);
454 if (ArrayList_Count(module->plugins) < 1)
456 if (!ArrayList_ForEach(module->plugins, pf_modules_load_ArrayList_ForEachFkt, plugin_name, &rc))
461static BOOL pf_modules_print_ArrayList_ForEachFkt(
void* data,
size_t index, va_list ap)
463 proxyPlugin* plugin = (proxyPlugin*)data;
468 WLog_INFO(TAG,
"\tName: %s", plugin->name);
469 WLog_INFO(TAG,
"\tDescription: %s", plugin->description);
473void pf_modules_list_loaded_plugins(proxyModule* module)
477 WINPR_ASSERT(module);
478 WINPR_ASSERT(module->plugins);
480 count = ArrayList_Count(module->plugins);
483 WLog_INFO(TAG,
"Loaded plugins:");
485 ArrayList_ForEach(module->plugins, pf_modules_print_ArrayList_ForEachFkt);
488static BOOL pf_modules_load_static_module(
const char* module_name, proxyModule* module,
491 WINPR_ASSERT(module);
493 HANDLE handle = GetModuleHandleA(NULL);
497 WLog_ERR(TAG,
"failed loading static library: %s", module_name);
501 char name[256] = { 0 };
502 (void)_snprintf(name,
sizeof(name),
"%s_%s", module_name, MODULE_ENTRY_POINT);
503 for (
size_t x = 0; x < strnlen(name,
sizeof(name)); x++)
509 proxyModuleEntryPoint pEntryPoint = GetProcAddressAs(handle, name, proxyModuleEntryPoint);
512 WLog_ERR(TAG,
"GetProcAddress failed for static %s (module %s)", name, module_name);
515 if (!ArrayList_Append(module->handles, handle))
517 WLog_ERR(TAG,
"ArrayList_Append failed!");
520 return pf_modules_add(module, pEntryPoint, userdata);
527static BOOL pf_modules_load_module(
const char* module_path,
const char* module_name,
528 proxyModule* module,
void* userdata)
530 WINPR_ASSERT(module);
532 if (pf_modules_load_static_module(module_name, module, userdata))
535 HANDLE handle = LoadLibraryX(module_path);
539 WLog_ERR(TAG,
"failed loading external library: %s", module_path);
543 proxyModuleEntryPoint pEntryPoint =
544 GetProcAddressAs(handle, MODULE_ENTRY_POINT, proxyModuleEntryPoint);
547 WLog_ERR(TAG,
"GetProcAddress failed while loading %s", module_path);
550 if (!ArrayList_Append(module->handles, handle))
552 WLog_ERR(TAG,
"ArrayList_Append failed!");
555 return pf_modules_add(module, pEntryPoint, userdata);
562static void free_handle(
void* obj)
564 HANDLE handle = (HANDLE)obj;
569static void free_plugin(
void* obj)
571 proxyPlugin* plugin = (proxyPlugin*)obj;
572 WINPR_ASSERT(plugin);
574 if (!IFCALLRESULT(TRUE, plugin->PluginUnload, plugin))
575 WLog_WARN(TAG,
"PluginUnload failed for plugin '%s'", plugin->name);
580static void* new_plugin(
const void* obj)
582 const proxyPlugin* src = obj;
583 proxyPlugin* proxy = calloc(1,
sizeof(proxyPlugin));
590proxyModule* pf_modules_new(
const char* root_dir,
const char** modules,
size_t count)
594 proxyModule*
module = calloc(1, sizeof(proxyModule));
598 module->mgr.RegisterPlugin = pf_modules_register_plugin;
599 module->mgr.SetPluginData = pf_modules_set_plugin_data;
600 module->mgr.GetPluginData = pf_modules_get_plugin_data;
601 module->mgr.AbortConnect = pf_modules_abort_connect;
602 module->plugins = ArrayList_New(FALSE);
604 if (module->plugins == NULL)
606 WLog_ERR(TAG,
"ArrayList_New failed!");
609 obj = ArrayList_Object(module->plugins);
612 obj->fnObjectFree = free_plugin;
613 obj->fnObjectNew = new_plugin;
615 module->handles = ArrayList_New(FALSE);
616 if (module->handles == NULL)
619 WLog_ERR(TAG,
"ArrayList_New failed!");
622 ArrayList_Object(module->handles)->fnObjectFree = free_handle;
626 WINPR_ASSERT(root_dir);
627 if (!winpr_PathFileExists(root_dir))
628 path = GetCombinedPath(FREERDP_INSTALL_PREFIX, root_dir);
630 path = _strdup(root_dir);
632 if (!winpr_PathFileExists(path))
634 if (!winpr_PathMakePath(path, NULL))
636 WLog_ERR(TAG,
"error occurred while creating modules directory: %s", root_dir);
640 if (winpr_PathFileExists(path))
641 WLog_DBG(TAG,
"modules root directory: %s", path);
643 for (
size_t i = 0; i < count; i++)
645 char name[8192] = { 0 };
646 char* fullpath = NULL;
647 (void)_snprintf(name,
sizeof(name),
"proxy-%s-plugin%s", modules[i],
648 FREERDP_SHARED_LIBRARY_SUFFIX);
649 fullpath = GetCombinedPath(path, name);
650 pf_modules_load_module(fullpath, modules[i], module, NULL);
660 pf_modules_free(module);
664void pf_modules_free(proxyModule* module)
669 ArrayList_Free(module->plugins);
670 ArrayList_Free(module->handles);
674BOOL pf_modules_add(proxyModule* module, proxyModuleEntryPoint ep,
void* userdata)
676 WINPR_ASSERT(module);
679 return ep(&module->mgr, userdata);
This struct contains function pointer to initialize/free objects.