@nevis-security/nevis-mobile-authentication-sdk-react/src/operations/selection/AuthenticatorSelectionContext.ts

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

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

import { Account } from '../../localData/Account';
import { Authenticator } from '../../localData/Authenticator';
import NevisMobileAuthenticationSdkReact from '../../MobileAuthenticationSdk';
import { IsPolicyCompliantMessage } from '../../model/messages/out/IsPolicyCompliantMessage';

/**
 * 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.
 *
 * @see {@link AuthenticatorSelector.selectAuthenticator}
 */
export abstract class AuthenticatorSelectionContext {
	/**
	 * The account used to execute the operation.
	 */
	abstract account: Account;

	/**
	 * 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
	 * {@link 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.
	 */
	abstract authenticators: Array<Authenticator>;

	/**
	 * 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.
	 */
	abstract transactionConfirmationData?: string;

	/**
	 * Returns whether the provided authenticator is compliant with the policy of the server.
	 *
	 * If an authenticator that is not policy compliant is provided through
	 * {@link AuthenticatorSelectionHandler.aaid} for registration or authentication operations,
	 * {@link FidoErrorCodeType.NoSuitableAuthenticator} will be returned as a result of the operation.
	 *
	 * @param aaid the AAID of the {@link Authenticator}.
	 * @returns true if the authenticator is compliant with the policy, and false otherwise.
	 */
	abstract isPolicyCompliant(aaid: string): Promise<boolean>;

	/**
	 * Alternate constructor that creates an instance from a json.
	 *
	 * @param json contains the source for instance creation.
	 * @returns the created instance.
	 */
	static fromJson(json: any): AuthenticatorSelectionContext {
		return AuthenticatorSelectionContextImpl.fromJson(json);
	}
}

export class AuthenticatorSelectionContextImpl extends AuthenticatorSelectionContext {
	operationId: string;
	account: Account;
	authenticators: Array<Authenticator>;
	transactionConfirmationData?: string;

	private constructor(
		operationId: string,
		account: Account,
		authenticators: Array<Authenticator>,
		transactionConfirmationData?: string
	) {
		super();
		this.operationId = operationId;
		this.account = account;
		this.authenticators = authenticators;
		this.transactionConfirmationData = transactionConfirmationData;
	}

	static fromJson(json: any) {
		const operationId = json.operationId;
		const account = Account.fromJson(json.account);
		const authenticators: Authenticator[] = json.authenticators.map((element: any) =>
			Authenticator.fromJson(element)
		);
		const transactionConfirmationData = json.transactionConfirmationData;

		return new AuthenticatorSelectionContextImpl(
			operationId,
			account,
			authenticators,
			transactionConfirmationData
		);
	}

	async isPolicyCompliant(aaid: string): Promise<boolean> {
		const message = new IsPolicyCompliantMessage(this.operationId, aaid);
		return await NevisMobileAuthenticationSdkReact.isPolicyCompliant(message).then(
			(result: { isPolicyCompliant: any }) => {
				return result.isPolicyCompliant;
			}
		);
	}
}