This project features two complimentary libraries to help reduce the amount of work needed to incorporate WebAuthn into a website. The following packages are maintained here:
SimpleWebAuthn can be installed from NPM and JSR in Node LTS 22.x and higher, Deno v2.4.x and higher projects, and other compatible runtimes (Cloudflare Workers, Bun, etc...)
See the packages' READMEs for more specific installation information.
SimpleWebAuthn actively supports the following runtimes, targeting versions using the guidelines below:
Node: LTS releases in Active and Maintenance mode, as per https://nodejs.org/en/about/previous-releases.
Deno: SemVer minor releases (e.g. 2.4.x) for up to one year after their release, as per
https://github.com/denoland/deno/releases.
In-depth documentation for this project is available at https://simplewebauthn.dev/docs
Thank you very much to those who sponsor my work. Your contributions help keep the open-source dream alive 🙇♂️
Interested in sponsoring this project? See here for more info: https://github.com/sponsors/MasterKale
Simple Authentication. Make login our problem. Not yours.
Simple, drop-in passkeys and MFA as a Service
For a practical guide to implementing these libraries, take a look at the example project. It includes a single-file Express server and a few HTML files that, combined with the packages in this repo, are close to all it takes to get up and running with WebAuthn.
The SimpleWebAuthn project is not currently open to external contributions.
Please submit an Issue and fill out the provided template with as much information as possible if you have found a bug in need of fixing.
You can also submit an Issue to request new features, or to suggest changes to existing features.
Install the following before proceeding:
- Deno v2.4.x
After pulling down the code, set up dependencies:
deno install
To run unit tests for all workspace packages, use the test series of scripts:
cd packages/browser/ && deno task test
cd packages/server/ && deno task test
Tests can be run in watch mode with the test:watch series of scripts:
cd packages/browser/ && deno task test:watch
cd packages/server/ && deno task test:watch
The following additional dependencies are needed locally to display test coverage reports:
- genhtml (run
brew install lcovon macOS to install this CLI tool)
Then run the following command to run tests and then host a coverage report at http://127.0.0.1:8000:
deno run test:coverage