Coverage Report

Created: 2025-07-01 06:46

/src/FreeRDP/libfreerdp/core/client.c
Line
Count
Source (jump to first uncovered line)
1
/**
2
 * FreeRDP: A Remote Desktop Protocol Implementation
3
 * Client Channels
4
 *
5
 * Copyright 2014 Marc-Andre Moreau <marcandre.moreau@gmail.com>
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 "settings.h"
25
26
#include <winpr/assert.h>
27
28
#include <freerdp/log.h>
29
#include <freerdp/channels/drdynvc.h>
30
31
#include "rdp.h"
32
#include "client.h"
33
34
#define TAG FREERDP_TAG("core.client")
35
36
typedef struct
37
{
38
  freerdp_channel_handle_fkt_t fkt;
39
  void* userdata;
40
} ChannelEventEntry;
41
42
/* Use this instance to get access to channels in VirtualChannelInit. It is set during
43
 * freerdp_connect so channels that use VirtualChannelInit must be initialized from the same thread
44
 * as freerdp_connect was called */
45
static WINPR_TLS freerdp* g_Instance = NULL;
46
47
/* use global counter to ensure uniqueness across channel manager instances */
48
static volatile LONG g_OpenHandleSeq = 1;
49
50
/* HashTable mapping channel handles to CHANNEL_OPEN_DATA */
51
static INIT_ONCE g_ChannelHandlesOnce = INIT_ONCE_STATIC_INIT;
52
static wHashTable* g_ChannelHandles = NULL;
53
54
static BOOL freerdp_channels_process_message_free(wMessage* message, DWORD type);
55
56
static CHANNEL_OPEN_DATA* freerdp_channels_find_channel_open_data_by_name(rdpChannels* channels,
57
                                                                          const char* name)
58
0
{
59
0
  for (int index = 0; index < channels->openDataCount; index++)
60
0
  {
61
0
    CHANNEL_OPEN_DATA* pChannelOpenData = &channels->openDataList[index];
62
63
0
    if (strncmp(name, pChannelOpenData->name, CHANNEL_NAME_LEN + 1) == 0)
64
0
      return pChannelOpenData;
65
0
  }
66
67
0
  return NULL;
68
0
}
69
70
/* returns rdpChannel for the channel name passed in */
71
static rdpMcsChannel* freerdp_channels_find_channel_by_name(rdpRdp* rdp, const char* name)
72
0
{
73
0
  rdpMcs* mcs = NULL;
74
75
0
  if (!rdp)
76
0
    return NULL;
77
78
0
  mcs = rdp->mcs;
79
80
0
  for (UINT32 index = 0; index < mcs->channelCount; index++)
81
0
  {
82
0
    rdpMcsChannel* channel = &mcs->channels[index];
83
84
0
    if (strncmp(name, channel->Name, CHANNEL_NAME_LEN + 1) == 0)
85
0
    {
86
0
      return channel;
87
0
    }
88
0
  }
89
90
0
  return NULL;
91
0
}
92
93
static rdpMcsChannel* freerdp_channels_find_channel_by_id(rdpRdp* rdp, UINT16 channel_id)
94
0
{
95
0
  rdpMcsChannel* channel = NULL;
96
0
  rdpMcs* mcs = NULL;
97
98
0
  if (!rdp)
99
0
    return NULL;
100
101
0
  mcs = rdp->mcs;
102
103
0
  for (UINT32 index = 0; index < mcs->channelCount; index++)
104
0
  {
105
0
    channel = &mcs->channels[index];
106
107
0
    if (channel->ChannelId == channel_id)
108
0
    {
109
0
      return channel;
110
0
    }
111
0
  }
112
113
0
  return NULL;
114
0
}
115
116
static void channel_queue_message_free(wMessage* msg)
117
0
{
118
0
  CHANNEL_OPEN_EVENT* ev = NULL;
119
120
0
  if (!msg || (msg->id != 0))
121
0
    return;
122
123
0
  ev = (CHANNEL_OPEN_EVENT*)msg->wParam;
124
0
  free(ev);
125
0
}
126
127
static void channel_queue_free(void* obj)
128
0
{
129
0
  wMessage* msg = (wMessage*)obj;
130
0
  freerdp_channels_process_message_free(msg, CHANNEL_EVENT_WRITE_CANCELLED);
131
0
  channel_queue_message_free(msg);
132
0
}
133
134
static BOOL CALLBACK init_channel_handles_table(WINPR_ATTR_UNUSED PINIT_ONCE once,
135
                                                WINPR_ATTR_UNUSED PVOID param,
136
                                                WINPR_ATTR_UNUSED PVOID* context)
137
0
{
138
0
  g_ChannelHandles = HashTable_New(TRUE);
139
0
  return TRUE;
140
0
}
141
142
static void* channel_event_entry_clone(const void* data)
143
0
{
144
0
  const ChannelEventEntry* entry = data;
145
0
  if (!entry)
146
0
    return NULL;
147
148
0
  ChannelEventEntry* copy = calloc(1, sizeof(ChannelEventEntry));
149
0
  if (!copy)
150
0
    return NULL;
151
0
  *copy = *entry;
152
0
  return copy;
153
0
}
154
155
rdpChannels* freerdp_channels_new(freerdp* instance)
156
0
{
157
0
  wObject* obj = NULL;
158
0
  rdpChannels* channels = NULL;
159
0
  channels = (rdpChannels*)calloc(1, sizeof(rdpChannels));
160
161
0
  if (!channels)
162
0
    return NULL;
163
164
0
  InitOnceExecuteOnce(&g_ChannelHandlesOnce, init_channel_handles_table, NULL, NULL);
165
166
0
  if (!g_ChannelHandles)
167
0
    goto error;
168
0
  if (!InitializeCriticalSectionAndSpinCount(&channels->channelsLock, 4000))
169
0
    goto error;
170
171
0
  channels->instance = instance;
172
0
  channels->queue = MessageQueue_New(NULL);
173
174
0
  if (!channels->queue)
175
0
    goto error;
176
177
0
  obj = MessageQueue_Object(channels->queue);
178
0
  obj->fnObjectFree = channel_queue_free;
179
180
0
  channels->channelEvents = HashTable_New(FALSE);
181
0
  if (!channels->channelEvents)
182
0
    goto error;
183
184
0
  obj = HashTable_ValueObject(channels->channelEvents);
185
0
  WINPR_ASSERT(obj);
186
0
  obj->fnObjectFree = free;
187
0
  obj->fnObjectNew = channel_event_entry_clone;
188
0
  return channels;
189
0
error:
190
0
  WINPR_PRAGMA_DIAG_PUSH
191
0
  WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
192
0
  freerdp_channels_free(channels);
193
0
  WINPR_PRAGMA_DIAG_POP
194
0
  return NULL;
195
0
}
196
197
void freerdp_channels_free(rdpChannels* channels)
198
0
{
199
0
  if (!channels)
200
0
    return;
201
202
0
  HashTable_Free(channels->channelEvents);
203
204
0
  DeleteCriticalSection(&channels->channelsLock);
205
206
0
  if (channels->queue)
207
0
  {
208
0
    MessageQueue_Free(channels->queue);
209
0
    channels->queue = NULL;
210
0
  }
211
212
0
  free(channels);
213
0
}
214
215
/**
216
 * Function description
217
 *
218
 * @return 0 on success, otherwise a Win32 error code
219
 */
220
static UINT freerdp_drdynvc_on_channel_connected(DrdynvcClientContext* context, const char* name,
221
                                                 void* pInterface)
