Replace libusbsio with hidapi

This commit is extracted from: Nitrokey/pynitrokey#523 If the hid module cannot be loaded, a warning is raised so that the SDK can still be used for other devices if hidapi is not working correctly. Co-authored-by: Sosthène Guédon <[email protected]>
Nitrokey · Aug 12, 2024 · fed610e · fed610e
1 parent 2f61618
commit fed610e
Show file tree

Hide file tree

Showing 8 changed files with 170 additions and 307 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
 
 - Update `protobuf` dependency to 5.26
 - Vendor `spsdk` dependency to reduce the total number of dependencies
+- Replace `libusbsio` dependency with `hidapi`
 
 ## [v0.1.0](https://github.com/Nitrokey/nitrokey-sdk-py/releases/tag/v0.1.0) (2024-07-29)
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -27,7 +27,7 @@ tlv8 = "^0.10"
 # lpc55
 crcmod = "^1.7"
 cryptography = ">=42"
-libusbsio = "^2.1"
+hidapi = "^0.14"
 
 # nrf52
 ecdsa = "^0.19"
@@ -59,8 +59,3 @@ mypy_path = "stubs"
 show_error_codes = true
 python_version = "3.9"
 strict = true
-
-# libusbsio is used by lpc55_upload, will be replaced eventually
-[[tool.mypy.overrides]]
-module = ["libusbsio.*"]
-ignore_missing_imports = true
diff --git a/src/nitrokey/trussed/_bootloader/lpc55.py b/src/nitrokey/trussed/_bootloader/lpc55.py
@@ -19,7 +19,6 @@
 from .lpc55_upload.mboot.properties import PropertyTag
 from .lpc55_upload.sbfile.sb2.images import BootImageV21
 from .lpc55_upload.utils.interfaces.device.usb_device import UsbDevice
-from .lpc55_upload.utils.usbfilter import USBDeviceFilter
 
 RKTH = bytes.fromhex("050aad3e77791a81e59c5b2ba5a158937e9460ee325d8ccba09734b8fdebb171")
 KEK = bytes([0xAA] * 32)
@@ -101,9 +100,8 @@ def update(
 
     @classmethod
     def _list_vid_pid(cls: type[T], vid: int, pid: int) -> list[T]:
-        device_filter = USBDeviceFilter(f"0x{vid:x}:0x{pid:x}")
         devices = []
-        for device in UsbDevice.enumerate(device_filter):
+        for device in UsbDevice.enumerate(vid=vid, pid=pid):
             try:
                 devices.append(cls(device))
             except ValueError:
@@ -114,8 +112,7 @@ def _list_vid_pid(cls: type[T], vid: int, pid: int) -> list[T]:
 
     @classmethod
     def _open(cls: type[T], path: str) -> Optional[T]:
-        device_filter = USBDeviceFilter(path)
-        devices = UsbDevice.enumerate(device_filter)
+        devices = UsbDevice.enumerate(path=path)
         if len(devices) == 0:
             logger.warn(f"No HID device at {path}")
             return None