pam_group: Add ruser and luser options.
[dragonfly.git] / lib / pam_module / pam_group / pam_group.8
1 .\" Copyright (c) 2003 Networks Associates Technology, Inc.
2 .\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
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_group/pam_group.8,v 1.4 2011/03/12 11:12:30 des Exp $
35 .\"
36 .Dd December 24, 2011
37 .Dt PAM_GROUP 8
38 .Os
39 .Sh NAME
40 .Nm pam_group
41 .Nd Group PAM module
42 .Sh SYNOPSIS
43 .Op Ar service-name
44 .Ar module-type
45 .Ar control-flag
46 .Pa pam_group
47 .Op Ar arguments
48 .Sh DESCRIPTION
49 The group service module for PAM accepts or rejects users based on
50 their membership in a particular file group.
51 .Pp
52 The following options may be passed to the
53 .Nm
54 module:
55 .Bl -tag -width ".Cm fail_safe"
56 .It Cm deny
57 Reverse the meaning of the test, i.e., reject the applicant if and only
58 if he or she is a member of the specified group.
59 This can be useful to exclude certain groups of users from certain
60 services.
61 .It Cm fail_safe
62 If the specified group does not exist, or has no members, act as if
63 it does exist and the applicant is a member.
64 .It Cm group Ns = Ns Ar groupname
65 Specify the name of the group to check.
66 The default is
67 .Dq Li wheel .
68 .It Cm luser
69 Accept or reject based on the target user's group membership.
70 .It Cm root_only
71 Skip this module entirely if the target account is not the superuser
72 account.
73 .It Cm ruser
74 Accept or reject based on the supplicant's group membership.
75 This is the default.
76 .El
77 .Pp
78 Note that the
79 .Cm luser
80 and
81 .Cm ruser
82 options are mutually exclusive, and that
83 .Nm
84 will fail if both are specified.
85 .Sh SEE ALSO
86 .Xr pam.conf 5 ,
87 .Xr pam 8
88 .Sh AUTHORS
89 The
90 .Nm
91 module and this manual page were developed for the
92 .Fx
93 Project by
94 ThinkSec AS and NAI Labs, the Security Research Division of Network
95 Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
96 .Pq Dq CBOSS ,
97 as part of the DARPA CHATS research program.