222
0
{
223
0
  UINT status = CHANNEL_RC_OK;
224
0
  ChannelConnectedEventArgs e = { 0 };
225
0
  rdpChannels* channels = (rdpChannels*)context->custom;
226
0
  freerdp* instance = channels->instance;
227
0
  EventArgsInit(&e, "freerdp");
228
0
  e.name = name;
229
0
  e.pInterface = pInterface;
230
0
  PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e);
231
0
  return status;
232
0
}
233
234
/**
235
 * Function description
236
 *
237
 * @return 0 on success, otherwise a Win32 error code
238
 */
239
static UINT freerdp_drdynvc_on_channel_disconnected(DrdynvcClientContext* context, const char* name,
240
                                                    void* pInterface)
241
0
{
242
0
  UINT status = CHANNEL_RC_OK;
243
0
  ChannelDisconnectedEventArgs e = { 0 };
244
0
  rdpChannels* channels = (rdpChannels*)context->custom;
245
0
  freerdp* instance = channels->instance;
246
0
  EventArgsInit(&e, "freerdp");
247
0
  e.name = name;
248
0
  e.pInterface = pInterface;
249
0
  PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e);
250
0
  return status;
251
0
}
252
253
static UINT freerdp_drdynvc_on_channel_attached(DrdynvcClientContext* context, const char* name,
254
                                                void* pInterface)
255
0
{
256
0
  UINT status = CHANNEL_RC_OK;
257
0
  ChannelAttachedEventArgs e = { 0 };
258
0
  rdpChannels* channels = (rdpChannels*)context->custom;
259
0
  freerdp* instance = channels->instance;
260
0
  EventArgsInit(&e, "freerdp");
261
0
  e.name = name;
262
0
  e.pInterface = pInterface;
263
0
  PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e);
264
0
  return status;
265
0
}
266
267
static UINT freerdp_drdynvc_on_channel_detached(DrdynvcClientContext* context, const char* name,
268
                                                void* pInterface)
269
0
{
270
0
  UINT status = CHANNEL_RC_OK;
271
0
  ChannelDetachedEventArgs e = { 0 };
272
0
  rdpChannels* channels = (rdpChannels*)context->custom;
273
0
  freerdp* instance = channels->instance;
274
0
  EventArgsInit(&e, "freerdp");
275
0
  e.name = name;
276
0
  e.pInterface = pInterface;
277
0
  PubSub_OnChannelDetached(instance->context->pubSub, instance->context, &e);
278
0
  return status;
279
0
}
280
281
void freerdp_channels_register_instance(WINPR_ATTR_UNUSED rdpChannels* channels, freerdp* instance)
282
0
{
283
  /* store instance in TLS so future VirtualChannelInit calls can use it */
284
0
  g_Instance = instance;
285
0
}
286
287
/**
288
 * go through and inform all the libraries that we are initialized
289
 * called only from main thread
290
 */
291
UINT freerdp_channels_pre_connect(rdpChannels* channels, freerdp* instance)
292
0
{
293
0
  UINT error = CHANNEL_RC_OK;
294
0
  CHANNEL_CLIENT_DATA* pChannelClientData = NULL;
295
296
0
  MessageQueue_Clear(channels->queue);
297
298
0
  for (int index = 0; index < channels->clientDataCount; index++)
299
0
  {
300
0
    pChannelClientData = &channels->clientDataList[index];
301
302
0
    if (pChannelClientData->pChannelInitEventProc)
303
0
    {
304
0
      pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
305
0
                                                CHANNEL_EVENT_INITIALIZED, 0, 0);
306
0
    }
307
0
    else if (pChannelClientData->pChannelInitEventProcEx)
308
0
    {
309
0
      pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
310
0
                                                  pChannelClientData->pInitHandle,
311
0
                                                  CHANNEL_EVENT_INITIALIZED, 0, 0);
312
0
    }
313
314
0
    if (CHANNEL_RC_OK != getChannelError(instance->context))
315
0
      break;
316
0
  }
317
318
0
  return error;
319
0
}
320
321
UINT freerdp_channels_attach(freerdp* instance)
322
0
{
323
0
  UINT error = CHANNEL_RC_OK;
324
0
  const char* hostname = NULL;
325
0
  size_t hostnameLength = 0;
326
0
  rdpChannels* channels = NULL;
327
0
  CHANNEL_CLIENT_DATA* pChannelClientData = NULL;
328
329
0
  WINPR_ASSERT(instance);
330
0
  WINPR_ASSERT(instance->context);
331
0
  WINPR_ASSERT(instance->context->settings);
332
333
0
  channels = instance->context->channels;
334
0
  hostname = freerdp_settings_get_string(instance->context->settings, FreeRDP_ServerHostname);
335
0
  WINPR_ASSERT(hostname);
336
0
  hostnameLength = strnlen(hostname, MAX_PATH);
337
338
0
  for (int index = 0; index < channels->clientDataCount; index++)
339
0
  {
340
0
    union
341
0
    {
342
0
      const void* cpv;
343
0
      void* pv;
344
0
    } cnv;
345
0
    ChannelAttachedEventArgs e = { 0 };
346
0
    CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
347
348
0
    cnv.cpv = hostname;
349
0
    pChannelClientData = &channels->clientDataList[index];
350
351
0
    if (pChannelClientData->pChannelInitEventProc)
352
0
    {
353
354
0
      pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
355
0
                                                CHANNEL_EVENT_ATTACHED, cnv.pv,
356
0
                                                (UINT)hostnameLength);
357
0
    }
358
0
    else if (pChannelClientData->pChannelInitEventProcEx)
359
0
    {
360
0
      pChannelClientData->pChannelInitEventProcEx(
361
0
          pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
362
0
          CHANNEL_EVENT_ATTACHED, cnv.pv, (UINT)hostnameLength);
363
0
    }
364
365
0
    if (getChannelError(instance->context) != CHANNEL_RC_OK)
366
0
      goto fail;
367
368
0
    pChannelOpenData = &channels->openDataList[index];
369
0
    EventArgsInit(&e, "freerdp");
370
0
    e.name = pChannelOpenData->name;
371
0
    e.pInterface = pChannelOpenData->pInterface;
372
0
    PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e);
373
0
  }
374
375
0
fail:
376
0
  return error;
377
0
}
378
379
UINT freerdp_channels_detach(freerdp* instance)
380
0
{
381
0
  UINT error = CHANNEL_RC_OK;
382
0
  const char* hostname = NULL;
383
0
  size_t hostnameLength = 0;
384
0
  rdpChannels* channels = NULL;
385
0
  rdpContext* context = NULL;
386
0
  CHANNEL_CLIENT_DATA* pChannelClientData = NULL;
387
388
0
  WINPR_ASSERT(instance);
389
390
0
  context = instance->context;
391
0
  WINPR_ASSERT(context);
392
393
0
  channels = context->channels;
394
0
  WINPR_ASSERT(channels);
395
396
0
  WINPR_ASSERT(context->settings);
397
0
  hostname = freerdp_settings_get_string(context->settings, FreeRDP_ServerHostname);
398
0
  WINPR_ASSERT(hostname);
399
0
  hostnameLength = strnlen(hostname, MAX_PATH);
400
401
0
  for (int index = 0; index < channels->clientDataCount; index++)
402
0
  {
403
0
    union
404
0
    {
405
0
      const void* cpv;
406
0
      void* pv;
407
0
    } cnv;
408
409
0
    ChannelDetachedEventArgs e = { 0 };
410
0
    CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
411
412
0
    cnv.cpv = hostname;
413
0
    pChannelClientData = &channels->clientDataList[index];
414
415
0
    if (pChannelClientData->pChannelInitEventProc)
416
0
    {
417
0
      pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
418
0
                                                CHANNEL_EVENT_DETACHED, cnv.pv,
419
0
                                                (UINT)hostnameLength);
420
0
    }
421
0
    else if (pChannelClientData->pChannelInitEventProcEx)
422
0
    {
423
0
      pChannelClientData->pChannelInitEventProcEx(
424
0
          pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
425
0
          CHANNEL_EVENT_DETACHED, cnv.pv, (UINT)hostnameLength);
426
0
    }
427
428
0
    if (getChannelError(context) != CHANNEL_RC_OK)
429
0
      goto fail;
430
431
0
    pChannelOpenData = &channels->openDataList[index];
432
0
    EventArgsInit(&e, "freerdp");
433
0
    e.name = pChannelOpenData->name;
434
0
    e.pInterface = pChannelOpenData->pInterface;
435
0
    PubSub_OnChannelDetached(context->pubSub, context, &e);
436
0
  }
