Coverage Report

Created: 2025-12-02 06:09

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
      IWTSVirtualChannelCallback* cb = channel->channel_callback;
510
0
      if (cb)
511
0
      {
512
0
        check_open_close_receive(channel);
513
0
        IFCALL(cb->OnClose, cb);
514
0
      }
515
516
0
      channel->channel_callback = NULL;
517
518
0
      if (channel->dvcman && channel->dvcman->drdynvc)
519
0
      {
520
0
        if (context)
521
0
        {
522
0
          IFCALLRET(context->OnChannelDisconnected, error, context, channel->channel_name,
523
0
                    channel->pInterface);
524
0
        }
525
0
      }
526
527
0
      if (!fromHashTableFn)
528
0
        dvcman_channel_unref(channel);
529
0
      break;
530
0
    case DVC_CHANNEL_CLOSED:
531
0
      break;
532
0
    default:
533
0
      break;
534
0
  }
535
536
0
  return error;
537
0
}
538
539
static DVCMAN_CHANNEL* dvcman_channel_new(WINPR_ATTR_UNUSED drdynvcPlugin* drdynvc,
540
                                          IWTSVirtualChannelManager* pChannelMgr, UINT32 ChannelId,
541
                                          const char* ChannelName)
542
0
{
543
0
  DVCMAN_CHANNEL* channel = NULL;
544
545
0
  WINPR_ASSERT(drdynvc);
546
0
  WINPR_ASSERT(pChannelMgr);
547
0
  channel = (DVCMAN_CHANNEL*)calloc(1, sizeof(DVCMAN_CHANNEL));
548
549
0
  if (!channel)
550
0
    return NULL;
551
552
0
  channel->dvcman = (DVCMAN*)pChannelMgr;
553
0
  channel->channel_id = ChannelId;
554
0
  channel->refCounter = 1;
555
0
  channel->state = DVC_CHANNEL_INIT;
556
0
  channel->channel_name = _strdup(ChannelName);
557
0
  if (!channel->channel_name)
558
0
    goto fail;
559
560
0
  channel->decompressor = zgfx_context_new(FALSE);
561
0
  if (!channel->decompressor)
562
0
    goto fail;
563
564
0
  if (!InitializeCriticalSectionEx(&(channel->lock), 0, 0))
565
0
    goto fail;
566
567
0
  return channel;
568
0
fail:
569
0
  dvcman_channel_free(channel);
570
0
  return NULL;
571
0
}
572
573
static void dvcman_clear(drdynvcPlugin* drdynvc, IWTSVirtualChannelManager* pChannelMgr)
574
0
{
575
0
  DVCMAN* dvcman = (DVCMAN*)pChannelMgr;
576
577
0
  WINPR_ASSERT(dvcman);
578
0
  WINPR_UNUSED(drdynvc);
579
580
0
  HashTable_Clear(dvcman->channelsById);
581
0
  ArrayList_Clear(dvcman->plugins);
582
0
  ArrayList_Clear(dvcman->plugin_names);
583
0
  HashTable_Clear(dvcman->listeners);
584
0
}
585
static void dvcman_free(drdynvcPlugin* drdynvc, IWTSVirtualChannelManager* pChannelMgr)
586
0
{
587
0
  DVCMAN* dvcman = (DVCMAN*)pChannelMgr;
588
589
0
  WINPR_ASSERT(dvcman);
590
0
  WINPR_UNUSED(drdynvc);
591
592
0
  HashTable_Free(dvcman->channelsById);
593
0
  ArrayList_Free(dvcman->plugins);
594
0
  ArrayList_Free(dvcman->plugin_names);
595
0
  HashTable_Free(dvcman->listeners);
596
597
0
  StreamPool_Free(dvcman->pool);
598
0
  free(dvcman);
599
0
}
600
601
/**
602
 * Function description
603
 *
604
 * @return 0 on success, otherwise a Win32 error code
605
 */
606
static UINT dvcman_init(drdynvcPlugin* drdynvc, IWTSVirtualChannelManager* pChannelMgr)
607
0
{
608
0
  DVCMAN* dvcman = (DVCMAN*)pChannelMgr;
609
0
  UINT error = CHANNEL_RC_OK;
610
611
0
  WINPR_ASSERT(dvcman);
612
0
  ArrayList_Lock(dvcman->plugins);
613
0
  for (size_t i = 0; i < ArrayList_Count(dvcman->plugins); i++)
614
0
  {
615
0
    IWTSPlugin* pPlugin = ArrayList_GetItem(dvcman->plugins, i);
616
617
0
    error = IFCALLRESULT(CHANNEL_RC_OK, pPlugin->Initialize, pPlugin, pChannelMgr);
618
0
    if (error != CHANNEL_RC_OK)
619
0
    {
620
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "Initialize failed with error %" PRIu32 "!",
621
0
                 error);
622
0
      goto fail;
623
0
    }
624
0
  }
625
626
0
fail:
627
0
  ArrayList_Unlock(dvcman->plugins);
628
0
  return error;
629
0
}
630
631
/**
632
 * Function description
633
 *
634
 * @return 0 on success, otherwise a Win32 error code
635
 */
636
static UINT dvcman_write_channel(IWTSVirtualChannel* pChannel, ULONG cbSize, const BYTE* pBuffer,
637
                                 void* pReserved)
638
0
{
639
0
  BOOL close = FALSE;
640
0
  UINT status = 0;
641
0
  DVCMAN_CHANNEL* channel = (DVCMAN_CHANNEL*)pChannel;
642
643
0
  WINPR_UNUSED(pReserved);
644
0
  if (!channel || !channel->dvcman)
645
0
    return CHANNEL_RC_BAD_CHANNEL;
646
647
0
  EnterCriticalSection(&(channel->lock));
648
0
  status =
649
0
      drdynvc_write_data(channel->dvcman->drdynvc, channel->channel_id, pBuffer, cbSize, &close);
650
0
  LeaveCriticalSection(&(channel->lock));
651
  /* Close delayed, it removes the channel struct */
652
0
  if (close)
653
0
    dvcman_channel_close(channel, FALSE, FALSE);
654
655
0
  return status;
656
0
}
657
658
/**
659
 * Function description
660
 *
661
 * @return 0 on success, otherwise a Win32 error code
662
 */
663
static UINT dvcman_close_channel_iface(IWTSVirtualChannel* pChannel)
664
0
{
665
0
  DVCMAN_CHANNEL* channel = (DVCMAN_CHANNEL*)pChannel;
666
667
0
  if (!channel)
668
0
    return CHANNEL_RC_BAD_CHANNEL;
669
670
0
  WLog_DBG(TAG, "close_channel_iface: id=%" PRIu32 "", channel->channel_id);
671
0
  return dvcman_channel_close(channel, FALSE, FALSE);
672
0
}
673
674
/**
675
 * Function description
676
 *
677
 * @return 0 on success, otherwise a Win32 error code
678
 */
679
static DVCMAN_CHANNEL* dvcman_create_channel(drdynvcPlugin* drdynvc,
680
                                             IWTSVirtualChannelManager* pChannelMgr,
681
                                             UINT32 ChannelId, const char* ChannelName, UINT* res)
682
0
{
683
0
  BOOL bAccept = 0;
684
0
  DVCMAN_CHANNEL* channel = NULL;
685
0
  DrdynvcClientContext* context = NULL;
686
0
  DVCMAN* dvcman = (DVCMAN*)pChannelMgr;
687
0
  DVCMAN_LISTENER* listener = NULL;
688
0
  IWTSVirtualChannelCallback* pCallback = NULL;
689
690
0
  WINPR_ASSERT(dvcman);
691
0
  WINPR_ASSERT(res);
692
693
0
  HashTable_Lock(dvcman->listeners);
694
0
  listener = (DVCMAN_LISTENER*)HashTable_GetItemValue(dvcman->listeners, ChannelName);
695
0
  if (!listener)
696
0
  {
697
0
    *res = ERROR_NOT_FOUND;
698
0
    goto out;
699
0
  }
700
701
0
  channel = dvcman_get_channel_by_id(pChannelMgr, ChannelId, FALSE);
702
0
  if (channel)
703
0
  {
704
0
    switch (channel->state)
705
0
    {
706
0
      case DVC_CHANNEL_RUNNING:
707
0
        WLog_Print(drdynvc->log, WLOG_ERROR,
708
0
                   "Protocol error: Duplicated ChannelId %" PRIu32 " (%s)!", ChannelId,
709
0
                   ChannelName);
710
0
        *res = CHANNEL_RC_ALREADY_OPEN;
711
0
        goto out;
712
713
0
      case DVC_CHANNEL_CLOSED:
714
0
      case DVC_CHANNEL_INIT:
715
0
      default:
716
0
      {
717
0
        WLog_Print(drdynvc->log, WLOG_ERROR, "not expecting a createChannel from state %s",
718
0
                   channel_state2str(channel->state));
719
0
        *res = CHANNEL_RC_INITIALIZATION_ERROR;
720
0
        goto out;
721
0
      }
722
0
    }
723
0
  }
724
0
  else
725
0
  {
726
0
    if (!(channel = dvcman_channel_new(drdynvc, pChannelMgr, ChannelId, ChannelName)))
727
0
    {
728
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_channel_new failed!");
729
0
      *res = CHANNEL_RC_NO_MEMORY;
730
0
      goto out;
731
0
    }
732
0
  }
733
734
0
  if (!HashTable_Insert(dvcman->channelsById, &channel->channel_id, channel))
735
0
  {
736
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "unable to register channel in our channel list");
737
0
    *res = ERROR_INTERNAL_ERROR;
738
0
    dvcman_channel_free(channel);
739
0
    channel = NULL;
740
0
    goto out;
741
0
  }
