/libfido2

Provides library functionality for FIDO 2.0 and 2.1, including communication with a device over USB or NFC.

Primary LanguageCOtherNOASSERTION

libfido2

Linux Build Status (github actions) macOS Build Status (github actions) Windows Build Status (github actions) Fuzz Status (github actions) Fuzz Status (oss-fuzz)

libfido2 provides library functionality and command-line tools to communicate with a FIDO device over USB, and to verify attestation and assertion signatures.

libfido2 supports the FIDO U2F (CTAP 1) and FIDO2 (CTAP 2) protocols.

For usage, see the examples/ directory.

License

libfido2 is licensed under the BSD 2-clause license. See the LICENSE file for the full license text.

Supported Platforms

libfido2 is known to work on Linux, macOS, Windows, OpenBSD, and FreeBSD.

NFC support is available on Linux and Windows.

Documentation

Documentation is available in troff and HTML formats. An online mirror of libfido2's documentation is also available.

Bindings

Installation

Releases

The current release of libfido2 is 1.10.0. Please consult Yubico’s release page for source and binary releases.

Ubuntu 20.04 (Focal)

$ sudo apt install libfido2-1
$ sudo apt install libfido2-dev
$ sudo apt install libfido2-doc

Alternatively, newer versions of libfido2 are available in Yubico’s PPA. Follow the instructions for Ubuntu 18.04 (Bionic) below.

Ubuntu 18.04 (Bionic)

$ sudo apt install software-properties-common
$ sudo apt-add-repository ppa:yubico/stable
$ sudo apt update
$ sudo apt install libfido2-dev

macOS

$ brew install libfido2

Or from source, on UNIX-like systems:

$ cmake -B build
$ make -C build
$ sudo make -C build install

Depending on the platform, pkg-config may need to be installed, or the PKG_CONFIG_PATH environment variable set.

libfido2 depends on libcbor, OpenSSL 1.1 or newer, and zlib. On Linux, libudev (part of systemd) is also required.

For complete, OS-specific installation instructions, please refer to the .actions/ (Linux, macOS) and windows/ directories.

On Linux, you will need to add a udev rule to be able to access the FIDO device, or run as root. For example, the udev rule may contain the following:

#udev rule for allowing HID access to Yubico devices for FIDO support.

KERNEL=="hidraw*", SUBSYSTEM=="hidraw", \
  MODE="0664", GROUP="plugdev", ATTRS{idVendor}=="1050"