437
438
0
fail:
439
0
  return error;
440
0
}
441
442
/**
443
 * go through and inform all the libraries that we are connected
444
 * this will tell the libraries that its ok to call MyVirtualChannelOpen
445
 * called only from main thread
446
 */
447
UINT freerdp_channels_post_connect(rdpChannels* channels, freerdp* instance)
448
0
{
449
0
  UINT error = CHANNEL_RC_OK;
450
0
  const char* hostname = NULL;
451
0
  size_t hostnameLength = 0;
452
0
  CHANNEL_CLIENT_DATA* pChannelClientData = NULL;
453
454
0
  WINPR_ASSERT(channels);
455
0
  WINPR_ASSERT(instance);
456
0
  WINPR_ASSERT(instance->context);
457
0
  WINPR_ASSERT(instance->context->settings);
458
459
0
  channels->connected = TRUE;
460
0
  hostname = freerdp_settings_get_string(instance->context->settings, FreeRDP_ServerHostname);
461
0
  WINPR_ASSERT(hostname);
462
0
  hostnameLength = strnlen(hostname, MAX_PATH);
463
464
0
  for (int index = 0; index < channels->clientDataCount; index++)
465
0
  {
466
0
    union
467
0
    {
468
0
      const void* pcb;
469
0
      void* pb;
470
0
    } cnv;
471
0
    ChannelConnectedEventArgs e = { 0 };
472
0
    CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
473
0
    pChannelClientData = &channels->clientDataList[index];
474
475
0
    cnv.pcb = hostname;
476
0
    if (pChannelClientData->pChannelInitEventProc)
477
0
    {
478
0
      pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
479
0
                                                CHANNEL_EVENT_CONNECTED, cnv.pb,
480
0
                                                (UINT)hostnameLength);
481
0
    }
482
0
    else if (pChannelClientData->pChannelInitEventProcEx)
483
0
    {
484
0
      pChannelClientData->pChannelInitEventProcEx(
485
0
          pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
486
0
          CHANNEL_EVENT_CONNECTED, cnv.pb, (UINT)hostnameLength);
487
0
    }
488
489
0
    error = getChannelError(instance->context);
490
0
    if (error != CHANNEL_RC_OK)
491
0
      goto fail;
492
493
0
    pChannelOpenData = &channels->openDataList[index];
494
0
    EventArgsInit(&e, "freerdp");
495
0
    e.name = pChannelOpenData->name;
496
0
    e.pInterface = pChannelOpenData->pInterface;
497
0
    PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e);
498
0
  }
499
500
0
  channels->drdynvc = (DrdynvcClientContext*)freerdp_channels_get_static_channel_interface(
501
0
      channels, DRDYNVC_SVC_CHANNEL_NAME);
502
503
0
  if (channels->drdynvc)
504
0
  {
505
0
    channels->drdynvc->custom = (void*)channels;
506
0
    channels->drdynvc->OnChannelConnected = freerdp_drdynvc_on_channel_connected;
507
0
    channels->drdynvc->OnChannelDisconnected = freerdp_drdynvc_on_channel_disconnected;
508
0
    channels->drdynvc->OnChannelAttached = freerdp_drdynvc_on_channel_attached;
509
0
    channels->drdynvc->OnChannelDetached = freerdp_drdynvc_on_channel_detached;
510
0
  }
511
512
0
fail:
513
0
  return error;
514
0
}
515
516
BOOL freerdp_channels_data(freerdp* instance, UINT16 channelId, const BYTE* cdata, size_t dataSize,
517
                           UINT32 flags, size_t totalSize)
518
0
{
519
0
  rdpMcs* mcs = NULL;
520
0
  rdpChannels* channels = NULL;
521
0
  rdpMcsChannel* channel = NULL;
522
0
  CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
523
0
  union
524
0
  {
525
0
    const BYTE* pcb;
526
0
    BYTE* pb;
527
0
  } data;
528
529
0
  data.pcb = cdata;
530
0
  if (!instance || !data.pcb)
531
0
  {
532
0
    WLog_ERR(TAG, "(%p, %" PRIu16 ", %p, 0x%08x): Invalid arguments", instance, channelId,
533
0
             data.pcb, flags);
534
0
    return FALSE;
535
0
  }
536
537
0
  mcs = instance->context->rdp->mcs;
538
0
  channels = instance->context->channels;
539
540
0
  if (!channels || !mcs)
541
0
  {
542
0
    return FALSE;
543
0
  }
544
545
0
  for (UINT32 index = 0; index < mcs->channelCount; index++)
546
0
  {
547
0
    rdpMcsChannel* cur = &mcs->channels[index];
548
549
0
    if (cur->ChannelId == channelId)
550
0
    {
551
0
      channel = cur;
552
0
      break;
553
0
    }
554
0
  }
555
556
0
  if (!channel)
557
0
  {
558
0
    return FALSE;
559
0
  }
560
561
0
  pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, channel->Name);
562
563
0
  if (!pChannelOpenData)
564
0
  {
565
0
    return FALSE;
566
0
  }
567
568
0
  if (pChannelOpenData->pChannelOpenEventProc)
569
0
  {
570
0
    pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->OpenHandle,
571
0
                                            CHANNEL_EVENT_DATA_RECEIVED, data.pb,
572
0
                                            (UINT32)dataSize, (UINT32)totalSize, flags);
573
0
  }
574
0
  else if (pChannelOpenData->pChannelOpenEventProcEx)
575
0
  {
576
0
    pChannelOpenData->pChannelOpenEventProcEx(
577
0
        pChannelOpenData->lpUserParam, pChannelOpenData->OpenHandle,
578
0
        CHANNEL_EVENT_DATA_RECEIVED, data.pb, (UINT32)dataSize, (UINT32)totalSize, flags);
579
0
  }
580
581
0
  return TRUE;
582
0
}
583
584
UINT16 freerdp_channels_get_id_by_name(freerdp* instance, const char* channel_name)
585
0
{
586
0
  if (!instance || !channel_name)
587
0
    return 0;
588
589
0
  rdpMcsChannel* mcsChannel =
590
0
      freerdp_channels_find_channel_by_name(instance->context->rdp, channel_name);
591
0
  if (!mcsChannel)
592
0
    return 0;
593
594
0
  return mcsChannel->ChannelId;
595
0
}
596
597
const char* freerdp_channels_get_name_by_id(freerdp* instance, UINT16 channelId)
598
0
{
599
0
  rdpMcsChannel* mcsChannel = NULL;
600
0
  if (!instance)
601
0
    return NULL;
602
603
0
  mcsChannel = freerdp_channels_find_channel_by_id(instance->context->rdp, channelId);
604
0
  if (!mcsChannel)
605
0
    return NULL;
606
607
0
  return mcsChannel->Name;
608
0
}
609
610
BOOL freerdp_channels_process_message_free(wMessage* message, DWORD type)
611
0
{
612
0
  if (message->id == WMQ_QUIT)
613
0
  {
614
0
    return FALSE;
615
0
  }
616
617
0
  if (message->id == 0)
618
0
  {
619
0
    CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
620
0
    CHANNEL_OPEN_EVENT* item = (CHANNEL_OPEN_EVENT*)message->wParam;
621
622
0
    if (!item)
623
0
      return FALSE;
624
625
0
    pChannelOpenData = item->pChannelOpenData;
626
627
0
    if (pChannelOpenData->pChannelOpenEventProc)
628
0
    {
629
0
      pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->OpenHandle, type,
630
0
                                              item->UserData, item->DataLength,
631
0
                                              item->DataLength, 0);
632
0
    }
633
0
    else if (pChannelOpenData->pChannelOpenEventProcEx)
634
0
    {
635
0
      pChannelOpenData->pChannelOpenEventProcEx(
636
0
          pChannelOpenData->lpUserParam, pChannelOpenData->OpenHandle, type, item->UserData,
637
0
          item->DataLength, item->DataLength, 0);
638
0
    }
639
0
  }