742
743
0
  channel->iface.Write = dvcman_write_channel;
744
0
  channel->iface.Close = dvcman_close_channel_iface;
745
0
  bAccept = TRUE;
746
747
0
  *res = listener->listener_callback->OnNewChannelConnection(
748
0
      listener->listener_callback, &channel->iface, NULL, &bAccept, &pCallback);
749
750
0
  if (*res != CHANNEL_RC_OK)
751
0
  {
752
0
    WLog_Print(drdynvc->log, WLOG_ERROR,
753
0
               "OnNewChannelConnection failed with error %" PRIu32 "!", *res);
754
0
    *res = ERROR_INTERNAL_ERROR;
755
0
    dvcman_channel_unref(channel);
756
0
    goto out;
757
0
  }
758
759
0
  if (!bAccept)
760
0
  {
761
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "OnNewChannelConnection returned with bAccept FALSE!");
762
0
    *res = ERROR_INTERNAL_ERROR;
763
0
    dvcman_channel_unref(channel);
764
0
    channel = NULL;
765
0
    goto out;
766
0
  }
767
768
0
  WLog_Print(drdynvc->log, WLOG_DEBUG, "listener %s created new channel %" PRIu32 "",
769
0
             listener->channel_name, channel->channel_id);
770
0
  channel->state = DVC_CHANNEL_RUNNING;
771
0
  channel->channel_callback = pCallback;
772
0
  channel->pInterface = listener->iface.pInterface;
773
0
  context = dvcman->drdynvc->context;
774
775
0
  IFCALLRET(context->OnChannelConnected, *res, context, ChannelName, listener->iface.pInterface);
776
0
  if (*res != CHANNEL_RC_OK)
777
0
  {
778
0
    WLog_Print(drdynvc->log, WLOG_ERROR,
779
0
               "context.OnChannelConnected failed with error %" PRIu32 "", *res);
780
0
  }
781
782
0
out:
783
0
  HashTable_Unlock(dvcman->listeners);
784
785
0
  return channel;
786
0
}
787
788
/**
789
 * Function description
790
 *
791
 * @return 0 on success, otherwise a Win32 error code
792
 */
793
static UINT dvcman_open_channel(drdynvcPlugin* drdynvc, DVCMAN_CHANNEL* channel)
794
0
{
795
0
  IWTSVirtualChannelCallback* pCallback = NULL;
796
0
  UINT error = CHANNEL_RC_OK;
797
798
0
  WINPR_ASSERT(drdynvc);
799
0
  WINPR_ASSERT(channel);
800
0
  if (channel->state == DVC_CHANNEL_RUNNING)
801
0
  {
802
0
    pCallback = channel->channel_callback;
803
804
0
    if (pCallback->OnOpen)
805
0
    {
806
0
      check_open_close_receive(channel);
807
0
      error = pCallback->OnOpen(pCallback);
808
0
      if (error)
809
0
      {
810
0
        WLog_Print(drdynvc->log, WLOG_ERROR, "OnOpen failed with error %" PRIu32 "!",
811
0
                   error);
812
0
        goto out;
813
0
      }
814
0
    }
815
816
0
    WLog_Print(drdynvc->log, WLOG_DEBUG, "open_channel: ChannelId %" PRIu32 "",
817
0
               channel->channel_id);
818
0
  }
819
820
0
out:
821
0
  return error;
822
0
}
823
824
/**
825
 * Function description
826
 *
827
 * @return 0 on success, otherwise a Win32 error code
828
 */
829
static UINT dvcman_receive_channel_data_first(DVCMAN_CHANNEL* channel, UINT32 length)
830
0
{
831
0
  WINPR_ASSERT(channel);
832
0
  WINPR_ASSERT(channel->dvcman);
833
0
  if (channel->dvc_data)
834
0
    Stream_Release(channel->dvc_data);
835
836
0
  channel->dvc_data = StreamPool_Take(channel->dvcman->pool, length);
837
838
0
  if (!channel->dvc_data)
839
0
  {
840
0
    drdynvcPlugin* drdynvc = channel->dvcman->drdynvc;
841
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
842
0
    return CHANNEL_RC_NO_MEMORY;
843
0
  }
844
845
0
  channel->dvc_data_length = length;
846
0
  return CHANNEL_RC_OK;
847
0
}
848
849
/**
850
 * Function description
851
 *
852
 * @return 0 on success, otherwise a Win32 error code
853
 */
854
static UINT dvcman_receive_channel_data(DVCMAN_CHANNEL* channel, wStream* data,
855
                                        WINPR_ATTR_UNUSED UINT32 ThreadingFlags)
856
0
{
857
0
  UINT status = CHANNEL_RC_OK;
858
0
  size_t dataSize = Stream_GetRemainingLength(data);
859
860
0
  WINPR_ASSERT(channel);
861
0
  WINPR_ASSERT(channel->dvcman);
862
0
  if (channel->dvc_data)
863
0
  {
864
0
    drdynvcPlugin* drdynvc = channel->dvcman->drdynvc;
865
866
    /* Fragmented data */
867
0
    if (Stream_GetPosition(channel->dvc_data) + dataSize > channel->dvc_data_length)
868
0
    {
869
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "data exceeding declared length!");
870
0
      Stream_Release(channel->dvc_data);
871
0
      channel->dvc_data = NULL;
872
0
      status = ERROR_INVALID_DATA;
873
0
      goto out;
874
0
    }
875
876
0
    Stream_Copy(data, channel->dvc_data, dataSize);
877
878
0
    if (Stream_GetPosition(channel->dvc_data) >= channel->dvc_data_length)
879
0
    {
880
0
      Stream_SealLength(channel->dvc_data);
881
0
      Stream_SetPosition(channel->dvc_data, 0);
882
883
0
      status = dvcman_call_on_receive(channel, channel->dvc_data);
884
0
      Stream_Release(channel->dvc_data);
885
0
      channel->dvc_data = NULL;
886
0
    }
887
0
  }
888
0
  else
889
0
    status = dvcman_call_on_receive(channel, data);
890
891
0
out:
892
0
  return status;
893
0
}
894
895
static UINT8 drdynvc_write_variable_uint(wStream* s, UINT32 val)
896
0
{
897
0
  UINT8 cb = 0;
898
899
0
  if (val <= 0xFF)
900
0
  {
901
0
    cb = 0;
902
0
    Stream_Write_UINT8(s, (UINT8)val);
903
0
  }
904
0
  else if (val <= 0xFFFF)
905
0
  {
906
0
    cb = 1;
907
0
    Stream_Write_UINT16(s, (UINT16)val);
908
0
  }
909
0
  else
910
0
  {
911
0
    cb = 2;
912
0
    Stream_Write_UINT32(s, val);
913
0
  }
914
915
0
  return cb;
916
0
}
917
918
/**
919
 * Function description
920
 *
921
 * @return 0 on success, otherwise a Win32 error code
922
 */
923
static UINT drdynvc_send(drdynvcPlugin* drdynvc, wStream* s)
924
0
{
925
0
  UINT status = 0;
926
927
0
  if (!drdynvc)
928
0
    status = CHANNEL_RC_BAD_CHANNEL_HANDLE;
929
0
  else
930
0
  {
931
0
    WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelWriteEx);
932
0
    status = drdynvc->channelEntryPoints.pVirtualChannelWriteEx(
933
0
        drdynvc->InitHandle, drdynvc->OpenHandle, Stream_Buffer(s),
934
0
        (UINT32)Stream_GetPosition(s), s);
935
0
  }
936
937
0
  switch (status)
