Added biometric support api

[Batlin]

Replace custom fingerprint authentication with androidx biometric library (supports both fingerprint and face unlock mechanisms). This library makes all the features announced in Android 10 (API level 29) available all the way back to Android 6 (API level 23).

New strings (shown at the biometric prompt) are available in english and spanish. Rest of languages are missing (strings biometric_prompt_title and biometric_prompt_subtitle).

---

QA

Test plan:

https://github.com/owncloud/QA/blob/master/Mobile/Android/Release_2.15/2775-biometric_support.md

BUGS & IMPROVEMENTS:

• (1) Passcode asked twice after cancelling biometric Added biometric support api #2775 (comment)

[jesmrec]

Thanks for the contribution!! we will dive into it and let you know. Since the contribution is marked as your first contribution, i will give a couple of tips about our process:

• Your contribution will be triaged to be included in one of our sprints (depending priorities etc...)
• The mobile team will check your code, will review it, and maybe you will be suggested changes (maybe not), to assure the code quality as much as posible.
• Once the code review is passed, a QA - test stage will start, to be sure it works as expected. So, you can be reported bugs! (i hope no!)
• Finally, it will be merged for the next product version.

Thanks again!!! i hope this is only the first one of many contributions ;)

[Batlin]

Thank you very much Jesús and happy new year all!

I'd really love to see this being included soon in the production apk. I'm ready to submit any needed modification to the PR (although I hope everything is ok!).

Best regards,

[abelgardep]

Pretty cool feature, we will take a look as soon as possible 👍

[abelgardep]

Some changes requested @Batlin . Thanks for the contribution, looks good 👍

[Batlin]

Thanks @abelgardep for your review. I'm really excited to see this moving along! :)

I've just submitted all suggested changes in a new commit (and made a rebase with master branch), except the ones involving the "set_fingerprint" key. I wanted to confirm with you before committing, because if we rename that key, I think people will have to configure that setting again after updating their apk. Please, confirm me if I should submit a new commit including that change.

Thanks again for your time. Best regards,

[davigonz]

if we rename that key, I think people will have to configure that setting again after updating their apk

@Batlin well, it's not trivial but you could try the following:

1. From registerActivityLifecycleCallbacks, onActivityCreated method in MainApp.kt you could call a static method created in PreferenceManager.java which will delete the set_fingerprint key from preferences (check if it exists before) and create a new set_biometric key with the same value as set_fingerprint.
2. You will also need to change the set_fingerprint key in preferences.xml to set_biometric.

We will need to keep that code to make sure we do not break the app for those users upgrading from older versions to new ones.

Try it out and tell me.

[Batlin]

Ok, I will try it and push a new commit next Friday.

Thank you.

[Batlin]

I've just implemented and tested it. You can check the new commit (I've rebased with master also).

Thank you, hope to see this included soon!

[davigonz]

I've just implemented and tested it. You can check the new commit (I've rebased with master also).
Thank you, hope to see this included soon!

Thanks @Batlin , having a look at it

[davigonz]

@Batlin I've requested a few more changes and we are ready to test the feature

[Batlin]

@davigonz, I've just rebased against master (no conflicts) and pushed the requested changes.

Just to let you know, depending on the UX you want to provide to end users, we could customize the BiometricPrompt that is created in BiometricActivity changing the setConfirmationRequired method. As it's set to true now there is a confirmation required (user has to click on Confirm button) after a biometric has been authenticated. If we set it to false, we could provide a faster authentication experience.

Thank you.

[davigonz]

@davigonz, I've just rebased against master (no conflicts) and pushed the requested changes.

Just to let you know, depending on the UX you want to provide to end users, we could customize the BiometricPrompt that is created in BiometricActivity changing the setConfirmationRequired method. As it's set to true now there is a confirmation required (user has to click on Confirm button) after a biometric has been authenticated. If we set it to false, we could provide a faster authentication experience.

Thank you.

Thanks a lot for applying the changes, the code looks good to me, now it's the turn of @jesmrec who will perform some QA tests.

About the faster authentication experience while using the feature, I'm comparing it with the current one

[davigonz]