640
641
0
  return TRUE;
642
0
}
643
644
static BOOL freerdp_channels_process_message(freerdp* instance, wMessage* message)
645
0
{
646
0
  BOOL ret = TRUE;
647
0
  BOOL rc = FALSE;
648
649
0
  WINPR_ASSERT(instance);
650
0
  WINPR_ASSERT(message);
651
652
0
  if (message->id == WMQ_QUIT)
653
0
    goto fail;
654
0
  else if (message->id == 0)
655
0
  {
656
0
    rdpMcsChannel* channel = NULL;
657
0
    CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
658
0
    CHANNEL_OPEN_EVENT* item = (CHANNEL_OPEN_EVENT*)message->wParam;
659
660
0
    if (!item)
661
0
      goto fail;
662
663
0
    pChannelOpenData = item->pChannelOpenData;
664
0
    if (pChannelOpenData->flags != 2)
665
0
    {
666
0
      freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_CANCELLED);
667
0
      goto fail;
668
0
    }
669
0
    channel =
670
0
        freerdp_channels_find_channel_by_name(instance->context->rdp, pChannelOpenData->name);
671
672
0
    if (channel)
673
0
      ret = instance->SendChannelData(instance, channel->ChannelId, item->Data,
674
0
                                      item->DataLength);
675
0
  }
676
677
0
  if (!freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_COMPLETE))
678
0
    goto fail;
679
680
0
  rc = ret;
681
682
0
fail:
683
0
  IFCALL(message->Free, message);
684
0
  return rc;
685
0
}
686
687
/**
688
 * called only from main thread
689
 */
690
static BOOL freerdp_channels_process_sync(rdpChannels* channels, freerdp* instance)
691
0
{
692
0
  BOOL status = TRUE;
693
0
  wMessage message = { 0 };
694
695
0
  WINPR_ASSERT(channels);
696
697
0
  while (MessageQueue_Peek(channels->queue, &message, TRUE))
698
0
  {
699
0
    if (!freerdp_channels_process_message(instance, &message))
700
0
      status = FALSE;
701
0
  }
702
703
0
  return status;
704
0
}
705
706
/**
707
 * called only from main thread
708
 */
709
#if defined(WITH_FREERDP_DEPRECATED)
710
BOOL freerdp_channels_get_fds(rdpChannels* channels, WINPR_ATTR_UNUSED freerdp* instance,
711
                              void** read_fds, int* read_count, WINPR_ATTR_UNUSED void** write_fds,
712
                              WINPR_ATTR_UNUSED int* write_count)
713
{
714
  void* pfd = NULL;
715
  pfd = GetEventWaitObject(MessageQueue_Event(channels->queue));
716
717
  if (pfd)
718
  {
719
    read_fds[*read_count] = pfd;
720
    (*read_count)++;
721
  }
722
723
  return TRUE;
724
}
725
#endif
726
727
void* freerdp_channels_get_static_channel_interface(rdpChannels* channels, const char* name)
728
0
{
729
0
  void* pInterface = NULL;
730
0
  CHANNEL_OPEN_DATA* pChannelOpenData =
731
0
      freerdp_channels_find_channel_open_data_by_name(channels, name);
732
733
0
  if (pChannelOpenData)
734
0
    pInterface = pChannelOpenData->pInterface;
735
736
0
  return pInterface;
737
0
}
738
739
HANDLE freerdp_channels_get_event_handle(freerdp* instance)
740
0
{
741
0
  if (!instance)
742
0
    return INVALID_HANDLE_VALUE;
743
744
0
  WINPR_ASSERT(instance->context);
745
746
0
  rdpChannels* channels = instance->context->channels;
747
0
  WINPR_ASSERT(channels);
748
749
0
  return MessageQueue_Event(channels->queue);
750
0
}
751
752
static BOOL channels_process(const void* key, void* value, void* arg)
753
0
{
754
0
  ChannelEventEntry* entry = value;
755
0
  rdpContext* context = arg;
756
757
0
  WINPR_UNUSED(key);
758
759
0
  if (!entry->fkt)
760
0
    return FALSE;
761
0
  return entry->fkt(context, entry->userdata);
762
0
}
763
764
int freerdp_channels_process_pending_messages(freerdp* instance)
765
0
{
766
0
  if (!instance)
767
0
    return -1;
768
769
0
  WINPR_ASSERT(instance->context);
770
771
0
  rdpChannels* channels = instance->context->channels;
772
0
  WINPR_ASSERT(channels);
773
774
0
  const DWORD status = WaitForSingleObject(MessageQueue_Event(channels->queue), 0);
775
0
  if (status == WAIT_OBJECT_0)
776
0
  {
777
0
    if (!freerdp_channels_process_sync(channels, instance))
778
0
      return -1;
779
0
  }
780
781
0
  if (!HashTable_Foreach(channels->channelEvents, channels_process, instance->context))
782
0
    return -1;
783
784
0
  return 1;
785
0
}
786
787
/**
788
 * called only from main thread
789
 */
790
BOOL freerdp_channels_check_fds(rdpChannels* channels, freerdp* instance)
791
0
{
792
0
  WINPR_ASSERT(channels);
793
0
  WINPR_UNUSED(channels);
794
795
0
  const int rc = freerdp_channels_process_pending_messages(instance);
796
0
  return rc == 1;
797
0
}
798
799
BOOL freerdp_client_channel_register(rdpChannels* channels, HANDLE handle,
800
                                     freerdp_channel_handle_fkt_t fkt, void* userdata)
801
0
{
802
0
  if (!channels || (handle == INVALID_HANDLE_VALUE) || !fkt)
803
0
  {
804
0
    WLog_ERR(TAG, "Invalid function arguments (channels=%p, handle=%p, fkt=%p, userdata=%p",
805
0
             channels, handle, fkt, userdata);
806
0
    return FALSE;
807
0
  }
808
809
0
  ChannelEventEntry entry = { .fkt = fkt, .userdata = userdata };
810
0
  return HashTable_Insert(channels->channelEvents, handle, &entry);
811
0
}
812
813
BOOL freerdp_client_channel_unregister(rdpChannels* channels, HANDLE handle)
814
0
{
815
0
  if (!channels || (handle == INVALID_HANDLE_VALUE))
816
0
  {
817
0
    WLog_ERR(TAG, "Invalid function arguments (channels=%p, handle=%p", channels, handle);
818
0
    return FALSE;
819
0
  }
820
821
0
  return HashTable_Remove(channels->channelEvents, handle);
822
0
}
823
824
SSIZE_T freerdp_client_channel_get_registered_event_handles(rdpChannels* channels, HANDLE* events,
825
                                                            DWORD count)
