/spice-usbdk

A Windows filter driver that supports redirection of USB traffic to user-space application, to be used by Spice USB redirection (windows client side).

Primary LanguageC++Apache License 2.0Apache-2.0

Build Status

UsbDk

UsbDk (USB Development Kit) is a open-source library for Windows meant to provide user mode applications with direct and exclusive access to USB devices by detaching those from Windows PNP manager and device drivers and providing user mode with API for USB-specific operations on the device.

The library is intended to be as generic as possible, support all types of USB devices, bulk and isochronous transfers, composite devices etc.

Library supports all Windows OS versions starting from Windows XP/2003.

Documentation

  • See ARCHITECTURE document in the source tree root.
  • See Documentation folder in the source tree root.
  • See UsbDkHelper\UsbDkHelper.h UsbDkHelper\UsbDkHelperHider.h for API documentation

Building

Tools required:

  • Visual Studio 2015/Visual Studio 2015 Express update 3 or newer
  • WDK 10
  • Windows 10 SDK
  • Wix Toolset V3.8 (for building MSI installer)
  • WDK 7.1 (for Windows XP/2003/Vista/2008 builds)

Compilation

Just open UsbDk.sln from the source tree root in Visual Studio 2015 and compile desired configuration.

Installing and running

Use UsbDkController.exe to install/uninstall and verify basic operation. Run UsbDkController.exe without parameters for command line options.

Known issues

  • Installation on 64-bit versions of Windows 7 fails if security update 3033929 is not installed. Reason: UsbDk driver is signed by SHA-256 certificate. Without this update Windows 7 does not recognize the signature properly and fails to load the driver.