[TRACKING] Fingerprint scanner compatibility with linux (ubuntu, fedora, etc)

Henry_Luengas · September 30, 2021, 5:16pm

I’m trying to replicate your process on Pop but I’m running into some problems, (I’ve never built a deb before).

I’ve tried v1.92.1 and v1.94.1, getting the same problem with both.

First difference is the name of deb source:
apt source --download-only libfprint
yields the file:
libfprint_1.90.7+git20210222+tod1-0ubuntu2.debian.tar.xz

Next difference, the following section doesn’t exist in the rules file:

We’ll also need to comment out the lines for moving around the autosuspend files (as far as I can tell they’re only needed for the ELAN driver)

Here is my resulting rules file:

#!/usr/bin/make -f

export DEB_BUILD_MAINT_OPTIONS = optimize=-lto

export DPKG_GENSYMBOLS_CHECK_LEVEL = 2

BUILDDIR = $(CURDIR)/obj-$(DEB_HOST_GNU_TYPE)

# Configuration arguments
CONFIG_ARGS = \
	-Dudev_hwdb_dir=/lib/udev/hwdb.d \
	-Ddrivers=goodixmoc \
	-Dgtk-examples=false

%:
	dh $@ --with gir

override_dh_auto_configure:
	dh_auto_configure -- $(CONFIG_ARGS)

override_dh_auto_test:
	dh_auto_test -- -C $(BUILDDIR) --timeout-multiplier 5

Another Difference is that /debian already has the .symbols file you provide, I tried it with your and the original one.

Final Difference is the libfprint-2-2.install file already uses hwdb.d instead of rules.d, it also has a [0-9] regex isntead of *, but i tried it both ways:

Next up, we need to modify debian/libfprint-2-2.install to install hwdb.d and not rules.d

Here’s my libfprint-2-2.install:

lib/udev/hwdb.d/
usr/lib/${DEB_HOST_MULTIARCH}/libfprint-[0-9].so.*

The package build seems to get pretty far but errors out on line 16 of debian/rules. Here’s the end of the output:

   dh_install
dh_install: warning: Cannot find (any matches for) "usr/lib/x86_64-linux-gnu/libfprint-[0-9]-tod.so.*" (tried in ., debian/tmp)

dh_install: warning: libfprint-2-2 missing files: usr/lib/x86_64-linux-gnu/libfprint-[0-9]-tod.so.*
dh_install: warning: Cannot find (any matches for) "usr/lib/x86_64-linux-gnu/libfprint-[0-9]-tod.so.*" (tried in ., debian/tmp)

dh_install: warning: libfprint-2-tod1 missing files: usr/lib/x86_64-linux-gnu/libfprint-[0-9]-tod.so.*
dh_install: warning: Cannot find (any matches for) "usr/include/libfprint-[0-9]/tod-[0-9]/*" (tried in ., debian/tmp)

