Debian Codegraph @

doc/man/pwscore.1

raw
1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
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 .if !\nF .nr F 0
58 .if \nF>0 \{\
59 . de IX
60 . tm Index:\\$1\t\\n%\t"\\$2"
61 ..
62 . if !\nF==2 \{\
63 . nr % 0
64 . nr F 2
65 . \}
66 .\}
67 .\" ========================================================================
68 .\"
69 .IX Title "PWSCORE 1"
70 .TH PWSCORE 1 "2017-02-10" "Red Hat, Inc." "General Commands Manual"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
72 .\" way too many mistakes in technical documents.
73 .if n .ad l
74 .nh
75 .SH "NAME"
76 pwscore \- simple configurable tool for checking quality of a password
77 .SH "SYNOPSIS"
78 .IX Header "SYNOPSIS"
79 \&\fBpwscore\fR [\fIuser\fR]
80 .SH "DESCRIPTION"
81 .IX Header "DESCRIPTION"
82 \&\fBpwscore\fR is a simple tool for checking quality of a password. The password
83 is read from stdin.
84 .PP
85 The tool uses the \fBlibpwquality\fR library to perform configurable checks
86 for minimum length, dictionary checking against cracklib dictionaries,
87 and other checks.
88 .PP
89 It either reports an error if the password fails any of the checks, or it
90 prints out the password quality score as an integer value between \fI0\fR and
91 \&\fI100\fR.
92 .PP
93 The password quality score is relative to the \fBminlen\fR setting in the
94 configuration file. But in general values below 50 can be treated as moderate
95 quality and above it fairly strong quality. Any password that passes the quality
96 checks (especially the mandatory cracklib check) should withstand dictionary
97 attacks and scores above 50 with the default minlen setting even fast brute
98 force attacks.
99 .SH "OPTIONS"
100 .IX Header "OPTIONS"
101 The first and only optional argument is the user name that is used to check
102 the similarity of the password to the username.
103 .SH "FILES"
104 .IX Header "FILES"
105 \&\fI/etc/security/pwquality.conf\fR \- The configuration file for the libpwquality
106 library.
107 .SH "RETURN CODES"
108 .IX Header "RETURN CODES"
109 \&\fBpwscore\fR returns 0 on success, non zero on error.
110 .SH "SEE ALSO"
111 .IX Header "SEE ALSO"
112 \&\fIpwscore\fR\|(1), \fIpwquality.conf\fR\|(5), \fIpam_pwquality\fR\|(8)
113 .SH "AUTHORS"
114 .IX Header "AUTHORS"
115 Tomas Mraz <[email protected]>