| <?xml version="1.0" encoding="ISO-8859-1"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> |
| <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" /> |
| <meta content="noindex, nofollow" name="robots" /> |
| <!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --> |
| <title>mod_auth_ldap - Apache HTTP Server</title> |
| <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> |
| <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> |
| <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /> |
| <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/mod/mod_auth_ldap.html" rel="canonical" /></head> |
| <body> |
| <div id="page-header"> |
| <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> |
| <p class="apache">Apache HTTP Server Version 2.0</p> |
| <img alt="" src="../images/feather.gif" /></div> |
| <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> |
| <div id="path"> |
| <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div> |
| <div id="page-content"> |
| <div class="retired"><h4>Please note</h4> |
| <p>This document refers to the <strong>2.0</strong> version of Apache httpd, which <strong>is no longer maintained</strong>. Upgrade, and refer to the current version of httpd instead, documented at:</p> |
| <ul><li><a href="http://httpd.apache.org/docs/current/">Current release version of Apache HTTP Server documentation</a></li></ul><p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_auth_ldap.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_auth_ldap</h1> |
| <div class="toplang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_auth_ldap.html" title="English"> en </a></p> |
| </div> |
| <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 |
| for HTTP Basic authentication.</td></tr> |
| <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>auth_ldap_module</td></tr> |
| <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_auth_ldap.c</td></tr> |
| <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.41 and later</td></tr></table> |
| <h3>Summary</h3> |
| |
| <p><code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> supports the following features:</p> |
| |
| <ul> |
| <li>Known to support the <a href="http://www.openldap.org/">OpenLDAP SDK</a> (both 1.x |
| and 2.x), <a href="http://developer.novell.com/ndk/cldap.htm"> |
| Novell LDAP SDK</a> and the <a href="http://www.iplanet.com/downloads/developer/">iPlanet |
| (Netscape)</a> SDK.</li> |
| |
| <li>Complex authorization policies can be implemented by |
| representing the policy with LDAP filters.</li> |
| |
| <li>Support for Microsoft FrontPage allows FrontPage users to |
| control access to their webs, while retaining LDAP for user |
| authentication.</li> |
| |
| <li>Uses extensive caching of LDAP operations via <a href="mod_ldap.html">mod_ldap</a>.</li> |
| |
| <li>Support for LDAP over SSL (requires the Netscape SDK) or |
| TLS (requires the OpenLDAP 2.x SDK or Novell LDAP SDK).</li> |
| </ul> |
| </div> |
| <div id="quickview"><h3 class="directives">Directives</h3> |
| <ul id="toc"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapauthoritative">AuthLDAPAuthoritative</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapbinddn">AuthLDAPBindDN</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapbindpassword">AuthLDAPBindPassword</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapcharsetconfig">AuthLDAPCharsetConfig</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapcomparednonserver">AuthLDAPCompareDNOnServer</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapdereferencealiases">AuthLDAPDereferenceAliases</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapenabled">AuthLDAPEnabled</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapfrontpagehack">AuthLDAPFrontPageHack</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapgroupattribute">AuthLDAPGroupAttribute</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapgroupattributeisdn">AuthLDAPGroupAttributeIsDN</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapremoteuserisdn">AuthLDAPRemoteUserIsDN</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authldapurl">AuthLDAPUrl</a></li> |
| </ul> |
| <h3>Topics</h3> |
| <ul id="topics"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#contents">Contents</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#operation">Operation</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#requiredirectives">The Require Directives</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#usingtls">Using TLS</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#usingssl">Using SSL</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#frontpage">Using Microsoft |
| FrontPage with mod_auth_ldap</a></li> |
| </ul><h3>See also</h3> |
| <ul class="seealso"> |
| <li><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code></li> |
| </ul></div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="contents" id="contents">Contents</a></h2> |
| |
| <ul> |
| <li> |
| <a href="#operation">Operation</a> |
| |
| <ul> |
| <li><a href="#authenphase">The Authentication |
| Phase</a></li> |
| |
| <li><a href="#authorphase">The Authorization |
| Phase</a></li> |
| </ul> |
| </li> |
| |
| <li> |
| <a href="#requiredirectives">The Require Directives</a> |
| |
| <ul> |
| <li><a href="#reqvaliduser">Require valid-user</a></li> |
| <li><a href="#requser">Require user</a></li> |
| <li><a href="#reqgroup">Require group</a></li> |
| <li><a href="#reqdn">Require dn</a></li> |
| <li><a href="#reqattribute">Require ldap-attribute</a></li> |
| </ul> |
| </li> |
| |
| <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="#frontpage">Using Microsoft FrontPage with |
| <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code></a> |
| |
| <ul> |
| <li><a href="#howitworks">How It Works</a></li> |
| <li><a href="#fpcaveats">Caveats</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="operation" id="operation">Operation</a></h2> |
| |
| <p>There are two phases in granting access to a user. The first |
| phase is authentication, in which <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> |
| verifies that the user's credentials are valid. This also called |
| the <em>search/bind</em> phase. The second phase is |
| authorization, in which <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> determines |
| if the authenticated user is allowed access to the resource in |
| question. This is also known as the <em>compare</em> |
| phase.</p> |
| |
| <h3><a name="authenphase" id="authenphase">The Authentication |
| Phase</a></h3> |
| |
| <p>During the authentication phase, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> |
| searches for an entry in the directory that matches the username |
| that the HTTP client passes. If a single unique match is found, |
| then <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> attempts to bind to the |
| directory server using the DN of the entry plus the password |
| provided by the HTTP client. Because it does a search, then a |
| bind, it is often referred to as the search/bind phase. Here are |
| the steps taken during the search/bind phase.</p> |
| |
| <ol> |
| <li>Generate a search filter by combining the attribute and |
| filter provided in the <code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code> directive with |
| the username passed by the HTTP client.</li> |
| |
| <li>Search the directory using the generated filter. If the |
| search does not return exactly one entry, deny or decline |
| access.</li> |
| |
| <li>Fetch the distinguished name of the entry retrieved from |
| the search and attempt to bind to the LDAP server using the |
| DN and the password passed by the HTTP client. If the bind is |
| unsuccessful, deny or decline access.</li> |
| </ol> |
| |
| <p>The following directives are used during the search/bind |
| phase</p> |
| |
| <table> |
| |
| <tr> |
| <td><code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code></td> |
| |
| <td>Specifies the LDAP server, the |
| base DN, the attribute to use in the search, as well as the |
| extra search filter to use.</td> |
| </tr> |
| |
| <tr> |
| <td><code class="directive"><a href="#authldapbinddn">AuthLDAPBindDN</a></code></td> |
| |
| <td>An optional DN to bind with |
| during the search phase.</td> |
| </tr> |
| |
| <tr> |
| <td><code class="directive"><a href="#authldapbindpassword">AuthLDAPBindPassword</a></code></td> |
| |
| <td>An optional password to bind |
| with during the search phase.</td> |
| </tr> |
| </table> |
| |
| |
| <h3><a name="authorphase" id="authorphase">The Authorization |
| Phase</a></h3> |
| |
| <p>During the authorization phase, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> |
| attempts to determine if the user is authorized to access the |
| resource. Many of these checks require |
| <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> to do a compare operation on the |
| LDAP server. This is why this phase is often referred to as the |
| compare phase. <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> accepts the |
| following <code class="directive"><a href="../mod/core.html#require">Require</a></code> |
| directives to determine if the credentials are acceptable:</p> |
| |
| <ul> |
| <li>Grant access if there is a <a href="#requser"><code>Require |
| valid-user</code></a> directive.</li> |
| |
| <li>Grant access if there is a <a href="#reqgroup"><code>Require user</code></a> directive, and the |
| username in the directive matches the username passed by the |
| client.</li> |
| |
| <li>Grant access if there is a <a href="#reqdn"><code>Require |
| dn</code></a> directive, and the DN in the directive matches |
| the DN fetched from the LDAP directory.</li> |
| |
| <li>Grant access if there is a <a href="#reqgroup"><code>Require group</code></a> directive, and |
| the DN fetched from the LDAP directory (or the username |
| passed by the client) occurs in the LDAP group.</li> |
| |
| <li>Grant access if there is a <a href="#reqattribute"> |
| <code>Require ldap-attribute</code></a> |
| directive, and the attribute fetched from the LDAP directory |
| matches the given value.</li> |
| |
| <li>otherwise, deny or decline access</li> |
| </ul> |
| |
| <p><code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> uses the following directives during the |
| compare phase:</p> |
| |
| <table> |
| |
| <tr> |
| <td><code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code> </td> |
| |
| <td>The attribute specified in the |
| URL is used in compare operations for the <code>Require |
| user</code> operation.</td> |
| </tr> |
| |
| <tr> |
| <td><code class="directive"><a href="#authldapcomparednonserver">AuthLDAPCompareDNOnServer</a></code></td> |
| |
| <td>Determines the behavior of the |
| <code>Require dn</code> directive.</td> |
| </tr> |
| |
| <tr> |
| <td><code class="directive"><a href="#authldapgroupattribute">AuthLDAPGroupAttribute</a></code></td> |
| |
| <td>Determines the attribute to |
| use for comparisons in the <code>Require group</code> |
| directive.</td> |
| </tr> |
| |
| <tr> |
| <td><code class="directive"><a href="#authldapgroupattributeisdn">AuthLDAPGroupAttributeIsDN</a></code></td> |
| |
| <td>Specifies whether to use the |
| user DN or the username when doing comparisons for the |
| <code>Require group</code> directive.</td> |
| </tr> |
| </table> |
| |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="requiredirectives" id="requiredirectives">The Require Directives</a></h2> |
| |
| <p>Apache's <code class="directive"><a href="../mod/core.html#require">Require</a></code> |
| directives are used during the authorization phase to ensure that |
| a user is allowed to access a resource.</p> |
| |
| <h3><a name="reqvaliduser" id="reqvaliduser">Require |
| valid-user</a></h3> |
| |
| <p>If this directive exists, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> grants |
| access to any user that has successfully authenticated during the |
| search/bind phase.</p> |
| |
| |
| <h3><a name="requser" id="requser">Require user</a></h3> |
| |
| <p>The <code>Require user</code> directive specifies what |
| usernames can access the resource. Once |
| <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> has retrieved a unique DN from the |
| directory, it does an LDAP compare operation using the username |
| specified in the <code>Require user</code> to see if that username |
| is part of the just-fetched LDAP entry. Multiple users can be |
| granted access by putting multiple usernames on the line, |
| separated with spaces. If a username has a space in it, then it |
| must be surrounded with double quotes. Multiple users can also be |
| granted access by using multiple <code>Require user</code> |
| directives, with one user per line. For example, with a <code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code> of |
| <code>ldap://ldap/o=Airius?cn</code> (i.e., <code>cn</code> is |
| used for searches), the following Require directives could be used |
| to restrict access:</p> |
| <div class="example"><p><code> |
| Require user "Barbara Jenson"<br /> |
| Require user "Fred User"<br /> |
| Require user "Joe Manager"<br /> |
| </code></p></div> |
| |
| <p>Because of the way that <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> handles this |
| directive, Barbara Jenson could sign on as <em>Barbara |
| Jenson</em>, <em>Babs Jenson</em> or any other <code>cn</code> that |
| she has in her LDAP entry. Only the single <code>Require |
| user</code> line is needed to support all values of the attribute |
| in the user's entry.</p> |
| |
| <p>If the <code>uid</code> attribute was used instead of the |
| <code>cn</code> attribute in the URL above, the above three lines |
| could be condensed to</p> |
| <div class="example"><p><code>Require user bjenson fuser jmanager</code></p></div> |
| |
| |
| <h3><a name="reqgroup" id="reqgroup">Require group</a></h3> |
| |
| <p>This directive specifies an LDAP group whose members are |
| allowed access. It takes the distinguished name of the LDAP |
| group. Note: Do not surround the group name with quotes. |
| For example, assume that the following entry existed in |
| the LDAP directory:</p> |
| <div class="example"><p><code> |
| dn: cn=Administrators, o=Airius<br /> |
| objectClass: groupOfUniqueNames<br /> |
| uniqueMember: cn=Barbara Jenson, o=Airius<br /> |
| uniqueMember: cn=Fred User, o=Airius<br /> |
| </code></p></div> |
| |
| <p>The following directive would grant access to both Fred and |
| Barbara:</p> |
| <div class="example"><p><code>Require group cn=Administrators, o=Airius</code></p></div> |
| |
| <p>Behavior of this directive is modified by the <code class="directive"><a href="#authldapgroupattribute">AuthLDAPGroupAttribute</a></code> and |
| <code class="directive"><a href="#authldapgroupattributeisdn">AuthLDAPGroupAttributeIsDN</a></code> |
| directives.</p> |
| |
| |
| <h3><a name="reqdn" id="reqdn">Require dn</a></h3> |
| |
| <p>The <code>Require dn</code> directive allows the administrator |
| to grant access based on distinguished names. It specifies a DN |
| that must match for access to be granted. If the distinguished |
| name that was retrieved from the directory server matches the |
| distinguished name in the <code>Require dn</code>, then |
| authorization is granted. Note: do not surround the distinguished |
| name with quotes.</p> |
| |
| <p>The following directive would grant access to a specific |
| DN:</p> |
| <div class="example"><p><code>Require dn cn=Barbara Jenson, o=Airius</code></p></div> |
| |
| <p>Behavior of this directive is modified by the <code class="directive"><a href="#authldapcomparednonserver">AuthLDAPCompareDNOnServer</a></code> |
| directive.</p> |
| |
| |
| <h3><a name="reqattribute" id="reqattribute">Require ldap-attribute</a></h3> |
| |
| <p>The <code>Require ldap-attribute</code> directive allows the |
| administrator to grant access based on attributes of the authenticated |
| user in the LDAP directory. If the attribute in the directory |
| matches the value given in the configuration, access is granted.</p> |
| |
| <p>The following directive would grant access to anyone with |
| the attribute employeeType = active</p> |
| |
| <div class="example"><p><code>Require ldap-attribute employeeType=active</code></p></div> |
| |
| <p>Multiple attribute/value pairs can be specified on the same line |
| separated by spaces or they can be specified in multiple |
| <code>Require ldap-attribute</code> directives. The effect of listing |
| multiple attribute/values pairs is an OR operation. Access will be |
| granted if any of the listed attribute values match the value of a |
| corresponding attribute in the user object. If the value of the |
| attribute contains a space, only the value must be within double quotes.</p> |
| |
| <p>The following directive would grant access to anyone with |
| the city attribute equal to "San Jose" or status equal to "Active"</p> |
| |
| <div class="example"><p><code>Require ldap-attribute city="San Jose" status=active</code></p></div> |
| |
| |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="examples" id="examples">Examples</a></h2> |
| |
| <ul> |
| <li> |
| Grant access to anyone who exists in the LDAP directory, |
| using their UID for searches. |
| |
| <div class="example"><p><code> |
| AuthLDAPURL "ldap://ldap1.airius.com:389/ou=People, o=Airius?uid?sub?(objectClass=*)"<br /> |
| Require valid-user |
| </code></p></div> |
| </li> |
| |
| <li> |
| The next example is the same as above; but with the fields |
| that have useful defaults omitted. Also, note the use of a |
| redundant LDAP server. |
| <div class="example"><p><code>AuthLDAPURL "ldap://ldap1.airius.com ldap2.airius.com/ou=People, o=Airius"<br /> |
| Require valid-user |
| </code></p></div> |
| </li> |
| |
| <li> |
| The next example is similar to the previous one, but is |
| uses the common name instead of the UID. Note that this |
| could be problematical if multiple people in the directory |
| share the same <code>cn</code>, because a search on <code>cn</code> |
| <strong>must</strong> return exactly one entry. That's why |
| this approach is not recommended: it's a better idea to |
| choose an attribute that is guaranteed unique in your |
| directory, such as <code>uid</code>. |
| <div class="example"><p><code> |
| AuthLDAPURL "ldap://ldap.airius.com/ou=People, o=Airius?cn"<br /> |
| Require valid-user |
| </code></p></div> |
| </li> |
| |
| <li> |
| Grant access to anybody in the Administrators group. The |
| users must authenticate using their UID. |
| <div class="example"><p><code> |
| AuthLDAPURL ldap://ldap.airius.com/o=Airius?uid<br /> |
| Require group cn=Administrators, o=Airius |
| </code></p></div> |
| </li> |
| |
| <li> |
| The next example assumes that everyone at Airius who |
| carries an alphanumeric pager will have an LDAP attribute |
| of <code>qpagePagerID</code>. The example will grant access |
| only to people (authenticated via their UID) who have |
| alphanumeric pagers: |
| <div class="example"><p><code> |
| AuthLDAPURL ldap://ldap.airius.com/o=Airius?uid??(qpagePagerID=*)<br /> |
| Require valid-user |
| </code></p></div> |
| </li> |
| |
| <li> |
| <p>The next example demonstrates the power of using filters |
| to accomplish complicated administrative requirements. |
| Without filters, it would have been necessary to create a |
| new LDAP group and ensure that the group's members remain |
| synchronized with the pager users. This becomes trivial |
| with filters. The goal is to grant access to anyone who has |
| a filter, plus grant access to Joe Manager, who doesn't |
| have a pager, but does need to access the same |
| resource:</p> |
| <div class="example"><p><code> |
| AuthLDAPURL ldap://ldap.airius.com/o=Airius?uid??(|(qpagePagerID=*)(uid=jmanager))<br /> |
| Require valid-user |
| </code></p></div> |
| |
| <p>This last may look confusing at first, so it helps to |
| evaluate what the search filter will look like based on who |
| connects, as shown below. The text in blue is the part that |
| is filled in using the attribute specified in the URL. The |
| text in red is the part that is filled in using the filter |
| specified in the URL. The text in green is filled in using |
| the information that is retrieved from the HTTP client. If |
| Fred User connects as <code>fuser</code>, the filter would look |
| like</p> |
| |
| <div class="example"><p><code>(&(|(qpagePagerID=*)(uid=jmanager))(uid=fuser))</code></p></div> |
| |
| <p>The above search will only succeed if <em>fuser</em> has a |
| pager. When Joe Manager connects as <em>jmanager</em>, the |
| filter looks like</p> |
| |
| <div class="example"><p><code>(&(|(qpagePagerID=*)(uid=jmanager))(uid=jmanager))</code></p></div> |
| |
| <p>The above search will succeed whether <em>jmanager</em> |
| has a pager or not.</p> |
| </li> |
| </ul> |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="usingtls" id="usingtls">Using TLS</a></h2> |
| |
| <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> |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="usingssl" id="usingssl">Using SSL</a></h2> |
| |
| <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> |
| |
| <p>To specify a secure LDAP server, use <em>ldaps://</em> in the |
| <code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code> |
| directive, instead of <em>ldap://</em>.</p> |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="frontpage" id="frontpage">Using Microsoft |
| FrontPage with mod_auth_ldap</a></h2> |
| |
| <p>Normally, FrontPage uses FrontPage-web-specific user/group |
| files (i.e., the <code class="module"><a href="../mod/mod_auth.html">mod_auth</a></code> module) to handle all |
| authentication. Unfortunately, it is not possible to just |
| change to LDAP authentication by adding the proper directives, |
| because it will break the <em>Permissions</em> forms in |
| the FrontPage client, which attempt to modify the standard |
| text-based authorization files.</p> |
| |
| <p>Once a FrontPage web has been created, adding LDAP |
| authentication to it is a matter of adding the following |
| directives to <em>every</em> <code>.htaccess</code> file |
| that gets created in the web</p> |
| <div class="example"><pre> |
| AuthLDAPURL "the url" |
| AuthLDAPAuthoritative off |
| AuthLDAPFrontPageHack on |
| </pre></div> |
| |
| <p><code class="directive"><a href="#authldapauthoritative">AuthLDAPAuthoritative</a></code> must be |
| off to allow <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> to decline group |
| authentication so that Apache will fall back to file |
| authentication for checking group membership. This allows the |
| FrontPage-managed group file to be used.</p> |
| |
| <h3><a name="howitworks" id="howitworks">How It Works</a></h3> |
| |
| <p>FrontPage restricts access to a web by adding the <code>Require |
| valid-user</code> directive to the <code>.htaccess</code> |
| files. If <code class="directive"><a href="#authldapfrontpagehack">AuthLDAPFrontPageHack</a></code> is not |
| on, the <code>Require valid-user</code> directive will succeed for |
| any user who is valid <em>as far as LDAP is |
| concerned</em>. This means that anybody who has an entry in |
| the LDAP directory is considered a valid user, whereas FrontPage |
| considers only those people in the local user file to be |
| valid. The purpose of the hack is to force Apache to consult the |
| local user file (which is managed by FrontPage) - instead of LDAP |
| - when handling the <code>Require valid-user</code> directive.</p> |
| |
| <p>Once directives have been added as specified above, |
| FrontPage users will be able to perform all management |
| operations from the FrontPage client.</p> |
| |
| |
| <h3><a name="fpcaveats" id="fpcaveats">Caveats</a></h3> |
| |
| <ul> |
| <li>When choosing the LDAP URL, the attribute to use for |
| authentication should be something that will also be valid |
| for putting into a <code class="module"><a href="../mod/mod_auth.html">mod_auth</a></code> user file. |
| The user ID is ideal for this.</li> |
| |
| <li>When adding users via FrontPage, FrontPage administrators |
| should choose usernames that already exist in the LDAP |
| directory (for obvious reasons). Also, the password that the |
| administrator enters into the form is ignored, since Apache |
| will actually be authenticating against the password in the |
| LDAP database, and not against the password in the local user |
| file. This could cause confusion for web administrators.</li> |
| |
| |
| <li>Apache must be compiled with <code class="module"><a href="../mod/mod_auth.html">mod_auth</a></code> in order to |
| use FrontPage support. This is because Apache will still use |
| the <code class="module"><a href="../mod/mod_auth.html">mod_auth</a></code> group file for determine the extent of a |
| user's access to the FrontPage web.</li> |
| |
| <li>The directives must be put in the <code>.htaccess</code> |
| 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 |
| is because <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> has to be able to grab |
| the <code class="directive"><a href="../mod/mod_auth.html#authuserfile">AuthUserFile</a></code> |
| directive that is found in FrontPage <code>.htaccess</code> |
| files so that it knows where to look for the valid user list. If |
| the <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> directives aren't in the same |
| <code>.htaccess</code> file as the FrontPage directives, then |
| the hack won't work, because <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will |
| never get a chance to process the <code>.htaccess</code> file, |
| and won't be able to find the FrontPage-managed user file.</li> |
| </ul> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPAuthoritative" id="AuthLDAPAuthoritative">AuthLDAPAuthoritative</a> <a name="authldapauthoritative" id="authldapauthoritative">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Prevent other authentication modules from |
| authenticating the user if this one fails</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPAuthoritative on|off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPAuthoritative on</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>Set to <code>off</code> if this module should let other |
| authentication modules attempt to authenticate the user, should |
| authentication with this module fail. Control is only passed on |
| to lower modules if there is no DN or rule that matches the |
| supplied user name (as passed by the client).</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPBindDN" id="AuthLDAPBindDN">AuthLDAPBindDN</a> <a name="authldapbinddn" id="authldapbinddn">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Optional DN to use in binding to the LDAP server</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPBindDN <em>distinguished-name</em></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>An optional DN used to bind to the server when searching for |
| entries. If not provided, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will use |
| an anonymous bind.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPBindPassword" id="AuthLDAPBindPassword">AuthLDAPBindPassword</a> <a name="authldapbindpassword" id="authldapbindpassword">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Password used in conjuction with the bind DN</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPBindPassword <em>password</em></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>A bind password to use in conjunction with the bind DN. Note |
| that the bind password is probably sensitive data, and should be |
| 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 |
| absolutely need them to search the directory.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPCharsetConfig" id="AuthLDAPCharsetConfig">AuthLDAPCharsetConfig</a> <a name="authldapcharsetconfig" id="authldapcharsetconfig">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Language to charset conversion configuration file</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPCharsetConfig <em>file-path</em></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>The <code class="directive">AuthLDAPCharsetConfig</code> directive sets the location |
| of the language to charset conversion configuration file. <var>File-path</var> is relative |
| to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>. This file specifies |
| the list of language extensions to character sets. |
| Most administrators use the provided <code>charset.conv</code> |
| file, which associates common language extensions to character sets.</p> |
| |
| <p>The file contains lines in the following format:</p> |
| |
| <div class="example"><p><code> |
| <var>Language-Extension</var> <var>charset</var> [<var>Language-String</var>] ... |
| </code></p></div> |
| |
| <p>The case of the extension does not matter. Blank lines, and lines |
| beginning with a hash character (<code>#</code>) are ignored.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPCompareDNOnServer" id="AuthLDAPCompareDNOnServer">AuthLDAPCompareDNOnServer</a> <a name="authldapcomparednonserver" id="authldapcomparednonserver">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use the LDAP server to compare the DNs</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPCompareDNOnServer on|off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPCompareDNOnServer on</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>When set, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will use the LDAP |
| server to compare the DNs. This is the only foolproof way to |
| compare DNs. <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will search the |
| directory for the DN specified with the <a href="#reqdn"><code>Require dn</code></a> directive, then, |
| retrieve the DN and compare it with the DN retrieved from the user |
| entry. If this directive is not set, |
| <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> simply does a string comparison. It |
| is possible to get false negatives with this approach, but it is |
| much faster. Note the <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> cache can speed up |
| DN comparison in most situations.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPDereferenceAliases" id="AuthLDAPDereferenceAliases">AuthLDAPDereferenceAliases</a> <a name="authldapdereferencealiases" id="authldapdereferencealiases">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>When will the module de-reference aliases</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPDereferenceAliases never|searching|finding|always</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPDereferenceAliases Always</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>This directive specifies when <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will |
| de-reference aliases during LDAP operations. The default is |
| <code>always</code>.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPEnabled" id="AuthLDAPEnabled">AuthLDAPEnabled</a> <a name="authldapenabled" id="authldapenabled">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Turn on or off LDAP authentication</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> AuthLDAPEnabled on|off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPEnabled on</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>Set to <code>off</code> to disable |
| <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> in certain directories. This is |
| useful if you have <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> enabled at or |
| near the top of your tree, but want to disable it completely in |
| certain locations.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPFrontPageHack" id="AuthLDAPFrontPageHack">AuthLDAPFrontPageHack</a> <a name="authldapfrontpagehack" id="authldapfrontpagehack">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Allow LDAP authentication to work with MS FrontPage</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPFrontPageHack on|off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPFrontPageHack off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>See the section on <a href="#frontpage">using Microsoft |
| FrontPage</a> with <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code>.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPGroupAttribute" id="AuthLDAPGroupAttribute">AuthLDAPGroupAttribute</a> <a name="authldapgroupattribute" id="authldapgroupattribute">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>LDAP attributes used to check for group membership</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPGroupAttribute <em>attribute</em></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>This directive specifies which LDAP attributes are used to |
| check for group membership. Multiple attributes can be used by |
| specifying this directive multiple times. If not specified, |
| then <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> uses the <code>member</code> and |
| <code>uniquemember</code> attributes.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPGroupAttributeIsDN" id="AuthLDAPGroupAttributeIsDN">AuthLDAPGroupAttributeIsDN</a> <a name="authldapgroupattributeisdn" id="authldapgroupattributeisdn">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use the DN of the client username when checking for |
| group membership</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPGroupAttributeIsDN on|off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPGroupAttributeIsDN on</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>When set <code>on</code>, this directive says to use the |
| distinguished name of the client username when checking for group |
| membership. Otherwise, the username will be used. For example, |
| assume that the client sent the username <code>bjenson</code>, |
| which corresponds to the LDAP DN <code>cn=Babs Jenson, |
| o=Airius</code>. If this directive is set, |
| <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will check if the group has |
| <code>cn=Babs Jenson, o=Airius</code> as a member. If this |
| directive is not set, then <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will |
| check if the group has <code>bjenson</code> as a member.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPRemoteUserIsDN" id="AuthLDAPRemoteUserIsDN">AuthLDAPRemoteUserIsDN</a> <a name="authldapremoteuserisdn" id="authldapremoteuserisdn">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use the DN of the client username to set the REMOTE_USER |
| environment variable</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPRemoteUserIsDN on|off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthLDAPRemoteUserIsDN off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>If this directive is set to on, the value of the |
| <code>REMOTE_USER</code> environment variable will be set to the full |
| distinguished name of the authenticated user, rather than just |
| the username that was passed by the client. It is turned off by |
| default.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthLDAPUrl" id="AuthLDAPUrl">AuthLDAPUrl</a> <a name="authldapurl" id="authldapurl">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>URL specifying the LDAP search parameters</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthLDAPUrl <em>url</em></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_ldap</td></tr> |
| </table> |
| <p>An RFC 2255 URL which specifies the LDAP search parameters |
| to use. The syntax of the URL is</p> |
| <div class="example"><p><code>ldap://host:port/basedn?attribute?scope?filter</code></p></div> |
| |
| <dl> |
| <dt>ldap</dt> |
| |
| <dd>For regular ldap, use the |
| string <code>ldap</code>. For secure LDAP, use <code>ldaps</code> |
| instead. Secure LDAP is only available if Apache was linked |
| to an LDAP library with SSL support.</dd> |
| |
| <dt>host:port</dt> |
| |
| <dd> |
| <p>The name/port of the ldap server (defaults to |
| <code>localhost:389</code> for <code>ldap</code>, and |
| <code>localhost:636</code> for <code>ldaps</code>). To |
| specify multiple, redundant LDAP servers, just list all |
| servers, separated by spaces. <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> |
| will try connecting to each server in turn, until it makes a |
| successful connection.</p> |
| |
| <p>Once a connection has been made to a server, that |
| connection remains active for the life of the |
| <code>httpd</code> process, or until the LDAP server goes |
| down.</p> |
| |
| <p>If the LDAP server goes down and breaks an existing |
| connection, <code class="module"><a href="../mod/mod_auth_ldap.html">mod_auth_ldap</a></code> will attempt to |
| re-connect, starting with the primary server, and trying |
| each redundant server in turn. Note that this is different |
| than a true round-robin search.</p> |
| </dd> |
| |
| <dt>basedn</dt> |
| |
| <dd>The DN of the branch of the |
| directory where all searches should start from. At the very |
| least, this must be the top of your directory tree, but |
| could also specify a subtree in the directory.</dd> |
| |
| <dt>attribute</dt> |
| |
| <dd>The attribute to search for. |
| Although RFC 2255 allows a comma-separated list of |
| attributes, only the first attribute will be used, no |
| matter how many are provided. If no attributes are |
| provided, the default is to use <code>uid</code>. It's a good |
| idea to choose an attribute that will be unique across all |
| entries in the subtree you will be using.</dd> |
| |
| <dt>scope</dt> |
| |
| <dd>The scope of the search. Can be either <code>one</code> or |
| <code>sub</code>. Note that a scope of <code>base</code> is |
| also supported by RFC 2255, but is not supported by this |
| module. If the scope is not provided, or if <code>base</code> scope |
| is specified, the default is to use a scope of |
| <code>sub</code>.</dd> |
| |
| <dt>filter</dt> |
| |
| <dd>A valid LDAP search filter. If |
| not provided, defaults to <code>(objectClass=*)</code>, which |
| will search for all objects in the tree. Filters are |
| limited to approximately 8000 characters (the definition of |
| <code>MAX_STRING_LEN</code> in the Apache source code). This |
| should be than sufficient for any application.</dd> |
| </dl> |
| |
| <p>When doing searches, the attribute, filter and username passed |
| by the HTTP client are combined to create a search filter that |
| looks like |
| <code>(&(<em>filter</em>)(<em>attribute</em>=<em>username</em>))</code>.</p> |
| |
| <p>For example, consider an URL of |
| <code>ldap://ldap.airius.com/o=Airius?cn?sub?(posixid=*)</code>. When |
| a client attempts to connect using a username of <code>Babs |
| Jenson</code>, the resulting search filter will be |
| <code>(&(posixid=*)(cn=Babs Jenson))</code>.</p> |
| |
| <p>See above for examples of <code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code> URLs.</p> |
| |
| </div> |
| </div> |
| <div class="bottomlang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_auth_ldap.html" title="English"> en </a></p> |
| </div><div id="footer"> |
| <p class="apache">Copyright 2013 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> |
| <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> |
| </body></html> |
