GUACAMOLE-522: USB Device Redirection integration with RDP.

Author: aleitner

src/libguac/guacamole/protocol.h

@@ -1182,7 +1182,9 @@ int guac_protocol_send_usbdisconnect(guac_socket* socket,
  *     The unique identifier of the USB device.
  *
  * @param endpoint_number
- *     The endpoint number to send data to.
+ *     The USB endpoint number identifying the logical communication channel
+ *     for this data transfer. The valid endpoint numbers for a device are
+ *     provided in the interface_data parameter during usbconnect.
  *
  * @param data
  *     The base64-encoded data to send to the USB device.

src/libguac/guacamole/user-fntypes.h

@@ -504,36 +504,36 @@ typedef int guac_user_put_handler(guac_user* user, guac_object* object,
  * instruction has been received from a user. This indicates that the user
  * has connected a USB device via WebUSB and it is available for redirection.
  *
- * @param user
- *     The user that connected the USB device.
- *
  * @param device_id
- *     The unique identifier for the USB device.
+ *     The unique identifier for the USB device. Required.
  *
  * @param vendor_id
- *     The vendor ID of the USB device.
+ *     The vendor ID of the USB device. Required.
  *
  * @param product_id
- *     The product ID of the USB device.
+ *     The product ID of the USB device. Required.
  *
  * @param device_name
- *     The human-readable name of the device.
+ *     The human-readable name of the device. Required (may be empty string).
  *
  * @param serial_number
- *     The serial number of the device, if available.
+ *     The serial number of the device. Optional (may be NULL or empty string
+ *     if not available).
  *
  * @param device_class
- *     The USB device class.
+ *     The USB device class. Required.
  *
  * @param device_subclass
- *     The USB device subclass.
+ *     The USB device subclass. Required.
  *
  * @param device_protocol
- *     The USB device protocol.
+ *     The USB device protocol. Required.
  *
  * @param interface_data
- *     Encoded string containing interface and endpoint information in the
- *     format: "iface_num:class:subclass:protocol:ep_num:dir:type:size,..."
+ *     Encoded string containing interface and endpoint information. Required.
+ *     Format: "ifaceNum:class:subclass:protocol:ep1Num:ep1Dir:ep1Type:ep1Size;ep2...,iface2..."
+ *     where multiple endpoints within an interface are separated by semicolons
+ *     and multiple interfaces are separated by commas.
  *
  * @return
  *     Zero if the USB connect event was handled successfully, or non-zero if 
@@ -556,7 +556,9 @@ typedef int guac_user_usbconnect_handler(guac_user* user, const char* device_id,
 *     The unique identifier for the USB device.
 *
 * @param endpoint_number
-*     The endpoint number the data originated from.
+*     The USB endpoint number that the data originated from. Endpoint
+*     numbers correspond to the endpoints defined in the device's
+*     interface_data from the usbconnect instruction.
 *
 * @param data
 *     The base64-encoded USB data.

src/libguac/guacamole/user.h

@@ -541,9 +541,11 @@ struct guac_user {
 /**
      * Handler for USB connect events sent by the Guacamole web-client.
      *
-     * The handler takes the user that connected the device, the device ID,
-     * vendor ID, product ID, device name, serial number, device class,
-     * device subclass, device protocol, and interface data.
+     * The handler takes the user that connected the device, the device ID
+     * (required), vendor ID (required), product ID (required), device name
+     * (required), serial number (optional - may be NULL or empty), device class
+     * (required), device subclass (required), device protocol (required), and
+     * interface data (required).
      *
      * Example:
      * @code

src/libguac/user-handlers.h

@@ -233,22 +233,22 @@ __guac_instruction_handler __guac_handshake_timezone_handler;
 
 /**
  * Internal initial handler for the usbconnect instruction. When a usbconnect
- * instruction is received, this handler will be called. The client's 
+ * instruction is received, this handler will be called. The user's
  * usbconnect handler will be invoked if defined.
  */
 __guac_instruction_handler __guac_handle_usbconnect;
 
 /**
  * Internal initial handler for the usbdata instruction. When a usbdata
- * instruction is received, this handler will be called. The client's 
+ * instruction is received, this handler will be called. The user's
  * usbdata handler will be invoked if defined.
  */
 __guac_instruction_handler __guac_handle_usbdata;
 
 /**
  * Internal initial handler for the usbdisconnect instruction. When a 
  * usbdisconnect instruction is received, this handler will be called. 
- * The client's usbdisconnect handler will be invoked if defined.
+ * The user's usbdisconnect handler will be invoked if defined.
  */
 __guac_instruction_handler __guac_handle_usbdisconnect;
 

src/protocols/rdp/Makefile.am

@@ -59,6 +59,8 @@ libguac_client_rdp_la_SOURCES =                  \
     channels/rdpgfx.c                            \
     channels/rdpsnd/rdpsnd-messages.c            \
     channels/rdpsnd/rdpsnd.c                     \
+    channels/usb-redirection/usb-redirection.c   \
+    channels/usb-redirection/usb-manager.c    \
     client.c                                     \
     color.c                                      \
     decompose.c                                  \
@@ -104,6 +106,8 @@ noinst_HEADERS =                                 \
     channels/rdpgfx.h                            \
     channels/rdpsnd/rdpsnd-messages.h            \
     channels/rdpsnd/rdpsnd.h                     \
+    channels/usb-redirection/usb-redirection.h   \
+    channels/usb-redirection/usb-manager.h    \
     client.h                                     \
     color.h                                      \
     decompose.h                                  \
@@ -119,6 +123,8 @@ noinst_HEADERS =                                 \
     plugins/channels.h                           \
     plugins/guacai/guacai-messages.h             \
     plugins/guacai/guacai.h                      \
+    plugins/guacusb/guacusb-messages.h           \
+    plugins/guacusb/guacusb.h                    \
     plugins/ptr-string.h                         \
     pointer.h                                    \
     print-job.h                                  \
@@ -152,7 +158,8 @@ libguac_client_rdp_la_LIBADD = \
 
 freerdp_LTLIBRARIES =            \
     libguac-common-svc-client.la \
-    libguacai-client.la
+    libguacai-client.la            \
+    libguacusb-client.la
 
 freerdpdir = @FREERDP_PLUGIN_DIR@
 
@@ -201,6 +208,33 @@ libguacai_client_la_LIBADD = \
     @COMMON_LTLIB@           \
     @LIBGUAC_LTLIB@
 
+#
+# URBDRC USB Redirection Plugin - OWNS ALL USB FUNCTIONALITY
+#
+
+libguacusb_client_la_SOURCES =                          \
+    channels/usb-redirection/usb-manager.c                \
+    plugins/guacusb/guacusb-messages.c                  \
+    plugins/guacusb/guacusb.c                           \
+    plugins/ptr-string.c
+
+libguacusb_client_la_CFLAGS = \
+    -Werror -Wall -Iinclude   \
+    @COMMON_INCLUDE@          \
+    @COMMON_SSH_INCLUDE@      \
+    @LIBGUAC_INCLUDE@         \
+    @RDP_CFLAGS@
+
+libguacusb_client_la_LDFLAGS =     \
+    -module -avoid-version -shared \
+    -export-dynamic                \
+    @PTHREAD_LIBS@                 \
+    @RDP_LIBS@
+
+libguacusb_client_la_LIBADD = \
+    @COMMON_LTLIB@            \
+    @LIBGUAC_LTLIB@
+
 #
 # Optional SFTP support
 #
@@ -259,4 +293,4 @@ _generated_channel_entry_wrappers.c: $(srcdir)/plugins/channels.h $(srcdir)/plug
 EXTRA_DIST =                           \
     $(rdp_keymaps)                     \
     keymaps/generate.pl                \
-    plugins/generate-entry-wrappers.pl
+    plugins/generate-entry-wrappers.pl