Debian Codegraph @

upstream/debian-unstable/man8/faillock.8

raw
1 '\" t
2 .\" Title: faillock
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "FAILLOCK" "8" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 faillock \- Tool for displaying and modifying the authentication failure record files
32 .SH "SYNOPSIS"
33 .HP \w'\fBfaillock\fR\ 'u
34 \fBfaillock\fR [\-\-dir\ \fI/path/to/tally\-directory\fR] [\-\-user\ \fIusername\fR] [\-\-reset]
35 .SH "DESCRIPTION"
36 .PP
37 The
38 \fIpam_faillock\&.so\fR
39 module maintains a list of failed authentication attempts per user during a specified interval and locks the account in case there were more than
40 \fIdeny\fR
41 consecutive failed authentications\&. It stores the failure records into per\-user files in the tally directory\&.
42 .PP
43 The
44 \fBfaillock\fR
45 command is an application which can be used to examine and modify the contents of the tally files\&. It can display the recent failed authentication attempts of the
46 \fIusername\fR
47 or clear the tally files of all or individual
48 \fIusernames\fR\&.
49 .SH "OPTIONS"
50 .PP
51 \-\-conf /path/to/config\-file
52 .RS 4
53 The file where the configuration is located\&. The default is
54 /etc/security/faillock\&.conf\&.
55 .RE
56 .PP
57 \-\-dir /path/to/tally\-directory
58 .RS 4
59 The directory where the user files with the failure records are kept\&.
60 .sp
61 The priority to set this option is to use the value provided from the command line\&. If this isn\*(Aqt provided, then the value from the configuration file is used\&. Finally, if neither of them has been provided, then
62 /var/run/faillock
63 is used\&.
64 .RE
65 .PP
66 \-\-user username
67 .RS 4
68 The user whose failure records should be displayed or cleared\&.
69 .RE
70 .PP
71 \-\-reset
72 .RS 4
73 Instead of displaying the user\*(Aqs failure records, clear them\&.
74 .RE
75 .SH "FILES"
76 .PP
77 /var/run/faillock/*
78 .RS 4
79 the files logging the authentication failures for users
80 .RE
81 .SH "SEE ALSO"
82 .PP
83 \fBpam_faillock\fR(8),
84 \fBpam\fR(8)
85 .SH "AUTHOR"
86 .PP
87 faillock was written by Tomas Mraz\&.