fwupd/plugins/solokey
Richard Hughes 1981c63d58 Remove FuFirmwareImage and just use FuFirmware instead
This allows us to 'nest' firmware formats, and removes a ton of duplication.

The aim here is to deprecate FuFirmwareImage -- it's almost always acting
as a 'child' FuFirmware instance, and even copies most of the vfuncs to allow
custom types. If I'm struggling to work out what should be a FuFirmware and
what should be a FuFirmwareImage then a plugin author has no hope.

For simple payloads we were adding bytes into an image and then the image into
a firmware. This gets really messy when most plugins are treating the FuFirmware
*as* the binary firmware file.

The GBytes saved in the FuFirmware would be considered the payload with the
aim of not using FuFirmwareImage in the single-image case.
2021-03-09 21:14:12 +00:00
..
data Add support for the SoloKey Secure 2019-07-30 16:16:14 +01:00
fu-plugin-solokey.c Use FWUPD_COMPILATION define to indicate an in tree build 2021-01-22 14:01:25 -06:00
fu-solokey-device.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-solokey-device.h trivial: Remove G_BEGIN_DECLS from all private headers 2019-10-09 20:02:16 +01:00
fu-solokey-firmware.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-solokey-firmware.h trivial: Remove G_BEGIN_DECLS from all private headers 2019-10-09 20:02:16 +01:00
meson.build Move the plugin build logic to the plugins themselves 2021-02-18 14:46:20 +00:00
README.md Add a new internal flag to opt-in to GUID matching 2021-02-25 15:47:25 +00:00
solokey.quirk Simplify the quirk file format 2021-03-03 08:30:34 +00:00

SoloKey Support

Introduction

The SoloKey Secure and Hacker is an affordable open source FIDO2 security key.

All hardware supports the U2F HID flashing protocol. The Hacker version is not supported and the existing DFU update procedure should be used.

Firmware Format

The daemon will decompress the cabinet archive and extract a firmware blob in a JSON wrapped, base-64, Intel hex file.

This plugin supports the following protocol ID:

  • com.solokeys

GUID Generation

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

  • USB\VID_0483&PID_A2CA&REV_0001
  • USB\VID_0483&PID_A2CA

Update Behavior

The firmware is deployed when the device is in normal runtime mode, and the device will reset when the new firmware has been written.

Vendor ID Security

The vendor ID is set from the USB vendor, in this instance set to USB:0x0483

External interface access

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