Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 4.1 KB

README.md

File metadata and controls

74 lines (52 loc) · 4.1 KB
Raw

libmicrofido2 - Minimal FIDO2 Library for Microcontrollers

libmicrofido2 is a minimal FIDO2 library that is designed to be used in microcontrollers. It is heavily inspired by the libfido2 and aims to have a similar API.

Features

  • No heap allocations: All structures are allocated on the stack.
  • Physical layer agnostic: The transport layer is left mostly to the user, so regardless of whether you want to use USB, NFC, or any other technology you can use this library. While we implemented the base layer for NFC, this can be easily implemented for other physical layers as well.
  • Fully customizable cryptographic algorithms: All of the cryptographic algorithms (Ed25519, AES GCM, SHA256, SHA512) can be replaced by the user entirely to enable hardware acceleration (see examples/nrf52/hw_crypto/hw_crypto.c).

Limitations

  • We chose the cryptographic library implementations that papers say were the fastest, as that was what mattered to us the most. However, we have not evaluated their security regarding attacks such as side-channel attacks.
  • Random Number Generation is currently not implemented. (#42)
  • The large blob currently cannot be written. (#43)
  • Only a minimal subset of the CTAP 2.1 commands are supported (authenticatorGetInfo, authenticatorLargeBlobs, authenticatorGetAssertion).
  • Only a minimal subset of cryptographic algorithms specified in the FIDO2 standard supported. For signature verification, only Ed25519 is supported.
  • Variable length fields and fields with arbitrary values (like the extension field in authenticatorGetInfo) are not supported. Instead, these fields are parsed into statically allocatable structures (see info.h and info.c for examples of this).

Building

The build system is based on cmake >= 3.10.

Desktops

You can build the library for desktops (we tested Linux and macOS):

mkdir -p build && cd build
cmake .. -DCMAKE_VERBOSE_MAKEFILE=1 -DCMAKE_BUILD_TYPE=Debug # Or Release
make -j

Using Toolchains (AVR-only)

Currently, we only provide a toolchain file for the ATmega (see #37). With that, you can easily build the library as a static library as follows:

mkdir -p build && cd build
# for AVR8 Debug builds
cmake .. -DCMAKE_VERBOSE_MAKEFILE=1 -DCMAKE_TOOLCHAIN_FILE=../avr.toolchain -DCMAKE_BUILD_TYPE=Debug
# for AVR8 Release builds
cmake .. -DCMAKE_VERBOSE_MAKEFILE=1 -DCMAKE_TOOLCHAIN_FILE=../avr.toolchain -DCMAKE_BUILD_TYPE=Release
make -j

Other Systems

Building the library for other systems depends on the framework you use for your microcontroller. We provide examples for the ESP-32 using ESP-IDF and the nRF52 using Zephyr.

Usage

We provide fairly extensive examples of using this library in the examples directory. Most of the time, you'll only need to #include <fido.h> as that file includes most of the others. In case you want to overwrite the implementation of the cryptographic algorithms, also checkout the crypto.h and random.h files.

Development

We are happy to receive any PRs that further improve this library. In case you want to modify the library for your needs, checkout DEVELOPMENT.md.

Acknowledgements

This library references code from: