The service returning the information required to choose the authenticator to be used.

It returns all the available authenticators, the operation being executed and also informs whether a given authenticator is compliant with the policy required by the FIDO UAF server for the ongoing operation.

Hierarchy

  • AuthenticatorSelectionContext

Properties

account: Account

The account used to execute the operation.

authenticators: Authenticator[]

The available authenticators. Note that this may also include authenticators that cannot be used to complete the operation.

All the available authenticators are returned so that the users of the SDK can figure out not only whether an authenticator can be used for the operation, but also why.

For example, a developer would like to give a visual hint explaining why the Fingerprint authenticator cannot be used during registration if it is not enrolled: by using Authenticator.userEnrollment this situation can be identified during registration and then some message can be displayed to the user informing that a fingerprint must be defined in the OS settings to be able to register the fingerprint authenticator. In the case where a user registers two authenticators, but the server's policy only allows to use PIN in a given authentication operation, @{link isPolicyCompliant} can be used to identify this situation and to inform the user why the fingerprint authenticator is not available.

transactionConfirmationData?: string

The transaction confirmation data, if any, to be presented to the user for verification.

If this data is present, data must be presented to the user before authenticating. Note that in the case of registration or authentication not involving transaction confirmation, this is typically empty and thus, it does not require handling. The contents are the base64 URL decoded contents of the Transaction as described in the FIDO UAF specification.

Methods

  • Returns whether the provided authenticator is compliant with the policy of the server.

    If an authenticator that is not policy compliant is provided through AuthenticatorSelectionHandler.aaid for registration or authentication operations, FidoErrorCodeType.NoSuitableAuthenticator will be returned as a result of the operation.

    Parameters

    Returns Promise<boolean>

    true if the authenticator is compliant with the policy, and false otherwise.

Generated using TypeDoc