2
===============================================================================
4
ThinkFinger is a driver for the UPEK/SGS Thomson Microelectronics fingerprint
5
reader (USB ID 0483:2016). The device is being found either as a standalone
6
USB device, built into USB keyboards or built into laptops. The following
7
laptop vendors are using the device:
13
Toshiba is shipping their laptops either with the UPEK/SGS Thomson Micro-
14
electronics fingerprint reader or with a fingerprint reader built by AuthenTec.
15
The AuthenTec fingerprint reader is *not* supported by ThinkFinger.
17
SONY laptops with the UPEK/SGS Thomson Microelectronics fingerprint
18
reader are not supported.
20
ThinkFinger is devided into two parts: libthinkfinger and pam_thinkfinger.
22
libthinkfinger is a library to be used in order to communicate with the finger-
25
The utility 'tf-tool' can be used to acquire and to verify fingerprints.
27
Installation Instructions
28
=========================
30
Please check the INSTALL file.
32
Simple Test Tool: tf-tool
33
=========================
35
Usage: tf-tool [--acquire | --verify | --add-user <login> ] [--verbose]
37
To acquire a fingerprint run 'tf-tool --acquire'. You will be prompted to
38
swipe your finger. It needs three successful swipes to get a fingerprint.
39
This fingerprint is being stored in '/tmp/test.bir'.
41
To verify a fingerprint run 'tf-tool --verify'. tf-tool will read a finger-
42
print image from '/tmp/test.bir' and compare that with the finger which
47
It is likely that you have to run 'tf-tool' as root as it needs to access the
48
USB device. On most distribution the device node can not be accessed by a
51
The switch '--add-user' is only available if ThinkFinger was built with PAM
54
Pluggable Authentication Module: pam_thinkfinger
55
================================================
57
The pluggable authentication module pam_thinkfinger can be used for PAM (e.g.
58
to log into your system). The module needs to be copied to the location
59
where PAM expects the modules to reside. On most GNU/Linux distributions
60
PAM modules are stored in '/lib/security'.
62
Also, the PAM module requires uinput. For further details, please read section
63
"Kernel Requirements" of the installation instructions provided by the file
66
In order to use pam_thinkfinger, PAM needs to be aware of the module. To
67
achieve this please edit '/etc/pam.d/common-auth'. You are required to add
68
the following directive before any pam_unix or pam_unix2 directives:
70
auth sufficient pam_thinkfinger.so
72
See [1] for a complete example how '/etc/pam.d/common-auth' looks like.
74
The module does only trigger for users which have deposited their fingerprint
75
in '/etc/pam_thinkfinger/'.
77
E.g. if the user 'bob' wants to login using his fingerprint, his fingerprint
78
needs to be stored at '/etc/pam_thinkfinger/bob.bir'. See [2] for a more
83
If your PAM uses the pam_unix module, you need to pass a specific argument in
84
the /etc/pam.d/common-auth directive:
86
auth required pam_unix.so try_first_pass
88
Otherwise, the password entered at the pam_thinkfinger prompt is not considered
89
by pam_unix. This is only the case for pam_unix, because pam_unix2
90
automatically enables the try_first_pass argument by default. More information
91
are available in the Linux-PAM documentation at:
93
http://www.kernel.org/pub/linux/libs/pam/Linux-PAM-html/sag-pam_unix.html
95
If you have troubles using the PAM module you may want to pass the 'debug'
98
auth required pam_unix.so debug
100
With this option the PAM module will be verbose and use syslog(3) for debug
106
The pluggable authentication module pam_thinkfinger should work with all
107
PAM aware applications.
112
Timo Hoenig <thoenig@suse.de>, <thoenig@nouse.net>
113
Pavel Machek <pavel@suse.cz>
118
Wolfgang Hafenscher <wolfgang@hafenscher.net> (project page)
119
Luca Capello <luca@pca.it> (patches, man pages)
120
Stephan Berberig <s.berberig@arcor.de> (patches)
121
Evgeni Golov <sargentd@die-welt.net>
123
Also, to big thanks to everyone else involved with the project by testing,
124
reporting bugs and communicating on thinkfinger-devel.
129
* http://thinkfinger.sourceforge.net
134
* svn co https://svn.sourceforge.net/svnroot/thinkfinger
139
* https://lists.sourceforge.net/lists/listinfo/thinkfinger-devel
141
[1] Example for a ThinkFinger-enabled '/etc/pam.d/common-auth'
145
auth required pam_env.so
146
auth sufficient pam_thinkfinger.so
147
auth required pam_unix2.so
149
[2] Example how to store a fingerprint image for user 'bob'
151
root@host~> tf-tool --add-user bob
153
( Now user 'bob' has to swipe his finger three times )
155
@PACKAGE_STRING@ (@PACKAGE_BUGREPORT@)
156
Copyright (C) 2006, 2007 Timo Hoenig <thoenig@suse.de>
158
Initializing... done.
159
Please swipe your finger (successful swipes 3/3, failed swipes: 0)... done.
160
Storing data (/etc/pam_thinkfinger/bob)... done.
162
Now 'bob' can authenticate himself by swiping his finger.