We have released version 3.22 of our SDK for Android.
\nAdded support for the device groups feature.
\nFor configuration details, see the Device groups documentation.
\nAdded error code serverErrorMissingAuthMethod, which may occur if an authentication method in a device group is deactivated.
Added non-blocking versions of the following support methods that accept a callback:
\nactivatedAuthMethodsactivatedRecoveryMethodsisActivatedisRecoveryActivatedregistrationIdAdded a new Controller.State, ERROR_INITIALIZING, to indicate that controller initialisation failed.
Controller initialisation now runs on a background thread to reduce creation time and prevent application not responding (ANR) situations.
\nBefore calling a controller operation such as isActivated, you must check that the controller state described in Controller state is READY or ERROR_INITIALIZING.
\n
Improved security for compliance with NSM/NIST:
\nOld elliptic curve keys do not work with the 3.22 API. Set the publicKeyBase64 property of EncapConfig to the Base64-encoded DER X25519 public key.
Removed the offline authentication feature.
\nRemoved error codes:
\nclientErrorOfflineVersionNotSupportedclientErrorOfflineParsingFailedWe have released version 3.21 of our SDK for Android.
\nAdded the following new risk parameters:
\nSSIDBSSIDBarometerGravityMagnetometerIsDeveloperModeIsOverlayDetectedIsProxyEnabledIsVpnEnabledLocaleIf you enable the SSID or BSSID risk parameters, you must add the required permissions to your AndroidManifest.xml file.
To learn how to do this, see Wi-Fi information (SSID and BSSID) in our Risk parameters feature documentation.
Added the error code clientErrorClientDataInvalid for client data passed to the start authentication operation that:
Added the exception class to each ErrorCode entry so you can look up the exception associated with an error code.
Renamed the recovery method enum entry:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Before | After |
|---|---|
RecoveryMethod.CLOUD_BACKUP | RecoveryMethod.CLOUD_BACKUP_RECOVERY_CODE |
You must replace all occurrences of RecoveryMethod.CLOUD_BACKUP with RecoveryMethod.CLOUD_BACKUP_RECOVERY_CODE in your code.
Changed the error code returned when the device has no enrolled biometrics to align with iOS:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Before | After |
|---|---|
clientErrorAuthMethodNotAllowed | clientErrorAuthMethodUnavailable |
The SDK still returns clientErrorAuthMethodNotAllowed in cases where an authentication method is being used but is not yet activated, or if not enabled in the server configuration.
Removed SDK error code serverErrorAuthenticationRequired.
We have released version 3.20 of our SDK for Android.
\nAdded support for face scan recovery alongside recovery codes, with the enum entry RecoveryMethod.CLOUD_BACKUP_SERVER_SIDE_FACE.
Added the following classes:
\nRecoveryParameterRecoveryCodeRecoveryParameterServerSideFaceRecoveryParameterAdded the following Controller methods accepting RecoveryParameter:
fun finishAddOrUpdateRecovery(
recoveryParameter: RecoveryParameter,
appCallback: AsyncCallback<FinishAddOrUpdateRecoveryResult>
)
fun finishRecovery(
recoveryParameter: RecoveryParameter,
activationParameter: ActivationParameter,
appCallback: AsyncCallback<FinishRecoveryResult>
)
fun finishDeleteRecovery(
recoveryParameter: RecoveryParameter,
appCallback: AsyncCallback<FinishDeleteRecoveryResult>
)
Rewrote the Encap Android API from Java to Kotlin 2.0. It remains backwards compatible with API 3.19 and adds a dependency on kotlin-stdlib version 2.0.
Raised the minimum Android version to Android 9 (API 28).
\nDeprecated the EncapRecoveryParameter class and the Controller methods that accept it.
Removed the deprecated Controller method:
void startAddOrUpdate(
String clientData,
AsyncCallback<StartAddOrUpdateResult> callback
);
Removed SDK error code serverErrorAlreadyAuthenticated.
Removed the SDK error code clientErrorGoogleServicesOutdated and the exception class GooglePlayServicesOutdatedException.
We have released version 3.19 of our SDK for Android.
\nAdded the server-side face authentication method AuthMethod.DEVICE_SERVER_SIDE_FACE.
You can use server-side face authentication to change a forgotten PIN when the end-user has no valid biometrics.
\nAdded the following Controller method:
void startAddOrUpdate(
@NonNull StartAddOrUpdateParameter startParameter,
@NonNull AsyncCallback<StartAddOrUpdateResult> callback
);
You can choose the parameter for your use case:
\nFor server-side face authentication, you can use:
\nStartAddOrUpdateParameter(AuthMethod.DEVICE_SERVER_SIDE_FACE)
To pass client data, you can use:
\nStartAddOrUpdateParameter(String clientData)
Added @NonNull and @Nullable annotations to all Controller methods to support Kotlin integration.
Raised the minimum Android version to Android 8 (API 26).
\nPROCESSING_DEACTIVATION is now a blocking state. Starting a new operation before deactivation finishes returns clientErrorOperationInProgress.
If biometrics or fingerprint are not enrolled or enabled on the device, the SDK returns BiometricAuthenticationException with clientErrorAndroidBiometricPromptErrorNoBiometrics. This replaces UnexpectedException with clientErrorUnexpected.
Deprecated the following Controller method:
void startAddOrUpdate(
String clientData,
AsyncCallback<StartAddOrUpdateResult> callback
);
The String clientData argument is made obsolete by the new method accepting:
StartAddOrUpdateParameter(String clientData)
Removed the fingerprint authentication method AuthMethod.DEVICE_ANDROID_FINGERPRINT. Use AuthMethod.DEVICE_ANDROID_BIOMETRIC_PROMPT instead.
For existing fingerprint users, you can migrate from PIN to Biometric Prompt using addOrUpdate. To migrate from fingerprint to Biometric Prompt, you must use an earlier SDK version.
We have released version 3.18 of our SDK for Android.
\nAdded the annotation @NonNull to both the OnSuccess and OnFailure functions of AsyncCallback.
Renamed the operation context methods in FinishActivationResult and FinishAuthenticationResult to match StartAuthenticationResult and iOS:
| Previous name | New name |
|---|---|
getResponseTitle() | getContextTitle() |
getResponseConent() | getContextContent() |
getResponseMimeType() | getContextMIME() |
The old methods are deprecated. They will be removed in the next release.
Deprecated fingerprint authentication. It will be removed in a future release.
", "url": "https://developer.signicat.com/docs/mobile-identity/encap/release-notes/sdk-android/20-10-2023/", "title": "Released Android SDK 3.18", "summary": "The 3.18 release is now available for Android SDK.", "date_modified": "2023-10-20T00:00:00.000Z", "tags": [ "Enhancement", "Deprecation", "Documentation" ] }, { "id": "https://developer.signicat.com/docs/mobile-identity/encap/release-notes/sdk-android/26-05-2023/", "content_html": "We have released version 3.17 of our SDK for Android.
\nThe Biometric Prompt activation and authentication parameters now expose setConfirmationRequired().
Raised the minimum Android version to Android 7.
\nReplaced the SafetyNet Attestation API with the Play Integrity API.
\nRemoved the intermediate push feature. You must use the Play Integrity API for app attestation instead.
\nRemoved the following deprecated API methods:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Removed deprecated API method | Use instead |
|---|---|
StartAuthenticationResult: getAllowedAuthMethods() | getAuthMethodsForAuthentication() |
StartActivationResult: getAllowedAuthMethods() | getAuthMethodsForActivation() |
StartAddOrUpdateResult: getAllowedAuthMethodsForActivation() | getAuthMethodsForActivation() |
We have released version 3.16 of our SDK for Android.
\nAdded the client debug data feature.
\nThe new EncapConfig setting setAllowDebugData is true by default. You can set it to false to prevent a device from sending debug data, even if you have enabled it in your application configuration.
Deprecated the following API methods:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Deprecated API method | Use instead |
|---|---|
StartAuthenticationResult: getAllowedAuthMethods() | getAuthMethodsForAuthentication() |
StartActivationResult: getAllowedAuthMethods() | getAuthMethodsForActivation() |
StartAddOrUpdateResult: getAllowedAuthMethodsForActivation() | getAuthMethodsForActivation() |
Removed the fingerprint documentation. For new implementations, we recommend using Biometric Prompt.
\nIf you need fingerprint authentication on Android 6–8, we recommend using Biometric Prompt with the AndroidX library.
\nYou can still access the removed fingerprint documentation in an earlier version of this documentation.
\nRemoved the documentation about building with Maven. You can still access the removed Maven integration documentation in an earlier version of this documentation.
\nDeactivating a non-activated registration on the client no longer results in an error.
\nThe SafetyNet Attestation API will be replaced with the Play Integrity API in version 3.17.
", "url": "https://developer.signicat.com/docs/mobile-identity/encap/release-notes/sdk-android/30-01-2023/", "title": "Released Android SDK 3.16", "summary": "The 3.16 release is now available for Android SDK.", "date_modified": "2023-01-30T00:00:00.000Z", "tags": [ "Feature", "Bug fix", "Deprecation", "Documentation" ] }, { "id": "https://developer.signicat.com/docs/mobile-identity/encap/release-notes/sdk-android/30-06-2022/", "content_html": "We have released version 3.15 of our SDK for Android.
\nAdded support for cancelling an ongoing biometric authentication for AndroidX BiometricPrompt.
\nYou can cancel an ongoing biometric authentication by supplying a CancellationSignal to the DeviceAndroidBiometricPromptAuthParameter and calling the cancel() method.
The Encap API sets up a listener on the CancellationSignal that calls the cancelAuthentication() method of AndroidX BiometricPrompt.
Replaced the error code clientErrorKeyPermanentlyInvalidated (180) with clientErrorAuthDataInvalidated (132) to align with iOS.
Deprecated intermediate push attestation. It will be removed in a future release.
", "url": "https://developer.signicat.com/docs/mobile-identity/encap/release-notes/sdk-android/30-06-2022/", "title": "Released Android SDK 3.15", "summary": "The 3.15 release is now available for Android SDK.", "date_modified": "2022-06-30T00:00:00.000Z", "tags": [ "Feature", "Breaking change", "Deprecation" ] }, { "id": "https://developer.signicat.com/docs/mobile-identity/encap/release-notes/sdk-android/15-02-2022/", "content_html": "We have released version 3.14 of our SDK for Android.
\nAdded the geofencing feature.
\nThe SDK uses an external geocoder service to look up the device location, then sends the country code to the server.
\nAdded the serverErrorInvalidSession error code.
If the server starts a new session after the client calls startAuthenticate, finishAuthenticate returns this error. You need to call startAuthenticate again to start a new authentication attempt.
Renamed the AuthenticateAndActivate operation to AddOrUpdate.
On iOS, this operation has always been called AddOrUpdate. The rename aligns the Android and iOS controller interfaces.
Removed the signing feature. If your app uses signing, you must remove calls to its functions.
\nRemoved the following functions and classes:
\nEncapConfig.Builder: setSigningEnabled() and setSigningKeySize()EncapController: startAuthenticationOrSigning(), startSigning() and FinishSigning()EncapController.State: isSigningState()PushMessage: isSigningMessage()SigningFailedExceptionStartSigningResultFinishSigningResultRemoved the following error codes:
\nserverErrorIncorrectSignatureserverErrorInvalidSignatureWe have released version 3.13 of our SDK for Android.
", "url": "https://developer.signicat.com/docs/mobile-identity/encap/release-notes/sdk-android/02-11-2021/", "title": "Released Android SDK 3.13", "summary": "The 3.13 release is now available for Android SDK.", "date_modified": "2021-11-02T00:00:00.000Z", "tags": [] } ] }