@nevis-security/nevis-mobile-authentication-sdk-react/lib/typescript/operations/Registration.d.ts

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

/**
 * Copyright © 2023-2024 Nevis Security AG. All rights reserved.
 */
import { HttpOperation, HttpOperationImpl } from './HttpOperation';
import type { PasswordEnroller } from './password/PasswordEnroller';
import type { PinEnroller } from './pin/PinEnroller';
import type { AuthenticatorSelector } from './selection/AuthenticatorSelector';
import type { BiometricUserVerifier } from './userverification/BiometricUserVerifier';
import type { DevicePasscodeUserVerifier } from './userverification/DevicePasscodeUserVerifier';
import type { FingerprintUserVerifier } from './userverification/FingerprintUserVerifier';
import { AuthorizationProvider } from '../authorization/AuthorizationProvider';
import { OperationError } from '../error/operation/OperationError';
import { DeviceInformation } from '../localData/DeviceInformation';
/**
 * The object that can be used to trigger a registration operation.
 *
 * Usage example:
 * ```ts
 *   class AuthenticatorSelectorImpl extends AuthenticatorSelector {
 *       async selectAuthenticator(
 *           context: AuthenticatorSelectionContext,
 *           handler: AuthenticatorSelectionHandler
 *       ): Promise<void> {
 *           await handler.aaid(aaid).catch(console.error);
 *       }
 *   }
 *
 *   class BiometricUserVerifierImpl extends BiometricUserVerifier {
 *       async verifyBiometric(
 *           context: BiometricUserVerificationContext,
 *           handler: BiometricUserVerificationHandler
 *       ): Promise<void> {
 *           await handler
 *               .listenForOsCredentials(
 *                   BiometricPromptOptions.create(
 *                       'Biometric authentication required',
 *                       'Cancel',
 *                       'Please identify yourself.'
 *                   )
 *               )
 *               .catch(console.error);
 *       }
 *   }
 *
 *   async register(
 *       client: MobileAuthenticationClient,
 *       username: string,
 *       deviceInformation: DeviceInformation
 *    ): Promise<void> {
 *       await client.operations.registration
 *           .username(username)
 *           .deviceInformation(deviceInformation)
 *           .authenticatorSelector(new AuthenticatorSelectorImpl())
 *           .biometricUserVerifier(new BiometricUserVerifierImpl())
 *           .onSuccess(() => {
 *               // handle success
 *           })
 *           .onError((_error) => {
 *               // handle error
 *           })
 *           .execute();
 *    }
 * ```
 *
 * The biometric, device passcode and fingerprint authenticators are enrolled at the OS level. That is why,
 * if one of them must be registered, the user must authenticate through {@link BiometricUserVerifier},
 * {@link DevicePasscodeUserVerifier} or {@link FingerprintUserVerifier}.
 * In the case of the PIN and password, the credentials are enrolled during
 * registration, so no authentication is needed.
 *
 * @see {@link Operations.registration}
 */
