Cannot enroll finger on Jammy

[Andy Chi]

[Impact]
Cannot enroll finger on Jammy (goodix tod driver)

[Test plan]
1. Install Jammy on XPS-9310
2. Open Gnome-control-center and select `User`
3. Enroll fingerprint

1. Find another Laptop with fingerprint device and test on Jammy

[Where problems could occur]
* This change will only affect fingerprint tod driver

The changes are mostly in the wrapper for the goodix driver so the focus should be on testing if finger print enrollment and identification is working on those devices during both authentication and finger enrollment (especially when no other fingerprints have been already enrolled).

The only possible regression may happen in goodix devices using the TOD driver that may not been able to enroll or log-in.

[Launchpad Janitor (janitor)]

Status changed to 'Confirmed' because the bug affects multiple users.

[Michael F (mfr0301)]

+1, I can confirm this behavior after updating to 22.04 on a Lenovo t495s (AMD Ryzen 5 PRO 3500U).

[Tom Colvin (tdcolvin)]

Same problem here:
Bus 001 Device 004: ID 27c6:533c Shenzhen Goodix Technology Co.,Ltd. FingerPrint

Dell XPS 15 9500

Attached English language version of @mfr0301's screenshot in case that is helpful.

[Vincent Gerris (vgerris)]

Same issue on my Dell Inspiron 5482 with:
Bus 001 Device 003: ID 27c6:538c Shenzhen Goodix Technology Co.,Ltd. Fingerprint Reader

which used to work on 20.04 LTS.
Will the goodix driver need to be updated?
Anyway, happy to test, thanks for reporting

[Marco Trevisan (Treviño) (3v1n0)]

So, apparently libfprint is still working fine, as I can properly run the libfprint's examples to enroll, identify and verify the prints. While fprintd seems to handle this poorly.

[Andy Chi (andch)]

Tried the patch from @3v1n0 on xps 9310, I can enroll fingerprint and login without issue.

[Ubuntu Foundations Team Bug Bot (crichton)]

The attachment "testpatch.patch" seems to be a patch. If it isn't, please remove the "patch" flag from the attachment, remove the "patch" tag, and if you are a member of the ~ubuntu-reviewers, unsubscribe the team.

[This is an automated message performed by a Launchpad user owned by ~brian-murray, for any issues please contact him.]

[Andy Chi (andch)]

[FP device]
27c6:533c

[libfprint-2-tod1-goodix]
0.0.6-0ubuntu1~22.04.1
TOD driver ppa:
https://launchpad.net/~andch/+archive/ubuntu/staging-fprint

[steps]
1. Enroll right index finger
2. Enroll left index finger with right index finger (error reported)
3. Login with left index finger

[result]
Login without any issue.

[Vincent Gerris (vgerris)]

I still get an enroll error with the staging driver unfortunately...

[Francesco (franciccio)]

Is there any news on this?

I too have tried the staging driver mentioned above but was still getting the same errors.

[Launchpad Janitor (janitor)]

This bug was fixed in the package libfprint - 1:1.94.3+tod1-0ubuntu2

