Skip to main content
Home

Built and signed on GitHub Actions

SimpleWebAuthn for Servers

This package works with Cloudflare Workers, Node.js, Deno, Bun
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
JSR Score
88%
Published
2 months ago (13.2.2)
T
AlternativeDescriptions

langCode -> "en-US", "ja-JP", etc...

T
AttestationConveyancePreference
No documentation available
T
AttestationFormat

Values for an attestation object's fmt

I
AuthenticationCredential

The value returned from navigator.credentials.get()

I
AuthenticationResponseJSON

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.

I
AuthenticatorAssertionResponseJSON

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.

T
AuthenticatorAttachment
No documentation available
I
AuthenticatorAttestationResponseFuture

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.

I
AuthenticatorAttestationResponseJSON

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.

T
AuthenticatorStatus
No documentation available
T
AuthenticatorTransport
No documentation available
T
AuthenticatorTransportFuture

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)

T
Base64URLString

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

c
BaseMetadataService

An implementation of MetadataService that can download and parse BLOBs, and support on-demand requesting and caching of individual metadata statements.

T
CodeAccuracyDescriptor

Types defined in the FIDO Metadata Statement spec

T
COSEAlgorithmIdentifier
No documentation available
T
CredentialDeviceType

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

I
Crypto

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

T
EcdaaTrustAnchor
No documentation available
T
f
generateAuthenticationOptions

Prepare a value to pass into navigator.credentials.get(...) for authenticator authentication

T
GenerateAuthenticationOptionsOpts
No documentation available
f
generateRegistrationOptions

Prepare a value to pass into navigator.credentials.create(...) for authenticator registration

T
GenerateRegistrationOptionsOpts
No documentation available
T
MDSJWTHeader
No documentation available
T
I
v
MetadataService
No documentation available
I
PublicKeyCredentialCreationOptionsJSON

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

I
I
PublicKeyCredentialDescriptorFuture

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)

I
PublicKeyCredentialFuture

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

T
PublicKeyCredentialHint

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:

T
PublicKeyCredentialJSON
No documentation available
I
PublicKeyCredentialParameters
No documentation available
I
PublicKeyCredentialRequestOptionsJSON

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

I
PublicKeyCredentialRpEntity
No documentation available
T
PublicKeyCredentialType
No documentation available
I
PublicKeyCredentialUserEntity
No documentation available
I
RegistrationCredential

The value returned from navigator.credentials.create()

I
RegistrationResponseJSON

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.

T
ResidentKeyRequirement
No documentation available
T
rgbPaletteEntry
No documentation available
T
RootCertIdentifier
No documentation available
T
Uint8Array_

Equivalent to Uint8Array before TypeScript 5.7, and Uint8Array<ArrayBuffer> in TypeScript 5.7 and beyond.

T
UserVerificationRequirement
No documentation available
T
VerificationMethodANDCombinations
No documentation available
T
VerificationMode

Allow MetadataService to accommodate unregistered AAGUIDs ("permissive"), or only allow registered AAGUIDs ("strict"). Currently primarily impacts how getStatement() operates

T
VerifiedAuthenticationResponse

Result of authentication verification

T
VerifiedRegistrationResponse

Result of registration verification

f
verifyAuthenticationResponse

Verify that the user has legitimately completed the authentication process

T
VerifyAuthenticationResponseOpts

Configurable options when calling verifyAuthenticationResponse()

f
verifyRegistrationResponse

Verify that the user has legitimately completed the registration process

T
VerifyRegistrationResponseOpts

Configurable options when calling verifyRegistrationResponse()

T
WebAuthnCredential

Public key credential information needed to verify authentication responses

T
AttestationFormat
No documentation available
T
AttestationObject
No documentation available
T
AttestationStatement

AttestationStatement will be an instance of Map, but these keys help make finite the list of possible values within it.

f
convertAAGUIDToString

Convert the aaguid buffer in authData into a UUID string

f
convertCertBufferToPEM

Convert buffer to an OpenSSL-compatible PEM text format.

