lib/libpam/modules/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$
  26 .\"
  27 .Dd July 8, 2001
  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
  40 The NoLogin authentication service module for PAM,
  41 .Nm
  42 provides functionality for only one PAM category:
  43 authentication.
  44 In terms of the
  45 .Ar module-type
  46 parameter, this is the
  47 .Dq Li auth
  48 feature.
  49 It also provides a null function for session management.
  50 .Ss NoLogin Authentication Module
  51 The NoLogin authentication component
  52 .Pq Fn pam_sm_authenticate ,
  53 always returns success for the superuser,
  54 and returns success for all other users
  55 if the file
  56 .Pa /var/run/nologin
  57 does not exist.
  58 If
  59 .Pa /var/run/nologin
  60 does exist,
  61 then its contents are echoed
  62 to non-superusers
  63 before failure is returned.
  64 If a "nologin" capability
  65 is specified in
  66 .Xr login.conf 5 ,
  67 then the file thus specified
  68 is used instead.
  69 This usually defaults to
  70 .Pa /var/run/nologin .
  71 .Pp
  72 The following options may be passed to the authentication module:
  73 .Bl -tag -width ".Cm no_warn"
  74 .It Cm debug
  75 .Xr syslog 3
  76 debugging information at
  77 .Dv LOG_DEBUG
  78 level.
  79 .It Cm no_warn
  80 suppress warning messages to the user.
  81 These messages include
  82 reasons why the user's
  83 authentication attempt was declined.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr syslog 3 ,
  87 .Xr login.conf 5 ,
  88 .Xr nologin 5 ,
  89 .Xr pam.conf 5 ,
  90 .Xr pam 8