Debian Codegraph @

data/pam_fprintd.pod

raw
1 =head1 NAME
2
3 pam_fprintd - PAM module to authenticate against fprintd, the fingerprint daemon
4
5 =head1 SYNOPSIS
6
7 B<pam_fprintd.so> [debug|debug=[I<on>|I<off>|I<true>|I<false>|I<1>|I<0>]] [max-tries=I<MAX_TRIES>] [timeout=I<TIMEOUT>]
8
9 =head1 DESCRIPTION
10
11 The pam_fprintd module is used to verify a user's fingerprints against fingerprints
12 enrolled using fprintd, the fingerprint management daemon.
13
14 =head1 OPTIONS
15
16 =over 8
17
18 =item B<debug>
19
20 =item B<debug=[I<on>|I<off>|I<true>|I<false>|I<1>|I<0>]>
21
22 Whether debug should be turned on or off. Debug messages will be generated using
23 pam_syslog which means that they will be saved in the systemd journal by default.
24
25 =item B<max-tries=I<MAX_TRIES>>
26
27 The number of attempts at fingerprint authentication to try before returning an
28 authentication failure. The minimum number of tries is 1 while the default is 3.
29
30 Use a negative value to set no limit at all, so that the module won't ever error on multiple
31 retries, but in such case it's suggested for the module loader to handle this.
32
33 =item B<timeout=I<TIMEOUT>>
34
35 The amount of time before returning an authentication failure. The default timeout
36 is 30 seconds, with 1 second being the minimum.
37
38 Use a negative value to set no limit at all, so that fingerprint authentication will
39 be always active while this module is loaded.
40
41 =back
42
43 =head1 LIMITATIONS
44
45 =over 8
46
47 =back
48
49 The PAM stack is by design a serialised authentication, so it is not
50 possible for pam_fprintd to allow authentication through passwords and
51 fingerprints at the same time.
52
53 It is up to the application using the PAM services to implement separate
54 PAM processes and run separate authentication stacks separately. This
55 is the way multiple authentication methods are made available to users
56 of gdm for example.
57
58 =head1 AUTHOR
59
60 B<fprintd> was written by Bastien Nocera.
61
62 =head1 SEE ALSO
63
64 =over 8
65
66 =item B<fprintd>, B<PAM>
67
68 =back
69