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->bytesOut = 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 channel = nullptr;
875 goto out;
876 }
877
878 if (!bAccept)
879 {
880 WLog_Print(drdynvc->log, WLOG_ERROR, "OnNewChannelConnection returned with bAccept FALSE!");
881 *res = ERROR_INTERNAL_ERROR;
882 dvcman_channel_unref(channel);
883 channel = nullptr;
884 goto out;
885 }
886
887 WLog_Print(drdynvc->log, WLOG_DEBUG, "listener %s created new channel %" PRIu32 "",
888 listener->channel_name, channel->channel_id);
889 channel->state = DVC_CHANNEL_RUNNING;
890 channel->channel_callback = pCallback;
891 channel->pInterface = listener->iface.pInterface;
892 context = dvcman->drdynvc->context;
893
894 IFCALLRET(context->OnChannelConnected, *res, context, ChannelName, listener->iface.pInterface);
895 if (*res != CHANNEL_RC_OK)
896 {
897 WLog_Print(drdynvc->log, WLOG_ERROR,
898 "context.OnChannelConnected failed with error %" PRIu32 "", *res);
899 }
900
901out:
902 HashTable_Unlock(dvcman->listeners);
903
904 return channel;
905}
906
912static UINT dvcman_open_channel(drdynvcPlugin* drdynvc, DVCMAN_CHANNEL* channel)
913{
914 UINT error = CHANNEL_RC_OK;
915
916 WINPR_ASSERT(drdynvc);
917 WINPR_ASSERT(channel);
918 if (channel->state == DVC_CHANNEL_RUNNING)
919 {
920 IWTSVirtualChannelCallback* pCallback = channel->channel_callback;
921
922 if (pCallback->OnOpen)
923 {
924 check_open_close_receive(channel);
925 error = pCallback->OnOpen(pCallback);
926 if (error)
927 {
928 WLog_Print(drdynvc->log, WLOG_ERROR, "OnOpen failed with error %" PRIu32 "!",
929 error);
930 goto out;
931 }
932 }
933
934 WLog_Print(drdynvc->log, WLOG_DEBUG, "open_channel: ChannelId %" PRIu32 "",
935 channel->channel_id);
936 }
937
938out:
939 return error;
940}
941
947static UINT dvcman_receive_channel_data_first(DVCMAN_CHANNEL* channel, UINT32 length)
948{
949 WINPR_ASSERT(channel);
950 WINPR_ASSERT(channel->dvcman);
951 if (channel->dvc_data)
952 Stream_Release(channel->dvc_data);
953
954 channel->dvc_data = StreamPool_Take(channel->dvcman->pool, length);
955
956 if (!channel->dvc_data)
957 {
958 drdynvcPlugin* drdynvc = channel->dvcman->drdynvc;
959 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
960 return CHANNEL_RC_NO_MEMORY;
961 }
962
963 channel->dvc_data_length = length;
964 return CHANNEL_RC_OK;
965}
966
972static UINT dvcman_receive_channel_data(DVCMAN_CHANNEL* channel, wStream* data,
973 WINPR_ATTR_UNUSED UINT32 ThreadingFlags)
974{
975 UINT status = CHANNEL_RC_OK;
976 size_t dataSize = Stream_GetRemainingLength(data);
977
978 WINPR_ASSERT(channel);
979 WINPR_ASSERT(channel->dvcman);
980
981 channel->stats.bytesIn += Stream_Length(data);
982 if (channel->dvc_data)
983 {
984 drdynvcPlugin* drdynvc = channel->dvcman->drdynvc;
985
986 /* Fragmented data */
987 if (Stream_GetPosition(channel->dvc_data) + dataSize > channel->dvc_data_length)
988 {
989 WLog_Print(drdynvc->log, WLOG_ERROR, "data exceeding declared length!");
990 Stream_Release(channel->dvc_data);
991 channel->dvc_data = nullptr;
992 status = ERROR_INVALID_DATA;
993 goto out;
994 }
995
996 Stream_Copy(data, channel->dvc_data, dataSize);
997 channel->stats.fragmentsIn++;
998
999 if (Stream_GetPosition(channel->dvc_data) >= channel->dvc_data_length)
1000 {
1001 Stream_SealLength(channel->dvc_data);
1002 Stream_ResetPosition(channel->dvc_data);
1003
1004 status = dvcman_call_on_receive(channel, channel->dvc_data);
1005 Stream_Release(channel->dvc_data);
1006 channel->dvc_data = nullptr;
1007 }
1008 }
1009 else
1010 status = dvcman_call_on_receive(channel, data);
1011
1012out:
1013 return status;
1014}
1015
1016static UINT8 drdynvc_write_variable_uint(wStream* s, UINT32 val)
1017{
1018 UINT8 cb = 0;
1019
1020 if (val <= 0xFF)
1021 {
1022 cb = 0;
1023 Stream_Write_UINT8(s, (UINT8)val);
1024 }
1025 else if (val <= 0xFFFF)
1026 {
1027 cb = 1;
1028 Stream_Write_UINT16(s, (UINT16)val);
1029 }
1030 else
1031 {
1032 cb = 2;
1033 Stream_Write_UINT32(s, val);
1034 }
1035
1036 return cb;
1037}
1038
1044static UINT drdynvc_send(drdynvcPlugin* drdynvc, wStream* s, DVCMAN_CHANNEL_STATS* stats)
1045{
1046 UINT status = 0;
1047
1048 if (!drdynvc)
1049 status = CHANNEL_RC_BAD_CHANNEL_HANDLE;
1050 else
1051 {
1052 const size_t len = Stream_GetPosition(s);
1053
1054 if (stats)
1055 stats->bytesOut += len;
1056
1057 WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelWriteEx);
1058 status = drdynvc->channelEntryPoints.pVirtualChannelWriteEx(
1059 drdynvc->InitHandle, drdynvc->OpenHandle, Stream_Buffer(s), (UINT32)len, s);
1060 }
1061
1062 switch (status)
1063 {
1064 case CHANNEL_RC_OK:
1065 return CHANNEL_RC_OK;
1066
1067 case CHANNEL_RC_NOT_CONNECTED:
1068 Stream_Release(s);
1069 return CHANNEL_RC_OK;
1070
1071 case CHANNEL_RC_BAD_CHANNEL_HANDLE:
1072 Stream_Release(s);
1073 WLog_ERR(TAG, "VirtualChannelWriteEx failed with CHANNEL_RC_BAD_CHANNEL_HANDLE");
1074 return status;
1075
1076 default:
1077 Stream_Release(s);
1078 WLog_Print(drdynvc->log, WLOG_ERROR,
1079 "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1080 WTSErrorToString(status), status);
1081 return status;
1082 }
1083}
1084
1090static UINT drdynvc_write_data(drdynvcPlugin* drdynvc, UINT32 ChannelId, const BYTE* data,
1091 UINT32 dataSize, BOOL* close, DVCMAN_CHANNEL_STATS* stats)
1092{
1093 size_t pos = 0;
1094 UINT8 cbChId = 0;
1095 UINT8 cbLen = 0;
1096 UINT status = CHANNEL_RC_BAD_INIT_HANDLE;
1097 DVCMAN* dvcman = nullptr;
1098
1099 if (!drdynvc)
1100 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1101
1102 dvcman = (DVCMAN*)drdynvc->channel_mgr;
1103 WINPR_ASSERT(dvcman);
1104
1105 WLog_Print(drdynvc->log, WLOG_TRACE, "write_data: ChannelId=%" PRIu32 " size=%" PRIu32 "",
1106 ChannelId, dataSize);
1107 wStream* data_out = StreamPool_Take(dvcman->pool, CHANNEL_CHUNK_LENGTH);
1108
1109 if (!data_out)
1110 {
1111 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1112 return CHANNEL_RC_NO_MEMORY;
1113 }
1114
1115 if (!Stream_SetPosition(data_out, 1))
1116 {
1117 Stream_Release(data_out);
1118 return ERROR_INVALID_DATA;
1119 }
1120 cbChId = drdynvc_write_variable_uint(data_out, ChannelId);
1121 pos = Stream_GetPosition(data_out);
1122
1123 if (dataSize == 0)
1124 {
1125 /* TODO: shall treat that case with write(0) that do a close */
1126 *close = TRUE;
1127 Stream_Release(data_out);
1128 }
1129 else if (dataSize <= CHANNEL_CHUNK_LENGTH - pos)
1130 {
1131 Stream_ResetPosition(data_out);
1132 Stream_Write_UINT8(data_out, (DATA_PDU << 4) | cbChId);
1133 if (!Stream_SetPosition(data_out, pos))
1134 {
1135 Stream_Release(data_out);
1136 return ERROR_INVALID_DATA;
1137 }
1138 Stream_Write(data_out, data, dataSize);
1139 stats->packetsOut++;
1140 status = drdynvc_send(drdynvc, data_out, stats);
1141 }
1142 else
1143 {
1144 /* Fragment the data */
1145 cbLen = drdynvc_write_variable_uint(data_out, dataSize);
1146 pos = Stream_GetPosition(data_out);
1147 Stream_ResetPosition(data_out);
1148
1149 const INT32 pdu = (DATA_FIRST_PDU << 4) | cbChId | (cbLen << 2);
1150 Stream_Write_UINT8(data_out, WINPR_ASSERTING_INT_CAST(UINT8, pdu));
1151 if (!Stream_SetPosition(data_out, pos))
1152 {
1153 Stream_Release(data_out);
1154 return ERROR_INVALID_DATA;
1155 }
1156
1157 {
1158 WINPR_ASSERT(pos <= CHANNEL_CHUNK_LENGTH);
1159 const uint32_t chunkLength =
1160 CHANNEL_CHUNK_LENGTH - WINPR_ASSERTING_INT_CAST(uint32_t, pos);
1161 Stream_Write(data_out, data, chunkLength);
1162
1163 data += chunkLength;
1164 dataSize -= chunkLength;
1165 }
1166 if (dataSize > 0)
1167 stats->fragmentsOut++;
1168
1169 status = drdynvc_send(drdynvc, data_out, stats);
1170
1171 while (status == CHANNEL_RC_OK && dataSize > 0)
1172 {
1173 data_out = StreamPool_Take(dvcman->pool, CHANNEL_CHUNK_LENGTH);
1174
1175 if (!data_out)
1176 {
1177 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1178 return CHANNEL_RC_NO_MEMORY;
1179 }
1180
1181 if (!Stream_SetPosition(data_out, 1))
1182 {
1183 Stream_Release(data_out);
1184 return ERROR_INVALID_DATA;
1185 }
1186
1187 cbChId = drdynvc_write_variable_uint(data_out, ChannelId);
1188 pos = Stream_GetPosition(data_out);
1189 Stream_ResetPosition(data_out);
1190 Stream_Write_UINT8(data_out, (DATA_PDU << 4) | cbChId);
1191 if (!Stream_SetPosition(data_out, pos))
1192 {
1193 Stream_Release(data_out);
1194 return ERROR_INVALID_DATA;
1195 }
1196
1197 uint32_t chunkLength = dataSize;
1198
1199 WINPR_ASSERT(pos <= CHANNEL_CHUNK_LENGTH);
1200 const uint32_t clen = CHANNEL_CHUNK_LENGTH - WINPR_ASSERTING_INT_CAST(uint32_t, pos);
1201 if (chunkLength > clen)
1202 {
1203 stats->fragmentsOut++;
1204 chunkLength = clen;
1205 }
1206 else
1207 stats->packetsOut++;
1208
1209 Stream_Write(data_out, data, chunkLength);
1210 data += chunkLength;
1211 dataSize -= chunkLength;
1212
1213 status = drdynvc_send(drdynvc, data_out, stats);
1214 }
1215 }
1216
1217 if (status != CHANNEL_RC_OK)
1218 {
1219 WLog_Print(drdynvc->log, WLOG_ERROR, "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1220 WTSErrorToString(status), status);
1221 return status;
1222 }
1223
1224 return CHANNEL_RC_OK;
1225}
1226
1232static UINT drdynvc_send_capability_response(drdynvcPlugin* drdynvc)
1233{
1234 UINT status = 0;
1235 wStream* s = nullptr;
1236 DVCMAN* dvcman = nullptr;
1237
1238 if (!drdynvc)
1239 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1240
1241 dvcman = (DVCMAN*)drdynvc->channel_mgr;
1242 WINPR_ASSERT(dvcman);
1243
1244 WLog_Print(drdynvc->log, WLOG_TRACE, "capability_response");
1245 s = StreamPool_Take(dvcman->pool, 4);
1246
1247 if (!s)
1248 {
1249 WLog_Print(drdynvc->log, WLOG_ERROR, "Stream_New failed!");
1250 return CHANNEL_RC_NO_MEMORY;
1251 }
1252
1253 Stream_Write_UINT16(s, 0x0050); /* Cmd+Sp+cbChId+Pad. Note: MSTSC sends 0x005c */
1254 Stream_Write_UINT16(s, drdynvc->version);
1255 status = drdynvc_send(drdynvc, s, nullptr);
1256
1257 if (status != CHANNEL_RC_OK)
1258 {
1259 WLog_Print(drdynvc->log, WLOG_ERROR, "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1260 WTSErrorToString(status), status);
1261 }
1262
1263 return status;
1264}
1265
1271static UINT drdynvc_process_capability_request(drdynvcPlugin* drdynvc, int Sp, int cbChId,
1272 wStream* s)
1273{
1274 UINT status = 0;
1275
1276 if (!drdynvc)
1277 return CHANNEL_RC_BAD_INIT_HANDLE;
1278
1279 if (!Stream_CheckAndLogRequiredLength(TAG, s, 3))
1280 return ERROR_INVALID_DATA;
1281
1282 WLog_Print(drdynvc->log, WLOG_TRACE, "capability_request Sp=%d cbChId=%d", Sp, cbChId);
1283 Stream_Seek(s, 1); /* pad */
1284 Stream_Read_UINT16(s, drdynvc->version);
1285
1286 /* RDP8 servers offer version 3, though Microsoft forgot to document it
1287 * in their early documents. It behaves the same as version 2.
1288 */
1289 if ((drdynvc->version == 2) || (drdynvc->version == 3))
1290 {
1291 if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
1292 return ERROR_INVALID_DATA;
1293
1294 Stream_Read_UINT16(s, drdynvc->PriorityCharge0);
1295 Stream_Read_UINT16(s, drdynvc->PriorityCharge1);
1296 Stream_Read_UINT16(s, drdynvc->PriorityCharge2);
1297 Stream_Read_UINT16(s, drdynvc->PriorityCharge3);
1298 }
1299
1300 status = drdynvc_send_capability_response(drdynvc);
1301 drdynvc->state = DRDYNVC_STATE_READY;
1302 return status;
1303}
1304
1305static UINT32 drdynvc_cblen_to_bytes(int cbLen)
1306{
1307 switch (cbLen)
1308 {
1309 case 0:
1310 return 1;
1311
1312 case 1:
1313 return 2;
1314
1315 default:
1316 return 4;
1317 }
1318}
1319
1320static UINT32 drdynvc_read_variable_uint(wStream* s, int cbLen)
1321{
1322 UINT32 val = 0;
1323
1324 switch (cbLen)
1325 {
1326 case 0:
1327 Stream_Read_UINT8(s, val);
1328 break;
1329
1330 case 1:
1331 Stream_Read_UINT16(s, val);
1332 break;
1333
1334 default:
1335 Stream_Read_UINT32(s, val);
1336 break;
1337 }
1338
1339 return val;
1340}
1341
1347static UINT drdynvc_process_create_request(drdynvcPlugin* drdynvc, UINT8 Sp, UINT8 cbChId,
1348 wStream* s)
1349{
1350 UINT status = 0;
1351 wStream* data_out = nullptr;
1352 UINT channel_status = 0;
1353 DVCMAN* dvcman = nullptr;
1354 DVCMAN_CHANNEL* channel = nullptr;
1355 INT32 retStatus = 0;
1356
1357 WINPR_UNUSED(Sp);
1358 if (!drdynvc)
1359 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1360
1361 dvcman = (DVCMAN*)drdynvc->channel_mgr;
1362 WINPR_ASSERT(dvcman);
1363
1364 if (drdynvc->state == DRDYNVC_STATE_CAPABILITIES)
1365 {
1371 drdynvc->version = 3;
1372
1373 if ((status = drdynvc_send_capability_response(drdynvc)))
1374 {
1375 WLog_Print(drdynvc->log, WLOG_ERROR, "drdynvc_send_capability_response failed!");
1376 return status;
1377 }
1378
1379 drdynvc->state = DRDYNVC_STATE_READY;
1380 }
1381
1382 if (!Stream_CheckAndLogRequiredLength(TAG, s, drdynvc_cblen_to_bytes(cbChId)))
1383 return ERROR_INVALID_DATA;
1384
1385 const UINT32 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1386 const size_t pos = Stream_GetPosition(s);
1387 const char* name = Stream_ConstPointer(s);
1388 const size_t length = Stream_GetRemainingLength(s);
1389
1390 if (strnlen(name, length) >= length)
1391 return ERROR_INVALID_DATA;
1392
1393 WLog_Print(drdynvc->log, WLOG_DEBUG,
1394 "process_create_request: ChannelId=%" PRIu32 " ChannelName=%s", ChannelId, name);
1395
1396 data_out = StreamPool_Take(dvcman->pool, pos + 4);
1397 if (!data_out)
1398 {
1399 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1400 return CHANNEL_RC_NO_MEMORY;
1401 }
1402
1403 Stream_Write_UINT8(data_out, (CREATE_REQUEST_PDU << 4) | cbChId);
1404 if (!Stream_SetPosition(s, 1))
1405 return ERROR_INVALID_DATA;
1406 Stream_Copy(s, data_out, pos - 1);
1407
1408 channel =
1409 dvcman_create_channel(drdynvc, drdynvc->channel_mgr, ChannelId, name, &channel_status);
1410 switch (channel_status)
1411 {
1412 case CHANNEL_RC_OK:
1413 WLog_Print(drdynvc->log, WLOG_DEBUG, "channel created");
1414 retStatus = 0;
1415 break;
1416 case CHANNEL_RC_NO_MEMORY:
1417 WLog_Print(drdynvc->log, WLOG_DEBUG, "not enough memory for channel creation");
1418 retStatus = STATUS_NO_MEMORY;
1419 break;
1420 case ERROR_NOT_FOUND:
1421 WLog_Print(drdynvc->log, WLOG_DEBUG, "no listener for '%s'", name);
1422 retStatus = STATUS_NOT_FOUND; /* same code used by mstsc, STATUS_UNSUCCESSFUL */
1423 break;
1424 default:
1425 WLog_Print(drdynvc->log, WLOG_DEBUG, "channel creation error");
1426 retStatus = STATUS_UNSUCCESSFUL; /* same code used by mstsc, STATUS_UNSUCCESSFUL */
1427 break;
1428 }
1429 Stream_Write_INT32(data_out, retStatus);
1430
1431 status = drdynvc_send(drdynvc, data_out, nullptr);
1432 if (status != CHANNEL_RC_OK)
1433 {
1434 WLog_Print(drdynvc->log, WLOG_ERROR, "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1435 WTSErrorToString(status), status);
1436 if (channel_status == CHANNEL_RC_OK)
1437 dvcman_channel_unref(channel);
1438 return status;
1439 }
1440
1441 if (channel_status == CHANNEL_RC_OK)
1442 {
1443 if ((status = dvcman_open_channel(drdynvc, channel)))
1444 {
1445 WLog_Print(drdynvc->log, WLOG_ERROR,
1446 "dvcman_open_channel failed with error %" PRIu32 "!", status);
1447 return status;
1448 }
1449 }
1450
1451 return status;
1452}
1453
1459static UINT drdynvc_process_data_first(drdynvcPlugin* drdynvc, int Sp, int cbChId, wStream* s,
1460 BOOL compressed, UINT32 ThreadingFlags)
1461{
1462 WINPR_ASSERT(drdynvc);
1463 if (!Stream_CheckAndLogRequiredLength(
1464 TAG, s, drdynvc_cblen_to_bytes(cbChId) + drdynvc_cblen_to_bytes(Sp)))
1465 return ERROR_INVALID_DATA;
1466
1467 UINT32 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1468 UINT32 Length = drdynvc_read_variable_uint(s, Sp);
1469 WLog_Print(drdynvc->log, WLOG_TRACE,
1470 "process_data_first: Sp=%d cbChId=%d, ChannelId=%" PRIu32 " Length=%" PRIu32 "", Sp,
1471 cbChId, ChannelId, Length);
1472
1473 DVCMAN_CHANNEL* channel = dvcman_get_channel_by_id(drdynvc->channel_mgr, ChannelId, TRUE);
1474 if (!channel)
1475 {
1481 WLog_Print(drdynvc->log, WLOG_ERROR, "ChannelId %" PRIu32 " not found!", ChannelId);
1482 return CHANNEL_RC_OK;
1483 }
1484
1485 UINT status = CHANNEL_RC_OK;
1486 BOOL shouldFree = FALSE;
1487 if (channel->state != DVC_CHANNEL_RUNNING)
1488 goto out;
1489
1490 if (compressed)
1491 {
1492 BYTE* data = nullptr;
1493 UINT32 dataSize = 0;
1494 if (zgfx_decompress(channel->decompressor, Stream_Pointer(s),
1495 WINPR_ASSERTING_INT_CAST(UINT32, Stream_GetRemainingLength(s)), &data,
1496 &dataSize, 0) < 0)
1497 {
1498 status = ERROR_INVALID_DATA;
1499 WLog_Print(drdynvc->log, WLOG_ERROR, "error de-compressing first packet");
1500 goto out;
1501 }
1502
1503 s = Stream_New(data, dataSize);
1504 if (!s)
1505 {
1506 status = CHANNEL_RC_NO_MEMORY;
1507 WLog_Print(drdynvc->log, WLOG_ERROR, "error allocating new Stream(len=%" PRIu32 ")",
1508 dataSize);
1509 free(data);
1510 goto out;
1511 }
1512 shouldFree = TRUE;
1513 }
1514
1515 status = dvcman_receive_channel_data_first(channel, Length);
1516
1517 if (status == CHANNEL_RC_OK)
1518 status = dvcman_receive_channel_data(channel, s, ThreadingFlags);
1519
1520 if (status != CHANNEL_RC_OK)
1521 status = dvcman_channel_close(channel, FALSE, FALSE);
1522
1523out:
1524 if (shouldFree)
1525 Stream_Free(s, TRUE);
1526 dvcman_channel_unref(channel);
1527 return status;
1528}
1529
1535static UINT drdynvc_process_data(drdynvcPlugin* drdynvc, int Sp, int cbChId, wStream* s,
1536 BOOL compressed, UINT32 ThreadingFlags)
1537{
1538 WINPR_ASSERT(drdynvc);
1539 if (!Stream_CheckAndLogRequiredLength(TAG, s, drdynvc_cblen_to_bytes(cbChId)))
1540 return ERROR_INVALID_DATA;
1541
1542 UINT32 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1543 WLog_Print(drdynvc->log, WLOG_TRACE, "process_data: Sp=%d cbChId=%d, ChannelId=%" PRIu32 "", Sp,
1544 cbChId, ChannelId);
1545
1546 DVCMAN_CHANNEL* channel = dvcman_get_channel_by_id(drdynvc->channel_mgr, ChannelId, TRUE);
1547 if (!channel)
1548 {
1554 WLog_Print(drdynvc->log, WLOG_ERROR, "ChannelId %" PRIu32 " not found!", ChannelId);
1555 return CHANNEL_RC_OK;
1556 }
1557
1558 BOOL shouldFree = FALSE;
1559 UINT status = CHANNEL_RC_OK;
1560 if (channel->state != DVC_CHANNEL_RUNNING)
1561 goto out;
1562
1563 if (compressed)
1564 {
1565 BYTE* data = nullptr;
1566 UINT32 dataSize = 0;
1567
1568 if (zgfx_decompress(channel->decompressor, Stream_Pointer(s),
1569 WINPR_ASSERTING_INT_CAST(UINT32, Stream_GetRemainingLength(s)), &data,
1570 &dataSize, 0) < 0)
1571 {
1572 status = ERROR_INVALID_DATA;
1573 WLog_Print(drdynvc->log, WLOG_ERROR, "error de-compressing data packet");
1574 goto out;
1575 }
1576
1577 s = Stream_New(data, dataSize);
1578 if (!s)
1579 {
1580 status = CHANNEL_RC_NO_MEMORY;
1581 WLog_Print(drdynvc->log, WLOG_ERROR, "error allocating new Stream(len=%" PRIu32 ")",
1582 dataSize);
1583 free(data);
1584 goto out;
1585 }
1586 shouldFree = TRUE;
1587 }
1588
1589 status = dvcman_receive_channel_data(channel, s, ThreadingFlags);
1590 if (status != CHANNEL_RC_OK)
1591 status = dvcman_channel_close(channel, FALSE, FALSE);
1592
1593out:
1594 if (shouldFree)
1595 Stream_Free(s, TRUE);
1596 dvcman_channel_unref(channel);
1597 return status;
1598}
1599
1605static UINT drdynvc_process_close_request(drdynvcPlugin* drdynvc, int Sp, int cbChId, wStream* s)
1606{
1607 UINT32 ChannelId = 0;
1608 DVCMAN_CHANNEL* channel = nullptr;
1609
1610 WINPR_ASSERT(drdynvc);
1611 if (!Stream_CheckAndLogRequiredLength(TAG, s, drdynvc_cblen_to_bytes(cbChId)))
1612 return ERROR_INVALID_DATA;
1613
1614 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1615 WLog_Print(drdynvc->log, WLOG_DEBUG,
1616 "process_close_request: Sp=%d cbChId=%d, ChannelId=%" PRIu32 "", Sp, cbChId,
1617 ChannelId);
1618
1619 channel = dvcman_get_channel_by_id(drdynvc->channel_mgr, ChannelId, TRUE);
1620 if (!channel)
1621 {
1622 WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_close_request channel %" PRIu32 " not present",
1623 ChannelId);
1624 return CHANNEL_RC_OK;
1625 }
1626
1627 dvcman_channel_close(channel, TRUE, FALSE);
1628 dvcman_channel_unref(channel);
1629 return CHANNEL_RC_OK;
1630}
1631
1637static UINT drdynvc_order_recv(drdynvcPlugin* drdynvc, wStream* s, UINT32 ThreadingFlags)
1638{
1639 WINPR_ASSERT(drdynvc);
1640 if (!Stream_CheckAndLogRequiredLength(TAG, s, 1))
1641 return ERROR_INVALID_DATA;
1642
1643 UINT8 value = Stream_Get_UINT8(s);
1644 const UINT8 Cmd = (value & 0xf0) >> 4;
1645 const UINT8 Sp = (value & 0x0c) >> 2;
1646 const UINT8 cbChId = (value & 0x03) >> 0;
1647 WLog_Print(drdynvc->log, WLOG_TRACE, "order_recv: Cmd=%s, Sp=%" PRIu8 " cbChId=%" PRIu8,
1648 drdynvc_get_packet_type(Cmd), Sp, cbChId);
1649
1650 switch (Cmd)
1651 {
1652 case CAPABILITY_REQUEST_PDU:
1653 return drdynvc_process_capability_request(drdynvc, Sp, cbChId, s);
1654
1655 case CREATE_REQUEST_PDU:
1656 return drdynvc_process_create_request(drdynvc, Sp, cbChId, s);
1657
1658 case DATA_FIRST_PDU:
1659 case DATA_FIRST_COMPRESSED_PDU:
1660 return drdynvc_process_data_first(drdynvc, Sp, cbChId, s,
1661 (Cmd == DATA_FIRST_COMPRESSED_PDU), ThreadingFlags);
1662
1663 case DATA_PDU:
1664 case DATA_COMPRESSED_PDU:
1665 return drdynvc_process_data(drdynvc, Sp, cbChId, s, (Cmd == DATA_COMPRESSED_PDU),
1666 ThreadingFlags);
1667
1668 case CLOSE_REQUEST_PDU:
1669 return drdynvc_process_close_request(drdynvc, Sp, cbChId, s);
1670
1671 case SOFT_SYNC_RESPONSE_PDU:
1672 WLog_Print(drdynvc->log, WLOG_ERROR,
1673 "not expecting a SOFT_SYNC_RESPONSE_PDU as a client");
1674 return ERROR_INTERNAL_ERROR;
1675
1676 default:
1677 WLog_Print(drdynvc->log, WLOG_ERROR, "unknown drdynvc cmd 0x%x", Cmd);
1678 return ERROR_INTERNAL_ERROR;
1679 }
1680}
1681
1687static UINT drdynvc_virtual_channel_event_data_received(drdynvcPlugin* drdynvc, void* pData,
1688 UINT32 dataLength, UINT32 totalLength,
1689 UINT32 dataFlags)
1690{
1691 wStream* data_in = nullptr;
1692
1693 WINPR_ASSERT(drdynvc);
1694 if ((dataFlags & CHANNEL_FLAG_SUSPEND) || (dataFlags & CHANNEL_FLAG_RESUME))
1695 {
1696 return CHANNEL_RC_OK;
1697 }
1698
1699 if (dataFlags & CHANNEL_FLAG_FIRST)
1700 {
1701 DVCMAN* mgr = (DVCMAN*)drdynvc->channel_mgr;
1702 if (drdynvc->data_in)
1703 Stream_Release(drdynvc->data_in);
1704
1705 drdynvc->data_in = StreamPool_Take(mgr->pool, totalLength);
1706 }
1707
1708 if (!(data_in = drdynvc->data_in))
1709 {
1710 WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1711 return CHANNEL_RC_NO_MEMORY;
1712 }
1713
1714 if (!Stream_EnsureRemainingCapacity(data_in, dataLength))
1715 {
1716 WLog_Print(drdynvc->log, WLOG_ERROR, "Stream_EnsureRemainingCapacity failed!");
1717 Stream_Release(drdynvc->data_in);
1718 drdynvc->data_in = nullptr;
1719 return ERROR_INTERNAL_ERROR;
1720 }
1721
1722 Stream_Write(data_in, pData, dataLength);
1723
1724 if (dataFlags & CHANNEL_FLAG_LAST)
1725 {
1726 const size_t cap = Stream_Capacity(data_in);
1727 const size_t pos = Stream_GetPosition(data_in);
1728 if (cap < pos)
1729 {
1730 WLog_Print(drdynvc->log, WLOG_ERROR, "drdynvc_plugin_process_received: read error");
1731 return ERROR_INVALID_DATA;
1732 }
1733
1734 drdynvc->data_in = nullptr;
1735 Stream_SealLength(data_in);
1736 Stream_ResetPosition(data_in);
1737
1738 if (drdynvc->async)
1739 {
1740 if (!MessageQueue_Post(drdynvc->queue, nullptr, 0, (void*)data_in, nullptr))
1741 {
1742 WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_Post failed!");
1743 return ERROR_INTERNAL_ERROR;
1744 }
1745 }
1746 else
1747 {
1748 UINT error = drdynvc_order_recv(drdynvc, data_in, TRUE);
1749 Stream_Release(data_in);
1750
1751 if (error)
1752 {
1753 WLog_Print(drdynvc->log, WLOG_WARN,
1754 "drdynvc_order_recv failed with error %" PRIu32 "!", error);
1755 return error;
1756 }
1757 }
1758 }
1759
1760 return CHANNEL_RC_OK;
1761}
1762
1763static void VCAPITYPE drdynvc_virtual_channel_open_event_ex(LPVOID lpUserParam, DWORD openHandle,
1764 UINT event, LPVOID pData,
1765 UINT32 dataLength, UINT32 totalLength,
1766 UINT32 dataFlags)
1767{
1768 UINT error = CHANNEL_RC_OK;
1769 drdynvcPlugin* drdynvc = (drdynvcPlugin*)lpUserParam;
1770
1771 WINPR_ASSERT(drdynvc);
1772 switch (event)
1773 {
1774 case CHANNEL_EVENT_DATA_RECEIVED:
1775 if (!drdynvc || (drdynvc->OpenHandle != openHandle))
1776 {
1777 WLog_ERR(TAG, "drdynvc_virtual_channel_open_event: error no match");
1778 return;
1779 }
1780 if ((error = drdynvc_virtual_channel_event_data_received(drdynvc, pData, dataLength,
1781 totalLength, dataFlags)))
1782 WLog_Print(drdynvc->log, WLOG_ERROR,
1783 "drdynvc_virtual_channel_event_data_received failed with error %" PRIu32
1784 "",
1785 error);
1786
1787 break;
1788
1789 case CHANNEL_EVENT_WRITE_CANCELLED:
1790 case CHANNEL_EVENT_WRITE_COMPLETE:
1791 {
1792 wStream* s = (wStream*)pData;
1793 Stream_Release(s);
1794 }
1795 break;
1796
1797 case CHANNEL_EVENT_USER:
1798 break;
1799 default:
1800 break;
1801 }
1802
1803 if (error && drdynvc && drdynvc->rdpcontext)
1804 setChannelError(drdynvc->rdpcontext, error,
1805 "drdynvc_virtual_channel_open_event reported an error");
1806}
1807
1808static DWORD WINAPI drdynvc_virtual_channel_client_thread(LPVOID arg)
1809{
1810 /* TODO: rewrite this */
1811 wStream* data = nullptr;
1812 wMessage message = WINPR_C_ARRAY_INIT;
1813 UINT error = CHANNEL_RC_OK;
1814 drdynvcPlugin* drdynvc = (drdynvcPlugin*)arg;
1815
1816 if (!drdynvc)
1817 {
1818 ExitThread((DWORD)CHANNEL_RC_BAD_CHANNEL_HANDLE);
1819 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1820 }
1821
1822 while (1)
1823 {
1824 if (!MessageQueue_Wait(drdynvc->queue))
1825 {
1826 WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_Wait failed!");
1827 error = ERROR_INTERNAL_ERROR;
1828 break;
1829 }
1830
1831 if (!MessageQueue_Peek(drdynvc->queue, &message, TRUE))
1832 {
1833 WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_Peek failed!");
1834 error = ERROR_INTERNAL_ERROR;
1835 break;
1836 }
1837
1838 if (message.id == WMQ_QUIT)
1839 break;
1840
1841 if (message.id == 0)
1842 {
1843 UINT32 ThreadingFlags = TRUE;
1844 data = (wStream*)message.wParam;
1845
1846 if ((error = drdynvc_order_recv(drdynvc, data, ThreadingFlags)))
1847 {
1848 WLog_Print(drdynvc->log, WLOG_WARN,
1849 "drdynvc_order_recv failed with error %" PRIu32 "!", error);
1850 }
1851
1852 Stream_Release(data);
1853 }
1854 }
1855
1856 {
1857 /* Disconnect remaining dynamic channels that the server did not.
1858 * This is required to properly shut down channels by calling the appropriate
1859 * event handlers. */
1860 DVCMAN* drdynvcMgr = (DVCMAN*)drdynvc->channel_mgr;
1861
1862 HashTable_Clear(drdynvcMgr->channelsById);
1863 }
1864
1865 if (error && drdynvc->rdpcontext)
1866 setChannelError(drdynvc->rdpcontext, error,
1867 "drdynvc_virtual_channel_client_thread reported an error");
1868
1869 ExitThread((DWORD)error);
1870 return error;
1871}
1872
1873static void drdynvc_queue_object_free(void* obj)
1874{
1875 wStream* s = nullptr;
1876 wMessage* msg = (wMessage*)obj;
1877
1878 if (!msg || (msg->id != 0))
1879 return;
1880
1881 s = (wStream*)msg->wParam;
1882
1883 if (s)
1884 Stream_Release(s);
1885}
1886
1887static UINT drdynvc_virtual_channel_event_initialized(drdynvcPlugin* drdynvc, LPVOID pData,
1888 UINT32 dataLength)
1889{
1890 wObject* obj = nullptr;
1891 WINPR_UNUSED(pData);
1892 WINPR_UNUSED(dataLength);
1893
1894 if (!drdynvc)
1895 goto error;
1896
1897 drdynvc->queue = MessageQueue_New(nullptr);
1898
1899 if (!drdynvc->queue)
1900 {
1901 WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_New failed!");
1902 goto error;
1903 }
1904
1905 obj = MessageQueue_Object(drdynvc->queue);
1906 obj->fnObjectFree = drdynvc_queue_object_free;
1907 drdynvc->channel_mgr = dvcman_new(drdynvc);
1908
1909 if (!drdynvc->channel_mgr)
1910 {
1911 WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_new failed!");
1912 goto error;
1913 }
1914
1915 return CHANNEL_RC_OK;
1916error:
1917 return ERROR_INTERNAL_ERROR;
1918}
1919
1925static UINT drdynvc_virtual_channel_event_connected(drdynvcPlugin* drdynvc, LPVOID pData,
1926 UINT32 dataLength)
1927{
1928 UINT error = 0;
1929 UINT32 status = 0;
1930 rdpSettings* settings = nullptr;
1931
1932 WINPR_ASSERT(drdynvc);
1933 WINPR_UNUSED(pData);
1934 WINPR_UNUSED(dataLength);
1935
1936 if (!drdynvc)
1937 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1938
1939 WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelOpenEx);
1940 status = drdynvc->channelEntryPoints.pVirtualChannelOpenEx(
1941 drdynvc->InitHandle, &drdynvc->OpenHandle, drdynvc->channelDef.name,
1942 drdynvc_virtual_channel_open_event_ex);
1943
1944 if (status != CHANNEL_RC_OK)
1945 {
1946 WLog_Print(drdynvc->log, WLOG_ERROR, "pVirtualChannelOpen failed with %s [%08" PRIX32 "]",
1947 WTSErrorToString(status), status);
1948 return status;
1949 }
1950
1951 WINPR_ASSERT(drdynvc->rdpcontext);
1952 settings = drdynvc->rdpcontext->settings;
1953 WINPR_ASSERT(settings);
1954
1955 for (UINT32 index = 0;
1956 index < freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelCount); index++)
1957 {
1958 const ADDIN_ARGV* args =
1959 freerdp_settings_get_pointer_array(settings, FreeRDP_DynamicChannelArray, index);
1960 error = dvcman_load_addin(drdynvc, drdynvc->channel_mgr, args, drdynvc->rdpcontext);
1961
1962 if (CHANNEL_RC_OK != error)
1963 goto error;
1964 }
1965
1966 if ((error = dvcman_init(drdynvc, drdynvc->channel_mgr)))
1967 {
1968 WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_init failed with error %" PRIu32 "!", error);
1969 goto error;
1970 }
1971
1972 drdynvc->state = DRDYNVC_STATE_CAPABILITIES;
1973
1974 if (drdynvc->async)
1975 {
1976 if (!(drdynvc->thread = CreateThread(nullptr, 0, drdynvc_virtual_channel_client_thread,
1977 (void*)drdynvc, 0, nullptr)))
1978 {
1979 error = ERROR_INTERNAL_ERROR;
1980 WLog_Print(drdynvc->log, WLOG_ERROR, "CreateThread failed!");
1981 goto error;
1982 }
1983
1984 if (!SetThreadPriority(drdynvc->thread, THREAD_PRIORITY_HIGHEST))
1985 WLog_Print(drdynvc->log, WLOG_WARN, "SetThreadPriority failed, ignoring.");
1986 }
1987
1988error:
1989 return error;
1990}
1991
1997static UINT drdynvc_virtual_channel_event_disconnected(drdynvcPlugin* drdynvc)
1998{
1999 UINT status = 0;
2000
2001 if (!drdynvc)
2002 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2003
2004 if (drdynvc->OpenHandle == 0)
2005 return CHANNEL_RC_OK;
2006
2007 if (drdynvc->queue)
2008 {
2009 if (!MessageQueue_PostQuit(drdynvc->queue, 0))
2010 {
2011 status = GetLastError();
2012 WLog_Print(drdynvc->log, WLOG_ERROR,
2013 "MessageQueue_PostQuit failed with error %" PRIu32 "", status);
2014 return status;
2015 }
2016 }
2017
2018 if (drdynvc->thread)
2019 {
2020 if (WaitForSingleObject(drdynvc->thread, INFINITE) != WAIT_OBJECT_0)
2021 {
2022 status = GetLastError();
2023 WLog_Print(drdynvc->log, WLOG_ERROR,
2024 "WaitForSingleObject failed with error %" PRIu32 "", status);
2025 return status;
2026 }
2027
2028 (void)CloseHandle(drdynvc->thread);
2029 drdynvc->thread = nullptr;
2030 }
2031 else
2032 {
2033 {
2034 /* Disconnect remaining dynamic channels that the server did not.
2035 * This is required to properly shut down channels by calling the appropriate
2036 * event handlers. */
2037 DVCMAN* drdynvcMgr = (DVCMAN*)drdynvc->channel_mgr;
2038
2039 HashTable_Clear(drdynvcMgr->channelsById);
2040 }
2041 }
2042
2043 WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelCloseEx);
2044 status = drdynvc->channelEntryPoints.pVirtualChannelCloseEx(drdynvc->InitHandle,
2045 drdynvc->OpenHandle);
2046
2047 if (status != CHANNEL_RC_OK)
2048 {
2049 WLog_Print(drdynvc->log, WLOG_ERROR, "pVirtualChannelClose failed with %s [%08" PRIX32 "]",
2050 WTSErrorToString(status), status);
2051 }
2052
2053 dvcman_clear(drdynvc, drdynvc->channel_mgr);
2054 if (drdynvc->queue)
2055 MessageQueue_Clear(drdynvc->queue);
2056 drdynvc->OpenHandle = 0;
2057
2058 if (drdynvc->data_in)
2059 {
2060 Stream_Release(drdynvc->data_in);
2061 drdynvc->data_in = nullptr;
2062 }
2063
2064 return status;
2065}
2066
2072static UINT drdynvc_virtual_channel_event_terminated(drdynvcPlugin* drdynvc)
2073{
2074 if (!drdynvc)
2075 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2076
2077 MessageQueue_Free(drdynvc->queue);
2078 drdynvc->queue = nullptr;
2079
2080 if (drdynvc->channel_mgr)
2081 {
2082 dvcman_free(drdynvc, drdynvc->channel_mgr);
2083 drdynvc->channel_mgr = nullptr;
2084 }
2085 drdynvc->InitHandle = nullptr;
2086 free(drdynvc->context);
2087 free(drdynvc);
2088 return CHANNEL_RC_OK;
2089}
2090
2091static UINT drdynvc_virtual_channel_event_attached(drdynvcPlugin* drdynvc)
2092{
2093 UINT error = CHANNEL_RC_OK;
2094 DVCMAN* dvcman = nullptr;
2095
2096 if (!drdynvc)
2097 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2098
2099 dvcman = (DVCMAN*)drdynvc->channel_mgr;
2100
2101 if (!dvcman)
2102 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2103
2104 ArrayList_Lock(dvcman->plugins);
2105 for (size_t i = 0; i < ArrayList_Count(dvcman->plugins); i++)
2106 {
2107 IWTSPlugin* pPlugin = ArrayList_GetItem(dvcman->plugins, i);
2108
2109 error = IFCALLRESULT(CHANNEL_RC_OK, pPlugin->Attached, pPlugin);
2110 if (error != CHANNEL_RC_OK)
2111 {
2112 WLog_Print(drdynvc->log, WLOG_ERROR, "Attach failed with error %" PRIu32 "!", error);
2113 goto fail;
2114 }
2115 }
2116
2117fail:
2118 ArrayList_Unlock(dvcman->plugins);
2119 return error;
2120}
2121
2122static UINT drdynvc_virtual_channel_event_detached(drdynvcPlugin* drdynvc)
2123{
2124 UINT error = CHANNEL_RC_OK;
2125 DVCMAN* dvcman = nullptr;
2126
2127 if (!drdynvc)
2128 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2129
2130 dvcman = (DVCMAN*)drdynvc->channel_mgr;
2131
2132 if (!dvcman)
2133 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
2134
2135 ArrayList_Lock(dvcman->plugins);
2136 for (size_t i = 0; i < ArrayList_Count(dvcman->plugins); i++)
2137 {
2138 IWTSPlugin* pPlugin = ArrayList_GetItem(dvcman->plugins, i);
2139
2140 error = IFCALLRESULT(CHANNEL_RC_OK, pPlugin->Detached, pPlugin);
2141 if (error != CHANNEL_RC_OK)
2142 {
2143 WLog_Print(drdynvc->log, WLOG_ERROR, "Detach failed with error %" PRIu32 "!", error);
2144 goto fail;
2145 }
2146 }
2147
2148fail:
2149 ArrayList_Unlock(dvcman->plugins);
2150
2151 return error;
2152}
2153
2154static VOID VCAPITYPE drdynvc_virtual_channel_init_event_ex(LPVOID lpUserParam, LPVOID pInitHandle,
2155 UINT event, LPVOID pData,
2156 UINT dataLength)
2157{
2158 UINT error = CHANNEL_RC_OK;
2159 drdynvcPlugin* drdynvc = (drdynvcPlugin*)lpUserParam;
2160
2161 if (!drdynvc || (drdynvc->InitHandle != pInitHandle))
2162 {
2163 WLog_ERR(TAG, "drdynvc_virtual_channel_init_event: error no match");
2164 return;
2165 }
2166
2167 switch (event)
2168 {
2169 case CHANNEL_EVENT_INITIALIZED:
2170 error = drdynvc_virtual_channel_event_initialized(drdynvc, pData, dataLength);
2171 break;
2172 case CHANNEL_EVENT_CONNECTED:
2173 if ((error = drdynvc_virtual_channel_event_connected(drdynvc, pData, dataLength)))
2174 WLog_Print(drdynvc->log, WLOG_ERROR,
2175 "drdynvc_virtual_channel_event_connected failed with error %" PRIu32 "",
2176 error);
2177
2178 break;
2179
2180 case CHANNEL_EVENT_DISCONNECTED:
2181 if ((error = drdynvc_virtual_channel_event_disconnected(drdynvc)))
2182 WLog_Print(drdynvc->log, WLOG_ERROR,
2183 "drdynvc_virtual_channel_event_disconnected failed with error %" PRIu32
2184 "",
2185 error);
2186
2187 break;
2188
2189 case CHANNEL_EVENT_TERMINATED:
2190 if ((error = drdynvc_virtual_channel_event_terminated(drdynvc)))
2191 WLog_Print(drdynvc->log, WLOG_ERROR,
2192 "drdynvc_virtual_channel_event_terminated failed with error %" PRIu32 "",
2193 error);
2194
2195 break;
2196
2197 case CHANNEL_EVENT_ATTACHED:
2198 if ((error = drdynvc_virtual_channel_event_attached(drdynvc)))
2199 WLog_Print(drdynvc->log, WLOG_ERROR,
2200 "drdynvc_virtual_channel_event_attached failed with error %" PRIu32 "",
2201 error);
2202
2203 break;
2204
2205 case CHANNEL_EVENT_DETACHED:
2206 if ((error = drdynvc_virtual_channel_event_detached(drdynvc)))
2207 WLog_Print(drdynvc->log, WLOG_ERROR,
2208 "drdynvc_virtual_channel_event_detached failed with error %" PRIu32 "",
2209 error);
2210
2211 break;
2212
2213 default:
2214 break;
2215 }
2216
2217 if (error && drdynvc->rdpcontext)
2218 setChannelError(drdynvc->rdpcontext, error,
2219 "drdynvc_virtual_channel_init_event_ex reported an error");
2220}
2221
2226static int drdynvc_get_version(DrdynvcClientContext* context)
2227{
2228 WINPR_ASSERT(context);
2229 drdynvcPlugin* drdynvc = (drdynvcPlugin*)context->handle;
2230 WINPR_ASSERT(drdynvc);
2231 return drdynvc->version;
2232}
2233
2234/* drdynvc is always built-in */
2235#define VirtualChannelEntryEx drdynvc_VirtualChannelEntryEx
2236
2237FREERDP_ENTRY_POINT(BOOL VCAPITYPE VirtualChannelEntryEx(PCHANNEL_ENTRY_POINTS_EX pEntryPoints,
2238 PVOID pInitHandle))
2239{
2240 UINT rc = 0;
2241 drdynvcPlugin* drdynvc = nullptr;
2242 DrdynvcClientContext* context = nullptr;
2243 CHANNEL_ENTRY_POINTS_FREERDP_EX* pEntryPointsEx = nullptr;
2244 drdynvc = (drdynvcPlugin*)calloc(1, sizeof(drdynvcPlugin));
2245
2246 WINPR_ASSERT(pEntryPoints);
2247 if (!drdynvc)
2248 {
2249 WLog_ERR(TAG, "calloc failed!");
2250 return FALSE;
2251 }
2252
2253 drdynvc->channelDef.options =
2254 CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP | CHANNEL_OPTION_COMPRESS_RDP;
2255 (void)sprintf_s(drdynvc->channelDef.name, ARRAYSIZE(drdynvc->channelDef.name),
2256 DRDYNVC_SVC_CHANNEL_NAME);
2257 drdynvc->state = DRDYNVC_STATE_INITIAL;
2258 pEntryPointsEx = (CHANNEL_ENTRY_POINTS_FREERDP_EX*)pEntryPoints;
2259
2260 if ((pEntryPointsEx->cbSize >= sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX)) &&
2261 (pEntryPointsEx->MagicNumber == FREERDP_CHANNEL_MAGIC_NUMBER))
2262 {
2263 context = (DrdynvcClientContext*)calloc(1, sizeof(DrdynvcClientContext));
2264
2265 if (!context)
2266 {
2267 WLog_Print(drdynvc->log, WLOG_ERROR, "calloc failed!");
2268 free(drdynvc);
2269 return FALSE;
2270 }
2271
2272 context->handle = (void*)drdynvc;
2273 context->custom = nullptr;
2274 drdynvc->context = context;
2275 context->GetVersion = drdynvc_get_version;
2276 context->GetChannelStats = drdynvc_get_channel_stats;
2277 drdynvc->rdpcontext = pEntryPointsEx->context;
2278 if (!freerdp_settings_get_bool(drdynvc->rdpcontext->settings,
2279 FreeRDP_TransportDumpReplay) &&
2280 !freerdp_settings_get_bool(drdynvc->rdpcontext->settings,
2281 FreeRDP_SynchronousDynamicChannels))
2282 drdynvc->async = TRUE;
2283 }
2284
2285 drdynvc->log = WLog_Get(TAG);
2286 WLog_Print(drdynvc->log, WLOG_DEBUG, "VirtualChannelEntryEx");
2287 CopyMemory(&(drdynvc->channelEntryPoints), pEntryPoints,
2289 drdynvc->InitHandle = pInitHandle;
2290
2291 WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelInitEx);
2292 rc = drdynvc->channelEntryPoints.pVirtualChannelInitEx(
2293 drdynvc, context, pInitHandle, &drdynvc->channelDef, 1, VIRTUAL_CHANNEL_VERSION_WIN2000,
2294 drdynvc_virtual_channel_init_event_ex);
2295
2296 if (CHANNEL_RC_OK != rc)
2297 {
2298 WLog_Print(drdynvc->log, WLOG_ERROR, "pVirtualChannelInit failed with %s [%08" PRIX32 "]",
2299 WTSErrorToString(rc), rc);
2300 free(drdynvc->context);
2301 free(drdynvc);
2302 return FALSE;
2303 }
2304
2305 drdynvc->channelEntryPoints.pInterface = context;
2306 return TRUE;
2307}
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