Migrated to use BioMetricManager for performing Authentication before accessing credentials via SecureCredentialsManager
Breaking Changes:
Removed the requireAuthentication API which used to be a pre-requisite previously for performing authentication while retrieving Credentials as it is no longer needed.
New API:
Updated the constructor of SecureCredentialsManager to accept fragmentActivity & authenticationOptions which are utilised while performing authentication using BiometricPrompt before retrieving credentials. It's no longer needed to call requireAuthentication before retrieving credentials.
Other changes:
We've added a dependency on androidx.biometrics package to use the BiometricsManager for authentication purposes.
Added class LocalAuthenticationManager which consolidates all the logic for interacting with the BiometricsManager
Added class LocalAuthenticationOptions which helps to configure the behaviour of the BiometricsManager like title, description displayed within in the biometric prompt and the level of authentication required.
Updated CredentialsManagerException to contain enum Code describing the reason for exception and allowing users to check all the cases of CredentialsManagerException and handle accordingly
Testing
Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. Since this library has unit testing, tests should be added for new functionality and existing tests should complete without errors.
[x] This change adds unit test coverage
[ ] This change adds integration test coverage
[ ] This change has been tested on the latest version of the platform/language or why not
Migrated to use BioMetricManager for performing Authentication before accessing credentials via SecureCredentialsManager
Breaking Changes:
requireAuthentication
API which used to be a pre-requisite previously for performing authentication while retrieving Credentials as it is no longer needed.New API:
SecureCredentialsManager
to acceptfragmentActivity
&authenticationOptions
which are utilised while performing authentication usingBiometricPrompt
before retrieving credentials. It's no longer needed to callrequireAuthentication
before retrieving credentials.Other changes:
androidx.biometrics
package to use theBiometricsManager
for authentication purposes.BiometricsManager
BiometricsManager
liketitle
,description
displayed within in the biometric prompt and the level of authentication required.CredentialsManagerException
to contain enumCode
describing the reason for exception and allowing users to check all the cases ofCredentialsManagerException
and handle accordinglyTesting
Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. Since this library has unit testing, tests should be added for new functionality and existing tests should complete without errors.
Checklist