Class FRWebAuthn`Abstract`

Utility for integrating a web browser's WebAuthn API.

Example:

// Determine if a step is a WebAuthn step
const stepType = FRWebAuthn.getWebAuthnStepType(step);
if (stepType === WebAuthnStepType.Registration) {
  // Register a new device
  await FRWebAuthn.register(step);
} else if (stepType === WebAuthnStepType.Authentication) {
  // Authenticate with a registered device
  await FRWebAuthn.authenticate(step);
}

Hierarchy

FRWebAuthn

Index

Methods

getWebAuthnStepType authenticate register getCallbacks getMetadataCallback getOutcomeCallback getTextOutputCallback getAuthenticationCredential getAuthenticationOutcome getRegistrationCredential getRegistrationOutcome createAuthenticationPublicKey createRegistrationPublicKey

Constructors

constructor

Methods

`Static` getWebAuthnStepType

getWebAuthnStepType(step: FRStep): WebAuthnStepType
Determines if the given step is a WebAuthn step.

Returns
A WebAuthnStepType value
Parameters
- step: FRStep
  
  The step to evaluate
Returns WebAuthnStepType
- Defined in fr-webauthn/index.ts:70

`Static` authenticate

authenticate(step: FRStep): Promise<FRStep>
Populates the step with the necessary authentication outcome.

Returns
The populated step
Parameters
- step: FRStep
  
  The step that contains WebAuthn authentication data
Returns Promise<FRStep>
- Defined in fr-webauthn/index.ts:102

`Static` register

register<T>(step: FRStep, deviceName?: T): Promise<FRStep>
Can make this generic const in Typescript 5.0 > and the name itself will be inferred from the type so typeof deviceName will not just return string but the actual name of the deviceName passed in as a generic.
Type Parameters
- T extends string = ""
Parameters
- step: FRStep
- Optional deviceName: T
Returns Promise<FRStep>
- Defined in fr-webauthn/index.ts:149

`Static` getCallbacks

getCallbacks(step: FRStep): WebAuthnCallbacks
Returns an object containing the two WebAuthn callbacks.

Returns
The WebAuthn callbacks
Parameters
- step: FRStep
  
  The step that contains WebAuthn callbacks
Returns WebAuthnCallbacks
- Defined in fr-webauthn/index.ts:203

`Static` getMetadataCallback

getMetadataCallback(step: FRStep): MetadataCallback
Returns the WebAuthn metadata callback containing data to pass to the browser Web Authentication API.

Returns
The metadata callback
Parameters
- step: FRStep
  
  The step that contains WebAuthn callbacks
Returns MetadataCallback
- Defined in fr-webauthn/index.ts:226

`Static` getOutcomeCallback

getOutcomeCallback(step: FRStep): HiddenValueCallback
Returns the WebAuthn hidden value callback where the outcome should be populated.

Returns
The hidden value callback
Parameters
- step: FRStep
  
  The step that contains WebAuthn callbacks
Returns HiddenValueCallback
- Defined in fr-webauthn/index.ts:240

`Static` getTextOutputCallback

getTextOutputCallback(step: FRStep): TextOutputCallback
Returns the WebAuthn metadata callback containing data to pass to the browser Web Authentication API.

Returns
The metadata callback
Parameters
- step: FRStep
  
  The step that contains WebAuthn callbacks
Returns TextOutputCallback
- Defined in fr-webauthn/index.ts:253

`Static` getAuthenticationCredential

getAuthenticationCredential(options: PublicKeyCredentialRequestOptions): Promise<PublicKeyCredential>
Retrieves the credential from the browser Web Authentication API.

Returns
The credential
Parameters
- options: PublicKeyCredentialRequestOptions
  
  The public key options associated with the request
Returns Promise<PublicKeyCredential>
- Defined in fr-webauthn/index.ts:268

`Static` getAuthenticationOutcome

getAuthenticationOutcome(credential: PublicKeyCredential): `${string}::direct::${string}` | `${string}::indirect::${string}` | `${string}::none::${string}` | `${string}::direct::${string}::${string}` | `${string}::indirect::${string}::${string}` | `${string}::none::${string}::${string}`
Converts an authentication credential into the outcome expected by OpenAM.

Returns
The outcome string
Parameters
- credential: PublicKeyCredential
  
  The credential to convert
Returns `${string}::direct::${string}` | `${string}::indirect::${string}` | `${string}::none::${string}` | `${string}::direct::${string}::${string}` | `${string}::indirect::${string}::${string}` | `${string}::none::${string}::${string}`
- Defined in fr-webauthn/index.ts:287