938
0
  {
939
0
    case CHANNEL_RC_OK:
940
0
      return CHANNEL_RC_OK;
941
942
0
    case CHANNEL_RC_NOT_CONNECTED:
943
0
      Stream_Release(s);
944
0
      return CHANNEL_RC_OK;
945
946
0
    case CHANNEL_RC_BAD_CHANNEL_HANDLE:
947
0
      Stream_Release(s);
948
0
      WLog_ERR(TAG, "VirtualChannelWriteEx failed with CHANNEL_RC_BAD_CHANNEL_HANDLE");
949
0
      return status;
950
951
0
    default:
952
0
      Stream_Release(s);
953
0
      WLog_Print(drdynvc->log, WLOG_ERROR,
954
0
                 "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
955
0
                 WTSErrorToString(status), status);
956
0
      return status;
957
0
  }
958
0
}
959
960
/**
961
 * Function description
962
 *
963
 * @return 0 on success, otherwise a Win32 error code
964
 */
965
static UINT drdynvc_write_data(drdynvcPlugin* drdynvc, UINT32 ChannelId, const BYTE* data,
966
                               UINT32 dataSize, BOOL* close)
967
0
{
968
0
  wStream* data_out = NULL;
969
0
  size_t pos = 0;
970
0
  UINT8 cbChId = 0;
971
0
  UINT8 cbLen = 0;
972
0
  UINT status = CHANNEL_RC_BAD_INIT_HANDLE;
973
0
  DVCMAN* dvcman = NULL;
974
975
0
  if (!drdynvc)
976
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
977
978
0
  dvcman = (DVCMAN*)drdynvc->channel_mgr;
979
0
  WINPR_ASSERT(dvcman);
980
981
0
  WLog_Print(drdynvc->log, WLOG_TRACE, "write_data: ChannelId=%" PRIu32 " size=%" PRIu32 "",
982
0
             ChannelId, dataSize);
983
0
  data_out = StreamPool_Take(dvcman->pool, CHANNEL_CHUNK_LENGTH);
984
985
0
  if (!data_out)
986
0
  {
987
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
988
0
    return CHANNEL_RC_NO_MEMORY;
989
0
  }
990
991
0
  Stream_SetPosition(data_out, 1);
992
0
  cbChId = drdynvc_write_variable_uint(data_out, ChannelId);
993
0
  pos = Stream_GetPosition(data_out);
994
995
0
  if (dataSize == 0)
996
0
  {
997
    /* TODO: shall treat that case with write(0) that do a close */
998
0
    *close = TRUE;
999
0
    Stream_Release(data_out);
1000
0
  }
1001
0
  else if (dataSize <= CHANNEL_CHUNK_LENGTH - pos)
1002
0
  {
1003
0
    Stream_SetPosition(data_out, 0);
1004
0
    Stream_Write_UINT8(data_out, (DATA_PDU << 4) | cbChId);
1005
0
    Stream_SetPosition(data_out, pos);
1006
0
    Stream_Write(data_out, data, dataSize);
1007
0
    status = drdynvc_send(drdynvc, data_out);
1008
0
  }
1009
0
  else
1010
0
  {
1011
    /* Fragment the data */
1012
0
    cbLen = drdynvc_write_variable_uint(data_out, dataSize);
1013
0
    pos = Stream_GetPosition(data_out);
1014
0
    Stream_SetPosition(data_out, 0);
1015
1016
0
    const INT32 pdu = (DATA_FIRST_PDU << 4) | cbChId | (cbLen << 2);
1017
0
    Stream_Write_UINT8(data_out, WINPR_ASSERTING_INT_CAST(UINT8, pdu));
1018
0
    Stream_SetPosition(data_out, pos);
1019
1020
0
    {
1021
0
      WINPR_ASSERT(pos <= CHANNEL_CHUNK_LENGTH);
1022
0
      const uint32_t chunkLength =
1023
0
          CHANNEL_CHUNK_LENGTH - WINPR_ASSERTING_INT_CAST(uint32_t, pos);
1024
0
      Stream_Write(data_out, data, chunkLength);
1025
1026
0
      data += chunkLength;
1027
0
      dataSize -= chunkLength;
1028
0
    }
1029
0
    status = drdynvc_send(drdynvc, data_out);
1030
1031
0
    while (status == CHANNEL_RC_OK && dataSize > 0)
1032
0
    {
1033
0
      data_out = StreamPool_Take(dvcman->pool, CHANNEL_CHUNK_LENGTH);
1034
1035
0
      if (!data_out)
1036
0
      {
1037
0
        WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1038
0
        return CHANNEL_RC_NO_MEMORY;
1039
0
      }
1040
1041
0
      Stream_SetPosition(data_out, 1);
1042
0
      cbChId = drdynvc_write_variable_uint(data_out, ChannelId);
1043
0
      pos = Stream_GetPosition(data_out);
1044
0
      Stream_SetPosition(data_out, 0);
1045
0
      Stream_Write_UINT8(data_out, (DATA_PDU << 4) | cbChId);
1046
0
      Stream_SetPosition(data_out, pos);
1047
1048
0
      uint32_t chunkLength = dataSize;
1049
1050
0
      WINPR_ASSERT(pos <= CHANNEL_CHUNK_LENGTH);
1051
0
      if (chunkLength > CHANNEL_CHUNK_LENGTH - pos)
1052
0
        chunkLength = CHANNEL_CHUNK_LENGTH - WINPR_ASSERTING_INT_CAST(uint32_t, pos);
1053
1054
0
      Stream_Write(data_out, data, chunkLength);
1055
0
      data += chunkLength;
1056
0
      dataSize -= chunkLength;
1057
0
      status = drdynvc_send(drdynvc, data_out);
1058
0
    }
1059
0
  }
1060
1061
0
  if (status != CHANNEL_RC_OK)
1062
0
  {
1063
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1064
0
               WTSErrorToString(status), status);
1065
0
    return status;
1066
0
  }
1067
1068
0
  return CHANNEL_RC_OK;
1069
0
}
1070
1071
/**
1072
 * Function description
1073
 *
1074
 * @return 0 on success, otherwise a Win32 error code
1075
 */
1076
static UINT drdynvc_send_capability_response(drdynvcPlugin* drdynvc)
1077
0
{
1078
0
  UINT status = 0;
1079
0
  wStream* s = NULL;
1080
0
  DVCMAN* dvcman = NULL;
1081
1082
0
  if (!drdynvc)
1083
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1084
1085
0
  dvcman = (DVCMAN*)drdynvc->channel_mgr;
1086
0
  WINPR_ASSERT(dvcman);
1087
1088
0
  WLog_Print(drdynvc->log, WLOG_TRACE, "capability_response");
1089
0
  s = StreamPool_Take(dvcman->pool, 4);
1090
1091
0
  if (!s)
1092
0
  {
1093
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "Stream_Ndrdynvc_write_variable_uintew failed!");
1094
0
    return CHANNEL_RC_NO_MEMORY;
1095
0
  }
1096
1097
0
  Stream_Write_UINT16(s, 0x0050); /* Cmd+Sp+cbChId+Pad. Note: MSTSC sends 0x005c */
1098
0
  Stream_Write_UINT16(s, drdynvc->version);
1099
0
  status = drdynvc_send(drdynvc, s);
1100
1101
0
  if (status != CHANNEL_RC_OK)
1102
0
  {
1103
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1104
0
               WTSErrorToString(status), status);
1105
0
  }
1106
1107
0
  return status;
1108
0
}
1109
1110
/**
1111
 * Function description
1112
 *
1113
 * @return 0 on success, otherwise a Win32 error code
1114
 */
1115
static UINT drdynvc_process_capability_request(drdynvcPlugin* drdynvc, int Sp, int cbChId,
1116
                                               wStream* s)
1117
0
{
1118
0
  UINT status = 0;
1119
1120
0
  if (!drdynvc)
1121
0
    return CHANNEL_RC_BAD_INIT_HANDLE;
1122
1123
0
  if (!Stream_CheckAndLogRequiredLength(TAG, s, 3))
1124
0
    return ERROR_INVALID_DATA;
1125
1126
0
  WLog_Print(drdynvc->log, WLOG_TRACE, "capability_request Sp=%d cbChId=%d", Sp, cbChId);
1127
0
  Stream_Seek(s, 1); /* pad */
1128
0
  Stream_Read_UINT16(s, drdynvc->version);
1129
1130
  /* RDP8 servers offer version 3, though Microsoft forgot to document it
1131
   * in their early documents.  It behaves the same as version 2.
1132
   */
1133
0
  if ((drdynvc->version == 2) || (drdynvc->version == 3))
1134
0
  {
1135
0
    if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
1136
0
      return ERROR_INVALID_DATA;
1137
1138
0
    Stream_Read_UINT16(s, drdynvc->PriorityCharge0);
1139
0
    Stream_Read_UINT16(s, drdynvc->PriorityCharge1);
1140
0
    Stream_Read_UINT16(s, drdynvc->PriorityCharge2);
1141
0
    Stream_Read_UINT16(s, drdynvc->PriorityCharge3);
1142
0
  }
1143
1144
0
  status = drdynvc_send_capability_response(drdynvc);
1145
0
  drdynvc->state = DRDYNVC_STATE_READY;
1146
0
  return status;
1147
0
}
1148
1149
static UINT32 drdynvc_cblen_to_bytes(int cbLen)
1150
0
{
1151
0
  switch (cbLen)
1152
0
  {
1153
0
    case 0:
1154
0
      return 1;
1155
1156
0
    case 1:
1157
0
      return 2;
1158
1159
0
    default:
1160
0
      return 4;
1161
0
  }
1162
0
}
1163
1164
static UINT32 drdynvc_read_variable_uint(wStream* s, int cbLen)
1165
0
{
1166
0
  UINT32 val = 0;
1167
1168
0
  switch (cbLen)
1169
0
  {
1170
0
    case 0:
1171
0
      Stream_Read_UINT8(s, val);
1172
0
      break;
1173
1174
0
    case 1:
1175
0
      Stream_Read_UINT16(s, val);
1176
0
      break;
1177
1178
0
    default:
1179
0
      Stream_Read_UINT32(s, val);
1180
0
      break;
1181
0
  }
1182
1183
0
  return val;
1184
0
}
1185
1186
/**
1187
 * Function description
1188
 *
1189
 * @return 0 on success, otherwise a Win32 error code
1190
 */
