Coverage Report

Created: 2026-01-09 06:49

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