Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/masterkale/simplewebauthn
WebAuthn, Simplified. A collection of TypeScript-first libraries for simpler WebAuthn integration. Supports modern browsers, Node, Deno, and more.
https://github.com/masterkale/simplewebauthn
browser commonjs deno denoland esm fido node passkeys typescript umd webauthn
Last synced: 7 days ago
JSON representation
WebAuthn, Simplified. A collection of TypeScript-first libraries for simpler WebAuthn integration. Supports modern browsers, Node, Deno, and more.
- Host: GitHub
- URL: https://github.com/masterkale/simplewebauthn
- Owner: MasterKale
- License: mit
- Created: 2020-05-22T16:21:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-27T22:38:56.000Z (3 months ago)
- Last Synced: 2024-10-29T14:54:11.750Z (3 months ago)
- Topics: browser, commonjs, deno, denoland, esm, fido, node, passkeys, typescript, umd, webauthn
- Language: TypeScript
- Homepage: https://simplewebauthn.dev
- Size: 4.81 MB
- Stars: 1,586
- Watchers: 25
- Forks: 134
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# SimpleWebAuthn
[](https://www.npmjs.com/search?q=simplewebauthn)
[](https://jsr.io/@simplewebauthn)
- [Overview](#overview)
- [Installation](#installation)
- [Documentation](#documentation)
- [Sponsors](#sponsors)
- [Example](#example)
- [Contributions](#contributions)
- [Development](#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](https://github.com/MasterKale/SimpleWebAuthn/tree/master/packages/server)
- [@simplewebauthn/browser](https://github.com/MasterKale/SimpleWebAuthn/tree/master/packages/browser)
## Installation
SimpleWebAuthn can be installed from **[NPM](https://www.npmjs.com/search?q=%40simplewebauthn)** and
**[JSR](https://jsr.io/@simplewebauthn)** 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
Simple Authentication. Make login our problem. Not yours.
### 🏅 Gold Sponsor
Simple, drop-in passkeys and MFA as a Service
## Example
For a practical guide to implementing these libraries, take a look at the
[example project](https://github.com/MasterKale/SimpleWebAuthn/tree/master/example). 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](https://github.com/MasterKale/SimpleWebAuthn/issues/new/choose) 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](https://github.com/MasterKale/SimpleWebAuthn/issues/new/choose) to
request new features, or to suggest changes to existing features.
## Development
Install the following before proceeding:
- **Deno v2.1.x**
After pulling down the code, set up dependencies:
```sh
$> deno install
```
To run unit tests for all workspace packages, use the `test` series of scripts:
```sh
# 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:
```sh
$> cd packages/browser/ && deno task test:watch
$> cd packages/server/ && deno task test:watch
```