1191
static UINT drdynvc_process_create_request(drdynvcPlugin* drdynvc, UINT8 Sp, UINT8 cbChId,
1192
                                           wStream* s)
1193
0
{
1194
0
  UINT status = 0;
1195
0
  wStream* data_out = NULL;
1196
0
  UINT channel_status = 0;
1197
0
  DVCMAN* dvcman = NULL;
1198
0
  DVCMAN_CHANNEL* channel = NULL;
1199
0
  INT32 retStatus = 0;
1200
1201
0
  WINPR_UNUSED(Sp);
1202
0
  if (!drdynvc)
1203
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1204
1205
0
  dvcman = (DVCMAN*)drdynvc->channel_mgr;
1206
0
  WINPR_ASSERT(dvcman);
1207
1208
0
  if (drdynvc->state == DRDYNVC_STATE_CAPABILITIES)
1209
0
  {
1210
    /**
1211
     * For some reason the server does not always send the
1212
     * capabilities pdu as it should. When this happens,
1213
     * send a capabilities response.
1214
     */
1215
0
    drdynvc->version = 3;
1216
1217
0
    if ((status = drdynvc_send_capability_response(drdynvc)))
1218
0
    {
1219
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "drdynvc_send_capability_response failed!");
1220
0
      return status;
1221
0
    }
1222
1223
0
    drdynvc->state = DRDYNVC_STATE_READY;
1224
0
  }
1225
1226
0
  if (!Stream_CheckAndLogRequiredLength(TAG, s, drdynvc_cblen_to_bytes(cbChId)))
1227
0
    return ERROR_INVALID_DATA;
1228
1229
0
  const UINT32 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1230
0
  const size_t pos = Stream_GetPosition(s);
1231
0
  const char* name = Stream_ConstPointer(s);
1232
0
  const size_t length = Stream_GetRemainingLength(s);
1233
1234
0
  if (strnlen(name, length) >= length)
1235
0
    return ERROR_INVALID_DATA;
1236
1237
0
  WLog_Print(drdynvc->log, WLOG_DEBUG,
1238
0
             "process_create_request: ChannelId=%" PRIu32 " ChannelName=%s", ChannelId, name);
1239
1240
0
  data_out = StreamPool_Take(dvcman->pool, pos + 4);
1241
0
  if (!data_out)
1242
0
  {
1243
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1244
0
    return CHANNEL_RC_NO_MEMORY;
1245
0
  }
1246
1247
0
  Stream_Write_UINT8(data_out, (CREATE_REQUEST_PDU << 4) | cbChId);
1248
0
  Stream_SetPosition(s, 1);
1249
0
  Stream_Copy(s, data_out, pos - 1);
1250
1251
0
  channel =
1252
0
      dvcman_create_channel(drdynvc, drdynvc->channel_mgr, ChannelId, name, &channel_status);
1253
0
  switch (channel_status)
1254
0
  {
1255
0
    case CHANNEL_RC_OK:
1256
0
      WLog_Print(drdynvc->log, WLOG_DEBUG, "channel created");
1257
0
      retStatus = 0;
1258
0
      break;
1259
0
    case CHANNEL_RC_NO_MEMORY:
1260
0
      WLog_Print(drdynvc->log, WLOG_DEBUG, "not enough memory for channel creation");
1261
0
      retStatus = STATUS_NO_MEMORY;
1262
0
      break;
1263
0
    case ERROR_NOT_FOUND:
1264
0
      WLog_Print(drdynvc->log, WLOG_DEBUG, "no listener for '%s'", name);
1265
0
      retStatus = STATUS_NOT_FOUND; /* same code used by mstsc, STATUS_UNSUCCESSFUL */
1266
0
      break;
1267
0
    default:
1268
0
      WLog_Print(drdynvc->log, WLOG_DEBUG, "channel creation error");
1269
0
      retStatus = STATUS_UNSUCCESSFUL; /* same code used by mstsc, STATUS_UNSUCCESSFUL */
1270
0
      break;
1271
0
  }
1272
0
  Stream_Write_INT32(data_out, retStatus);
1273
1274
0
  status = drdynvc_send(drdynvc, data_out);
1275
0
  if (status != CHANNEL_RC_OK)
1276
0
  {
1277
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1278
0
               WTSErrorToString(status), status);
1279
0
    dvcman_channel_unref(channel);
1280
0
    return status;
1281
0
  }
1282
1283
0
  if (channel_status == CHANNEL_RC_OK)
1284
0
  {
1285
0
    if ((status = dvcman_open_channel(drdynvc, channel)))
1286
0
    {
1287
0
      WLog_Print(drdynvc->log, WLOG_ERROR,
1288
0
                 "dvcman_open_channel failed with error %" PRIu32 "!", status);
1289
0
      return status;
1290
0
    }
1291
0
  }
1292
1293
0
  return status;
1294
0
}
1295
1296
/**
1297
 * Function description
1298
 *
1299
 * @return 0 on success, otherwise a Win32 error code
1300
 */
1301
static UINT drdynvc_process_data_first(drdynvcPlugin* drdynvc, int Sp, int cbChId, wStream* s,
1302
                                       BOOL compressed, UINT32 ThreadingFlags)
1303
0
{
1304
0
  WINPR_ASSERT(drdynvc);
1305
0
  if (!Stream_CheckAndLogRequiredLength(
1306
0
          TAG, s, drdynvc_cblen_to_bytes(cbChId) + drdynvc_cblen_to_bytes(Sp)))
1307
0
    return ERROR_INVALID_DATA;
1308
1309
0
  UINT32 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1310
0
  UINT32 Length = drdynvc_read_variable_uint(s, Sp);
1311
0
  WLog_Print(drdynvc->log, WLOG_TRACE,
1312
0
             "process_data_first: Sp=%d cbChId=%d, ChannelId=%" PRIu32 " Length=%" PRIu32 "", Sp,
1313
0
             cbChId, ChannelId, Length);
1314
1315
0
  DVCMAN_CHANNEL* channel = dvcman_get_channel_by_id(drdynvc->channel_mgr, ChannelId, TRUE);
1316
0
  if (!channel)
1317
0
  {
1318
    /**
1319
     * Windows Server 2012 R2 can send some messages over
1320
     * Microsoft::Windows::RDS::Geometry::v08.01 even if the dynamic virtual channel wasn't
1321
     * registered on our side. Ignoring it works.
1322
     */
1323
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "ChannelId %" PRIu32 " not found!", ChannelId);
1324
0
    return CHANNEL_RC_OK;
1325
0
  }
1326
1327
0
  UINT status = CHANNEL_RC_OK;
1328
0
  BOOL shouldFree = FALSE;
1329
0
  if (channel->state != DVC_CHANNEL_RUNNING)
1330
0
    goto out;
1331
1332
0
  if (compressed)
1333
0
  {
1334
0
    BYTE* data = NULL;
1335
0
    UINT32 dataSize = 0;
1336
0
    if (zgfx_decompress(channel->decompressor, Stream_Pointer(s),
1337
0
                        WINPR_ASSERTING_INT_CAST(UINT32, Stream_GetRemainingLength(s)), &data,
1338
0
                        &dataSize, 0) < 0)
1339
0
    {
1340
0
      status = ERROR_INVALID_DATA;
1341
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "error de-compressing first packet");
1342
0
      goto out;
1343
0
    }
1344
1345
0
    s = Stream_New(data, dataSize);
1346
0
    if (!s)
1347
0
    {
1348
0
      status = CHANNEL_RC_NO_MEMORY;
1349
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "error allocating new Stream(len=%" PRIu32 ")",
1350
0
                 dataSize);
