Integrate the Secure Storage SDK

Android

To use the Secure Storage SDK in your Android project

1. Copy SecureStorageSDK.aar from the OneSpan Mobile Security Suite package to the aars folder.

2. Link UtilitiesSDK.aar from the OneSpan Mobile Security Suite package to your project.

To use the Secure Storage SDK library, you also need to add the following external libraries to your maven/gradle project:

dependencies {
implementation 'org.jetbrains.kotlin:kotlin-stdlib:1.9.25'
implementation 'androidx.appcompat:appcompat:1.6.1'
implementation 'androidx.biometric:biometric-ktx:1.2.0-alpha05'
implementation 'org.bouncycastle:bcprov-jdk18on:1.81'
}

iOS

To use the Secure Storage SDK in your iOS project

1. Link MSSSecureStorage.xcframework from the OneSpan Mobile Security Suite package to the linked framework and libraries of your Xcode project.

2. Link the UtilitiesSDK.xcframework from the OneSpan Mobile Security Suite package to the linked framework and libraries of your Xcode project.

Your project must be linked with the -ObjC flag. This should be set in Other Linker Flags in the target's build settings. In a pbxproj project file, the raw key is OTHER_LDFLAGS.

To use this framework with pure Objective-C projects, you need to add a Swift file and create the Bringing Header file.

To see the Objective-C error codes mapped to Swift error cases, refer to the SecureStorageErrorCodes enum in the SDK's public header MSSSecureStorage-Swift.h.

Deprecation of the iteration counter-based data protection

The iteration counter is only required to migrate a secure storage.

To migrate your application to use the new methods to create or write a new secure storage

1. The first call must be done with the up-to-date initialization method without any iteration counter.

2. When the migrationNeeded error is thrown,

   1. call the deprecated initialization method with iteration counter

   2. call the write method. This will create files with new security options.

      If the legacy storage cannot be opened anymore, you need to remove it by calling the delete method.

You are now ready to use the Secure Storage SDK. For more information on, see Available methods in the Secure Storage SDK.