---------------
libfprint (1:1.94.3+tod1-0ubuntu2) kinetic; urgency=medium

  * debian/patches: Ensure that identify works with old goodix driver
    (LP: #1966911)

 -- Marco Trevisan (Treviño) <email address hidden> Sun, 17 Jul 2022 17:37:33 +0200

[Łukasz Zemczak (sil2100)]

As this SRU touches existing code, I would like to see a regression potential section added to the bug description [1], aka. "Where problems could occur". Can someone take a look and write up some ideas on what could go wrong in case the cherry-picked code is buggy? Thanks.

[1] https://wiki.ubuntu.com/StableReleaseUpdates#SRU_Bug_Template

[Andy Chi (andch)]

Followed the steps and test on my XPS9310, fingerprint device works well.

[Andy Chi (andch)]

@3v1n0 uploaded to jammy queue, but if anyone wants to test before the packages is in -proposed. Here is my PPA.

https://launchpad.net/~andch/+archive/ubuntu/staging-fprint/

[Andy Chi (andch)]

Verified on synaptics laptop with libfprint mentioned in comment #17. Synaptics fingerprint works well.

[Łukasz Zemczak (sil2100)]

Hello Andy, or anyone else affected,

Accepted libfprint into jammy-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/libfprint/1:1.94.3+tod1-0ubuntu2~22.04.01 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-jammy to verification-done-jammy. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-jammy. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[Łukasz Zemczak (sil2100)]

The chosen version number wasn't ideal, but on the other hand it also wasn't invalid - so I accepted as is (~22.04.01 instead of ~22.04.1). Please remember to use the package from -proposed during verification! Thank you.

[Andy Chi (andch)]

Tested on Elan fp device [04f3:0c7e] and install libfprint 1:1.94.3+tod1-0ubuntu2~22.04.01 from proposed.

Follow the steps
1. Open settings
2. Enroll finger
3. Logout
4. Login with enrolled finger

Fingerprint works fine.

[Andy Chi (andch)]

Tested on Goodix fp device [27c6:63bc] and install libfprint 1:1.94.3+tod1-0ubuntu2~22.04.01 from proposed.

Follow the steps
1. Open settings
2. Enroll finger
3. Logout
4. Login with enrolled finger

Fingerprint works fine.

[Andy Chi (andch)]

Tested on Goodix fp device [27c6:533c] and install libfprint 1:1.94.3+tod1-0ubuntu2~22.04.01 from proposed and goodix-tod driver (0.0.6-0ubuntu1~22.04.1) from https://launchpad.net/~andch/+archive/ubuntu/staging-fprint

Follow the steps
1. Open settings
2. Enroll finger
3. Logout
4. Login with enrolled finger

Fingerprint works fine.

[Tom Colvin (tdcolvin)]

Tested on Dell XPS 9500 with:
Bus 001 Device 002: ID 27c6:533c Shenzhen Goodix Technology Co.,Ltd. FingerPrint
Installed libfprint 1:1.94.3+tod1-0ubuntu2~22.04.01
The fingerprint enrolled successfully from the settings, where previously it was showing an error.

[Vincent Gerris (vgerris)]

I tested :
https://launchpad.net/ubuntu/jammy/amd64/libfprint-2-2/1:1.94.3+tod1-0ubuntu2~22.04.01
with :
libfprint-2-tod1-goodix 0.0.6-0ubuntu1~22.04.1

It works with fprintd-enroll :
ubuntu@ubuntu-inspiron-5482:~$ fprintd-verify
Using device /net/reactivated/Fprint/Device/0
Listing enrolled fingers:
 - #0: right-index-finger
Verify started!
Verifying: right-index-finger
Verify result: verify-match (done)

It does however no work at login. It seems the finger input is automatically entered without a finger being on, so a message comes a few times that the fingerprint login failed.
Not sure if that has to do with this package.

please test that and let me know if more input is needed, ot perhaps a new bug report for login.
thank you

[Francesco (franciccio)]

Tested on Dell Inc. XPS 13 9310 with:

Bus 003 Device 002: ID 27c6:533c Shenzhen Goodix Technology Co.,Ltd. FingerPrint

libfprint-2-2/jammy-proposed,now 1:1.94.3+tod1-0ubuntu2~22.04.01 amd64 [installed]

The fingerprint enrolled successfully both from terminal and from Settings, where previously it was showing an error.

Login to Gnome and `sudo` commands in the terminal work "via fingerprint" as it used to in Ubuntu 21.10.

Thank you!!! \(^-^)/

[Vincent Gerris (vgerris)]

update on failure at login screen. since fprintd-verify and enroll worked, I started to suspect gdm3. I purged and reinstalled it ( don't forget the desktop packages that are shown to be removed).
After that it works as expected, with the mentioned packages by Andy Chi.
Thanks, hope that get released in main soon.

[Launchpad Janitor (janitor)]

This bug was fixed in the package libfprint - 1:1.94.3+tod1-0ubuntu2~22.04.01

---------------
libfprint (1:1.94.3+tod1-0ubuntu2~22.04.01) jammy; urgency=medium

  * debian/patches: Ensure that identify works with old goodix driver
    (LP: #1966911)
  * debian: Update references to jammy branch

 -- Marco Trevisan (Treviño) <email address hidden> Sun, 17 Jul 2022 17:39:59 +0200

[Łukasz Zemczak (sil2100)]

The verification of the Stable Release Update for libfprint has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

[Craig Setera (craigjunk)]

I continue to have issues enrolling fingerprints on my XPS 15 9500 even with these latest changes . I'm happy to try whatever and collect whatever information that I can to help get this working again.

╰─➤ fprintd-enroll
Using device /net/reactivated/Fprint/Device/0
Enrolling right-index-finger finger.
Enroll result: enroll-unknown-error

╰─➤ sudo apt list | grep fprint 1 ↵

WARNING: apt does not have a stable CLI interface. Use with caution in scripts.

fprintd-doc/jammy,jammy 1.94.2-1 all
fprintd/jammy,now 1.94.2-1 amd64 [installed,automatic]
gir1.2-fprint-2.0/jammy-updates,now 1:1.94.3+tod1-0ubuntu2~22.04.01 amd64 [installed,automatic]
libfprint-2-2/jammy-updates,now 1:1.94.3+tod1-0ubuntu2~22.04.01 amd64 [installed,automatic]
libfprint-2-dev/jammy-updates,now 1:1.94.3+tod1-0ubuntu2~22.04.01 amd64 [installed]
libfprint-2-doc/jammy-updates,jammy-updates 1:1.94.3+tod1-0ubuntu2~22.04.01 all
libfprint-2-tod-dev/jammy-updates 1:1.94.3+tod1-0ubuntu2~22.04.01 amd64
libfprint-2-tod1-goodix/now 0.0.6-0ubuntu1~somerville1 amd64 [installed,local]
libfprint-2-tod1/jammy-updates,now 1:1.94.3+tod1-0ubuntu2~22.04.01 amd64 [installed,automatic]
libpam-fprintd/jammy,now 1.94.2-1 amd64 [installed,automatic]

[TF (cactus-online)]

Same at Dell Inc. Latitude 7390 -> no success
---------------------------------------------

freitag_t1@laptop:~$ lsusb
Bus 001 Device 010: ID 0a5c:5834 Broadcom Corp. 5880

freitag_t1@laptop:/etc/apt/sources.list.d$ sudo env G_MESSAGES_DEBUG=all /usr/libexec/fprintd -t
(fprintd:19496): fprintd-DEBUG: 09:50:24.101: About to load configuration file '/etc/fprintd.conf'
(fprintd:19496): fprintd-DEBUG: 09:50:24.101: Launching FprintObject
(fprintd:19496): libfprint-tod-DEBUG: 09:50:24.102: Opening driver /usr/lib/x86_64-linux-gnu/libfprint-2/tod-1/libfprint-tod-goodix-53xc-0.0.6.so
(fprintd:19496): libfprint-tod-DEBUG: 09:50:24.103: Found TOD entry point symbol 0x7fb99f5fb920, GType is 94761596067424
(fprintd:19496): libfprint-tod-DEBUG: 09:50:24.103: Loading driver goodix-tod (Goodix Fingerprint Sensor 53xc)
(fprintd:19496): libfprint-tod-DEBUG: 09:50:24.103: Initializing features for driver goodix-tod
libfprint-tod-Message: 09:50:24.103: Creating TOD wrapper for goodix-tod (Goodix Fingerprint Sensor 53xc) driver
(fprintd:19496): libfprint-tod-DEBUG: 09:50:24.103: Opening driver /usr/lib/x86_64-linux-gnu/libfprint-2/tod-1/libfprint-2-tod-1-broadcom.so
(fprintd:19496): libfprint-tod-DEBUG: 09:50:24.104: Found TOD entry point symbol 0x7fb9968c7d30, GType is 94761596085472
(fprintd:19496): libfprint-tod-DEBUG: 09:50:24.104: Loading driver broadcom (Broadcom Sensors)
(fprintd:19496): libfprint-tod-DEBUG: 09:50:24.104: Initializing features for driver broadcom
(fprintd:19496): fprintd-DEBUG: 09:50:24.119: Preparing devices for resume
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 413C:81B6
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 0BDA:8153
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 0BDA:0413
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 0BDA:0487
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 1D6B:0003
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 045E:0810
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 8087:0A2B
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 0BDA:5650
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 0A5C:5834
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 413C:B06E
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 413C:B06F
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 0BDA:402E
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 24AE:1801
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 0BDA:5413
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 0BDA:2169
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 0BDA:5487
(fprintd:19496): libfprint-context-DEBUG: 09:50:24.119: No driver found for USB device 1D6B:00...

[Andy Chi (andch)]

Hi @TF,
Just noticed that you fingerprint device is Broadcom which is not Goodix. This bug is mainly focus on Goodix fingerprint support.

There is another similar Bug #1956885
Please install the libfprint-tod1-broadcom in the ppa below:
https://launchpad.net/~andch/+archive/ubuntu/staging-fprint

[Jared Johnson (binaryist.com)]

Dell 9315 with
ID 27c6:63ac Shenzhen Goodix Technology Co.,Ltd. Goodix USB2.0 MISC

Does not work with previous troubleshooting steps. Same issue. Add fingerprint, logout, does not recognize fingerprint at login. After logging in with password all fingerprints are missing.

[Andy Chi (andch)]

Hi,
63ac is not supported in this library. 63ac is supported by libfprint-2-2 (1:1.94.3+tod1-0ubuntu2~22.04.04), may I know how many fingers you enrolled before?

[Jared Johnson (binaryist.com)]

Only right index. I just saw another post about adding a second to force
something, am going to try tomorrow.

--
Thanks,

Jared

[Jared Johnson (binaryist.com)]

Thanks for the quick response and information. Adding a second
fingerprint appears to have stabilized things.

--
Thanks,

Jared

[Vincent Gerris (vgerris)]

I have tested this with https://launchpad.net/ubuntu/jammy/amd64/libfprint-2-2/1:1.94.3+tod1-0ubuntu2~22.04.01 and Bus 001 Device 005: ID 27c6:533c Shenzhen Goodix Technology Co.,Ltd. FingerPrint
 and it works great.

Are there any plans to make this part of a main included repo ?
Thank you!

[Andy Chi (andch)]

Hi Vincent,
Yes, the plan is on going, but we'll only put into Jammy main repository.

[Vincent Gerris (vgerris)]

hi Andy, that is great, will it be posted here? For people interested, the message above confirming it works is on a Dell XPS 9500, Dell Precision 5550 and Dell XPS 9700.

Andy, what do you mean with only in Jammy main? As in not in future releases?
Included in main would be great, then it can 'just work' via extra drivers or directly.

I believe I had to wipe the prints specifically for one laptop, but otherwise it just works.

Thank you for the help and your work!

[Andy Chi (andch)]

Hi,
Because the so library is provided by Goodix, and they don't guarantee on newer LTS, which means if the package doesn't work on Noble, there is nothing we can do to fix it.