Skip to content

README.md: Add NFC support #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlfioEmanueleFresta merged 2 commits into from
Jan 5, 2026
Merged

README.md: Add NFC support #163

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8925f0
README.md: Add NFC support
AlfioEmanueleFresta Dec 27, 2025
a061bb7
README.md: Pivot transports table
AlfioEmanueleFresta Dec 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,13 @@ _Looking for the D-Bus API proposal?_ Check out [credentialsd][credentialsd].

## Transports

| | USB (HID) | Bluetooth Low Energy (BLE) | NFC | TPM 2.0 (Platform) | Hybrid (caBLEv2) |
| -------------------- | ------------------------- | -------------------------- | --------------------- | --------------------- | ---------------------------------- |
| **FIDO U2F** | 🟢 Supported (via hidapi) | 🟢 Supported (via bluez) | 🟠 Planned ([#5][#5]) | 🟠 Planned ([#4][#4]) | N/A |
| **WebAuthn (FIDO2)** | 🟢 Supported (via hidapi) | 🟢 Supported (via bluez) | 🟠 Planned ([#5][#5]) | 🟠 Planned ([#4][#4]) | 🟢 Supported |
| | FIDO U2F | WebAuthn (FIDO2) |
| ---------------------------- | --------------------- | --------------------- |
| **USB (HID)** | 🟢 Supported (hidapi) | 🟢 Supported (hidapi) |
| **Bluetooth Low Energy** | 🟢 Supported (bluez) | 🟢 Supported (bluez) |
| **NFC** | 🟢 Supported (pcsc or libnfc) | 🟢 Supported (pcsc or libnfc) |
| **TPM 2.0 (Platform)** | 🟠 Planned ([#4][#4]) | 🟠 Planned ([#4][#4]) |
| **Hybrid (QR code scan, aka caBLE v2)** | N/A | 🟢 Supported |

## Example programs

Expand All @@ -52,6 +55,7 @@ After cloning, you can try out [one of the libwebauthn examples](libwebauthn/exa
$ cd libwebauthn
$ git submodule update --init
$ cargo run --example webauthn_hid
$ cargo run --example webauthn_nfc
$ cargo run --example webauthn_cable
$ cargo run --example u2f_hid
```
Expand All @@ -72,7 +76,6 @@ If you don't know where to start, check out the _Issues_ tab.
[#10]: https://github.com/linux-credentials/libwebauthn/issues/10
[#3]: https://github.com/linux-credentials/libwebauthn/issues/3
[#4]: https://github.com/linux-credentials/libwebauthn/issues/4
[#5]: https://github.com/linux-credentials/libwebauthn/issues/5
[#17]: https://github.com/linux-credentials/libwebauthn/issues/17
[#18]: https://github.com/linux-credentials/libwebauthn/issues/18
[#31]: https://github.com/linux-credentials/libwebauthn/issues/31
Loading