| 1 |
'\" t |
| 2 |
.\" Title: faillock.conf |
| 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\&.CONF" "5" "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.conf \- pam_faillock configuration file |
| 32 |
.SH "DESCRIPTION" |
| 33 |
.PP |
| 34 |
\fBfaillock\&.conf\fR |
| 35 |
provides a way to configure the default settings for locking the user after multiple failed authentication attempts\&. This file is read by the |
| 36 |
\fIpam_faillock\fR |
| 37 |
module and is the preferred method over configuring |
| 38 |
\fIpam_faillock\fR |
| 39 |
directly\&. |
| 40 |
.PP |
| 41 |
The file has a very simple |
| 42 |
\fIname = value\fR |
| 43 |
format with possible comments starting with |
| 44 |
\fI#\fR |
| 45 |
character\&. The whitespace at the beginning of line, end of line, and around the |
| 46 |
\fI=\fR |
| 47 |
sign is ignored\&. |
| 48 |
.SH "OPTIONS" |
| 49 |
.PP |
| 50 |
dir=/path/to/tally\-directory |
| 51 |
.RS 4 |
| 52 |
The directory where the user files with the failure records are kept\&. The default is |
| 53 |
/var/run/faillock\&. |
| 54 |
.sp |
| 55 |
Note: These files will disappear after reboot on systems configured with directory |
| 56 |
/var/run/faillock |
| 57 |
mounted on virtual memory\&. |
| 58 |
.RE |
| 59 |
.PP |
| 60 |
audit |
| 61 |
.RS 4 |
| 62 |
Will log the user name into the system log if the user is not found\&. |
| 63 |
.RE |
| 64 |
.PP |
| 65 |
silent |
| 66 |
.RS 4 |
| 67 |
Don\*(Aqt print informative messages to the user\&. Please note that when this option is not used there will be difference in the authentication behavior for users which exist on the system and non\-existing users\&. |
| 68 |
.RE |
| 69 |
.PP |
| 70 |
no_log_info |
| 71 |
.RS 4 |
| 72 |
Don\*(Aqt log informative messages via |
| 73 |
\fBsyslog\fR(3)\&. |
| 74 |
.RE |
| 75 |
.PP |
| 76 |
local_users_only |
| 77 |
.RS 4 |
| 78 |
Only track failed user authentications attempts for local users in /etc/passwd and ignore centralized (AD, IdM, LDAP, etc\&.) users\&. The |
| 79 |
\fBfaillock\fR(8) |
| 80 |
command will also no longer track user failed authentication attempts\&. Enabling this option will prevent a double\-lockout scenario where a user is locked out locally and in the centralized mechanism\&. |
| 81 |
.RE |
| 82 |
.PP |
| 83 |
nodelay |
| 84 |
.RS 4 |
| 85 |
Don\*(Aqt enforce a delay after authentication failures\&. |
| 86 |
.RE |
| 87 |
.PP |
| 88 |
deny=n |
| 89 |
.RS 4 |
| 90 |
Deny access if the number of consecutive authentication failures for this user during the recent interval exceeds |
| 91 |
\fIn\fR\&. The default is 3\&. |
| 92 |
.RE |
| 93 |
.PP |
| 94 |
fail_interval=n |
| 95 |
.RS 4 |
| 96 |
The length of the interval during which the consecutive authentication failures must happen for the user account lock out is |
| 97 |
\fIn\fR |
| 98 |
seconds\&. The default is 900 (15 minutes)\&. |
| 99 |
.RE |
| 100 |
.PP |
| 101 |
unlock_time=n |
| 102 |
.RS 4 |
| 103 |
The access will be re\-enabled after |
| 104 |
\fIn\fR |
| 105 |
seconds after the lock out\&. The value 0 has the same meaning as value |
| 106 |
\fInever\fR |
| 107 |
\- the access will not be re\-enabled without resetting the faillock entries by the |
| 108 |
\fBfaillock\fR(8) |
| 109 |
command\&. The default is 600 (10 minutes)\&. |
| 110 |
.sp |
| 111 |
Note that the default directory that |
| 112 |
\fIpam_faillock\fR |
| 113 |
uses is usually cleared on system boot so the access will be also re\-enabled after system reboot\&. If that is undesirable a different tally directory must be set with the |
| 114 |
\fBdir\fR |
| 115 |
option\&. |
| 116 |
.sp |
| 117 |
Also note that it is usually undesirable to permanently lock out users as they can become easily a target of denial of service attack unless the usernames are random and kept secret to potential attackers\&. |
| 118 |
.RE |
| 119 |
.PP |
| 120 |
even_deny_root |
| 121 |
.RS 4 |
| 122 |
Root account can become locked as well as regular accounts\&. |
| 123 |
.RE |
| 124 |
.PP |
| 125 |
root_unlock_time=n |
| 126 |
.RS 4 |
| 127 |
This option implies |
| 128 |
\fBeven_deny_root\fR |
| 129 |
option\&. Allow access after |
| 130 |
\fIn\fR |
| 131 |
seconds to root account after the account is locked\&. In case the option is not specified the value is the same as of the |
| 132 |
\fBunlock_time\fR |
| 133 |
option\&. |
| 134 |
.RE |
| 135 |
.PP |
| 136 |
admin_group=name |
| 137 |
.RS 4 |
| 138 |
If a group name is specified with this option, members of the group will be handled by this module the same as the root account (the options |
| 139 |
\fBeven_deny_root\fR |
| 140 |
and |
| 141 |
\fBroot_unlock_time\fR |
| 142 |
will apply to them\&. By default the option is not set\&. |
| 143 |
.RE |
| 144 |
.SH "EXAMPLES" |
| 145 |
.PP |
| 146 |
/etc/security/faillock\&.conf file example: |
| 147 |
.sp |
| 148 |
.if n \{\ |
| 149 |
.RS 4 |
| 150 |
.\} |
| 151 |
.nf |
| 152 |
deny=4 |
| 153 |
unlock_time=1200 |
| 154 |
silent |
| 155 |
|
| 156 |
.fi |
| 157 |
.if n \{\ |
| 158 |
.RE |
| 159 |
.\} |
| 160 |
.SH "FILES" |
| 161 |
.PP |
| 162 |
/etc/security/faillock\&.conf |
| 163 |
.RS 4 |
| 164 |
the config file for custom options |
| 165 |
.RE |
| 166 |
.SH "SEE ALSO" |
| 167 |
.PP |
| 168 |
\fBfaillock\fR(8), |
| 169 |
\fBpam_faillock\fR(8), |
| 170 |
\fBpam.conf\fR(5), |
| 171 |
\fBpam.d\fR(5), |
| 172 |
\fBpam\fR(8) |
| 173 |
.SH "AUTHOR" |
| 174 |
.PP |
| 175 |
pam_faillock was written by Tomas Mraz\&. The support for faillock\&.conf was written by Brian Ward\&. |