Debian Codegraph @

upstream/opensuse-tumbleweed/man8/pam_group.8

raw
1 '\" t
2 .\" Title: pam_group
3 .\" Author: [see the "AUTHORS" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_GROUP" "8" "05/26/2026" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pam_group \- PAM module for group access
32 .SH "SYNOPSIS"
33 .HP \w'\fBpam_group\&.so\fR\ 'u
34 \fBpam_group\&.so\fR
35 .SH "DESCRIPTION"
36 .PP
37 The pam_group PAM module does not authenticate the user, but instead it grants group memberships (in the credential setting phase of the authentication module) to the user\&. Such memberships are based on the service they are applying for\&.
38 .PP
39 By default rules for group memberships are taken from config file
40 /etc/security/group\&.conf\&.
41 .PP
42 If
43 /etc/security/group\&.conf
44 does not exist,
45 /usr/etc/security/group\&.conf
46 is used\&.
47 .PP
48 This module\*(Aqs usefulness relies on the file\-systems accessible to the user\&. The point being that once granted the membership of a group, the user may attempt to create a
49 \fBsetgid\fR
50 binary with a restricted group ownership\&. Later, when the user is not given membership to this group, they can recover group membership with the precompiled binary\&. The reason that the file\-systems that the user has access to are so significant, is the fact that when a system is mounted
51 \fInosuid\fR
52 the user is unable to create or execute such a binary file\&. For this module to provide any level of security, all file\-systems that the user has write access to should be mounted
53 \fInosuid\fR\&.
54 .PP
55 The pam_group module functions in parallel with the
56 /etc/group
57 file\&. If the user is granted any groups based on the behavior of this module, they are granted
58 \fIin addition\fR
59 to those entries
60 /etc/group
61 (or equivalent)\&.
62 .SH "OPTIONS"
63 .PP
64 This module does not recognise any options\&.
65 .SH "MODULE TYPES PROVIDED"
66 .PP
67 Only the
68 \fBauth\fR
69 module type is provided\&.
70 .SH "RETURN VALUES"
71 .PP
72 PAM_SUCCESS
73 .RS 4
74 group membership was granted\&.
75 .RE
76 .PP
77 PAM_ABORT
78 .RS 4
79 Not all relevant data could be gotten\&.
80 .RE
81 .PP
82 PAM_BUF_ERR
83 .RS 4
84 Memory buffer error\&.
85 .RE
86 .PP
87 PAM_CRED_ERR
88 .RS 4
89 Group membership was not granted\&.
90 .RE
91 .PP
92 PAM_IGNORE
93 .RS 4
94 \fBpam_sm_authenticate\fR
95 was called which does nothing\&.
96 .RE
97 .PP
98 PAM_USER_UNKNOWN
99 .RS 4
100 The user is not known to the system\&.
101 .RE
102 .SH "FILES"
103 .PP
104 /etc/security/group\&.conf
105 .RS 4
106 Default configuration file
107 .RE
108 .SH "SEE ALSO"
109 .PP
110 \fBgroup.conf\fR(5),
111 \fBpam.d\fR(5),
112 \fBpam\fR(8)\&.
113 .SH "AUTHORS"
114 .PP
115 pam_group was written by Andrew G\&. Morgan <morgan@kernel\&.org>\&.