home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277997_mod_auth_ldap.html.en < prev    next >
Extensible Markup Language  |  2004-05-21  |  49KB  |  858 lines
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>mod_auth_ldap - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16. <p class="apache">Apache HTTP Server Version 2.0</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache Module mod_auth_ldap</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../en/mod/mod_auth_ldap.html" title="English"> en </a></p>
  25. </div>
  26. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Allows an LDAP directory to be used to store the database
  27. for HTTP Basic authentication.</td></tr>
  28. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  29. <tr><th><a href="module-dict.html#ModuleIdentifier">ModuleáIdentifier:</a></th><td>auth_ldap_module</td></tr>
  30. <tr><th><a href="module-dict.html#SourceFile">SourceáFile:</a></th><td>mod_auth_ldap.c</td></tr>
  31. <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.41 and later</td></tr></table>
  32. <h3>Summary</h3>
  33.  
  34.     <p><code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> supports the following features:</p>
  35.  
  36.     <ul>
  37.       <li>Known to support the <a href="http://www.openldap.org/">OpenLDAP SDK</a> (both 1.x
  38.       and 2.x), <a href="http://developer.novell.com/ndk/cldap.htm">
  39.       Novell LDAP SDK</a> and the <a href="http://www.iplanet.com/downloads/developer/">iPlanet
  40.       (Netscape)</a> SDK.</li>
  41.  
  42.       <li>Complex authorization policies can be implemented by
  43.       representing the policy with LDAP filters.</li>
  44.  
  45.       <li>Support for Microsoft FrontPage allows FrontPage users to
  46.       control access to their webs, while retaining LDAP for user
  47.       authentication.</li>
  48.  
  49.       <li>Uses extensive caching of LDAP operations via <a href="mod_ldap.html">mod_ldap</a>.</li>
  50.  
  51.       <li>Support for LDAP over SSL (requires the Netscape SDK) or
  52.       TLS (requires the OpenLDAP 2.x SDK or Novell LDAP SDK).</li>
  53.     </ul>
  54. </div>
  55. <div id="quickview"><h3 class="directives">Directives</h3>
  56. <ul id="toc">
  57. <li><img alt="" src="../images/down.gif" /> <a href="#authldapauthoritative">AuthLDAPAuthoritative</a></li>
  58. <li><img alt="" src="../images/down.gif" /> <a href="#authldapbinddn">AuthLDAPBindDN</a></li>
  59. <li><img alt="" src="../images/down.gif" /> <a href="#authldapbindpassword">AuthLDAPBindPassword</a></li>
  60. <li><img alt="" src="../images/down.gif" /> <a href="#authldapcharsetconfig">AuthLDAPCharsetConfig</a></li>
  61. <li><img alt="" src="../images/down.gif" /> <a href="#authldapcomparednonserver">AuthLDAPCompareDNOnServer</a></li>
  62. <li><img alt="" src="../images/down.gif" /> <a href="#authldapdereferencealiases">AuthLDAPDereferenceAliases</a></li>
  63. <li><img alt="" src="../images/down.gif" /> <a href="#authldapenabled">AuthLDAPEnabled</a></li>
  64. <li><img alt="" src="../images/down.gif" /> <a href="#authldapfrontpagehack">AuthLDAPFrontPageHack</a></li>
  65. <li><img alt="" src="../images/down.gif" /> <a href="#authldapgroupattribute">AuthLDAPGroupAttribute</a></li>
  66. <li><img alt="" src="../images/down.gif" /> <a href="#authldapgroupattributeisdn">AuthLDAPGroupAttributeIsDN</a></li>
  67. <li><img alt="" src="../images/down.gif" /> <a href="#authldapremoteuserisdn">AuthLDAPRemoteUserIsDN</a></li>
  68. <li><img alt="" src="../images/down.gif" /> <a href="#authldapurl">AuthLDAPUrl</a></li>
  69. </ul>
  70. <h3>Topics</h3>
  71. <ul id="topics">
  72. <li><img alt="" src="../images/down.gif" /> <a href="#contents">Contents</a></li>
  73. <li><img alt="" src="../images/down.gif" /> <a href="#operation">Operation</a></li>
  74. <li><img alt="" src="../images/down.gif" /> <a href="#requiredirectives">The require Directives</a></li>
  75. <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  76. <li><img alt="" src="../images/down.gif" /> <a href="#usingtls">Using TLS</a></li>
  77. <li><img alt="" src="../images/down.gif" /> <a href="#usingssl">Using SSL</a></li>
  78. <li><img alt="" src="../images/down.gif" /> <a href="#frontpage">Using Microsoft
  79.     FrontPage with mod_auth_ldap</a></li>
  80. </ul><h3>See also</h3>
  81. <ul class="seealso">
  82. <li><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code></li>
  83. </ul></div>
  84. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  85. <div class="section">
  86. <h2><a name="contents" id="contents">Contents</a></h2>
  87.  
  88.     <ul>
  89.       <li>
  90.         <a href="#operation">Operation</a> 
  91.  
  92.         <ul>
  93.           <li><a href="#authenphase">The Authentication
  94.           Phase</a></li>
  95.  
  96.           <li><a href="#authorphase">The Authorization
  97.           Phase</a></li>
  98.         </ul>
  99.       </li>
  100.  
  101.       <li>
  102.         <a href="#requiredirectives">The require Directives</a> 
  103.  
  104.         <ul>
  105.           <li><a href="#reqvaliduser">require valid-user</a></li>
  106.           <li><a href="#requser">require user</a></li>
  107.           <li><a href="#reqgroup">require group</a></li>
  108.           <li><a href="#reqdn">require dn</a></li>
  109.         </ul>
  110.       </li>
  111.  
  112.       <li><a href="#examples">Examples</a></li>
  113.       <li><a href="#usingtls">Using TLS</a></li>
  114.       <li><a href="#usingssl">Using SSL</a></li>
  115.  
  116.       <li>
  117.         <a href="#frontpage">Using Microsoft FrontPage with
  118.         <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code></a> 
  119.  
  120.         <ul>
  121.           <li><a href="#howitworks">How It Works</a></li>
  122.           <li><a href="#fpcaveats">Caveats</a></li>
  123.         </ul>
  124.       </li>
  125.     </ul>
  126. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  127. <div class="section">
  128. <h2><a name="operation" id="operation">Operation</a></h2>
  129.  
  130.     <p>There are two phases in granting access to a user. The first
  131.     phase is authentication, in which <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code>
  132.     verifies that the user's credentials are valid. This also called
  133.     the <em>search/bind</em> phase. The second phase is
  134.     authorization, in which <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> determines
  135.     if the authenticated user is allowed access to the resource in
  136.     question. This is also known as the <em>compare</em>
  137.     phase.</p>
  138.  
  139. <h3><a name="authenphase" id="authenphase">The Authentication
  140.     Phase</a></h3>
  141.  
  142.     <p>During the authentication phase, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code>
  143.     searches for an entry in the directory that matches the username
  144.     that the HTTP client passes. If a single unique match is found,
  145.     then <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> attempts to bind to the
  146.     directory server using the DN of the entry plus the password
  147.     provided by the HTTP client. Because it does a search, then a
  148.     bind, it is often referred to as the search/bind phase. Here are
  149.     the steps taken during the search/bind phase.</p>
  150.  
  151.     <ol>
  152.       <li>Generate a search filter by combining the attribute and
  153.       filter provided in the <code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code> directive with
  154.       the username passed by the HTTP client.</li>
  155.  
  156.       <li>Search the directory using the generated filter. If the
  157.       search does not return exactly one entry, deny or decline
  158.       access.</li>
  159.  
  160.       <li>Fetch the distinguished name of the entry retrieved from
  161.       the search and attempt to bind to the LDAP server using the
  162.       DN and the password passed by the HTTP client. If the bind is
  163.       unsuccessful, deny or decline access.</li>
  164.     </ol>
  165.  
  166.     <p>The following directives are used during the search/bind
  167.     phase</p>
  168.  
  169.     <table>
  170.       
  171.       <tr>
  172.         <td><code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code></td>
  173.  
  174.         <td>Specifies the LDAP server, the
  175.         base DN, the attribute to use in the search, as well as the
  176.         extra search filter to use.</td>
  177.       </tr>
  178.  
  179.       <tr>
  180.         <td><code class="directive"><a href="#authldapbinddn">AuthLDAPBindDN</a></code></td>
  181.  
  182.         <td>An optional DN to bind with
  183.         during the search phase.</td>
  184.       </tr>
  185.  
  186.       <tr>
  187.         <td><code class="directive"><a href="#authldapbindpassword">AuthLDAPBindPassword</a></code></td>
  188.  
  189.         <td>An optional password to bind
  190.         with during the search phase.</td>
  191.       </tr>
  192.     </table>
  193.  
  194.  
  195. <h3><a name="authorphase" id="authorphase">The Authorization
  196.     Phase</a></h3>
  197.  
  198.     <p>During the authorization phase, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code>
  199.     attempts to determine if the user is authorized to access the
  200.     resource.  Many of these checks require
  201.     <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> to do a compare operation on the
  202.     LDAP server. This is why this phase is often referred to as the
  203.     compare phase. <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> accepts the
  204.     following <code class="directive"><a href="../mod/core.html#require">Require</a></code>
  205.     directives to determine if the credentials are acceptable:</p>
  206.  
  207.     <ul>
  208.       <li>Grant access if there is a <a href="#requser"><code>require
  209.       valid-user</code></a> directive.</li>
  210.  
  211.       <li>Grant access if there is a <a href="#reqgroup"><code>require user</code></a> directive, and the
  212.       username in the directive matches the username passed by the
  213.       client.</li>
  214.  
  215.       <li>Grant access if there is a <a href="#reqdn"><code>require
  216.       dn</code></a> directive, and the DN in the directive matches
  217.       the DN fetched from the LDAP directory.</li>
  218.  
  219.       <li>Grant access if there is a <a href="#reqgroup"><code>require group</code></a> directive, and
  220.       the DN fetched from the LDAP directory (or the username
  221.       passed by the client) occurs in the LDAP group.</li>
  222.  
  223.       <li>otherwise, deny or decline access</li>
  224.     </ul>
  225.  
  226.     <p><code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> uses the following directives during the
  227.     compare phase:</p>
  228.  
  229.     <table>
  230.       
  231.       <tr>
  232.         <td><code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code> </td>
  233.  
  234.         <td>The attribute specified in the
  235.         URL is used in compare operations for the <code>require
  236.         user</code> operation.</td>
  237.       </tr>
  238.  
  239.       <tr>
  240.         <td><code class="directive"><a href="#authldapcomparednonserver">AuthLDAPCompareDNOnServer</a></code></td>
  241.  
  242.         <td>Determines the behavior of the
  243.         <code>require dn</code> directive.</td>
  244.       </tr>
  245.  
  246.       <tr>
  247.         <td><code class="directive"><a href="#authldapgroupattribute">AuthLDAPGroupAttribute</a></code></td>
  248.  
  249.         <td>Determines the attribute to
  250.         use for comparisons in the <code>require group</code>
  251.         directive.</td>
  252.       </tr>
  253.  
  254.       <tr>
  255.         <td><code class="directive"><a href="#authldapgroupattributeisdn">AuthLDAPGroupAttributeIsDN</a></code></td>
  256.  
  257.         <td>Specifies whether to use the
  258.         user DN or the username when doing comparisons for the
  259.         <code>require group</code> directive.</td>
  260.       </tr>
  261.     </table>
  262.  
  263. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  264. <div class="section">
  265. <h2><a name="requiredirectives" id="requiredirectives">The require Directives</a></h2>
  266.  
  267.     <p>Apache's <code class="directive"><a href="../mod/core.html#require">Require</a></code>
  268.     directives are used during the authorization phase to ensure that
  269.     a user is allowed to access a resource.</p>
  270.  
  271. <h3><a name="reqvaliduser" id="reqvaliduser">require
  272.     valid-user</a></h3>
  273.  
  274.     <p>If this directive exists, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> grants
  275.     access to any user that has successfully authenticated during the
  276.     search/bind phase.</p>
  277.  
  278.  
  279. <h3><a name="requser" id="requser">require user</a></h3>
  280.  
  281.     <p>The <code>require user</code> directive specifies what
  282.     usernames can access the resource. Once
  283.     <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> has retrieved a unique DN from the
  284.     directory, it does an LDAP compare operation using the username
  285.     specified in the <code>require user</code> to see if that username
  286.     is part of the just-fetched LDAP entry.  Multiple users can be
  287.     granted access by putting multiple usernames on the line,
  288.     separated with spaces. If a username has a space in it, then it
  289.     must be surrounded with double quotes. Multiple users can also be
  290.     granted access by using multiple <code>require user</code>
  291.     directives, with one user per line. For example, with a <code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code> of
  292.     <code>ldap://ldap/o=Airius?cn</code> (i.e., <code>cn</code> is
  293.     used for searches), the following require directives could be used
  294.     to restrict access:</p>
  295. <div class="example"><p><code>
  296. require user "Barbara Jenson"<br />
  297. require user "Fred User"<br />
  298. require user "Joe Manager"<br />
  299. </code></p></div>
  300.  
  301.     <p>Because of the way that <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> handles this
  302.     directive, Barbara Jenson could sign on as <em>Barbara
  303.     Jenson</em>, <em>Babs Jenson</em> or any other <code>cn</code> that
  304.     she has in her LDAP entry. Only the single <code>require
  305.     user</code> line is needed to support all values of the attribute
  306.     in the user's entry.</p>
  307.  
  308.     <p>If the <code>uid</code> attribute was used instead of the
  309.     <code>cn</code> attribute in the URL above, the above three lines
  310.     could be condensed to</p>
  311. <div class="example"><p><code>require user bjenson fuser jmanager</code></p></div>
  312.  
  313.  
  314. <h3><a name="reqgroup" id="reqgroup">require group</a></h3>
  315.  
  316.     <p>This directive specifies an LDAP group whose members are
  317.     allowed access. It takes the distinguished name of the LDAP
  318.     group. Note: Do not surround the group name with quotes.
  319.     For example, assume that the following entry existed in
  320.     the LDAP directory:</p>
  321. <div class="example"><p><code>
  322. dn: cn=Administrators, o=Airius<br />
  323. objectClass: groupOfUniqueNames<br />
  324. uniqueMember: cn=Barbara Jenson, o=Airius<br />
  325. uniqueMember: cn=Fred User, o=Airius<br />
  326. </code></p></div>
  327.  
  328.     <p>The following directive would grant access to both Fred and
  329.     Barbara:</p>
  330. <div class="example"><p><code>require group cn=Administrators, o=Airius</code></p></div>
  331.  
  332.     <p>Behavior of this directive is modified by the <code class="directive"><a href="#authldapgroupattribute">AuthLDAPGroupAttribute</a></code> and
  333.     <code class="directive"><a href="#authldapgroupattributeisdn">AuthLDAPGroupAttributeIsDN</a></code>
  334.     directives.</p>
  335.  
  336.  
  337. <h3><a name="reqdn" id="reqdn">require dn</a></h3>
  338.  
  339.     <p>The <code>require dn</code> directive allows the administrator
  340.     to grant access based on distinguished names. It specifies a DN
  341.     that must match for access to be granted. If the distinguished
  342.     name that was retrieved from the directory server matches the
  343.     distinguished name in the <code>require dn</code>, then
  344.     authorization is granted. Note: do not surround the distinguished
  345.     name with quotes.</p>
  346.  
  347.     <p>The following directive would grant access to a specific
  348.     DN:</p>
  349. <div class="example"><p><code>require dn cn=Barbara Jenson, o=Airius</code></p></div>
  350.  
  351.     <p>Behavior of this directive is modified by the <code class="directive"><a href="#authldapcomparednonserver">AuthLDAPCompareDNOnServer</a></code>
  352.     directive.</p>
  353.  
  354. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  355. <div class="section">
  356. <h2><a name="examples" id="examples">Examples</a></h2>
  357.  
  358.     <ul>
  359.       <li>
  360.         Grant access to anyone who exists in the LDAP directory,
  361.         using their UID for searches.
  362.  
  363. <div class="example"><p><code>
  364.  AuthLDAPURL ldap://ldap1.airius.com:389/ou=People, o=Airius?uid?sub?(objectClass=*)<br />
  365.  require valid-user
  366. </code></p></div>
  367.       </li>
  368.  
  369.       <li>
  370.         The next example is the same as above; but with the fields
  371.         that have useful defaults omitted. Also, note the use of a
  372.         redundant LDAP server. 
  373. <div class="example"><p><code>AuthLDAPURL ldap://ldap1.airius.com ldap2.airius.com/ou=People, o=Airius<br />
  374. require valid-user
  375. </code></p></div>
  376.       </li>
  377.  
  378.       <li>
  379.         The next example is similar to the previous one, but is
  380.         uses the common name instead of the UID. Note that this
  381.         could be problematical if multiple people in the directory
  382.         share the same <code>cn</code>, because a search on <code>cn</code>
  383.         <strong>must</strong> return exactly one entry. That's why
  384.         this approach is not recommended: it's a better idea to
  385.         choose an attribute that is guaranteed unique in your
  386.         directory, such as <code>uid</code>. 
  387. <div class="example"><p><code>
  388. AuthLDAPURL ldap://ldap.airius.com/ou=People, o=Airius?cn<br />
  389. require valid-user
  390. </code></p></div>
  391.       </li>
  392.  
  393.       <li>
  394.         Grant access to anybody in the Administrators group. The
  395.         users must authenticate using their UID. 
  396. <div class="example"><p><code>
  397. AuthLDAPURL ldap://ldap.airius.com/o=Airius?uid<br />
  398. require group cn=Administrators, o=Airius
  399. </code></p></div>
  400.       </li>
  401.  
  402.       <li>
  403.         The next example assumes that everyone at Airius who
  404.         carries an alphanumeric pager will have an LDAP attribute
  405.         of <code>qpagePagerID</code>. The example will grant access
  406.         only to people (authenticated via their UID) who have
  407.         alphanumeric pagers: 
  408. <div class="example"><p><code>
  409. AuthLDAPURL ldap://ldap.airius.com/o=Airius?uid??(qpagePagerID=*)<br />
  410. require valid-user
  411. </code></p></div>
  412.       </li>
  413.  
  414.       <li>
  415.         <p>The next example demonstrates the power of using filters
  416.         to accomplish complicated administrative requirements.
  417.         Without filters, it would have been necessary to create a
  418.         new LDAP group and ensure that the group's members remain
  419.         synchronized with the pager users. This becomes trivial
  420.         with filters. The goal is to grant access to anyone who has
  421.         a filter, plus grant access to Joe Manager, who doesn't
  422.         have a pager, but does need to access the same
  423.         resource:</p>
  424. <div class="example"><p><code>
  425. AuthLDAPURL ldap://ldap.airius.com/o=Airius?uid??(|(qpagePagerID=*)(uid=jmanager))<br />
  426. require valid-user
  427. </code></p></div>
  428.  
  429.         <p>This last may look confusing at first, so it helps to
  430.         evaluate what the search filter will look like based on who
  431.         connects, as shown below. The text in blue is the part that
  432.         is filled in using the attribute specified in the URL. The
  433.         text in red is the part that is filled in using the filter
  434.         specified in the URL. The text in green is filled in using
  435.         the information that is retrieved from the HTTP client. If
  436.         Fred User connects as <code>fuser</code>, the filter would look
  437.         like</p>
  438.  
  439.         <div class="example"><p><code>(&(|(qpagePagerID=*)(uid=jmanager))(uid=fuser))</code></p></div>
  440.  
  441.         <p>The above search will only succeed if <em>fuser</em> has a
  442.         pager. When Joe Manager connects as <em>jmanager</em>, the
  443.         filter looks like</p>
  444.  
  445.         <div class="example"><p><code>(&(|(qpagePagerID=*)(uid=jmanager))(uid=jmanager))</code></p></div>
  446.  
  447.         <p>The above search will succeed whether <em>jmanager</em>
  448.         has a pager or not.</p>
  449.       </li>
  450.     </ul>
  451. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  452. <div class="section">
  453. <h2><a name="usingtls" id="usingtls">Using TLS</a></h2>
  454.  
  455.     <p>To use TLS, see the <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> directives <code class="directive"><a href="../mod/mod_ldap.html#ldaptrustedca">LDAPTrustedCA</a></code> and <code class="directive"><a href="../mod/mod_ldap.html#ldaptrustedcatype">LDAPTrustedCAType</a></code>.</p>
  456. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  457. <div class="section">
  458. <h2><a name="usingssl" id="usingssl">Using SSL</a></h2>
  459.  
  460.     <p>To use SSL, see the <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> directives <code class="directive"><a href="../mod/mod_ldap.html#ldaptrustedca">LDAPTrustedCA</a></code> and <code class="directive"><a href="../mod/mod_ldap.html#ldaptrustedcatype">LDAPTrustedCAType</a></code>.</p>
  461.  
  462.     <p>To specify a secure LDAP server, use <em>ldaps://</em> in the
  463.     <code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code>
  464.     directive, instead of <em>ldap://</em>.</p>
  465. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  466. <div class="section">
  467. <h2><a name="frontpage" id="frontpage">Using Microsoft
  468.     FrontPage with mod_auth_ldap</a></h2>
  469.  
  470.     <p>Normally, FrontPage uses FrontPage-web-specific user/group
  471.     files (i.e., the <code class="module"><a href="../mod/mod_auth.html">mod_auth</a></code> module) to handle all
  472.     authentication. Unfortunately, it is not possible to just
  473.     change to LDAP authentication by adding the proper directives,
  474.     because it will break the <em>Permissions</em> forms in
  475.     the FrontPage client, which attempt to modify the standard
  476.     text-based authorization files.</p>
  477.  
  478.     <p>Once a FrontPage web has been created, adding LDAP
  479.     authentication to it is a matter of adding the following
  480.     directives to <em>every</em> <code>.htaccess</code> file
  481.     that gets created in the web</p>
  482. <div class="example"><pre>
  483. AuthLDAPURL            "the url"
  484. AuthLDAPAuthoritative  off
  485. AuthLDAPFrontPageHack  on
  486. </pre></div>
  487.  
  488.     <p><code class="directive"><a href="#authldapauthoritative">AuthLDAPAuthoritative</a></code> must be
  489.     off to allow <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> to decline group
  490.     authentication so that Apache will fall back to file
  491.     authentication for checking group membership. This allows the
  492.     FrontPage-managed group file to be used.</p>
  493.  
  494. <h3><a name="howitworks" id="howitworks">How It Works</a></h3>
  495.  
  496.     <p>FrontPage restricts access to a web by adding the <code>require
  497.     valid-user</code> directive to the <code>.htaccess</code>
  498.     files. If <code class="directive"><a href="#authldapfrontpagehack">AuthLDAPFrontPageHack</a></code> is not
  499.     on, the <code>require valid-user</code> directive will succeed for
  500.     any user who is valid <em>as far as LDAP is
  501.     concerned</em>. This means that anybody who has an entry in
  502.     the LDAP directory is considered a valid user, whereas FrontPage
  503.     considers only those people in the local user file to be
  504.     valid. The purpose of the hack is to force Apache to consult the
  505.     local user file (which is managed by FrontPage) - instead of LDAP
  506.     - when handling the <code>require valid-user</code> directive.</p>
  507.  
  508.     <p>Once directives have been added as specified above,
  509.     FrontPage users will be able to perform all management
  510.     operations from the FrontPage client.</p>
  511.  
  512.  
  513. <h3><a name="fpcaveats" id="fpcaveats">Caveats</a></h3>
  514.  
  515.     <ul>
  516.       <li>When choosing the LDAP URL, the attribute to use for
  517.       authentication should be something that will also be valid
  518.       for putting into a <code class="module"><a href="../mod/mod_auth.html">mod_auth</a></code> user file.
  519.       The user ID is ideal for this.</li>
  520.  
  521.       <li>When adding users via FrontPage, FrontPage administrators
  522.       should choose usernames that already exist in the LDAP
  523.       directory (for obvious reasons). Also, the password that the
  524.       administrator enters into the form is ignored, since Apache
  525.       will actually be authenticating against the password in the
  526.       LDAP database, and not against the password in the local user
  527.       file. This could cause confusion for web administrators.</li>
  528.  
  529.       
  530.       <li>Apache must be compiled with <code class="module"><a href="../mod/mod_auth.html">mod_auth</a></code> in order to
  531.       use FrontPage support. This is because Apache will still use
  532.       the <code class="module"><a href="../mod/mod_auth.html">mod_auth</a></code> group file for determine the extent of a
  533.       user's access to the FrontPage web.</li>
  534.  
  535.       <li>The directives must be put in the <code>.htaccess</code>
  536.       files. Attempting to put them inside <code class="directive"><a href="../mod/core.html#location"><Location></a></code> or <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> directives won't work. This
  537.       is because <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> has to be able to grab
  538.       the <code class="directive"><a href="../mod/mod_auth.html#authuserfile">AuthUserFile</a></code>
  539.       directive that is found in FrontPage <code>.htaccess</code>
  540.       files so that it knows where to look for the valid user list. If
  541.       the <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> directives aren't in the same
  542.       <code>.htaccess</code> file as the FrontPage directives, then
  543.       the hack won't work, because <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will
  544.       never get a chance to process the <code>.htaccess</code> file,
  545.       and won't be able to find the FrontPage-managed user file.</li>
  546.     </ul>
  547.  
  548. </div>
  549. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  550. <div class="directive-section"><h2><a name="AuthLDAPAuthoritative" id="AuthLDAPAuthoritative">AuthLDAPAuthoritative</a> <a name="authldapauthoritative" id="authldapauthoritative">Directive</a></h2>
  551. <table class="directive">
  552. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Prevent other authentication modules from
  553. authenticating the user if this one fails</td></tr>
  554. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPAuthoritative on|off</code></td></tr>
  555. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPAuthoritative on</code></td></tr>
  556. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  557. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  558. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  559. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  560. </table>
  561.     <p>Set to <code>off</code> if this module should let other
  562.     authentication modules attempt to authenticate the user, should
  563.     authentication with this module fail. Control is only passed on
  564.     to lower modules if there is no DN or rule that matches the
  565.     supplied user name (as passed by the client).</p>
  566.  
  567. </div>
  568. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  569. <div class="directive-section"><h2><a name="AuthLDAPBindDN" id="AuthLDAPBindDN">AuthLDAPBindDN</a> <a name="authldapbinddn" id="authldapbinddn">Directive</a></h2>
  570. <table class="directive">
  571. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Optional DN to use in binding to the LDAP server</td></tr>
  572. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPBindDN <em>distinguished-name</em></code></td></tr>
  573. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  574. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  575. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  576. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  577. </table>
  578.     <p>An optional DN used to bind to the server when searching for
  579.     entries. If not provided, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will use
  580.     an anonymous bind.</p>
  581.  
  582. </div>
  583. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  584. <div class="directive-section"><h2><a name="AuthLDAPBindPassword" id="AuthLDAPBindPassword">AuthLDAPBindPassword</a> <a name="authldapbindpassword" id="authldapbindpassword">Directive</a></h2>
  585. <table class="directive">
  586. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Password used in conjuction with the bind DN</td></tr>
  587. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPBindPassword <em>password</em></code></td></tr>
  588. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  589. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  590. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  591. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  592. </table>
  593.     <p>A bind password to use in conjunction with the bind DN. Note
  594.     that the bind password is probably sensitive data, and should be
  595.     properly protected. You should only use the <code class="directive"><a href="#authldapbinddn">AuthLDAPBindDN</a></code> and <code class="directive"><a href="#authldapbindpassword">AuthLDAPBindPassword</a></code> if you
  596.     absolutely need them to search the directory.</p> 
  597.  
  598. </div>
  599. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  600. <div class="directive-section"><h2><a name="AuthLDAPCharsetConfig" id="AuthLDAPCharsetConfig">AuthLDAPCharsetConfig</a> <a name="authldapcharsetconfig" id="authldapcharsetconfig">Directive</a></h2>
  601. <table class="directive">
  602. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Language to charset conversion configuration file</td></tr>
  603. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPCharsetConfig <em>file-path</em></code></td></tr>
  604. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  605. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  606. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  607. </table>
  608.     <p>The <code class="directive">AuthLDAPCharsetConfig</code> directive sets the location
  609.     of the language to charset conversion configuration file. <var>File-path</var> is relative
  610.     to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>. This file specifies
  611.     the list of language extensions to character sets.
  612.     Most administrators use the provided <code>charset.conv</code>
  613.     file, which associates common language extensions to character sets.</p>
  614.  
  615.     <p>The file contains lines in the following format:</p>
  616.  
  617.     <div class="example"><p><code>
  618.       <var>Language-Extension</var> <var>charset</var> [<var>Language-String</var>] ...
  619.     </code></p></div>
  620.  
  621.     <p>The case of the extension does not matter. Blank lines, and lines
  622.     beginning with a hash character (<code>#</code>) are ignored.</p>
  623.  
  624. </div>
  625. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  626. <div class="directive-section"><h2><a name="AuthLDAPCompareDNOnServer" id="AuthLDAPCompareDNOnServer">AuthLDAPCompareDNOnServer</a> <a name="authldapcomparednonserver" id="authldapcomparednonserver">Directive</a></h2>
  627. <table class="directive">
  628. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use the LDAP server to compare the DNs</td></tr>
  629. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPCompareDNOnServer on|off</code></td></tr>
  630. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPCompareDNOnServer on</code></td></tr>
  631. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  632. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  633. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  634. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  635. </table>
  636.     <p>When set, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will use the LDAP
  637.     server to compare the DNs. This is the only foolproof way to
  638.     compare DNs.  <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will search the
  639.     directory for the DN specified with the <a href="#reqdn"><code>require dn</code></a> directive, then,
  640.     retrieve the DN and compare it with the DN retrieved from the user
  641.     entry. If this directive is not set,
  642.     <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> simply does a string comparison. It
  643.     is possible to get false negatives with this approach, but it is
  644.     much faster. Note the <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> cache can speed up
  645.     DN comparison in most situations.</p>
  646.  
  647. </div>
  648. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  649. <div class="directive-section"><h2><a name="AuthLDAPDereferenceAliases" id="AuthLDAPDereferenceAliases">AuthLDAPDereferenceAliases</a> <a name="authldapdereferencealiases" id="authldapdereferencealiases">Directive</a></h2>
  650. <table class="directive">
  651. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>When will the module de-reference aliases</td></tr>
  652. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPDereferenceAliases never|searching|finding|always</code></td></tr>
  653. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPDereferenceAliases Always</code></td></tr>
  654. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  655. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  656. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  657. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  658. </table>
  659.     <p>This directive specifies when <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will
  660.     de-reference aliases during LDAP operations. The default is
  661.     <code>always</code>.</p>
  662.  
  663. </div>
  664. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  665. <div class="directive-section"><h2><a name="AuthLDAPEnabled" id="AuthLDAPEnabled">AuthLDAPEnabled</a> <a name="authldapenabled" id="authldapenabled">Directive</a></h2>
  666. <table class="directive">
  667. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Turn on or off LDAP authentication</td></tr>
  668. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> AuthLDAPEnabled on|off</code></td></tr>
  669. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPEnabled on</code></td></tr>
  670. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  671. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  672. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  673. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  674. </table>
  675.     <p>Set to <code>off</code> to disable
  676.     <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> in certain directories. This is
  677.     useful if you have <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> enabled at or
  678.     near the top of your tree, but want to disable it completely in
  679.     certain locations.</p> 
  680.  
  681. </div>
  682. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  683. <div class="directive-section"><h2><a name="AuthLDAPFrontPageHack" id="AuthLDAPFrontPageHack">AuthLDAPFrontPageHack</a> <a name="authldapfrontpagehack" id="authldapfrontpagehack">Directive</a></h2>
  684. <table class="directive">
  685. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Allow LDAP authentication to work with MS FrontPage</td></tr>
  686. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPFrontPageHack on|off</code></td></tr>
  687. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPFrontPageHack off</code></td></tr>
  688. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  689. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  690. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  691. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  692. </table>
  693.     <p>See the section on <a href="#frontpage">using Microsoft
  694.     FrontPage</a> with <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code>.</p>
  695.  
  696. </div>
  697. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  698. <div class="directive-section"><h2><a name="AuthLDAPGroupAttribute" id="AuthLDAPGroupAttribute">AuthLDAPGroupAttribute</a> <a name="authldapgroupattribute" id="authldapgroupattribute">Directive</a></h2>
  699. <table class="directive">
  700. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>LDAP attributes used to check for group membership</td></tr>
  701. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPGroupAttribute <em>attribute</em></code></td></tr>
  702. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  703. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  704. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  705. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  706. </table>
  707.     <p>This directive specifies which LDAP attributes are used to
  708.     check for group membership. Multiple attributes can be used by
  709.     specifying this directive multiple times. If not specified,
  710.     then <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> uses the <code>member</code> and
  711.     <code>uniquemember</code> attributes.</p>
  712.  
  713. </div>
  714. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  715. <div class="directive-section"><h2><a name="AuthLDAPGroupAttributeIsDN" id="AuthLDAPGroupAttributeIsDN">AuthLDAPGroupAttributeIsDN</a> <a name="authldapgroupattributeisdn" id="authldapgroupattributeisdn">Directive</a></h2>
  716. <table class="directive">
  717. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use the DN of the client username when checking for
  718. group membership</td></tr>
  719. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPGroupAttributeIsDN on|off</code></td></tr>
  720. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPGroupAttributeIsDN on</code></td></tr>
  721. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  722. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  723. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  724. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  725. </table>
  726.     <p>When set <code>on</code>, this directive says to use the
  727.     distinguished name of the client username when checking for group
  728.     membership.  Otherwise, the username will be used. For example,
  729.     assume that the client sent the username <code>bjenson</code>,
  730.     which corresponds to the LDAP DN <code>cn=Babs Jenson,
  731.     o=Airius</code>. If this directive is set,
  732.     <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will check if the group has
  733.     <code>cn=Babs Jenson, o=Airius</code> as a member. If this
  734.     directive is not set, then <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will
  735.     check if the group has <code>bjenson</code> as a member.</p>
  736.  
  737. </div>
  738. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  739. <div class="directive-section"><h2><a name="AuthLDAPRemoteUserIsDN" id="AuthLDAPRemoteUserIsDN">AuthLDAPRemoteUserIsDN</a> <a name="authldapremoteuserisdn" id="authldapremoteuserisdn">Directive</a></h2>
  740. <table class="directive">
  741. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use the DN of the client username to set the REMOTE_USER
  742. environment variable</td></tr>
  743. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPRemoteUserIsDN on|off</code></td></tr>
  744. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPRemoteUserIsDN off</code></td></tr>
  745. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  746. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  747. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  748. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  749. </table>
  750.     <p>If this directive is set to on, the value of the
  751.     <code>REMOTE_USER</code> environment variable will be set to the full
  752.     distinguished name of the authenticated user, rather than just
  753.     the username that was passed by the client. It is turned off by
  754.     default.</p>
  755.  
  756. </div>
  757. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  758. <div class="directive-section"><h2><a name="AuthLDAPUrl" id="AuthLDAPUrl">AuthLDAPUrl</a> <a name="authldapurl" id="authldapurl">Directive</a></h2>
  759. <table class="directive">
  760. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>URL specifying the LDAP search parameters</td></tr>
  761. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPUrl <em>url</em></code></td></tr>
  762. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  763. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  764. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  765. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr>
  766. </table>
  767.     <p>An RFC 2255 URL which specifies the LDAP search parameters
  768.     to use. The syntax of the URL is</p>
  769. <div class="example"><p><code>ldap://host:port/basedn?attribute?scope?filter</code></p></div>
  770.  
  771. <dl>
  772. <dt>ldap</dt>
  773.  
  774.         <dd>For regular ldap, use the
  775.         string <code>ldap</code>. For secure LDAP, use <code>ldaps</code>
  776.         instead. Secure LDAP is only available if Apache was linked
  777.         to an LDAP library with SSL support.</dd>
  778.  
  779. <dt>host:port</dt>
  780.  
  781.         <dd>
  782.           <p>The name/port of the ldap server (defaults to
  783.           <code>localhost:389</code> for <code>ldap</code>, and
  784.           <code>localhost:636</code> for <code>ldaps</code>). To
  785.           specify multiple, redundant LDAP servers, just list all
  786.           servers, separated by spaces. <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code>
  787.           will try connecting to each server in turn, until it makes a
  788.           successful connection.</p>
  789.  
  790.           <p>Once a connection has been made to a server, that
  791.           connection remains active for the life of the
  792.           <code>httpd</code> process, or until the LDAP server goes
  793.           down.</p>
  794.  
  795.           <p>If the LDAP server goes down and breaks an existing
  796.           connection, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will attempt to
  797.           re-connect, starting with the primary server, and trying
  798.           each redundant server in turn. Note that this is different
  799.           than a true round-robin search.</p>
  800.         </dd>
  801.  
  802. <dt>basedn</dt>
  803.  
  804.         <dd>The DN of the branch of the
  805.         directory where all searches should start from. At the very
  806.         least, this must be the top of your directory tree, but
  807.         could also specify a subtree in the directory.</dd>
  808.  
  809. <dt>attribute</dt>
  810.  
  811.         <dd>The attribute to search for.
  812.         Although RFC 2255 allows a comma-separated list of
  813.         attributes, only the first attribute will be used, no
  814.         matter how many are provided. If no attributes are
  815.         provided, the default is to use <code>uid</code>. It's a good
  816.         idea to choose an attribute that will be unique across all
  817.         entries in the subtree you will be using.</dd>
  818.  
  819. <dt>scope</dt>
  820.  
  821.         <dd>The scope of the search. Can be either <code>one</code> or
  822.         <code>sub</code>. Note that a scope of <code>base</code> is
  823.         also supported by RFC 2255, but is not supported by this
  824.         module. If the scope is not provided, or if <code>base</code> scope
  825.         is specified, the default is to use a scope of
  826.         <code>sub</code>.</dd>
  827.  
  828. <dt>filter</dt>
  829.  
  830.         <dd>A valid LDAP search filter. If
  831.         not provided, defaults to <code>(objectClass=*)</code>, which
  832.         will search for all objects in the tree. Filters are
  833.         limited to approximately 8000 characters (the definition of
  834.         <code>MAX_STRING_LEN</code> in the Apache source code). This
  835.         should be than sufficient for any application.</dd>
  836. </dl>
  837.  
  838.     <p>When doing searches, the attribute, filter and username passed
  839.     by the HTTP client are combined to create a search filter that
  840.     looks like
  841.     <code>(&(<em>filter</em>)(<em>attribute</em>=<em>username</em>))</code>.</p>
  842.  
  843.     <p>For example, consider an URL of
  844.     <code>ldap://ldap.airius.com/o=Airius?cn?sub?(posixid=*)</code>. When
  845.     a client attempts to connect using a username of <code>Babs
  846.     Jenson</code>, the resulting search filter will be
  847.     <code>(&(posixid=*)(cn=Babs Jenson))</code>.</p>
  848.  
  849.     <p>See above for examples of <code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code> URLs.</p>
  850.  
  851. </div>
  852. </div>
  853. <div class="bottomlang">
  854. <p><span>Available Languages: </span><a href="../en/mod/mod_auth_ldap.html" title="English"> en </a></p>
  855. </div><div id="footer">
  856. <p class="apache">Copyright 1999-2004 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
  857. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  858. </body></html>