Debian Codegraph @

upstream/debian-unstable/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: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_GROUP" "8" "06/29/2025" "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 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
43 \fBsetgid\fR
44 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
45 \fInosuid\fR
46 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
47 \fInosuid\fR\&.
48 .PP
49 The pam_group module functions in parallel with the
50 /etc/group
51 file\&. If the user is granted any groups based on the behavior of this module, they are granted
52 \fIin addition\fR
53 to those entries
54 /etc/group
55 (or equivalent)\&.
56 .SH "OPTIONS"
57 .PP
58 This module does not recognise any options\&.
59 .SH "MODULE TYPES PROVIDED"
60 .PP
61 Only the
62 \fBauth\fR
63 module type is provided\&.
64 .SH "RETURN VALUES"
65 .PP
66 PAM_SUCCESS
67 .RS 4
68 group membership was granted\&.
69 .RE
70 .PP
71 PAM_ABORT
72 .RS 4
73 Not all relevant data could be gotten\&.
74 .RE
75 .PP
76 PAM_BUF_ERR
77 .RS 4
78 Memory buffer error\&.
79 .RE
80 .PP
81 PAM_CRED_ERR
82 .RS 4
83 Group membership was not granted\&.
84 .RE
85 .PP
86 PAM_IGNORE
87 .RS 4
88 \fBpam_sm_authenticate\fR
89 was called which does nothing\&.
90 .RE
91 .PP
92 PAM_USER_UNKNOWN
93 .RS 4
94 The user is not known to the system\&.
95 .RE
96 .SH "FILES"
97 .PP
98 /etc/security/group\&.conf
99 .RS 4
100 Default configuration file
101 .RE
102 .SH "SEE ALSO"
103 .PP
104 \fBgroup.conf\fR(5),
105 \fBpam.d\fR(5),
106 \fBpam\fR(7)\&.
107 .SH "AUTHORS"
108 .PP
109 pam_group was written by Andrew G\&. Morgan <morgan@kernel\&.org>\&.