Coverage Report

Created: 2026-01-17 07:16

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