826
0
{
827
0
  SSIZE_T rc = -1;
828
829
0
  WINPR_ASSERT(channels);
830
0
  WINPR_ASSERT(events || (count == 0));
831
832
0
  HashTable_Lock(channels->channelEvents);
833
0
  size_t len = HashTable_Count(channels->channelEvents);
834
0
  if (len <= count)
835
0
  {
836
0
    ULONG_PTR* keys = NULL;
837
0
    const size_t nrKeys = HashTable_GetKeys(channels->channelEvents, &keys);
838
0
    if ((nrKeys <= SSIZE_MAX) && (nrKeys == len))
839
0
    {
840
0
      for (size_t x = 0; x < nrKeys; x++)
841
0
      {
842
0
        HANDLE cur = (HANDLE)keys[x];
843
0
        events[x] = cur;
844
0
      }
845
0
      rc = (SSIZE_T)nrKeys;
846
0
    }
847
0
    free(keys);
848
0
  }
849
0
  HashTable_Unlock(channels->channelEvents);
850
0
  return rc;
851
0
}
852
853
UINT freerdp_channels_disconnect(rdpChannels* channels, freerdp* instance)
854
0
{
855
0
  UINT error = CHANNEL_RC_OK;
856
0
  CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
857
0
  CHANNEL_CLIENT_DATA* pChannelClientData = NULL;
858
859
0
  WINPR_ASSERT(channels);
860
861
0
  if (!channels->connected)
862
0
    return 0;
863
864
0
  (void)freerdp_channels_check_fds(channels, instance);
865
866
  /* tell all libraries we are shutting down */
867
0
  for (int index = 0; index < channels->clientDataCount; index++)
868
0
  {
869
0
    ChannelDisconnectedEventArgs e = { 0 };
870
0
    pChannelClientData = &channels->clientDataList[index];
871
872
0
    if (pChannelClientData->pChannelInitEventProc)
873
0
    {
874
0
      pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
875
0
                                                CHANNEL_EVENT_DISCONNECTED, 0, 0);
876
0
    }
877
0
    else if (pChannelClientData->pChannelInitEventProcEx)
878
0
    {
879
0
      pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
880
0
                                                  pChannelClientData->pInitHandle,
881
0
                                                  CHANNEL_EVENT_DISCONNECTED, 0, 0);
882
0
    }
883
884
0
    pChannelOpenData = &channels->openDataList[index];
885
0
    EventArgsInit(&e, "freerdp");
886
0
    e.name = pChannelOpenData->name;
887
0
    e.pInterface = pChannelOpenData->pInterface;
888
0
    PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e);
889
0
  }
890
891
0
  channels->connected = FALSE;
892
893
  /* Flush pending messages */
894
0
  (void)freerdp_channels_check_fds(channels, instance);
895
0
  return error;
896
0
}
897
898
void freerdp_channels_close(rdpChannels* channels, freerdp* instance)
899
0
{
900
0
  CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
901
0
  CHANNEL_CLIENT_DATA* pChannelClientData = NULL;
902
903
0
  WINPR_ASSERT(channels);
904
0
  WINPR_ASSERT(instance);
905
906
0
  MessageQueue_PostQuit(channels->queue, 0);
907
0
  (void)freerdp_channels_check_fds(channels, instance);
908
909
  /* tell all libraries we are shutting down */
910
0
  for (int index = 0; index < channels->clientDataCount; index++)
911
0
  {
912
0
    pChannelClientData = &channels->clientDataList[index];
913
914
0
    if (pChannelClientData->pChannelInitEventProc)
915
0
    {
916
0
      pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
917
0
                                                CHANNEL_EVENT_TERMINATED, 0, 0);
918
0
    }
919
0
    else if (pChannelClientData->pChannelInitEventProcEx)
920
0
    {
921
0
      pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
922
0
                                                  pChannelClientData->pInitHandle,
923
0
                                                  CHANNEL_EVENT_TERMINATED, 0, 0);
924
0
    }
925
0
  }
926
927
0
  for (int index = 0; index < channels->openDataCount; index++)
928
0
  {
929
0
    pChannelOpenData = &channels->openDataList[index];
930
0
    HashTable_Remove(g_ChannelHandles, (void*)(UINT_PTR)pChannelOpenData->OpenHandle);
931
0
  }
932
933
0
  channels->openDataCount = 0;
934
0
  channels->initDataCount = 0;
935
0
  channels->clientDataCount = 0;
936
937
0
  WINPR_ASSERT(instance->context);
938
0
  WINPR_ASSERT(instance->context->settings);
939
0
  instance->context->settings->ChannelCount = 0;
940
0
  g_Instance = NULL;
941
0
}
942
943
static UINT VCAPITYPE FreeRDP_VirtualChannelInitEx(
944
    LPVOID lpUserParam, LPVOID clientContext, LPVOID pInitHandle, PCHANNEL_DEF pChannel,
945
    INT channelCount, ULONG versionRequested, PCHANNEL_INIT_EVENT_EX_FN pChannelInitEventProcEx)
946
0
{
947
0
  rdpSettings* settings = NULL;
948
0
  CHANNEL_INIT_DATA* pChannelInitData = NULL;
949
0
  CHANNEL_CLIENT_DATA* pChannelClientData = NULL;
950
0
  rdpChannels* channels = NULL;
951
952
0
  if (!pInitHandle)
953
0
    return CHANNEL_RC_BAD_INIT_HANDLE;
954
955
0
  if (!pChannel)
956
0
    return CHANNEL_RC_BAD_CHANNEL;
957
958
0
  if ((channelCount <= 0) || !pChannelInitEventProcEx)
959
0
    return CHANNEL_RC_INITIALIZATION_ERROR;
960
961
0
  pChannelInitData = (CHANNEL_INIT_DATA*)pInitHandle;
962
0
  WINPR_ASSERT(pChannelInitData);
963
964
0
  channels = pChannelInitData->channels;
965
0
  WINPR_ASSERT(channels);
966
967
0
  if (!channels->can_call_init)
968
0
    return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
969
970
0
  if ((channels->openDataCount + channelCount) > CHANNEL_MAX_COUNT)
971
0
    return CHANNEL_RC_TOO_MANY_CHANNELS;
972
973
0
  if (channels->connected)
974
0
    return CHANNEL_RC_ALREADY_CONNECTED;
975
976
0
  if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
977
0
  {
978
0
  }
979
980
0
  for (int index = 0; index < channelCount; index++)
981
0
  {
982
0
    const PCHANNEL_DEF pChannelDef = &pChannel[index];
983
984
0
    if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) != 0)
985
0
    {
986
0
      return CHANNEL_RC_BAD_CHANNEL;
987
0
    }
988
0
  }
989
990
0
  pChannelInitData->pInterface = clientContext;
991
0
  pChannelClientData = &channels->clientDataList[channels->clientDataCount];
992
0
  pChannelClientData->pChannelInitEventProcEx = pChannelInitEventProcEx;
993
0
  pChannelClientData->pInitHandle = pInitHandle;
994
0
  pChannelClientData->lpUserParam = lpUserParam;
995
0
  channels->clientDataCount++;
996
997
0
  WINPR_ASSERT(channels->instance);
998
0
  WINPR_ASSERT(channels->instance->context);
999
0
  settings = channels->instance->context->settings;
1000
0
  WINPR_ASSERT(settings);
1001
1002
0
  for (int index = 0; index < channelCount; index++)
