@nevis-security/nevis-mobile-authentication-sdk-react
Version:
React Native plugin for Nevis Mobile Authentication SDK. Supports only mobile.
162 lines (160 loc) • 6.58 kB
JavaScript
"use strict";
/**
* Copyright © 2023-2024 Nevis Security AG. All rights reserved.
*/
import { UserInteractionPlatformOperationImpl } from "../../cache/operation/UserInteractionPlatformOperation.js";
import { PlatformOperationCache } from "../../cache/PlatformOperationCache.js";
import { OperationErrorConverter } from "../../error/operation/OperationErrorConverter.js";
import { NativeEventListener } from "../../event/NativeEventListener.js";
import NevisMobileAuthenticationSdkReact from "../../MobileAuthenticationSdk.js";
import { OnSuccessMessage } from "../../model/messages/in/OnSuccessMessage.js";
import { OutOfBandAuthenticationMessage } from "../../model/messages/out/OutOfBandAuthenticationMessage.js";
import { HttpOperation, HttpOperationImpl } from "../HttpOperation.js";
/**
* The operation handling an out-of-band authentication.
*
* This is the object returned by the SDK, when an {@link OutOfBandPayload} was processed and the
* {@link OutOfBandPayload} corresponds to an authentication operation.
*
* Usage example:
* ```ts
* class AccountSelectorImpl extends AccountSelector {
* async selectAccount(
* context: AccountSelectionContext,
* handler: AccountSelectionHandler
* ): Promise<void> {
* await handler.username(username).catch(console.error);
* }
* }
*
* class AuthenticatorSelectorImpl extends AuthenticatorSelector {
* async selectAuthenticator(
* context: AuthenticatorSelectionContext,
* handler: AuthenticatorSelectionHandler
* ): Promise<void> {
* await handler.aaid(aaid).catch(console.error);
* }
* }
*
* class PinUserVerifierImpl extends PinUserVerifier {
* async verifyPin(
* context: PinVerificationContext,
* handler: PinVerificationHandler
* ): Promise<void> {
* await handler.verifyPin(pin).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 authenticateWithOutOfBand(
* client: MobileAuthenticationClient,
* payload: OutOfBandPayload
* ): Promise<void> {
* await client.operations.outOfBandOperation
* .payload(payload)
* .onRegistration((registration) => {
* // handle registration
* })
* .onAuthentication((authentication) => {
* authentication
* .accountSelector(new AccountSelectorImpl())
* .authenticatorSelector(new AuthenticatorSelectorImpl())
* .pinUserVerifier(new PinUserVerifierImpl())
* .biometricUserVerifier(new BiometricUserVerifierImpl())
* .onSuccess((authorizationProvider) => {
* // handle success
* })
* .onError((error) => {
* // handle error
* })
* .execute();
* })
* .onError((_error) => {
* // handle out-of-band error
* })
* .execute();
* }
* ```
*
* @group Performing Operations
* @see {@link OutOfBandOperation.onAuthentication}
*/
export class OutOfBandAuthentication extends HttpOperation {}
export class OutOfBandAuthenticationImpl extends HttpOperationImpl {
constructor(operationId) {
super();
this.operationId = operationId;
}
accountSelector(accountSelector) {
this._accountSelector = accountSelector;
return this;
}
authenticatorSelector(authenticatorSelector) {
this._authenticatorSelector = authenticatorSelector;
return this;
}
pinUserVerifier(pinUserVerifier) {
this._pinUserVerifier = pinUserVerifier;
return this;
}
passwordUserVerifier(passwordUserVerifier) {
this._passwordUserVerifier = passwordUserVerifier;
return this;
}
biometricUserVerifier(biometricUserVerifier) {
this._biometricUserVerifier = biometricUserVerifier;
return this;
}
devicePasscodeUserVerifier(devicePasscodeUserVerifier) {
this._devicePasscodeUserVerifier = devicePasscodeUserVerifier;
return this;
}
fingerprintUserVerifier(fingerprintUserVerifier) {
this._fingerprintUserVerifier = fingerprintUserVerifier;
return this;
}
onSuccess(onSuccess) {
this._onSuccess = onSuccess;
return this;
}
onError(onError) {
this._onError = onError;
return this;
}
async execute() {
const operation = new UserInteractionPlatformOperationImpl(this.operationId, this._accountSelector, this._authenticatorSelector, undefined, undefined, undefined, undefined, this._pinUserVerifier, this._passwordUserVerifier, this._biometricUserVerifier, this._devicePasscodeUserVerifier, this._fingerprintUserVerifier);
PlatformOperationCache.getInstance().put(operation);
NativeEventListener.getInstance().start(this.operationId);
const message = new OutOfBandAuthenticationMessage(this.operationId, this._accountSelector !== undefined, this._authenticatorSelector !== undefined, false, false, this._pinUserVerifier !== undefined, this._passwordUserVerifier !== undefined, this._biometricUserVerifier !== undefined, this._devicePasscodeUserVerifier !== undefined, this._fingerprintUserVerifier !== undefined, this._onSuccess !== undefined, this._onError !== undefined, this.httpRequestHeaders);
const finish = () => {
NativeEventListener.getInstance().stop(this.operationId);
PlatformOperationCache.getInstance().delete(this.operationId);
};
return NevisMobileAuthenticationSdkReact.oobAuthenticate(message).then(data => {
finish();
const successMessage = OnSuccessMessage.fromJson(data);
this._onSuccess?.(successMessage.authorizationProvider);
}).catch(error => {
finish();
const operationError = new OperationErrorConverter(error).convert();
this._onError?.(operationError);
});
}
}
//# sourceMappingURL=OutOfBandAuthentication.js.map