1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
'\" t
.\" Title: pam_faillock
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 09/03/2021
.\" Manual: Linux-PAM Manual
.\" Source: Linux-PAM Manual
.\" Language: English
.\"
.TH "PAM_FAILLOCK" "8" "09/03/2021" "Linux-PAM Manual" "Linux\-PAM Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pam_faillock \- Module counting authentication failures during a specified interval
.SH "SYNOPSIS"
.HP \w'\fBauth\ \&.\&.\&.\ pam_faillock\&.so\fR\ 'u
\fBauth \&.\&.\&. pam_faillock\&.so\fR {preauth|authfail|authsucc} [conf=\fI/path/to/config\-file\fR] [dir=\fI/path/to/tally\-directory\fR] [even_deny_root] [deny=\fIn\fR] [fail_interval=\fIn\fR] [unlock_time=\fIn\fR] [root_unlock_time=\fIn\fR] [admin_group=\fIname\fR] [audit] [silent] [no_log_info]
.HP \w'\fBaccount\ \&.\&.\&.\ pam_faillock\&.so\fR\ 'u
\fBaccount \&.\&.\&. pam_faillock\&.so\fR [dir=\fI/path/to/tally\-directory\fR] [no_log_info]
.SH "DESCRIPTION"
.PP
This module maintains a list of failed authentication attempts per user during a specified interval and locks the account in case there were more than
\fIdeny\fR
consecutive failed authentications\&.
.PP
Normally, failed attempts to authenticate
\fIroot\fR
will
\fBnot\fR
cause the root account to become blocked, to prevent denial\-of\-service: if your users aren\*(Aqt given shell accounts and root may only login via
\fBsu\fR
or at the machine console (not telnet/rsh, etc), this is safe\&.
.SH "OPTIONS"
.PP
\fB{preauth|authfail|authsucc}\fR
.RS 4
This argument must be set accordingly to the position of this module instance in the PAM stack\&.
.sp
The
\fIpreauth\fR
argument must be used when the module is called before the modules which ask for the user credentials such as the password\&. The module just examines whether the user should be blocked from accessing the service in case there were anomalous number of failed consecutive authentication attempts recently\&. This call is optional if
\fIauthsucc\fR
is used\&.
.sp
The
\fIauthfail\fR
argument must be used when the module is called after the modules which determine the authentication outcome, failed\&. Unless the user is already blocked due to previous authentication failures, the module will record the failure into the appropriate user tally file\&.
.sp
The
\fIauthsucc\fR
argument must be used when the module is called after the modules which determine the authentication outcome, succeeded\&. Unless the user is already blocked due to previous authentication failures, the module will then clear the record of the failures in the respective user tally file\&. Otherwise it will return authentication error\&. If this call is not done, the pam_faillock will not distinguish between consecutive and non\-consecutive failed authentication attempts\&. The
\fIpreauth\fR
call must be used in such case\&. Due to complications in the way the PAM stack can be configured it is also possible to call
\fIpam_faillock\fR
as an account module\&. In such configuration the module must be also called in the
\fIpreauth\fR
stage\&.
.RE
.PP
\fBconf=/path/to/config\-file\fR
.RS 4
Use another configuration file instead of the default
/etc/security/faillock\&.conf\&.
.RE
.PP
The options for configuring the module behavior are described in the
\fBfaillock.conf\fR(5)
manual page\&. The options specified on the module command line override the values from the configuration file\&.
.SH "MODULE TYPES PROVIDED"
.PP
The
\fBauth\fR
and
\fBaccount\fR
module types are provided\&.
.SH "RETURN VALUES"
.PP
PAM_AUTH_ERR
.RS 4
An invalid option was given, the module was not able to retrieve the user name, no valid counter file was found, or too many failed logins\&.
.RE
.PP
PAM_BUF_ERR
.RS 4
Memory buffer error\&.
.RE
.PP
PAM_CONV_ERR
.RS 4
The conversation method supplied by the application failed to obtain the username\&.
.RE
.PP
PAM_INCOMPLETE
.RS 4
The conversation method supplied by the application returned PAM_CONV_AGAIN\&.
.RE
.PP
PAM_SUCCESS
.RS 4
Everything was successful\&.
.RE
.PP
PAM_IGNORE
.RS 4
User not present in passwd database\&.
.RE
.SH "NOTES"
.PP
Configuring options on the module command line is not recommend\&. The
/etc/security/faillock\&.conf
should be used instead\&.
.PP
The setup of
\fIpam_faillock\fR
in the PAM stack is different from the
\fIpam_tally2\fR
module setup\&.
.PP
Individual files with the failure records are created as owned by the user\&. This allows
\fBpam_faillock\&.so\fR
module to work correctly when it is called from a screensaver\&.
.PP
Note that using the module in
\fBpreauth\fR
without the
\fBsilent\fR
option specified in
/etc/security/faillock\&.conf
or with
\fIrequisite\fR
control field leaks an information about existence or non\-existence of a user account in the system because the failures are not recorded for the unknown users\&. The message about the user account being locked is never displayed for non\-existing user accounts allowing the adversary to infer that a particular account is not existing on a system\&.
.SH "EXAMPLES"
.PP
Here are two possible configuration examples for
/etc/pam\&.d/login\&. They make
\fIpam_faillock\fR
to lock the account after 4 consecutive failed logins during the default interval of 15 minutes\&. Root account will be locked as well\&. The accounts will be automatically unlocked after 20 minutes\&.
.PP
In the first example the module is called only in the
\fIauth\fR
phase and the module does not print any information about the account being blocked by
\fIpam_faillock\fR\&. The
\fIpreauth\fR
call can be added to tell users that their logins are blocked by the module and also to abort the authentication without even asking for password in such case\&.
.PP
/etc/security/faillock\&.conf
file example:
.sp
.if n \{\
.RS 4
.\}
.nf
deny=4
unlock_time=1200
silent
.fi
.if n \{\
.RE
.\}
.PP
/etc/pam\&.d/config file example:
.sp
.if n \{\
.RS 4
.\}
.nf
auth required pam_securetty\&.so
auth required pam_env\&.so
auth required pam_nologin\&.so
# optionally call: auth requisite pam_faillock\&.so preauth
# to display the message about account being locked
auth [success=1 default=bad] pam_unix\&.so
auth [default=die] pam_faillock\&.so authfail
auth sufficient pam_faillock\&.so authsucc
auth required pam_deny\&.so
account required pam_unix\&.so
password required pam_unix\&.so shadow
session required pam_selinux\&.so close
session required pam_loginuid\&.so
session required pam_unix\&.so
session required pam_selinux\&.so open
.fi
.if n \{\
.RE
.\}
.PP
In the second example the module is called both in the
\fIauth\fR
and
\fIaccount\fR
phases and the module informs the authenticating user when the account is locked if
\fBsilent\fR
option is not specified in the
faillock\&.conf\&.
.sp
.if n \{\
.RS 4
.\}
.nf
auth required pam_securetty\&.so
auth required pam_env\&.so
auth required pam_nologin\&.so
auth required pam_faillock\&.so preauth
# optionally use requisite above if you do not want to prompt for the password
# on locked accounts
auth sufficient pam_unix\&.so
auth [default=die] pam_faillock\&.so authfail
auth required pam_deny\&.so
account required pam_faillock\&.so
# if you drop the above call to pam_faillock\&.so the lock will be done also
# on non\-consecutive authentication failures
account required pam_unix\&.so
password required pam_unix\&.so shadow
session required pam_selinux\&.so close
session required pam_loginuid\&.so
session required pam_unix\&.so
session required pam_selinux\&.so open
.fi
.if n \{\
.RE
.\}
.SH "FILES"
.PP
/var/run/faillock/*
.RS 4
the files logging the authentication failures for users
.RE
.PP
/etc/security/faillock\&.conf
.RS 4
the config file for pam_faillock options
.RE
.SH "SEE ALSO"
.PP
\fBfaillock\fR(8),
\fBfaillock.conf\fR(5),
\fBpam.conf\fR(5),
\fBpam.d\fR(5),
\fBpam\fR(8)
.SH "AUTHOR"
.PP
pam_faillock was written by Tomas Mraz\&.
|
