Integrate the WBC SDK

Prev Next

Android

AAR artifact-based integration

  1. Link WBCSDK.aar from the OneSpan Mobile Security Suite package to your project's classpath.

  2. Add the file generated by the White-Box Table Generator to the assets folder of your project.

You are now ready to use the WBC SDK. For more information on the functions, refer to the API documentation.

Maven-based integration

The SDK artifact is also delivered as a local Maven repository with transitive dependencies, and the package includes a documentation jar file to view the technical documentation in Android Studio (to be used in conjunction with the Maven repository).

To integrate the SDK via maven repository:

  1. Copy the maven folder from the published artifacts to the root folder of your application.

  2. Define the dependency in your build.gradle file: implementation 'com.onespan:sdk_wbc_android:+'.

  3. Comment out any existing definitions, for example: implementation(name: 'WBCSDK', ext: 'aar').

Additional Considerations

The integration of the WBC SDK on Android can cause some performance issues on low-end devices, during the loading of the WBC tables.

iOS

White-Box Cryptography SDK provides native protocols for Objective-C and Swift.

The following procedure enables you to integrate and use the WBC SDK in your iOS project.

If you use the White-Box Cryptography SDK on the iOS Simulator, the following warning can be included in the logs:
libMobileGestalt MobileGestalt.c:890: MGIsDeviceOneOfType is not supported on this platform.

You can ignore this warning!

To integrate the WBC SDK into your iOS project

  1. Link MSSWBC.xcframework from the OneSpan Mobile Security Suite package to your Xcode project (linked framework and libraries).

  2. Add the file generated by the White-Box Table Generator to your project and verify that file is included in the app bundle.

You are now ready to use the WBC SDK.

API reference documentation and sample applications

To learn more about the public APIs and their functions, exceptions, and error codes, refer to the technical documentation that is included in the product package for each SDK and each platform. In the product package, you can also find the sample applications provided for each platform to see examples of how the SDKs can be used.

These sample apps are intended only to demonstrate basic scenarios and SDK usage. They are not designed to be copied directly into production projects!