@nevis-security/nevis-mobile-authentication-sdk-react
Version:
React Native plugin for Nevis Mobile Authentication SDK. Supports only mobile.
181 lines (158 loc) • 7.58 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.RegistrationMessage = void 0;
var _PinPolicyMessage = require("./PinPolicyMessage");
var _TypedAuthorizationProvider = require("../../../model/typed/TypedAuthorizationProvider");
/**
* Copyright © 2023-2024 Nevis Security AG. All rights reserved.
*/
/**
* Holds the parameters of the registration operation call.
*/
class RegistrationMessage {
/**
* The identifier of the operation.
*/
/**
* Flag that tells whether the account selector is provided.
*/
/**
* Flag that tells whether the authenticator selector is provided.
*/
/**
* Flag that tells whether the PIN enroller is provided.
*/
/**
* Flag that tells whether the password enroller is provided.
*/
/**
* Flag that tells whether the PIN user verifier is provided.
*/
/**
* Flag that tells whether the password user verifier is provided.
*/
/**
* Flag that tells whether the biometric user verifier is provided.
*/
/**
* Flag that tells whether the device passcode user verifier is provided.
*/
/**
* Flag that tells whether the fingerprint user verifier is provided.
*/
/**
* Flag that tells whether the success callback is provided.
*/
/**
* Flag that tells whether the error callback is provided.
*/
/**
* Specifies the additional request headers that must be included in the HTTP requests sent by
* the operation.
*/
/**
* The username that must be used to register.
*/
/**
* The base URL of the server where the registration should be made.
*/
/**
* The device information to be used.
*/
/**
* The object providing the authorization.
*/
/**
* The PIN policy to be used.
*/
/**
* 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 property is Android specific and will be ignored by iOS native plugin.
*
* 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.
*/
/**
* 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.
*/
/**
* Specifies whether the authenticator must be invalidated if the user adds new biometric
* credentials in the OS settings. If not specified, the authenticator will not be invalidated
* when the user adds a new biometric credential in the OS settings.
*/
/**
* Creates a new instance.
*
* @param operationId the identifier of the operation.
* @param accountSelectorProvided flag that tells whether the account selector is provided.
* @param authenticatorSelectorProvided flag that tells whether the authenticator selector is provided.
* @param pinEnrollerProvided flag that tells whether the PIN enroller is provided.
* @param passwordEnrollerProvided flag that tells whether the password enroller is provided.
* @param pinUserVerifierProvided flag that tells whether the PIN user verifier is provided.
* @param passwordUserVerifierProvided flag that tells whether the password user verifier is provided.
* @param biometricUserVerifierProvided flag that tells whether the biometric user verifier is
* provided.
* @param devicePasscodeUserVerifierProvided flag that tells whether the device passcode user
* verifier is provided.
* @param fingerprintUserVerifierProvided flag that tells whether the fingerprint user verifier
* is provided.
* @param onSuccessProvided flag that tells whether the success callback is provided.
* @param onErrorProvided flag that tells whether the error callback is provided.
* @param requestHeaders specifies the additional request headers that must be included in the
* HTTP requests sent by the operation.
* @param username the username that must be used to register.
* @param serverUrl the base URL of the server where the registration should be made.
* @param deviceInformation the device information to be used.
* @param authorizationProvider the object providing the authorization.
* @param pinPolicy the PIN policy to be used.
* @param allowClass2AndroidSensors 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.
* @param allowDevicePasscodeAsFallback specifies whether the OS device passcode can be used as
* fallback during biometric authentication.
* @param invalidateOnNewOsBiometrics specifies whether the authenticator must be invalidated if
* the user adds new biometric credentials in the OS settings.
*/
constructor(operationId, accountSelectorProvided, authenticatorSelectorProvided, pinEnrollerProvided, passwordEnrollerProvided, pinUserVerifierProvided, passwordUserVerifierProvided, biometricUserVerifierProvided, devicePasscodeUserVerifierProvided, fingerprintUserVerifierProvided, onSuccessProvided, onErrorProvided, requestHeaders, username, serverUrl, deviceInformation, authorizationProvider, pinPolicy, allowClass2AndroidSensors, allowDevicePasscodeAsFallback, invalidateOnNewOsBiometrics) {
this.operationId = operationId;
this.accountSelectorProvided = accountSelectorProvided;
this.authenticatorSelectorProvided = authenticatorSelectorProvided;
this.pinEnrollerProvided = pinEnrollerProvided;
this.passwordEnrollerProvided = passwordEnrollerProvided;
this.pinUserVerifierProvided = pinUserVerifierProvided;
this.passwordUserVerifierProvided = passwordUserVerifierProvided;
this.biometricUserVerifierProvided = biometricUserVerifierProvided;
this.devicePasscodeUserVerifierProvided = devicePasscodeUserVerifierProvided;
this.fingerprintUserVerifierProvided = fingerprintUserVerifierProvided;
this.onSuccessProvided = onSuccessProvided;
this.onErrorProvided = onErrorProvided;
this.requestHeaders = requestHeaders;
this.username = username;
this.serverUrl = serverUrl;
this.deviceInformation = deviceInformation;
this.allowClass2AndroidSensors = allowClass2AndroidSensors;
this.allowDevicePasscodeAsFallback = allowDevicePasscodeAsFallback;
this.invalidateOnNewOsBiometrics = invalidateOnNewOsBiometrics;
if (authorizationProvider) {
this.authorizationProvider = _TypedAuthorizationProvider.TypedAuthorizationProvider.create(authorizationProvider);
}
if (pinPolicy) {
this.pinPolicyMessage = new _PinPolicyMessage.PinPolicyMessage(operationId, pinPolicy.minLength, pinPolicy.maxLength);
}
}
}
exports.RegistrationMessage = RegistrationMessage;
//# sourceMappingURL=RegistrationMessage.js.map