Package Exports

@vincss-public-projects/fido2-client

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vincss-public-projects/fido2-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

FIDO2 CLIENT - NODE.JS

FIDO2 is comprised of the W3C's Web Authentication specification (WebAuthn) and FIDO Alliance's corresponding Client-to-Authenticator Protocol (CTAP). FIDO2 supports passwordless, second-factor, and multi-factor user experiences with embedded (or bound) authenticators (such as biometric or PIN) or external/roaming authenticators (such as FIDO Security keys, mobile devices, wearables, etc...).
Currently, PIN protocols are only supported on Windows and Chrome on macOS. Therefore, we have created a PIN protocol support library that uses Node.js to communicate directly with the security key.
With this library, we have made it possible for users to use OpenVPN with a security key.

Summary

The FIDO2 client library lets you access FIDO2 devices over BLE, USB, and NFC transports.

Implementation

USB transport
BLE transport
NFC transport
Client PIN
Default modal

Installation

npm

npm install @vincss-public-projects/fido2-client

For more installation details, see installation.

Documents

Docs

Troubleshooting

Crash on Windows when plug/unplug Smart Card Reader

This is a known bug, it occurs in usb dependency (https://github.com/tessel/node-usb/issues/386), we can temporarily patch it by following below script

npm install --save-dev patch-package
npx patch-package --patch-dir node_modules/@vincss-public-projects/fido2-client/patches

Then you need to rebuild your project

# Node backend
npm rebuild
...
# Electron backend
npx electron-rebuild

Cannot find module 'noble-winrt' on Windows

Make sure you use the default Windows command line, 3rd party command line can make npm's behavior incorrect.

License

MIT

@vincss-public-projects/fido2-client