Debian Codegraph @

doc/man/pwquality.conf.5

raw
1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 . if \nF \{\
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{\
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\" ========================================================================
72 .\"
73 .IX Title "PWQUALITY.CONF 5"
74 .TH PWQUALITY.CONF 5 "2020-08-03" "Red Hat, Inc." "File Formats Manual"
75 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
76 .\" way too many mistakes in technical documents.
77 .if n .ad l
78 .nh
79 .SH "NAME"
80 pwquality.conf \- configuration for the libpwquality library
81 .SH "SYNOPSIS"
82 .IX Header "SYNOPSIS"
83 \&\fI/etc/security/pwquality.conf\fR
84 .PP
85 \&\fI/etc/security/pwquality.conf.d/*.conf\fR
86 .SH "DESCRIPTION"
87 .IX Header "DESCRIPTION"
88 \&\fBpwquality.conf\fR provides a way to configure the default password
89 quality requirements for the system passwords. This file is read by the
90 libpwquality library and utilities that use this library for checking
91 and generating passwords.
92 .PP
93 The file has a very simple \fIname = value\fR format with possible comments
94 starting with \f(CW\*(C`#\*(C'\fR character. The whitespace at the beginning of line, end
95 of line, and around the \f(CW\*(C`=\*(C'\fR sign is ignored.
96 .PP
97 The libpwquality library also first reads all \fI*.conf\fR files from the
98 \&\fI/etc/security/pwquality.conf.d\fR directory in \s-1ASCII\s0 sorted order. The
99 values of the same settings are overridden in the order the files are parsed.
100 .SH "OPTIONS"
101 .IX Header "OPTIONS"
102 The possible options in the file are:
103 .IP "\fBdifok\fR" 4
104 .IX Item "difok"
105 Number of characters in the new password that must not be present in the
106 old password. (default 1)
107 .Sp
108 The special value of 0 disables all checks of similarity of the new password
109 with the old password except the new password being exactly the same as
110 the old one.
111 .IP "\fBminlen\fR" 4
112 .IX Item "minlen"
113 Minimum acceptable size for the new password (plus one if credits are not
114 disabled which is the default). (See \fBpam_pwquality\fR\|(8).)
115 Cannot be set to lower value than 6. (default 8)
116 .IP "\fBdcredit\fR" 4
117 .IX Item "dcredit"
118 The maximum credit for having digits in the new password. If less than 0
119 it is the minimum number of digits in the new password. (default 0)
120 .IP "\fBucredit\fR" 4
121 .IX Item "ucredit"
122 The maximum credit for having uppercase characters in the new password.
123 If less than 0 it is the minimum number of uppercase characters in the new
124 password. (default 0)
125 .IP "\fBlcredit\fR" 4
126 .IX Item "lcredit"
127 The maximum credit for having lowercase characters in the new password.
128 If less than 0 it is the minimum number of lowercase characters in the new
129 password. (default 0)
130 .IP "\fBocredit\fR" 4
131 .IX Item "ocredit"
132 The maximum credit for having other characters in the new password.
133 If less than 0 it is the minimum number of other characters in the new
134 password. (default 0)
135 .IP "\fBminclass\fR" 4
136 .IX Item "minclass"
137 The minimum number of required classes of characters for the new
138 password (digits, uppercase, lowercase, others). (default 0)
139 .IP "\fBmaxrepeat\fR" 4
140 .IX Item "maxrepeat"
141 The maximum number of allowed same consecutive characters in the new password.
142 The check is disabled if the value is 0. (default 0)
143 .IP "\fBmaxsequence\fR" 4
144 .IX Item "maxsequence"
145 The maximum length of monotonic character sequences in the new password.
146 Examples of such sequence are '12345' or 'fedcb'. Note
147 that most such passwords will not pass the simplicity check unless
148 the sequence is only a minor part of the password.
149 The check is disabled if the value is 0. (default 0)
150 .IP "\fBmaxclassrepeat\fR" 4
151 .IX Item "maxclassrepeat"
152 The maximum number of allowed consecutive characters of the same class in the
153 new password.
154 The check is disabled if the value is 0. (default 0)
155 .IP "\fBgecoscheck\fR" 4
156 .IX Item "gecoscheck"
157 If nonzero, check whether the words longer than 3 characters from the \fI\s-1GECOS\s0\fR
158 field of the user's \fBpasswd\fR\|(5) entry are contained in the new password.
159 The check is disabled if the value is 0. (default 0)
160 .IP "\fBdictcheck\fR" 4
161 .IX Item "dictcheck"
162 If nonzero, check whether the password (with possible modifications)
163 matches a word in a dictionary. Currently the dictionary check is performed
164 using the cracklib library. (default 1)
165 .IP "\fBusercheck=\fR\fIN\fR" 4
166 .IX Item "usercheck=N"
167 If nonzero, check whether the password (with possible modifications)
168 contains the user name in some form. It is not performed for user names shorter
169 than 3 characters. (default 1)
170 .IP "\fBusersubstr=\fR\fIN\fR" 4
171 .IX Item "usersubstr=N"
172 If greater than 3 (due to the minimum length in usercheck), check whether the
173 password contains a substring of at least \fIN\fR length in some form.
174 (default 0)
175 .IP "\fBenforcing=\fR\fIN\fR" 4
176 .IX Item "enforcing=N"
177 If nonzero, reject the password if it fails the checks, otherwise
178 only print the warning. This setting applies only to the pam_pwquality module
179 and possibly other applications that explicitly change their behavior
180 based on it. It does not affect \fBpwmake\fR\|(1) and \fBpwscore\fR\|(1). (default 1)
181 .IP "\fBbadwords\fR" 4
182 .IX Item "badwords"
183 Space separated list of words that must not be contained in the password. These
184 are additional words to the cracklib dictionary check. This setting can be
185 also used by applications to emulate the gecos check for user accounts that are
186 not created yet.
187 .IP "\fBdictpath\fR" 4
188 .IX Item "dictpath"
189 Path to the cracklib dictionaries. Default is to use the cracklib default.
190 .IP "\fBretry=\fR\fIN\fR" 4
191 .IX Item "retry=N"
192 Prompt user at most \fIN\fR times before returning with error. The default is
193 \&\fI1\fR.
194 .IP "\fBenforce_for_root\fR" 4
195 .IX Item "enforce_for_root"
196 The module will return error on failed check even if the user changing the
197 password is root. This option is off by default which means that just
198 the message about the failed check is printed but root can change
199 the password anyway. Note that root is not asked for an old password
200 so the checks that compare the old and new password are not performed.
201 .IP "\fBlocal_users_only\fR" 4
202 .IX Item "local_users_only"
203 The module will not test the password quality for users that are not present
204 in the \fI/etc/passwd\fR file. The module still asks for the password so
205 the following modules in the stack can use the \fBuse_authtok\fR option.
206 This option is off by default.
207 .SH "SEE ALSO"
208 .IX Header "SEE ALSO"
209 \&\fBpwscore\fR\|(1), \fBpwmake\fR\|(1), \fBpam_pwquality\fR\|(8)
210 .SH "AUTHORS"
211 .IX Header "AUTHORS"
212 Tomas Mraz <[email protected]>