xref: /freebsd/lib/libpam/modules/pam_nologin/pam_nologin.8 (revision 6e1fc0118033f42b7c0d3623c8f67a89ebecabb2)
11642eb1aSMark Murray.\" Copyright (c) 2001 Mark R V Murray
21642eb1aSMark Murray.\" All rights reserved.
31642eb1aSMark Murray.\"
41642eb1aSMark Murray.\" Redistribution and use in source and binary forms, with or without
51642eb1aSMark Murray.\" modification, are permitted provided that the following conditions
61642eb1aSMark Murray.\" are met:
71642eb1aSMark Murray.\" 1. Redistributions of source code must retain the above copyright
81642eb1aSMark Murray.\"    notice, this list of conditions and the following disclaimer.
91642eb1aSMark Murray.\" 2. Redistributions in binary form must reproduce the above copyright
101642eb1aSMark Murray.\"    notice, this list of conditions and the following disclaimer in the
111642eb1aSMark Murray.\"    documentation and/or other materials provided with the distribution.
121642eb1aSMark Murray.\"
131642eb1aSMark Murray.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
141642eb1aSMark Murray.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
151642eb1aSMark Murray.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
161642eb1aSMark Murray.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
171642eb1aSMark Murray.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
181642eb1aSMark Murray.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
191642eb1aSMark Murray.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
201642eb1aSMark Murray.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
211642eb1aSMark Murray.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
221642eb1aSMark Murray.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
231642eb1aSMark Murray.\" SUCH DAMAGE.
241642eb1aSMark Murray.\"
259cd40e64SYaroslav Tykhiy.Dd June 10, 2007
261642eb1aSMark Murray.Dt PAM_NOLOGIN 8
271642eb1aSMark Murray.Os
281642eb1aSMark Murray.Sh NAME
291642eb1aSMark Murray.Nm pam_nologin
301642eb1aSMark Murray.Nd NoLogin PAM module
311642eb1aSMark Murray.Sh SYNOPSIS
321642eb1aSMark Murray.Op Ar service-name
331642eb1aSMark Murray.Ar module-type
341642eb1aSMark Murray.Ar control-flag
351642eb1aSMark Murray.Pa pam_nologin
361642eb1aSMark Murray.Op Ar options
371642eb1aSMark Murray.Sh DESCRIPTION
389cd40e64SYaroslav TykhiyThe NoLogin service module for PAM,
391642eb1aSMark Murray.Nm
401642eb1aSMark Murrayprovides functionality for only one PAM category:
419cd40e64SYaroslav Tykhiyaccount management.
421642eb1aSMark MurrayIn terms of the
431642eb1aSMark Murray.Ar module-type
441642eb1aSMark Murrayparameter, this is the
459cd40e64SYaroslav Tykhiy.Dq Li account
461642eb1aSMark Murrayfeature.
479cd40e64SYaroslav Tykhiy.Ss NoLogin Account Management Module
489cd40e64SYaroslav TykhiyThe NoLogin account management component,
499cd40e64SYaroslav Tykhiy.Fn pam_sm_acct_mgmt ,
5058d6bdcbSYaroslav Tykhiyverifies whether logins are administratively disabled via
5158d6bdcbSYaroslav Tykhiy.Xr nologin 5 .
5258d6bdcbSYaroslav TykhiyIt returns success if the user's login class has an "ignorenologin"
5358d6bdcbSYaroslav Tykhiycapability specified in
5458d6bdcbSYaroslav Tykhiy.Xr login.conf 5
5558d6bdcbSYaroslav Tykhiyor the
5658d6bdcbSYaroslav Tykhiy.Xr nologin 5
5758d6bdcbSYaroslav Tykhiyfile does not exist.
5858d6bdcbSYaroslav TykhiyIf neither condition is met,
5958d6bdcbSYaroslav Tykhiythen the contents of
6058d6bdcbSYaroslav Tykhiy.Xr nologin 5
6158d6bdcbSYaroslav Tykhiyare echoed
621642eb1aSMark Murraybefore failure is returned.
6358d6bdcbSYaroslav TykhiyThe location of
6458d6bdcbSYaroslav Tykhiy.Xr nologin 5
6558d6bdcbSYaroslav Tykhiyis specified by a "nologin" capability in
66f96b705fSMark Murray.Xr login.conf 5 ,
6758d6bdcbSYaroslav Tykhiywhich defaults to
68f96b705fSMark Murray.Pa /var/run/nologin .
691642eb1aSMark Murray.Pp
709cd40e64SYaroslav TykhiyThe following options may be passed to the module:
71ca0bdcddSMark Murray.Bl -tag -width ".Cm no_warn"
721642eb1aSMark Murray.It Cm debug
731642eb1aSMark Murray.Xr syslog 3
741642eb1aSMark Murraydebugging information at
751642eb1aSMark Murray.Dv LOG_DEBUG
761642eb1aSMark Murraylevel.
77ca0bdcddSMark Murray.It Cm no_warn
78ca0bdcddSMark Murraysuppress warning messages to the user.
79ca0bdcddSMark MurrayThese messages include
80ca0bdcddSMark Murrayreasons why the user's
819cd40e64SYaroslav Tykhiylogin attempt was declined.
821642eb1aSMark Murray.El
831642eb1aSMark Murray.Sh SEE ALSO
84*6e1fc011SGraham Percival.Xr pam 3 ,
851642eb1aSMark Murray.Xr syslog 3 ,
86f96b705fSMark Murray.Xr login.conf 5 ,
871642eb1aSMark Murray.Xr nologin 5 ,
88*6e1fc011SGraham Percival.Xr pam.conf 5
89