Class WebAuthnProvider

Hierarchy (view full)

BaseProvider
- WebAuthnProvider

Index

Constructors

Properties

Methods

authenticate claimKeyId computePublicKeyFromAuthMethod fetchPKPs fetchPKPsThroughRelayer getAuthMethodId getPKPsForAuthMethod getSessionSigs mintPKPThroughRelayer prepareFetchBody prepareMintBody prepareRelayRequestData register verifyAndMintPKPThroughRelayer authMethodId getPublicKeyFromRegistration

Constructors

constructor

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

Properties

litNodeClient

litNodeClient: LitNodeClient

Client to connect to Lit nodes

relay

relay: IRelay

Relay server to subsidize minting of PKPs

Methods

authenticate

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

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

claimKeyId

claimKeyId(claimRequest): Promise<ClaimKeyResponse>
Authenticates an auth Method for claiming a Programmable Key Pair (PKP). Uses the underyling litNodeClient instance to authenticate a given auth method
Parameters
- claimRequest: ClaimRequest<ClaimProcessor>
Returns Promise<ClaimKeyResponse>
- Response from the network for the claim
Inherited from BaseProvider.claimKeyId
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:336

computePublicKeyFromAuthMethod

computePublicKeyFromAuthMethod(authMethod): Promise<string>
Calculates a public key for a given key identifier which is an Auth Method Identifier the Auth Method Identifier is a hash of a user identifier and app idendtifer. These identifiers are specific to each auth method and will derive the public key protion of a pkp which will be persited when a key is claimed.

Auth Method User ID App ID

Google OAuth token sub token aud

Discord OAuth user id client app identifier

Stytch OTP token sub token aud
Parameters
- authMethod: AuthMethod
Returns Promise<string>
Inherited from BaseProvider.computePublicKeyFromAuthMethod
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:360

Auth Method	User ID	App ID
Google OAuth	token `sub`	token `aud`
Discord OAuth	user id	client app identifier
Stytch OTP	token `sub`	token `aud`

fetchPKPs

fetchPKPs(authMethod): Promise<IRelayPKP[]>
Fetch PKPs associated with given auth method from pkp contract
Parameters
- authMethod: AuthMethod
  Auth method object
Returns Promise<IRelayPKP[]>
- Array of PKPs
Inherited from BaseProvider.fetchPKPs
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:228

fetchPKPsThroughRelayer

fetchPKPsThroughRelayer(authMethod): Promise<IRelayPKP[]>
Parameters
- authMethod: AuthMethod
  Auth method object
Returns Promise<IRelayPKP[]>
- Array of PKPs
Deprecated
- Use fetchPKPs instead Fetch PKPs associated with given auth method from relay server
Inherited from BaseProvider.fetchPKPsThroughRelayer
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:130

getAuthMethodId

getAuthMethodId(authMethod): Promise<string>
Get auth method id that can be used to look up and interact with PKPs associated with the given auth method
Parameters
- authMethod: AuthMethod
  Auth method object
Returns Promise<string>
- Auth method id
Overrides BaseProvider.getAuthMethodId
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:178

getPKPsForAuthMethod

getPKPsForAuthMethod(__namedParameters): Promise<IRelayPKP[]>
Fetch PKPs associated with given auth method type and id from pkp contract
Parameters
- __namedParameters: {
  authMethodId: string;
  authMethodType: AUTH_METHOD_TYPE_VALUES;
  }
  - authMethodId: string
  - authMethodType: AUTH_METHOD_TYPE_VALUES
Returns Promise<IRelayPKP[]>
- Array of PKPs
Inherited from BaseProvider.getPKPsForAuthMethod
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:158

getSessionSigs

getSessionSigs(params): Promise<SessionSigs>
Generate session sigs for given auth method and PKP
Parameters
- params: BaseProviderSessionSigsParams
Returns Promise<SessionSigs>
- Session sigs
Inherited from BaseProvider.getSessionSigs
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:251

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.

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

`Protected`prepareFetchBody

prepareFetchBody(data): string
Generate request body to fetch PKPs using auth method info via relay server
Parameters
- data: IRelayRequestData
  Data for fetching PKP
Returns string
- Relay request body to fetch PKPs
Inherited from BaseProvider.prepareFetchBody
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:445

`Protected`prepareMintBody

prepareMintBody(data, customArgs?): string
Generate request body for minting PKP using auth methods via relay server
Parameters
- data: IRelayRequestData
  Data for minting PKP
- OptionalcustomArgs: MintRequestBody
  Extra data to overwrite default params
Returns string
- Relay request body for minting PKP
Inherited from BaseProvider.prepareMintBody
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:409

prepareRelayRequestData

prepareRelayRequestData(authMethod): Promise<IRelayRequestData>
Generate request data for minting and fetching PKPs via relay server
Parameters
- authMethod: AuthMethod
  Auth method obejct
Returns Promise<IRelayRequestData>
- Relay request data
Inherited from BaseProvider.prepareRelayRequestData
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:386

register

register(username?): Promise<PublicKeyCredentialCreationOptionsJSON>
Generate registration options for the browser to pass to a supported authenticator
Parameters
- Optionalusername: string
  Username to register credential with
Returns Promise<PublicKeyCredentialCreationOptionsJSON>
- Options to pass to the authenticator
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:41

verifyAndMintPKPThroughRelayer

verifyAndMintPKPThroughRelayer(options, customArgs?): Promise<string>
Mint PKP with verified registration data
Parameters
- options: PublicKeyCredentialCreationOptionsJSON
  Registration options to pass to the authenticator
- OptionalcustomArgs: MintRequestBody
  Extra data to overwrite default params
Returns Promise<string>
- Mint transaction hash
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:55

`Static`authMethodId

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

`Static`getPublicKeyFromRegistration

getPublicKeyFromRegistration(attResp): string
Parse the WebAuthn registration response to get the WebAuthn credential public key
Parameters
- attResp: RegistrationResponseJSON
  WebAuthn registration response
Returns string
- WebAuthn credential public key in hex format
- Defined in packages/lit-auth-client/src/lib/providers/WebAuthnProvider.ts:217

Class WebAuthnProvider

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebAuthnProvider

Properties

litNodeClient

relay

Methods

authenticate

Returns Promise<AuthMethod>

claimKeyId

Parameters

Returns Promise<ClaimKeyResponse>

computePublicKeyFromAuthMethod

Parameters

Returns Promise<string>

fetchPKPs

Parameters

Returns Promise<IRelayPKP[]>

fetchPKPsThroughRelayer

Parameters

Returns Promise<IRelayPKP[]>

Deprecated

getAuthMethodId

Parameters

Returns Promise<string>

getPKPsForAuthMethod

Parameters

authMethodId: string

authMethodType: AUTH_METHOD_TYPE_VALUES

Returns Promise<IRelayPKP[]>

getSessionSigs

Parameters

Returns Promise<SessionSigs>

mintPKPThroughRelayer

Returns Promise<string>

Throws

ProtectedprepareFetchBody

Parameters

Returns string

ProtectedprepareMintBody

Parameters

Returns string

prepareRelayRequestData

Parameters

Returns Promise<IRelayRequestData>

register

Parameters

Returns Promise<PublicKeyCredentialCreationOptionsJSON>

verifyAndMintPKPThroughRelayer

Parameters

Returns Promise<string>

StaticauthMethodId

Parameters

Returns Promise<string>

StaticgetPublicKeyFromRegistration

Parameters

Returns string

Settings

On This Page

`Protected`prepareFetchBody

`Protected`prepareMintBody

`Static`authMethodId

`Static`getPublicKeyFromRegistration