Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CT-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Crypto Command Center
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Windows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
back

OneWelcome ReactNative SDK 1.0.0

Configuration

search
printsuggest an edit

Configuration

copy link to clipboardIntroduction

This section describes the first steps to integrate the OneWelcome React Native SDK with an existing React Native project. In this topic we will describe how you can configure your project to use our SDK.

The SDK consists of a react-native wrapper for the OneWelcome Android and iOS SDKs. You will need explicit access to the Android and iOS SDKs, the wrapper is public.

copy link to clipboardRequirements

copy link to clipboardAndroid:

  • Minium API level 23

For more information see android SDK documentation

copy link to clipboardiOS:

  • Minimum iOS version 13

For more information see iOS SDK documentation

copy link to clipboardReact Native

  • Minimum version 0.63

Lower versions of React Native might or might not work and have not been tested.

copy link to clipboardAdding the dependency

We start by installing the sdk with your prefered package manager.

npm: npm install @onewelcome/react-native-sdk --save

yarn: yarn add @onewelcome/react-native-sdk

copy link to clipboardSDK Configuration

  1. Get access to https://repo.onewelcome.com/artifactory/onegini-sdk
  2. Use https://github.com/onewelcome/sdk-configurator on your application (instructions can be found there)

copy link to clipboardAndroid:

Please note, that adding a lot of dependencies to the project can lead to a build exception that indicates your app has reached a limit of the Android app build architecture. In such case you should use multidex.

Make sure you are running a minSdkVersion of 23.

Modify android/app/build.gradle : Add to android-> defaultConfig section:

android {
  defaultConfig {
    minSdkVersion 23
    __ ...
  }
}

The OneWelcome Android SDK is uploaded to a private artifactory repository. In order to obtain credentials, navigate to https://onewelcome.atlassian.net/servicedesk/customer/portals and submit a request for access. Assuming you already have access to this repository, you will have to provide credentials in order to access the repository.

Set onegini artifactory user and onegini_artifactory_ password at android/gradle.properties or globally for Gradle in ~/gradle/gradle.properties (recommended).

onegini_artifactory_user=<username>
onegini_artifactory_password=<password>

You will have to manually add this repository to your android/build.gradle for it to be able to download the Native Android SDK.

Add in allprojects->repositories in android/build.grade .

allprojects {
    repositories {
                __ Previous code here.
        __ ...
        if (project.hasProperty('onegini_artifactory_user') && project.hasProperty('onegini_artifactory_password')) {
            maven {
                url "https:__repo.onewelcome.com_artifactory_onegini-sdk"
                credentials {
                    username "${onegini_artifactory_user}"
                    password "${onegini_artifactory_password}"
                }
            }
        } else {
            throw new InvalidUserDataException("You must configure the 'artifactory_user' and 'artifactory_password' properties in your project before you can " +
                "build it.")
        }
    }
}

Modify android/app/src/main/AndroidManifest.xml. Add <intent-filter> to your MainActivity for listening for browser redirects, this is how the browser communicates back to the app after successful authentication. The scheme="reactnativeexample" should be changed to your schema (will be provided by onegini-sdk-configurator):

<intent-filter>
  <action android:name="android.intent.action.VIEW" _>

  <category android:name="android.intent.category.DEFAULT"_>
  <category android:name="android.intent.category.BROWSABLE"_>

  <data android:scheme="reactnativeexample"_>
<_intent-filter>

Setup the OneWelcome config: Generate a OneginiConfigModel and keystore.bks with SDK Configurator. The configurator will put OneginiConfigModel into the RN application's package_classpath.OneginiConfigModel (e.g. com.exampleapp.OneginiConfigModel) and the keystore.bks into /res/raw.

After using the configurator - you have 2 options:

  • Keep it as it is.
  • If there is a need to move OneginiConfigModel to another place - it's required to specify custom classpath for OneWelcomeSdk: setConfigModelClassName(className). More information HERE.

copy link to clipboardSet up the security controller

In order to change security options you should create your own instance of SecurityController and pass it to OneWelcomeSdk - See the setSecurityControllerClassName(className). More information HERE.