1003
0
  {
1004
0
    const PCHANNEL_DEF pChannelDef = &pChannel[index];
1005
0
    CHANNEL_OPEN_DATA* pChannelOpenData = &channels->openDataList[channels->openDataCount];
1006
1007
0
    WINPR_ASSERT(pChannelOpenData);
1008
1009
0
    const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1010
0
    pChannelOpenData->OpenHandle = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1011
0
    pChannelOpenData->channels = channels;
1012
0
    pChannelOpenData->lpUserParam = lpUserParam;
1013
0
    if (!HashTable_Insert(g_ChannelHandles, (void*)(UINT_PTR)pChannelOpenData->OpenHandle,
1014
0
                          (void*)pChannelOpenData))
1015
0
    {
1016
0
      pChannelInitData->pInterface = NULL;
1017
0
      return CHANNEL_RC_INITIALIZATION_ERROR;
1018
0
    }
1019
0
    pChannelOpenData->flags = 1; /* init */
1020
0
    strncpy(pChannelOpenData->name, pChannelDef->name, CHANNEL_NAME_LEN);
1021
0
    pChannelOpenData->options = pChannelDef->options;
1022
1023
0
    const UINT32 max = freerdp_settings_get_uint32(settings, FreeRDP_ChannelDefArraySize);
1024
0
    WINPR_ASSERT(max >= CHANNEL_MAX_COUNT);
1025
0
    if (settings->ChannelCount < max)
1026
0
    {
1027
0
      CHANNEL_DEF* channel = freerdp_settings_get_pointer_array_writable(
1028
0
          settings, FreeRDP_ChannelDefArray, settings->ChannelCount);
1029
0
      if (!channel)
1030
0
        continue;
1031
0
      strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1032
0
      channel->options = pChannelDef->options;
1033
0
      settings->ChannelCount++;
1034
0
    }
1035
1036
0
    channels->openDataCount++;
1037
0
  }
1038
1039
0
  return CHANNEL_RC_OK;
1040
0
}
1041
1042
static UINT VCAPITYPE FreeRDP_VirtualChannelInit(LPVOID* ppInitHandle, PCHANNEL_DEF pChannel,
1043
                                                 INT channelCount, ULONG versionRequested,
1044
                                                 PCHANNEL_INIT_EVENT_FN pChannelInitEventProc)
1045
0
{
1046
0
  CHANNEL_DEF* channel = NULL;
1047
0
  rdpSettings* settings = NULL;
1048
0
  PCHANNEL_DEF pChannelDef = NULL;
1049
0
  CHANNEL_INIT_DATA* pChannelInitData = NULL;
1050
0
  CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
1051
0
  CHANNEL_CLIENT_DATA* pChannelClientData = NULL;
1052
0
  rdpChannels* channels = NULL;
1053
1054
  /* g_Instance should have been set during freerdp_connect - otherwise VirtualChannelInit was
1055
   * called from a different thread */
1056
0
  if (!g_Instance || !g_Instance->context)
1057
0
    return CHANNEL_RC_NOT_INITIALIZED;
1058
1059
0
  channels = g_Instance->context->channels;
1060
1061
0
  if (!ppInitHandle || !channels)
1062
0
    return CHANNEL_RC_BAD_INIT_HANDLE;
1063
1064
0
  if (!pChannel)
1065
0
    return CHANNEL_RC_BAD_CHANNEL;
1066
1067
0
  if ((channelCount <= 0) || !pChannelInitEventProc)
1068
0
    return CHANNEL_RC_INITIALIZATION_ERROR;
1069
1070
0
  pChannelInitData = &(channels->initDataList[channels->initDataCount]);
1071
0
  *ppInitHandle = pChannelInitData;
1072
0
  channels->initDataCount++;
1073
0
  pChannelInitData->channels = channels;
1074
0
  pChannelInitData->pInterface = NULL;
1075
1076
0
  if (!channels->can_call_init)
1077
0
    return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
1078
1079
0
  if (channels->openDataCount + channelCount > CHANNEL_MAX_COUNT)
1080
0
    return CHANNEL_RC_TOO_MANY_CHANNELS;
1081
1082
0
  if (channels->connected)
1083
0
    return CHANNEL_RC_ALREADY_CONNECTED;
1084
1085
0
  if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
1086
0
  {
1087
0
  }
1088
1089
0
  for (int index = 0; index < channelCount; index++)
1090
0
  {
1091
0
    pChannelDef = &pChannel[index];
1092
1093
0
    if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) != 0)
1094
0
    {
1095
0
      return CHANNEL_RC_BAD_CHANNEL;
1096
0
    }
1097
0
  }
1098
1099
0
  pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1100
0
  pChannelClientData->pChannelInitEventProc = pChannelInitEventProc;
1101
0
  pChannelClientData->pInitHandle = *ppInitHandle;
1102
0
  channels->clientDataCount++;
1103
0
  settings = channels->instance->context->settings;
1104
1105
0
  for (int index = 0; index < channelCount; index++)
1106
0
  {
1107
0
    UINT32 ChannelCount = freerdp_settings_get_uint32(settings, FreeRDP_ChannelCount);
1108
1109
0
    pChannelDef = &pChannel[index];
1110
1111
0
    pChannelOpenData = &channels->openDataList[channels->openDataCount];
1112
1113
0
    const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1114
0
    pChannelOpenData->OpenHandle = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1115
0
    pChannelOpenData->channels = channels;
1116
0
    if (!HashTable_Insert(g_ChannelHandles, (void*)(UINT_PTR)pChannelOpenData->OpenHandle,
1117
0
                          (void*)pChannelOpenData))
1118
0
      return CHANNEL_RC_INITIALIZATION_ERROR;
1119
0
    pChannelOpenData->flags = 1; /* init */
1120
0
    strncpy(pChannelOpenData->name, pChannelDef->name, CHANNEL_NAME_LEN);
1121
0
    pChannelOpenData->options = pChannelDef->options;
1122
1123
0
    if (ChannelCount < CHANNEL_MAX_COUNT)
1124
0
    {
1125
0
      channel = freerdp_settings_get_pointer_array_writable(settings, FreeRDP_ChannelDefArray,
1126
0
                                                            ChannelCount++);
1127
0
      strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1128
0
      channel->options = pChannelDef->options;
1129
0
      if (!freerdp_settings_set_uint32(settings, FreeRDP_ChannelCount, ChannelCount))
1130
0
        return ERROR_INTERNAL_ERROR;
1131
0
    }
1132
1133
0
    channels->openDataCount++;
1134
0
  }
1135
1136
0
  return CHANNEL_RC_OK;
1137
0
}
1138
1139
static UINT VCAPITYPE
1140
FreeRDP_VirtualChannelOpenEx(LPVOID pInitHandle, LPDWORD pOpenHandle, PCHAR pChannelName,
1141
                             PCHANNEL_OPEN_EVENT_EX_FN pChannelOpenEventProcEx)
1142
0
{
1143
0
  void* pInterface = NULL;
1144
0
  rdpChannels* channels = NULL;
1145
0
  CHANNEL_INIT_DATA* pChannelInitData = NULL;
1146
0
  CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
1147
0
  pChannelInitData = (CHANNEL_INIT_DATA*)pInitHandle;
1148
0
  channels = pChannelInitData->channels;
1149
0
  pInterface = pChannelInitData->pInterface;
1150
1151
0
  if (!pOpenHandle)
1152
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1153
1154
0
  if (!pChannelOpenEventProcEx)
1155
0
    return CHANNEL_RC_BAD_PROC;
1156
1157
0
  if (!channels->connected)
1158
0
    return CHANNEL_RC_NOT_CONNECTED;
1159
1160
0
  pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1161
1162
0
  if (!pChannelOpenData)
1163
0
    return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1164
1165
0
  if (pChannelOpenData->flags == 2)
1166
0
    return CHANNEL_RC_ALREADY_OPEN;
1167
1168
0
  pChannelOpenData->flags = 2; /* open */
1169
0
  pChannelOpenData->pInterface = pInterface;
1170
0
  pChannelOpenData->pChannelOpenEventProcEx = pChannelOpenEventProcEx;
1171
0
  *pOpenHandle = pChannelOpenData->OpenHandle;
1172
0
  return CHANNEL_RC_OK;
1173
0
}
1174
1175
static UINT VCAPITYPE FreeRDP_VirtualChannelOpen(LPVOID pInitHandle, LPDWORD pOpenHandle,
1176
                                                 PCHAR pChannelName,
1177
                                                 PCHANNEL_OPEN_EVENT_FN pChannelOpenEventProc)
