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

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

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

import type { BiometricPromptOptions } from './BiometricPromptOptions';
import {
	type OsAuthenticationListenHandler,
	OsAuthenticationListenHandlerImpl,
} from './OsAuthenticationListenHandler';
import { UserVerificationHandler } from './UserVerificationHandler';
import NevisMobileAuthenticationSdkReact from '../../MobileAuthenticationSdk';
import { ListenForOsCredentialsMessage } from '../../model/messages/out/ListenForOsCredentialsMessage';
import { OperationIdMessage } from '../../model/messages/out/OperationIdMessage';
import { TypedBiometricPromptOptions } from '../../model/typed/TypedPromptOptions';

/**
 * The objects consuming the outcome of an interaction where the user provides biometric credentials.
 *
 * This is used with the {@link Aaid.BIOMETRIC} authenticator attestation identifier. The particularity
 * of this authenticator with the other authenticators, is that the SDK relies on the operating system
 * prompt to authentication (i.e. there is no need to develop a GUI to do the authentication when
 * this authenticator is used).
 *
 * @see {@link BiometricUserVerifier.verifyBiometric}
 */
export abstract class BiometricUserVerificationHandler extends UserVerificationHandler {
	/**
	 * When this method is invoked, the SDK will invoke the operating system prompt to ask the user
	 * to provide credentials.
	 *
	 * So no GUI must be explicitly defined by the code using the SDK (as required with the fingerprint,
	 * PIN and password authenticators).
	 *
	 * **IMPORTANT** \
	 * The returned {@link OsAuthenticationListenHandler} is Android specific.
	 *
	 * @param biometricOptions the options to be used when prompting.
	 * @returns an {@link OsAuthenticationListenHandler} that can be used to cancel, pause or resume
	 * listening for OS credentials.
	 */
	abstract listenForOsCredentials(
		biometricOptions?: BiometricPromptOptions
	): Promise<OsAuthenticationListenHandler>;
}

export class BiometricUserVerificationHandlerImpl extends BiometricUserVerificationHandler {
	private readonly _operationId: string;
	private readonly _listenForOsCredentials: OsAuthenticationListenHandler;

	constructor(operationId: string) {
		super();
		this._operationId = operationId;
		this._listenForOsCredentials = new OsAuthenticationListenHandlerImpl(operationId);
	}

	async listenForOsCredentials(
		biometricOptions?: BiometricPromptOptions
	): Promise<OsAuthenticationListenHandler> {
		const typedBiometricPromptOptions = new TypedBiometricPromptOptions(biometricOptions);
		const message = new ListenForOsCredentialsMessage(
			this._operationId,
			typedBiometricPromptOptions
		);
		return NevisMobileAuthenticationSdkReact.listenForOsCredentials(message).then(() => {
			return this._listenForOsCredentials;
		});
	}

	async cancel(): Promise<void> {
		const message = new OperationIdMessage(this._operationId);
		return NevisMobileAuthenticationSdkReact.cancel(message);
	}
}