export declare abstract class Registration extends HttpOperation<Registration> {
    /**
     * Specifies the username that must be used to register.
     *
     * **IMPORTANT** \
     * Providing the username is required.
     *
     * **WARNING** \
     * The username is the technical user identifier defined by the relaying party.
     * Do not provide the login identifier (for example the users e-mail address) here.
     *
     * @param username the username.
     * @returns a {@link Registration} object.
     */
    abstract username(username: string): Registration;
    /**
     * Specifies the base URL of the server where the registration should be made.
     *
     * **NOTE** \
     * If no server base URL is provided, then the base URL defined in {@link ConfigurationBuilder.baseUrl}
     * will be used.
     *
     * **IMPORTANT** \
     * It is assumed that all the servers have the same endpoints, thus only the scheme, hostname and
     * port of the URL will be taken into account.
     *
     * Examples of base URL resolution in registration:
     * | Configuration base URL | Provided server URL in Registration | Resulting Server URL |
     * | --- | --- | --- |
     * | https://server/path | https://other.server | https://other.server/path |
     * | https://server:443/path | https://other.server/path | https://other.server/path |
     * | https://server/path | http://other.server:80/otherpath | http://other.server:80/path |
     *
     * @param serverUrl the server URL.
     * @returns a {@link Registration} object.
     */
    abstract serverUrl(serverUrl: string): Registration;
    /**
     * Specifies the device information to be used.
     *
     * The {@link DeviceInformation} is required only if you require support for encrypted out-of-band
     * payloads or push notifications. If a {@link DeviceInformation} was already provided in an
     * existing registration, the provided value will be ignored.
     *
     * @param deviceInformation the device information.
     * @returns a {@link Registration} object.
     */
    abstract deviceInformation(deviceInformation: DeviceInformation): Registration;
    /**
     * Specifies the authorization provider that must be used to register the authenticator.
     *
     * @param authorizationProvider the {@link AuthorizationProvider}.
     * @returns a {@link Registration} object.
     */
    abstract authorizationProvider(authorizationProvider: AuthorizationProvider): Registration;
    /**
     * Specifies whether [Class 2 (formerly weak)](https://source.android.com/docs/security/features/biometric/measure#biometric-classes)
     * biometric sensors are allowed if the biometric authenticator is selected.
     *
     * **IMPORTANT** \
     * This method is Android specific and will be ignored on iOS platform.
     *
     * By default, the SDK will only allow to use Class 3 (formerly strong) sensors. Using Class 2
     * sensors is less secure and discouraged. When a Class 2 sensor is used, the FIDO UAF keys are
     * not protected by the operating system by requiring user authentication.
     *
     * If the SDK detects that only Class 3 (strong) biometric sensors are available in the mobile
     * device, even if Class 2 sensors are allowed, the FIDO UAF credentials will be protected by
     * the operating system by requiring user authentication.
     *
     * However, in some cases it may be acceptable for the sake of end-user convenience. Allowing
     * Class 2 sensors will enable for instance the use of face recognition in some Samsung devices.
     *
     * @param allowClass2AndroidSensors specifies whether Class 2 biometric sensors are allowed if
     * the biometric authenticator is selected.
     * @returns a {@link Registration} object.
     */
    abstract allowClass2AndroidSensors(allowClass2AndroidSensors: boolean): Registration;
    /**
     * Specifies whether the OS device passcode can be used as fallback during biometric authentication.
     *
     * If not specified, the device passcode cannot be used as fallback.
     *
     * @param allowDevicePasscodeAsFallback indicates whether the device passcode can be used as fallback.
     * @returns a {@link Registration} object.
     */
    abstract allowDevicePasscodeAsFallback(allowDevicePasscodeAsFallback: boolean): Registration;
    /**
     * Specifies whether the authenticator must be invalidated if the user adds new biometric
     * credentials in the OS settings. If the authenticator has been invalidated, and you try to
     * authenticate with it, an error with code {@link FidoErrorCodeType.KeyDisappearedPermanently}
     * will be returned by the authentication operation.
     *
     * This setting only applies to biometric {@link Aaid.BIOMETRIC} and fingerprint {@link Aaid.FINGERPRINT}
     * authenticators.
     * By setting this parameter to `true`, you increase the security but there is a loss of
     * convenience: adding a new OS biometric credential does not imply necessarily that there is a
     * security risk, but if the end-user does it, a new registration will be required, because an
     * invalidated authenticator cannot be recovered.
     *
     * If not specified, the authenticator will be invalidated when the user adds a new biometric
     * credential in the OS settings.
     *
     * @param invalidateOnNewOsBiometrics indicates whether an addition of biometric credentials in
     * the OS should invalidate this authenticator.
     * @returns a {@link Registration} object.
     */
    abstract invalidateOnNewOsBiometrics(invalidateOnNewOsBiometrics: boolean): Registration;
    /**
     * Specifies the object that will take care of the selection of the authenticator to be used.
     *
     * **IMPORTANT** \
     * Providing the authenticator selector is required.
     *
     * @param authenticatorSelector the {@link AuthenticatorSelector}.
     * @returns a {@link Registration} object.
     */
    abstract authenticatorSelector(authenticatorSelector: AuthenticatorSelector): Registration;
    /**
     * Specifies the object that will take care of enrolling the PIN of the authenticator.
     * It must be provided only if a PIN authenticator must be registered.
     *
     * **IMPORTANT** \
     * Providing at least one of the {@link PinEnroller},{@link PasswordEnroller},
     * {@link BiometricUserVerifier}, {@link DevicePasscodeUserVerifier} or {@link FingerprintUserVerifier}
     * is required.
     *
     * @param pinEnroller the {@link PinEnroller}.
     * @returns a {@link Registration} object.
     */
    abstract pinEnroller(pinEnroller: PinEnroller): Registration;
    /**
     * Specifies the object that will take care of enrolling the password of the authenticator.
     * It must be provided only if a password authenticator must be registered.
     *
     * **IMPORTANT** \
     * Providing at least one of the {@link PinEnroller},{@link PasswordEnroller},
     * {@link BiometricUserVerifier}, {@link DevicePasscodeUserVerifier} or {@link FingerprintUserVerifier}
     * is required.
     *
     * @param passwordEnroller the {@link PasswordEnroller}.
     * @returns a {@link Registration} object.
     */
    abstract passwordEnroller(passwordEnroller: PasswordEnroller): Registration;
    /**
     * Specifies the object that will take care of the biometric user verification.
     * It must be provided only if a biometric authenticator must be registered.
     *
     * **IMPORTANT** \
     * Providing at least one of the {@link PinEnroller},{@link PasswordEnroller},
     * {@link BiometricUserVerifier}, {@link DevicePasscodeUserVerifier} or {@link FingerprintUserVerifier}
     * is required.
     *
     * @param biometricUserVerifier the {@link BiometricUserVerifier}.
     * @returns a {@link Registration} object.
     */
    abstract biometricUserVerifier(biometricUserVerifier: BiometricUserVerifier): Registration;
    /**
     * Specifies the object that will take care of the device passcode user verification.
     * It must be provided only if a device passcode authenticator must be registered.
     *
     * **IMPORTANT** \
     * Providing at least one of the {@link PinEnroller},{@link PasswordEnroller},
     * {@link BiometricUserVerifier}, {@link DevicePasscodeUserVerifier} or {@link FingerprintUserVerifier}
     * is required.
     *
     * @param devicePasscodeUserVerifier the {@link DevicePasscodeUserVerifier}.
     * @returns a {@link Registration} object.
     */
    abstract devicePasscodeUserVerifier(devicePasscodeUserVerifier: DevicePasscodeUserVerifier): Registration;
    /**
     * Specifies the object that will take care of the fingerprint user verification.
     * It must be provided only if a fingerprint authenticator must be registered.
     *
     * **IMPORTANT** \
     * Providing at least one of the {@link PinEnroller},{@link PasswordEnroller},
     * {@link BiometricUserVerifier}, {@link DevicePasscodeUserVerifier} or {@link FingerprintUserVerifier}
     * is required.
     *
     * @param fingerprintUserVerifier the {@link FingerprintUserVerifier}.
     * @returns a {@link Registration} object.
     */
    abstract fingerprintUserVerifier(fingerprintUserVerifier: FingerprintUserVerifier): Registration;
    /**
     * Specifies the object that will be invoked if the registration completed successfully.
     *
     * **IMPORTANT** \
     * Providing the {@link onSuccess} is required.
     *
     * @param onSuccess the callback which is invoked on successful registration.
     * @returns a {@link Registration} object.
     */
    abstract onSuccess(onSuccess: () => void): Registration;
    /**
     * Specifies the object that will be invoked if the registration failed.
     *
     * **IMPORTANT** \
     * Providing the {@link onError} is required.
     *
     * @param onError the callback which receives an {@link OperationError}.
     * @returns a {@link Registration} object.
     */
    abstract onError(onError: (error: OperationError) => void): Registration;
}
export declare class RegistrationImpl extends HttpOperationImpl<Registration> implements Registration {
    private _username?;
    private _serverUrl?;
    private _deviceInformation?;
    private _authorizationProvider?;
    private _allowClass2AndroidSensors?;
    private _allowDevicePasscodeAsFallback?;
    private _invalidateOnNewOsBiometrics?;
    private _authenticatorSelector?;
    private _pinEnroller?;
    private _passwordEnroller?;
    private _biometricUserVerifier?;
    private _devicePasscodeUserVerifier?;
    private _fingerprintUserVerifier?;
    private _onSuccess?;
    private _onError?;
    username(username: string): Registration;
    serverUrl(serverUrl: string): Registration;
    deviceInformation(deviceInformation: DeviceInformation): Registration;
    authorizationProvider(authorizationProvider: AuthorizationProvider): Registration;
    allowClass2AndroidSensors(allowClass2AndroidSensors: boolean): Registration;
    allowDevicePasscodeAsFallback(allowDevicePasscodeAsFallback: boolean): Registration;
    invalidateOnNewOsBiometrics(invalidateOnNewOsBiometrics: boolean): Registration;
    authenticatorSelector(authenticatorSelector: AuthenticatorSelector): Registration;
    pinEnroller(pinEnroller: PinEnroller): Registration;
    passwordEnroller(passwordEnroller: PasswordEnroller): Registration;
    biometricUserVerifier(biometricUserVerifier: BiometricUserVerifier): Registration;
    devicePasscodeUserVerifier(devicePasscodeUserVerifier: DevicePasscodeUserVerifier): Registration;
    fingerprintUserVerifier(fingerprintUserVerifier: FingerprintUserVerifier): Registration;
    onSuccess(onSuccess: () => void): Registration;
    onError(onError: (error: OperationError) => void): Registration;
    execute(): Promise<void>;
}
//# sourceMappingURL=Registration.d.ts.map