fwupd/plugins/nitrokey
Richard Hughes bf72d393fd Split up FuUsbDevice into ->open() and ->setup()
Before this change calling FuUsbDevice->open() opened the device, and
also unconditionally added various GUIDs and InstanceIDs which we
normally do in setup.
Then fu_device_setup() would call the FuSubclass->setup() vfunc which
would have no way of either opting out of the FuUsbDevice->setup()-like
behaviour, or controlling if the parent class ->setup is run before or
after the subclass setup.

Split up FuUsbDevice->open() into clear ->open() and ->setup() phases
and add the parent class calls where appropriate.

This means that ->setup() now behaves the same as all the other vfuncs.
2021-06-17 16:21:41 +01:00
..
fu-nitrokey-common.c Remove the unused Emacs indenting headers from all source files 2018-08-09 12:48:04 +01:00
fu-nitrokey-common.h trivial: Remove G_BEGIN_DECLS from all private headers 2019-10-09 20:02:16 +01:00
fu-nitrokey-device.c Split up FuUsbDevice into ->open() and ->setup() 2021-06-17 16:21:41 +01:00
fu-nitrokey-device.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-plugin-nitrokey.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-self-test.c trivial: Fix two more missing <string.h> instances 2020-12-14 20:24:04 +00:00
lsusb.txt Add a nitrokey plugin 2017-11-13 16:25:46 +00:00
meson.build Support more than one protocol for a given device 2021-03-01 16:14:36 +00:00
nitrokey.quirk Simplify the quirk file format 2021-03-03 08:30:34 +00:00
README.md Add a new internal flag to opt-in to GUID matching 2021-02-25 15:47:25 +00:00

Nitrokey Support

Introduction

This plugin is used to get the correct version number on Nitrokey storage devices. These devices have updatable firmware but so far no updates are available from the vendor.

The device is switched to a DFU bootloader only when the secret firmware pin is entered into the nitrokey-app tool. This cannot be automated.

GUID Generation

These devices use the standard USB DeviceInstanceId values, e.g.

  • USB\VID_20A0&PID_4109&REV_0001
  • USB\VID_20A0&PID_4109
  • USB\VID_20A0

Update Behavior

The device usually presents in runtime mode, but on detach re-enumerates with a different USB VID and PID in DFU mode. The device is then handled by the dfu plugin.

On DFU attach the device again re-enumerates back to the runtime mode.

For this reason the REPLUG_MATCH_GUID internal device flag is used so that the bootloader and runtime modes are treated as the same device.

Vendor ID Security

The vendor ID is set from the USB vendor, in this instance set to USB:0x20A0 in runtime mode and USB:0x03EB in bootloader mode.

External interface access

This plugin requires read/write access to /dev/bus/usb.