`Static` getRegistrationCredential

getRegistrationCredential(options: PublicKeyCredentialCreationOptions): Promise<PublicKeyCredential>
Retrieves the credential from the browser Web Authentication API.

Returns
The credential
Parameters
- options: PublicKeyCredentialCreationOptions
  
  The public key options associated with the request
Returns Promise<PublicKeyCredential>
- Defined in fr-webauthn/index.ts:342

`Static` getRegistrationOutcome

getRegistrationOutcome(credential: PublicKeyCredential): `${string}::direct::${string}` | `${string}::indirect::${string}` | `${string}::none::${string}`
Converts a registration credential into the outcome expected by OpenAM.

Returns
The outcome string
Parameters
- credential: PublicKeyCredential
  
  The credential to convert
Returns `${string}::direct::${string}` | `${string}::indirect::${string}` | `${string}::none::${string}`
- Defined in fr-webauthn/index.ts:363

`Static` createAuthenticationPublicKey

createAuthenticationPublicKey(metadata: WebAuthnAuthenticationMetadata): PublicKeyCredentialRequestOptions
Converts authentication tree metadata into options required by the browser Web Authentication API.

Returns
The Web Authentication API request options
Parameters
- metadata: WebAuthnAuthenticationMetadata
  
  The metadata provided in the authentication tree MetadataCallback
Returns PublicKeyCredentialRequestOptions
- Defined in fr-webauthn/index.ts:393

`Static` createRegistrationPublicKey

createRegistrationPublicKey(metadata: WebAuthnRegistrationMetadata): PublicKeyCredentialCreationOptions
Converts authentication tree metadata into options required by the browser Web Authentication API.

Returns
The Web Authentication API request options
Parameters
- metadata: WebAuthnRegistrationMetadata
  
  The metadata provided in the authentication tree MetadataCallback
Returns PublicKeyCredentialCreationOptions
- Defined in fr-webauthn/index.ts:424

Constructors

constructor

new FRWebAuthn(): FRWebAuthn
Returns FRWebAuthn

Class FRWebAuthnAbstract

Hierarchy

Index

Methods

Constructors

Methods

Static getWebAuthnStepType

Returns

Parameters

step: FRStep

Returns WebAuthnStepType

Static authenticate

Returns

Parameters

step: FRStep

Returns Promise<FRStep>

Static register

Type Parameters

T extends string = ""

Parameters

step: FRStep

Optional deviceName: T

Returns Promise<FRStep>

Static getCallbacks

Returns

Parameters

step: FRStep

Returns WebAuthnCallbacks

Static getMetadataCallback

Returns

Parameters

step: FRStep

Returns MetadataCallback

Static getOutcomeCallback

Returns

Parameters

step: FRStep

Returns HiddenValueCallback

Static getTextOutputCallback

Returns

Parameters

step: FRStep

Returns TextOutputCallback

Static getAuthenticationCredential

Returns

Parameters

options: PublicKeyCredentialRequestOptions

Returns Promise<PublicKeyCredential>

Static getAuthenticationOutcome

Returns

Parameters

credential: PublicKeyCredential

Returns `${string}::direct::${string}` | `${string}::indirect::${string}` | `${string}::none::${string}` | `${string}::direct::${string}::${string}` | `${string}::indirect::${string}::${string}` | `${string}::none::${string}::${string}`

Static getRegistrationCredential

Returns

Parameters

options: PublicKeyCredentialCreationOptions

Returns Promise<PublicKeyCredential>

Static getRegistrationOutcome

Returns

Parameters

credential: PublicKeyCredential

Returns `${string}::direct::${string}` | `${string}::indirect::${string}` | `${string}::none::${string}`

Static createAuthenticationPublicKey

Returns

Parameters

metadata: WebAuthnAuthenticationMetadata

Returns PublicKeyCredentialRequestOptions

Static createRegistrationPublicKey

Returns

Parameters

metadata: WebAuthnRegistrationMetadata

Returns PublicKeyCredentialCreationOptions

Constructors

constructor

Returns FRWebAuthn

Settings

Member Visibility

Theme

Class FRWebAuthn`Abstract`

`Static` getWebAuthnStepType

`Static` authenticate

`Static` register

`Optional` deviceName: T

`Static` getCallbacks

`Static` getMetadataCallback

`Static` getOutcomeCallback

`Static` getTextOutputCallback

`Static` getAuthenticationCredential

`Static` getAuthenticationOutcome

`Static` getRegistrationCredential

`Static` getRegistrationOutcome

`Static` createAuthenticationPublicKey

`Static` createRegistrationPublicKey