Document `transports` in `README.md`

`@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 any custom client-side processing. This will be possible directly in the browser some day, but we're here for you until then.

Usage

Replace calls:

navigator.credentials.create(...) with create(parseCreationOptionsFromJSON(...)).
navigator.credentials.get(...) with get(parseRequestOptionsFromJSON(...)).

Encode/decode binary values on the server as base64url.

Example

Install using:

npm install --save @github/webauthn-json

Then:

import {
  create,
  parseCreationOptionsFromJSON,
} from "@github/webauthn-json/browser-ponyfill";

const request = fetch("...");

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

See here for fully working client-side demo code.

API (browser ponyfill)

We now recommend using a ponyfill for the new JSON-based APIs in the WebAuthn spec:

// @github/webauthn-json/browser-ponyfill

function supported(): boolean;

function parseCreationOptionsFromJSON(json: JSON): CredentialCreationOptions;
function parseRequestOptionsFromJSON(json: JSON): CredentialRequestOptions;

// You can call `.toJSON()` on the result or pass directly to `JSON.stringify()`.
function create(options: CredentialCreationOptions): Promise<PublicKeyCredential>;
// You can call `.toJSON()` on the result or pass directly to `JSON.stringify()`.
function get(options: CredentialRequestOptions): Promise<PublicKeyCredential>;

API (main library)

This was the original simplified API, which remains supported.

// @github/webauthn-json

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 main build is about ≈1KB when minified and gzipped (although we publish unminified builds).

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 — and most sites only need to use — a small number of extensions. To save code size, @github/webauthn-json only includes the following extensions by default:

In addition, we handle the following info (that is not technically part of extensions):

transports (on AuthenticatorAttestationResponse)¹

If you need to convert additional input or output extensions, use either of the following:

createExtended() and getExtended() from @github/webauthn-json/extended.
parseExtendedCreationOptionsFromJSON() and parseExtendedRequestOptionsFromJSON() from @github/webauthn-json/browser-ponyfill/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!

This comes from getTransports() on the AuthenticatorAttestationResponse. Note that we don't include its three sibling functions (getAuthenticatorData(), getPublicKey(), and getPublicKeyAlgorithm()), since they duplicates information that is available in other parts of the response. In particular, the authenticator data is available inside the signed attestation object. ↩

	const authenticationExtensionsClientInputsSchema: Schema = {
	appid: optional(copyValue),
	appidExclude: optional(copyValue),
	uvm: optional(copyValue),
	credProps: optional(copyValue),
	largeBlob: optional({
	support: optional(copyValue),
	read: optional(copyValue),
	write: optional(convertValue),
	}),
	};

	const authenticationExtensionsClientOutputsSchema: Schema = {
	appid: optional(copyValue),
	appidExclude: optional(copyValue),
	uvm: optional(copyValue),
	credProps: optional(copyValue),
	largeBlob: optional({
	supported: optional(copyValue),
	blob: optional(convertValue),
	written: optional(copyValue),
	}),
	};

	interface ExtendedExtensionsClientInputsJSON {
	appid?: string;
	appidExclude?: string;
	uvm?: boolean;
	credProps?: boolean;
	largeBlob?: {
	support?: "required" \| "preferred";
	read?: boolean;
	write?: Base64urlString;
	};
	}

	interface ExtendedAuthenticationExtensionsClientOutputsJSON {
	appid?: boolean;
	appidExclude?: boolean;
	uvm?: Array<[number, number, number]>;
	credProps?: {
	rk: boolean;
	};
	largeBlob?: {
	supported?: boolean;
	blob?: Base64urlString;
	written?: boolean;
	};
	}

	interface FullWebAuthnExtensionsJSON {
	appid?: string;
	txAuthSimple?: string;
	txAuthGeneric?: {
	contentType: string;
	content: Base64urlString;
	};
	authnSel?: Base64urlString[];
	exts?: boolean;
	uvi?: boolean;
	loc?: boolean;
	uvm?: boolean;
	authenticatorBiometricPerfBounds?: {
	FAR: number;
	FRR: number;
	};
	}

	interface FullWebAuthnExtensionsJSON {
	appid?: string;
	txAuthSimple?: string;
	txAuthGeneric?: {
	contentType: string;
	content: Base64urlString;
	};
	authnSel?: Base64urlString[];
	exts?: boolean;
	uvi?: boolean;
	loc?: boolean;
	uvm?: boolean;
	authenticatorBiometricPerfBounds?: {
	FAR: number;
	FRR: number;
	};
	}

github / webauthn-json Goto Github PK

webauthn-json's Introduction

@github/webauthn-json

Usage

Example

API (browser ponyfill)

API (main library)

Schema

Extensions

Contributions

Footnotes

webauthn-json's People

Contributors

Stargazers

Watchers

Forkers

webauthn-json's Issues

Recommend Projects

Recommend Topics

Recommend Org

`@github/webauthn-json`