@vortigo/react-native-onespan-wrapper v0.2.5

Project Setup

Add to your project android/build.gradle:

maven {
    url 'https://pkgs.dev.azure.com/vortigo-af/OneSpan/_packaging/onespan/maven/v1'
    redentials {
    username "vortigo-af"
    password ""
  }
}

React Native OneSpan Wrapper

React Native library that implements native Wrapper for Android

Installation

To install and set up the library, run:

$ npm install @vortigo/react-native-onespan-wrapper --save

Or if you prefer using Yarn:

$ yarn add @vortigo/react-native-onespan-wrapper

Usage

Configuration

import OnespanWrapper from '@vortigo/react-native-onespan-wrapper';

const response = await OnespanWrapper.config(
  domainIdentifier,
  saltStorage,
  saltDigipass,
  mainActivityPath
);

User Self-Registration

Application Workflow

Activation command

Import OnespanActivate from wrapper

import OnespanWrapper from '@vortigo/react-native-onespan-wrapper';

And then call the method passing the authentication parameters

const command = await OnespanWrapper.activate(
  userIdentifier,
  activationPassword
);

Example

const activateUser = async (userIdentifier, activationPassword) => {
  let sdkResponse = '';
  let apiResponse = '';
  sdkResponse = await OnespanWrapper.activate(
    userIdentifier,
    activationPassword
  );

  apiResponse = await executeAPICommand(sdkResponse);

  do {
    sdkResponse = await OnespanWrapper.execute(apiResponse);
    if (sdkResponse !== 'success') {
      apiResponse = await executeAPICommand(sdkResponse);
    }
  } while (sdkResponse !== 'success');
};

Example of our helper function "executeAPICommand", but you can create your own

const commandsURL = `${baseURL}/v1/orchestration-commands`;
const executeAPICommand = async (command: string) => {
  try {
    const response = await axios.post(commandsURL, {
      command,
    });

    if (response?.data?.command) {
      const { command } = response.data;
      return command;
    } else {
      throw new Error('API command execution error');
    }
  } catch (error) {
    console.log(`${error}`);
  }
};

Execute command

import OnespanWrapper from '@vortigo/react-native-onespan-wrapper';

and send a command to be interpreted by the Onespan Native SDK

const response = await OnespanWrapper.execute(command);

Push Notification Registration

Application workflow

OnespanRegisterNotification command

import OnespanWrapper from '@vortigo/react-native-onespan-wrapper';

const onespanRegisterNotification = async () => {
  let sdkResponse = '';
  let apiResponse = '';
  let subString = '';
  sdkResponse = await OnespanWrapper.registerNotification.register();
  apiResponse = await executeAPICommand(sdkResponse);

  do {
    sdkResponse = await OnespanWrapper.registerNotification.execute(
      apiResponse
    );
    subString = sdkResponse.substring(0, 14);
    if (subString !== 'notificationId') {
      apiResponse = await executeAPICommand(sdkResponse);
    }
  } while (subString !== 'notificationId');
};

User Authentication With Push Notifications

Application workflow

To Check new notifications (can be used on useEffect)

import OnespanWrapper from '@vortigo/react-native-onespan-wrapper';

const checkNotification = async () => {
  try {
    const response = await OnespanWrapper.pushNotification.checkAndExecute();

    if (response != '') {
      const apiResponseCommand = await executeAPICommand(response);

      if (apiResponseCommand) {
        onespanAuthPushNotificationExecute(apiResponseCommand);
      }
    }
  } catch (e) {
    console.error(e);
  }
};

Notification execute command

import OnespanWrapper from '@vortigo/react-native-onespan-wrapper';

const onespanAuthPushNotificationExecute = async (command: string) => {
  try {
    const response = await OnespanWrapper.pushNotification.execute(command);

    let splitString = response.split(':');

    if (splitString[0] == 'data') {
      onespanAuthenticationApproved(true);
    } else if (splitString[0] == 'success') {
    } else {
      const apiResponseCommand = await executeAPICommand(response);

      if (apiResponseCommand) {
        onespanAuthPushNotificationExecute(apiResponseCommand);
      }
    }
  } catch (e) {
    console.error(e);
  }
};

Send approval command

import OnespanWrapper from '@vortigo/react-native-onespan-wrapper';

const onespanAuthenticationApproved = async (approved: boolean) => {
  try {
    const response = await OnespanWrapper.pushNotification.isApproved(approved);
    let splitString = response.split(':');
    if (splitString[0] == 'pin') {
      // you can call the pin screen here
      // the pin screen should call a function
      // onespanOnUserAuthenticationInput passing the pin
      // onespanOnUserAuthenticationInput(pin);
    } else {
      // request to /v1/orchestration-commands OCA
      const apiResponseCommand = await executeAPICommand(response);

      if (apiResponseCommand) {
        // send command to orchestrationSDK.execute
        onespanAuthPushNotificationExecute(apiResponseCommand);
      }
    }
  } catch (e) {
    console.error(e);
  }
};

Notification - Auth with PIN

import OnespanWrapper from '@vortigo/react-native-onespan-wrapper';

const authWithPinResponse = await OnespanWrapper.pushNotification.authWithPin(
  pin
);

async function onespanOnUserAuthenticationInput(pin: string) {
  // if user aborted authentication - send "" or send pin for auth
  const response = await OnespanWrapper.pushNotification.authWithPin(pin);

  if (response) {
    // request to /v1/orchestration-commands OCA
    const apiResponseCommand = await executeAPICommand(response);

    if (apiResponseCommand) {
      // send command to orchestrationSDK.execute
      onespanAuthPushNotificationExecute(apiResponseCommand);
    }
  }
}

Auth with CRONTO

import OnespanWrapper from '@vortigo/react-native-onespan-wrapper';

const responseScan = await OnespanWrapper.scanQrCode();

const response = await OnespanWrapper.pushNotification.execute(responseScan);

Example

const onScan = async () => {
  try {
    const responseScan = await OnespanWrapper.scanQrCode();
    console.log(`responseScan: ${responseScan}`);

    const response = await OnespanWrapper.pushNotification.execute(
      responseScan
    );
    // promisse for a command / "canceled:" or "exception:"
    console.log(`onScan.execute: ${response}`);

    if (response) {
      // request to /v1/orchestration-commands OCA
      const apiResponseCommand = await executeAPICommand(response);

      if (apiResponseCommand) {
        // send command to orchestrationSDK.execute
        console.log(`apiResponseCommand: ${apiResponseCommand}`);
        onespanAuthPushNotificationExecute(apiResponseCommand);
      }
    }
  } catch (e) {
    console.error(e);
  }
};

Remove current user from device

import OnespanWrapper from '@vortigo/react-native-onespan-wrapper';

const response = await OnespanWrapper.removeCurrentUser();