SimpleWebAuthn <!-- omit in toc -->

• Overview
• Installation
• Documentation
• Sponsors
• Example
• Contributions
• Development

Overview

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/server
• @simplewebauthn/browser

Installation

SimpleWebAuthn can be installed from NPM and
JSR in Node LTS 20.x and higher, Deno v1.43 and higher
projects, and other compatible runtimes (Cloudflare Workers, Bun, etc...)

See the packages' READMEs for more specific installation information.

Documentation

In-depth documentation for this project is available at https://simplewebauthn.dev/docs

Sponsors

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

🌟 Platinum Sponsor <!-- omit from toc -->

<p class="sponsor-logo"> <a href="https://a0.to/signup/simplewebauthn"> <img src="https://github.com/user-attachments/assets/82bd296f-81c9-455f-b561-29119bd941c3" width="270" height="101" alt="Auth0 by Okta" /> <br /> <em>Simple Authentication. Make login our problem. Not yours.</em> </a> </p>

🏅 Gold Sponsor <!-- omit from toc -->

<p class="sponsor-logo"> <a href="https://www.authsignal.com"> <img src="https://github.com/user-attachments/assets/475e8759-bb1a-4614-b3f9-b38002b11f34" width="270" height="63" alt="Authsignal" /> <br /> <em>Simple, drop-in passkeys and MFA as a Service</em> </a> </p>

Example

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.

Contributions

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.

Development

Install the following before proceeding:

• Deno v2.4.x

After pulling down the code, set up dependencies:

shCopy
$> deno install

To run unit tests for all workspace packages, use the test series of scripts:

shCopy
# Run an individual package's tests
$> 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:

shCopy
$> cd packages/browser/ && deno task test:watch
$> cd packages/server/ && deno task test:watch