@simplewebauthn/browser@13.1.2
SimpleWebAuthn for Browsers
Values for an attestation object's fmt
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.
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
Convert from a Base64URL-encoded string to an Array Buffer. Best used when converting a credential ID from a JSON string to an ArrayBuffer, like in allowCredentials or excludeCredentials
Determine if the browser is capable of Webauthn
Determine if the browser supports conditional UI, so that WebAuthn credentials can be shown to the user in the browser's typical password autofill popup.
Convert the given array buffer into a Base64URL-encoded string. Ideal for converting various credential response ArrayBuffers to string for sending back to the server as JSON.
The two types of credentials as defined by bit 3 ("Backup Eligibility") in authenticator data:
Basic cryptography features available in the current context. It allows access to a cryptographically strong random number generator and to cryptographic primitives.
Determine whether the browser can communicate with a built-in authenticator, like Touch ID, Android fingerprint scanner, or Windows Hello.
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
Categories of authenticators that Relying Parties can pass along to browsers during registration. Browsers that understand these values can optimize their modal experience to start the user off in a particular registration flow:
A variant of PublicKeyCredentialRequestOptions suitable for JSON transmission to the browser to (eventually) get passed into navigator.credentials.get(...) in the browser.
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.
Begin authenticator "login" via WebAuthn assertion
Begin authenticator "registration" via WebAuthn attestation
Public key credential information needed to verify authentication responses
A custom Error used to return a more nuanced error detailing why one of the eight documented
errors in the spec was raised after calling navigator.credentials.create() or
navigator.credentials.get():