From: Graham Leggett <minfrin@apache.org>
Date: Sat, 1 Sep 2007 14:24:55 +0000 (+0000)
Subject: Add docs for the AUTHENTICATE_ prefixed exposure of login attributes during
X-Git-Tag: 2.3.0~1483
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ed3e6b8562cb1e2425d9222d00d5b5ded48c068d;p=apache

Add docs for the AUTHENTICATE_ prefixed exposure of login attributes during
AAA.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@571804 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/mod_authn_dbd.xml b/docs/manual/mod/mod_authn_dbd.xml
index aac4197624..521a39f09f 100644
--- a/docs/manual/mod/mod_authn_dbd.xml
+++ b/docs/manual/mod/mod_authn_dbd.xml
@@ -95,6 +95,23 @@ DBDExptime 60</code>
 </example>
 </section>
 
+<section id="exposed">
+<title>Exposing Login Information</title>
+<p>
+Whenever a query is made to the database server, all columns returned by
+the query are placed in the environment, using environment variables with
+the prefix "AUTHENTICATE_".
+</p>
+<p>If a database query for example returned the username, full name
+and telephone number of a user, a CGI program will have access to
+this information without the need to make a second independent database
+query to gather this additional information.</p>
+</p>
+<p>This has the potential to dramatically simplify the coding and
+configuration required in some web applications.
+</p>
+</section>
+
 <directivesynopsis>
 <name>AuthDBDUserPWQuery</name>
 <description>SQL query to look up a password for a user</description>
diff --git a/docs/manual/mod/mod_authnz_ldap.xml b/docs/manual/mod/mod_authnz_ldap.xml
index 0bbccf4c39..7935baad10 100644
--- a/docs/manual/mod/mod_authnz_ldap.xml
+++ b/docs/manual/mod/mod_authnz_ldap.xml
@@ -96,6 +96,7 @@ for HTTP Basic authentication.</description>
       <li><a href="#examples">Examples</a></li>
       <li><a href="#usingtls">Using TLS</a></li>
       <li><a href="#usingssl">Using SSL</a></li>
+      <li><a href="#exposed">Exposing Login Information</a></li>
       <li><a href="#activedirectory">Using Active Directory</a></li>
       <li>
         <a href="#frontpage">Using Microsoft FrontPage with
@@ -559,6 +560,22 @@ Require valid-user
     directive, instead of <em>ldap://</em>.</p>
 </section>
 
+<section id="exposed"><title>Exposing Login Information</title>
+
+    <p>Whenever a query is made to the LDAP server, all LDAP attributes
+    returned by the query are placed in the environment, using environment
+    variables with the prefix "AUTHENTICATE_".</p>
+
+    <p>If an LDAP query for example returned the username, common name
+    and telephone number of a user, a CGI program will have access to
+    this information without the need to make a second independent LDAP
+    query to gather this additional information.</p>
+
+    <p>This has the potential to dramatically simplify the coding and
+    configuration required in some web applications.</p>
+
+</section>
+
 <section id="activedirectory"><title>Using Active Directory</title>
 
     <p>An Active Directory installation may support multiple domains at the