1351
0
      free(data);
1352
0
      goto out;
1353
0
    }
1354
0
    shouldFree = TRUE;
1355
0
  }
1356
1357
0
  status = dvcman_receive_channel_data_first(channel, Length);
1358
1359
0
  if (status == CHANNEL_RC_OK)
1360
0
    status = dvcman_receive_channel_data(channel, s, ThreadingFlags);
1361
1362
0
  if (status != CHANNEL_RC_OK)
1363
0
    status = dvcman_channel_close(channel, FALSE, FALSE);
1364
1365
0
out:
1366
0
  if (shouldFree)
1367
0
    Stream_Free(s, TRUE);
1368
0
  dvcman_channel_unref(channel);
1369
0
  return status;
1370
0
}
1371
1372
/**
1373
 * Function description
1374
 *
1375
 * @return 0 on success, otherwise a Win32 error code
1376
 */
1377
static UINT drdynvc_process_data(drdynvcPlugin* drdynvc, int Sp, int cbChId, wStream* s,
1378
                                 BOOL compressed, UINT32 ThreadingFlags)
1379
0
{
1380
0
  WINPR_ASSERT(drdynvc);
1381
0
  if (!Stream_CheckAndLogRequiredLength(TAG, s, drdynvc_cblen_to_bytes(cbChId)))
1382
0
    return ERROR_INVALID_DATA;
1383
1384
0
  UINT32 ChannelId = drdynvc_read_variable_uint(s, cbChId);
1385
0
  WLog_Print(drdynvc->log, WLOG_TRACE, "process_data: Sp=%d cbChId=%d, ChannelId=%" PRIu32 "", Sp,
1386
0
             cbChId, ChannelId);
1387
1388
0
  DVCMAN_CHANNEL* channel = dvcman_get_channel_by_id(drdynvc->channel_mgr, ChannelId, TRUE);
1389
0
  if (!channel)
1390
0
  {
1391
    /**
1392
     * Windows Server 2012 R2 can send some messages over
1393
     * Microsoft::Windows::RDS::Geometry::v08.01 even if the dynamic virtual channel wasn't
1394
     * registered on our side. Ignoring it works.
1395
     */
1396
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "ChannelId %" PRIu32 " not found!", ChannelId);
1397
0
    return CHANNEL_RC_OK;
1398
0
  }
1399
1400
0
  BOOL shouldFree = FALSE;
1401
0
  UINT status = CHANNEL_RC_OK;
1402
0
  if (channel->state != DVC_CHANNEL_RUNNING)
1403
0
    goto out;
1404
1405
0
  if (compressed)
1406
0
  {
1407
0
    BYTE* data = NULL;
1408
0
    UINT32 dataSize = 0;
1409
1410
0
    if (zgfx_decompress(channel->decompressor, Stream_Pointer(s),
1411
0
                        WINPR_ASSERTING_INT_CAST(UINT32, Stream_GetRemainingLength(s)), &data,
1412
0
                        &dataSize, 0) < 0)
1413
0
    {
1414
0
      status = ERROR_INVALID_DATA;
1415
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "error de-compressing data packet");
1416
0
      goto out;
1417
0
    }
1418
1419
0
    s = Stream_New(data, dataSize);
1420
0
    if (!s)
1421
0
    {
1422
0
      status = CHANNEL_RC_NO_MEMORY;
1423
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "error allocating new Stream(len=%" PRIu32 ")",
1424
0
                 dataSize);
1425
0
      free(data);
1426
0
      goto out;
1427
0
    }
1428
0
    shouldFree = TRUE;
1429
0
  }
1430
1431
0
  status = dvcman_receive_channel_data(channel, s, ThreadingFlags);
1432
0
  if (status != CHANNEL_RC_OK)
1433
0
    status = dvcman_channel_close(channel, FALSE, FALSE);
1434
1435
0
out:
1436
0
  if (shouldFree)
1437
0
    Stream_Free(s, TRUE);
1438
0
  dvcman_channel_unref(channel);
1439
0
  return status;
1440
0
}
1441
1442
/**
1443
 * Function description
1444
 *
1445
 * @return 0 on success, otherwise a Win32 error code
1446
 */
1447
static UINT drdynvc_process_close_request(drdynvcPlugin* drdynvc, int Sp, int cbChId, wStream* s)
1448
0
{
1449
0
  UINT32 ChannelId = 0;
1450
0
  DVCMAN_CHANNEL* channel = NULL;
1451
1452
0
  WINPR_ASSERT(drdynvc);
1453
0
  if (!Stream_CheckAndLogRequiredLength(TAG, s, drdynvc_cblen_to_bytes(cbChId)))
1454
0
    return ERROR_INVALID_DATA;
1455
1456
0
  ChannelId = drdynvc_read_variable_uint(s, cbChId);
1457
0
  WLog_Print(drdynvc->log, WLOG_DEBUG,
1458
0
             "process_close_request: Sp=%d cbChId=%d, ChannelId=%" PRIu32 "", Sp, cbChId,
1459
0
             ChannelId);
1460
1461
0
  channel = dvcman_get_channel_by_id(drdynvc->channel_mgr, ChannelId, TRUE);
1462
0
  if (!channel)
1463
0
  {
1464
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_close_request channel %" PRIu32 " not present",
1465
0
               ChannelId);
1466
0
    return CHANNEL_RC_OK;
1467
0
  }
1468
1469
0
  dvcman_channel_close(channel, TRUE, FALSE);
1470
0
  dvcman_channel_unref(channel);
1471
0
  return CHANNEL_RC_OK;
1472
0
}
1473
1474
/**
1475
 * Function description
1476
 *
1477
 * @return 0 on success, otherwise a Win32 error code
1478
 */
1479
static UINT drdynvc_order_recv(drdynvcPlugin* drdynvc, wStream* s, UINT32 ThreadingFlags)
1480
0
{
1481
0
  WINPR_ASSERT(drdynvc);
1482
0
  if (!Stream_CheckAndLogRequiredLength(TAG, s, 1))
1483
0
    return ERROR_INVALID_DATA;
1484
1485
0
  UINT8 value = Stream_Get_UINT8(s);
1486
0
  const UINT8 Cmd = (value & 0xf0) >> 4;
1487
0
  const UINT8 Sp = (value & 0x0c) >> 2;
1488
0
  const UINT8 cbChId = (value & 0x03) >> 0;
1489
0
  WLog_Print(drdynvc->log, WLOG_TRACE, "order_recv: Cmd=%s, Sp=%" PRIu8 " cbChId=%" PRIu8,
1490
0
             drdynvc_get_packet_type(Cmd), Sp, cbChId);
1491
1492
0
  switch (Cmd)
1493
0
  {
1494
0
    case CAPABILITY_REQUEST_PDU:
1495
0
      return drdynvc_process_capability_request(drdynvc, Sp, cbChId, s);
1496
1497
0
    case CREATE_REQUEST_PDU:
1498
0
      return drdynvc_process_create_request(drdynvc, Sp, cbChId, s);
1499
1500
0
    case DATA_FIRST_PDU:
1501
0
    case DATA_FIRST_COMPRESSED_PDU:
1502
0
      return drdynvc_process_data_first(drdynvc, Sp, cbChId, s,
1503
0
                                        (Cmd == DATA_FIRST_COMPRESSED_PDU), ThreadingFlags);
1504
1505
0
    case DATA_PDU:
1506
0
    case DATA_COMPRESSED_PDU:
1507
0
      return drdynvc_process_data(drdynvc, Sp, cbChId, s, (Cmd == DATA_COMPRESSED_PDU),
1508
0
                                  ThreadingFlags);
1509
1510
0
    case CLOSE_REQUEST_PDU:
1511
0
      return drdynvc_process_close_request(drdynvc, Sp, cbChId, s);
1512
1513
0
    case SOFT_SYNC_RESPONSE_PDU:
1514
0
      WLog_Print(drdynvc->log, WLOG_ERROR,
1515
0
                 "not expecting a SOFT_SYNC_RESPONSE_PDU as a client");
1516
0
      return ERROR_INTERNAL_ERROR;
1517
1518
0
    default:
1519
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "unknown drdynvc cmd 0x%x", Cmd);
1520
0
      return ERROR_INTERNAL_ERROR;
1521
0
  }
1522
0
}
1523
1524
/**
1525
 * Function description
1526
 *
1527
 * @return 0 on success, otherwise a Win32 error code
1528
 */
1529
static UINT drdynvc_virtual_channel_event_data_received(drdynvcPlugin* drdynvc, void* pData,
1530
                                                        UINT32 dataLength, UINT32 totalLength,
1531
                                                        UINT32 dataFlags)
