FreeRDP
Loading...
Searching...
No Matches
client/rdpdr_main.c
1
25#include <freerdp/config.h>
26
27#include <stdio.h>
28#include <stdlib.h>
29#include <string.h>
30#include <stdint.h>
31
32#include <winpr/crt.h>
33#include <winpr/sysinfo.h>
34#include <winpr/assert.h>
35#include <winpr/stream.h>
36
37#include <winpr/print.h>
38#include <winpr/sspicli.h>
39
40#include <freerdp/types.h>
41#include <freerdp/freerdp.h>
42#include <freerdp/constants.h>
43#include <freerdp/channels/log.h>
44#include <freerdp/channels/rdpdr.h>
45#include <freerdp/utils/rdpdr_utils.h>
46
47#ifdef _WIN32
48#include <windows.h>
49#include <dbt.h>
50#else
51#include <sys/types.h>
52#include <sys/stat.h>
53#include <fcntl.h>
54#endif
55
56#ifdef __MACOSX__
57#include <CoreFoundation/CoreFoundation.h>
58#include <stdio.h>
59#include <dirent.h>
60#include <sys/types.h>
61#include <sys/stat.h>
62#include <unistd.h>
63#endif
64
65#include "rdpdr_capabilities.h"
66
67#include "devman.h"
68#include "irp.h"
69
70#include "rdpdr_main.h"
71
72#define TAG CHANNELS_TAG("rdpdr.client")
73
74/* IMPORTANT: Keep in sync with DRIVE_DEVICE */
75typedef struct
76{
77 DEVICE device;
78 WCHAR* path;
79 BOOL automount;
80} DEVICE_DRIVE_EXT;
81
82static const char* rdpdr_state_str(enum RDPDR_CHANNEL_STATE state)
83{
84 switch (state)
85 {
86 case RDPDR_CHANNEL_STATE_INITIAL:
87 return "RDPDR_CHANNEL_STATE_INITIAL";
88 case RDPDR_CHANNEL_STATE_ANNOUNCE:
89 return "RDPDR_CHANNEL_STATE_ANNOUNCE";
90 case RDPDR_CHANNEL_STATE_ANNOUNCE_REPLY:
91 return "RDPDR_CHANNEL_STATE_ANNOUNCE_REPLY";
92 case RDPDR_CHANNEL_STATE_NAME_REQUEST:
93 return "RDPDR_CHANNEL_STATE_NAME_REQUEST";
94 case RDPDR_CHANNEL_STATE_SERVER_CAPS:
95 return "RDPDR_CHANNEL_STATE_SERVER_CAPS";
96 case RDPDR_CHANNEL_STATE_CLIENT_CAPS:
97 return "RDPDR_CHANNEL_STATE_CLIENT_CAPS";
98 case RDPDR_CHANNEL_STATE_CLIENTID_CONFIRM:
99 return "RDPDR_CHANNEL_STATE_CLIENTID_CONFIRM";
100 case RDPDR_CHANNEL_STATE_READY:
101 return "RDPDR_CHANNEL_STATE_READY";
102 case RDPDR_CHANNEL_STATE_USER_LOGGEDON:
103 return "RDPDR_CHANNEL_STATE_USER_LOGGEDON";
104 default:
105 return "RDPDR_CHANNEL_STATE_UNKNOWN";
106 }
107}
108
109static const char* support_str(BOOL val)
110{
111 if (val)
112 return "supported";
113 return "not found";
114}
115
116static const char* rdpdr_caps_pdu_str(UINT32 flag)
117{
118 switch (flag)
119 {
120 case RDPDR_DEVICE_REMOVE_PDUS:
121 return "RDPDR_USER_LOGGEDON_PDU";
122 case RDPDR_CLIENT_DISPLAY_NAME_PDU:
123 return "RDPDR_CLIENT_DISPLAY_NAME_PDU";
124 case RDPDR_USER_LOGGEDON_PDU:
125 return "RDPDR_USER_LOGGEDON_PDU";
126 default:
127 return "RDPDR_UNKNONW";
128 }
129}
130
131static BOOL rdpdr_check_extended_pdu_flag(rdpdrPlugin* rdpdr, UINT32 flag)
132{
133 WINPR_ASSERT(rdpdr);
134
135 const BOOL client = (rdpdr->clientExtendedPDU & flag) != 0;
136 const BOOL server = (rdpdr->serverExtendedPDU & flag) != 0;
137
138 if (!client || !server)
139 {
140 WLog_Print(rdpdr->log, WLOG_WARN, "Checking ExtendedPDU::%s, client %s, server %s",
141 rdpdr_caps_pdu_str(flag), support_str(client), support_str(server));
142 return FALSE;
143 }
144 return TRUE;
145}
146
147BOOL rdpdr_state_advance(rdpdrPlugin* rdpdr, enum RDPDR_CHANNEL_STATE next)
148{
149 WINPR_ASSERT(rdpdr);
150
151 if (next != rdpdr->state)
152 WLog_Print(rdpdr->log, WLOG_DEBUG, "[RDPDR] transition from %s to %s",
153 rdpdr_state_str(rdpdr->state), rdpdr_state_str(next));
154 rdpdr->state = next;
155 return TRUE;
156}
157
158static BOOL device_foreach(rdpdrPlugin* rdpdr, BOOL abortOnFail,
159 BOOL (*fkt)(ULONG_PTR key, void* element, void* data), void* data)
160{
161 BOOL rc = TRUE;
162 ULONG_PTR* keys = nullptr;
163
164 ListDictionary_Lock(rdpdr->devman->devices);
165 const size_t count = ListDictionary_GetKeys(rdpdr->devman->devices, &keys);
166 for (size_t x = 0; x < count; x++)
167 {
168 void* element = ListDictionary_GetItemValue(rdpdr->devman->devices, (void*)keys[x]);
169 if (!fkt(keys[x], element, data))
170 {
171 rc = FALSE;
172 if (abortOnFail)
173 break;
174 }
175 }
176 free(keys);
177 ListDictionary_Unlock(rdpdr->devman->devices);
178 return rc;
179}
180
186static UINT rdpdr_try_send_device_list_announce_request(rdpdrPlugin* rdpdr);
187
188static BOOL rdpdr_load_drive(rdpdrPlugin* rdpdr, const char* name, const char* path, BOOL automount)
189{
190 UINT rc = ERROR_INTERNAL_ERROR;
191 union
192 {
193 RDPDR_DRIVE* drive;
194 RDPDR_DEVICE* device;
195 } drive;
196 const char* args[] = { name, path, automount ? nullptr : name };
197
198 drive.device = freerdp_device_new(RDPDR_DTYP_FILESYSTEM, ARRAYSIZE(args), args);
199 if (!drive.device)
200 goto fail;
201
202 WINPR_ASSERT(rdpdr->context.RdpdrRegisterDevice);
203 rc = rdpdr->context.RdpdrRegisterDevice(&rdpdr->context, drive.device, &drive.device->Id);
204 if (rc != CHANNEL_RC_OK)
205 goto fail;
206
207fail:
208 freerdp_device_free(drive.device);
209 return rc == CHANNEL_RC_OK;
210}
211
217static UINT rdpdr_send_device_list_remove_request(rdpdrPlugin* rdpdr, UINT32 count,
218 const UINT32 ids[])
219{
220 wStream* s = nullptr;
221
222 WINPR_ASSERT(rdpdr);
223 WINPR_ASSERT(ids || (count == 0));
224
225 if (count == 0)
226 return CHANNEL_RC_OK;
227
228 if (!rdpdr_check_extended_pdu_flag(rdpdr, RDPDR_DEVICE_REMOVE_PDUS))
229 return CHANNEL_RC_OK;
230
231 s = StreamPool_Take(rdpdr->pool, count * sizeof(UINT32) + 8);
232
233 if (!s)
234 {
235 WLog_Print(rdpdr->log, WLOG_ERROR, "Stream_New failed!");
236 return CHANNEL_RC_NO_MEMORY;
237 }
238
239 Stream_Write_UINT16(s, RDPDR_CTYP_CORE);
240 Stream_Write_UINT16(s, PAKID_CORE_DEVICELIST_REMOVE);
241 Stream_Write_UINT32(s, count);
242
243 for (UINT32 i = 0; i < count; i++)
244 Stream_Write_UINT32(s, ids[i]);
245
246 Stream_SealLength(s);
247 return rdpdr_send(rdpdr, s);
248}
249
250#if defined(_UWP) || defined(__IOS__)
251
252static UINT handle_hotplug(WINPR_ATTR_UNUSED RdpdrClientContext* context,
253 WINPR_ATTR_UNUSED RdpdrHotplugEventType type)
254{
255 return ERROR_CALL_NOT_IMPLEMENTED;
256}
257
258static void first_hotplug(WINPR_ATTR_UNUSED rdpdrPlugin* rdpdr)
259{
260}
261
262static DWORD WINAPI drive_hotplug_thread_func(WINPR_ATTR_UNUSED LPVOID arg)
263{
264 return CHANNEL_RC_OK;
265}
266
267static UINT drive_hotplug_thread_terminate(WINPR_ATTR_UNUSED rdpdrPlugin* rdpdr)
268{
269 return CHANNEL_RC_OK;
270}
271
272#elif defined(_WIN32)
273
274static UINT handle_hotplug(WINPR_ATTR_UNUSED RdpdrClientContext* context,
275 WINPR_ATTR_UNUSED RdpdrHotplugEventType type)
276{
277 return CHANNEL_RC_OK;
278}
279
280static BOOL check_path(const char* path)
281{
282 UINT type = GetDriveTypeA(path);
283
284 if (!(type == DRIVE_FIXED || type == DRIVE_REMOVABLE || type == DRIVE_CDROM ||
285 type == DRIVE_REMOTE))
286 return FALSE;
287
288 return GetVolumeInformationA(path, nullptr, 0, nullptr, nullptr, nullptr, nullptr, 0);
289}
290
291static void first_hotplug(rdpdrPlugin* rdpdr)
292{
293 DWORD unitmask = GetLogicalDrives();
294
295 for (size_t i = 0; i < 26; i++)
296 {
297 if (unitmask & 0x01)
298 {
299 char drive_path[] = { 'c', ':', '\\', '\0' };
300 char drive_name[] = { 'c', '\0' };
301 drive_path[0] = 'A' + (char)i;
302 drive_name[0] = 'A' + (char)i;
303
304 if (check_path(drive_path))
305 {
306 rdpdr_load_drive(rdpdr, drive_name, drive_path, TRUE);
307 }
308 }
309
310 unitmask = unitmask >> 1;
311 }
312}
313
314static LRESULT CALLBACK hotplug_proc(HWND hWnd, UINT Msg, WPARAM wParam, LPARAM lParam)
315{
316 rdpdrPlugin* rdpdr;
317 PDEV_BROADCAST_HDR lpdb = (PDEV_BROADCAST_HDR)lParam;
318 UINT error;
319 rdpdr = (rdpdrPlugin*)GetWindowLongPtr(hWnd, GWLP_USERDATA);
320
321 switch (Msg)
322 {
323 case WM_DEVICECHANGE:
324 switch (wParam)
325 {
326 case DBT_DEVICEARRIVAL:
327 if (lpdb->dbch_devicetype == DBT_DEVTYP_VOLUME)
328 {
329 PDEV_BROADCAST_VOLUME lpdbv = (PDEV_BROADCAST_VOLUME)lpdb;
330 DWORD unitmask = lpdbv->dbcv_unitmask;
331
332 for (int i = 0; i < 26; i++)
333 {
334 if (unitmask & 0x01)
335 {
336 char drive_path[] = { 'c', ':', '/', '\0' };
337 char drive_name[] = { 'c', '\0' };
338 drive_path[0] = 'A' + (char)i;
339 drive_name[0] = 'A' + (char)i;
340
341 if (check_path(drive_path))
342 {
343 rdpdr_load_drive(rdpdr, drive_name, drive_path, TRUE);
344 }
345 }
346
347 unitmask = unitmask >> 1;
348 }
349 }
350
351 break;
352
353 case DBT_DEVICEREMOVECOMPLETE:
354 if (lpdb->dbch_devicetype == DBT_DEVTYP_VOLUME)
355 {
356 PDEV_BROADCAST_VOLUME lpdbv = (PDEV_BROADCAST_VOLUME)lpdb;
357 DWORD unitmask = lpdbv->dbcv_unitmask;
358 char drive_name_upper, drive_name_lower;
359 ULONG_PTR* keys = nullptr;
360 DEVICE_DRIVE_EXT* device_ext;
361
362 for (int i = 0; i < 26; i++)
363 {
364 if (unitmask & 0x01)
365 {
366 drive_name_upper = 'A' + i;
367 drive_name_lower = 'a' + i;
368 const size_t count =
369 ListDictionary_GetKeys(rdpdr->devman->devices, &keys);
370
371 for (size_t j = 0; j < count; j++)
372 {
373 device_ext = (DEVICE_DRIVE_EXT*)ListDictionary_GetItemValue(
374 rdpdr->devman->devices, (void*)keys[j]);
375
376 if (device_ext->device.type != RDPDR_DTYP_FILESYSTEM)
377 continue;
378
379 if (device_ext->path[0] == drive_name_upper ||
380 device_ext->path[0] == drive_name_lower)
381 {
382 if (device_ext->automount)
383 {
384 const uint32_t ids[] = { (uint32_t)keys[j] };
385 WINPR_ASSERT(rdpdr->context.RdpdrUnregisterDevice);
386 error = rdpdr->context.RdpdrUnregisterDevice(
387 &rdpdr->context, ARRAYSIZE(ids), ids);
388 if (error)
389 {
390 // don't end on error, just report ?
391 WLog_Print(
392 rdpdr->log, WLOG_ERROR,
393 "rdpdr_send_device_list_remove_request failed "
394 "with error %" PRIu32 "!",
395 error);
396 }
397
398 break;
399 }
400 }
401 }
402
403 free(keys);
404 }
405
406 unitmask = unitmask >> 1;
407 }
408 }
409
410 break;
411
412 default:
413 break;
414 }
415
416 break;
417
418 default:
419 return DefWindowProc(hWnd, Msg, wParam, lParam);
420 }
421
422 return DefWindowProc(hWnd, Msg, wParam, lParam);
423}
424
425static DWORD WINAPI drive_hotplug_thread_func(LPVOID arg)
426{
427 rdpdrPlugin* rdpdr;
428 WNDCLASSEX wnd_cls;
429 HWND hwnd;
430 MSG msg;
431 BOOL bRet;
432 DEV_BROADCAST_HANDLE NotificationFilter;
433 HDEVNOTIFY hDevNotify;
434 rdpdr = (rdpdrPlugin*)arg;
435 /* init windows class */
436 wnd_cls.cbSize = sizeof(WNDCLASSEX);
437 wnd_cls.style = CS_HREDRAW | CS_VREDRAW;
438 wnd_cls.lpfnWndProc = hotplug_proc;
439 wnd_cls.cbClsExtra = 0;
440 wnd_cls.cbWndExtra = 0;
441 wnd_cls.hIcon = LoadIcon(nullptr, IDI_APPLICATION);
442 wnd_cls.hCursor = nullptr;
443 wnd_cls.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH);
444 wnd_cls.lpszMenuName = nullptr;
445 wnd_cls.lpszClassName = L"DRIVE_HOTPLUG";
446 wnd_cls.hInstance = nullptr;
447 wnd_cls.hIconSm = LoadIcon(nullptr, IDI_APPLICATION);
448 RegisterClassEx(&wnd_cls);
449 /* create window */
450 hwnd = CreateWindowEx(0, L"DRIVE_HOTPLUG", nullptr, 0, 0, 0, 0, 0, nullptr, nullptr, nullptr,
451 nullptr);
452 SetWindowLongPtr(hwnd, GWLP_USERDATA, (LONG_PTR)rdpdr);
453 rdpdr->hotplug_wnd = hwnd;
454 /* register device interface to hwnd */
455 NotificationFilter.dbch_size = sizeof(DEV_BROADCAST_HANDLE);
456 NotificationFilter.dbch_devicetype = DBT_DEVTYP_HANDLE;
457 hDevNotify = RegisterDeviceNotification(hwnd, &NotificationFilter, DEVICE_NOTIFY_WINDOW_HANDLE);
458
459 /* message loop */
460 while ((bRet = GetMessage(&msg, 0, 0, 0)) != 0)
461 {
462 if (bRet == -1)
463 {
464 break;
465 }
466 else
467 {
468 TranslateMessage(&msg);
469 DispatchMessage(&msg);
470 }
471 }
472
473 UnregisterDeviceNotification(hDevNotify);
474 return CHANNEL_RC_OK;
475}
476
482static UINT drive_hotplug_thread_terminate(rdpdrPlugin* rdpdr)
483{
484 UINT error = CHANNEL_RC_OK;
485
486 if (rdpdr->hotplug_wnd && !PostMessage(rdpdr->hotplug_wnd, WM_QUIT, 0, 0))
487 {
488 error = GetLastError();
489 WLog_Print(rdpdr->log, WLOG_ERROR, "PostMessage failed with error %" PRIu32 "", error);
490 }
491
492 return error;
493}
494
495#elif defined(__MACOSX__)
496
497#define MAX_USB_DEVICES 100
498
499typedef struct
500{
501 char* path;
502 BOOL to_add;
503} hotplug_dev;
504
510static UINT handle_hotplug(WINPR_ATTR_UNUSED RdpdrClientContext* context,
511 WINPR_ATTR_UNUSED RdpdrHotplugEventType type)
512{
513 WINPR_ASSERT(context);
514 rdpdrPlugin* rdpdr = context->handle;
515
516 struct dirent* pDirent = nullptr;
517 char fullpath[PATH_MAX] = WINPR_C_ARRAY_INIT;
518 char* szdir = (char*)"/Volumes";
519 struct stat buf = WINPR_C_ARRAY_INIT;
520 hotplug_dev dev_array[MAX_USB_DEVICES] = WINPR_C_ARRAY_INIT;
521 int count = 0;
522 DEVICE_DRIVE_EXT* device_ext = nullptr;
523 ULONG_PTR* keys = nullptr;
524 int size = 0;
525 UINT error = ERROR_INTERNAL_ERROR;
526
527 DIR* pDir = opendir(szdir);
528
529 if (pDir == nullptr)
530 {
531 printf("Cannot open directory\n");
532 return ERROR_OPEN_FAILED;
533 }
534
535 while ((pDirent = readdir(pDir)) != nullptr)
536 {
537 if (pDirent->d_name[0] != '.')
538 {
539 (void)sprintf_s(fullpath, ARRAYSIZE(fullpath), "%s/%s", szdir, pDirent->d_name);
540 if (stat(fullpath, &buf) != 0)
541 continue;
542
543 if (S_ISDIR(buf.st_mode))
544 {
545 dev_array[size].path = _strdup(fullpath);
546
547 if (!dev_array[size].path)
548 {
549 closedir(pDir);
550 error = CHANNEL_RC_NO_MEMORY;
551 goto cleanup;
552 }
553
554 dev_array[size++].to_add = TRUE;
555 }
556 }
557 }
558
559 closedir(pDir);
560 /* delete removed devices */
561 count = ListDictionary_GetKeys(rdpdr->devman->devices, &keys);
562
563 for (size_t j = 0; j < count; j++)
564 {
565 char* path = nullptr;
566 BOOL dev_found = FALSE;
567 device_ext =
568 (DEVICE_DRIVE_EXT*)ListDictionary_GetItemValue(rdpdr->devman->devices, (void*)keys[j]);
569
570 if (!device_ext || !device_ext->automount)
571 continue;
572
573 if (device_ext->device.type != RDPDR_DTYP_FILESYSTEM)
574 continue;
575
576 if (device_ext->path == nullptr)
577 continue;
578
579 path = ConvertWCharToUtf8Alloc(device_ext->path, nullptr);
580 if (!path)
581 continue;
582
583 /* not pluggable device */
584 if (strstr(path, "/Volumes/") == nullptr)
585 {
586 free(path);
587 continue;
588 }
589
590 for (size_t i = 0; i < size; i++)
591 {
592 if (strstr(path, dev_array[i].path) != nullptr)
593 {
594 dev_found = TRUE;
595 dev_array[i].to_add = FALSE;
596 break;
597 }
598 }
599
600 free(path);
601
602 if (!dev_found)
603 {
604 const uint32_t ids[] = { (uint32_t)keys[j] };
605 WINPR_ASSERT(rdpdr->context.RdpdrUnregisterDevice);
606 error = rdpdr->context.RdpdrUnregisterDevice(&rdpdr->context, ARRAYSIZE(ids), ids);
607 if (error)
608 {
609 WLog_Print(rdpdr->log, WLOG_ERROR,
610 "rdpdr_send_device_list_remove_request failed with error %" PRIu32 "!",
611 error);
612 goto cleanup;
613 }
614 }
615 }
616
617 /* add new devices */
618 for (size_t i = 0; i < size; i++)
619 {
620 const hotplug_dev* dev = &dev_array[i];
621 if (dev->to_add)
622 {
623 const char* path = dev->path;
624 const char* name = strrchr(path, '/') + 1;
625 error = rdpdr_load_drive(rdpdr, name, path, TRUE);
626 if (error)
627 goto cleanup;
628 }
629 }
630
631cleanup:
632 free(keys);
633
634 for (size_t i = 0; i < size; i++)
635 free(dev_array[i].path);
636
637 return error;
638}
639
640static void drive_hotplug_fsevent_callback(ConstFSEventStreamRef streamRef,
641 void* clientCallBackInfo, size_t numEvents,
642 void* eventPaths,
643 const FSEventStreamEventFlags eventFlags[],
644 const FSEventStreamEventId eventIds[])
645{
646 rdpdrPlugin* rdpdr;
647 UINT error;
648 char** paths = (char**)eventPaths;
649 rdpdr = (rdpdrPlugin*)clientCallBackInfo;
650
651 for (size_t i = 0; i < numEvents; i++)
652 {
653 if (strcmp(paths[i], "/Volumes/") == 0)
654 {
655 UINT error = ERROR_CALL_NOT_IMPLEMENTED;
656 if (rdpdr->context.RdpdrHotplugDevice)
657 error = rdpdr->context.RdpdrHotplugDevice(&rdpdr->context,
658 RDPDR_HOTPLUG_CHECK_FOR_CHANGES);
659 switch (error)
660 {
661 case ERROR_DISK_CHANGE:
662 case CHANNEL_RC_OK:
663 break;
664 case ERROR_CALL_NOT_IMPLEMENTED:
665 break;
666 default:
667 WLog_Print(rdpdr->log, WLOG_ERROR,
668 "handle_hotplug failed with error %" PRIu32 "!", error);
669 break;
670 }
671 }
672 }
673}
674
675static void first_hotplug(rdpdrPlugin* rdpdr)
676{
677 WINPR_ASSERT(rdpdr);
678 UINT error = ERROR_CALL_NOT_IMPLEMENTED;
679 if (rdpdr->context.RdpdrHotplugDevice)
680 error = rdpdr->context.RdpdrHotplugDevice(&rdpdr->context, RDPDR_HOTPLUG_FIRST_CHECK);
681
682 switch (error)
683 {
684 case ERROR_DISK_CHANGE:
685 case CHANNEL_RC_OK:
686 case ERROR_CALL_NOT_IMPLEMENTED:
687 break;
688 default:
689 WLog_Print(rdpdr->log, WLOG_ERROR, "handle_hotplug failed with error %" PRIu32 "!",
690 error);
691 break;
692 }
693}
694
695static DWORD WINAPI drive_hotplug_thread_func(LPVOID arg)
696{
697 rdpdrPlugin* rdpdr = (rdpdrPlugin*)arg;
698 WINPR_ASSERT(rdpdr);
699 WINPR_ASSERT(rdpdr->stopEvent);
700
701 CFStringRef path = CFSTR("/Volumes/");
702 CFArrayRef pathsToWatch = CFArrayCreate(kCFAllocatorMalloc, (const void**)&path, 1, nullptr);
703 FSEventStreamContext ctx = {
704 .copyDescription = nullptr, .info = arg, .release = nullptr, .retain = nullptr, .version = 0
705 };
706 FSEventStreamRef fsev =
707 FSEventStreamCreate(kCFAllocatorMalloc, drive_hotplug_fsevent_callback, &ctx, pathsToWatch,
708 kFSEventStreamEventIdSinceNow, 1, kFSEventStreamCreateFlagNone);
709
710 dispatch_queue_t queue = dispatch_queue_create(TAG, nullptr);
711 FSEventStreamSetDispatchQueue(fsev, queue);
712 FSEventStreamStart(fsev);
713 WLog_Print(rdpdr->log, WLOG_DEBUG, "Started hotplug watcher");
714 HANDLE handles[] = { rdpdr->stopEvent, freerdp_abort_event(rdpdr->rdpcontext) };
715 const DWORD status = WaitForMultipleObjects(ARRAYSIZE(handles), handles, FALSE, INFINITE);
716 WLog_Print(rdpdr->log, WLOG_DEBUG, "Stopped hotplug watcher");
717 FSEventStreamStop(fsev);
718 FSEventStreamRelease(fsev);
719 dispatch_release(queue);
720
721 UINT error = CHANNEL_RC_OK;
722 if (status > WAIT_OBJECT_0 + ARRAYSIZE(handles))
723 error = ERROR_INTERNAL_ERROR;
724 ExitThread(error);
725 return error;
726}
727
728#else
729
730static const char* automountLocations[] = { "/run/user/%lu/gvfs", "/run/media/%s", "/media/%s",
731 "/media", "/mnt" };
732
733static BOOL isAutomountLocation(const char* path)
734{
735 const size_t nrLocations = sizeof(automountLocations) / sizeof(automountLocations[0]);
736 char buffer[MAX_PATH] = WINPR_C_ARRAY_INIT;
737 uid_t uid = getuid();
738 char uname[MAX_PATH] = WINPR_C_ARRAY_INIT;
739 ULONG size = sizeof(uname) - 1;
740
741 if (!GetUserNameExA(NameSamCompatible, uname, &size))
742 return FALSE;
743
744 if (!path)
745 return FALSE;
746
747 for (size_t x = 0; x < nrLocations; x++)
748 {
749 const char* location = automountLocations[x];
750 size_t length = 0;
751
752 WINPR_PRAGMA_DIAG_PUSH
753 WINPR_PRAGMA_DIAG_IGNORED_FORMAT_NONLITERAL
754 if (strstr(location, "%lu"))
755 (void)snprintf(buffer, sizeof(buffer), location, (unsigned long)uid);
756 else if (strstr(location, "%s"))
757 (void)snprintf(buffer, sizeof(buffer), location, uname);
758 else
759 (void)snprintf(buffer, sizeof(buffer), "%s", location);
760 WINPR_PRAGMA_DIAG_POP
761
762 length = strnlen(buffer, sizeof(buffer));
763
764 if (strncmp(buffer, path, length) == 0)
765 {
766 const char* rest = &path[length];
767
768 /* Only consider mount locations with max depth of 1 below the
769 * base path or the base path itself. */
770 if (*rest == '\0')
771 return TRUE;
772 else if (*rest == '/')
773 {
774 const char* token = strstr(&rest[1], "/");
775
776 if (!token || (token[1] == '\0'))
777 return TRUE;
778 }
779 }
780 }
781
782 return FALSE;
783}
784
785#define MAX_USB_DEVICES 100
786
787typedef struct
788{
789 char* path;
790 BOOL to_add;
791} hotplug_dev;
792
793static void handle_mountpoint(hotplug_dev* dev_array, size_t* size, const char* mountpoint)
794{
795 if (!mountpoint)
796 return;
797 /* copy hotpluged device mount point to the dev_array */
798 if (isAutomountLocation(mountpoint) && (*size < MAX_USB_DEVICES))
799 {
800 dev_array[*size].path = _strdup(mountpoint);
801 dev_array[*size].to_add = TRUE;
802 (*size)++;
803 }
804}
805
806#ifdef __sun
807#include <sys/mnttab.h>
808static UINT handle_platform_mounts_sun(wLog* log, hotplug_dev* dev_array, size_t* size)
809{
810 FILE* f;
811 struct mnttab ent;
812 f = winpr_fopen("/etc/mnttab", "r");
813 if (f == nullptr)
814 {
815 WLog_Print(log, WLOG_ERROR, "fopen failed!");
816 return ERROR_OPEN_FAILED;
817 }
818 while (getmntent(f, &ent) == 0)
819 {
820 handle_mountpoint(dev_array, size, ent.mnt_mountp);
821 }
822 fclose(f);
823 return ERROR_SUCCESS;
824}
825#endif
826
827#if defined(__FreeBSD__) || defined(__OpenBSD__)
828#include <sys/mount.h>
829static UINT handle_platform_mounts_bsd(wLog* log, hotplug_dev* dev_array, size_t* size)
830{
831 int mntsize;
832 struct statfs* mntbuf = nullptr;
833
834 mntsize = getmntinfo(&mntbuf, MNT_NOWAIT);
835 if (!mntsize)
836 {
837 /* TODO: handle 'errno' */
838 WLog_Print(log, WLOG_ERROR, "getmntinfo failed!");
839 return ERROR_OPEN_FAILED;
840 }
841 for (size_t idx = 0; idx < (size_t)mntsize; idx++)
842 {
843 handle_mountpoint(dev_array, size, mntbuf[idx].f_mntonname);
844 }
845 free(mntbuf);
846 return ERROR_SUCCESS;
847}
848#endif
849
850#if defined(__LINUX__) || defined(__linux__)
851#include <mntent.h>
852static struct mntent* getmntent_x(FILE* f, struct mntent* buffer, char* pathbuffer,
853 size_t pathbuffersize)
854{
855#if defined(FREERDP_HAVE_GETMNTENT_R)
856 WINPR_ASSERT(pathbuffersize <= INT32_MAX);
857 return getmntent_r(f, buffer, pathbuffer, (int)pathbuffersize);
858#else
859 (void)buffer;
860 (void)pathbuffer;
861 (void)pathbuffersize;
862 return getmntent(f);
863#endif
864}
865
866static UINT handle_platform_mounts_linux(wLog* log, hotplug_dev* dev_array, size_t* size)
867{
868 FILE* f = nullptr;
869 struct mntent mnt = WINPR_C_ARRAY_INIT;
870 char pathbuffer[PATH_MAX] = WINPR_C_ARRAY_INIT;
871 struct mntent* ent = nullptr;
872 f = winpr_fopen("/proc/mounts", "r");
873 if (f == nullptr)
874 {
875 WLog_Print(log, WLOG_ERROR, "fopen failed!");
876 return ERROR_OPEN_FAILED;
877 }
878 while ((ent = getmntent_x(f, &mnt, pathbuffer, sizeof(pathbuffer))) != nullptr)
879 {
880 handle_mountpoint(dev_array, size, ent->mnt_dir);
881 }
882 (void)fclose(f);
883 return ERROR_SUCCESS;
884}
885#endif
886
887static UINT handle_platform_mounts(wLog* log, hotplug_dev* dev_array, size_t* size)
888{
889#ifdef __sun
890 return handle_platform_mounts_sun(log, dev_array, size);
891#elif defined(__FreeBSD__) || defined(__OpenBSD__)
892 return handle_platform_mounts_bsd(log, dev_array, size);
893#elif defined(__LINUX__) || defined(__linux__)
894 return handle_platform_mounts_linux(log, dev_array, size);
895#endif
896 return ERROR_CALL_NOT_IMPLEMENTED;
897}
898
899static BOOL device_not_plugged(ULONG_PTR key, void* element, void* data)
900{
901 const WCHAR* path = (const WCHAR*)data;
902 DEVICE_DRIVE_EXT* device_ext = (DEVICE_DRIVE_EXT*)element;
903
904 WINPR_UNUSED(key);
905 WINPR_ASSERT(path);
906
907 if (!device_ext || (device_ext->device.type != RDPDR_DTYP_FILESYSTEM) || !device_ext->path)
908 return TRUE;
909 if (_wcscmp(device_ext->path, path) != 0)
910 return TRUE;
911 return FALSE;
912}
913
914static BOOL device_already_plugged(rdpdrPlugin* rdpdr, const hotplug_dev* device)
915{
916 BOOL rc = FALSE;
917 WCHAR* path = nullptr;
918
919 if (!rdpdr || !device)
920 return TRUE;
921 if (!device->to_add)
922 return TRUE;
923
924 WINPR_ASSERT(rdpdr->devman);
925 WINPR_ASSERT(device->path);
926
927 path = ConvertUtf8ToWCharAlloc(device->path, nullptr);
928 if (!path)
929 return TRUE;
930
931 rc = device_foreach(rdpdr, TRUE, device_not_plugged, path);
932 free(path);
933 return !rc;
934}
935
936struct hotplug_delete_arg
937{
938 hotplug_dev* dev_array;
939 size_t dev_array_size;
940 rdpdrPlugin* rdpdr;
941};
942
943static BOOL hotplug_delete_foreach(ULONG_PTR key, void* element, void* data)
944{
945 char* path = nullptr;
946 BOOL dev_found = FALSE;
947 struct hotplug_delete_arg* arg = (struct hotplug_delete_arg*)data;
948 DEVICE_DRIVE_EXT* device_ext = (DEVICE_DRIVE_EXT*)element;
949
950 WINPR_ASSERT(arg);
951 WINPR_ASSERT(arg->rdpdr);
952 WINPR_ASSERT(arg->dev_array || (arg->dev_array_size == 0));
953 WINPR_ASSERT(key <= UINT32_MAX);
954
955 if (!device_ext || (device_ext->device.type != RDPDR_DTYP_FILESYSTEM) || !device_ext->path ||
956 !device_ext->automount)
957 return TRUE;
958
959 WINPR_ASSERT(device_ext->path);
960 path = ConvertWCharToUtf8Alloc(device_ext->path, nullptr);
961 if (!path)
962 return FALSE;
963
964 /* not pluggable device */
965 if (isAutomountLocation(path))
966 {
967 for (size_t i = 0; i < arg->dev_array_size; i++)
968 {
969 hotplug_dev* cur = &arg->dev_array[i];
970 if (cur->path && strstr(path, cur->path) != nullptr)
971 {
972 dev_found = TRUE;
973 cur->to_add = FALSE;
974 break;
975 }
976 }
977 }
978
979 free(path);
980
981 if (!dev_found)
982 {
983 const UINT32 ids[1] = { (UINT32)key };
984 WINPR_ASSERT(arg->rdpdr->context.RdpdrUnregisterDevice);
985 const UINT error =
986 arg->rdpdr->context.RdpdrUnregisterDevice(&arg->rdpdr->context, ARRAYSIZE(ids), ids);
987
988 if (error)
989 {
990 WLog_Print(arg->rdpdr->log, WLOG_ERROR,
991 "rdpdr_send_device_list_remove_request failed with error %" PRIu32 "!",
992 error);
993 return FALSE;
994 }
995 }
996
997 return TRUE;
998}
999
1000static UINT handle_hotplug(RdpdrClientContext* context,
1001 WINPR_ATTR_UNUSED RdpdrHotplugEventType type)
1002{
1003 WINPR_ASSERT(context);
1004 rdpdrPlugin* rdpdr = context->handle;
1005
1006 hotplug_dev dev_array[MAX_USB_DEVICES] = WINPR_C_ARRAY_INIT;
1007 size_t size = 0;
1008 UINT error = ERROR_SUCCESS;
1009 struct hotplug_delete_arg arg = { dev_array, ARRAYSIZE(dev_array), rdpdr };
1010
1011 WINPR_ASSERT(rdpdr);
1012 WINPR_ASSERT(rdpdr->devman);
1013
1014 error = handle_platform_mounts(rdpdr->log, dev_array, &size);
1015
1016 /* delete removed devices */
1017 /* Ignore result */ device_foreach(rdpdr, FALSE, hotplug_delete_foreach, &arg);
1018
1019 /* add new devices */
1020 for (size_t i = 0; i < size; i++)
1021 {
1022 hotplug_dev* cur = &dev_array[i];
1023 if (!device_already_plugged(rdpdr, cur))
1024 {
1025 const char* path = cur->path;
1026 const char* name = strrchr(path, '/') + 1;
1027
1028 rdpdr_load_drive(rdpdr, name, path, TRUE);
1029 error = ERROR_DISK_CHANGE;
1030 }
1031 }
1032
1033 for (size_t i = 0; i < size; i++)
1034 free(dev_array[i].path);
1035
1036 return error;
1037}
1038
1039static void first_hotplug(rdpdrPlugin* rdpdr)
1040{
1041 UINT error = ERROR_CALL_NOT_IMPLEMENTED;
1042
1043 WINPR_ASSERT(rdpdr);
1044 if (rdpdr->context.RdpdrHotplugDevice)
1045 error = rdpdr->context.RdpdrHotplugDevice(&rdpdr->context, RDPDR_HOTPLUG_FIRST_CHECK);
1046
1047 switch (error)
1048 {
1049 case ERROR_DISK_CHANGE:
1050 case CHANNEL_RC_OK:
1051 case ERROR_OPEN_FAILED:
1052 case ERROR_CALL_NOT_IMPLEMENTED:
1053 break;
1054 default:
1055 WLog_Print(rdpdr->log, WLOG_ERROR, "handle_hotplug failed with error %" PRIu32 "!",
1056 error);
1057 break;
1058 }
1059}
1060
1061static DWORD WINAPI drive_hotplug_thread_func(LPVOID arg)
1062{
1063 rdpdrPlugin* rdpdr = (rdpdrPlugin*)arg;
1064
1065 WINPR_ASSERT(rdpdr);
1066 WINPR_ASSERT(rdpdr->stopEvent);
1067
1068 while (WaitForSingleObject(rdpdr->stopEvent, 1000) == WAIT_TIMEOUT)
1069 {
1070 UINT error = ERROR_CALL_NOT_IMPLEMENTED;
1071 if (rdpdr->context.RdpdrHotplugDevice)
1072 error =
1073 rdpdr->context.RdpdrHotplugDevice(&rdpdr->context, RDPDR_HOTPLUG_CHECK_FOR_CHANGES);
1074 switch (error)
1075 {
1076 case ERROR_DISK_CHANGE:
1077 break;
1078 case CHANNEL_RC_OK:
1079 case ERROR_OPEN_FAILED:
1080 case ERROR_CALL_NOT_IMPLEMENTED:
1081 break;
1082 default:
1083 WLog_Print(rdpdr->log, WLOG_ERROR, "handle_hotplug failed with error %" PRIu32 "!",
1084 error);
1085 goto out;
1086 }
1087 }
1088
1089out:
1090{
1091 const UINT error = GetLastError();
1092 if (error && rdpdr->rdpcontext)
1093 setChannelError(rdpdr->rdpcontext, error, "reported an error");
1094
1095 ExitThread(error);
1096 return error;
1097}
1098}
1099
1100#endif
1101
1102#if !defined(_WIN32) && !defined(__IOS__)
1108static UINT drive_hotplug_thread_terminate(rdpdrPlugin* rdpdr)
1109{
1110 UINT error = 0;
1111
1112 WINPR_ASSERT(rdpdr);
1113
1114 if (rdpdr->hotplugThread)
1115 {
1116#if !defined(_WIN32)
1117 if (rdpdr->stopEvent)
1118 (void)SetEvent(rdpdr->stopEvent);
1119#endif
1120
1121 if (WaitForSingleObject(rdpdr->hotplugThread, INFINITE) == WAIT_FAILED)
1122 {
1123 error = GetLastError();
1124 WLog_Print(rdpdr->log, WLOG_ERROR, "WaitForSingleObject failed with error %" PRIu32 "!",
1125 error);
1126 return error;
1127 }
1128
1129 (void)CloseHandle(rdpdr->hotplugThread);
1130 rdpdr->hotplugThread = nullptr;
1131 }
1132
1133 return CHANNEL_RC_OK;
1134}
1135
1136#endif
1137
1138static UINT rdpdr_add_devices(rdpdrPlugin* rdpdr)
1139{
1140 WINPR_ASSERT(rdpdr);
1141 WINPR_ASSERT(rdpdr->rdpcontext);
1142
1143 rdpSettings* settings = rdpdr->rdpcontext->settings;
1144 WINPR_ASSERT(settings);
1145
1146 for (UINT32 index = 0; index < freerdp_settings_get_uint32(settings, FreeRDP_DeviceCount);
1147 index++)
1148 {
1149 RDPDR_DEVICE* device =
1150 freerdp_settings_get_pointer_array_writable(settings, FreeRDP_DeviceArray, index);
1151 WINPR_ASSERT(device);
1152
1153 if (device->Type == RDPDR_DTYP_FILESYSTEM)
1154 {
1155 const char DynamicDrives[] = "DynamicDrives";
1156 const RDPDR_DRIVE* drive = (const RDPDR_DRIVE*)device;
1157 if (!drive->Path)
1158 continue;
1159
1160 const char wildcard[] = "*";
1161 BOOL hotplugAll = strncmp(drive->Path, wildcard, sizeof(wildcard)) == 0;
1162 BOOL hotplugLater = strncmp(drive->Path, DynamicDrives, sizeof(DynamicDrives)) == 0;
1163
1164 if (hotplugAll || hotplugLater)
1165 {
1166 if (!rdpdr->async)
1167 {
1168 WLog_Print(rdpdr->log, WLOG_WARN,
1169 "Drive hotplug is not supported in synchronous mode!");
1170 continue;
1171 }
1172
1173 if (hotplugAll)
1174 first_hotplug(rdpdr);
1175
1176 /* There might be multiple hotplug related device entries.
1177 * Ensure the thread is only started once
1178 */
1179 if (!rdpdr->hotplugThread)
1180 {
1181 rdpdr->hotplugThread =
1182 CreateThread(nullptr, 0, drive_hotplug_thread_func, rdpdr, 0, nullptr);
1183 if (!rdpdr->hotplugThread)
1184 {
1185 WLog_Print(rdpdr->log, WLOG_ERROR, "CreateThread failed!");
1186 return ERROR_INTERNAL_ERROR;
1187 }
1188 }
1189
1190 continue;
1191 }
1192 }
1193
1194 const UINT error = devman_load_device_service(rdpdr->devman, device, rdpdr->rdpcontext);
1195 if (error)
1196 {
1197 WLog_Print(rdpdr->log, WLOG_ERROR,
1198 "devman_load_device_service failed with error %" PRIu32 "!", error);
1199 return error;
1200 }
1201 }
1202 return CHANNEL_RC_OK;
1203}
1204
1210static UINT rdpdr_process_connect(rdpdrPlugin* rdpdr)
1211{
1212 WINPR_ASSERT(rdpdr);
1213
1214 rdpdr->devman = devman_new(rdpdr);
1215
1216 if (!rdpdr->devman)
1217 {
1218 WLog_Print(rdpdr->log, WLOG_ERROR, "devman_new failed!");
1219 return CHANNEL_RC_NO_MEMORY;
1220 }
1221
1222 WINPR_ASSERT(rdpdr->rdpcontext);
1223
1224 rdpSettings* settings = rdpdr->rdpcontext->settings;
1225 WINPR_ASSERT(settings);
1226
1227 rdpdr->ignoreInvalidDevices = freerdp_settings_get_bool(settings, FreeRDP_IgnoreInvalidDevices);
1228
1229 const char* name = freerdp_settings_get_string(settings, FreeRDP_ClientHostname);
1230 if (!name)
1231 name = freerdp_settings_get_string(settings, FreeRDP_ComputerName);
1232 if (!name)
1233 {
1234 DWORD size = ARRAYSIZE(rdpdr->computerName);
1235 if (!GetComputerNameExA(ComputerNameNetBIOS, rdpdr->computerName, &size))
1236 return ERROR_INTERNAL_ERROR;
1237 }
1238 else
1239 strncpy(rdpdr->computerName, name, strnlen(name, sizeof(rdpdr->computerName)));
1240
1241 return rdpdr_add_devices(rdpdr);
1242}
1243
1244static UINT rdpdr_process_server_announce_request(rdpdrPlugin* rdpdr, wStream* s)
1245{
1246 WINPR_ASSERT(rdpdr);
1247 WINPR_ASSERT(s);
1248
1249 if (!Stream_CheckAndLogRequiredLengthWLog(rdpdr->log, s, 8))
1250 return ERROR_INVALID_DATA;
1251
1252 Stream_Read_UINT16(s, rdpdr->serverVersionMajor);
1253 Stream_Read_UINT16(s, rdpdr->serverVersionMinor);
1254 Stream_Read_UINT32(s, rdpdr->clientID);
1255 rdpdr->sequenceId++;
1256
1257 rdpdr->clientVersionMajor = MIN(RDPDR_VERSION_MAJOR, rdpdr->serverVersionMajor);
1258 rdpdr->clientVersionMinor = MIN(RDPDR_VERSION_MINOR_RDP10X, rdpdr->serverVersionMinor);
1259 WLog_Print(rdpdr->log, WLOG_DEBUG,
1260 "[rdpdr] server announces version %" PRIu32 ".%" PRIu32 ", client uses %" PRIu32
1261 ".%" PRIu32,
1262 rdpdr->serverVersionMajor, rdpdr->serverVersionMinor, rdpdr->clientVersionMajor,
1263 rdpdr->clientVersionMinor);
1264 return CHANNEL_RC_OK;
1265}
1266
1272static UINT rdpdr_send_client_announce_reply(rdpdrPlugin* rdpdr)
1273{
1274 WINPR_ASSERT(rdpdr);
1275 WINPR_ASSERT(rdpdr->state == RDPDR_CHANNEL_STATE_ANNOUNCE);
1276 if (!rdpdr_state_advance(rdpdr, RDPDR_CHANNEL_STATE_ANNOUNCE_REPLY))
1277 return ERROR_INVALID_STATE;
1278
1279 wStream* s = StreamPool_Take(rdpdr->pool, 12);
1280
1281 if (!s)
1282 {
1283 WLog_Print(rdpdr->log, WLOG_ERROR, "Stream_New failed!");
1284 return CHANNEL_RC_NO_MEMORY;
1285 }
1286
1287 Stream_Write_UINT16(s, RDPDR_CTYP_CORE); /* Component (2 bytes) */
1288 Stream_Write_UINT16(s, PAKID_CORE_CLIENTID_CONFIRM); /* PacketId (2 bytes) */
1289 Stream_Write_UINT16(s, rdpdr->clientVersionMajor);
1290 Stream_Write_UINT16(s, rdpdr->clientVersionMinor);
1291 Stream_Write_UINT32(s, rdpdr->clientID);
1292 return rdpdr_send(rdpdr, s);
1293}
1294
1300static UINT rdpdr_send_client_name_request(rdpdrPlugin* rdpdr)
1301{
1302 wStream* s = nullptr;
1303 WCHAR* computerNameW = nullptr;
1304 size_t computerNameLenW = 0;
1305
1306 WINPR_ASSERT(rdpdr);
1307 WINPR_ASSERT(rdpdr->state == RDPDR_CHANNEL_STATE_ANNOUNCE_REPLY);
1308 if (!rdpdr_state_advance(rdpdr, RDPDR_CHANNEL_STATE_NAME_REQUEST))
1309 return ERROR_INVALID_STATE;
1310
1311 const size_t len = strnlen(rdpdr->computerName, sizeof(rdpdr->computerName));
1312 if (len == 0)
1313 return ERROR_INTERNAL_ERROR;
1314
1315 WINPR_ASSERT(rdpdr->computerName);
1316 computerNameW = ConvertUtf8NToWCharAlloc(rdpdr->computerName, len, &computerNameLenW);
1317 computerNameLenW *= sizeof(WCHAR);
1318
1319 if (computerNameLenW > 0)
1320 computerNameLenW += sizeof(WCHAR); // also write '\0'
1321
1322 s = StreamPool_Take(rdpdr->pool, 16U + computerNameLenW);
1323
1324 if (!s)
1325 {
1326 free(computerNameW);
1327 WLog_Print(rdpdr->log, WLOG_ERROR, "Stream_New failed!");
1328 return CHANNEL_RC_NO_MEMORY;
1329 }
1330
1331 Stream_Write_UINT16(s, RDPDR_CTYP_CORE); /* Component (2 bytes) */
1332 Stream_Write_UINT16(s, PAKID_CORE_CLIENT_NAME); /* PacketId (2 bytes) */
1333 Stream_Write_UINT32(s, 1); /* unicodeFlag, 0 for ASCII and 1 for Unicode */
1334 Stream_Write_UINT32(s, 0); /* codePage, must be set to zero */
1335 Stream_Write_UINT32(s,
1336 (UINT32)computerNameLenW); /* computerNameLen, including null terminator */
1337 Stream_Write(s, computerNameW, computerNameLenW);
1338 free(computerNameW);
1339 return rdpdr_send(rdpdr, s);
1340}
1341
1342static UINT rdpdr_process_server_clientid_confirm(rdpdrPlugin* rdpdr, wStream* s)
1343{
1344 UINT16 versionMajor = 0;
1345 UINT16 versionMinor = 0;
1346 UINT32 clientID = 0;
1347
1348 WINPR_ASSERT(rdpdr);
1349 WINPR_ASSERT(s);
1350
1351 if (!Stream_CheckAndLogRequiredLengthWLog(rdpdr->log, s, 8))
1352 return ERROR_INVALID_DATA;
1353
1354 Stream_Read_UINT16(s, versionMajor);
1355 Stream_Read_UINT16(s, versionMinor);
1356 Stream_Read_UINT32(s, clientID);
1357
1358 if (versionMajor != rdpdr->clientVersionMajor || versionMinor != rdpdr->clientVersionMinor)
1359 {
1360 WLog_Print(rdpdr->log, WLOG_WARN,
1361 "[rdpdr] server announced version %" PRIu32 ".%" PRIu32 ", client uses %" PRIu32
1362 ".%" PRIu32 " but clientid confirm requests version %" PRIu32 ".%" PRIu32,
1363 rdpdr->serverVersionMajor, rdpdr->serverVersionMinor, rdpdr->clientVersionMajor,
1364 rdpdr->clientVersionMinor, versionMajor, versionMinor);
1365 rdpdr->clientVersionMajor = versionMajor;
1366 rdpdr->clientVersionMinor = versionMinor;
1367 }
1368
1369 if (clientID != rdpdr->clientID)
1370 rdpdr->clientID = clientID;
1371
1372 return CHANNEL_RC_OK;
1373}
1374
1375struct device_announce_arg
1376{
1377 rdpdrPlugin* rdpdr;
1378 wStream* s;
1379 BOOL userLoggedOn;
1380 UINT32 count;
1381};
1382
1383static BOOL device_announce(ULONG_PTR key, void* element, void* data)
1384{
1385 struct device_announce_arg* arg = data;
1386 rdpdrPlugin* rdpdr = nullptr;
1387 DEVICE* device = (DEVICE*)element;
1388
1389 WINPR_UNUSED(key);
1390
1391 WINPR_ASSERT(arg);
1392 WINPR_ASSERT(device);
1393 WINPR_ASSERT(arg->rdpdr);
1394 WINPR_ASSERT(arg->s);
1395
1396 rdpdr = arg->rdpdr;
1397
1405 if ((rdpdr->clientVersionMinor == RDPDR_VERSION_MINOR_RDP51) ||
1406 (device->type == RDPDR_DTYP_SMARTCARD) || arg->userLoggedOn)
1407 {
1408 size_t data_len = (device->data == nullptr ? 0 : Stream_GetPosition(device->data));
1409
1410 if (!Stream_EnsureRemainingCapacity(arg->s, 20 + data_len))
1411 {
1412 Stream_Release(arg->s);
1413 WLog_Print(rdpdr->log, WLOG_ERROR, "Stream_EnsureRemainingCapacity failed!");
1414 return FALSE;
1415 }
1416
1417 Stream_Write_UINT32(arg->s, device->type); /* deviceType */
1418 Stream_Write_UINT32(arg->s, device->id); /* deviceID */
1419 strncpy(Stream_Pointer(arg->s), device->name, 8);
1420
1421 for (size_t i = 0; i < 8; i++)
1422 {
1423 BYTE c = 0;
1424 Stream_Peek_UINT8(arg->s, c);
1425
1426 if (c > 0x7F)
1427 Stream_Write_UINT8(arg->s, '_');
1428 else
1429 Stream_Seek_UINT8(arg->s);
1430 }
1431
1432 WINPR_ASSERT(data_len <= UINT32_MAX);
1433 Stream_Write_UINT32(arg->s, (UINT32)data_len);
1434
1435 if (data_len > 0)
1436 Stream_Write(arg->s, Stream_Buffer(device->data), data_len);
1437
1438 arg->count++;
1439 WLog_Print(rdpdr->log, WLOG_INFO,
1440 "registered [%9s] device #%" PRIu32 ": %5s (type=%2" PRIu32 " id=%2" PRIu32 ")",
1441 rdpdr_device_type_string(device->type), arg->count, device->name, device->type,
1442 device->id);
1443 }
1444 return TRUE;
1445}
1446
1447static UINT rdpdr_send_device_list_announce_request(rdpdrPlugin* rdpdr, BOOL userLoggedOn)
1448{
1449 size_t pos = 0;
1450 wStream* s = nullptr;
1451 size_t count_pos = 0;
1452 struct device_announce_arg arg = WINPR_C_ARRAY_INIT;
1453
1454 WINPR_ASSERT(rdpdr);
1455 WINPR_ASSERT(rdpdr->devman);
1456
1457 if (userLoggedOn)
1458 {
1459 rdpdr->userLoggedOn = TRUE;
1460 }
1461
1462 s = StreamPool_Take(rdpdr->pool, 256);
1463
1464 if (!s)
1465 {
1466 WLog_Print(rdpdr->log, WLOG_ERROR, "Stream_New failed!");
1467 return CHANNEL_RC_NO_MEMORY;
1468 }
1469
1470 Stream_Write_UINT16(s, RDPDR_CTYP_CORE); /* Component (2 bytes) */
1471 Stream_Write_UINT16(s, PAKID_CORE_DEVICELIST_ANNOUNCE); /* PacketId (2 bytes) */
1472 count_pos = Stream_GetPosition(s);
1473 Stream_Seek_UINT32(s); /* deviceCount */
1474
1475 arg.rdpdr = rdpdr;
1476 arg.userLoggedOn = userLoggedOn || rdpdr->userLoggedOn;
1477 arg.s = s;
1478 if (!device_foreach(rdpdr, TRUE, device_announce, &arg))
1479 return ERROR_INVALID_DATA;
1480
1481 if (arg.count == 0)
1482 {
1483 Stream_Release(s);
1484 return CHANNEL_RC_OK;
1485 }
1486 pos = Stream_GetPosition(s);
1487 if (!Stream_SetPosition(s, count_pos))
1488 {
1489 Stream_Release(s);
1490 return ERROR_INVALID_DATA;
1491 }
1492 Stream_Write_UINT32(s, arg.count);
1493 if (!Stream_SetPosition(s, pos))
1494 {
1495 Stream_Release(s);
1496 return ERROR_INVALID_DATA;
1497 }
1498 Stream_SealLength(s);
1499 return rdpdr_send(rdpdr, s);
1500}
1501
1502UINT rdpdr_try_send_device_list_announce_request(rdpdrPlugin* rdpdr)
1503{
1504 WINPR_ASSERT(rdpdr);
1505 if (rdpdr->state != RDPDR_CHANNEL_STATE_READY)
1506 {
1507 WLog_Print(rdpdr->log, WLOG_DEBUG,
1508 "hotplug event received, but channel [RDPDR] is not ready (state %s), ignoring.",
1509 rdpdr_state_str(rdpdr->state));
1510 return CHANNEL_RC_OK;
1511 }
1512 return rdpdr_send_device_list_announce_request(rdpdr, rdpdr->userLoggedOn);
1513}
1514
1515static UINT dummy_irp_response(rdpdrPlugin* rdpdr, wStream* s)
1516{
1517 WINPR_ASSERT(rdpdr);
1518 WINPR_ASSERT(s);
1519
1520 wStream* output = StreamPool_Take(rdpdr->pool, 256); // RDPDR_DEVICE_IO_RESPONSE_LENGTH
1521 if (!output)
1522 {
1523 WLog_Print(rdpdr->log, WLOG_ERROR, "Stream_New failed!");
1524 return CHANNEL_RC_NO_MEMORY;
1525 }
1526
1527 if (!Stream_SetPosition(s, 4)) /* see "rdpdr_process_receive" */
1528 {
1529 Stream_Release(output);
1530 return ERROR_INVALID_DATA;
1531 }
1532
1533 const uint32_t DeviceId = Stream_Get_UINT32(s); /* DeviceId (4 bytes) */
1534 const uint32_t FileId = Stream_Get_UINT32(s); /* FileId (4 bytes) */
1535 const uint32_t CompletionId = Stream_Get_UINT32(s); /* CompletionId (4 bytes) */
1536
1537 WLog_Print(rdpdr->log, WLOG_WARN,
1538 "Dummy response {DeviceId=%" PRIu32 ", FileId=%" PRIu32 ", CompletionId=%" PRIu32
1539 "}",
1540 DeviceId, FileId, CompletionId);
1541 if (!rdpdr_write_iocompletion_header(output, DeviceId, CompletionId, STATUS_UNSUCCESSFUL))
1542 return CHANNEL_RC_NO_MEMORY;
1543
1544 return rdpdr_send(rdpdr, output);
1545}
1546
1552static UINT rdpdr_process_irp(rdpdrPlugin* rdpdr, wStream* s)
1553{
1554 UINT error = CHANNEL_RC_OK;
1555
1556 WINPR_ASSERT(rdpdr);
1557 WINPR_ASSERT(s);
1558
1559 IRP* irp = irp_new(rdpdr->devman, rdpdr->pool, s, rdpdr->log, &error);
1560
1561 if (!irp)
1562 {
1563 if ((error == CHANNEL_RC_OK) ||
1564 (error == ERROR_DEV_NOT_EXIST && rdpdr->ignoreInvalidDevices))
1565 {
1566 return dummy_irp_response(rdpdr, s);
1567 }
1568
1569 WLog_Print(rdpdr->log, WLOG_ERROR, "irp_new failed with %" PRIu32 "!", error);
1570 return error;
1571 }
1572
1573 if (irp->device->IRPRequest)
1574 error = irp->device->IRPRequest(irp->device, irp);
1575 else
1576 error = irp->Discard(irp);
1577
1578 if (error != CHANNEL_RC_OK)
1579 {
1580 WLog_Print(rdpdr->log, WLOG_ERROR, "device->IRPRequest failed with error %" PRIu32 "",
1581 error);
1582 }
1583
1584 return error;
1585}
1586
1587static UINT rdpdr_process_component(rdpdrPlugin* rdpdr, UINT16 component, UINT16 packetId,
1588 wStream* s)
1589{
1590 UINT32 type = 0;
1591 DEVICE* device = nullptr;
1592
1593 WINPR_ASSERT(rdpdr);
1594 WINPR_ASSERT(s);
1595
1596 switch (component)
1597 {
1598 case RDPDR_CTYP_PRN:
1599 type = RDPDR_DTYP_PRINT;
1600 break;
1601
1602 default:
1603 return ERROR_INVALID_DATA;
1604 }
1605
1606 device = devman_get_device_by_type(rdpdr->devman, type);
1607
1608 if (!device)
1609 return ERROR_DEV_NOT_EXIST;
1610
1611 return IFCALLRESULT(ERROR_INVALID_PARAMETER, device->CustomComponentRequest, device, component,
1612 packetId, s);
1613}
1614
1620static BOOL device_init(ULONG_PTR key, void* element, void* data)
1621{
1622 wLog* log = data;
1623 UINT error = CHANNEL_RC_OK;
1624 DEVICE* device = element;
1625
1626 WINPR_UNUSED(key);
1627 WINPR_UNUSED(data);
1628
1629 IFCALLRET(device->Init, error, device);
1630
1631 if (error != CHANNEL_RC_OK)
1632 {
1633 WLog_Print(log, WLOG_ERROR, "Device init failed with %s", WTSErrorToString(error));
1634 return FALSE;
1635 }
1636 return TRUE;
1637}
1638
1639static UINT rdpdr_process_init(rdpdrPlugin* rdpdr)
1640{
1641 WINPR_ASSERT(rdpdr);
1642 WINPR_ASSERT(rdpdr->devman);
1643
1644 rdpdr->userLoggedOn = FALSE; /* reset possible received state */
1645
1646 /* windows servers tend to trail off if pending IRP are completed after a
1647 * PAKID_CORE_SERVER_ANNOUNCE message was received.
1648 * So, set rdpdr->clearing and discard all response messages triggered by
1649 * cancelling the pending requests.
1650 */
1651 rdpdr->clearing = TRUE;
1652 BOOL rc = device_foreach(rdpdr, TRUE, device_init, rdpdr->log);
1653 rdpdr->clearing = FALSE;
1654 if (!rc)
1655 return ERROR_INTERNAL_ERROR;
1656 return CHANNEL_RC_OK;
1657}
1658
1659static BOOL state_match(enum RDPDR_CHANNEL_STATE state, size_t count, va_list ap)
1660{
1661 for (size_t x = 0; x < count; x++)
1662 {
1663 enum RDPDR_CHANNEL_STATE cur = va_arg(ap, enum RDPDR_CHANNEL_STATE);
1664 if (state == cur)
1665 return TRUE;
1666 }
1667 return FALSE;
1668}
1669
1670static const char* state_str(size_t count, va_list ap, char* buffer, size_t size)
1671{
1672 for (size_t x = 0; x < count; x++)
1673 {
1674 enum RDPDR_CHANNEL_STATE cur = va_arg(ap, enum RDPDR_CHANNEL_STATE);
1675 const char* curstr = rdpdr_state_str(cur);
1676 winpr_str_append(curstr, buffer, size, "|");
1677 }
1678 return buffer;
1679}
1680
1681static BOOL rdpdr_state_check(rdpdrPlugin* rdpdr, UINT16 packetid, enum RDPDR_CHANNEL_STATE next,
1682 size_t count, ...)
1683{
1684 va_list ap = WINPR_C_ARRAY_INIT;
1685 WINPR_ASSERT(rdpdr);
1686
1687 va_start(ap, count);
1688 BOOL rc = state_match(rdpdr->state, count, ap);
1689 va_end(ap);
1690
1691 if (!rc)
1692 {
1693 const char* strstate = rdpdr_state_str(rdpdr->state);
1694 char buffer[256] = WINPR_C_ARRAY_INIT;
1695
1696 va_start(ap, count);
1697 state_str(count, ap, buffer, sizeof(buffer));
1698 va_end(ap);
1699
1700 WLog_Print(rdpdr->log, WLOG_ERROR,
1701 "channel [RDPDR] received %s, expected states [%s] but have state %s, aborting.",
1702 rdpdr_packetid_string(packetid), buffer, strstate);
1703
1704 if (!rdpdr_state_advance(rdpdr, RDPDR_CHANNEL_STATE_INITIAL))
1705 return FALSE;
1706 return FALSE;
1707 }
1708 return rdpdr_state_advance(rdpdr, next);
1709}
1710
1711static BOOL rdpdr_check_channel_state(rdpdrPlugin* rdpdr, UINT16 packetid)
1712{
1713 WINPR_ASSERT(rdpdr);
1714
1715 switch (packetid)
1716 {
1717 case PAKID_CORE_SERVER_ANNOUNCE:
1718 /* windows servers sometimes send this message.
1719 * it seems related to session login (e.g. first initialization for RDP/TLS style login,
1720 * then reinitialize the channel after login successful
1721 */
1722 if (!rdpdr_state_advance(rdpdr, RDPDR_CHANNEL_STATE_INITIAL))
1723 return FALSE;
1724 return rdpdr_state_check(rdpdr, packetid, RDPDR_CHANNEL_STATE_ANNOUNCE, 1,
1725 RDPDR_CHANNEL_STATE_INITIAL);
1726 case PAKID_CORE_SERVER_CAPABILITY:
1727 return rdpdr_state_check(
1728 rdpdr, packetid, RDPDR_CHANNEL_STATE_SERVER_CAPS, 6,
1729 RDPDR_CHANNEL_STATE_NAME_REQUEST, RDPDR_CHANNEL_STATE_SERVER_CAPS,
1730 RDPDR_CHANNEL_STATE_READY, RDPDR_CHANNEL_STATE_CLIENT_CAPS,
1731 RDPDR_CHANNEL_STATE_CLIENTID_CONFIRM, RDPDR_CHANNEL_STATE_USER_LOGGEDON);
1732 case PAKID_CORE_CLIENTID_CONFIRM:
1733 return rdpdr_state_check(rdpdr, packetid, RDPDR_CHANNEL_STATE_CLIENTID_CONFIRM, 5,
1734 RDPDR_CHANNEL_STATE_NAME_REQUEST,
1735 RDPDR_CHANNEL_STATE_SERVER_CAPS,
1736 RDPDR_CHANNEL_STATE_CLIENT_CAPS, RDPDR_CHANNEL_STATE_READY,
1737 RDPDR_CHANNEL_STATE_USER_LOGGEDON);
1738 case PAKID_CORE_USER_LOGGEDON:
1739 if (!rdpdr_check_extended_pdu_flag(rdpdr, RDPDR_USER_LOGGEDON_PDU))
1740 return FALSE;
1741
1742 return rdpdr_state_check(
1743 rdpdr, packetid, RDPDR_CHANNEL_STATE_USER_LOGGEDON, 4,
1744 RDPDR_CHANNEL_STATE_NAME_REQUEST, RDPDR_CHANNEL_STATE_CLIENT_CAPS,
1745 RDPDR_CHANNEL_STATE_CLIENTID_CONFIRM, RDPDR_CHANNEL_STATE_READY);
1746 default:
1747 {
1748 enum RDPDR_CHANNEL_STATE state = RDPDR_CHANNEL_STATE_READY;
1749 return rdpdr_state_check(rdpdr, packetid, state, 1, state);
1750 }
1751 }
1752}
1753
1754static BOOL tryAdvance(rdpdrPlugin* rdpdr, BOOL announce)
1755{
1756 if (rdpdr->haveClientId && rdpdr->haveServerCaps)
1757 {
1758 if (announce)
1759 {
1760 const UINT error = rdpdr_send_device_list_announce_request(rdpdr, FALSE);
1761 if (error)
1762 {
1763 WLog_Print(rdpdr->log, WLOG_ERROR,
1764 "rdpdr_send_device_list_announce_request failed with error %" PRIu32 "",
1765 error);
1766 return FALSE;
1767 }
1768 }
1769 if (!rdpdr_state_advance(rdpdr, RDPDR_CHANNEL_STATE_READY))
1770 return FALSE;
1771 }
1772 return TRUE;
1773}
1774
1780static UINT rdpdr_process_receive(rdpdrPlugin* rdpdr, wStream* s)
1781{
1782 UINT16 component = 0;
1783 UINT16 packetId = 0;
1784 UINT32 deviceId = 0;
1785 UINT32 status = 0;
1786 UINT error = ERROR_INVALID_DATA;
1787
1788 if (!rdpdr || !s)
1789 return CHANNEL_RC_NULL_DATA;
1790
1791 rdpdr_dump_received_packet(rdpdr->log, WLOG_TRACE, s, "[rdpdr-channel] receive");
1792 if (Stream_GetRemainingLength(s) >= 4)
1793 {
1794 Stream_Read_UINT16(s, component); /* Component (2 bytes) */
1795 Stream_Read_UINT16(s, packetId); /* PacketId (2 bytes) */
1796
1797 if (component == RDPDR_CTYP_CORE)
1798 {
1799 if (!rdpdr_check_channel_state(rdpdr, packetId))
1800 return CHANNEL_RC_OK;
1801
1802 switch (packetId)
1803 {
1804 case PAKID_CORE_SERVER_ANNOUNCE:
1805 rdpdr->haveClientId = FALSE;
1806 rdpdr->haveServerCaps = FALSE;
1807 if ((error = rdpdr_process_server_announce_request(rdpdr, s)))
1808 {
1809 }
1810 else if ((error = rdpdr_send_client_announce_reply(rdpdr)))
1811 {
1812 WLog_Print(rdpdr->log, WLOG_ERROR,
1813 "rdpdr_send_client_announce_reply failed with error %" PRIu32 "",
1814 error);
1815 }
1816 else if ((error = rdpdr_send_client_name_request(rdpdr)))
1817 {
1818 WLog_Print(rdpdr->log, WLOG_ERROR,
1819 "rdpdr_send_client_name_request failed with error %" PRIu32 "",
1820 error);
1821 }
1822 else if ((error = rdpdr_process_init(rdpdr)))
1823 {
1824 WLog_Print(rdpdr->log, WLOG_ERROR,
1825 "rdpdr_process_init failed with error %" PRIu32 "", error);
1826 }
1827
1828 break;
1829
1830 case PAKID_CORE_SERVER_CAPABILITY:
1831 if ((error = rdpdr_process_capability_request(rdpdr, s)))
1832 {
1833 }
1834 else if ((error = rdpdr_send_capability_response(rdpdr)))
1835 {
1836 WLog_Print(rdpdr->log, WLOG_ERROR,
1837 "rdpdr_send_capability_response failed with error %" PRIu32 "",
1838 error);
1839 }
1840 else
1841 {
1842 rdpdr->haveServerCaps = TRUE;
1843 if (!tryAdvance(rdpdr, TRUE))
1844 error = ERROR_INTERNAL_ERROR;
1845 }
1846
1847 break;
1848
1849 case PAKID_CORE_CLIENTID_CONFIRM:
1850 if ((error = rdpdr_process_server_clientid_confirm(rdpdr, s)))
1851 {
1852 }
1853 else
1854 {
1855 rdpdr->haveClientId = TRUE;
1856 if (!tryAdvance(rdpdr, TRUE))
1857 error = ERROR_INTERNAL_ERROR;
1858 }
1859 break;
1860
1861 case PAKID_CORE_USER_LOGGEDON:
1862 if (!rdpdr->haveServerCaps)
1863 {
1864 WLog_Print(rdpdr->log, WLOG_ERROR,
1865 "Wrong state %s for %s. [serverCaps=%d, clientId=%d]",
1866 rdpdr_state_str(rdpdr->state), rdpdr_packetid_string(packetId),
1867 rdpdr->haveServerCaps, rdpdr->haveClientId);
1868 error = ERROR_INTERNAL_ERROR;
1869 }
1870 else if ((error = rdpdr_send_device_list_announce_request(rdpdr, TRUE)))
1871 {
1872 WLog_Print(
1873 rdpdr->log, WLOG_ERROR,
1874 "rdpdr_send_device_list_announce_request failed with error %" PRIu32 "",
1875 error);
1876 }
1877 else if (!tryAdvance(rdpdr, FALSE))
1878 {
1879 error = ERROR_INTERNAL_ERROR;
1880 }
1881
1882 break;
1883
1884 case PAKID_CORE_DEVICE_REPLY:
1885
1886 /* connect to a specific resource */
1887 if (Stream_GetRemainingLength(s) >= 8)
1888 {
1889 Stream_Read_UINT32(s, deviceId);
1890 Stream_Read_UINT32(s, status);
1891
1892 if (status != 0)
1893 devman_unregister_device(rdpdr->devman, (void*)((size_t)deviceId));
1894 error = CHANNEL_RC_OK;
1895 }
1896
1897 break;
1898
1899 case PAKID_CORE_DEVICE_IOREQUEST:
1900 if ((error = rdpdr_process_irp(rdpdr, s)))
1901 {
1902 WLog_Print(rdpdr->log, WLOG_ERROR,
1903 "rdpdr_process_irp failed with error %" PRIu32 "", error);
1904 return error;
1905 }
1906 else
1907 s = nullptr;
1908
1909 break;
1910
1911 default:
1912 WLog_Print(rdpdr->log, WLOG_ERROR,
1913 "RDPDR_CTYP_CORE unknown PacketId: 0x%04" PRIX16 "", packetId);
1914 error = ERROR_INVALID_DATA;
1915 break;
1916 }
1917 }
1918 else
1919 {
1920 error = rdpdr_process_component(rdpdr, component, packetId, s);
1921
1922 if (error != CHANNEL_RC_OK)
1923 {
1924 DWORD level = WLOG_ERROR;
1925 if (rdpdr->ignoreInvalidDevices)
1926 {
1927 if (error == ERROR_DEV_NOT_EXIST)
1928 {
1929 level = WLOG_WARN;
1930 error = CHANNEL_RC_OK;
1931 }
1932 }
1933 WLog_Print(rdpdr->log, level,
1934 "Unknown message: Component: %s [0x%04" PRIX16
1935 "] PacketId: %s [0x%04" PRIX16 "]",
1936 rdpdr_component_string(component), component,
1937 rdpdr_packetid_string(packetId), packetId);
1938 }
1939 }
1940 }
1941
1942 return error;
1943}
1944
1950UINT rdpdr_send(rdpdrPlugin* rdpdr, wStream* s)
1951{
1952 rdpdrPlugin* plugin = rdpdr;
1953
1954 if (rdpdr->clearing)
1955 {
1956 WLog_ERR(TAG, "trying to send message while reinitializing channel, aborting");
1957 return ERROR_INTERNAL_ERROR;
1958 }
1959 if (!s)
1960 {
1961 Stream_Release(s);
1962 return CHANNEL_RC_NULL_DATA;
1963 }
1964
1965 if (!plugin)
1966 {
1967 Stream_Release(s);
1968 return CHANNEL_RC_BAD_INIT_HANDLE;
1969 }
1970
1971 const size_t pos = Stream_GetPosition(s);
1972 UINT status = ERROR_INTERNAL_ERROR;
1973 if (pos <= UINT32_MAX)
1974 {
1975 rdpdr_dump_send_packet(rdpdr->log, WLOG_TRACE, s, "[rdpdr-channel] send");
1976 status = plugin->channelEntryPoints.pVirtualChannelWriteEx(
1977 plugin->InitHandle, plugin->OpenHandle, Stream_Buffer(s), (UINT32)pos, s);
1978 }
1979
1980 if (status != CHANNEL_RC_OK)
1981 {
1982 Stream_Release(s);
1983 WLog_Print(rdpdr->log, WLOG_ERROR, "pVirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1984 WTSErrorToString(status), status);
1985 }
1986
1987 return status;
1988}
1989
1995static UINT rdpdr_virtual_channel_event_data_received(rdpdrPlugin* rdpdr, void* pData,
1996 UINT32 dataLength, UINT32 totalLength,
1997 UINT32 dataFlags)
1998{
1999 wStream* data_in = nullptr;
2000
2001 WINPR_ASSERT(rdpdr);
2002 WINPR_ASSERT(pData || (dataLength == 0));
2003
2004 if ((dataFlags & CHANNEL_FLAG_SUSPEND) || (dataFlags & CHANNEL_FLAG_RESUME))
2005 {
2006 /*
2007 * According to MS-RDPBCGR 2.2.6.1, "All virtual channel traffic MUST be suspended.
2008 * This flag is only valid in server-to-client virtual channel traffic. It MUST be
2009 * ignored in client-to-server data." Thus it would be best practice to cease data
2010 * transmission. However, simply returning here avoids a crash.
2011 */
2012 return CHANNEL_RC_OK;
2013 }
2014
2015 if (dataFlags & CHANNEL_FLAG_FIRST)
2016 {
2017 if (rdpdr->data_in != nullptr)
2018 Stream_Release(rdpdr->data_in);
2019
2020 rdpdr->data_in = StreamPool_Take(rdpdr->pool, totalLength);
2021
2022 if (!rdpdr->data_in)
2023 {
2024 WLog_Print(rdpdr->log, WLOG_ERROR, "Stream_New failed!");
2025 return CHANNEL_RC_NO_MEMORY;
2026 }
2027 }
2028
2029 data_in = rdpdr->data_in;
2030
2031 if (!Stream_EnsureRemainingCapacity(data_in, dataLength))
2032 {
2033 WLog_Print(rdpdr->log, WLOG_ERROR, "Stream_EnsureRemainingCapacity failed!");
2034 return ERROR_INVALID_DATA;
2035 }
2036
2037 Stream_Write(data_in, pData, dataLength);
2038
2039 if (dataFlags & CHANNEL_FLAG_LAST)
2040 {
2041 const size_t pos = Stream_GetPosition(data_in);
2042 const size_t cap = Stream_Capacity(data_in);
2043 if (cap < pos)
2044 {
2045 WLog_Print(rdpdr->log, WLOG_ERROR,
2046 "rdpdr_virtual_channel_event_data_received: read error");
2047 return ERROR_INTERNAL_ERROR;
2048 }
2049
2050 Stream_SealLength(data_in);
2051 Stream_ResetPosition(data_in);
2052
2053 if (rdpdr->async)
2054 {
2055 if (!MessageQueue_Post(rdpdr->queue, nullptr, 0, (void*)data_in, nullptr))
2056 {
2057 WLog_Print(rdpdr->log, WLOG_ERROR, "MessageQueue_Post failed!");
2058 return ERROR_INTERNAL_ERROR;
2059 }
2060 rdpdr->data_in = nullptr;
2061 }
2062 else
2063 {
2064 UINT error = rdpdr_process_receive(rdpdr, data_in);
2065 Stream_Release(data_in);
2066 rdpdr->data_in = nullptr;
2067 if (error)
2068 return error;
2069 }
2070 }
2071
2072 return CHANNEL_RC_OK;
2073}
2074
2075static VOID VCAPITYPE rdpdr_virtual_channel_open_event_ex(LPVOID lpUserParam, DWORD openHandle,
2076 UINT event, LPVOID pData,
2077 UINT32 dataLength, UINT32 totalLength,
2078 UINT32 dataFlags)
2079{
2080 UINT error = CHANNEL_RC_OK;
2081 rdpdrPlugin* rdpdr = (rdpdrPlugin*)lpUserParam;
2082
2083 WINPR_ASSERT(rdpdr);
2084 switch (event)
2085 {
2086 case CHANNEL_EVENT_DATA_RECEIVED:
2087 if (!rdpdr || !pData || (rdpdr->OpenHandle != openHandle))
2088 {
2089 WLog_Print(rdpdr->log, WLOG_ERROR, "error no match");
2090 return;
2091 }
2092 if ((error = rdpdr_virtual_channel_event_data_received(rdpdr, pData, dataLength,
2093 totalLength, dataFlags)))
2094 WLog_Print(rdpdr->log, WLOG_ERROR,
2095 "rdpdr_virtual_channel_event_data_received failed with error %" PRIu32
2096 "!",
2097 error);
2098
2099 break;
2100
2101 case CHANNEL_EVENT_WRITE_CANCELLED:
2102 case CHANNEL_EVENT_WRITE_COMPLETE:
2103 {
2104 wStream* s = (wStream*)pData;
2105 Stream_Release(s);
2106 }
2107 break;
2108
2109 case CHANNEL_EVENT_USER:
2110 break;
2111 default:
2112 break;
2113 }
2114
2115 if (error && rdpdr && rdpdr->rdpcontext)
2116 setChannelError(rdpdr->rdpcontext, error,
2117 "rdpdr_virtual_channel_open_event_ex reported an error");
2118}
2119
2120static DWORD WINAPI rdpdr_virtual_channel_client_thread(LPVOID arg)
2121{
2122 rdpdrPlugin* rdpdr = (rdpdrPlugin*)arg;
2123 UINT error = 0;
2124
2125 if (!rdpdr)
2126 {
2127 ExitThread((DWORD)CHANNEL_RC_NULL_DATA);
2128 return CHANNEL_RC_NULL_DATA;
2129 }
2130
2131 if ((error = rdpdr_process_connect(rdpdr)))
2132 {
2133 WLog_Print(rdpdr->log, WLOG_ERROR, "rdpdr_process_connect failed with error %" PRIu32 "!",
2134 error);
2135
2136 if (rdpdr->rdpcontext)
2137 setChannelError(rdpdr->rdpcontext, error,
2138 "rdpdr_virtual_channel_client_thread reported an error");
2139
2140 ExitThread(error);
2141 return error;
2142 }
2143
2144 while (1)
2145 {
2146 wMessage message = WINPR_C_ARRAY_INIT;
2147 WINPR_ASSERT(rdpdr);
2148
2149 if (!MessageQueue_Wait(rdpdr->queue))
2150 break;
2151
2152 if (MessageQueue_Peek(rdpdr->queue, &message, TRUE))
2153 {
2154 if (message.id == WMQ_QUIT)
2155 break;
2156
2157 if (message.id == 0)
2158 {
2159 wStream* data = (wStream*)message.wParam;
2160
2161 error = rdpdr_process_receive(rdpdr, data);
2162
2163 Stream_Release(data);
2164 if (error)
2165 {
2166 WLog_Print(rdpdr->log, WLOG_ERROR,
2167 "rdpdr_process_receive failed with error %" PRIu32 "!", error);
2168
2169 if (rdpdr->rdpcontext)
2170 setChannelError(rdpdr->rdpcontext, error,
2171 "rdpdr_virtual_channel_client_thread reported an error");
2172
2173 goto fail;
2174 }
2175 }
2176 }
2177 }
2178
2179fail:
2180 if ((error = drive_hotplug_thread_terminate(rdpdr)))
2181 WLog_Print(rdpdr->log, WLOG_ERROR,
2182 "drive_hotplug_thread_terminate failed with error %" PRIu32 "!", error);
2183
2184 ExitThread(error);
2185 return error;
2186}
2187
2188static void queue_free(void* obj)
2189{
2190 wStream* s = nullptr;
2191 wMessage* msg = (wMessage*)obj;
2192
2193 if (!msg || (msg->id != 0))
2194 return;
2195
2196 s = (wStream*)msg->wParam;
2197 WINPR_ASSERT(s);
2198 Stream_Release(s);
2199}
2200
2206static UINT rdpdr_virtual_channel_event_connected(rdpdrPlugin* rdpdr, LPVOID pData,
2207 UINT32 dataLength)
2208{
2209 wObject* obj = nullptr;
2210
2211 WINPR_ASSERT(rdpdr);
2212 WINPR_UNUSED(pData);
2213 WINPR_UNUSED(dataLength);
2214
2215 if (rdpdr->async)
2216 {
2217 rdpdr->queue = MessageQueue_New(nullptr);
2218
2219 if (!rdpdr->queue)
2220 {
2221 WLog_Print(rdpdr->log, WLOG_ERROR, "MessageQueue_New failed!");
2222 return CHANNEL_RC_NO_MEMORY;
2223 }
2224
2225 obj = MessageQueue_Object(rdpdr->queue);
2226 obj->fnObjectFree = queue_free;
2227
2228 if (!(rdpdr->thread = CreateThread(nullptr, 0, rdpdr_virtual_channel_client_thread,
2229 (void*)rdpdr, 0, nullptr)))
2230 {
2231 WLog_Print(rdpdr->log, WLOG_ERROR, "CreateThread failed!");
2232 return ERROR_INTERNAL_ERROR;
2233 }
2234 }
2235 else
2236 {
2237 UINT error = rdpdr_process_connect(rdpdr);
2238 if (error)
2239 {
2240 WLog_Print(rdpdr->log, WLOG_ERROR,
2241 "rdpdr_process_connect failed with error %" PRIu32 "!", error);
2242 return error;
2243 }
2244 }
2245
2246 return rdpdr->channelEntryPoints.pVirtualChannelOpenEx(rdpdr->InitHandle, &rdpdr->OpenHandle,
2247 rdpdr->channelDef.name,
2248 rdpdr_virtual_channel_open_event_ex);
2249}
2250
2256static UINT rdpdr_virtual_channel_event_disconnected(rdpdrPlugin* rdpdr)
2257{
2258 UINT error = 0;
2259
2260 WINPR_ASSERT(rdpdr);
2261
2262 if (rdpdr->OpenHandle == 0)
2263 return CHANNEL_RC_OK;
2264
2265 if (rdpdr->queue && rdpdr->thread)
2266 {
2267 if (MessageQueue_PostQuit(rdpdr->queue, 0) &&
2268 (WaitForSingleObject(rdpdr->thread, INFINITE) == WAIT_FAILED))
2269 {
2270 error = GetLastError();
2271 WLog_Print(rdpdr->log, WLOG_ERROR, "WaitForSingleObject failed with error %" PRIu32 "!",
2272 error);
2273 return error;
2274 }
2275 }
2276
2277 if (rdpdr->thread)
2278 (void)CloseHandle(rdpdr->thread);
2279 MessageQueue_Free(rdpdr->queue);
2280 rdpdr->queue = nullptr;
2281 rdpdr->thread = nullptr;
2282
2283 WINPR_ASSERT(rdpdr->channelEntryPoints.pVirtualChannelCloseEx);
2284 error = rdpdr->channelEntryPoints.pVirtualChannelCloseEx(rdpdr->InitHandle, rdpdr->OpenHandle);
2285
2286 if (CHANNEL_RC_OK != error)
2287 {
2288 WLog_Print(rdpdr->log, WLOG_ERROR, "pVirtualChannelCloseEx failed with %s [%08" PRIX32 "]",
2289 WTSErrorToString(error), error);
2290 }
2291
2292 rdpdr->OpenHandle = 0;
2293
2294 if (rdpdr->data_in)
2295 {
2296 Stream_Release(rdpdr->data_in);
2297 rdpdr->data_in = nullptr;
2298 }
2299
2300 if (rdpdr->devman)
2301 {
2302 devman_free(rdpdr->devman);
2303 rdpdr->devman = nullptr;
2304 }
2305
2306 return error;
2307}
2308
2309static void rdpdr_virtual_channel_event_terminated(rdpdrPlugin* rdpdr)
2310{
2311 WINPR_ASSERT(rdpdr);
2312#if !defined(_WIN32)
2313 if (rdpdr->stopEvent)
2314 {
2315 (void)CloseHandle(rdpdr->stopEvent);
2316 rdpdr->stopEvent = nullptr;
2317 }
2318#endif
2319 rdpdr->InitHandle = nullptr;
2320 StreamPool_Free(rdpdr->pool);
2321 free(rdpdr);
2322}
2323
2324static UINT rdpdr_register_device(RdpdrClientContext* context, const RDPDR_DEVICE* device,
2325 uint32_t* pid)
2326{
2327 WINPR_ASSERT(context);
2328 WINPR_ASSERT(device);
2329 WINPR_ASSERT(pid);
2330
2331 rdpdrPlugin* rdpdr = context->handle;
2332 WINPR_ASSERT(rdpdr);
2333
2334 RDPDR_DEVICE* copy = freerdp_device_clone(device);
2335 if (!copy)
2336 return ERROR_INVALID_DATA;
2337 UINT rc = devman_load_device_service(rdpdr->devman, copy, rdpdr->rdpcontext);
2338 *pid = copy->Id;
2339 freerdp_device_free(copy);
2340 if (rc == CHANNEL_RC_OK)
2341 rc = rdpdr_try_send_device_list_announce_request(rdpdr);
2342 return rc;
2343}
2344
2345static UINT rdpdr_unregister_device(RdpdrClientContext* context, size_t count, const uint32_t ids[])
2346{
2347 WINPR_ASSERT(context);
2348
2349 rdpdrPlugin* rdpdr = context->handle;
2350 WINPR_ASSERT(rdpdr);
2351
2352 for (size_t x = 0; x < count; x++)
2353 {
2354 const uintptr_t id = ids[x];
2355 devman_unregister_device(rdpdr->devman, (void*)id);
2356 }
2357 return rdpdr_send_device_list_remove_request(rdpdr, WINPR_ASSERTING_INT_CAST(uint32_t, count),
2358 ids);
2359}
2360
2361static UINT rdpdr_virtual_channel_event_initialized(rdpdrPlugin* rdpdr,
2362 WINPR_ATTR_UNUSED LPVOID pData,
2363 WINPR_ATTR_UNUSED UINT32 dataLength)
2364{
2365 WINPR_ASSERT(rdpdr);
2366#if !defined(_WIN32)
2367 WINPR_ASSERT(!rdpdr->stopEvent);
2368 rdpdr->stopEvent = CreateEvent(nullptr, TRUE, FALSE, nullptr);
2369 if (!rdpdr->stopEvent)
2370 return ERROR_INTERNAL_ERROR;
2371#endif
2372
2373 rdpdr->context.handle = rdpdr;
2374 rdpdr->context.RdpdrHotplugDevice = handle_hotplug;
2375 rdpdr->context.RdpdrRegisterDevice = rdpdr_register_device;
2376 rdpdr->context.RdpdrUnregisterDevice = rdpdr_unregister_device;
2377 return CHANNEL_RC_OK;
2378}
2379
2380static VOID VCAPITYPE rdpdr_virtual_channel_init_event_ex(LPVOID lpUserParam, LPVOID pInitHandle,
2381 UINT event, LPVOID pData, UINT dataLength)
2382{
2383 UINT error = CHANNEL_RC_OK;
2384 rdpdrPlugin* rdpdr = (rdpdrPlugin*)lpUserParam;
2385
2386 if (!rdpdr || (rdpdr->InitHandle != pInitHandle))
2387 {
2388 WLog_ERR(TAG, "error no match");
2389 return;
2390 }
2391
2392 WINPR_ASSERT(pData || (dataLength == 0));
2393
2394 switch (event)
2395 {
2396 case CHANNEL_EVENT_INITIALIZED:
2397 error = rdpdr_virtual_channel_event_initialized(rdpdr, pData, dataLength);
2398 break;
2399
2400 case CHANNEL_EVENT_CONNECTED:
2401 if ((error = rdpdr_virtual_channel_event_connected(rdpdr, pData, dataLength)))
2402 WLog_Print(rdpdr->log, WLOG_ERROR,
2403 "rdpdr_virtual_channel_event_connected failed with error %" PRIu32 "!",
2404 error);
2405
2406 break;
2407
2408 case CHANNEL_EVENT_DISCONNECTED:
2409 if ((error = rdpdr_virtual_channel_event_disconnected(rdpdr)))
2410 WLog_Print(rdpdr->log, WLOG_ERROR,
2411 "rdpdr_virtual_channel_event_disconnected failed with error %" PRIu32
2412 "!",
2413 error);
2414
2415 break;
2416
2417 case CHANNEL_EVENT_TERMINATED:
2418 rdpdr_virtual_channel_event_terminated(rdpdr);
2419 rdpdr = nullptr;
2420 break;
2421
2422 case CHANNEL_EVENT_ATTACHED:
2423 case CHANNEL_EVENT_DETACHED:
2424 default:
2425 WLog_Print(rdpdr->log, WLOG_ERROR, "unknown event %" PRIu32 "!", event);
2426 break;
2427 }
2428
2429 if (error && rdpdr && rdpdr->rdpcontext)
2430 setChannelError(rdpdr->rdpcontext, error,
2431 "rdpdr_virtual_channel_init_event_ex reported an error");
2432}
2433
2434/* rdpdr is always built-in */
2435#define VirtualChannelEntryEx rdpdr_VirtualChannelEntryEx
2436
2437FREERDP_ENTRY_POINT(BOOL VCAPITYPE VirtualChannelEntryEx(PCHANNEL_ENTRY_POINTS_EX pEntryPoints,
2438 PVOID pInitHandle))
2439{
2440 WINPR_ASSERT(pEntryPoints);
2441 WINPR_ASSERT(pInitHandle);
2442
2443 rdpdrPlugin* rdpdr = (rdpdrPlugin*)calloc(1, sizeof(rdpdrPlugin));
2444
2445 if (!rdpdr)
2446 {
2447 WLog_ERR(TAG, "calloc failed!");
2448 return FALSE;
2449 }
2450 rdpdr->log = WLog_Get(TAG);
2451
2452 rdpdr->clientExtendedPDU =
2453 RDPDR_DEVICE_REMOVE_PDUS | RDPDR_CLIENT_DISPLAY_NAME_PDU | RDPDR_USER_LOGGEDON_PDU;
2454 rdpdr->clientIOCode1 =
2455 RDPDR_IRP_MJ_CREATE | RDPDR_IRP_MJ_CLEANUP | RDPDR_IRP_MJ_CLOSE | RDPDR_IRP_MJ_READ |
2456 RDPDR_IRP_MJ_WRITE | RDPDR_IRP_MJ_FLUSH_BUFFERS | RDPDR_IRP_MJ_SHUTDOWN |
2457 RDPDR_IRP_MJ_DEVICE_CONTROL | RDPDR_IRP_MJ_QUERY_VOLUME_INFORMATION |
2458 RDPDR_IRP_MJ_SET_VOLUME_INFORMATION | RDPDR_IRP_MJ_QUERY_INFORMATION |
2459 RDPDR_IRP_MJ_SET_INFORMATION | RDPDR_IRP_MJ_DIRECTORY_CONTROL | RDPDR_IRP_MJ_LOCK_CONTROL |
2460 RDPDR_IRP_MJ_QUERY_SECURITY | RDPDR_IRP_MJ_SET_SECURITY;
2461
2462 rdpdr->clientExtraFlags1 = ENABLE_ASYNCIO;
2463
2464 rdpdr->pool = StreamPool_New(TRUE, 1024);
2465 if (!rdpdr->pool)
2466 {
2467 free(rdpdr);
2468 return FALSE;
2469 }
2470
2471 rdpdr->channelDef.options =
2472 CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP | CHANNEL_OPTION_COMPRESS_RDP;
2473 (void)sprintf_s(rdpdr->channelDef.name, ARRAYSIZE(rdpdr->channelDef.name),
2474 RDPDR_SVC_CHANNEL_NAME);
2475 rdpdr->sequenceId = 0;
2476 CHANNEL_ENTRY_POINTS_FREERDP_EX* pEntryPointsEx =
2477 (CHANNEL_ENTRY_POINTS_FREERDP_EX*)pEntryPoints;
2478
2479 if ((pEntryPointsEx->cbSize >= sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX)) &&
2480 (pEntryPointsEx->MagicNumber == FREERDP_CHANNEL_MAGIC_NUMBER))
2481 {
2482 rdpdr->rdpcontext = pEntryPointsEx->context;
2483 if (!freerdp_settings_get_bool(rdpdr->rdpcontext->settings,
2484 FreeRDP_SynchronousStaticChannels))
2485 rdpdr->async = TRUE;
2486 }
2487
2488 CopyMemory(&(rdpdr->channelEntryPoints), pEntryPoints, sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX));
2489 rdpdr->InitHandle = pInitHandle;
2490 const UINT rc = rdpdr->channelEntryPoints.pVirtualChannelInitEx(
2491 rdpdr, &rdpdr->context, pInitHandle, &rdpdr->channelDef, 1, VIRTUAL_CHANNEL_VERSION_WIN2000,
2492 rdpdr_virtual_channel_init_event_ex);
2493
2494 if (CHANNEL_RC_OK != rc)
2495 {
2496 WLog_Print(rdpdr->log, WLOG_ERROR, "pVirtualChannelInitEx failed with %s [%08" PRIX32 "]",
2497 WTSErrorToString(rc), rc);
2498 free(rdpdr);
2499 return FALSE;
2500 }
2501
2502 return TRUE;
2503}
freerdp_settings_get_string
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
freerdp_settings_get_uint32
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
freerdp_settings_get_bool
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
RDPDR_DEVICE
Definition settings_types.h:467
RDPDR_DRIVE
Definition settings_types.h:474
CHANNEL_ENTRY_POINTS_FREERDP_EX
Definition svc.h:60
wObject
This struct contains function pointer to initialize/free objects.
Definition collections.h:52
wObject::fnObjectFree
OBJECT_FREE_FN fnObjectFree
Definition collections.h:59