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