PAM_WHEEL(8)

  .SH "NAME" pam_wheel - Only permit root access to members of group wheel
  .SH "SYNOPSIS"
    .HP u
      pam_wheel.so
       [debug]
       [deny]
       [group=name]
       [root_only]
       [trust]
       [use_uid]

  .SH "DESCRIPTION"

    .PP The pam_wheel PAM module is used to enforce the so-called wheel group. By default it permits access to the target user if the applicant user is a member of the wheel group. If no group with this name exist, the module is using the group with the group-ID 0.

  .SH "OPTIONS"

      .PP debug

              Print debug information.

          .RE
          .PP deny

                  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 group option), deny access. Conversely, if the user is not in the group, return PAM_IGNORE (unless trust was also specified, in which case we return PAM_SUCCESS).

              .RE
              .PP group=name

                      Instead of checking the wheel or GID 0 groups, use the name group to perform the authentication.

                  .RE
                  .PP root_only

                          The check for wheel membership is done only when the target user UID is 0.

                      .RE
                      .PP trust

                              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).

                          .RE
                          .PP use_uid

                                  The check will be done against the real uid of the calling process, instead of trying to obtain the user from the login session associated with the terminal in use.

                              .RE

                          .SH "MODULE TYPES PROVIDED"

                            .PP The auth and account module types are provided.

                          .SH "RETURN VALUES"

                              .PP PAM_AUTH_ERR

                                       Authentication failure.

                                  .RE
                                  .PP PAM_BUF_ERR

                                           Memory buffer error.

                                      .RE
                                      .PP PAM_IGNORE

                                              The return value should be ignored by PAM dispatch.

                                          .RE
                                          .PP PAM_PERM_DENY

                                                  Permission denied.

                                              .RE
                                              .PP PAM_SERVICE_ERR

                                                      Cannot determine the user name.

                                                  .RE
                                                  .PP PAM_SUCCESS

                                                          Success.

                                                      .RE
                                                      .PP PAM_USER_UNKNOWN

                                                              User not known.

                                                          .RE

                                                      .SH "EXAMPLES"

                                                        .PP 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"

                                                        .PP pam.conf(5), pam.d(5), pam(8)

                                                      .SH "AUTHOR"

                                                          .PP pam_wheel was written by Cristian Gafton <gafton@redhat.com>.