1178
0
{
1179
0
  void* pInterface = NULL;
1180
0
  rdpChannels* channels = NULL;
1181
0
  CHANNEL_INIT_DATA* pChannelInitData = NULL;
1182
0
  CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
1183
0
  pChannelInitData = (CHANNEL_INIT_DATA*)pInitHandle;
1184
0
  channels = pChannelInitData->channels;
1185
0
  pInterface = pChannelInitData->pInterface;
1186
1187
0
  if (!pOpenHandle)
1188
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1189
1190
0
  if (!pChannelOpenEventProc)
1191
0
    return CHANNEL_RC_BAD_PROC;
1192
1193
0
  if (!channels->connected)
1194
0
    return CHANNEL_RC_NOT_CONNECTED;
1195
1196
0
  pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1197
1198
0
  if (!pChannelOpenData)
1199
0
    return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1200
1201
0
  if (pChannelOpenData->flags == 2)
1202
0
    return CHANNEL_RC_ALREADY_OPEN;
1203
1204
0
  pChannelOpenData->flags = 2; /* open */
1205
0
  pChannelOpenData->pInterface = pInterface;
1206
0
  pChannelOpenData->pChannelOpenEventProc = pChannelOpenEventProc;
1207
0
  *pOpenHandle = pChannelOpenData->OpenHandle;
1208
0
  return CHANNEL_RC_OK;
1209
0
}
1210
1211
static UINT VCAPITYPE FreeRDP_VirtualChannelCloseEx(LPVOID pInitHandle, DWORD openHandle)
1212
0
{
1213
0
  CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
1214
1215
0
  if (!pInitHandle)
1216
0
    return CHANNEL_RC_BAD_INIT_HANDLE;
1217
1218
0
  pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (void*)(UINT_PTR)openHandle);
1219
1220
0
  if (!pChannelOpenData)
1221
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1222
1223
0
  if (pChannelOpenData->flags != 2)
1224
0
    return CHANNEL_RC_NOT_OPEN;
1225
1226
0
  pChannelOpenData->flags = 0;
1227
0
  return CHANNEL_RC_OK;
1228
0
}
1229
1230
static UINT VCAPITYPE FreeRDP_VirtualChannelClose(DWORD openHandle)
1231
0
{
1232
0
  CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
1233
1234
0
  pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (void*)(UINT_PTR)openHandle);
1235
1236
0
  if (!pChannelOpenData)
1237
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1238
1239
0
  if (pChannelOpenData->flags != 2)
1240
0
    return CHANNEL_RC_NOT_OPEN;
1241
1242
0
  pChannelOpenData->flags = 0;
1243
0
  return CHANNEL_RC_OK;
1244
0
}
1245
1246
static UINT VCAPITYPE FreeRDP_VirtualChannelWriteEx(LPVOID pInitHandle, DWORD openHandle,
1247
                                                    LPVOID pData, ULONG dataLength,
1248
                                                    LPVOID pUserData)
1249
0
{
1250
0
  rdpChannels* channels = NULL;
1251
0
  CHANNEL_INIT_DATA* pChannelInitData = NULL;
1252
0
  CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
1253
0
  CHANNEL_OPEN_EVENT* pChannelOpenEvent = NULL;
1254
0
  wMessage message = { 0 };
1255
1256
0
  if (!pInitHandle)
1257
0
    return CHANNEL_RC_BAD_INIT_HANDLE;
1258
1259
0
  pChannelInitData = (CHANNEL_INIT_DATA*)pInitHandle;
1260
0
  channels = pChannelInitData->channels;
1261
1262
0
  if (!channels)
1263
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1264
1265
0
  pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (void*)(UINT_PTR)openHandle);
1266
1267
0
  if (!pChannelOpenData)
1268
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1269
1270
0
  if (!channels->connected)
1271
0
    return CHANNEL_RC_NOT_CONNECTED;
1272
1273
0
  if (!pData)
1274
0
    return CHANNEL_RC_NULL_DATA;
1275
1276
0
  if (!dataLength)
1277
0
    return CHANNEL_RC_ZERO_LENGTH;
1278
1279
0
  if (pChannelOpenData->flags != 2)
1280
0
    return CHANNEL_RC_NOT_OPEN;
1281
1282
0
  pChannelOpenEvent = (CHANNEL_OPEN_EVENT*)malloc(sizeof(CHANNEL_OPEN_EVENT));
1283
1284
0
  if (!pChannelOpenEvent)
1285
0
    return CHANNEL_RC_NO_MEMORY;
1286
1287
0
  pChannelOpenEvent->Data = pData;
1288
0
  pChannelOpenEvent->DataLength = dataLength;
1289
0
  pChannelOpenEvent->UserData = pUserData;
1290
0
  pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1291
0
  message.context = channels;
1292
0
  message.id = 0;
1293
0
  message.wParam = pChannelOpenEvent;
1294
0
  message.lParam = NULL;
1295
0
  message.Free = channel_queue_message_free;
1296
1297
0
  if (!MessageQueue_Dispatch(channels->queue, &message))
1298
0
  {
1299
0
    free(pChannelOpenEvent);
1300
0
    return CHANNEL_RC_NO_MEMORY;
1301
0
  }
1302
1303
0
  return CHANNEL_RC_OK;
1304
0
}
1305
1306
static UINT VCAPITYPE FreeRDP_VirtualChannelWrite(DWORD openHandle, LPVOID pData, ULONG dataLength,
1307
                                                  LPVOID pUserData)
1308
0
{
1309
0
  wMessage message = { 0 };
1310
0
  CHANNEL_OPEN_DATA* pChannelOpenData = NULL;
1311
0
  CHANNEL_OPEN_EVENT* pChannelOpenEvent = NULL;
1312
0
  rdpChannels* channels = NULL;
1313
1314
0
  pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (void*)(UINT_PTR)openHandle);
1315
1316
0
  if (!pChannelOpenData)
1317
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1318
1319
0
  channels = pChannelOpenData->channels;
1320
0
  if (!channels)
1321
0
    return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1322
1323
0
  if (!channels->connected)
1324
0
    return CHANNEL_RC_NOT_CONNECTED;
1325
1326
0
  if (!pData)
1327
0
    return CHANNEL_RC_NULL_DATA;
1328
1329
0
  if (!dataLength)
1330
0
    return CHANNEL_RC_ZERO_LENGTH;
1331
1332
0
  if (pChannelOpenData->flags != 2)
1333
0
    return CHANNEL_RC_NOT_OPEN;
1334
1335
0
  pChannelOpenEvent = (CHANNEL_OPEN_EVENT*)malloc(sizeof(CHANNEL_OPEN_EVENT));
1336
1337
0
  if (!pChannelOpenEvent)
1338
0
    return CHANNEL_RC_NO_MEMORY;
1339
1340
0
  pChannelOpenEvent->Data = pData;
1341
0
  pChannelOpenEvent->DataLength = dataLength;
1342
0
  pChannelOpenEvent->UserData = pUserData;
1343
0
  pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1344
0
  message.context = channels;
1345
0
  message.id = 0;