dh_install: warning: libfprint-2-tod-dev missing files: usr/include/libfprint-[0-9]/tod-[0-9]/*
dh_install: warning: Cannot find (any matches for) "usr/lib/x86_64-linux-gnu/libfprint-[0-9]-tod.so" (tried in ., debian/tmp)

dh_install: warning: libfprint-2-tod-dev missing files: usr/lib/x86_64-linux-gnu/libfprint-[0-9]-tod.so
dh_install: warning: Cannot find (any matches for) "usr/lib/x86_64-linux-gnu/pkgconfig/libfprint-[0-9]-tod-[0-9].pc" (tried in ., debian/tmp)

dh_install: warning: libfprint-2-tod-dev missing files: usr/lib/x86_64-linux-gnu/pkgconfig/libfprint-[0-9]-tod-[0-9].pc
dh_install: error: missing files, aborting
make: *** [debian/rules:16: binary] Error 255
dpkg-buildpackage: error: debian/rules binary subprocess returned exit status 2

debian/usr/lib/x86_64-linux-gnu/ has the following files after the error:

setebos@setebos ~/D/f/libfprint ((v1.94.1))> ls -la debian/tmp/usr/lib/x86_64-linux-gnu/
total 1288
drwxr-xr-x 1 root root     150 Sep 30 11:48 ./
drwxr-xr-x 1 root root      32 Sep 30 11:48 ../
drwxr-xr-x 1 root root      36 Sep 30 11:48 girepository-1.0/
lrwxrwxrwx 1 root root      16 Sep 30 11:48 libfprint-2.so -> libfprint-2.so.2*
lrwxrwxrwx 1 root root      20 Sep 30 11:48 libfprint-2.so.2 -> libfprint-2.so.2.0.0*
-rwxr-xr-x 1 root root 1307544 Sep 30 11:48 libfprint-2.so.2.0.0*
drwxr-xr-x 1 root root      28 Sep 30 11:48 pkgconfig/

Your framework page was great, I hope you can provide some insight into this .deb build issue!

Reese_Borel · September 30, 2021, 5:18pm

@Henry_Luengas I’m trying on Kubuntu 21 and running into the exact same error(s).

Henry_Luengas · September 30, 2021, 5:20pm

Must have something to do with libfprint-2-tod. I’m going to investigate that.

Henry_Luengas · September 30, 2021, 6:13pm

@Reese_Borel @Brett_Kosinski Downloading the actual package source that you used on debian did the trick, the ubuntu repositories have some different one that I believe is a fork or something.

libfprint_1.90.7-2.debian.tar.xz

After that your instructions applied much more directly, except neither the original symbols file nor the one you provided worked for v1.94.1

dpkg-gensymbols: error: some new symbols appeared in the symbols file: see diff output below
dpkg-gensymbols: warning: debian/libfprint-2-2/DEBIAN/symbols doesn't match completely debian/libfprint-2-2.symbols

So I copied the contents of debian/libfprint-2-2/DEBIAN/symbols to debian/libfprint-2-2.symbols and then it worked like a charm!

Brett_Kosinski · September 30, 2021, 6:51pm

Yeah that’s no surprise. The symbols change from version to version. Nice job getting it working!

Henry_Luengas · September 30, 2021, 7:28pm

Final Guide for v1.94.1 on Ubuntu/Pop!_OS

All credit to @Brett_Kosinski’s original guide.

libfprint 1.94.1

To begin, create a working directory and download the Debian package source, the libfprint source, and associated build dependencies:

mkdir build_dir
cd build_dir
curl -O https://deb.debian.org/debian/pool/main/libf/libfprint/libfprint_1.90.7-2.debian.tar.xz
sudo apt build-dep libfprint
sudo apt-get install libgudev-1.0-dev
git clone https://github.com/freedesktop/libfprint.git

Now, we’ll jump into the libfprint repository, check out the 1.94.1 tag, and unpack the debian control files:

cd libfprint
git checkout v1.94.1
tar -xJvf ../libfprint_1.90.7-2.debian.tar.xz

To begin, we need to make some changes to the ./debian/rules file. First, we’ll update the rules to only build the driver we need:

CONFIG_ARGS = \
    -Dudev_rules_dir=/lib/udev/rules.d \
    -Dgtk-examples=false \
    -Ddrivers=goodixmoc

We’ll also need to comment out the lines for moving around the autosuspend files (as far as I can tell they’re only needed for the ELAN driver):

override_dh_install:
#	mv debian/tmp/lib/udev/rules.d/60-libfprint-2-autosuspend.rules \
#		debian/tmp/lib/udev/rules.d/60-libfprint-2.rules

Next up, we need to modify ./debian/libfprint-2-2.install to install hwdb.d and not rules.d:

lib/udev/hwdb.d/
usr/lib/${DEB_HOST_MULTIARCH}/libfprint-*.so.*

Next, we’ll update ./debian/changelog to add an entry for our version at the top of the file, you can add your own info:

libfprint (1:1.94.1-1) unstable; urgency=medium

  * custom build for use on my Framework laptop

 -- Brett Kosinski (brettk) <email>  Fri, 6 Sep 2021 20:05:00 -0700

Build the package, it will fail:

sudo dpkg-buildpackage -b -uc -us

dpkg-gensymbols: error: some new symbols appeared in the symbols file: see diff output below
dpkg-gensymbols: warning: debian/libfprint-2-2/DEBIAN/symbols doesn't match completely debian/libfprint-2-2.symbols

Fix this error by copying the symbols file it is comparing against:

cp ./debian/libfprint-2-2/DEBIAN/symbols ./debian/libfprint-2-2.symbols

Build again and it should work this time, producing 4 .deb files in the parent directory:

sudo dpkg-buildpackage -b -uc -us

Install these with dpkg:

sudo dpkg -i ../*.deb

You can remove all the files now and uninstall the build dependencies if desired.

frpintd 1.94.0

While getting libfprint built was a bit of a pain, fprintd is much simpler. The first essential steps are the same (starting in some build directory):

mkdir build_dir
cd build_dir
apt source --download-only fprintd
sudo apt build-dep fprintd
git clone https://github.com/freedesktop/libfprint-fprintd.git 
cd libfprint-fprintd
git checkout v1.94.0
tar -xJvf ../fprintd_1.90.9-1.debian.tar.xz

Edit ./debian/rules to overide a check for dependency information. Add these lines to the end and make sure a tab is used rather than spaces for the spacing on the last line:

    override_dh_shlibdeps:
    	dh_shlibdeps --dpkg-shlibdeps-params=--ignore-missing-info

Edit ./debian/changelog to create a new entry for our version, you can add your own info:

fprintd (1:1.94.0-1) unstable; urgency=medium

  * custom build for use on my Framework laptop

 -- Brett Kosinski (brettk) <email>  Fri, 6 Sep 2021 20:05:00 -0700

Then build the package!

sudo dpkg-buildpackage -b -uc -us

Install the created .deb files:

sudo dpkg -i ../*.deb

Enable and start the service:

sudo systemctl enable fprintd.service
sudo systemctl start fprintd.service

Activate the PAM module.

sudo pam-auth-update --enable fprintd

You can remove all the files now and uninstall the build dependencies if desired.

Enrolling Fingerprints

Setting up fingerprints

At this point, if all went well, assuming you’re using Gnome you can enroll a new set of fingerprints:

Hit the Windows key, type “Users”, and open the settings panel
Select “Fingerprint login”
Enroll fingerprints

Voila! At this point all of the hardware on your laptop should be functioning.

It’s really not a hard process, but here’s a dumb script that should get the job done. It’s not smart enough to edit the files, so it just deletes them and pulls edited copies from my webserver. This is very unsafe so if you can’t read and understand this script (also verify any files it downloads) you should NOT be running it!

ubuntu_libfprint_v1.94.1_install.sh

bash ubuntu_libfprint_v1.94.1_install.sh

(Tested on Pop!_OS, but i think it should work fine on Ubuntu)

dkc · October 2, 2021, 3:36am

So this is my first time using linux. Im using PopOS and was relived to see this guide was specifically for it but after installing some of the packages I noticed that I have to go in and edit files.

My terminal commands knowledge especially on Linux is very basic and Im not willing to go down a stack overflow rabbit hole just to get the fingerprint scanner to work. So I tried the script and that didn’t work either.

Somebody please tell me there is an easier way to get this damn thing to work. Im willing to install some shit using the terminal and that’s about as far as Im willing to go to get this to work.

Maybe theres another distro that this just works out of the box?

Shaun_Kingston · October 2, 2021, 3:38am

My experience with the Fedora 34 respin is that it just works out of the box.

Water261 · October 2, 2021, 3:51am

If you’re only willing to install packages then you won’t get the fingerprint sensor working, as from the Ubuntu 21.04 thread:

Ubuntu 21.10 may have libfprint >1.92.0 but I’m unable to check. Otherwise Fedora 34 Respin or Fedora 35 (When it releases later this month) will work fine.

dkc · October 2, 2021, 3:56am

@Water261 ok thanks for clarifying. The scanner not working isn’t a deal breaker for me right now, Im sure someone will eventually figure out how to make it easier in the next few weeks/months. Im not even sure if Im set on using Linux anyway and might just end up going back to Windows.

Bradley_Bratten · October 2, 2021, 11:14am

So question, following a earlier guide I got it to work but it only works for log on, reported I could also use the scanner for sudo authentication as well? How do I enable this if possible?

Carlos_Fernandez_San · October 2, 2021, 4:51pm

@dkc I can send you my generated .deb files if you want them, so you just need to install them (I just followed the guides and corrected a few minor problems along hte way).

Of course that means you’re trusting an stranger on the internet But if you’re willing to do that (not that we check everything we download anyway), it can save you some headache.

Note though that generally speaking - brand new hardware + linux always means some tinkering required if you want everything to work well. But I’m sure you know that already.

dkc · October 2, 2021, 5:57pm

@Carlos_Fernandez_San Yeah that would be very helpful, thank you!

Henry_Luengas · October 3, 2021, 2:05am

Here’s a script that just downloads the deb files and installs them, honestly idk why I didn’t do that in the first place:
libfprint_v1.94.1_install_v2.sh

Run with:
bash ./libfprint_v1.94.1_install_v2.sh

As before, this is very insecure and you shouldn’t trust random strangers on the internet. So if you want to do it yourself, all the steps are in this post above.

Carlos_Fernandez_San · October 3, 2021, 3:01am

@dkc Here you go

SeaMonkey · October 3, 2021, 3:07am

@Henry_Luengas Thanks so much for the guide! I am using Linux Mint 20.2 with Cinnamon. A couple of notes for anyone else doing the same:

sudo apt build-dep doesn’t work, but the build process will tell you which dependencies are missing. Manually install them with sudo apt install. debhelper-compat does not exist because it is provided by debhelper. After you’ve installed all the other dependencies, as well as making the other necessary modifications in the guide, append -d to the build command to force it to ignore the lack of debhelper-compat.

apt-source --download-only fprintd fails to locate a source package. Use curl -O http://ftp.debian.org/debian/pool/main/f/fprintd/fprintd_1.90.9-1.debian.tar.xz instead.

The Cinnamon user configuration doesn’t have fingerprint configuration in the GUI, but you can configure it from the CLI.
fprintd-enroll -f right-thumb (or right/left index,middle,ring,little finger). Note that it will take many passes to complete, so don’t worry when you see a lot of remove-and-retry messages.
Then
sudo pam-auth-update and ensure that the Fingerprint option is selected.

Adrian_Sanabria · October 4, 2021, 10:54pm

No, @Alfonso_Lopez I don’t recall having to do anything extra to get fingerprint login working for sudo or for 1Password. I believe I downloaded directly from 1password.com: Best Password Manager for Linux | 1Password

DylanCM · October 6, 2021, 7:26pm

I’m also having the “can’t enroll in Linux anymore after doing the ‘windows fix’” issue.

These were the steps I took:

Installed Manjaro and enrolled right-index
Reinstalled Manjaro and wasn’t able to enroll right-index again, but other fingers worked
Installed Win10 and removed the WinBioDatabase (via Fingerprint enrollment)
Installed dual boot Manjaro and started getting the errors noted above when trying to enroll for any finger

I’ve reinstalled windows all on it’s own and fingerprint enrollment/use works just fine. I’ve reinstalled just Manjaro and the errors persist. I’ve run the python script and gotten the errors mentioned above. I’ve pulled the script apart and tried various other methods on the FPrint device. I’ve tried from a live USB.

I’m at the point where I’ve been trying to find a datasheet for the Goodix fingerprint scanner to see if I can take it apart and wipe it’s memory somehow. Unfortunately, something I read somewhere implied that the firmware is stored in the same place… so that might just brick the chip.

It seems pretty likely that this is a gap in libfprint/fprintd since Win10 continues to function fine. Unfortunately I don’t have the time to dig into that code and figure out how it differs from the Win driver.

Atul_Ingle · October 6, 2021, 8:23pm

@DylanCM Ditto. I’ve given up on this and just waiting for a major update to libfprint that hopefully fixes this issue. I’m also considering buying a new fingerprint reader once the Framework marketplace opens.

Henry_Luengas · October 7, 2021, 11:49pm

Sorry to hear you guys can’t get your fingerprint readers working. In case anybody else comes here wondering what python script you are refering to, it deletes fingerprints held in the device’s memory but that weren’t registered on the current OS.

Here is a version I modified to require root privaleges, and only list the fingerprints if not given a -d flag:
libfprint_delete_device_prints.py

To list the prints run:
sudo python3 libfprint_delete_device_prints.py

To delete them all run:
sudo python3 libfprint_delete_device_prints.py -d