Relevant BUGIDs:

Purpose of commit: new feature

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

2007-07-16  Thorsten Kukuk  <kukuk@thkukuk.de>

        * doc/man/pam.conf-syntax.xml: Improve documentation about
        sufficient keyword (Patch by Petteri Räty <betelgeuse@gentoo.org>)

2 files changed, 68 insertions, 28 deletions

diff --git a/doc/man/pam.conf-syntax.xml b/doc/man/pam.conf-syntax.xml
index b422cba9..60c64b75 100644
--- a/doc/man/pam.conf-syntax.xml
+++ b/doc/man/pam.conf-syntax.xml
@@ -155,7 +155,9 @@
             prior <emphasis>required</emphasis> module has failed the
             success of this one is <emphasis>ignored</emphasis>). A failure
             of this module is not deemed as fatal to satisfying the
-            application that this type has succeeded.
+            application that this type has succeeded. If the module succeeds 
+            the PAM framework returns success to the application immediately
+            without trying any other modules.
           </para>
         </listitem>
       </varlistentry>
diff --git a/doc/man/pam.conf.5 b/doc/man/pam.conf.5
index 2ea40185..3a76ba45 100644
--- a/doc/man/pam.conf.5
+++ b/doc/man/pam.conf.5
@@ -1,11 +1,11 @@
 .\"     Title: pam.conf
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\"      Date: 06/27/2006
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
+.\"      Date: 01/16/2007
 .\"    Manual: Linux\-PAM Manual
 .\"    Source: Linux\-PAM Manual
 .\"
-.TH "PAM.CONF" "5" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.TH "PAM.CONF" "5" "01/16/2007" "Linux\-PAM Manual" "Linux\-PAM Manual"
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -67,18 +67,26 @@ entries) will be associated with the given service\-application.
 The
 \fItype\fR
 is the management group that the rule corresponds to. It is used to specify which of the management groups the subsequent module is to be associated with. Valid entries are:
-.TP 3n
+.PP
 account
+.RS 4
 this module type performs non\-authentication based account management. It is typically used to restrict/permit access to a service based on the time of day, currently available system resources (maximum number of users) or perhaps the location of the applicant user \-\- 'root' login only on the console.
-.TP 3n
+.RE
+.PP
 auth
+.RS 4
 this module type provides two aspects of authenticating the user. Firstly, it establishes that the user is who they claim to be, by instructing the application to prompt the user for a password or other means of identification. Secondly, the module can grant group membership or other privileges through its credential granting properties.
-.TP 3n
+.RE
+.PP
 password
+.RS 4
 this module type is required for updating the authentication token associated with the user. Typically, there is one module for each 'challenge/response' based authentication (auth) type.
-.TP 3n
+.RE
+.PP
 session
+.RS 4
 this module type is associated with doing things that need to be done for the user before/after they can be given service. Such things include the logging of information concerning the opening/closing of some data exchange with a user, mounting directories, etc.
+.RE
 .PP
 The third field,
 \fIcontrol\fR, indicates the behavior of the PAM\-API should the module fail to succeed in its authentication task. There are two types of syntax for this control field: the simple one has a single simple keyword; the more complicated one involves a square\-bracketed selection of
@@ -88,37 +96,47 @@ pairs.
 For the simple (historical) syntax valid
 \fIcontrol\fR
 values are:
-.TP 3n
+.PP
 required
+.RS 4
 failure of such a PAM will ultimately lead to the PAM\-API returning failure but only after the remaining
 \fIstacked\fR
 modules (for this
 \fIservice\fR
 and
 \fItype\fR) have been invoked.
-.TP 3n
+.RE
+.PP
 requisite
+.RS 4
 like
 \fIrequired\fR, however, in the case that such a module returns a failure, control is directly returned to the application. The return value is that associated with the first required or requisite module to fail. Note, this flag can be used to protect against the possibility of a user getting the opportunity to enter a password over an unsafe medium. It is conceivable that such behavior might inform an attacker of valid accounts on a system. This possibility should be weighed against the not insignificant concerns of exposing a sensitive password in a hostile environment.
-.TP 3n
+.RE
+.PP
 sufficient
