| 1 |
'\" t |
| 2 |
.\" Title: pam_wheel |
| 3 |
.\" Author: [see the "AUTHOR" 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_WHEEL" "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_wheel \- Only permit root access to members of group wheel |
| 32 |
.SH "SYNOPSIS" |
| 33 |
.HP \w'\fBpam_wheel\&.so\fR\ 'u |
| 34 |
\fBpam_wheel\&.so\fR [debug] [deny] [group=\fIname\fR] [root_only] [trust] |
| 35 |
.SH "DESCRIPTION" |
| 36 |
.PP |
| 37 |
The pam_wheel PAM module is used to enforce the so\-called |
| 38 |
\fIwheel\fR |
| 39 |
group\&. By default it permits access to the target user if the applicant user is a member of the |
| 40 |
\fIwheel\fR |
| 41 |
group\&. If no group with this name exist, the module is using the group with the group\-ID |
| 42 |
\fB0\fR\&. |
| 43 |
.SH "OPTIONS" |
| 44 |
.PP |
| 45 |
debug |
| 46 |
.RS 4 |
| 47 |
Print debug information\&. |
| 48 |
.RE |
| 49 |
.PP |
| 50 |
deny |
| 51 |
.RS 4 |
| 52 |
Reverse the sense of the auth operation: if the user is trying to get UID 0 access and is a member of the wheel group (or the group of the |
| 53 |
\fBgroup\fR |
| 54 |
option), deny access\&. Conversely, if the user is not in the group, return PAM_IGNORE (unless |
| 55 |
\fBtrust\fR |
| 56 |
was also specified, in which case we return PAM_SUCCESS)\&. |
| 57 |
.RE |
| 58 |
.PP |
| 59 |
group=name |
| 60 |
.RS 4 |
| 61 |
Instead of checking the wheel or GID 0 groups, use the |
| 62 |
\fB\fIname\fR\fR |
| 63 |
group to perform the authentication\&. |
| 64 |
.RE |
| 65 |
.PP |
| 66 |
root_only |
| 67 |
.RS 4 |
| 68 |
The check for wheel membership is done only when the target user UID is 0\&. |
| 69 |
.RE |
| 70 |
.PP |
| 71 |
trust |
| 72 |
.RS 4 |
| 73 |
The pam_wheel module will return PAM_SUCCESS instead of PAM_IGNORE if the user is a member of the wheel group (thus with a little play stacking the modules the wheel members may be able to su to root without being prompted for a passwd)\&. |
| 74 |
.RE |
| 75 |
.SH "MODULE TYPES PROVIDED" |
| 76 |
.PP |
| 77 |
The |
| 78 |
\fBauth\fR |
| 79 |
and |
| 80 |
\fBaccount\fR |
| 81 |
module types are provided\&. |
| 82 |
.SH "RETURN VALUES" |
| 83 |
.PP |
| 84 |
PAM_AUTH_ERR |
| 85 |
.RS 4 |
| 86 |
Authentication failure\&. |
| 87 |
.RE |
| 88 |
.PP |
| 89 |
PAM_BUF_ERR |
| 90 |
.RS 4 |
| 91 |
Memory buffer error\&. |
| 92 |
.RE |
| 93 |
.PP |
| 94 |
PAM_IGNORE |
| 95 |
.RS 4 |
| 96 |
The return value should be ignored by PAM dispatch\&. |
| 97 |
.RE |
| 98 |
.PP |
| 99 |
PAM_PERM_DENY |
| 100 |
.RS 4 |
| 101 |
Permission denied\&. |
| 102 |
.RE |
| 103 |
.PP |
| 104 |
PAM_SERVICE_ERR |
| 105 |
.RS 4 |
| 106 |
Cannot determine the user name\&. |
| 107 |
.RE |
| 108 |
.PP |
| 109 |
PAM_SUCCESS |
| 110 |
.RS 4 |
| 111 |
Success\&. |
| 112 |
.RE |
| 113 |
.PP |
| 114 |
PAM_USER_UNKNOWN |
| 115 |
.RS 4 |
| 116 |
User not known\&. |
| 117 |
.RE |
| 118 |
.SH "EXAMPLES" |
| 119 |
.PP |
| 120 |
The root account gains access by default (rootok), only wheel members can become root (wheel) but Unix authenticate non\-root applicants\&. |
| 121 |
.sp |
| 122 |
.if n \{\ |
| 123 |
.RS 4 |
| 124 |
.\} |
| 125 |
.nf |
| 126 |
su auth sufficient pam_rootok\&.so |
| 127 |
su auth required pam_wheel\&.so |
| 128 |
su auth required pam_unix\&.so |
| 129 |
|
| 130 |
.fi |
| 131 |
.if n \{\ |
| 132 |
.RE |
| 133 |
.\} |
| 134 |
.sp |
| 135 |
.SH "SEE ALSO" |
| 136 |
.PP |
| 137 |
\fBpam.conf\fR(5), |
| 138 |
\fBpam.d\fR(5), |
| 139 |
\fBpam\fR(7) |
| 140 |
.SH "AUTHOR" |
| 141 |
.PP |
| 142 |
pam_wheel was written by Cristian Gafton <gafton@redhat\&.com>\&. |