1346
0
  message.wParam = pChannelOpenEvent;
1347
0
  message.lParam = NULL;
1348
0
  message.Free = channel_queue_message_free;
1349
1350
0
  if (!MessageQueue_Dispatch(channels->queue, &message))
1351
0
  {
1352
0
    free(pChannelOpenEvent);
1353
0
    return CHANNEL_RC_NO_MEMORY;
1354
0
  }
1355
1356
0
  return CHANNEL_RC_OK;
1357
0
}
1358
1359
static BOOL freerdp_channels_is_loaded(rdpChannels* channels, PVIRTUALCHANNELENTRY entry)
1360
0
{
1361
0
  for (int i = 0; i < channels->clientDataCount; i++)
1362
0
  {
1363
0
    CHANNEL_CLIENT_DATA* pChannelClientData = &channels->clientDataList[i];
1364
1365
0
    if (pChannelClientData->entry == entry)
1366
0
      return TRUE;
1367
0
  }
1368
1369
0
  return FALSE;
1370
0
}
1371
1372
static BOOL freerdp_channels_is_loaded_ex(rdpChannels* channels, PVIRTUALCHANNELENTRYEX entryEx)
1373
0
{
1374
0
  for (int i = 0; i < channels->clientDataCount; i++)
1375
0
  {
1376
0
    CHANNEL_CLIENT_DATA* pChannelClientData = &channels->clientDataList[i];
1377
1378
0
    if (pChannelClientData->entryEx == entryEx)
1379
0
      return TRUE;
1380
0
  }
1381
1382
0
  return FALSE;
1383
0
}
1384
1385
int freerdp_channels_client_load(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1386
                                 PVIRTUALCHANNELENTRY entry, void* data)
1387
0
{
1388
0
  int status = 0;
1389
0
  CHANNEL_ENTRY_POINTS_FREERDP EntryPoints = { 0 };
1390
0
  CHANNEL_CLIENT_DATA* pChannelClientData = NULL;
1391
1392
0
  WINPR_ASSERT(channels);
1393
0
  WINPR_ASSERT(channels->instance);
1394
0
  WINPR_ASSERT(channels->instance->context);
1395
0
  WINPR_ASSERT(entry);
1396
1397
0
  if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1398
0
  {
1399
0
    WLog_ERR(TAG, "error: too many channels");
1400
0
    return 1;
1401
0
  }
1402
1403
0
  if (freerdp_channels_is_loaded(channels, entry))
1404
0
  {
1405
0
    WLog_WARN(TAG, "Skipping, channel already loaded");
1406
0
    return 0;
1407
0
  }
1408
1409
0
  pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1410
0
  pChannelClientData->entry = entry;
1411
1412
0
  EntryPoints.cbSize = sizeof(EntryPoints);
1413
0
  EntryPoints.protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000;
1414
0
  EntryPoints.pVirtualChannelInit = FreeRDP_VirtualChannelInit;
1415
0
  EntryPoints.pVirtualChannelOpen = FreeRDP_VirtualChannelOpen;
1416
0
  EntryPoints.pVirtualChannelClose = FreeRDP_VirtualChannelClose;
1417
0
  EntryPoints.pVirtualChannelWrite = FreeRDP_VirtualChannelWrite;
1418
0
  EntryPoints.MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER;
1419
0
  EntryPoints.pExtendedData = data;
1420
0
  EntryPoints.context = channels->instance->context;
1421
  /* enable VirtualChannelInit */
1422
0
  channels->can_call_init = TRUE;
1423
0
  EnterCriticalSection(&channels->channelsLock);
1424
0
  status = pChannelClientData->entry((PCHANNEL_ENTRY_POINTS)&EntryPoints);
1425
0
  LeaveCriticalSection(&channels->channelsLock);
1426
  /* disable MyVirtualChannelInit */
1427
0
  channels->can_call_init = FALSE;
1428
1429
0
  if (!status)
1430
0
  {
1431
0
    WLog_ERR(TAG, "error: channel export function call failed");
1432
0
    return 1;
1433
0
  }
1434
1435
0
  return 0;
1436
0
}
1437
1438
int freerdp_channels_client_load_ex(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1439
                                    PVIRTUALCHANNELENTRYEX entryEx, void* data)
1440
0
{
1441
0
  int status = 0;
1442
0
  void* pInitHandle = NULL;
1443
0
  CHANNEL_ENTRY_POINTS_FREERDP_EX EntryPointsEx = { 0 };
1444
0
  CHANNEL_INIT_DATA* pChannelInitData = NULL;
1445
0
  CHANNEL_CLIENT_DATA* pChannelClientData = NULL;
1446
1447
0
  WINPR_ASSERT(channels);
1448
0
  WINPR_ASSERT(channels->instance);
1449
0
  WINPR_ASSERT(channels->instance->context);
1450
0
  WINPR_ASSERT(entryEx);
1451
1452
0
  if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1453
0
  {
1454
0
    WLog_ERR(TAG, "error: too many channels");
1455
0
    return 1;
1456
0
  }
1457
1458
0
  if (freerdp_channels_is_loaded_ex(channels, entryEx))
1459
0
  {
1460
0
    WLog_WARN(TAG, "Skipping, channel already loaded");
1461
0
    return 0;
1462
0
  }
1463
1464
0
  pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1465
0
  pChannelClientData->entryEx = entryEx;
1466
0
  pChannelInitData = &(channels->initDataList[channels->initDataCount++]);
1467
0
  pInitHandle = pChannelInitData;
1468
0
  pChannelInitData->channels = channels;
1469
0
  EntryPointsEx.cbSize = sizeof(EntryPointsEx);
1470
0
  EntryPointsEx.protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000;
1471
0
  EntryPointsEx.pVirtualChannelInitEx = FreeRDP_VirtualChannelInitEx;
1472
0
  EntryPointsEx.pVirtualChannelOpenEx = FreeRDP_VirtualChannelOpenEx;
1473
0
  EntryPointsEx.pVirtualChannelCloseEx = FreeRDP_VirtualChannelCloseEx;
1474
0
  EntryPointsEx.pVirtualChannelWriteEx = FreeRDP_VirtualChannelWriteEx;
1475
0
  EntryPointsEx.MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER;
1476
0
  EntryPointsEx.pExtendedData = data;
1477
0
  EntryPointsEx.context = channels->instance->context;
1478
  /* enable VirtualChannelInit */
1479
0
  channels->can_call_init = TRUE;
1480
0
  EnterCriticalSection(&channels->channelsLock);
1481
0
  status = pChannelClientData->entryEx((PCHANNEL_ENTRY_POINTS_EX)&EntryPointsEx, pInitHandle);
1482
0
  LeaveCriticalSection(&channels->channelsLock);
1483
  /* disable MyVirtualChannelInit */
1484
0
  channels->can_call_init = FALSE;
1485
1486
0
  if (!status)
1487
0
  {
1488
0
    WLog_ERR(TAG, "error: channel export function call failed");
1489
0
    return 1;
1490
0
  }
1491
1492
0
  return 0;
1493
0
}
1494
1495
/**
1496
 * this is called when processing the command line parameters
1497
 * called only from main thread
1498
 */
1499
int freerdp_channels_load_plugin(rdpChannels* channels, rdpSettings* settings, const char* name,
1500
                                 void* data)
1501
0
{
1502
0
  PVIRTUALCHANNELENTRY entry =
1503
0
      freerdp_load_channel_addin_entry(name, NULL, NULL, FREERDP_ADDIN_CHANNEL_STATIC);
1504
1505
0
  if (!entry)
1506
0
    return 1;
1507
1508
0
  return freerdp_channels_client_load(channels, settings, entry, data);
1509
0
}