+.RS 4
 success of such a module is enough to satisfy the authentication requirements of the stack of modules (if a prior
 \fIrequired\fR
 module has failed the success of this one is
-\fIignored\fR). A failure of this module is not deemed as fatal to satisfying the application that this type has succeeded.
-.TP 3n
+\fIignored\fR). A failure of this module is not deemed as fatal to satisfying the application that this type has succeeded. If the module succeeds the PAM framework returns success to the application immediately without trying any other modules.
+.RE
+.PP
 optional
+.RS 4
 the success or failure of this module is only important if it is the only module in the stack associated with this
 \fIservice\fR+\fItype\fR.
-.TP 3n
+.RE
+.PP
 include
+.RS 4
 include all lines of given type from the configuration file specified as an argument to this control.
+.RE
 .PP
 For the more complicated syntax valid
 \fIcontrol\fR
 values have the following form:
 .sp
-.RS 3n
+.RS 4
 .nf
       [value1=action1 value2=action2 ...]
     
@@ -170,39 +188,59 @@ can be: an unsigned integer,
 \fIn\fR, signifying an action of 'jump over the next
 \fIn\fR
 modules in the stack', or take one of the following forms:
-.TP 3n
+.PP
 ignore
+.RS 4
 when used with a stack of modules, the module's return status will not contribute to the return code the application obtains.
-.TP 3n
+.RE
+.PP
 bad
+.RS 4
 this action indicates that the return code should be thought of as indicative of the module failing. If this module is the first in the stack to fail, its status value will be used for that of the whole stack.
-.TP 3n
+.RE
+.PP
 die
+.RS 4
 equivalent to bad with the side effect of terminating the module stack and PAM immediately returning to the application.
-.TP 3n
+.RE
+.PP
 ok
+.RS 4
 this tells PAM that the administrator thinks this return code should contribute directly to the return code of the full stack of modules. In other words, if the former state of the stack would lead to a return of
 \fIPAM_SUCCESS\fR, the module's return code will override this value. Note, if the former state of the stack holds some value that is indicative of a modules failure, this 'ok' value will not be used to override that value.
-.TP 3n
+.RE
+.PP
 done
+.RS 4
 equivalent to ok with the side effect of terminating the module stack and PAM immediately returning to the application.
-.TP 3n
+.RE
+.PP
 reset
+.RS 4
 clear all memory of the state of the module stack and start again with the next stacked module.
+.RE
 .PP
 Each of the four keywords: required; requisite; sufficient; and optional, have an equivalent expression in terms of the [...] syntax. They are as follows:
-.TP 3n
+.PP
 required
+.RS 4
 [success=ok new_authtok_reqd=ok ignore=ignore default=bad]
-.TP 3n
+.RE
+.PP
 requisite
+.RS 4
 [success=ok new_authtok_reqd=ok ignore=ignore default=die]
-.TP 3n
+.RE
+.PP
 sufficient
+.RS 4
 [success=done new_authtok_reqd=done default=ignore]
-.TP 3n
+.RE
+.PP
 optional
+.RS 4
 [success=ok new_authtok_reqd=ok default=ignore]
+.RE
 .PP
 
 \fImodule\-path\fR
@@ -215,7 +253,7 @@ or
 \fImodule\-arguments\fR
 are a space separated list of tokens that can be used to modify the specific behavior of the given PAM. Such arguments will be documented for each individual module. Note, if you wish to include spaces in an argument, you should surround that argument with square brackets.
 .sp
-.RS 3n
+.RS 4
 .nf
     squid auth required pam_mysql.so user=passwd_query passwd=mada \\
           db=eminence [query=select user_name from internet_service \\
@@ -227,7 +265,7 @@ are a space separated list of tokens that can be used to modify the specific beh
 .PP
 When using this convention, you can include `[' characters inside the string, and if you wish to include a `]' character inside the string that will survive the argument parsing, you should use `\\['. In other words:
 .sp
-.RS 3n
+.RS 4
 .nf
     [..[..\\]..]    \-\->   ..[..]..
     
@@ -245,7 +283,7 @@ The syntax of each file in /etc/pam.d/ is similar to that of the
 \fI/etc/pam.conf\fR
 file and is made up of lines of the following form:
 .sp
-.RS 3n
+.RS 4
 .nf
 type  control  module\-path  module\-arguments