Class WebAuthnProvider

Hierarchy

BaseProvider
- WebAuthnProvider

Index

Constructors

Properties

Methods

authenticate getAuthMethodId getPublicKeyFromRegistration mintPKPThroughRelayer register verifyAndMintPKPThroughRelayer

Constructors

constructor

new WebAuthnProvider(options: BaseProviderOptions & WebAuthnProviderOptions): WebAuthnProvider
Parameters
- options: BaseProviderOptions & WebAuthnProviderOptions
Returns WebAuthnProvider
Overrides BaseProvider.constructor
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:23

Properties

`Private` `Optional` rpName

rpName?: string

Name of relying party. Defaults to "lit"

Methods

authenticate

authenticate(): Promise<AuthMethod>
Authenticate with a WebAuthn credential and return the relevant authentication data

Returns
- Auth method object containing WebAuthn authentication data
Returns Promise<AuthMethod>
Inherited from BaseProvider.authenticate
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:103

getAuthMethodId

getAuthMethodId(authMethod: AuthMethod): Promise<string>
Get auth method id that can be used to look up and interact with PKPs associated with the given auth method

Returns
- Auth method id
Parameters
- authMethod: AuthMethod
  
  Auth method object
Returns Promise<string>
Inherited from BaseProvider.getAuthMethodId
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:155

getPublicKeyFromRegistration

getPublicKeyFromRegistration(attResp: RegistrationResponseJSON): string
Parse the WebAuthn registration response to get the WebAuthn credential public key

Returns
- WebAuthn credential public key in hex format
Parameters
- attResp: RegistrationResponseJSON
  
  WebAuthn registration response
Returns string
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:179

mintPKPThroughRelayer

mintPKPThroughRelayer(): Promise<string>
This method is not applicable for WebAuthnProvider and should not be used. Use verifyAndMintPKPThroughRelayer instead to mint a PKP for a WebAuthn credential.

Throws
- Throws an error when called for WebAuthnProvider.
Returns Promise<string>
Inherited from BaseProvider.mintPKPThroughRelayer
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:92

register

register(username?: string): Promise<PublicKeyCredentialCreationOptionsJSON>
Generate registration options for the browser to pass to a supported authenticator

Returns
- Options to pass to the authenticator
Parameters
- Optional username: string
  
  Username to register credential with
Returns Promise<PublicKeyCredentialCreationOptionsJSON>
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:35

verifyAndMintPKPThroughRelayer

verifyAndMintPKPThroughRelayer(options: PublicKeyCredentialCreationOptionsJSON): Promise<string>
Mint PKP with verified registration data

Returns
- Mint transaction hash
Parameters
- options: PublicKeyCredentialCreationOptionsJSON
  
  Registration options to pass to the authenticator
Returns Promise<string>
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:48

Generated using TypeDoc