repository·master·Indexed 25 days ago
https://github.com/masterkale/simplewebauthnA suite of libraries designed to reduce the complexity of implementing WebAuthn and Passkeys in web applications. It includes @simplewebauthn/server for server-side verification and @simplewebauthn/browser for client-side interaction. Compatible with Node.js (LTS 20.x+), Deno (v1.43+), Cloudflare Workers, and Bun. The server package supports various W3C attestation formats including Android Key, Apple, FIDO U2F, and TPM.
SimpleWebAuthn provides two complementary libraries designed to simplify the integration of WebAuthn into web applications:
@simplewebauthn/server: Handles the server-side logic for WebAuthn authentication flows.@simplewebauthn/browser: Provides client-side utilities to interact with the WebAuthn API in the browser.SimpleWebAuthn can be installed via NPM or JSR. It is compatible with the following runtimes:
For specific installation commands for each package, refer to their individual READMEs.
The types defined in @simplewebauthn/types are not consumed directly as a dependency in production. Instead, they are codegen'd into @simplewebauthn/browser and @simplewebauthn/server to ensure the typings are bundled within those specific packages.
If you are contributing to the repository and make changes to the typings in this package, you must run the codegen task to propagate those changes to the browser and server packages, and then commit the resulting changes.
deno task codegenFor Deno environments (v1.43 and higher), add the package using JSR.
deno add jsr:@simplewebauthn/browserThe example package serves as a fully-functional reference implementation of both @simplewebauthn/server and @simplewebauthn/browser. It demonstrates how to integrate these two packages to create a complete WebAuthn flow. For a detailed, in-depth guide on how the example project is structured and how the components interact, refer to the official documentation.
https://simplewebauthn.dev/docs/advanced/example-projectYou can install the @simplewebauthn/server package via NPM or JSR depending on your runtime environment.
Requires Node LTS 20.x or higher.
Requires Deno v1.43 or higher.
Support for importing SimpleWebAuthn packages via deno.land/x URLs is deprecated. For Deno v1.43 and higher, use Deno's native support for JSR imports. You can install the server package using the deno add command, which allows you to use standard npm-style import specifiers in your code.
# Deno v1.43 and higher
deno add jsr:@simplewebauthn/serverYou can include the library via unpkg in your HTML <head>. The library's methods will be available on the global SimpleWebAuthnBrowser object.
Use this version if you only need to support modern browsers.
Use this version if you need to support WebAuthn feature detection in deprecated browsers like IE11 and Edge Legacy. This version includes polyfills that enable the use of browserSupportsWebAuthn() in older browsers, though it adds bundle size overhead.
If you are currently using deno.land/x URLs to import SimpleWebAuthn, you should migrate to JSR imports.
Old way (Deprecated):
import { generateAuthenticationOptions } from 'https://deno.land/x/simplewebauthn/deno/server.ts';New way (JSR):
import { generateAuthenticationOptions } from 'jsr:@simplewebauthn/server';For Node.js environments (LTS 20.x and higher), install the package using npm.
npm install @simplewebauthn/browserWhen sending WebAuthn options from a server to a browser, or receiving responses from a browser to a server, you cannot use the standard DOM types because they contain ArrayBuffer objects which are not JSON-serializable.
Use the *JSON interfaces provided by this package to define the shape of the data being transmitted over the wire. These interfaces use Base64URLString for all binary data fields.
PublicKeyCredentialCreationOptionsJSON: Use this to send registration options to the browser.PublicKeyCredentialRequestOptionsJSON: Use this to send authentication options to the browser.RegistrationResponseJSON: Use this to receive registration results from the browser.AuthenticationResponseJSON: Use this to receive authentication results from the browser.