FreeRDP
Loading...
Searching...
No Matches
client/drdynvc_main.c
1
22#include <freerdp/config.h>
23
24#include <winpr/crt.h>
25#include <winpr/cast.h>
26#include <winpr/stream.h>
27#include <winpr/interlocked.h>
28
29#include <freerdp/freerdp.h>
30#include <freerdp/channels/drdynvc.h>
31#include <freerdp/utils/drdynvc.h>
32#include <freerdp/codec/zgfx.h>
33
34#include "drdynvc_main.h"
35
36#define TAG CHANNELS_TAG("drdynvc.client")
37
38static const char* channel_state2str(DVC_CHANNEL_STATE state)
39{
40 switch (state)
41 {
42 case DVC_CHANNEL_INIT:
43 return "DVC_CHANNEL_INIT";
44 case DVC_CHANNEL_RUNNING:
45 return "DVC_CHANNEL_RUNNING";
46 case DVC_CHANNEL_CLOSED:
47 return "DVC_CHANNEL_CLOSED";
48 default:
49 return "DVC_CHANNEL_UNKNOWN";
50 }
51}
52
53static void dvcman_channel_free(DVCMAN_CHANNEL* channel);
54static UINT dvcman_channel_close(DVCMAN_CHANNEL* channel, BOOL perRequest, BOOL fromHashTableFn);
55static void dvcman_free(drdynvcPlugin* drdynvc, IWTSVirtualChannelManager* pChannelMgr);
56static UINT drdynvc_write_data(drdynvcPlugin* drdynvc, UINT32 ChannelId, const BYTE* data,
57 UINT32 dataSize, BOOL* close, DVCMAN_CHANNEL_STATS* stats);
58static UINT drdynvc_send(drdynvcPlugin* drdynvc, wStream* s, DVCMAN_CHANNEL_STATS* stats);
59
60static void dvcman_wtslistener_free(DVCMAN_LISTENER* listener)
61{
62 if (listener)
63 free(listener->channel_name);
64 free(listener);
65}
66
72static UINT dvcman_get_configuration(IWTSListener* pListener, void** ppPropertyBag)
73{
74 WINPR_ASSERT(ppPropertyBag);
75 WINPR_UNUSED(pListener);
76 *ppPropertyBag = nullptr;
77 return ERROR_INTERNAL_ERROR;
78}
79
85static UINT dvcman_create_listener(IWTSVirtualChannelManager* pChannelMgr,
86 const char* pszChannelName, ULONG ulFlags,
87 IWTSListenerCallback* pListenerCallback,
88 IWTSListener** ppListener)
89{
90 DVCMAN* dvcman = (DVCMAN*)pChannelMgr;
91 DVCMAN_LISTENER* listener = nullptr;
92
93 WINPR_ASSERT(dvcman);
94 WLog_DBG(TAG, "create_listener: %" PRIuz ".%s.", HashTable_Count(dvcman->listeners) + 1,
95 pszChannelName);
96 listener = (DVCMAN_LISTENER*)calloc(1, sizeof(DVCMAN_LISTENER));
97
98 if (!listener)
99 {
100 WLog_ERR(TAG, "calloc failed!");
101 return CHANNEL_RC_NO_MEMORY;
102 }
103
104 listener->iface.GetConfiguration = dvcman_get_configuration;
105 listener->iface.pInterface = nullptr;
106 listener->dvcman = dvcman;
107 listener->channel_name = _strdup(pszChannelName);
108
109 if (!listener->channel_name)
110 {
111 WLog_ERR(TAG, "_strdup failed!");
112 dvcman_wtslistener_free(listener);
113 return CHANNEL_RC_NO_MEMORY;
114 }
115
116 listener->flags = ulFlags;
117 listener->listener_callback = pListenerCallback;
118
119 if (ppListener)
120 *ppListener = (IWTSListener*)listener;
121
122 if (!HashTable_Insert(dvcman->listeners, listener->channel_name, listener))
123 {
124 dvcman_wtslistener_free(listener);
125 return ERROR_INTERNAL_ERROR;
126 }
127
128 // NOLINTNEXTLINE(clang-analyzer-unix.Malloc): HashTable_Insert takes ownership of listener
129 return CHANNEL_RC_OK;
130}
131
132static UINT dvcman_destroy_listener(IWTSVirtualChannelManager* pChannelMgr, IWTSListener* pListener)
133{
134 DVCMAN_LISTENER* listener = (DVCMAN_LISTENER*)pListener;
135
136 WINPR_UNUSED(pChannelMgr);
137
138 if (listener)
139 {
140 DVCMAN* dvcman = listener->dvcman;
141 if (dvcman)
142 HashTable_Remove(dvcman->listeners, listener->channel_name);
143 }
144
145 return CHANNEL_RC_OK;
146}
147
153static UINT dvcman_register_plugin(IDRDYNVC_ENTRY_POINTS* pEntryPoints, const char* name,
154 IWTSPlugin* pPlugin)
155{
156 WINPR_ASSERT(pEntryPoints);
157 DVCMAN* dvcman = ((DVCMAN_ENTRY_POINTS*)pEntryPoints)->dvcman;
158
159 WINPR_ASSERT(dvcman);
160 if (!ArrayList_Append(dvcman->plugin_names, name))
161 return ERROR_INTERNAL_ERROR;
162 if (!ArrayList_Append(dvcman->plugins, pPlugin))
163 return ERROR_INTERNAL_ERROR;
164
165 WLog_DBG(TAG, "register_plugin: num_plugins %" PRIuz, ArrayList_Count(dvcman->plugins));
166 return CHANNEL_RC_OK;
167}
168
169static IWTSPlugin* dvcman_get_plugin(IDRDYNVC_ENTRY_POINTS* pEntryPoints, const char* name)
170{
171 IWTSPlugin* plugin = nullptr;
172 size_t nc = 0;
173 size_t pc = 0;
174 WINPR_ASSERT(pEntryPoints);
175 DVCMAN* dvcman = ((DVCMAN_ENTRY_POINTS*)pEntryPoints)->dvcman;
176 if (!dvcman || !pEntryPoints || !name)
177 return nullptr;
178
179 nc = ArrayList_Count(dvcman->plugin_names);
180 pc = ArrayList_Count(dvcman->plugins);
181 if (nc != pc)
182 return nullptr;
183
184 ArrayList_Lock(dvcman->plugin_names);
185 ArrayList_Lock(dvcman->plugins);
186 for (size_t i = 0; i < pc; i++)
187 {
188 const char* cur = ArrayList_GetItem(dvcman->plugin_names, i);
189 if (strcmp(cur, name) == 0)
190 {
191 plugin = ArrayList_GetItem(dvcman->plugins, i);
192 break;
193 }
194 }
195 ArrayList_Unlock(dvcman->plugin_names);
196 ArrayList_Unlock(dvcman->plugins);
197 return plugin;
198}
199
200static const ADDIN_ARGV* dvcman_get_plugin_data(IDRDYNVC_ENTRY_POINTS* pEntryPoints)
201{
202 WINPR_ASSERT(pEntryPoints);
203 return ((DVCMAN_ENTRY_POINTS*)pEntryPoints)->args;
204}
205
206static rdpContext* dvcman_get_rdp_context(IDRDYNVC_ENTRY_POINTS* pEntryPoints)
207{
208 DVCMAN_ENTRY_POINTS* entry = (DVCMAN_ENTRY_POINTS*)pEntryPoints;
209 WINPR_ASSERT(entry);
210 return entry->context;
211}
212
213static rdpSettings* dvcman_get_rdp_settings(IDRDYNVC_ENTRY_POINTS* pEntryPoints)
214{
215 rdpContext* context = dvcman_get_rdp_context(pEntryPoints);
216 WINPR_ASSERT(context);
217
218 return context->settings;
219}
220
221static UINT32 dvcman_get_channel_id(IWTSVirtualChannel* channel)
222{
223 DVCMAN_CHANNEL* dvc = (DVCMAN_CHANNEL*)channel;
224 WINPR_ASSERT(dvc);
225 return dvc->channel_id;
226}
227
228static const char* dvcman_get_channel_name(IWTSVirtualChannel* channel)
229{
230 DVCMAN_CHANNEL* dvc = (DVCMAN_CHANNEL*)channel;
231 WINPR_ASSERT(dvc);
232 return dvc->channel_name;
233}
234
235static DVCMAN_CHANNEL* dvcman_get_channel_by_id(IWTSVirtualChannelManager* pChannelMgr,
236 UINT32 ChannelId, BOOL doRef)
237{
238 DVCMAN* dvcman = (DVCMAN*)pChannelMgr;
239 DVCMAN_CHANNEL* dvcChannel = nullptr;
240
241 WINPR_ASSERT(dvcman);
242 HashTable_Lock(dvcman->channelsById);
243 dvcChannel = HashTable_GetItemValue(dvcman->channelsById, &ChannelId);
244 if (dvcChannel)
245 {
246 if (doRef)
247 InterlockedIncrement(&dvcChannel->refCounter);
248 }
249
250 HashTable_Unlock(dvcman->channelsById);
251 return dvcChannel;
252}
253
254static IWTSVirtualChannel* dvcman_find_channel_by_id(IWTSVirtualChannelManager* pChannelMgr,
255 UINT32 ChannelId)
256{
257 DVCMAN_CHANNEL* channel = dvcman_get_channel_by_id(pChannelMgr, ChannelId, FALSE);
258 if (!channel)
259 return nullptr;
260
261 return &channel->iface;
262}
263
264static void dvcman_plugin_terminate(void* plugin)
265{
266 IWTSPlugin* pPlugin = plugin;
267
268 WINPR_ASSERT(pPlugin);
269 UINT error = IFCALLRESULT(CHANNEL_RC_OK, pPlugin->Terminated, pPlugin);
270 if (error != CHANNEL_RC_OK)
271 WLog_ERR(TAG, "Terminated failed with error %" PRIu32 "!", error);
272}
273
274static void wts_listener_free(void* arg)
275{
276 DVCMAN_LISTENER* listener = (DVCMAN_LISTENER*)arg;
277 dvcman_wtslistener_free(listener);
278}
279
280static BOOL channelIdMatch(const void* k1, const void* k2)
281{
282 WINPR_ASSERT(k1);
283 WINPR_ASSERT(k2);
284 return *((const UINT32*)k1) == *((const UINT32*)k2);
285}
286
287static UINT32 channelIdHash(const void* id)
288{
289 WINPR_ASSERT(id);
290 return *((const UINT32*)id);
291}
292
293static void channelByIdCleanerFn(void* value)
294{
295 DVCMAN_CHANNEL* channel = (DVCMAN_CHANNEL*)value;
296 if (channel)
297 {
298 dvcman_channel_close(channel, FALSE, TRUE);
299 dvcman_channel_free(channel);
300 }
301}
302
303static IWTSVirtualChannelManager* dvcman_new(drdynvcPlugin* plugin)
304{
305 wObject* obj = nullptr;
306 DVCMAN* dvcman = (DVCMAN*)calloc(1, sizeof(DVCMAN));
307
308 if (!dvcman)
309 return nullptr;
310
311 dvcman->iface.CreateListener = dvcman_create_listener;
312 dvcman->iface.DestroyListener = dvcman_destroy_listener;
313 dvcman->iface.FindChannelById = dvcman_find_channel_by_id;
314 dvcman->iface.GetChannelId = dvcman_get_channel_id;
315 dvcman->iface.GetChannelName = dvcman_get_channel_name;
316 dvcman->drdynvc = plugin;
317 dvcman->channelsById = HashTable_New(TRUE);
318
319 if (!dvcman->channelsById)
320 goto fail;
321
322 if (!HashTable_SetHashFunction(dvcman->channelsById, channelIdHash))
323 goto fail;
324
325 obj = HashTable_KeyObject(dvcman->channelsById);
326 WINPR_ASSERT(obj);
327 obj->fnObjectEquals = channelIdMatch;
328
329 obj = HashTable_ValueObject(dvcman->channelsById);
330 WINPR_ASSERT(obj);
331 obj->fnObjectFree = channelByIdCleanerFn;
332
333 dvcman->pool = StreamPool_New(TRUE, 10);
334 if (!dvcman->pool)
335 goto fail;
336
337 dvcman->listeners = HashTable_New(TRUE);
338 if (!dvcman->listeners)
339 goto fail;
340
341 if (!HashTable_SetHashFunction(dvcman->listeners, HashTable_StringHash))
342 goto fail;
343
344 obj = HashTable_KeyObject(dvcman->listeners);
345 obj->fnObjectEquals = HashTable_StringCompare;
346
347 obj = HashTable_ValueObject(dvcman->listeners);
348 obj->fnObjectFree = wts_listener_free;
349
350 dvcman->plugin_names = ArrayList_New(TRUE);
351 if (!dvcman->plugin_names)
352 goto fail;
353 obj = ArrayList_Object(dvcman->plugin_names);
354 obj->fnObjectNew = winpr_ObjectStringClone;
355 obj->fnObjectFree = winpr_ObjectStringFree;
356
357 dvcman->plugins = ArrayList_New(TRUE);
358 if (!dvcman->plugins)
359 goto fail;
360 obj = ArrayList_Object(dvcman->plugins);
361 obj->fnObjectFree = dvcman_plugin_terminate;
362 return &dvcman->iface;
363fail:
364 dvcman_free(plugin, &dvcman->iface);
365 return nullptr;
366}
367
373static UINT dvcman_load_addin(drdynvcPlugin* drdynvc, IWTSVirtualChannelManager* pChannelMgr,
374 const ADDIN_ARGV* args, rdpContext* context)
375{
376 WINPR_ASSERT(drdynvc);
377 WINPR_ASSERT(pChannelMgr);
378 WINPR_ASSERT(args);
379 WINPR_ASSERT(context);
380
381 WLog_Print(drdynvc->log, WLOG_INFO, "Loading Dynamic Virtual Channel %s", args->argv[0]);
382
383 PVIRTUALCHANNELENTRY pvce = freerdp_load_channel_addin_entry(args->argv[0], nullptr, nullptr,
384 FREERDP_ADDIN_CHANNEL_DYNAMIC);
385 PDVC_PLUGIN_ENTRY pDVCPluginEntry = WINPR_FUNC_PTR_CAST(pvce, PDVC_PLUGIN_ENTRY);
386
387 if (pDVCPluginEntry)
388 {
389 DVCMAN_ENTRY_POINTS entryPoints = WINPR_C_ARRAY_INIT;
390
391 entryPoints.iface.RegisterPlugin = dvcman_register_plugin;
392 entryPoints.iface.GetPlugin = dvcman_get_plugin;
393 entryPoints.iface.GetPluginData = dvcman_get_plugin_data;
394 entryPoints.iface.GetRdpSettings = dvcman_get_rdp_settings;
395 entryPoints.iface.GetRdpContext = dvcman_get_rdp_context;
396 entryPoints.dvcman = (DVCMAN*)pChannelMgr;
397 entryPoints.args = args;
398 entryPoints.context = context;
399 return pDVCPluginEntry(&entryPoints.iface);
400 }
401
402 return ERROR_INVALID_FUNCTION;
403}
404
405static void dvcman_channel_free(DVCMAN_CHANNEL* channel)
406{
407 if (!channel)
408 return;
409
410 if (channel->dvcman)
411 {
412 drdynvcPlugin* plugin = channel->dvcman->drdynvc;
413 if (plugin)
414 {
415 rdpContext* context = plugin->rdpcontext;
416 if (context)
417 {
418 ChannelTerminatedEventArgs e = WINPR_C_ARRAY_INIT;
419 EventArgsInit(&e, "freerdp");
420 e.name = channel->channel_name;
421 e.pInterface = channel->pInterface;
422
423 const int rc = PubSub_OnChannelTerminated(context->pubSub, context, &e);
424 if (rc < 0)
425 WLog_WARN(TAG, "PubSub_OnChannelTerminated(%s) failed", channel->channel_name);
426 }
427 }
428 }
429
430 if (channel->dvc_data)
431 Stream_Release(channel->dvc_data);
432
433 zgfx_context_free(channel->decompressor);
434 DeleteCriticalSection(&(channel->lock));
435 free(channel->channel_name);
436 free(channel);
437}
438
439static void dvcman_channel_unref(DVCMAN_CHANNEL* channel)
440{
441 WINPR_ASSERT(channel);
442 if (InterlockedDecrement(&channel->refCounter))
443 return;
444
445 DVCMAN* dvcman = channel->dvcman;
446 if (dvcman)
447 HashTable_Remove(dvcman->channelsById, &channel->channel_id);
448}
449
450static UINT dvcchannel_send_close(DVCMAN_CHANNEL* channel)
451{
452 WINPR_ASSERT(channel);
453 DVCMAN* dvcman = channel->dvcman;
454 drdynvcPlugin* drdynvc = dvcman->drdynvc;
455 wStream* s = StreamPool_Take(dvcman->pool, 5);
456
457 if (!s)
458 {
459 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
460 return CHANNEL_RC_NO_MEMORY;
461 }
462
463 Stream_Write_UINT8(s, (CLOSE_REQUEST_PDU << 4) | 0x02);
464 Stream_Write_UINT32(s, channel->channel_id);
465 return drdynvc_send(drdynvc, s, &channel->stats);
466}
467
468static void check_open_close_receive(DVCMAN_CHANNEL* channel)
469{
470 WINPR_ASSERT(channel);
471
472 IWTSVirtualChannelCallback* cb = channel->channel_callback;
473 const char* name = channel->channel_name;
474 const UINT32 id = channel->channel_id;
475
476 WINPR_ASSERT(cb);
477 if (!cb->OnOpen || !cb->OnClose || !cb->OnDataReceived)
478 WLog_VRB(TAG, "{%s:%" PRIu32 "} OnOpen=%p, OnClose=%p, OnDataReceived=%p", name, id,
479 WINPR_FUNC_PTR_CAST(cb->OnOpen, const void*),
480 WINPR_FUNC_PTR_CAST(cb->OnClose, const void*),
481 WINPR_FUNC_PTR_CAST(cb->OnDataReceived, const void*));
482}
483
484static UINT dvcman_call_on_receive(DVCMAN_CHANNEL* channel, wStream* data)
485{
486 WINPR_ASSERT(channel);
487 WINPR_ASSERT(data);
488
489 channel->stats.packetsIn++;
490
491 IWTSVirtualChannelCallback* cb = channel->channel_callback;
492 WINPR_ASSERT(cb);
493
494 check_open_close_receive(channel);
495 WINPR_ASSERT(cb->OnDataReceived);
496 return cb->OnDataReceived(cb, data);
497}
498
499static UINT dvcman_channel_close(DVCMAN_CHANNEL* channel, BOOL perRequest, BOOL fromHashTableFn)
500{
501 UINT error = CHANNEL_RC_OK;
502 DrdynvcClientContext* context = nullptr;
503
504 WINPR_ASSERT(channel);
505 switch (channel->state)
506 {
507 case DVC_CHANNEL_INIT:
508 break;
509 case DVC_CHANNEL_RUNNING:
510 if (channel->dvcman)
511 {
512 drdynvcPlugin* drdynvc = channel->dvcman->drdynvc;
513 WINPR_ASSERT(drdynvc);
514 context = drdynvc->context;
515 if (perRequest)
516 WLog_Print(drdynvc->log, WLOG_DEBUG, "sending close confirm for '%s'",
517 channel->channel_name);
518
519 error = dvcchannel_send_close(channel);
520 if (error != CHANNEL_RC_OK)
521 {
522 if (perRequest)
523 WLog_Print(drdynvc->log, WLOG_DEBUG,
524 "error when sending closeRequest for '%s'",
525 channel->channel_name);
526 else
527 WLog_Print(drdynvc->log, WLOG_DEBUG,
528 "error when sending close confirm for '%s'",
529 channel->channel_name);
530 }
531 WLog_Print(drdynvc->log, WLOG_DEBUG, "listener %s destroyed channel %" PRIu32 "",
532 channel->channel_name, channel->channel_id);
533 }
534
535 channel->state = DVC_CHANNEL_CLOSED;
536
537 {
538 check_open_close_receive(channel);
539
540 IWTSVirtualChannelCallback* cb = channel->channel_callback;
541 channel->channel_callback = nullptr;
542 if (cb)
543 error = IFCALLRESULT(CHANNEL_RC_OK, cb->OnClose, cb);
544 }
545
546 if (channel->dvcman && channel->dvcman->drdynvc)
547 {
548 if (context)
549 {
550 IFCALLRET(context->OnChannelDisconnected, error, context, channel->channel_name,
551 channel->pInterface);
552 }
553 }
554
555 if (!fromHashTableFn)
556 dvcman_channel_unref(channel);
557 break;
558 case DVC_CHANNEL_CLOSED:
559 break;
560 default:
561 break;
562 }
563
564 return error;
565}
566
567static DVCMAN_CHANNEL* dvcman_channel_new(drdynvcPlugin* drdynvc,
568 IWTSVirtualChannelManager* pChannelMgr, UINT32 ChannelId,
569 const char* ChannelName)
570{
571 WINPR_ASSERT(drdynvc);
572 WINPR_ASSERT(pChannelMgr);
573 DVCMAN_CHANNEL* channel = (DVCMAN_CHANNEL*)calloc(1, sizeof(DVCMAN_CHANNEL));
574
575 if (!channel)
576 return nullptr;
577
578 channel->dvcman = (DVCMAN*)pChannelMgr;
579 channel->channel_id = ChannelId;
580 channel->refCounter = 1;
581 channel->state = DVC_CHANNEL_INIT;
582 channel->channel_name = _strdup(ChannelName);
583 if (!channel->channel_name)
584 goto fail;
585
586 channel->decompressor = zgfx_context_new(FALSE);
587 if (!channel->decompressor)
588 goto fail;
589
590 if (!InitializeCriticalSectionEx(&(channel->lock), 0, 0))
591 goto fail;
592
593 if (drdynvc)
594 {
595 rdpContext* context = drdynvc->rdpcontext;
596 if (context)
597 {
598 ChannelInitializedEventArgs e = WINPR_C_ARRAY_INIT;
599 EventArgsInit(&e, "freerdp");
600 e.name = channel->channel_name;
601 e.pInterface = channel->pInterface;
602
603 const int rc = PubSub_OnChannelInitialized(context->pubSub, context, &e);
604 if (rc < 0)
605 WLog_WARN(TAG, "PubSub_OnChannelInitialized(%s) failed", channel->channel_name);
606 }
607 }
608
609 return channel;
610fail:
611 dvcman_channel_free(channel);
612 return nullptr;
613}
614
615static void dvcman_clear(drdynvcPlugin* drdynvc, IWTSVirtualChannelManager* pChannelMgr)
616{
617 DVCMAN* dvcman = (DVCMAN*)pChannelMgr;
618
619 WINPR_ASSERT(dvcman);
620 WINPR_UNUSED(drdynvc);
621
622 HashTable_Clear(dvcman->channelsById);
623 ArrayList_Clear(dvcman->plugins);
624 ArrayList_Clear(dvcman->plugin_names);
625 HashTable_Clear(dvcman->listeners);
626}
627
628static void dvcman_free(drdynvcPlugin* drdynvc, IWTSVirtualChannelManager* pChannelMgr)
629{
630 DVCMAN* dvcman = (DVCMAN*)pChannelMgr;
631
632 WINPR_ASSERT(dvcman);
633 WINPR_UNUSED(drdynvc);
634
635 HashTable_Free(dvcman->channelsById);
636 ArrayList_Free(dvcman->plugins);
637 ArrayList_Free(dvcman->plugin_names);
638 HashTable_Free(dvcman->listeners);
639
640 StreamPool_Free(dvcman->pool);
641 free(dvcman);
642}
643
649static UINT dvcman_init(drdynvcPlugin* drdynvc, IWTSVirtualChannelManager* pChannelMgr)
650{
651 DVCMAN* dvcman = (DVCMAN*)pChannelMgr;
652 UINT error = CHANNEL_RC_OK;
653
654 WINPR_ASSERT(dvcman);
655 ArrayList_Lock(dvcman->plugins);
656 for (size_t i = 0; i < ArrayList_Count(dvcman->plugins); i++)
657 {
658 IWTSPlugin* pPlugin = ArrayList_GetItem(dvcman->plugins, i);
659
660 error = IFCALLRESULT(CHANNEL_RC_OK, pPlugin->Initialize, pPlugin, pChannelMgr);
661 if (error != CHANNEL_RC_OK)
662 {
663 WLog_Print(drdynvc->log, WLOG_ERROR, "Initialize failed with error %" PRIu32 "!",
664 error);
665 goto fail;
666 }
667 }
668
669fail:
670 ArrayList_Unlock(dvcman->plugins);
671 return error;
672}
673
679static UINT dvcman_write_channel(IWTSVirtualChannel* pChannel, ULONG cbSize, const BYTE* pBuffer,
680 void* pReserved)
681{
682 BOOL close = FALSE;
683 UINT status = 0;
684 DVCMAN_CHANNEL* channel = (DVCMAN_CHANNEL*)pChannel;
685
686 WINPR_UNUSED(pReserved);
687 if (!channel || !channel->dvcman)
688 return CHANNEL_RC_BAD_CHANNEL;
689
690 EnterCriticalSection(&(channel->lock));
691 status = drdynvc_write_data(channel->dvcman->drdynvc, channel->channel_id, pBuffer, cbSize,
692 &close, &channel->stats);
693 LeaveCriticalSection(&(channel->lock));
694 /* Close delayed, it removes the channel struct */
695 if (close)
696 dvcman_channel_close(channel, FALSE, FALSE);
697
698 return status;
699}
700
706static UINT dvcman_close_channel_iface(IWTSVirtualChannel* pChannel)
707{
708 DVCMAN_CHANNEL* channel = (DVCMAN_CHANNEL*)pChannel;
709
710 if (!channel)
711 return CHANNEL_RC_BAD_CHANNEL;
712
713 WLog_DBG(TAG, "close_channel_iface: id=%" PRIu32 "", channel->channel_id);
714 return dvcman_channel_close(channel, FALSE, FALSE);
715}
716
717struct stats_collector_argument
718{
720 size_t count;
721 size_t used;
722};
723
724static BOOL stats_collector(WINPR_ATTR_UNUSED const void* key, void* value, void* arg)
725{
726 struct stats_collector_argument* args = arg;
727 WINPR_ASSERT(args);
728
729 DVCMAN_CHANNEL* channel = value;
730 WINPR_ASSERT(channel);
731 if (args->used >= args->count)
732 return FALSE;
733
734 DrdynvcClientChannelStat* stat = &args->stats[args->used++];
735
736 if (channel->channel_name)
737 {
738 const size_t len = strnlen(channel->channel_name, ARRAYSIZE(stat->channelName) - 1);
739 strncpy(stat->channelName, channel->channel_name, len);
740 }
741 else
742 memset(stat->channelName, 0, sizeof(stat->channelName));
743 stat->channelId = channel->channel_id;
744 stat->bytesIn = channel->stats.bytesIn;
745 stat->bytesIn = channel->stats.bytesOut;
746 stat->fragmentsIn = channel->stats.fragmentsIn;
747 stat->fragmentsOut = channel->stats.fragmentsOut;
748 stat->packetsIn = channel->stats.packetsIn;
749 stat->packetsOut = channel->stats.packetsOut;
750 return TRUE;
751}
752
753WINPR_ATTR_MALLOC(free, 1)
754static DrdynvcClientChannelStat* drdynvc_get_channel_stats(DrdynvcClientContext* context,
755 size_t* pCount)
756{
757 WINPR_ASSERT(context);
758 WINPR_ASSERT(pCount);
759
760 drdynvcPlugin* drdynvc = (drdynvcPlugin*)context->handle;
761 WINPR_ASSERT(drdynvc);
762
763 DVCMAN* dvcman = (DVCMAN*)drdynvc->channel_mgr;
764 *pCount = 0;
765 if (!dvcman)
766 return nullptr;
767
768 struct stats_collector_argument args = { .stats = nullptr, .count = 0 };
769
770 HashTable_Lock(dvcman->channelsById);
771 const size_t count = HashTable_Count(dvcman->channelsById);
772 if (count > 0)
773 {
774 args.stats = calloc(count, sizeof(DrdynvcClientChannelStat));
775 if (args.stats)
776 {
777 args.count = count;
778 const BOOL rc = HashTable_Foreach(dvcman->channelsById, stats_collector, &args);
779 if (!rc)
780 {
781 HashTable_Unlock(dvcman->channelsById);
782 free(args.stats);
783 return nullptr;
784 }
785 }
786 }
787 HashTable_Unlock(dvcman->channelsById);
788 *pCount = args.used;
789 return args.stats;
790}
791
797static DVCMAN_CHANNEL* dvcman_create_channel(drdynvcPlugin* drdynvc,
798 IWTSVirtualChannelManager* pChannelMgr,
799 UINT32 ChannelId, const char* ChannelName, UINT* res)
800{
801 BOOL bAccept = 0;
802 DVCMAN_CHANNEL* channel = nullptr;
803 DrdynvcClientContext* context = nullptr;
804 DVCMAN* dvcman = (DVCMAN*)pChannelMgr;
805 DVCMAN_LISTENER* listener = nullptr;
806 IWTSVirtualChannelCallback* pCallback = nullptr;
807
808 WINPR_ASSERT(dvcman);
809 WINPR_ASSERT(res);
810
811 HashTable_Lock(dvcman->listeners);
812 listener = (DVCMAN_LISTENER*)HashTable_GetItemValue(dvcman->listeners, ChannelName);
813 if (!listener)
814 {
815 *res = ERROR_NOT_FOUND;
816 goto out;
817 }
818
819 channel = dvcman_get_channel_by_id(pChannelMgr, ChannelId, FALSE);
820 if (channel)
821 {
822 switch (channel->state)
823 {
824 case DVC_CHANNEL_RUNNING:
825 WLog_Print(drdynvc->log, WLOG_ERROR,
826 "Protocol error: Duplicated ChannelId %" PRIu32 " (%s)!", ChannelId,
827 ChannelName);
828 *res = CHANNEL_RC_ALREADY_OPEN;
829 goto out;
830
831 case DVC_CHANNEL_CLOSED:
832 case DVC_CHANNEL_INIT:
833 default:
834 {
835 WLog_Print(drdynvc->log, WLOG_ERROR, "not expecting a createChannel from state %s",
836 channel_state2str(channel->state));
837 *res = CHANNEL_RC_INITIALIZATION_ERROR;
838 goto out;
839 }
840 }
841 }
842 else
843 {
844 if (!(channel = dvcman_channel_new(drdynvc, pChannelMgr, ChannelId, ChannelName)))
845 {
846 WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_channel_new failed!");
847 *res = CHANNEL_RC_NO_MEMORY;
848 goto out;
849 }
850 }
851
852 if (!HashTable_Insert(dvcman->channelsById, &channel->channel_id, channel))
853 {
854 WLog_Print(drdynvc->log, WLOG_ERROR, "unable to register channel in our channel list");
855 *res = ERROR_INTERNAL_ERROR;
856 dvcman_channel_free(channel);
857 channel = nullptr;
858 goto out;
859 }
860
861 channel->iface.Write = dvcman_write_channel;
862 channel->iface.Close = dvcman_close_channel_iface;
863 bAccept = TRUE;
864
865 *res = listener->listener_callback->OnNewChannelConnection(
866 listener->listener_callback, &channel->iface, nullptr, &bAccept, &pCallback);
867
868 if (*res != CHANNEL_RC_OK)
869 {
870 WLog_Print(drdynvc->log, WLOG_ERROR,
871 "OnNewChannelConnection failed with error %" PRIu32 "!", *res);
872 *res = ERROR_INTERNAL_ERROR;
873 dvcman_channel_unref(channel);
874 goto out;
875 }
876
877 if (!bAccept)
878 {
879 WLog_Print(drdynvc->log, WLOG_ERROR, "OnNewChannelConnection returned with bAccept FALSE!");
880 *res = ERROR_INTERNAL_ERROR;
881 dvcman_channel_unref(channel);
882 channel = nullptr;
883 goto out;
884 }
885
886 WLog_Print(drdynvc->log, WLOG_DEBUG, "listener %s created new channel %" PRIu32 "",
887 listener->channel_name, channel->channel_id);
888 channel->state = DVC_CHANNEL_RUNNING;
889 channel->channel_callback = pCallback;
890 channel->pInterface = listener->iface.pInterface;
891 context = dvcman->drdynvc->context;
892
893 IFCALLRET(context->OnChannelConnected, *res, context, ChannelName, listener->iface.pInterface);
894 if (*res != CHANNEL_RC_OK)
895 {
896 WLog_Print(drdynvc->log, WLOG_ERROR,
897 "context.OnChannelConnected failed with error %" PRIu32 "", *res);
898 }
899
900out:
901 HashTable_Unlock(dvcman->listeners);
902
903 return channel;
904}
905
911static UINT dvcman_open_channel(drdynvcPlugin* drdynvc, DVCMAN_CHANNEL* channel)
912{
913 UINT error = CHANNEL_RC_OK;
914
915 WINPR_ASSERT(drdynvc);
916 WINPR_ASSERT(channel);
917 if (channel->state == DVC_CHANNEL_RUNNING)
918 {
919 IWTSVirtualChannelCallback* pCallback = channel->channel_callback;
920
921 if (pCallback->OnOpen)
922 {
923 check_open_close_receive(channel);
924 error = pCallback->OnOpen(pCallback);
925 if (error)
926 {
927 WLog_Print(drdynvc->log, WLOG_ERROR, "OnOpen failed with error %" PRIu32 "!",
928 error);
929 goto out;
930 }
931 }
932
933 WLog_Print(drdynvc->log, WLOG_DEBUG, "open_channel: ChannelId %" PRIu32 "",
934 channel->channel_id);
935 }
936
937out:
938 return error;
939}
940
946static UINT dvcman_receive_channel_data_first(DVCMAN_CHANNEL* channel, UINT32 length)
947{
948 WINPR_ASSERT(channel);
949 WINPR_ASSERT(channel->dvcman);
950 if (channel->dvc_data)
951 Stream_Release(channel->dvc_data);
952
953 channel->dvc_data = StreamPool_Take(channel->dvcman->pool, length);
954
955 if (!channel->dvc_data)
956 {
957 drdynvcPlugin* drdynvc = channel->dvcman->drdynvc;
958 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
959 return CHANNEL_RC_NO_MEMORY;
960 }
961
962 channel->dvc_data_length = length;
963 return CHANNEL_RC_OK;
964}
965
971static UINT dvcman_receive_channel_data(DVCMAN_CHANNEL* channel, wStream* data,
972 WINPR_ATTR_UNUSED UINT32 ThreadingFlags)
973{
974 UINT status = CHANNEL_RC_OK;
975 size_t dataSize = Stream_GetRemainingLength(data);
976
977 WINPR_ASSERT(channel);
978 WINPR_ASSERT(channel->dvcman);
979
980 channel->stats.bytesIn += Stream_Length(data);
981 if (channel->dvc_data)
982 {
983 drdynvcPlugin* drdynvc = channel->dvcman->drdynvc;
984
985 /* Fragmented data */
986 if (Stream_GetPosition(channel->dvc_data) + dataSize > channel->dvc_data_length)
987 {
988 WLog_Print(drdynvc->log, WLOG_ERROR, "data exceeding declared length!");
989 Stream_Release(channel->dvc_data);
990 channel->dvc_data = nullptr;
991 status = ERROR_INVALID_DATA;
992 goto out;
993 }
994
995 Stream_Copy(data, channel->dvc_data, dataSize);
996 channel->stats.fragmentsIn++;
997
998 if (Stream_GetPosition(channel->dvc_data) >= channel->dvc_data_length)
999 {
1000 Stream_SealLength(channel->dvc_data);
1001 Stream_ResetPosition(channel->dvc_data);
1002
1003 status = dvcman_call_on_receive(channel, channel->dvc_data);
1004 Stream_Release(channel->dvc_data);
1005 channel->dvc_data = nullptr;
1006 }
1007 }
1008 else
1009 status = dvcman_call_on_receive(channel, data);
1010
1011out:
1012 return status;
1013}
1014
1015static UINT8 drdynvc_write_variable_uint(wStream* s, UINT32 val)
1016{
1017 UINT8 cb = 0;
1018
1019 if (val <= 0xFF)
1020 {
1021 cb = 0;
1022 Stream_Write_UINT8(s, (UINT8)val);
1023 }
1024 else if (val <= 0xFFFF)
1025 {
1026 cb = 1;
1027 Stream_Write_UINT16(s, (UINT16)val);
1028 }
1029 else
1030 {
1031 cb = 2;
1032 Stream_Write_UINT32(s, val);
1033 }
1034
1035 return cb;
1036}
1037
1043static UINT drdynvc_send(drdynvcPlugin* drdynvc, wStream* s, DVCMAN_CHANNEL_STATS* stats)
1044{
1045 UINT status = 0;
1046
1047 if (!drdynvc)
1048 status = CHANNEL_RC_BAD_CHANNEL_HANDLE;
1049 else
1050 {
1051 const size_t len = Stream_GetPosition(s);
1052
1053 if (stats)
1054 stats->bytesOut += len;
1055
1056 WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelWriteEx);
1057 status = drdynvc->channelEntryPoints.pVirtualChannelWriteEx(
1058 drdynvc->InitHandle, drdynvc->OpenHandle, Stream_Buffer(s), (UINT32)len, s);
1059 }
1060
1061 switch (status)
1062 {
1063 case CHANNEL_RC_OK:
1064 return CHANNEL_RC_OK;
1065
1066 case CHANNEL_RC_NOT_CONNECTED:
1067 Stream_Release(s);
1068 return CHANNEL_RC_OK;
1069
1070 case CHANNEL_RC_BAD_CHANNEL_HANDLE:
1071 Stream_Release(s);
1072 WLog_ERR(TAG, "VirtualChannelWriteEx failed with CHANNEL_RC_BAD_CHANNEL_HANDLE");
1073 return status;
1074
1075 default:
1076 Stream_Release(s);
1077 WLog_Print(drdynvc->log, WLOG_ERROR,
1078 "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1079 WTSErrorToString(status), status);
1080 return status;
1081 }
1082}
1083
1089static UINT drdynvc_write_data(drdynvcPlugin* drdynvc, UINT32 ChannelId, const BYTE* data,
1090 UINT32 dataSize, BOOL* close, DVCMAN_CHANNEL_STATS* stats)
1091{
1092 size_t pos = 0;
1093 UINT8 cbChId = 0;
1094 UINT8 cbLen = 0;
1095 UINT status = CHANNEL_RC_BAD_INIT_HANDLE;
1096 DVCMAN* dvcman = nullptr;
1097
1098 if (!drdynvc)
1099 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1100
1101 dvcman = (DVCMAN*)drdynvc->channel_mgr;
1102 WINPR_ASSERT(dvcman);
1103
1104 WLog_Print(drdynvc->log, WLOG_TRACE, "write_data: ChannelId=%" PRIu32 " size=%" PRIu32 "",
1105 ChannelId, dataSize);
1106 wStream* data_out = StreamPool_Take(dvcman->pool, CHANNEL_CHUNK_LENGTH);
1107
1108 if (!data_out)
1109 {
1110 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1111 return CHANNEL_RC_NO_MEMORY;
1112 }
1113
1114 if (!Stream_SetPosition(data_out, 1))
1115 {
1116 Stream_Release(data_out);
1117 return ERROR_INVALID_DATA;
1118 }
1119 cbChId = drdynvc_write_variable_uint(data_out, ChannelId);
1120 pos = Stream_GetPosition(data_out);
1121
1122 if (dataSize == 0)
1123 {
1124 /* TODO: shall treat that case with write(0) that do a close */
1125 *close = TRUE;
1126 Stream_Release(data_out);
1127 }
1128 else if (dataSize <= CHANNEL_CHUNK_LENGTH - pos)
1129 {
1130 Stream_ResetPosition(data_out);
1131 Stream_Write_UINT8(data_out, (DATA_PDU << 4) | cbChId);
1132 if (!Stream_SetPosition(data_out, pos))
1133 {
1134 Stream_Release(data_out);
1135 return ERROR_INVALID_DATA;
1136 }
1137 Stream_Write(data_out, data, dataSize);
1138 stats->packetsOut++;
1139 status = drdynvc_send(drdynvc, data_out, stats);
1140 }
1141 else
1142 {
1143 /* Fragment the data */
1144 cbLen = drdynvc_write_variable_uint(data_out, dataSize);
1145 pos = Stream_GetPosition(data_out);
1146 Stream_ResetPosition(data_out);
1147
1148 const INT32 pdu = (DATA_FIRST_PDU << 4) | cbChId | (cbLen << 2);
1149 Stream_Write_UINT8(data_out, WINPR_ASSERTING_INT_CAST(UINT8, pdu));
1150 if (!Stream_SetPosition(data_out, pos))
1151 {
1152 Stream_Release(data_out);
1153 return ERROR_INVALID_DATA;
1154 }
1155
1156 {
1157 WINPR_ASSERT(pos <= CHANNEL_CHUNK_LENGTH);
1158 const uint32_t chunkLength =
1159 CHANNEL_CHUNK_LENGTH - WINPR_ASSERTING_INT_CAST(uint32_t, pos);
1160 Stream_Write(data_out, data, chunkLength);
1161
1162 data += chunkLength;
1163 dataSize -= chunkLength;
1164 }
1165 if (dataSize > 0)
1166 stats->fragmentsOut++;
1167
1168 status = drdynvc_send(drdynvc, data_out, stats);
1169
1170 while (status == CHANNEL_RC_OK && dataSize > 0)
1171 {
1172 data_out = StreamPool_Take(dvcman->pool, CHANNEL_CHUNK_LENGTH);
1173
1174 if (!data_out)
1175 {
1176 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1177 return CHANNEL_RC_NO_MEMORY;
1178 }
1179
1180 if (!Stream_SetPosition(data_out, 1))
1181 {
1182 Stream_Release(data_out);
1183 return ERROR_INVALID_DATA;
1184 }
1185
1186 cbChId = drdynvc_write_variable_uint(data_out, ChannelId);
1187 pos = Stream_GetPosition(data_out);
1188 Stream_ResetPosition(data_out);
1189 Stream_Write_UINT8(data_out, (DATA_PDU << 4) | cbChId);
1190 if (!Stream_SetPosition(data_out, pos))
1191 {
1192 Stream_Release(data_out);
1193 return ERROR_INVALID_DATA;
1194 }
1195
1196 uint32_t chunkLength = dataSize;
1197
1198 WINPR_ASSERT(pos <= CHANNEL_CHUNK_LENGTH);
1199 const uint32_t clen = CHANNEL_CHUNK_LENGTH - WINPR_ASSERTING_INT_CAST(uint32_t, pos);
1200 if (chunkLength > clen)
1201 {
1202 stats->fragmentsOut++;
1203 chunkLength = clen;
1204 }
1205 else
1206 stats->packetsOut++;
1207
1208 Stream_Write(data_out, data, chunkLength);
1209 data += chunkLength;
1210 dataSize -= chunkLength;
1211
1212 status = drdynvc_send(drdynvc, data_out, stats);
1213 }
1214 }
1215
1216 if (status != CHANNEL_RC_OK)
1217 {
1218 WLog_Print(drdynvc->log, WLOG_ERROR, "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1219 WTSErrorToString(status), status);
1220 return status;
1221 }
1222
1223 return CHANNEL_RC_OK;
1224}
1225
1231static UINT drdynvc_send_capability_response(drdynvcPlugin* drdynvc)
1232{
1233 UINT status = 0;
1234 wStream* s = nullptr;
1235 DVCMAN* dvcman = nullptr;
1236
1237 if (!drdynvc)
1238 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1239
1240 dvcman = (DVCMAN*)drdynvc->channel_mgr;
1241 WINPR_ASSERT(dvcman);
1242
1243 WLog_Print(drdynvc->log, WLOG_TRACE, "capability_response");
1244 s = StreamPool_Take(dvcman->pool, 4);
1245
1246 if (!s)
1247 {
1248 WLog_Print(drdynvc->log, WLOG_ERROR, "Stream_New failed!");
1249 return CHANNEL_RC_NO_MEMORY;
1250 }
1251
1252 Stream_Write_UINT16(s, 0x0050); /* Cmd+Sp+cbChId+Pad. Note: MSTSC sends 0x005c */
1253 Stream_Write_UINT16(s, drdynvc->version);
1254 status = drdynvc_send(drdynvc, s, nullptr);
1255
1256 if (status != CHANNEL_RC_OK)
1257 {
1258 WLog_Print(drdynvc->log, WLOG_ERROR, "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1259 WTSErrorToString(status), status);
1260 }
1261
1262 return status;
1263}
1264
1270static UINT drdynvc_process_capability_request(drdynvcPlugin* drdynvc, int Sp, int cbChId,
1271 wStream* s)
1272{
1273 UINT status = 0;
1274
1275 if (!drdynvc)
1276 return CHANNEL_RC_BAD_INIT_HANDLE;
1277
1278 if (!Stream_CheckAndLogRequiredLength(TAG, s, 3))
1279 return ERROR_INVALID_DATA;
1280
1281 WLog_Print(drdynvc->log, WLOG_TRACE, "capability_request Sp=%d cbChId=%d", Sp, cbChId);
1282 Stream_Seek(s, 1); /* pad */
1283 Stream_Read_UINT16(s, drdynvc->version);
1284
1285 /* RDP8 servers offer version 3, though Microsoft forgot to document it
1286 * in their early documents. It behaves the same as version 2.
1287 */
1288 if ((drdynvc->version == 2) || (drdynvc->version == 3))
1289 {
1290 if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
1291 return ERROR_INVALID_DATA;
1292
1293 Stream_Read_UINT16(s, drdynvc->PriorityCharge0);
1294 Stream_Read_UINT16(s, drdynvc->PriorityCharge1);
1295 Stream_Read_UINT16(s, drdynvc->PriorityCharge2);
1296 Stream_Read_UINT16(s, drdynvc->PriorityCharge3);
1297 }
1298
1299 status = drdynvc_send_capability_response(drdynvc);
1300 drdynvc->state = DRDYNVC_STATE_READY;
1301 return status;
1302}
1303
1304static UINT32 drdynvc_cblen_to_bytes(int cbLen)
1305{
1306 switch (cbLen)
1307 {
1308 case 0:
1309 return 1;
1310
1311 case 1:
1312 return 2;
1313
1314 default:
1315 return 4;
1316 }
1317}
1318
1319static UINT32 drdynvc_read_variable_uint(wStream* s, int cbLen)
1320{
1321 UINT32 val = 0;
1322
1323 switch (cbLen)
1324 {
1325 case 0:
1326 Stream_Read_UINT8(s, val);
1327 break;
1328
1329 case 1:
1330 Stream_Read_UINT16(s, val);
1331 break;
1332
1333 default:
1334 Stream_Read_UINT32(s, val);
1335 break;
1336 }
1337
1338 return val;
1339}
1340
1346static UINT drdynvc_process_create_request(drdynvcPlugin* drdynvc, UINT8 Sp, UINT8 cbChId,
1347 wStream* s)
1348{
1349 UINT status = 0;
1350 wStream* data_out = nullptr;
1351 UINT channel_status = 0;
1352 DVCMAN* dvcman = nullptr;
1353 DVCMAN_CHANNEL* channel = nullptr;
1354 INT32 retStatus = 0;
1355
1356 WINPR_UNUSED(Sp);
1357 if (!drdynvc)
1358 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1359
1360 dvcman = (DVCMAN*)drdynvc->channel_mgr;
1361 WINPR_ASSERT(dvcman);
1362
1363 if (drdynvc->state == DRDYNVC_STATE_CAPABILITIES)
1364 {
1370 drdynvc->version = 3;
1371
1372 if ((status = drdynvc_send_capability_response(drdynvc)))
1373 {
1374 WLog_Print(drdynvc->log, WLOG_ERROR, "drdynvc_send_capability_response failed!");
1375 return status;
1376 }
1377
1378 drdynvc->state = DRDYNVC_STATE_READY;
1379 }
1380
1381 if (!Stream_CheckAndLogRequiredLength(TAG, s, drdynvc_cblen_to_bytes(cbChId)))
1382 return ERROR_INVALID_DATA;
1383
1384 const UINT32 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1385 const size_t pos = Stream_GetPosition(s);
1386 const char* name = Stream_ConstPointer(s);
1387 const size_t length = Stream_GetRemainingLength(s);
1388
1389 if (strnlen(name, length) >= length)
1390 return ERROR_INVALID_DATA;
1391
1392 WLog_Print(drdynvc->log, WLOG_DEBUG,
1393 "process_create_request: ChannelId=%" PRIu32 " ChannelName=%s", ChannelId, name);
1394
1395 data_out = StreamPool_Take(dvcman->pool, pos + 4);
1396 if (!data_out)
1397 {
1398 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1399 return CHANNEL_RC_NO_MEMORY;
1400 }
1401
1402 Stream_Write_UINT8(data_out, (CREATE_REQUEST_PDU << 4) | cbChId);
1403 if (!Stream_SetPosition(s, 1))
1404 return ERROR_INVALID_DATA;
1405 Stream_Copy(s, data_out, pos - 1);
1406
1407 channel =
1408 dvcman_create_channel(drdynvc, drdynvc->channel_mgr, ChannelId, name, &channel_status);
1409 switch (channel_status)
1410 {
1411 case CHANNEL_RC_OK:
1412 WLog_Print(drdynvc->log, WLOG_DEBUG, "channel created");
1413 retStatus = 0;
1414 break;
1415 case CHANNEL_RC_NO_MEMORY:
1416 WLog_Print(drdynvc->log, WLOG_DEBUG, "not enough memory for channel creation");
1417 retStatus = STATUS_NO_MEMORY;
1418 break;
1419 case ERROR_NOT_FOUND:
1420 WLog_Print(drdynvc->log, WLOG_DEBUG, "no listener for '%s'", name);
1421 retStatus = STATUS_NOT_FOUND; /* same code used by mstsc, STATUS_UNSUCCESSFUL */
1422 break;
1423 default:
1424 WLog_Print(drdynvc->log, WLOG_DEBUG, "channel creation error");
1425 retStatus = STATUS_UNSUCCESSFUL; /* same code used by mstsc, STATUS_UNSUCCESSFUL */
1426 break;
1427 }
1428 Stream_Write_INT32(data_out, retStatus);
1429
1430 status = drdynvc_send(drdynvc, data_out, nullptr);
1431 if (status != CHANNEL_RC_OK)
1432 {
1433 WLog_Print(drdynvc->log, WLOG_ERROR, "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1434 WTSErrorToString(status), status);
1435 dvcman_channel_unref(channel);
1436 return status;
1437 }
1438
1439 if (channel_status == CHANNEL_RC_OK)
1440 {
1441 if ((status = dvcman_open_channel(drdynvc, channel)))
1442 {
1443 WLog_Print(drdynvc->log, WLOG_ERROR,
1444 "dvcman_open_channel failed with error %" PRIu32 "!", status);
1445 return status;
1446 }
1447 }
1448
1449 return status;
1450}
1451
1457static UINT drdynvc_process_data_first(drdynvcPlugin* drdynvc, int Sp, int cbChId, wStream* s,
1458 BOOL compressed, UINT32 ThreadingFlags)
1459{
1460 WINPR_ASSERT(drdynvc);
1461 if (!Stream_CheckAndLogRequiredLength(
1462 TAG, s, drdynvc_cblen_to_bytes(cbChId) + drdynvc_cblen_to_bytes(Sp)))
1463 return ERROR_INVALID_DATA;
1464
1465 UINT32 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1466 UINT32 Length = drdynvc_read_variable_uint(s, Sp);
1467 WLog_Print(drdynvc->log, WLOG_TRACE,
1468 "process_data_first: Sp=%d cbChId=%d, ChannelId=%" PRIu32 " Length=%" PRIu32 "", Sp,
1469 cbChId, ChannelId, Length);
1470
1471 DVCMAN_CHANNEL* channel = dvcman_get_channel_by_id(drdynvc->channel_mgr, ChannelId, TRUE);
1472 if (!channel)
1473 {
1479 WLog_Print(drdynvc->log, WLOG_ERROR, "ChannelId %" PRIu32 " not found!", ChannelId);
1480 return CHANNEL_RC_OK;
1481 }
1482
1483 UINT status = CHANNEL_RC_OK;
1484 BOOL shouldFree = FALSE;
1485 if (channel->state != DVC_CHANNEL_RUNNING)
1486 goto out;
1487
1488 if (compressed)
1489 {
1490 BYTE* data = nullptr;
1491 UINT32 dataSize = 0;
1492 if (zgfx_decompress(channel->decompressor, Stream_Pointer(s),
1493 WINPR_ASSERTING_INT_CAST(UINT32, Stream_GetRemainingLength(s)), &data,
1494 &dataSize, 0) < 0)
1495 {
1496 status = ERROR_INVALID_DATA;
1497 WLog_Print(drdynvc->log, WLOG_ERROR, "error de-compressing first packet");
1498 goto out;
1499 }
1500
1501 s = Stream_New(data, dataSize);
1502 if (!s)
1503 {
1504 status = CHANNEL_RC_NO_MEMORY;
1505 WLog_Print(drdynvc->log, WLOG_ERROR, "error allocating new Stream(len=%" PRIu32 ")",
1506 dataSize);
1507 free(data);
1508 goto out;
1509 }
1510 shouldFree = TRUE;
1511 }
1512
1513 status = dvcman_receive_channel_data_first(channel, Length);
1514
1515 if (status == CHANNEL_RC_OK)
1516 status = dvcman_receive_channel_data(channel, s, ThreadingFlags);
1517
1518 if (status != CHANNEL_RC_OK)
1519 status = dvcman_channel_close(channel, FALSE, FALSE);
1520
1521out:
1522 if (shouldFree)
1523 Stream_Free(s, TRUE);
1524 dvcman_channel_unref(channel);
1525 return status;
1526}
1527
1533static UINT drdynvc_process_data(drdynvcPlugin* drdynvc, int Sp, int cbChId, wStream* s,
1534 BOOL compressed, UINT32 ThreadingFlags)
1535{
1536 WINPR_ASSERT(drdynvc);
1537 if (!Stream_CheckAndLogRequiredLength(TAG, s, drdynvc_cblen_to_bytes(cbChId)))
1538 return ERROR_INVALID_DATA;
1539
1540 UINT32 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1541 WLog_Print(drdynvc->log, WLOG_TRACE, "process_data: Sp=%d cbChId=%d, ChannelId=%" PRIu32 "", Sp,
1542 cbChId, ChannelId);
1543
1544 DVCMAN_CHANNEL* channel = dvcman_get_channel_by_id(drdynvc->channel_mgr, ChannelId, TRUE);
1545 if (!channel)
1546 {
1552 WLog_Print(drdynvc->log, WLOG_ERROR, "ChannelId %" PRIu32 " not found!", ChannelId);
1553 return CHANNEL_RC_OK;
1554 }
1555
1556 BOOL shouldFree = FALSE;
1557 UINT status = CHANNEL_RC_OK;
1558 if (channel->state != DVC_CHANNEL_RUNNING)
1559 goto out;
1560
1561 if (compressed)
1562 {
1563 BYTE* data = nullptr;
1564 UINT32 dataSize = 0;
1565
1566 if (zgfx_decompress(channel->decompressor, Stream_Pointer(s),
1567 WINPR_ASSERTING_INT_CAST(UINT32, Stream_GetRemainingLength(s)), &data,
1568 &dataSize, 0) < 0)
1569 {
1570 status = ERROR_INVALID_DATA;
1571 WLog_Print(drdynvc->log, WLOG_ERROR, "error de-compressing data packet");
1572 goto out;
1573 }
1574
1575 s = Stream_New(data, dataSize);
1576 if (!s)
1577 {
1578 status = CHANNEL_RC_NO_MEMORY;
1579 WLog_Print(drdynvc->log, WLOG_ERROR, "error allocating new Stream(len=%" PRIu32 ")",
1580 dataSize);
1581 free(data);
1582 goto out;
1583 }
1584 shouldFree = TRUE;
1585 }
1586
1587 status = dvcman_receive_channel_data(channel, s, ThreadingFlags);
1588 if (status != CHANNEL_RC_OK)
1589 status = dvcman_channel_close(channel, FALSE, FALSE);
1590
1591out:
1592 if (shouldFree)
1593 Stream_Free(s, TRUE);
1594 dvcman_channel_unref(channel);
1595 return status;
1596}
1597
1603static UINT drdynvc_process_close_request(drdynvcPlugin* drdynvc, int Sp, int cbChId, wStream* s)
1604{
1605 UINT32 ChannelId = 0;
1606 DVCMAN_CHANNEL* channel = nullptr;
1607
1608 WINPR_ASSERT(drdynvc);
1609 if (!Stream_CheckAndLogRequiredLength(TAG, s, drdynvc_cblen_to_bytes(cbChId)))
1610 return ERROR_INVALID_DATA;
1611
1612 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1613 WLog_Print(drdynvc->log, WLOG_DEBUG,
1614 "process_close_request: Sp=%d cbChId=%d, ChannelId=%" PRIu32 "", Sp, cbChId,
1615 ChannelId);
1616
1617 channel = dvcman_get_channel_by_id(drdynvc->channel_mgr, ChannelId, TRUE);
1618 if (!channel)
1619 {
1620 WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_close_request channel %" PRIu32 " not present",
1621 ChannelId);
1622 return CHANNEL_RC_OK;
1623 }
1624
1625 dvcman_channel_close(channel, TRUE, FALSE);
1626 dvcman_channel_unref(channel);
1627 return CHANNEL_RC_OK;
1628}
1629
1635static UINT drdynvc_order_recv(drdynvcPlugin* drdynvc, wStream* s, UINT32 ThreadingFlags)
1636{
1637 WINPR_ASSERT(drdynvc);
1638 if (!Stream_CheckAndLogRequiredLength(TAG, s, 1))
1639 return ERROR_INVALID_DATA;
1640
1641 UINT8 value = Stream_Get_UINT8(s);
1642 const UINT8 Cmd = (value & 0xf0) >> 4;
1643 const UINT8 Sp = (value & 0x0c) >> 2;
1644 const UINT8 cbChId = (value & 0x03) >> 0;
1645 WLog_Print(drdynvc->log, WLOG_TRACE, "order_recv: Cmd=%s, Sp=%" PRIu8 " cbChId=%" PRIu8,
1646 drdynvc_get_packet_type(Cmd), Sp, cbChId);
1647
1648 switch (Cmd)
1649 {
1650 case CAPABILITY_REQUEST_PDU:
1651 return drdynvc_process_capability_request(drdynvc, Sp, cbChId, s);
1652
1653 case CREATE_REQUEST_PDU:
1654 return drdynvc_process_create_request(drdynvc, Sp, cbChId, s);
1655
1656 case DATA_FIRST_PDU:
1657 case DATA_FIRST_COMPRESSED_PDU:
1658 return drdynvc_process_data_first(drdynvc, Sp, cbChId, s,
1659 (Cmd == DATA_FIRST_COMPRESSED_PDU), ThreadingFlags);
1660
1661 case DATA_PDU:
1662 case DATA_COMPRESSED_PDU:
1663 return drdynvc_process_data(drdynvc, Sp, cbChId, s, (Cmd == DATA_COMPRESSED_PDU),
1664 ThreadingFlags);
1665
1666 case CLOSE_REQUEST_PDU:
1667 return drdynvc_process_close_request(drdynvc, Sp, cbChId, s);
1668
1669 case SOFT_SYNC_RESPONSE_PDU:
1670 WLog_Print(drdynvc->log, WLOG_ERROR,
1671 "not expecting a SOFT_SYNC_RESPONSE_PDU as a client");
1672 return ERROR_INTERNAL_ERROR;
1673
1674 default:
1675 WLog_Print(drdynvc->log, WLOG_ERROR, "unknown drdynvc cmd 0x%x", Cmd);
1676 return ERROR_INTERNAL_ERROR;
1677 }
1678}
1679
1685static UINT drdynvc_virtual_channel_event_data_received(drdynvcPlugin* drdynvc, void* pData,
1686 UINT32 dataLength, UINT32 totalLength,
1687 UINT32 dataFlags)
1688{
1689 wStream* data_in = nullptr;
1690
1691 WINPR_ASSERT(drdynvc);
1692 if ((dataFlags & CHANNEL_FLAG_SUSPEND) || (dataFlags & CHANNEL_FLAG_RESUME))
1693 {
1694 return CHANNEL_RC_OK;
1695 }
1696
1697 if (dataFlags & CHANNEL_FLAG_FIRST)
1698 {
1699 DVCMAN* mgr = (DVCMAN*)drdynvc->channel_mgr;
1700 if (drdynvc->data_in)
1701 Stream_Release(drdynvc->data_in);
1702
1703 drdynvc->data_in = StreamPool_Take(mgr->pool, totalLength);
1704 }
1705
1706 if (!(data_in = drdynvc->data_in))
1707 {
1708 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1709 return CHANNEL_RC_NO_MEMORY;
1710 }
1711
1712 if (!Stream_EnsureRemainingCapacity(data_in, dataLength))
1713 {
1714 WLog_Print(drdynvc->log, WLOG_ERROR, "Stream_EnsureRemainingCapacity failed!");
1715 Stream_Release(drdynvc->data_in);
1716 drdynvc->data_in = nullptr;
1717 return ERROR_INTERNAL_ERROR;
1718 }
1719
1720 Stream_Write(data_in, pData, dataLength);
1721
1722 if (dataFlags & CHANNEL_FLAG_LAST)
1723 {
1724 const size_t cap = Stream_Capacity(data_in);
1725 const size_t pos = Stream_GetPosition(data_in);
1726 if (cap < pos)
1727 {
1728 WLog_Print(drdynvc->log, WLOG_ERROR, "drdynvc_plugin_process_received: read error");
1729 return ERROR_INVALID_DATA;
1730 }
1731
1732 drdynvc->data_in = nullptr;
1733 Stream_SealLength(data_in);
1734 Stream_ResetPosition(data_in);
1735
1736 if (drdynvc->async)
1737 {
1738 if (!MessageQueue_Post(drdynvc->queue, nullptr, 0, (void*)data_in, nullptr))
1739 {
1740 WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_Post failed!");
1741 return ERROR_INTERNAL_ERROR;
1742 }
1743 }
1744 else
1745 {
1746 UINT error = drdynvc_order_recv(drdynvc, data_in, TRUE);
1747 Stream_Release(data_in);
1748
1749 if (error)
1750 {
1751 WLog_Print(drdynvc->log, WLOG_WARN,
1752 "drdynvc_order_recv failed with error %" PRIu32 "!", error);
1753 return error;
1754 }
1755 }
1756 }
1757
1758 return CHANNEL_RC_OK;
1759}
1760
1761static void VCAPITYPE drdynvc_virtual_channel_open_event_ex(LPVOID lpUserParam, DWORD openHandle,
1762 UINT event, LPVOID pData,
1763 UINT32 dataLength, UINT32 totalLength,
1764 UINT32 dataFlags)
1765{
1766 UINT error = CHANNEL_RC_OK;
1767 drdynvcPlugin* drdynvc = (drdynvcPlugin*)lpUserParam;
1768
1769 WINPR_ASSERT(drdynvc);
1770 switch (event)
1771 {
1772 case CHANNEL_EVENT_DATA_RECEIVED:
1773 if (!drdynvc || (drdynvc->OpenHandle != openHandle))
1774 {
1775 WLog_ERR(TAG, "drdynvc_virtual_channel_open_event: error no match");
1776 return;
1777 }
1778 if ((error = drdynvc_virtual_channel_event_data_received(drdynvc, pData, dataLength,
1779 totalLength, dataFlags)))
1780 WLog_Print(drdynvc->log, WLOG_ERROR,
1781 "drdynvc_virtual_channel_event_data_received failed with error %" PRIu32
1782 "",
1783 error);
1784
1785 break;
1786
1787 case CHANNEL_EVENT_WRITE_CANCELLED:
1788 case CHANNEL_EVENT_WRITE_COMPLETE:
1789 {
1790 wStream* s = (wStream*)pData;
1791 Stream_Release(s);
1792 }
1793 break;
1794
1795 case CHANNEL_EVENT_USER:
1796 break;
1797 default:
1798 break;
1799 }
1800
1801 if (error && drdynvc && drdynvc->rdpcontext)
1802 setChannelError(drdynvc->rdpcontext, error,
1803 "drdynvc_virtual_channel_open_event reported an error");
1804}
1805
1806static DWORD WINAPI drdynvc_virtual_channel_client_thread(LPVOID arg)
1807{
1808 /* TODO: rewrite this */
1809 wStream* data = nullptr;
1810 wMessage message = WINPR_C_ARRAY_INIT;
1811 UINT error = CHANNEL_RC_OK;
1812 drdynvcPlugin* drdynvc = (drdynvcPlugin*)arg;
1813
1814 if (!drdynvc)
1815 {
1816 ExitThread((DWORD)CHANNEL_RC_BAD_CHANNEL_HANDLE);
1817 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1818 }
1819
1820 while (1)
1821 {
1822 if (!MessageQueue_Wait(drdynvc->queue))
1823 {
1824 WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_Wait failed!");
1825 error = ERROR_INTERNAL_ERROR;
1826 break;
1827 }
1828
1829 if (!MessageQueue_Peek(drdynvc->queue, &message, TRUE))
1830 {
1831 WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_Peek failed!");
1832 error = ERROR_INTERNAL_ERROR;
1833 break;
1834 }
1835
1836 if (message.id == WMQ_QUIT)
1837 break;
1838
1839 if (message.id == 0)
1840 {
1841 UINT32 ThreadingFlags = TRUE;
1842 data = (wStream*)message.wParam;
1843
1844 if ((error = drdynvc_order_recv(drdynvc, data, ThreadingFlags)))
1845 {
1846 WLog_Print(drdynvc->log, WLOG_WARN,
1847 "drdynvc_order_recv failed with error %" PRIu32 "!", error);
1848 }
1849
1850 Stream_Release(data);
1851 }
1852 }
1853
1854 {
1855 /* Disconnect remaining dynamic channels that the server did not.
1856 * This is required to properly shut down channels by calling the appropriate
1857 * event handlers. */
1858 DVCMAN* drdynvcMgr = (DVCMAN*)drdynvc->channel_mgr;
1859
1860 HashTable_Clear(drdynvcMgr->channelsById);
1861 }
1862
1863 if (error && drdynvc->rdpcontext)
1864 setChannelError(drdynvc->rdpcontext, error,
1865 "drdynvc_virtual_channel_client_thread reported an error");
1866
1867 ExitThread((DWORD)error);
1868 return error;
1869}
1870
1871static void drdynvc_queue_object_free(void* obj)
1872{
1873 wStream* s = nullptr;
1874 wMessage* msg = (wMessage*)obj;
1875
1876 if (!msg || (msg->id != 0))
1877 return;
1878
1879 s = (wStream*)msg->wParam;
1880
1881 if (s)
1882 Stream_Release(s);
1883}
1884
1885static UINT drdynvc_virtual_channel_event_initialized(drdynvcPlugin* drdynvc, LPVOID pData,
1886 UINT32 dataLength)
1887{
1888 wObject* obj = nullptr;
1889 WINPR_UNUSED(pData);
1890 WINPR_UNUSED(dataLength);
1891
1892 if (!drdynvc)
1893 goto error;
1894
1895 drdynvc->queue = MessageQueue_New(nullptr);
1896
1897 if (!drdynvc->queue)
1898 {
1899 WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_New failed!");
1900 goto error;
1901 }
1902
1903 obj = MessageQueue_Object(drdynvc->queue);
1904 obj->fnObjectFree = drdynvc_queue_object_free;
1905 drdynvc->channel_mgr = dvcman_new(drdynvc);
1906
1907 if (!drdynvc->channel_mgr)
1908 {
1909 WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_new failed!");
1910 goto error;
1911 }
1912
1913 return CHANNEL_RC_OK;
1914error:
1915 return ERROR_INTERNAL_ERROR;
1916}
1917
1923static UINT drdynvc_virtual_channel_event_connected(drdynvcPlugin* drdynvc, LPVOID pData,
1924 UINT32 dataLength)
1925{
1926 UINT error = 0;
1927 UINT32 status = 0;
1928 rdpSettings* settings = nullptr;
1929
1930 WINPR_ASSERT(drdynvc);
1931 WINPR_UNUSED(pData);
1932 WINPR_UNUSED(dataLength);
1933
1934 if (!drdynvc)
1935 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1936
1937 WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelOpenEx);
1938 status = drdynvc->channelEntryPoints.pVirtualChannelOpenEx(
1939 drdynvc->InitHandle, &drdynvc->OpenHandle, drdynvc->channelDef.name,
1940 drdynvc_virtual_channel_open_event_ex);
1941
1942 if (status != CHANNEL_RC_OK)
1943 {
1944 WLog_Print(drdynvc->log, WLOG_ERROR, "pVirtualChannelOpen failed with %s [%08" PRIX32 "]",
1945 WTSErrorToString(status), status);
1946 return status;
1947 }
1948
1949 WINPR_ASSERT(drdynvc->rdpcontext);
1950 settings = drdynvc->rdpcontext->settings;
1951 WINPR_ASSERT(settings);
1952
1953 for (UINT32 index = 0;
1954 index < freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelCount); index++)
1955 {
1956 const ADDIN_ARGV* args =
1957 freerdp_settings_get_pointer_array(settings, FreeRDP_DynamicChannelArray, index);
1958 error = dvcman_load_addin(drdynvc, drdynvc->channel_mgr, args, drdynvc->rdpcontext);
1959
1960 if (CHANNEL_RC_OK != error)
1961 goto error;
1962 }
1963
1964 if ((error = dvcman_init(drdynvc, drdynvc->channel_mgr)))
1965 {
1966 WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_init failed with error %" PRIu32 "!", error);
1967 goto error;
1968 }
1969
1970 drdynvc->state = DRDYNVC_STATE_CAPABILITIES;
1971
1972 if (drdynvc->async)
1973 {
1974 if (!(drdynvc->thread = CreateThread(nullptr, 0, drdynvc_virtual_channel_client_thread,
1975 (void*)drdynvc, 0, nullptr)))
1976 {
1977 error = ERROR_INTERNAL_ERROR;
1978 WLog_Print(drdynvc->log, WLOG_ERROR, "CreateThread failed!");
1979 goto error;
1980 }
1981
1982 if (!SetThreadPriority(drdynvc->thread, THREAD_PRIORITY_HIGHEST))
1983 WLog_Print(drdynvc->log, WLOG_WARN, "SetThreadPriority failed, ignoring.");
1984 }
1985
1986error:
1987 return error;
1988}
1989
1995static UINT drdynvc_virtual_channel_event_disconnected(drdynvcPlugin* drdynvc)
1996{
1997 UINT status = 0;
1998
1999 if (!drdynvc)
2000 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2001
2002 if (drdynvc->OpenHandle == 0)
2003 return CHANNEL_RC_OK;
2004
2005 if (drdynvc->queue)
2006 {
2007 if (!MessageQueue_PostQuit(drdynvc->queue, 0))
2008 {
2009 status = GetLastError();
2010 WLog_Print(drdynvc->log, WLOG_ERROR,
2011 "MessageQueue_PostQuit failed with error %" PRIu32 "", status);
2012 return status;
2013 }
2014 }
2015
2016 if (drdynvc->thread)
2017 {
2018 if (WaitForSingleObject(drdynvc->thread, INFINITE) != WAIT_OBJECT_0)
2019 {
2020 status = GetLastError();
2021 WLog_Print(drdynvc->log, WLOG_ERROR,
2022 "WaitForSingleObject failed with error %" PRIu32 "", status);
2023 return status;
2024 }
2025
2026 (void)CloseHandle(drdynvc->thread);
2027 drdynvc->thread = nullptr;
2028 }
2029 else
2030 {
2031 {
2032 /* Disconnect remaining dynamic channels that the server did not.
2033 * This is required to properly shut down channels by calling the appropriate
2034 * event handlers. */
2035 DVCMAN* drdynvcMgr = (DVCMAN*)drdynvc->channel_mgr;
2036
2037 HashTable_Clear(drdynvcMgr->channelsById);
2038 }
2039 }
2040
2041 WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelCloseEx);
2042 status = drdynvc->channelEntryPoints.pVirtualChannelCloseEx(drdynvc->InitHandle,
2043 drdynvc->OpenHandle);
2044
2045 if (status != CHANNEL_RC_OK)
2046 {
2047 WLog_Print(drdynvc->log, WLOG_ERROR, "pVirtualChannelClose failed with %s [%08" PRIX32 "]",
2048 WTSErrorToString(status), status);
2049 }
2050
2051 dvcman_clear(drdynvc, drdynvc->channel_mgr);
2052 if (drdynvc->queue)
2053 MessageQueue_Clear(drdynvc->queue);
2054 drdynvc->OpenHandle = 0;
2055
2056 if (drdynvc->data_in)
2057 {
2058 Stream_Release(drdynvc->data_in);
2059 drdynvc->data_in = nullptr;
2060 }
2061
2062 return status;
2063}
2064
2070static UINT drdynvc_virtual_channel_event_terminated(drdynvcPlugin* drdynvc)
2071{
2072 if (!drdynvc)
2073 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2074
2075 MessageQueue_Free(drdynvc->queue);
2076 drdynvc->queue = nullptr;
2077
2078 if (drdynvc->channel_mgr)
2079 {
2080 dvcman_free(drdynvc, drdynvc->channel_mgr);
2081 drdynvc->channel_mgr = nullptr;
2082 }
2083 drdynvc->InitHandle = nullptr;
2084 free(drdynvc->context);
2085 free(drdynvc);
2086 return CHANNEL_RC_OK;
2087}
2088
2089static UINT drdynvc_virtual_channel_event_attached(drdynvcPlugin* drdynvc)
2090{
2091 UINT error = CHANNEL_RC_OK;
2092 DVCMAN* dvcman = nullptr;
2093
2094 if (!drdynvc)
2095 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2096
2097 dvcman = (DVCMAN*)drdynvc->channel_mgr;
2098
2099 if (!dvcman)
2100 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2101
2102 ArrayList_Lock(dvcman->plugins);
2103 for (size_t i = 0; i < ArrayList_Count(dvcman->plugins); i++)
2104 {
2105 IWTSPlugin* pPlugin = ArrayList_GetItem(dvcman->plugins, i);
2106
2107 error = IFCALLRESULT(CHANNEL_RC_OK, pPlugin->Attached, pPlugin);
2108 if (error != CHANNEL_RC_OK)
2109 {
2110 WLog_Print(drdynvc->log, WLOG_ERROR, "Attach failed with error %" PRIu32 "!", error);
2111 goto fail;
2112 }
2113 }
2114
2115fail:
2116 ArrayList_Unlock(dvcman->plugins);
2117 return error;
2118}
2119
2120static UINT drdynvc_virtual_channel_event_detached(drdynvcPlugin* drdynvc)
2121{
2122 UINT error = CHANNEL_RC_OK;
2123 DVCMAN* dvcman = nullptr;
2124
2125 if (!drdynvc)
2126 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2127
2128 dvcman = (DVCMAN*)drdynvc->channel_mgr;
2129
2130 if (!dvcman)
2131 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2132
2133 ArrayList_Lock(dvcman->plugins);
2134 for (size_t i = 0; i < ArrayList_Count(dvcman->plugins); i++)
2135 {
2136 IWTSPlugin* pPlugin = ArrayList_GetItem(dvcman->plugins, i);
2137
2138 error = IFCALLRESULT(CHANNEL_RC_OK, pPlugin->Detached, pPlugin);
2139 if (error != CHANNEL_RC_OK)
2140 {
2141 WLog_Print(drdynvc->log, WLOG_ERROR, "Detach failed with error %" PRIu32 "!", error);
2142 goto fail;
2143 }
2144 }
2145
2146fail:
2147 ArrayList_Unlock(dvcman->plugins);
2148
2149 return error;
2150}
2151
2152static VOID VCAPITYPE drdynvc_virtual_channel_init_event_ex(LPVOID lpUserParam, LPVOID pInitHandle,
2153 UINT event, LPVOID pData,
2154 UINT dataLength)
2155{
2156 UINT error = CHANNEL_RC_OK;
2157 drdynvcPlugin* drdynvc = (drdynvcPlugin*)lpUserParam;
2158
2159 if (!drdynvc || (drdynvc->InitHandle != pInitHandle))
2160 {
2161 WLog_ERR(TAG, "drdynvc_virtual_channel_init_event: error no match");
2162 return;
2163 }
2164
2165 switch (event)
2166 {
2167 case CHANNEL_EVENT_INITIALIZED:
2168 error = drdynvc_virtual_channel_event_initialized(drdynvc, pData, dataLength);
2169 break;
2170 case CHANNEL_EVENT_CONNECTED:
2171 if ((error = drdynvc_virtual_channel_event_connected(drdynvc, pData, dataLength)))
2172 WLog_Print(drdynvc->log, WLOG_ERROR,
2173 "drdynvc_virtual_channel_event_connected failed with error %" PRIu32 "",
2174 error);
2175
2176 break;
2177
2178 case CHANNEL_EVENT_DISCONNECTED:
2179 if ((error = drdynvc_virtual_channel_event_disconnected(drdynvc)))
2180 WLog_Print(drdynvc->log, WLOG_ERROR,
2181 "drdynvc_virtual_channel_event_disconnected failed with error %" PRIu32
2182 "",
2183 error);
2184
2185 break;
2186
2187 case CHANNEL_EVENT_TERMINATED:
2188 if ((error = drdynvc_virtual_channel_event_terminated(drdynvc)))
2189 WLog_Print(drdynvc->log, WLOG_ERROR,
2190 "drdynvc_virtual_channel_event_terminated failed with error %" PRIu32 "",
2191 error);
2192
2193 break;
2194
2195 case CHANNEL_EVENT_ATTACHED:
2196 if ((error = drdynvc_virtual_channel_event_attached(drdynvc)))
2197 WLog_Print(drdynvc->log, WLOG_ERROR,
2198 "drdynvc_virtual_channel_event_attached failed with error %" PRIu32 "",
2199 error);
2200
2201 break;
2202
2203 case CHANNEL_EVENT_DETACHED:
2204 if ((error = drdynvc_virtual_channel_event_detached(drdynvc)))
2205 WLog_Print(drdynvc->log, WLOG_ERROR,
2206 "drdynvc_virtual_channel_event_detached failed with error %" PRIu32 "",
2207 error);
2208
2209 break;
2210
2211 default:
2212 break;
2213 }
2214
2215 if (error && drdynvc->rdpcontext)
2216 setChannelError(drdynvc->rdpcontext, error,
2217 "drdynvc_virtual_channel_init_event_ex reported an error");
2218}
2219
2224static int drdynvc_get_version(DrdynvcClientContext* context)
2225{
2226 WINPR_ASSERT(context);
2227 drdynvcPlugin* drdynvc = (drdynvcPlugin*)context->handle;
2228 WINPR_ASSERT(drdynvc);
2229 return drdynvc->version;
2230}
2231
2232/* drdynvc is always built-in */
2233#define VirtualChannelEntryEx drdynvc_VirtualChannelEntryEx
2234
2235FREERDP_ENTRY_POINT(BOOL VCAPITYPE VirtualChannelEntryEx(PCHANNEL_ENTRY_POINTS_EX pEntryPoints,
2236 PVOID pInitHandle))
2237{
2238 UINT rc = 0;
2239 drdynvcPlugin* drdynvc = nullptr;
2240 DrdynvcClientContext* context = nullptr;
2241 CHANNEL_ENTRY_POINTS_FREERDP_EX* pEntryPointsEx = nullptr;
2242 drdynvc = (drdynvcPlugin*)calloc(1, sizeof(drdynvcPlugin));
2243
2244 WINPR_ASSERT(pEntryPoints);
2245 if (!drdynvc)
2246 {
2247 WLog_ERR(TAG, "calloc failed!");
2248 return FALSE;
2249 }
2250
2251 drdynvc->channelDef.options =
2252 CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP | CHANNEL_OPTION_COMPRESS_RDP;
2253 (void)sprintf_s(drdynvc->channelDef.name, ARRAYSIZE(drdynvc->channelDef.name),
2254 DRDYNVC_SVC_CHANNEL_NAME);
2255 drdynvc->state = DRDYNVC_STATE_INITIAL;
2256 pEntryPointsEx = (CHANNEL_ENTRY_POINTS_FREERDP_EX*)pEntryPoints;
2257
2258 if ((pEntryPointsEx->cbSize >= sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX)) &&
2259 (pEntryPointsEx->MagicNumber == FREERDP_CHANNEL_MAGIC_NUMBER))
2260 {
2261 context = (DrdynvcClientContext*)calloc(1, sizeof(DrdynvcClientContext));
2262
2263 if (!context)
2264 {
2265 WLog_Print(drdynvc->log, WLOG_ERROR, "calloc failed!");
2266 free(drdynvc);
2267 return FALSE;
2268 }
2269
2270 context->handle = (void*)drdynvc;
2271 context->custom = nullptr;
2272 drdynvc->context = context;
2273 context->GetVersion = drdynvc_get_version;
2274 context->GetChannelStats = drdynvc_get_channel_stats;
2275 drdynvc->rdpcontext = pEntryPointsEx->context;
2276 if (!freerdp_settings_get_bool(drdynvc->rdpcontext->settings,
2277 FreeRDP_TransportDumpReplay) &&
2278 !freerdp_settings_get_bool(drdynvc->rdpcontext->settings,
2279 FreeRDP_SynchronousDynamicChannels))
2280 drdynvc->async = TRUE;
2281 }
2282
2283 drdynvc->log = WLog_Get(TAG);
2284 WLog_Print(drdynvc->log, WLOG_DEBUG, "VirtualChannelEntryEx");
2285 CopyMemory(&(drdynvc->channelEntryPoints), pEntryPoints,
2287 drdynvc->InitHandle = pInitHandle;
2288
2289 WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelInitEx);
2290 rc = drdynvc->channelEntryPoints.pVirtualChannelInitEx(
2291 drdynvc, context, pInitHandle, &drdynvc->channelDef, 1, VIRTUAL_CHANNEL_VERSION_WIN2000,
2292 drdynvc_virtual_channel_init_event_ex);
2293
2294 if (CHANNEL_RC_OK != rc)
2295 {
2296 WLog_Print(drdynvc->log, WLOG_ERROR, "pVirtualChannelInit failed with %s [%08" PRIX32 "]",
2297 WTSErrorToString(rc), rc);
2298 free(drdynvc->context);
2299 free(drdynvc);
2300 return FALSE;
2301 }
2302
2303 drdynvc->channelEntryPoints.pInterface = context;
2304 return TRUE;
2305}
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.
Definition svc.h:60
Dynamic channel stats struct. Contains statistic information for a single dynamic channel.
This struct contains function pointer to initialize/free objects.
Definition collections.h:52
OBJECT_FREE_FN fnObjectFree
Definition collections.h:59
WINPR_ATTR_NODISCARD OBJECT_EQUALS_FN fnObjectEquals
Definition collections.h:61
WINPR_ATTR_NODISCARD OBJECT_NEW_FN fnObjectNew
Definition collections.h:54