Relevant BUGIDs: 1427738

Purpose of commit: new feature/bugfix

Commit summary:
---------------

2006-06-02  Thorsten Kukuk  <kukuk@thkukuk.de>

        * doc/man/PAM.8: Regenerate with DocBook XSL Stylesheets v1.70.1.
        * doc/man/pam.3: Likewise.
        * doc/man/pam.conf.5: Likewise.
        * doc/man/pam_acct_mgmt.3: Likewise.
        * doc/man/pam_authenticate.3: Likewise.
        * doc/man/pam_chauthtok.3: Likewise.
        * doc/man/pam_close_session.3: Likewise.
        * doc/man/pam_conv.3: Likewise.
        * doc/man/pam_end.3: Likewise.
        * doc/man/pam_error.3: Likewise.
        * doc/man/pam_fail_delay.3: Likewise.
        * doc/man/pam_get_data.3: Likewise.
        * doc/man/pam_get_item.3: Likewise.
        * doc/man/pam_get_user.3: Likewise.
        * doc/man/pam_getenv.3: Likewise.
        * doc/man/pam_getenvlist.3: Likewise.
        * doc/man/pam_info.3: Likewise.
        * doc/man/pam_open_session.3: Likewise.
        * doc/man/pam_prompt.3: Likewise.
        * doc/man/pam_putenv.3: Likewise.
        * doc/man/pam_set_data.3: Likewise.
        * doc/man/pam_set_item.3: Likewise.
        * doc/man/pam_setcred.3: Likewise.
        * doc/man/pam_sm_acct_mgmt.3: Likewise.
        * doc/man/pam_start.3: Likewise.
        * doc/man/pam_strerror.3: Likewise.
        * doc/man/pam_syslog.3: Likewise.
        * modules/pam_access/access.conf.5: Likewise.
        * modules/pam_access/pam_access.8: Likewise.
        * modules/pam_cracklib/pam_cracklib.8: Likewise.
        * modules/pam_deny/pam_deny.8: Likewise.
        * modules/pam_echo/pam_echo.8: Likewise.
        * modules/pam_env/pam_env.8: Likewise.
        * modules/pam_env/pam_env.conf.5: Likewise.
        * modules/pam_exec/pam_exec.8: Likewise.
        * modules/pam_filter/pam_filter.8: Likewise.
        * modules/pam_ftp/pam_ftp.8: Likewise.
        * modules/pam_group/group.conf.5: Likewise.
        * modules/pam_group/pam_group.8: Likewise.
        * modules/pam_issue/pam_issue.8: Likewise.
        * modules/pam_lastlog/pam_lastlog.8: Likewise.
        * modules/pam_mkhomedir/pam_mkhomedir.8: Likewise.
        * modules/pam_succeed_if/pam_succeed_if.8: Likewise.
        * modules/pam_umask/pam_umask.8: Likewise.

        * modules/pam_unix/pam_unix_acct.c (pam_sm_acct_mgmt): Use
        dngettext if available [#1427738].
        * configure.in: Check for dngettext [#1427738].
        * po/*.po: Update to dngettext usage.

        * modules/pam_listfile/Makefile.am: Include Make.xml.rules.
        * modules/pam_listfile/pam_listfile.8.xml: New.
        * modules/pam_listfile/pam_listfile.8: New, generated from xml file.
        * modules/pam_listfile/README.xml: New.
        * modules/pam_listfile/README: Regenerated from xml file.

1 files changed, 164 insertions, 0 deletions

diff --git a/modules/pam_listfile/pam_listfile.8 b/modules/pam_listfile/pam_listfile.8
new file mode 100644
index 00000000..826d337e
--- /dev/null
+++ b/modules/pam_listfile/pam_listfile.8
@@ -0,0 +1,164 @@
+.\"     Title: pam_listfile
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\"      Date: 06/02/2006
+.\"    Manual: Linux\-PAM Manual
+.\"    Source: Linux\-PAM Manual
+.\"
+.TH "PAM_LISTFILE" "8" "06/02/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+pam_listfile \- deny or allow services based on an arbitrary file.
+.SH "SYNOPSIS"
+.HP 16
+\fBpam_listfile.so\fR item=[tty|user|rhost|ruser|group|shell] sense=[allow|deny] file=\fI/path/filename\fR onerr=[succeed|fail] [apply=[\fIuser\fR|\fI@group\fR]]
+.SH "DESCRIPTION"
+.PP
+pam_listfile is a PAM module which provides a way to deny or allow services based on an arbitrary file.
+.PP
+The module gets the
+\fBitem\fR
+of the type specified \-\-
+\fIuser\fR
+specifies the username,
+\fIPAM_USER\fR; tty specifies the name of the terminal over which the request has been made,
+\fIPAM_TTY\fR; rhost specifies the name of the remote host (if any) from which the request was made,
+\fIPAM_RHOST\fR; and ruser specifies the name of the remote user (if available) who made the request,
+\fIPAM_RUSER\fR
+\-\- and looks for an instance of that item in the
+\fBfile=\fR\fB\fIfilename\fR\fR.
+\fIfilename\fR
+contains one line per item listed. If the item is found, then if
+\fBsense=\fR\fB\fIallow\fR\fR,
+\fIPAM_SUCCESS\fR
+is returned, causing the authorization request to succeed; else if
+\fBsense=\fR\fB\fIdeny\fR\fR,
+\fIPAM_AUTH_ERR\fR
+is returned, causing the authorization request to fail.
+.PP
+If an error is encountered (for instance, if
+\fIfilename\fR
+does not exist, or a poorly\-constructed argument is encountered), then if
+\fIonerr=succeed\fR,
+\fIPAM_SUCCESS\fR
+is returned, otherwise if
+\fIonerr=fail\fR,
+\fIPAM_AUTH_ERR\fR
+or
+\fIPAM_SERVICE_ERR\fR
+(as appropriate) will be returned.
+.PP
+An additional argument,
+\fBapply=\fR, can be used to restrict the application of the above to a specific user (\fBapply=\fR\fB\fIusername\fR\fR) or a given group (\fBapply=\fR\fB\fI@groupname\fR\fR). This added restriction is only meaningful when used with the
+\fItty\fR,
+\fIrhost\fR
+and
+\fIshell\fR
+items.
+.PP
+Besides this last one, all arguments should be specified; do not count on any default behavior.
+.PP
+No credentials are awarded by this module.
+.SH "OPTIONS"
+.PP
+.TP 3n
+\fBitem=[tty|user|rhost|ruser|group|shell]\fR
+What is listed in the file and should be checked for.
+.TP 3n
+\fBsense=[allow|deny]\fR
+Action to take if found in file, if the item is NOT found in the file, then the opposite action is requested.
+.TP 3n
+\fBfile=\fR\fB\fI/path/filename\fR\fR
+File containing one item per line. The file needs to be a plain file and not world writeable.
+.TP 3n
+\fBonerr=[succeed|fail]\fR
+What to do if something weird happens like being unable to open the file.
+.TP 3n
+\fBapply=[\fR\fB\fIuser\fR\fR\fB|\fR\fB\fI@group\fR\fR\fB]\fR
+Restrict the user class for which the restriction apply. Note that with
+\fBitem=[user|ruser|group]\fR
+this oes not make sense, but for
+\fBitem=[tty|rhost|shell]\fR
+it have a meaning.
+.SH "MODULE SERVICES PROVIDED"
+.PP
+The services
+\fBauth\fR,
+\fBaccount\fR,
+\fBpassword\fR
+and
+\fBsession\fR
+are supported.
+.SH "RETURN VALUES"
+.PP
+.TP 3n
+PAM_AUTH_ERR
+Authentication failure.
+.TP 3n
+PAM_BUF_ERR
+Memory buffer error.
+.TP 3n
+PAM_IGNORE
+The rule does not apply to the
+\fBapply\fR
+option.
+.TP 3n
+PAM_SERVICE_ERR
+Error in service module.
+.TP 3n
+PAM_SUCCESS
+Success.
+.SH "EXAMPLES"
+.PP
+Classic 'ftpusers' authentication can be implemented with this entry in
+\fI/etc/pam.d/ftpd\fR:
+.sp
+.RS 3n
+.nf
+#
+# deny ftp\-access to users listed in the /etc/ftpusers file
+#
+auth    required       pam_listfile.so \\
+        onerr=succeed item=user sense=deny file=/etc/ftpusers
+      
+.fi
+.RE
+.sp
+Note, users listed in
+\fI/etc/ftpusers\fR
+file are (counterintuitively)
+\fInot\fR
+allowed access to the ftp service.
+.PP
+To allow login access only for certain users, you can use a
+\fI/etc/pam.d/login\fR
+entry like this:
+.sp
+.RS 3n
+.nf
+#
+# permit login to users listed in /etc/loginusers
+#
+auth    required       pam_listfile.so \\
+        onerr=fail item=user sense=allow file=/etc/loginusers
+      
+.fi
+.RE
+.sp
+For this example to work, all users who are allowed to use the login service should be listed in the file
+\fI/etc/loginusers\fR. Unless you are explicitly trying to lock out root, make sure that when you do this, you leave a way for root to log in, either by listing root in
+\fI/etc/loginusers\fR, or by listing a user who is able to
+\fIsu\fR
+to the root account.
+.SH "SEE ALSO"
+.PP
+
+\fBpam.conf\fR(5),
+\fBpam.d\fR(8),
+\fBpam\fR(8)
+.SH "AUTHOR"
+.PP
+pam_listfile was written by Michael K. Johnson <johnsonm@redhat.com> and Elliot Lee <sopwith@cuc.edu>.