Skip to content

๐Ÿ” A small WebAuthn API wrapper that translates to/from pure JSON using base64url.

License

Notifications You must be signed in to change notification settings

cedarcode/webauthn-json

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

96 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

@github/webauthn-json

@github/webauthn-json is a client-side Javascript library that serves as convenience wrapper for the the WebAuthn API by encoding binary data using base64url (also known as "websafe" or "urlsafe" base64).

The WebAuthn API itself takes input and output values that look almost like JSON, except that binary data is represented as ArrayBuffers. Using webauthn-json allows the data to be sent from/to the server as normal JSON without client-side processing.

Usage

  1. Replace calls to navigator.credentials.create() with create(), and navigator.credentials.get() with get().
  2. Encode/decode binary values on the server as base64url.

Example

Install using:

npm install --save @github/webauthn-json

Then:

import {create} from "@github/webauthn-json"

async auth() {
  const request = await fetch("...");
  const response = await create(request.json());
  await fetch("...", {
    method: "POST",
    body: JSON.stringify(response)
  });
}

See here for fully working client-side demo code.

API

function create(requestJSON: JSON): Promise<JSON>;
function get(requestJSON: JSON): Promise<JSON>;
function supported(): boolean;

Schema

There are are several ways to encode JSON with binary fields. @github/webauthn-json focuses on one simple approach: converting the known structure using a simple (custom) schema format. @github/webauthn-json uses a few tricks for a compact schema encoding: the production build is about โ‰ˆ2KB uncompressed (<1KB gzipped).

Right now, we only convert fields explicitly known to be used by the WebAuthn API. This means that you'll have to update to a newer version of this library if you want to use new fields in the future.

To print the current schema, run:

npx @github/webauthn-json schema

Extensions

Modern browsers generally only support a small numbe rof extensions. To save code size, this library only includes the following extensions in the main build:

  • appid
  • appidExclude

If you need to convert additional input or output extensions, use createExtended() and getExtended() from @github/webauthn-json/dist/extended.

Contributions

The scope of @github/webauthn-json is fairly small โ€” it's essentially feature-complete. However, we're happy to accept issues or pull requests that address the core goal of the project!

About

๐Ÿ” A small WebAuthn API wrapper that translates to/from pure JSON using base64url.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 92.7%
  • CSS 2.8%
  • HTML 2.3%
  • Makefile 2.2%