As it's set to true now there is a confirmation required (user has to click on Confirm button) after a biometric has been authenticated. If we set it to false, we could provide a faster authentication experience.

@Batlin I do not see that confirmation button, where should it appear? I use my fingerprint in the app and the filelist directly appears without any confirmation button.

[Batlin]

@davigonz, you are right, I've just tested this on a Xiaomi Mi 9T and there is no confirmation button using fingerprint authentication.

But you can see the difference with the face unlock on Pixel 4 (with setConfirmationRequired set to true):

And setConfirmationRequired set to false:

Best regards,

[davigonz]

But you can see the difference with the face unlock on Pixel 4 (with setConfirmationRequired set to true)

Ok, thanks @Batlin !

[jesmrec]

Let's start the QA stage.

In the first message i've added a link to the test plan and i will add the bugs, improvements etc i'd find out

[davigonz]

Hi @davigonz, @jesmrec,

I've just pushed a new commit including the FLAG_ACTIVITY_SINGLE_TOP, and rebased with master.

I hope it gets merged soon!

Best regards,

Thanks a lot @Batlin , I guess @jesmrec can resume the QA work here, we will keep you updated.

[jesmrec]

bug of double passcode is fixed.

[jesmrec]

I did a couple of tests with a Samsung device with Android 9, which contains its own biometrical unlock implementation. By enrolling face and fingerprint is always asked fingerprint, no matter the preference you set.

[Batlin]

Any news on this PR? Which are the next steps?

Best regards,

[jesmrec]

tomorrow we will test with real device Android 10 to check if everyhing is finally OK

[michaelstingl]

Everything worked fine on my Google Pixel 4, but the text always says "Fingerprint", and the Pixel 4 only has FaceID.

Android version: 10
Security patch level: 5 March 2020

[jesmrec]

@Batlin could you take a look? this is the last remaining issue before merging.

With a Pixel2 upgraded to Android10, this is how it looks like that is more correct:

any difference in the new device that make the difference?

both screenshots were taken using the same commit.

[CLAassistant]

All committers have signed the CLA.

[Batlin]

@jesmrec, I've just rebased the branch, without conflicts, and pushed a new commit to fix the reported string issue (really hope it gets merged!).

The only possible explanation is that @michaelstingl has set English (from United Kingdom) in his device and, therefore, it's using strings.xml from values-en-rGB.

Please, keep in mind as I have already warned in my first post that new strings (shown at the biometric prompt) are only available in english (now both US and UK) and spanish. Rest of languages are missing (strings biometric_prompt_title and biometric_prompt_subtitle will be shown in english if users have a different language configured). prefs_biometric string ("fingerprint lock") should be modified in other languages as well.

Thank you all.

Best regards,

[jesmrec]

Thanks @Batlin , your explanation makes much sense. @michaelstingl can check and we approve then if everything is in order.

Let's also check why CI is not passing in this PR.

[jesmrec]

Other issue to take in account are the UI tests.

In settings sets, we used to use the string resource R.string.prefs_fingerprint that has to be changed for R.string.prefs_biometric in

https://github.com/owncloud/android/blob/master/owncloudApp/src/androidTest/java/com/owncloud/android/settings/security/OCSettingsSecurityTest.kt

otherwise, tests will fail.

[michaelstingl]

Good point with the languages…

English (Germany)	Arabic	German	English (UK)
Biometric	Fingerprint	Fingerprint	Biometric

[jesmrec]

Let's then transifex do its magic... i will add by myself the spanish translation :D

From QA this is approved. We have to deal the CI (why the hell is it stucked?) and the UI tests due to the change of resource name.

Thanks for your help @michaelstingl !!

[Batlin]

Should I push a new commit with the UI test modification?

Is there anything else I should do? Just let me know.

Thank you!

[jesmrec]

It would be awesome if you put the commit with the wording modification @Batlin. Thanks!

[jesmrec]

Finally, these were the actions:

• Due to the CI problems, i moved your commits to a new PR: Added biometric support api II #2840

• UI tests were fixed with an additional commit.

• PR was merged and new feature will be included in 2.15

Thanks again for your patience and engagement @Batlin!

[abelgardep]

Merged via #2840, thanks @Batlin !