By default, debug detection and root detection are enabled in the SDK. This also means that you can not run the SDK on an android emulator without adjusting these settings.

You should add the path to this SecurityController class in the in config when instantiating the SDK in react native. See HERE for how to set up the config.

When minifying is enabled, proguard will change the names of classes. This prevents the SDK from loading a class with reflection. The following rule prevents proguard from modifying the SecurityController class. Make sure to replace the classPath here with the one in your project.

Add to android/app/proguard-rules.pro

-keep class com.onegini.mobile.rnexampleapp.SecurityController { *; }

Add in your project package_classpath e.g.. com.rnexampleapp 

package com.rnexampleapp;

@SuppressWarnings({ "unused", "WeakerAccess" })
public final class SecurityController {
  public static final boolean debugDetection = false;
  public static final boolean rootDetection = false;
  public static final boolean debugLogs = true;
}

These settings are for development only. In production you should have debugDetection and rootDetection enabled.

copy link to clipboardiOS:

This section describes how to set up the OneWelcome Native iOS SDK and configurations for iOS

copy link to clipboardAdding the native sdk

The Onegini SDK is uploaded to the Onegini Artifactory repository. In order to let CocoaPods use an Artifactory repository you need to install a specific plugin.

Run the following command to install the CocoaPods plugin.

gem install cocoapods-art

It is strongly recommended that you install CocoaPods as a Rubygem and not through Homebrew. Installing with Homebrew may cause issues with the CocoaPods hooks mechanism that the plugin relies on.

The Onegini SDK repository is not a public repository. You must provide credentials in order to access the repo.

Create a file named .netrc in your Home folder (~/) and add the following contents to it. (Replace the <username> and <password> with the credentials that you use to login to support.onegini.com.)

machine repo.onewelcome.com
   login <username>
   password <password>

The Onegini CocoaPods repository must be added to your local machine using the following command:

pod repo-art add onegini https:__repo.onewelcome.com_artifactory_api_pods_cocoapods-public

In order to update the Repository you must manually perform an update:

pod repo-art update onegini

Add next toios/Podfile (before app target):

source 'https:__github.com_CocoaPods_Specs.git'
plugin 'cocoapods-art', :sources => ['onegini']

use_frameworks!

platform :ios, "13.0"

Add the following into your post install script in ios/Podfile

installer.pods_project.targets.each do |target|
        target.build_configurations.each do |config|
            config.build_settings['ENABLE_BITCODE'] = 'NO'
            config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '13.0'
            config.build_settings["EXCLUDED_ARCHS[sdk=iphonesimulator*]"] = "arm64"
        end
    end

Run pod install

Add SecurityController.h and SecurityController.m as described HERE

Optional: In order to support FaceID or TouchID add next to ios/<project-name>/info.plist:

<key>NSFaceIDUsageDescription<_key>
<string>Application needs access to support authentication with Face_Touch ID<_string>

Biometrics will not work on iOS simulator, only on the real devices

copy link to clipboardLinking Native Code

copy link to clipboardRN >= 60.0

cd ios && pod install

copy link to clipboardManual installation

copy link to clipboardiOS

  1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
  2. Go to node_modules ➜ onewelcome-react-native-sdk and add RNOnewelcomeSdk.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNOneginiSdk.a to your project's Build Phases ➜ Link Binary With Libraries
  4. Run your project (Cmd+R)<

copy link to clipboardAndroid

  1. Open up android/app/src/main/java/[...]/MainActivity.java

  2. Add import com.onewelcome.mobile.RNOneWelcomeSdkPackage; to the imports at the top of the file

  3. Add new RNOneWelcomeSdkPackage() to the list returned by the getPackages() method

  4. Append the following lines to android/settings.gradle:

include ':onewelcome-react-native-sdk'
project(':onewelcome-react-native-sdk').projectDir = new File(rootProject.projectDir,     '.._node_modules_onewelcome-react-native-sdk_android')
  1. Insert the following lines inside the dependencies block in android/app/build.gradle:
compile project(':onewelcome-react-native-sdk')

On this page