xref: /netbsd-src/lib/libpam/modules/pam_deny/pam_deny.8 (revision a09cadcf91d2b4b195c4325907c76cee75fce5ee)
1.\" $NetBSD: pam_deny.8,v 1.5 2013/08/20 22:44:37 wiz Exp $
2.\" Copyright (c) 2001 Mark R V Murray
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD: src/lib/libpam/modules/pam_deny/pam_deny.8,v 1.4 2001/08/15 20:05:30 markm Exp $
27.\"
28.Dd August 21, 2013
29.Dt PAM_DENY 8
30.Os
31.Sh NAME
32.Nm pam_deny
33.Nd Deny PAM module
34.Sh SYNOPSIS
35.Op Ar service-name
36.Ar module-type
37.Ar control-flag
38.Pa pam_deny
39.Op Ar options
40.Sh DESCRIPTION
41The deny authentication service module for PAM
42provides functionality for all the PAM categories:
43authentication,
44account management,
45session management and
46password management.
47In terms of the
48.Ar module-type
49parameter, these are the
50.Dq Li auth ,
51.Dq Li account ,
52.Dq Li session ,
53and
54.Dq Li password
55features.
56.Pp
57The Deny module
58will universally deny all requests.
59It is primarily of use during testing,
60and to
61.Dq null-out
62unwanted functionality.
63.Pp
64The following options may be passed to the module:
65.Bl -tag -width ".Cm no_warn"
66.It Cm debug
67.Xr syslog 3
68debugging information at
69.Dv LOG_DEBUG
70level.
71.It Cm no_warn
72suppress warning messages to the user.
73These messages include
74reasons why the user's
75authentication attempt was declined.
76.It Cm prelim_ignore
77for password management
78.Dq ( Li password
79feature), return
80.Dv PAM_IGNORE
81in the preliminary phase.
82This allows the module to be used (with the
83.Dq Li required
84flag) at the end of a chain of
85.Dq Li sufficient
86modules with this service
87(where the entire chain is in fact run twice).
88.El
89.Sh SEE ALSO
90.Xr syslog 3 ,
91.Xr pam.conf 5 ,
92.Xr pam 8
93