lib/pam_module/pam_nologin/pam_nologin.8

   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: src/lib/libpam/modules/pam_nologin/pam_nologin.8,v 1.7 2007/06/14 13:07:06 yar Exp $
  26 .\" $DragonFly: src/lib/pam_module/pam_nologin/pam_nologin.8,v 1.3 2008/02/08 10:41:43 swildner Exp $
  27 .\"
  28 .Dd June 10, 2007
  29 .Dt PAM_NOLOGIN 8
  30 .Os
  31 .Sh NAME
  32 .Nm pam_nologin
  33 .Nd NoLogin PAM module
  34 .Sh SYNOPSIS
  35 .Op Ar service-name
  36 .Ar module-type
  37 .Ar control-flag
  38 .Pa pam_nologin
  39 .Op Ar options
  40 .Sh DESCRIPTION
  41 The NoLogin service module for PAM,
  42 .Nm
  43 provides functionality for only one PAM category:
  44 account management.
  45 In terms of the
  46 .Ar module-type
  47 parameter, this is the
  48 .Dq Li account
  49 feature.
  50 .Ss NoLogin Account Management Module
  51 The NoLogin account management component,
  52 .Fn pam_sm_acct_mgmt ,
  53 verifies whether logins are administratively disabled via
  54 .Xr nologin 5 .
  55 It returns success if the user's login class has an "ignorenologin"
  56 capability specified in
  57 .Xr login.conf 5
  58 or the
  59 .Xr nologin 5
  60 file does not exist.
  61 If neither condition is met,
  62 then the contents of
  63 .Xr nologin 5
  64 are echoed
  65 before failure is returned.
  66 The location of
  67 .Xr nologin 5
  68 is specified by a "nologin" capability in
  69 .Xr login.conf 5 ,
  70 which defaults to
  71 .Pa /var/run/nologin .
  72 .Pp
  73 The following options may be passed to the module:
  74 .Bl -tag -width ".Cm no_warn"
  75 .It Cm debug
  76 .Xr syslog 3
  77 debugging information at
  78 .Dv LOG_DEBUG
  79 level.
  80 .It Cm no_warn
  81 suppress warning messages to the user.
  82 These messages include
  83 reasons why the user's
  84 login attempt was declined.
  85 .El
  86 .Sh SEE ALSO
  87 .Xr syslog 3 ,
  88 .Xr login.conf 5 ,
  89 .Xr nologin 5 ,
  90 .Xr pam.conf 5 ,
  91 .Xr pam 8
  92 .Sh HISTORY
  93 .Nm
  94 originated from
  95 .Fx
  96 and first appeared in
  97 .Dx 1.11 .