1.\" Copyright (c) 2001 Networks Associates Technology, Inc.
2.\" All rights reserved.
3.\" Copyright (c) 2009 Dmitry V. Levin
4.\" All rights reserved.
5.\" Copyright (c) 2009,2019 Solar Designer
6.\" All rights reserved.
7.\"
8.\" Portions of this software were developed for the FreeBSD Project by
9.\" ThinkSec AS and NAI Labs, the Security Research Division of Network
10.\" Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
11.\" ("CBOSS"), as part of the DARPA CHATS research program.
12.\"
13.\" Redistribution and use in source and binary forms, with or without
14.\" modification, are permitted provided that the following conditions
15.\" are met:
16.\" 1. Redistributions of source code must retain the above copyright
17.\"    notice, this list of conditions and the following disclaimer.
18.\" 2. Redistributions in binary form must reproduce the above copyright
19.\"    notice, this list of conditions and the following disclaimer in the
20.\"    documentation and/or other materials provided with the distribution.
21.\" 3. The name of the author may not be used to endorse or promote
22.\"    products derived from this software without specific prior written
23.\"    permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35.\" SUCH DAMAGE.
36.\"
37.Dd December 9, 2019
38.Dt PAM_PASSWDQC 8
39.Os "Openwall Project"
40.Sh NAME
41.Nm pam_passwdqc
42.Nd Password quality-control PAM module
43.Sh SYNOPSIS
44.Op Ar service-name
45.Ar module-type
46.Ar control-flag
47.Pa pam_passwdqc
48.Op Ar options
49.Sh DESCRIPTION
50The
51.Nm
52module is a simple password strength checking module for
53PAM.
54In addition to checking regular passwords, it offers support for
55passphrases and can provide randomly generated ones.
56.Pp
57The
58.Nm
59module provides functionality for only one PAM management group:
60password changing.
61In terms of the
62.Ar module-type
63parameter, this is the
64.Dq Li password
65feature.
66.Pp
67The
68.Fn pam_chauthtok
69service function may ask the user for a new password, and verify that
70it meets certain minimum standards.
71If the chosen password is unsatisfactory, the service function returns
72.Dv PAM_AUTHTOK_ERR .
73.Pp
74The set of options that may be passed to the module is exactly the
75same as the set of options that may be specified in the configuration
76file (suggested location
77.Pa /etc/passwdqc.conf ,
78to be specified in the
79.Cm config=/etc/passwdqc.conf
80option).  These options are described in
81.Xr passwdqc.conf 5 .
82.Sh SEE ALSO
83.Xr pam 3 ,
84.Xr pam.conf 5 ,
85.Xr passwdqc.conf 5 ,
86.Pp
87https://www.openwall.com/passwdqc/
88.Sh AUTHORS
89The
90.Nm
91module was written for Openwall GNU/*/Linux by
92.An Solar Designer Aq solar at openwall.com .
93This manual page was written for the
94.Fx
95Project by
96ThinkSec AS and NAI Labs, the Security Research Division of Network
97Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
98.Pq Dq CBOSS ,
99as part of the DARPA CHATS research program.
100It has since been revised, most importantly to refer to
101.Xr passwdqc.conf 5
102instead of describing the options right on this page.
103