xref: /freebsd/lib/libpam/modules/pam_guest/pam_guest.8 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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.\" $FreeBSD$
34.\"
35.Dd May 26, 2003
36.Dt PAM_GUEST 8
37.Os
38.Sh NAME
39.Nm pam_guest
40.Nd Guest PAM module
41.Sh SYNOPSIS
42.Op Ar service-name
43.Ar module-type
44.Ar control-flag
45.Pa pam_guest
46.Op Ar arguments
47.Sh DESCRIPTION
48The guest service module for PAM allows guest logins.
49If successful, the
50.Nm
51module sets the PAM environment variable
52.Ev GUEST
53to the login name.
54The application can check this variable using
55.Xr pam_getenv 3
56to differentiate guest logins from normal logins.
57.Pp
58The following options may be passed to the
59.Nm
60module:
61.Bl -tag -width ".Cm pass_as_ruser"
62.It Cm guests Ns = Ns Ar list
63Comma-separated list of guest account names.
64The default is
65.Dq Li guest .
66A typical value for
67.Xr ftpd 8
68would be
69.Dq Li anonymous,ftp .
70.It Cm nopass
71Omits the password prompt if the target account is on the list of
72guest accounts.
73.It Cm pass_as_ruser
74The password typed in by the user is exported as the
75.Dv PAM_RUSER
76item.
77This is useful for applications like
78.Xr ftpd 8
79where guest users are encouraged to use their email address as
80password.
81.It Cm pass_is_user
82Requires the guest user to type in the guest account name as password.
83.El
84.Sh SEE ALSO
85.Xr pam_get_item 3 ,
86.Xr pam_getenv 3 ,
87.Xr pam.conf 5 ,
88.Xr pam 8
89.Sh AUTHORS
90The
91.Nm
92module and this manual page were developed for the
93.Fx
94Project by
95ThinkSec AS and NAI Labs, the Security Research Division of Network
96Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
97.Pq Dq CBOSS ,
98as part of the DARPA CHATS research program.
99