1.\" Copyright (c) 2001 Mark R V Murray
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD: head/lib/libpam/modules/pam_nologin/pam_nologin.8 233648 2012-03-29 05:02:12Z eadler $
26.\"
27.Dd June 10, 2007
28.Dt PAM_NOLOGIN 8
29.Os
30.Sh NAME
31.Nm pam_nologin
32.Nd NoLogin PAM module
33.Sh SYNOPSIS
34.Op Ar service-name
35.Ar module-type
36.Ar control-flag
37.Pa pam_nologin
38.Op Ar options
39.Sh DESCRIPTION
40The NoLogin service module for PAM,
41.Nm
42provides functionality for only one PAM category:
43account management.
44In terms of the
45.Ar module-type
46parameter, this is the
47.Dq Li account
48feature.
49.Ss NoLogin Account Management Module
50The NoLogin account management component,
51.Fn pam_sm_acct_mgmt ,
52verifies whether logins are administratively disabled via
53.Xr nologin 5 .
54It returns success if the user's login class has an "ignorenologin"
55capability specified in
56.Xr login.conf 5
57or the
58.Xr nologin 5
59file does not exist.
60If neither condition is met,
61then the contents of
62.Xr nologin 5
63are echoed
64before failure is returned.
65The location of
66.Xr nologin 5
67is specified by a "nologin" capability in
68.Xr login.conf 5 ,
69which defaults to
70.Pa /var/run/nologin .
71.Pp
72The following options may be passed to the module:
73.Bl -tag -width ".Cm no_warn"
74.It Cm debug
75.Xr syslog 3
76debugging information at
77.Dv LOG_DEBUG
78level.
79.It Cm no_warn
80suppress warning messages to the user.
81These messages include
82reasons why the user's
83login attempt was declined.
84.El
85.Sh SEE ALSO
86.Xr pam 3 ,
87.Xr syslog 3 ,
88.Xr login.conf 5 ,
89.Xr nologin 5 ,
90.Xr pam.conf 5
91.Sh HISTORY
92.Nm
93originated from
94.Fx
95and first appeared in
96.Dx 1.11 .
97