1532
0
{
1533
0
  wStream* data_in = NULL;
1534
1535
0
  WINPR_ASSERT(drdynvc);
1536
0
  if ((dataFlags & CHANNEL_FLAG_SUSPEND) || (dataFlags & CHANNEL_FLAG_RESUME))
1537
0
  {
1538
0
    return CHANNEL_RC_OK;
1539
0
  }
1540
1541
0
  if (dataFlags & CHANNEL_FLAG_FIRST)
1542
0
  {
1543
0
    DVCMAN* mgr = (DVCMAN*)drdynvc->channel_mgr;
1544
0
    if (drdynvc->data_in)
1545
0
      Stream_Release(drdynvc->data_in);
1546
1547
0
    drdynvc->data_in = StreamPool_Take(mgr->pool, totalLength);
1548
0
  }
1549
1550
0
  if (!(data_in = drdynvc->data_in))
1551
0
  {
1552
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "StreamPool_Take failed!");
1553
0
    return CHANNEL_RC_NO_MEMORY;
1554
0
  }
1555
1556
0
  if (!Stream_EnsureRemainingCapacity(data_in, dataLength))
1557
0
  {
1558
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "Stream_EnsureRemainingCapacity failed!");
1559
0
    Stream_Release(drdynvc->data_in);
1560
0
    drdynvc->data_in = NULL;
1561
0
    return ERROR_INTERNAL_ERROR;
1562
0
  }
1563
1564
0
  Stream_Write(data_in, pData, dataLength);
1565
1566
0
  if (dataFlags & CHANNEL_FLAG_LAST)
1567
0
  {
1568
0
    const size_t cap = Stream_Capacity(data_in);
1569
0
    const size_t pos = Stream_GetPosition(data_in);
1570
0
    if (cap < pos)
1571
0
    {
1572
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "drdynvc_plugin_process_received: read error");
1573
0
      return ERROR_INVALID_DATA;
1574
0
    }
1575
1576
0
    drdynvc->data_in = NULL;
1577
0
    Stream_SealLength(data_in);
1578
0
    Stream_SetPosition(data_in, 0);
1579
1580
0
    if (drdynvc->async)
1581
0
    {
1582
0
      if (!MessageQueue_Post(drdynvc->queue, NULL, 0, (void*)data_in, NULL))
1583
0
      {
1584
0
        WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_Post failed!");
1585
0
        return ERROR_INTERNAL_ERROR;
1586
0
      }
1587
0
    }
1588
0
    else
1589
0
    {
1590
0
      UINT error = drdynvc_order_recv(drdynvc, data_in, TRUE);
1591
0
      Stream_Release(data_in);
1592
1593
0
      if (error)
1594
0
      {
1595
0
        WLog_Print(drdynvc->log, WLOG_WARN,
1596
0
                   "drdynvc_order_recv failed with error %" PRIu32 "!", error);
1597
0
      }
1598
0
    }
1599
0
  }
1600
1601
0
  return CHANNEL_RC_OK;
1602
0
}
1603
1604
static void VCAPITYPE drdynvc_virtual_channel_open_event_ex(LPVOID lpUserParam, DWORD openHandle,
1605
                                                            UINT event, LPVOID pData,
1606
                                                            UINT32 dataLength, UINT32 totalLength,
1607
                                                            UINT32 dataFlags)
1608
0
{
1609
0
  UINT error = CHANNEL_RC_OK;
1610
0
  drdynvcPlugin* drdynvc = (drdynvcPlugin*)lpUserParam;
1611
1612
0
  WINPR_ASSERT(drdynvc);
1613
0
  switch (event)
1614
0
  {
1615
0
    case CHANNEL_EVENT_DATA_RECEIVED:
1616
0
      if (!drdynvc || (drdynvc->OpenHandle != openHandle))
1617
0
      {
1618
0
        WLog_ERR(TAG, "drdynvc_virtual_channel_open_event: error no match");
1619
0
        return;
1620
0
      }
1621
0
      if ((error = drdynvc_virtual_channel_event_data_received(drdynvc, pData, dataLength,
1622
0
                                                               totalLength, dataFlags)))
1623
0
        WLog_Print(drdynvc->log, WLOG_ERROR,
1624
0
                   "drdynvc_virtual_channel_event_data_received failed with error %" PRIu32
1625
0
                   "",
1626
0
                   error);
1627
1628
0
      break;
1629
1630
0
    case CHANNEL_EVENT_WRITE_CANCELLED:
1631
0
    case CHANNEL_EVENT_WRITE_COMPLETE:
1632
0
    {
1633
0
      wStream* s = (wStream*)pData;
1634
0
      Stream_Release(s);
1635
0
    }
1636
0
    break;
1637
1638
0
    case CHANNEL_EVENT_USER:
1639
0
      break;
1640
0
    default:
1641
0
      break;
1642
0
  }
1643
1644
0
  if (error && drdynvc && drdynvc->rdpcontext)
1645
0
    setChannelError(drdynvc->rdpcontext, error,
1646
0
                    "drdynvc_virtual_channel_open_event reported an error");
1647
0
}
1648
1649
static DWORD WINAPI drdynvc_virtual_channel_client_thread(LPVOID arg)
1650
0
{
1651
  /* TODO: rewrite this */
1652
0
  wStream* data = NULL;
1653
0
  wMessage message = { 0 };
1654
0
  UINT error = CHANNEL_RC_OK;
1655
0
  drdynvcPlugin* drdynvc = (drdynvcPlugin*)arg;
1656
1657
0
  if (!drdynvc)
1658
0
  {
1659
0
    ExitThread((DWORD)CHANNEL_RC_BAD_CHANNEL_HANDLE);
1660
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1661
0
  }
1662
1663
0
  while (1)
1664
0
  {
1665
0
    if (!MessageQueue_Wait(drdynvc->queue))
1666
0
    {
1667
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_Wait failed!");
1668
0
      error = ERROR_INTERNAL_ERROR;
1669
0
      break;
1670
0
    }
1671
1672
0
    if (!MessageQueue_Peek(drdynvc->queue, &message, TRUE))
1673
0
    {
1674
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_Peek failed!");
1675
0
      error = ERROR_INTERNAL_ERROR;
1676
0
      break;
1677
0
    }
1678
1679
0
    if (message.id == WMQ_QUIT)
1680
0
      break;
1681
1682
0
    if (message.id == 0)
1683
0
    {
1684
0
      UINT32 ThreadingFlags = TRUE;
1685
0
      data = (wStream*)message.wParam;
1686
1687
0
      if ((error = drdynvc_order_recv(drdynvc, data, ThreadingFlags)))
1688
0
      {
1689
0
        WLog_Print(drdynvc->log, WLOG_WARN,
1690
0
                   "drdynvc_order_recv failed with error %" PRIu32 "!", error);
1691
0
      }
1692
1693
0
      Stream_Release(data);
1694
0
    }
1695
0
  }
1696
1697
0
  {
1698
    /* Disconnect remaining dynamic channels that the server did not.
1699
     * This is required to properly shut down channels by calling the appropriate
1700
     * event handlers. */
1701
0
    DVCMAN* drdynvcMgr = (DVCMAN*)drdynvc->channel_mgr;
1702
1703
0
    HashTable_Clear(drdynvcMgr->channelsById);
1704
0
  }
1705
1706
0
  if (error && drdynvc->rdpcontext)
1707
0
    setChannelError(drdynvc->rdpcontext, error,
1708
0
                    "drdynvc_virtual_channel_client_thread reported an error");
1709
1710
0
  ExitThread((DWORD)error);
1711
0
  return error;
1712
0
}
1713
1714
static void drdynvc_queue_object_free(void* obj)
1715
0
{
1716
0
  wStream* s = NULL;
1717
0
  wMessage* msg = (wMessage*)obj;
1718
1719
0
  if (!msg || (msg->id != 0))
1720
0
    return;
1721
1722
0
  s = (wStream*)msg->wParam;
1723
1724
0
  if (s)
1725
0
    Stream_Release(s);
1726
0
}
1727
1728
static UINT drdynvc_virtual_channel_event_initialized(drdynvcPlugin* drdynvc, LPVOID pData,
1729
                                                      UINT32 dataLength)
1730
0
{
1731
0
  wObject* obj = NULL;
1732
0
  WINPR_UNUSED(pData);
1733
0
  WINPR_UNUSED(dataLength);
1734
1735
0
  if (!drdynvc)
1736
0
    goto error;
1737
1738
0
  drdynvc->queue = MessageQueue_New(NULL);
1739
1740
0
  if (!drdynvc->queue)
1741
0
  {
1742
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "MessageQueue_New failed!");
1743
0
    goto error;
1744
0
  }
1745
1746
0
  obj = MessageQueue_Object(drdynvc->queue);
1747
0
  obj->fnObjectFree = drdynvc_queue_object_free;
1748
0
  drdynvc->channel_mgr = dvcman_new(drdynvc);
1749
1750
0
  if (!drdynvc->channel_mgr)
