@nevis-security/nevis-mobile-authentication-sdk-react/src/operations/userverification/PasswordUserVerifier.ts

React Native plugin for Nevis Mobile Authentication SDK. Supports only mobile.

/**
 * Copyright © 2024 Nevis Security AG. All rights reserved.
 */

import type { PasswordUserVerificationContext } from './PasswordUserVerificationContext';
import type { PasswordUserVerificationHandler } from './PasswordUserVerificationHandler';

/**
 * The object in charge of interacting with the user to do password authentication.
 *
 * It is invoked when the operation uses the password ({@link Aaid.PASSWORD}) authenticator.
 *
 * The SDK does not provide implementations of this interface.
 * The implementation must be done by the user of the SDK if the password authenticator is required.
 *
 * @group User Interaction
 * @category Password
 * @see
 * - {@link Authentication.passwordUserVerifier}
 * - {@link OutOfBandAuthentication.passwordUserVerifier}
 */
export abstract class PasswordUserVerifier {
	/**
	 * The user verification interaction.
	 *
	 * In the case of the registration the user must provide credentials again as required by the
	 * FIDO UAF protocol. In the case of the authentication, this is invoked for the user to provide
	 * credentials.
	 *
	 * If the user provided invalid credentials, and it results in a non-recoverable error, then the
	 * `onError` method will be invoked.
	 *
	 * @param context the object providing the information required for the verification process.
	 * @param handler the object that must be notified with the result of the interaction.
	 */
	abstract verifyPassword(
		context: PasswordUserVerificationContext,
		handler: PasswordUserVerificationHandler
	): Promise<void>;

	/**
	 * This method is invoked when valid password credentials were provided and verified locally.
	 *
	 * The method is invoked after {@link verifyPassword} has been invoked and {@link PasswordUserVerificationHandler.verifyPassword}
	 * is invoked in the {@link PasswordUserVerificationHandler} of {@link verifyPassword} and the provided
	 * password credentials are valid.
	 *
	 * This method can be used for instance to hide the UI used to ask for credentials
	 * to the user (some text fields to get password credentials) and then display some
	 * progress message indicating that the operation is ongoing.
	 *
	 * Note that invoking this method does not mean that the UAF operation completed
	 * successfully (this is notified through `onSuccess` methods once the FIDO UAF
	 * server validates the request generated with the credentials).
	 */
	abstract onValidCredentialsProvided(): void;
}