NAME

pam_groupmember - test group membership

SYNOPSIS

pam_groupmember groups=GROUPLIST [sense=SENSE] [debug[=NUMBER]] [waitdebug] [audit]

DESCRIPTION

Tests if the user is member of at least one group from GROUPLIST. GROUPLIST is a comma-separated list of group names or IDs (numbers prefixed with a plus sign).

OPTIONS

groups=GROUPLIST

Defines a list of groups to check against. GROUPLIST is a comma-separated list of group names. A group name prefixed with a plus sign is treated as GID number.

sense=allow|deny

What to do if the user name matches the expression given by the regex option. The value allow (the default) instructs the module to return PAM_SUCCESS, the deny instructs it to return PAM_AUTH_ERR.

debug[=NUMBER]

Set debugging level (0 <= NUMBER <= 100).

audit

Log full debugging information (equivalent to debug=100).

waitdebug=N

Wait for N seconds before starting up. This option is intended to facilitate attaching to the module with gdb(1). It is available only if the package was configured with the --enable-debug option.

MODULE TYPES PROVIDED

All module types (account, auth, password and session) are provided.

RETURN VALUES

PAM_SUCCESS

Successful return.

PAM_AUTH_ERR

Authentication failed.

PAM_AUTHINFO_UNAVAIL

The input information is not sufficient.

PAM_USER_UNKNOWN

Supplied username not found.

EXAMPLES

auth required pam_groupmember.so groups=users,+80,ftp

NOTE

This manpage is a short description of pam_groupmember. For a detailed discussion, including examples and usage recommendations, refer to the PAM-modules Manual available in texinfo format. If the info reader and the tar documentation are properly installed on your system, the command

should give you access to the complete manual.

You can also view the manual using the info mode in emacs(1), or find it in various formats online at

If any discrepancies occur between this manpage and the PAM-modules Manual, the later shall be considered the authoritative source.

SEE ALSO

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

AUTHORS

Sergey Poznyakoff <gray@gnu.org>

BUG REPORTS

Report bugs to <bug-pam-modules@gnu.org.ua>.

COPYRIGHT

Copyright © 2001-2014 Sergey Poznyakoff
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.