Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 4.2 KB

README.md

File metadata and controls

66 lines (40 loc) · 4.2 KB
Raw

Ledger App Security Key

Ledger App Security Key for Ledger devices.

This application implements an U2F and CTAP2 Authenticator for Ledger devices.

A great introduction to WebAuthn can be found here. You can also use this demo to test this app, or use its debugger to do some advance testing.

Specifications

  • FIDO U2F (CTAP 1) specification can be found here.
  • FIDO v2 (CTAP 2) specification can be found here.
  • FIDO v2.1 (CTAP 2.1) specification can be found here.

Building

With VSCode

You can quickly setup a convenient environment to build and test your application by using Ledger's VSCode developer tools extension which leverages the ledger-app-dev-tools docker image.

With a terminal

The ledger-app-dev-tools docker image contains all the required tools and libraries to build, test and load an application.

Acronyms

Acronyms specific to the project:

  • CBIP: CBOR in place

Acronyms not specific to the project:

  • CBOR: Concise Binary Object Representation (serialization format standardized as RFC7049 and described on Wikipedia)
  • COSE: CBOR Object Signing and Encryption (serialization format standardized as RFC8152 which uses identifiers assigned by IANA)
  • CTAP: Client to Authenticator Protocol (component of FIDO2 specifications, described on FIDO Alliance's website)
  • FIDO2: Fast IDentity Online (open authentication standard, hosted by the FIDO Alliance)
  • U2F: Universal 2nd Factor (open authentication standard, precedes FIDO2)
  • WebAuthn: Web Authentication (component of FIDO2 specifications, described on FIDO Alliance's website)
  • UP: User Presence (for example clicking buttons)
  • UV: User Verification (for example verifying a PIN code)

Testing the app

See dedicated README.md in tests directory.

Known limitations

  • On Firefox on Linux, Nano S Plus is missing in snap udev rules.
  • There are some instabilities on Safari on MacOS, it's recommended to use another browser.
  • On Android, it is supported as soon as you have Google Play services v23.35 or above and that the service configuration doesn't require Discoverable Credentials.

Due to OS constraints, this Security Key App as some limitations:

  • Discoverable / Resident credentials are supported but are stored on a part of the device flash that will be wiped upon app deletion, which can happen:
    • If the user chooses to uninstall it from Ledger Live
    • If the user chooses to update the app to a new available version
    • If the user updates the OS version That is why they are not enabled by default, and should be manually enabled in the settings. See HAVE_RK_SUPPORT_SETTING section on the Makefile for more explanations.
  • Following FIDO2 spec, there should be a way to revoked credentials. A revocation mechanism has been implemented based on a counter that - as discoverable credentials - will be wiped upon app deletion. therefore, in order to avoid weird issue on user side, this counter as been disabled. See HAVE_NO_RESET_GENERATION_INCREMENT section on the Makefile for more explanations.

Please look at the dedicated section at the end of this blog post for more detailed explanations.