Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/simplewebauthn/packages/types/src/index.ts

WebAuthn, Simplified. A collection of TypeScript-first libraries for simpler WebAuthn integration. Supports modern browsers, Node, Deno, and more.
Latest
import * as simplewebauthn from "https://deno.land/x/simplewebauthn@v11.0.0/packages/types/src/index.ts";

Interfaces

The value returned from navigator.credentials.get()

A slightly-modified AuthenticationCredential to simplify working with ArrayBuffers that are Base64URL-encoded in the browser so that they can be sent as JSON to the server.

Available only in secure contexts.

A slightly-modified AuthenticatorAssertionResponse to simplify working with ArrayBuffers that are Base64URL-encoded in the browser so that they can be sent as JSON to the server.

Available only in secure contexts.

AuthenticatorAttestationResponse in TypeScript's DOM lib is outdated (up through v3.9.7). Maintain an augmented version here so we can implement additional properties as the WebAuthn spec evolves.

A slightly-modified AuthenticatorAttestationResponse to simplify working with ArrayBuffers that are Base64URL-encoded in the browser so that they can be sent as JSON to the server.

Basic cryptography features available in the current context. It allows access to a cryptographically strong random number generator and to cryptographic primitives.

Available only in secure contexts.

A variant of PublicKeyCredentialCreationOptions suitable for JSON transmission to the browser to (eventually) get passed into navigator.credentials.create(...) in the browser.

A super class of TypeScript's PublicKeyCredentialDescriptor that knows about the latest transports. Should eventually be replaced by TypeScript's when TypeScript gets updated to know about it (sometime after 4.6.3)

A super class of TypeScript's PublicKeyCredential that knows about upcoming WebAuthn features

A variant of PublicKeyCredentialRequestOptions suitable for JSON transmission to the browser to (eventually) get passed into navigator.credentials.get(...) in the browser.

The value returned from navigator.credentials.create()

A slightly-modified RegistrationCredential to simplify working with ArrayBuffers that are Base64URL-encoded in the browser so that they can be sent as JSON to the server.

Type Aliases

A super class of TypeScript's AuthenticatorTransport that includes support for the latest transports. Should eventually be replaced by TypeScript's when TypeScript gets updated to know about it (sometime after 4.6.3)

An attempt to communicate that this isn't just any string, but a Base64URL-encoded string

The two types of credentials as defined by bit 3 ("Backup Eligibility") in authenticator data:

  • "singleDevice" credentials will never be backed up
  • "multiDevice" credentials can be backed up

Public key credential information needed to verify authentication responses