lib/libpam/modules/pam_guest/pam_guest.8

   1 .\" $NetBSD: pam_guest.8,v 1.2 2004/12/12 08:18:45 christos Exp $
   2 .\" Copyright (c) 2003 Networks Associates Technology, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" Portions of this software were developed for the FreeBSD Project by
   6 .\" ThinkSec AS and NAI Labs, the Security Research Division of Network
   7 .\" Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
   8 .\" ("CBOSS"), as part of the DARPA CHATS research program.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. The name of the author may not be used to endorse or promote
  19 .\"    products derived from this software without specific prior written
  20 .\"    permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\" $FreeBSD: src/lib/libpam/modules/pam_guest/pam_guest.8,v 1.4 2004/07/05 06:39:03 ru Exp $
  35 .\"
  36 .Dd May 26, 2003
  37 .Dt PAM_GUEST 8
  38 .Os
  39 .Sh NAME
  40 .Nm pam_guest
  41 .Nd Guest PAM module
  42 .Sh SYNOPSIS
  43 .Op Ar service-name
  44 .Ar module-type
  45 .Ar control-flag
  46 .Pa pam_guest
  47 .Op Ar arguments
  48 .Sh DESCRIPTION
  49 The guest service module for PAM allows guest logins.
  50 If successful, the
  51 .Nm
  52 module sets the PAM environment variable
  53 .Ev GUEST
  54 to the login name.
  55 The application can check this variable using
  56 .Xr pam_getenv 3
  57 to differentiate guest logins from normal logins.
  58 .Pp
  59 The following options may be passed to the
  60 .Nm
  61 module:
  62 .Bl -tag -width ".Cm pass_as_ruser"
  63 .It Cm guests Ns = Ns Ar list
  64 Comma-separated list of guest account names.
  65 The default is
  66 .Dq Li guest .
  67 A typical value for
  68 .Xr ftpd 8
  69 would be
  70 .Dq Li anonymous,ftp .
  71 .It Cm nopass
  72 Omits the password prompt if the target account is on the list of
  73 guest accounts.
  74 .It Cm pass_as_ruser
  75 The password typed in by the user is exported as the
  76 .Dv PAM_RUSER
  77 item.
  78 This is useful for applications like
  79 .Xr ftpd 8
  80 where guest users are encouraged to use their email address as
  81 password.
  82 .It Cm pass_is_user
  83 Requires the guest user to type in the guest account name as password.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr pam_get_item 3 ,
  87 .Xr pam_getenv 3 ,
  88 .Xr pam.conf 5 ,
  89 .Xr pam 8
  90 .Sh AUTHORS
  91 The
  92 .Nm
  93 module and this manual page were developed for the
  94 .Fx
  95 Project by
  96 ThinkSec AS and NAI Labs, the Security Research Division of Network
  97 Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
  98 .Pq Dq CBOSS ,
  99 as part of the DARPA CHATS research program.