Android
To use the Secure Storage SDK in your Android project
Copy SecureStorageSDK.aar from the OneSpan Mobile Security Suite package to the aars folder.
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:2.2.21' implementation 'androidx.appcompat:appcompat:1.7.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
Link MSSSecureStorage.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
-ObjCflag. This should be set inOther Linker Flagsin the target's build settings. In a pbxproj project file, the raw key isOTHER_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
SecureStorageErrorCodesenum in the SDK's public headerMSSSecureStorage-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
The first call must be done with the up-to-date
initializationmethod without any iteration counter.When the
migrationNeedederror is thrown,call the deprecated
initializationmethod with iteration countercall the
writemethod. This will create files with new security options.If the legacy storage cannot be opened anymore, you need to remove it by calling the
deletemethod.
You are now ready to use the Secure Storage SDK. For more information on, see Available methods in the Secure Storage 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!