-
Notifications
You must be signed in to change notification settings - Fork 223
/
faillog.8.xml
242 lines (235 loc) · 7.38 KB
/
faillog.8.xml
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
<?xml version="1.0" encoding="UTF-8"?>
<!--
SPDX-FileCopyrightText: 1989 - 1994, Julianne Frances Haugh
SPDX-FileCopyrightText: 2007 - 2011, Nicolas François
SPDX-License-Identifier: BSD-3-Clause
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
"http:https://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!-- SHADOW-CONFIG-HERE -->
]>
<refentry id='faillog.8'>
<!-- $Id$ -->
<refentryinfo>
<author>
<firstname>Julianne Frances</firstname>
<surname>Haugh</surname>
<contrib>Creation, 1989</contrib>
</author>
<author>
<firstname>Thomas</firstname>
<surname>Kłoczko</surname>
<email>[email protected]</email>
<contrib>shadow-utils maintainer, 2000 - 2007</contrib>
</author>
<author>
<firstname>Nicolas</firstname>
<surname>François</surname>
<email>[email protected]</email>
<contrib>shadow-utils maintainer, 2007 - now</contrib>
</author>
</refentryinfo>
<refmeta>
<refentrytitle>faillog</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="sectdesc">System Management Commands</refmiscinfo>
<refmiscinfo class="source">shadow-utils</refmiscinfo>
<refmiscinfo class="version">&SHADOW_UTILS_VERSION;</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>faillog</refname>
<refpurpose>display faillog records or set login failure limits</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>faillog</command>
<arg choice='opt'>
<replaceable>options</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
<command>faillog</command> displays the contents of the failure log
database (<filename>/var/log/faillog</filename>). It can also
set the failure counters and limits. When
<command>faillog</command> is run without arguments, it only displays the
faillog records of the users who had a login failure.
</para>
</refsect1>
<refsect1 id='options'>
<title>OPTIONS</title>
<para>
The options which apply to the <command>faillog</command> command
are:
</para>
<variablelist remap='IP'>
<varlistentry>
<term><option>-a</option>, <option>--all</option></term>
<listitem>
<para>
Display (or act on) faillog records for all users having an
entry in the <filename>faillog</filename> database.
</para>
<para>
The range of users can be restricted with the
<option>-u</option> option.
</para>
<para>
In display mode, this is still restricted to existing users
but forces the display of the faillog entries even if they
are empty.
</para>
<para>
With the <option>-l</option>, <option>-m</option>,
<option>-r</option>, <option>-t</option> options, the users'
records are changed, even if the user does not exist on the
system. This is useful to reset records of users that have
been deleted or to set a policy in advance for a range of
users.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>, <option>--help</option></term>
<listitem>
<para>Display help message and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-l</option>, <option>--lock-secs</option> <replaceable>SEC</replaceable>
</term>
<listitem>
<para>
Lock account for <replaceable>SEC</replaceable>
seconds after failed login.
</para>
<para>
Write access to <filename>/var/log/faillog</filename>
is required for this option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-m</option>, <option>--maximum</option> <replaceable>MAX</replaceable>
</term>
<listitem>
<para>
Set the maximum number of login failures after the account is
disabled to <replaceable>MAX</replaceable>.
</para>
<para>
Selecting a
<replaceable>MAX</replaceable> value of 0 has the effect of not
placing a limit on the number of failed logins.
</para>
<para>
The maximum
failure count should always be 0 for <emphasis>root</emphasis>
to prevent a denial of services attack against the system.
</para>
<para>
Write access to <filename>/var/log/faillog</filename>
is required for this option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option>, <option>--reset</option></term>
<listitem>
<para>
Reset the counters of login failures.
</para>
<para>
Write access to <filename>/var/log/faillog</filename>
is required for this option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-R</option>, <option>--root</option> <replaceable>CHROOT_DIR</replaceable>
</term>
<listitem>
<para>
Apply changes in the <replaceable>CHROOT_DIR</replaceable>
directory and use the configuration files from the
<replaceable>CHROOT_DIR</replaceable> directory.
Only absolute paths are supported.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option>, <option>--time</option> <replaceable>DAYS</replaceable>
</term>
<listitem>
<para>
Display faillog records more recent than
<replaceable>DAYS</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-u</option>, <option>--user</option> <replaceable>LOGIN</replaceable>|<replaceable>RANGE</replaceable>
</term>
<listitem>
<para>
Display faillog record or maintains failure counters and limits
(if used with <option>-l</option>, <option>-m</option> or
<option>-r</option> options) only for the specified user(s).
</para>
<para>
The users can be specified by a login name, a numerical user
ID, or a <replaceable>RANGE</replaceable> of users. This
<replaceable>RANGE</replaceable> of users can be specified
with a min and max values
(<replaceable>UID_MIN-UID_MAX</replaceable>), a max value
(<replaceable>-UID_MAX</replaceable>), or a min value
(<replaceable>UID_MIN-</replaceable>).
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
When none of the <option>-l</option>, <option>-m</option>, or
<option>-r</option> options are used, <command>faillog</command>
displays the faillog record of the specified user(s).
</para>
</refsect1>
<refsect1 id='caveats'>
<title>CAVEATS</title>
<para>
<command>faillog</command> only prints out users with no successful
login since the last failure. To print out a user who has had a
successful login since their last failure, you must explicitly request
the user with the <option>-u</option> flag, or print out all users
with the <option>-a</option> flag.
</para>
</refsect1>
<refsect1 id='files'>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/var/log/faillog</filename></term>
<listitem>
<para>Failure logging file.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>login</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>faillog</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>.
</para>
</refsect1>
</refentry>