1751
0
  {
1752
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_new failed!");
1753
0
    goto error;
1754
0
  }
1755
1756
0
  return CHANNEL_RC_OK;
1757
0
error:
1758
0
  return ERROR_INTERNAL_ERROR;
1759
0
}
1760
1761
/**
1762
 * Function description
1763
 *
1764
 * @return 0 on success, otherwise a Win32 error code
1765
 */
1766
static UINT drdynvc_virtual_channel_event_connected(drdynvcPlugin* drdynvc, LPVOID pData,
1767
                                                    UINT32 dataLength)
1768
0
{
1769
0
  UINT error = 0;
1770
0
  UINT32 status = 0;
1771
0
  rdpSettings* settings = NULL;
1772
1773
0
  WINPR_ASSERT(drdynvc);
1774
0
  WINPR_UNUSED(pData);
1775
0
  WINPR_UNUSED(dataLength);
1776
1777
0
  if (!drdynvc)
1778
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1779
1780
0
  WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelOpenEx);
1781
0
  status = drdynvc->channelEntryPoints.pVirtualChannelOpenEx(
1782
0
      drdynvc->InitHandle, &drdynvc->OpenHandle, drdynvc->channelDef.name,
1783
0
      drdynvc_virtual_channel_open_event_ex);
1784
1785
0
  if (status != CHANNEL_RC_OK)
1786
0
  {
1787
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "pVirtualChannelOpen failed with %s [%08" PRIX32 "]",
1788
0
               WTSErrorToString(status), status);
1789
0
    return status;
1790
0
  }
1791
1792
0
  WINPR_ASSERT(drdynvc->rdpcontext);
1793
0
  settings = drdynvc->rdpcontext->settings;
1794
0
  WINPR_ASSERT(settings);
1795
1796
0
  for (UINT32 index = 0;
1797
0
       index < freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelCount); index++)
1798
0
  {
1799
0
    const ADDIN_ARGV* args =
1800
0
        freerdp_settings_get_pointer_array(settings, FreeRDP_DynamicChannelArray, index);
1801
0
    error = dvcman_load_addin(drdynvc, drdynvc->channel_mgr, args, drdynvc->rdpcontext);
1802
1803
0
    if (CHANNEL_RC_OK != error)
1804
0
      goto error;
1805
0
  }
1806
1807
0
  if ((error = dvcman_init(drdynvc, drdynvc->channel_mgr)))
1808
0
  {
1809
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "dvcman_init failed with error %" PRIu32 "!", error);
1810
0
    goto error;
1811
0
  }
1812
1813
0
  drdynvc->state = DRDYNVC_STATE_CAPABILITIES;
1814
1815
0
  if (drdynvc->async)
1816
0
  {
1817
0
    if (!(drdynvc->thread = CreateThread(NULL, 0, drdynvc_virtual_channel_client_thread,
1818
0
                                         (void*)drdynvc, 0, NULL)))
1819
0
    {
1820
0
      error = ERROR_INTERNAL_ERROR;
1821
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "CreateThread failed!");
1822
0
      goto error;
1823
0
    }
1824
1825
0
    if (!SetThreadPriority(drdynvc->thread, THREAD_PRIORITY_HIGHEST))
1826
0
      WLog_Print(drdynvc->log, WLOG_WARN, "SetThreadPriority failed, ignoring.");
1827
0
  }
1828
1829
0
error:
1830
0
  return error;
1831
0
}
1832
1833
/**
1834
 * Function description
1835
 *
1836
 * @return 0 on success, otherwise a Win32 error code
1837
 */
1838
static UINT drdynvc_virtual_channel_event_disconnected(drdynvcPlugin* drdynvc)
1839
0
{
1840
0
  UINT status = 0;
1841
1842
0
  if (!drdynvc)
1843
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1844
1845
0
  if (drdynvc->OpenHandle == 0)
1846
0
    return CHANNEL_RC_OK;
1847
1848
0
  if (drdynvc->queue)
1849
0
  {
1850
0
    if (!MessageQueue_PostQuit(drdynvc->queue, 0))
1851
0
    {
1852
0
      status = GetLastError();
1853
0
      WLog_Print(drdynvc->log, WLOG_ERROR,
1854
0
                 "MessageQueue_PostQuit failed with error %" PRIu32 "", status);
1855
0
      return status;
1856
0
    }
1857
0
  }
1858
1859
0
  if (drdynvc->thread)
1860
0
  {
1861
0
    if (WaitForSingleObject(drdynvc->thread, INFINITE) != WAIT_OBJECT_0)
1862
0
    {
1863
0
      status = GetLastError();
1864
0
      WLog_Print(drdynvc->log, WLOG_ERROR,
1865
0
                 "WaitForSingleObject failed with error %" PRIu32 "", status);
1866
0
      return status;
1867
0
    }
1868
1869
0
    (void)CloseHandle(drdynvc->thread);
1870
0
    drdynvc->thread = NULL;
1871
0
  }
1872
0
  else
1873
0
  {
1874
0
    {
1875
      /* Disconnect remaining dynamic channels that the server did not.
1876
       * This is required to properly shut down channels by calling the appropriate
1877
       * event handlers. */
1878
0
      DVCMAN* drdynvcMgr = (DVCMAN*)drdynvc->channel_mgr;
1879
1880
0
      HashTable_Clear(drdynvcMgr->channelsById);
1881
0
    }
1882
0
  }
1883
1884
0
  WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelCloseEx);
1885
0
  status = drdynvc->channelEntryPoints.pVirtualChannelCloseEx(drdynvc->InitHandle,
1886
0
                                                              drdynvc->OpenHandle);
1887
1888
0
  if (status != CHANNEL_RC_OK)
1889
0
  {
1890
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "pVirtualChannelClose failed with %s [%08" PRIX32 "]",
1891
0
               WTSErrorToString(status), status);
1892
0
  }
1893
1894
0
  dvcman_clear(drdynvc, drdynvc->channel_mgr);
1895
0
  if (drdynvc->queue)
1896
0
    MessageQueue_Clear(drdynvc->queue);
1897
0
  drdynvc->OpenHandle = 0;
1898
1899
0
  if (drdynvc->data_in)
1900
0
  {
1901
0
    Stream_Release(drdynvc->data_in);
1902
0
    drdynvc->data_in = NULL;
1903
0
  }
1904
1905
0
  return status;
1906
0
}
1907
1908
/**
1909
 * Function description
1910
 *
1911
 * @return 0 on success, otherwise a Win32 error code
1912
 */
1913
static UINT drdynvc_virtual_channel_event_terminated(drdynvcPlugin* drdynvc)
1914
0
{
1915
0
  if (!drdynvc)
1916
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1917
1918
0
  MessageQueue_Free(drdynvc->queue);
1919
0
  drdynvc->queue = NULL;
1920
1921
0
  if (drdynvc->channel_mgr)
1922
0
  {
1923
0
    dvcman_free(drdynvc, drdynvc->channel_mgr);
1924
0
    drdynvc->channel_mgr = NULL;
1925
0
  }
1926
0
  drdynvc->InitHandle = 0;
1927
0
  free(drdynvc->context);
1928
0
  free(drdynvc);
1929
0
  return CHANNEL_RC_OK;
1930
0
}
1931
1932
static UINT drdynvc_virtual_channel_event_attached(drdynvcPlugin* drdynvc)
1933
0
{
1934
0
  UINT error = CHANNEL_RC_OK;
1935
0
  DVCMAN* dvcman = NULL;
1936
1937
0
  if (!drdynvc)
1938
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1939
1940
0
  dvcman = (DVCMAN*)drdynvc->channel_mgr;
1941
1942
0
  if (!dvcman)
1943
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1944
1945
0
  ArrayList_Lock(dvcman->plugins);
1946
0
  for (size_t i = 0; i < ArrayList_Count(dvcman->plugins); i++)
1947
0
  {
1948
0
    IWTSPlugin* pPlugin = ArrayList_GetItem(dvcman->plugins, i);
1949
1950
0
    error = IFCALLRESULT(CHANNEL_RC_OK, pPlugin->Attached, pPlugin);
1951
0
    if (error != CHANNEL_RC_OK)
1952
0
    {
1953
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "Attach failed with error %" PRIu32 "!", error);
1954
0
      goto fail;
1955
0
    }
1956
0
  }
1957
1958
0
fail:
1959
0
  ArrayList_Unlock(dvcman->plugins);
1960
0
  return error;