f
convertCOSEtoPKCS

Takes COSE-encoded public key and converts it to PKCS key

N
cose
No documentation available
E
cose.COSEALG

COSE Algorithms

E
cose.COSECRV

COSE Curves

E
cose.COSEKEYS

COSE Keys

E
cose.COSEKTY

COSE Key Types

T
cose.COSEPublicKey

COSE public key common values

T
cose.COSEPublicKeyEC2

Values specific to Elliptic Curve Cryptography public keys

T
cose.COSEPublicKeyOKP

Values specific to Octet Key Pair public keys

T
cose.COSEPublicKeyRSA

Values specific to RSA public keys

f
cose.isCOSEAlg
No documentation available
f
cose.isCOSECrv
No documentation available
f
cose.isCOSEKty
No documentation available
f
cose.isCOSEPublicKeyEC2

A type guard for determining if a COSE public key is an EC2 key pair

f
cose.isCOSEPublicKeyOKP

A type guard for determining if a COSE public key is an OKP key pair

f
cose.isCOSEPublicKeyRSA

A type guard for determining if a COSE public key is an RSA key pair

f
decodeAttestationObject

Convert an AttestationObject buffer to a proper object

f
decodeClientDataJSON

Decode an authenticator's base64url-encoded clientDataJSON to JSON

f
decodeCredentialPublicKey
No documentation available
f
generateChallenge

Generate a suitably random value to be used as an attestation or assertion challenge

f
generateUserID

Generate a suitably random value to be used as user ID

f
getCertificateInfo

Extract PEM certificate info

f
isCertRevoked

A method to pull a CRL from a certificate and compare its serial number to the list of revoked certificate serial numbers within the CRL.

N
isoBase64URL

A runtime-agnostic collection of methods for working with Base64URL encoding

f
isoBase64URL.fromBuffer

Encode 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.

f
isoBase64URL.fromUTF8String

Encode a UTF-8 string to base64url

f
isoBase64URL.isBase64

Confirm that the string is encoded into base64

f
isoBase64URL.isBase64URL

Confirm that the string is encoded into base64url, with support for optional padding

f
isoBase64URL.toBase64

Convert a base64url string into base64

f
isoBase64URL.toBuffer

Decode from a Base64URL-encoded string to an ArrayBuffer. Best used when converting a credential ID from a JSON string to an ArrayBuffer, like in allowCredentials or excludeCredentials.

f
isoBase64URL.toUTF8String

Decode a base64url string into its original UTF-8 string

f
isoBase64URL.trimPadding

Remove optional padding from a base64url-encoded string

N
isoCBOR

A runtime-agnostic collection of methods for working with CBOR encoding

f
isoCBOR.decodeFirst

Decode and return the first item in a sequence of CBOR-encoded values

f
isoCBOR.encode

Encode data to CBOR

N
isoCrypto

A runtime-agnostic collection of methods for working with the WebCrypto API

N
isoUint8Array
No documentation available
f
isoUint8Array.areEqual

Make sure two Uint8Arrays are deeply equivalent

f
isoUint8Array.concat

Combine multiple Uint8Arrays into a single Uint8Array

f
isoUint8Array.fromASCIIString

Convert an ASCII string to Uint8Array

f
isoUint8Array.fromHex

Convert a hexadecimal string to isoUint8Array.

f
isoUint8Array.fromUTF8String

Convert a UTF-8 string back into bytes

f
isoUint8Array.toDataView

Prepare a DataView we can slice our way around in as we parse the bytes in a Uint8Array

f
isoUint8Array.toHex

Convert a Uint8Array to Hexadecimal.

f
isoUint8Array.toUTF8String

Convert bytes into a UTF-8 string

f
parseAuthenticatorData

Make sense of the authData buffer contained in an Attestation

f
toHash

Returns hash digest of the given data, using the given algorithm when provided. Defaults to using SHA-256.

f
validateCertificatePath

Traverse an array of PEM certificates and ensure they form a proper chain

f
verifySignature

Verify an authenticator's signature

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.