Deprecations
iOS
Advance notice: removal of legacy device fingerprint migration support
In the next version of the SDK we will remove migration support for device fingerprints created with SDK versions 4.27.1 and earlier. Apps using Device Binding SDK version 4.27.1 or earlier must first upgrade to version 5.x, i.e., a version that supports this migration, before upgrading to upcoming version 6.x of the SDK.
Upgrading directly from version 4.27.1 or earlier is not supported and will cause the device fingerprint migration to fail.
Supported upgrade paths:
From 4.x: upgrade to the latest 5.x version first, then upgrade to version 6.x
From 5.x: upgrade directly to version 6.x
Before you upgrade to version 6.x, migrate the fingerprints:
(If you use a version 4.x of the SDK) Upgrade to the latest 5.x version.
Call a fingerprint for every salt your app uses.
Release this app version to your customers, and allow time for the migrations to complete.
Upgrade to version 6.X.
Your fingerprints are now migrated. Fingerprints that are not called before the upgrade may not migrate. If a fingerprint is not migrated, the SDK will generate a new one.
This is an advance notice, you can still upgrade directly to the current version.
New features and enhancements
Android
Maven-based integration
The SDK artifact is now delivered as a local Maven repository, in addition to the previously published standalone aar artifact, and the package now also includes a documentation jar file. For more information, see Maven-based integration.
Saving fingerprint type per salt (preparation for endpoint removal)
As part of the ongoing preparations for removing deprecated endpoints and to ensure that existing users can continue accessing their current fingerprints, the SDK now saves which fingerprint type was used for each salt. Each successful fingerprint(salt) call on the non-biometric types now writes a record to a DataStore Preferences file in the app's storage. The record is a Base64 SHA-256 hash of the salt plus the type name. The fingerprint value itself remains unchanged.
Thread improvements to fix ANR
The biometric fingerprint can now be requested from a background thread. The SDK moves the biometric prompt to the user interface thread itself, which avoids Application Not Responding (ANR) errors during key generation. For more information, see Threading.
Improvements for hardware fingerprints and Keystore error codes
The SDK now provides more reliable hardware fingerprints. Keystore operations that were left open after failed or abandoned calls are now released. On StrongBox devices, these leaks could use up the few available operation slots and make later calls fail with Keystore operation failed.
Keystore error codes have been made clearer. Keystore failures that used to be reported as INTERNAL_ERROR (-4400) or HMAC_KEYGEN_ERROR (-4409) now tell you whether to retry, switch fingerprint type, or treat the key as lost.
Temporary Keystore failures, such as the secure hardware being busy, the Keystore service restarting or too many concurrent operations, will not be reported anymore as INTERNAL_ERROR or STRONGBOX_UNAVAILABLE. Instead, the SDK will now return KEYSTORE_FAILURE (-4418) when problems with the Keystore prevent fingerprint generation. The classification between permanently unusable and potential transient errors are handled using best effort, this error code cannot rule out a permanently unusable key. KEY_INVALID_FOR_OPERATION will now be returned for keys that are considered permanently unusable. And the STRONGBOX_UNAVAILABLE error will now be returned correctly when StrongBox is not available or not generating fingerprints successfully on initial generation.
iOS
Enhanced error lookup
The technical documentation provided in the product package now includes the numeric value of each error code (DeviceBindingErrorCodes), making error lookup easier.
Prepare sample application for iOS 27
The sample application has been updated to adopt the UIKit scene-based application lifecycle which is required for apps to be built with iOS 27 and later. For more information, refer to the iOS documentation and iOS & iPadOS 27 Release Notes.
Fixes and other updates
Android
[MSS-13135]: Incorrect error code returned
Description: The SDK incorrectly returned error code 4400 for a KeyStore exception
Status: This issue has been fixed. New error codes were added, KEY_INVALID_FOR_OPERATION (-4417) and STRONGBOX_UNAVAILABLE (-4416) for KeyStore exceptions. In FingerprintByHardware, an InvalidKeyException from the MAC operation now throws DeviceBindingSDKException(-4417). Before, it fell through to INTERNAL_ERROR. This covers the HARDWARE and HARDWARE_WITH_TEE types. The biometric path (FingerprintByHardwareWithBiometrics) does not use error -4417.
Supported platforms
For information on the supported operating systems and platforms supported by Mobile Security Suite and the affiliated SDKs, see Supported platforms.
Known issues
For information on issues that have not yet been resolved in this release of Mobile Security Suite, see Known issues.
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!
Third party licenses
For information on third party dependencies associated with Mobile Security Suite and the affiliated SDKs in this release, see Third party licenses.