Diffstat (limited to 'modules/pam_wheel/pam_wheel.8')
1 files changed, 101 insertions, 0 deletions
diff --git a/modules/pam_wheel/pam_wheel.8 b/modules/pam_wheel/pam_wheel.8
new file mode 100644
@@ -0,0 +1,101 @@
+.\" Title: pam_wheel
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\" Date: 06/09/2006
+.\" Manual: Linux\-PAM Manual
+.\" Source: Linux\-PAM Manual
+.TH "PAM_WHEEL" "8" "06/09/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.\" disable justification (adjust text to left margin only)
+pam_wheel \- Only permit root access to members of group wheel
+\fBpam_wheel.so\fR [debug] [deny] [group=\fIname\fR] [root_only] [trust] [use_uid]
+The pam_wheel PAM module is used to enforce the so\-called
+group. By default it permits root access to the system if the applicant user is a member of the
+group. If no group with this name exist, the module is using the group with the group\-ID
+Print debug information.
+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
+option), deny access. Conversely, if the user is not in the group, return PAM_IGNORE (unless
+was also specified, in which case we return PAM_SUCCESS).
+Instead of checking the wheel or GID 0 groups, use the
+group to perform the authentification.
+The check for wheel membership is done only.
+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).
+The check for wheel membership will be done against the current uid instead of the original one (useful when jumping with su from one account to another for example).
+.SH "MODULE SERVICES PROVIDED"
+services are supported.
+.SH "RETURN VALUES"
+Memory buffer error.
+The return value should be ignored by PAM dispatch.
+Cannot determine the user name.
+User not known.
+The root account gains access by default (rootok), only wheel members can become root (wheel) but Unix authenticate non\-root applicants.
+su auth sufficient pam_rootok.so
+su auth required pam_wheel.so
+su auth required pam_unix.so
+.SH "SEE ALSO"
+pam_wheel was written by Cristian Gafton <email@example.com>.