1961
0
}
1962
1963
static UINT drdynvc_virtual_channel_event_detached(drdynvcPlugin* drdynvc)
1964
0
{
1965
0
  UINT error = CHANNEL_RC_OK;
1966
0
  DVCMAN* dvcman = NULL;
1967
1968
0
  if (!drdynvc)
1969
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1970
1971
0
  dvcman = (DVCMAN*)drdynvc->channel_mgr;
1972
1973
0
  if (!dvcman)
1974
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1975
1976
0
  ArrayList_Lock(dvcman->plugins);
1977
0
  for (size_t i = 0; i < ArrayList_Count(dvcman->plugins); i++)
1978
0
  {
1979
0
    IWTSPlugin* pPlugin = ArrayList_GetItem(dvcman->plugins, i);
1980
1981
0
    error = IFCALLRESULT(CHANNEL_RC_OK, pPlugin->Detached, pPlugin);
1982
0
    if (error != CHANNEL_RC_OK)
1983
0
    {
1984
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "Detach failed with error %" PRIu32 "!", error);
1985
0
      goto fail;
1986
0
    }
1987
0
  }
1988
1989
0
fail:
1990
0
  ArrayList_Unlock(dvcman->plugins);
1991
1992
0
  return error;
1993
0
}
1994
1995
static VOID VCAPITYPE drdynvc_virtual_channel_init_event_ex(LPVOID lpUserParam, LPVOID pInitHandle,
1996
                                                            UINT event, LPVOID pData,
1997
                                                            UINT dataLength)
1998
0
{
1999
0
  UINT error = CHANNEL_RC_OK;
2000
0
  drdynvcPlugin* drdynvc = (drdynvcPlugin*)lpUserParam;
2001
2002
0
  if (!drdynvc || (drdynvc->InitHandle != pInitHandle))
2003
0
  {
2004
0
    WLog_ERR(TAG, "drdynvc_virtual_channel_init_event: error no match");
2005
0
    return;
2006
0
  }
2007
2008
0
  switch (event)
2009
0
  {
2010
0
    case CHANNEL_EVENT_INITIALIZED:
2011
0
      error = drdynvc_virtual_channel_event_initialized(drdynvc, pData, dataLength);
2012
0
      break;
2013
0
    case CHANNEL_EVENT_CONNECTED:
2014
0
      if ((error = drdynvc_virtual_channel_event_connected(drdynvc, pData, dataLength)))
2015
0
        WLog_Print(drdynvc->log, WLOG_ERROR,
2016
0
                   "drdynvc_virtual_channel_event_connected failed with error %" PRIu32 "",
2017
0
                   error);
2018
2019
0
      break;
2020
2021
0
    case CHANNEL_EVENT_DISCONNECTED:
2022
0
      if ((error = drdynvc_virtual_channel_event_disconnected(drdynvc)))
2023
0
        WLog_Print(drdynvc->log, WLOG_ERROR,
2024
0
                   "drdynvc_virtual_channel_event_disconnected failed with error %" PRIu32
2025
0
                   "",
2026
0
                   error);
2027
2028
0
      break;
2029
2030
0
    case CHANNEL_EVENT_TERMINATED:
2031
0
      if ((error = drdynvc_virtual_channel_event_terminated(drdynvc)))
2032
0
        WLog_Print(drdynvc->log, WLOG_ERROR,
2033
0
                   "drdynvc_virtual_channel_event_terminated failed with error %" PRIu32 "",
2034
0
                   error);
2035
2036
0
      break;
2037
2038
0
    case CHANNEL_EVENT_ATTACHED:
2039
0
      if ((error = drdynvc_virtual_channel_event_attached(drdynvc)))
2040
0
        WLog_Print(drdynvc->log, WLOG_ERROR,
2041
0
                   "drdynvc_virtual_channel_event_attached failed with error %" PRIu32 "",
2042
0
                   error);
2043
2044
0
      break;
2045
2046
0
    case CHANNEL_EVENT_DETACHED:
2047
0
      if ((error = drdynvc_virtual_channel_event_detached(drdynvc)))
2048
0
        WLog_Print(drdynvc->log, WLOG_ERROR,
2049
0
                   "drdynvc_virtual_channel_event_detached failed with error %" PRIu32 "",
2050
0
                   error);
2051
2052
0
      break;
2053
2054
0
    default:
2055
0
      break;
2056
0
  }
2057
2058
0
  if (error && drdynvc->rdpcontext)
2059
0
    setChannelError(drdynvc->rdpcontext, error,
2060
0
                    "drdynvc_virtual_channel_init_event_ex reported an error");
2061
0
}
2062
2063
/**
2064
 * Channel Client Interface
2065
 */
2066
2067
static int drdynvc_get_version(DrdynvcClientContext* context)
2068
0
{
2069
0
  WINPR_ASSERT(context);
2070
0
  drdynvcPlugin* drdynvc = (drdynvcPlugin*)context->handle;
2071
0
  WINPR_ASSERT(drdynvc);
2072
0
  return drdynvc->version;
2073
0
}
2074
2075
/* drdynvc is always built-in */
2076
#define VirtualChannelEntryEx drdynvc_VirtualChannelEntryEx
2077
2078
FREERDP_ENTRY_POINT(BOOL VCAPITYPE VirtualChannelEntryEx(PCHANNEL_ENTRY_POINTS_EX pEntryPoints,
2079
                                                         PVOID pInitHandle))
2080
0
{
2081
0
  UINT rc = 0;
2082
0
  drdynvcPlugin* drdynvc = NULL;
2083
0
  DrdynvcClientContext* context = NULL;
2084
0
  CHANNEL_ENTRY_POINTS_FREERDP_EX* pEntryPointsEx = NULL;
2085
0
  drdynvc = (drdynvcPlugin*)calloc(1, sizeof(drdynvcPlugin));
2086
2087
0
  WINPR_ASSERT(pEntryPoints);
2088
0
  if (!drdynvc)
2089
0
  {
2090
0
    WLog_ERR(TAG, "calloc failed!");
2091
0
    return FALSE;
2092
0
  }
2093
2094
0
  drdynvc->channelDef.options =
2095
0
      CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP | CHANNEL_OPTION_COMPRESS_RDP;
2096
0
  (void)sprintf_s(drdynvc->channelDef.name, ARRAYSIZE(drdynvc->channelDef.name),
2097
0
                  DRDYNVC_SVC_CHANNEL_NAME);
2098
0
  drdynvc->state = DRDYNVC_STATE_INITIAL;
2099
0
  pEntryPointsEx = (CHANNEL_ENTRY_POINTS_FREERDP_EX*)pEntryPoints;
2100
2101
0
  if ((pEntryPointsEx->cbSize >= sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX)) &&
2102
0
      (pEntryPointsEx->MagicNumber == FREERDP_CHANNEL_MAGIC_NUMBER))
2103
0
  {
2104
0
    context = (DrdynvcClientContext*)calloc(1, sizeof(DrdynvcClientContext));
2105
2106
0
    if (!context)
2107
0
    {
2108
0
      WLog_Print(drdynvc->log, WLOG_ERROR, "calloc failed!");
2109
0
      free(drdynvc);
2110
0
      return FALSE;
2111
0
    }
2112
2113
0
    context->handle = (void*)drdynvc;
2114
0
    context->custom = NULL;
2115
0
    drdynvc->context = context;
2116
0
    context->GetVersion = drdynvc_get_version;
2117
0
    drdynvc->rdpcontext = pEntryPointsEx->context;
2118
0
    if (!freerdp_settings_get_bool(drdynvc->rdpcontext->settings,
2119
0
                                   FreeRDP_TransportDumpReplay) &&
2120
0
        !freerdp_settings_get_bool(drdynvc->rdpcontext->settings,
2121
0
                                   FreeRDP_SynchronousDynamicChannels))
2122
0
      drdynvc->async = TRUE;
2123
0
  }
2124
2125
0
  drdynvc->log = WLog_Get(TAG);
2126
0
  WLog_Print(drdynvc->log, WLOG_DEBUG, "VirtualChannelEntryEx");
2127
0
  CopyMemory(&(drdynvc->channelEntryPoints), pEntryPoints,
2128
0
             sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX));
2129
0
  drdynvc->InitHandle = pInitHandle;
2130
2131
0
  WINPR_ASSERT(drdynvc->channelEntryPoints.pVirtualChannelInitEx);
2132
0
  rc = drdynvc->channelEntryPoints.pVirtualChannelInitEx(
2133
0
      drdynvc, context, pInitHandle, &drdynvc->channelDef, 1, VIRTUAL_CHANNEL_VERSION_WIN2000,
2134
0
      drdynvc_virtual_channel_init_event_ex);
2135
2136
0
  if (CHANNEL_RC_OK != rc)
2137
0
  {
2138
0
    WLog_Print(drdynvc->log, WLOG_ERROR, "pVirtualChannelInit failed with %s [%08" PRIX32 "]",
2139
0
               WTSErrorToString(rc), rc);
2140
0
    free(drdynvc->context);
2141
0
    free(drdynvc);
2142
0
    return FALSE;
2143
0
  }
2144
2145
0
  drdynvc->channelEntryPoints.pInterface = context;
2146
  return TRUE;
2147
0
}