Installing Protector OATH SDK

Protector OATH SDK must be installed as part of your development platform.

The first step is to unzip the contents of the Protector OATH SDK release onto the host platform. The steps required to build an application based on Protector OATH SDK are listed in their target platforms.

To test an application based on Protector OATH SDK, various servers are required depending on the feature under the test (for example, an authentication server to verify an OTP).

Each platform provides a debug and a release version of Protector OATH SDK for your application:

  • A debug version which allows you to debug your codes and use of more TLS configurations to ease app development.
  • A release version where the security configuration is enforced by TLS configuration, debugging detection, hooking detection, and so on.

Protector OATH SDK provides the following libraries:

Note

The application must not go live with the debug version of the library. The debug version is only for development purposes that may contain debug symbols and introduce certain security issues if used in production. The application must go live using a release version of the library and a properly signed CA Certificate for the server.

Android

In the debug/, and release/ versions, different types of libraries are provided.

In Java library libidpmobile.jar and libidpmobilefasttrack.jar, you can configure the build.gradle file to link the JAR file of debug and release versions correctly using:

dependencies {
    debugImplementation files("${your-ezio-root-dir}/android/debug/libidpmobile.jar")
    debugImplementation files("${your-ezio-root-dir}/android/fasttrack/debug/libidpmobilefasttrack.jar")

    releaseImplementation files("${your-ezio-root-dir}/android/release/libidpmobile.jar")
    releaseImplementation files("${your-ezio-root-dir}/android/fasttrack/release/libidpmobilefasttrack.jar")
} 

The Java library libidpmobile.jar is for Core API and libidpmobilefasttrack.jar is for FastTrack API.

Native libraries

Since SDK V4.6, the sensitive codes were moved from Java to C which includes a shared library libidp-shared.so. Protector OATH SDK does not support MIPS ABIs as there is no device using this architecture. Since SDK V4.7, Protector OATH SDK ceases the support for armeabi ABI.

For a default Protector OATH SDK delivery package, the native libraries include:

You can copy these native libraries to the jniLibs directory of debug and release versions respectively, or configure your build.gradle file as the following codes to link the debug and release version of native libraries correctly:

android {
    ...
    sourceSets {
        debug {
            jniLibs.srcDirs += ["${your-ezio-root-dir}/android/debug"]
        }
        release {
            jniLibs.srcDirs += ["${your-ezio-root-dir}/android/release"]
       }
    }
    ...
}

iOS

These are the versions of Protector OATH SDK available on iOS:

  • debug/EzioMobile.framework
  • debug/EzioMobileFastTrack.framework
  • release/EzioMobile.framework
  • release/EzioMobileFastTrack.framework

EzioMobile.framework is for Core API and EzioMobileFastTrack.framework is for FastTrack API.

Examples

Protector OATH SDK provides the following examples to illustrate the usage of the SDK. Refer to the platform’s readme.txt for the details on building and deploying the project and the additional information.

Core API Example:

Android:

  • android/example/eziomobilesdk_dskpp_example
  • android/example/eziomobilesdk_emvqr_example
  • android/example/eziomobilesdk_emvqr_example_QR_codes.pdf
  • android/example/eziomobilesdk_facial_example
  • android/example/eziomobilesdk_example
  • android/example/eziomobilesdk_oathdcv_example

iOS:

  • ios/examples/eziomobilesdk_dskpp_example
  • ios/examples/eziomobilesdk_dskpp_swift_example
  • ios/examples/eziomobilesdk_emvqr_example
  • ios/examples/eziomobilesdk_oathdcv_example
  • ios/examples/eziomobilesdk_example

FastTrack API Example:

Android:

  • android/fasttrack/examples/fasttrack_example

iOS:

  • ios/fasttrack/examples/fasttrack_example
Note

FaceID example projects are only available in the full release of the SDK package.

Tools

Protector OATH SDK provides the Token Builder tool (tools/eps-tokenbuilder) for application development. The Token Builder tool enables the application developer to provision their device without a live EPS server. It generates two types of files:

  • A file having contents that the Protector OATH SDK requires.
  • A file having contents that the verification server needs. For further details, refer to the documentation within the tool.