Class WebAuthnProvider

Hierarchy

BaseProvider
- WebAuthnProvider

Index

Constructors

Properties

Methods

authenticate getAuthMethodId mintPKPThroughRelayer register verifyAndMintPKPThroughRelayer authMethodId getPublicKeyFromRegistration

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:24

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:113

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:161

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:102

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:36

verifyAndMintPKPThroughRelayer

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

Returns
- Mint transaction hash
Parameters
- options: PublicKeyCredentialCreationOptionsJSON
  
  Registration options to pass to the authenticator
- Optional customArgs: MintRequestBody
  
  Extra data to overwrite default params
Returns Promise<string>
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:50

`Static` authMethodId

authMethodId(authMethod: AuthMethod, rpName?: string): Promise<string>
Parameters
- authMethod: AuthMethod
- Optional rpName: string
Returns Promise<string>
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:165

`Static` 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:194

Class WebAuthnProvider

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: BaseProviderOptions & WebAuthnProviderOptions

Returns WebAuthnProvider

Properties

Private Optional rpName

Methods

authenticate

Returns

Returns Promise<AuthMethod>

getAuthMethodId

Returns

Parameters

authMethod: AuthMethod

Returns Promise<string>

mintPKPThroughRelayer

Throws

Returns Promise<string>

register

Returns

Parameters

Optional username: string

Returns Promise<PublicKeyCredentialCreationOptionsJSON>

verifyAndMintPKPThroughRelayer

Returns

Parameters

options: PublicKeyCredentialCreationOptionsJSON

Optional customArgs: MintRequestBody

Returns Promise<string>

Static authMethodId

Parameters

authMethod: AuthMethod

Optional rpName: string

Returns Promise<string>

Static getPublicKeyFromRegistration

Returns

Parameters

attResp: RegistrationResponseJSON

Returns string

Settings

Member Visibility

Theme

`Private` `Optional` rpName

`Optional` username: string

`Optional` customArgs: MintRequestBody

`Static` authMethodId

`Optional` rpName: string

`Static` getPublicKeyFromRegistration