Relevant BUGIDs:

Purpose of commit: new feature

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

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

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

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

        * modules/pam_deny/pam_deny.8.xml: Fix syntax errors.
        * modules/pam_deny/pam_deny.8: Regenerate from xml file.
        * modules/pam_deny/README: Likewise.

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

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

5 files changed, 522 insertions, 69 deletions

diff --git a/modules/pam_userdb/Makefile.am b/modules/pam_userdb/Makefile.am
index 6e6a94af..4b6f2569 100644
--- a/modules/pam_userdb/Makefile.am
+++ b/modules/pam_userdb/Makefile.am
@@ -4,7 +4,10 @@
 
 CLEANFILES = *~
 
-EXTRA_DIST = README create.pl tst-pam_userdb
+EXTRA_DIST = README (MANS) $(XMLS) create.pl tst-pam_userdb
+
+man_MANS = pam_userdb.8
+XMLS = README.xml pam_userdb.8.xml
 
 TESTS = tst-pam_userdb
 
@@ -23,3 +26,10 @@ if HAVE_LIBDB
 endif
 
 noinst_HEADERS = pam_userdb.h
+
+if ENABLE_REGENERATE_MAN
+noinst_DATA = README
+README: pam_userdb.8.xml
+-include $(top_srcdir)/Make.xml.rules
+endif
+
diff --git a/modules/pam_userdb/README b/modules/pam_userdb/README
index 0d74ecb2..8e1a5ffd 100644
--- a/modules/pam_userdb/README
+++ b/modules/pam_userdb/README
@@ -1,68 +1,74 @@
-pam_userdb:
-	Look up users in a .db database and verify their password against
-	what is contained in that database.  The database will have been
-	created using db_load.
-
-RECOGNIZED ARGUMENTS:
-	debug		write a message to syslog indicating success or
-			failure.
-
-	db=[path]	use the [path] database for performing lookup. There
-			is no default; the module will return PAM_IGNORE if
-			no database is provided.  Some versions of DB will
-			automatically append ".db" to whatever pathname you
-			supply here.
-			
-	crypt=[mode]	indicates whether encrypted or plaintext passwords
-	                are stored in the database.  If [mode] is "crypt", 
-			passwords should be stored in the database in 
-		        crypt(3) form.	If [mode] is "none" or any other 
-	                value, passwords should be stored in the database in
-			plaintext.
-
-	icase		make the password verification to be case insensitive
-			(ie when working with registration numbers and such)
-			only works with plaintext password storage.
-
-	dump		dump all the entries in the database to the log (eek,
-			don't do this by default!)
-
-	try_first_pass	use the authentication token previously obtained by
-			another module that did the conversation with the
-			application.  If this token can not be obtained then
-			the module will try to converse. This option can
-			be used for stacking different modules that need to
-			deal with the authentication tokens.
-
-	use_first_pass	use the authentication token previously obtained by
-			another module that did the conversation with the
-			application.  If this token can not be obtained then
-			the module will fail. This option can be used for
-			stacking different modules that need to	deal with
-			the authentication tokens.
-
-	unknown_ok	do not return error when checking for a user that is
-			not in the database. This can be used to stack more
-			than one pam_userdb module that will check a
-			username/password pair in more than a database.
-
-	key_only	the username and password are concatenated together
-			in the database hash as 'username-password' with a
-			random value.  if the concatenation of the username and
-			password with a dash in the middle returns any result,
-			the user is valid.  this is useful in cases where
-			the username may not be unique but the username and
-			password pair are.
-
-MODULE SERVICES PROVIDED:
-	auth		_authentication and _setcred (blank)
-
-EXAMPLE USE:
-	auth  sufficient pam_userdb.so icase db=/etc/dbtest.db
-
-AUTHOR:
-	Cristian Gafton <gafton@redhat.com>
-
-
-
-$Id$
+pam_userdb — PAM module to authenticate against a db database
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+DESCRIPTION
+
+The pam_userdb module is used to verify a username/password pair against values
+stored in a Berkeley DB database. The database is indexed by the username, and
+the data fields corresponding to the username keys are the passwords.
+
+OPTIONS
+
+crypt=[crypt|none]
+
+    Indicates whether encrypted or plaintext passwords are stored in the
+    database. If it is crypt, passwords should be stored in the database in
+    crypt(3) form. If none is selected, passwords should be stored in the
+    database as plaintext.
+
+db=/path/database
+
+    Use the /path/database database for performing lookup. There is no default;
+    the module will return PAM_IGNORE if no database is provided.
+
+debug
+
+    Print debug information.
+
+dump
+
+    Dump all the entries in the database to the log. Don't do this by default!
+
+icase
+
+    Make the password verification to be case insensitive (ie when working with
+    registration numbers and such). Only works with plaintext password storage.
+
+try_first_pass
+
+    Use the authentication token previously obtained by another module that did
+    the conversation with the application. If this token can not be obtained
+    then the module will try to converse. This option can be used for stacking
+    different modules that need to deal with the authentication tokens.
+
+use_first_pass
+
+    Use the authentication token previously obtained by another module that did
+    the conversation with the application. If this token can not be obtained
+    then the module will fail. This option can be used for stacking different
+    modules that need to deal with the authentication tokens.
+
+unknown_ok
+
+    Do not return error when checking for a user that is not in the database.
+    This can be used to stack more than one pam_userdb module that will check a
+    username/password pair in more than a database.
+
+key_only
+
+    The username and password are concatenated together in the database hash as
+    'username-password' with a random value. if the concatenation of the
+    username and password with a dash in the middle returns any result, the
+    user is valid. this is useful in cases where the username may not be unique
+    but the username and password pair are.
+
+EXAMPLES
+
+auth  sufficient pam_userdb.so icase db=/etc/dbtest.db
+
+
+AUTHOR
+
+pam_userdb was written by Cristian Gafton >gafton@redhat.com<.
+
diff --git a/modules/pam_userdb/README.xml b/modules/pam_userdb/README.xml
new file mode 100644
index 00000000..b22c09e7
--- /dev/null
+++ b/modules/pam_userdb/README.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding='UTF-8'?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+[
+<!--
+<!ENTITY pamaccess SYSTEM "pam_userdb.8.xml">
+-->
+]>
+
+<article>
+
+  <articleinfo>
+
+    <title>
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_userdb.8.xml" xpointer='xpointer(//refnamediv[@id = "pam_userdb-name"]/*)'/>
+    </title>
+
+  </articleinfo>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_userdb.8.xml" xpointer='xpointer(//refsect1[@id = "pam_userdb-description"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_userdb.8.xml" xpointer='xpointer(//refsect1[@id = "pam_userdb-options"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_userdb.8.xml" xpointer='xpointer(//refsect1[@id = "pam_userdb-examples"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_userdb.8.xml" xpointer='xpointer(//refsect1[@id = "pam_userdb-author"]/*)'/>
+  </section>
+
+</article>
diff --git a/modules/pam_userdb/pam_userdb.8 b/modules/pam_userdb/pam_userdb.8
new file mode 100644
index 00000000..b1ad6677
--- /dev/null
+++ b/modules/pam_userdb/pam_userdb.8
@@ -0,0 +1,104 @@
+.\"     Title: pam_userdb
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\"      Date: 06/07/2006
+.\"    Manual: Linux\-PAM Manual
+.\"    Source: Linux\-PAM Manual
+.\"
+.TH "PAM_USERDB" "8" "06/07/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+pam_userdb \- PAM module to authenticate against a db database
+.SH "SYNOPSIS"
+.HP 14
+\fBpam_userdb.so\fR db=\fI/path/database\fR [debug] [crypt=[crypt|none]] [icase] [dump] [try_first_pass] [use_first_pass] [unknown_ok] [key_only]
+.SH "DESCRIPTION"
+.PP
+The pam_userdb module is used to verify a username/password pair against values stored in a Berkeley DB database. The database is indexed by the username, and the data fields corresponding to the username keys are the passwords.
+.SH "OPTIONS"
+.TP 3n
+\fBcrypt=[crypt|none]\fR
+Indicates whether encrypted or plaintext passwords are stored in the database. If it is
+\fBcrypt\fR, passwords should be stored in the database in
+\fBcrypt\fR(3)
+form. If
+\fBnone\fR
+is selected, passwords should be stored in the database as plaintext.
+.TP 3n
+\fBdb=\fR\fB\fI/path/database\fR\fR
+Use the
+\fI/path/database\fR
+database for performing lookup. There is no default; the module will return
+\fBPAM_IGNORE\fR
+if no database is provided.
+.TP 3n
+\fBdebug\fR
+Print debug information.
+.TP 3n
+\fBdump\fR
+Dump all the entries in the database to the log. Don't do this by default!
+.TP 3n
+\fBicase\fR
+Make the password verification to be case insensitive (ie when working with registration numbers and such). Only works with plaintext password storage.
+.TP 3n
+\fBtry_first_pass\fR
+Use the authentication token previously obtained by another module that did the conversation with the application. If this token can not be obtained then the module will try to converse. This option can be used for stacking different modules that need to deal with the authentication tokens.
+.TP 3n
+\fBuse_first_pass\fR
+Use the authentication token previously obtained by another module that did the conversation with the application. If this token can not be obtained then the module will fail. This option can be used for stacking different modules that need to deal with the authentication tokens.
+.TP 3n
+\fBunknown_ok\fR
+Do not return error when checking for a user that is not in the database. This can be used to stack more than one pam_userdb module that will check a username/password pair in more than a database.
+.TP 3n
+\fBkey_only\fR
+The username and password are concatenated together in the database hash as 'username\-password' with a random value. if the concatenation of the username and password with a dash in the middle returns any result, the user is valid. this is useful in cases where the username may not be unique but the username and password pair are.
+.SH "MODULE SERVICES PROVIDED"
+.PP
+The services
+\fBauth\fR
+and
+\fBaccount\fR
+are supported.
+.SH "RETURN VALUES"
+.TP 3n
+PAM_AUTH_ERR
+Authentication failure.
+.TP 3n
+PAM_AUTHTOK_RECOVERY_ERR
+Authentication information cannot be recovered.
+.TP 3n
+PAM_BUF_ERR
+Memory buffer error.
+.TP 3n
+PAM_CONV_ERR
+Conversation failure.
+.TP 3n
+PAM_SERVICE_ERR
+Error in service module.
+.TP 3n
+PAM_SUCCESS
+Success.
+.TP 3n
+PAM_USER_UNKNOWN
+User not known to the underlying authentication module.
+.SH "EXAMPLES"
+.sp
+.RS 3n
+.nf
+auth  sufficient pam_userdb.so icase db=/etc/dbtest.db
+    
+.fi
+.RE
+.SH "SEE ALSO"
+.PP
+
+\fBcrypt\fR(3),
+\fBpam.conf\fR(5),
+\fBpam.d\fR(8),
+\fBpam\fR(8)
+.SH "AUTHOR"
+.PP
+pam_userdb was written by Cristian Gafton >gafton@redhat.com<.
diff --git a/modules/pam_userdb/pam_userdb.8.xml b/modules/pam_userdb/pam_userdb.8.xml
new file mode 100644
index 00000000..70b416b3
--- /dev/null
+++ b/modules/pam_userdb/pam_userdb.8.xml
@@ -0,0 +1,292 @@
+<?xml version="1.0" encoding='UTF-8'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+
+<refentry id="pam_userdb">
+
+  <refmeta>
+    <refentrytitle>pam_userdb</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
+  </refmeta>
+
+  <refnamediv id="pam_userdb-name">
+    <refname>pam_userdb</refname>
+    <refpurpose>PAM module to authenticate against a db database</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis id="pam_userdb-cmdsynopsis">
+      <command>pam_userdb.so</command>
+      <arg choice="plain">
+	db=<replaceable>/path/database</replaceable>
+      </arg>
+      <arg choice="opt">
+	debug
+      </arg>
+      <arg choice="opt">
+        crypt=[crypt|none]
+      </arg>
+      <arg choice="opt">
+        icase
+      </arg>
+      <arg choice="opt">
+        dump
+      </arg>
+      <arg choice="opt">
+        try_first_pass
+      </arg>
+      <arg choice="opt">
+        use_first_pass
+      </arg>
+      <arg choice="opt">
+        unknown_ok
+      </arg>
+      <arg choice="opt">
+        key_only
+      </arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id="pam_userdb-description">
+
+    <title>DESCRIPTION</title>
+
+    <para>
+      The pam_userdb module is used to verify a username/password pair
+      against values stored in a Berkeley DB database. The database is
+      indexed by the username, and the data fields corresponding to the
+      username keys are the passwords.
+    </para>
+  </refsect1>
+
+  <refsect1 id="pam_userdb-options">
+
+    <title>OPTIONS</title>
+    <variablelist>
+      <varlistentry>
+        <term>
+          <option>crypt=[crypt|none]</option>
+        </term>
+        <listitem>
+          <para>
+            Indicates whether encrypted or plaintext passwords are stored
+            in the database.  If it is <option>crypt</option>, passwords
+            should be stored in the database in
+            <citerefentry>
+	      <refentrytitle>crypt</refentrytitle><manvolnum>3</manvolnum>
+            </citerefentry> form.  If <option>none</option> is selected,
+            passwords should be stored in the database as plaintext.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>db=<replaceable>/path/database</replaceable></option>
+        </term>
+        <listitem>
+          <para>
+            Use the <filename>/path/database</filename> database for
+            performing lookup. There is no default; the module will
+            return <emphasis remap='B'>PAM_IGNORE</emphasis> if no
+            database is provided.
+          </para>
+        </listitem>
+      </varlistentry>
+       <varlistentry>
+        <term>
+          <option>debug</option>
+        </term>
+        <listitem>
+          <para>
+            Print debug information.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>dump</option>
+        </term>
+        <listitem>
+          <para>
+            Dump all the entries in the database to the log.
+            Don't do this by default!
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>icase</option>
+        </term>
+        <listitem>
+          <para>
+            Make the password verification to be case insensitive
+            (ie when working with registration numbers and such).
+            Only works with plaintext password storage.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>
+          <option>try_first_pass</option>
+        </term>
+        <listitem>
+          <para>
+            Use the authentication token previously obtained by
+            another module that did the conversation with the
+            application.  If this token can not be obtained then
+            the module will try to converse. This option can
+            be used for stacking different modules that need to
+            deal with the authentication tokens.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>use_first_pass</option>
+        </term>
+        <listitem>
+          <para>
+            Use the authentication token previously obtained by
+            another module that did the conversation with the
+            application.  If this token can not be obtained then
+            the module will fail. This option can be used for
+            stacking different modules that need to deal with
+            the authentication tokens.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>unknown_ok</option>
+        </term>
+        <listitem>
+          <para>
+            Do not return error when checking for a user that is
+            not in the database. This can be used to stack more
+            than one pam_userdb module that will check a
+            username/password pair in more than a database.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>key_only</option>
+        </term>
+        <listitem>
+          <para>
+            The username and password are concatenated together
+            in the database hash as 'username-password' with a
+            random value.  if the concatenation of the username and
+            password with a dash in the middle returns any result,
+            the user is valid.  this is useful in cases where
+            the username may not be unique but the username and
+            password pair are.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id="pam_userdb-services">
+    <title>MODULE SERVICES PROVIDED</title>
+    <para>
+      The services <option>auth</option> and <option>account</option>
+      are supported.
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_userdb-return_values'>
+    <title>RETURN VALUES</title>
+    <variablelist>
+      <varlistentry>
+        <term>PAM_AUTH_ERR</term>
+        <listitem>
+          <para>Authentication failure.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_AUTHTOK_RECOVERY_ERR</term>
+        <listitem>
+          <para>
+            Authentication information cannot be recovered.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_BUF_ERR</term>
+        <listitem>
+           <para>
+             Memory buffer error.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_CONV_ERR</term>
+        <listitem>
+           <para>
+             Conversation failure.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_SERVICE_ERR</term>
+        <listitem>
+          <para>
+             Error in service module.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_SUCCESS</term>
+        <listitem>
+          <para>
+            Success.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_USER_UNKNOWN</term>
+        <listitem>
+          <para>
+            User not known to the underlying authentication module.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id='pam_userdb-examples'>
+    <title>EXAMPLES</title>
+    <programlisting>
+auth  sufficient pam_userdb.so icase db=/etc/dbtest.db
+    </programlisting>
+  </refsect1>
+
+  <refsect1 id='pam_userdb-see_also'>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+	<refentrytitle>crypt</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+	<refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+	<refentrytitle>pam.d</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+	<refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_userdb-author'>
+    <title>AUTHOR</title>
+      <para>
+        pam_userdb was written by Cristian Gafton &gt;gafton@redhat.com&lt;.
+      </para>
+  </refsect1>
+
+</refentry>