<status>Extension</status>
<sourcefile>mod_authnz_ldap.c</sourcefile>
<identifier>authnz_ldap_module</identifier>
-<compatibility>Available in version 2.1 and later</compatibility>
<summary>
- <p>This module provides authentication front-ends such as
- <module>mod_auth_basic</module> to authenticate users through
+ <p>This module allows authentication front-ends such as
+ <module>mod_auth_basic</module> to authenticate users through
an ldap directory.</p>
-
+
<p><module>mod_authnz_ldap</module> supports the following features:</p>
<ul>
<section id="contents"><title>Contents</title>
<ul>
- <li>
- <a href="#operation">Operation</a>
+ <li> <a href="#gcaveats">General caveats</a> </li>
+ <li> <a href="#operation">Operation</a>
<ul>
<li><a href="#authenphase">The Authentication
</li>
<li>
- <a href="#requiredirectives">The Require Directives</a>
+ <a href="#requiredirectives">The Require Directives</a>
<ul>
- <li><a href="#reqvaliduser">Require valid-user</a></li>
<li><a href="#requser">Require ldap-user</a></li>
<li><a href="#reqgroup">Require ldap-group</a></li>
<li><a href="#reqdn">Require ldap-dn</a></li>
<li><a href="#reqattribute">Require ldap-attribute</a></li>
<li><a href="#reqfilter">Require ldap-filter</a></li>
+ <li><a href="#reqsearch">Require ldap-search</a></li>
</ul>
</li>
<li><a href="#activedirectory">Using Active Directory</a></li>
<li>
<a href="#frontpage">Using Microsoft FrontPage with
- <module>mod_authnz_ldap</module></a>
+ <module>mod_authnz_ldap</module></a>
<ul>
<li><a href="#howitworks">How It Works</a></li>
</ul>
</section>
+<section id="gcaveats"><title>General caveats</title>
+<p> This module caches authentication and authorization results based
+on the configuration of <module>mod_ldap</module>. Changes
+made to the backing LDAP server will not be immediately reflected on the
+HTTP Server, including but not limited to user lockouts/revocations,
+password changes, or changes to group memberships. Consult the directives
+in <module>mod_ldap</module> for details of the cache tunables.
+</p>
+</section>
+
<section id="operation"><title>Operation</title>
<p>There are two phases in granting access to a user. The first
phase is authentication, in which the <module>mod_authnz_ldap</module>
- authentication provider verifies that the user's credentials are valid.
+ authentication provider verifies that the user's credentials are valid.
This is also called the <em>search/bind</em> phase. The second phase is
authorization, in which <module>mod_authnz_ldap</module> determines
if the authenticated user is allowed access to the resource in
<p><module>mod_authnz_ldap</module> registers both an authn_ldap authentication
provider and an authz_ldap authorization handler. The authn_ldap
- authentication provider can be enabled through the
- <directive module="mod_auth_basic">AuthBasicProvider</directive> directive
- using the <code>ldap</code> value. The authz_ldap handler extends the
+ authentication provider can be enabled through the
+ <directive module="mod_auth_basic">AuthBasicProvider</directive> directive
+ using the <code>ldap</code> value. The authz_ldap handler extends the
<directive module="mod_authz_core">Require</directive> directive's authorization types
- by adding <code>ldap-user</code>, <code>ldap-dn</code> and <code>ldap-group</code>
+ by adding <code>ldap-user</code>, <code>ldap-dn</code> and <code>ldap-group</code>
values.</p>
<section id="authenphase"><title>The Authentication
access.</li>
<li>Fetch the distinguished name of the entry retrieved from
- the search and attempt to bind to the LDAP server using the
+ the search and attempt to bind to the LDAP server using that
DN and the password passed by the HTTP client. If the bind is
unsuccessful, deny or decline access.</li>
</ol>
one of its sub-groups.</li>
<li>Grant access if there is a <a href="#reqattribute">
- <code>Require ldap-attribute</code></a>
+ <code>Require ldap-attribute</code></a>
directive, and the attribute fetched from the LDAP directory
- matches the given value.</li>
+ matches the given value.</li>
<li>Grant access if there is a <a href="#reqfilter">
- <code>Require ldap-filter</code></a>
+ <code>Require ldap-filter</code></a>
directive, and the search filter successfully finds a single user
- object that matches the dn of the authenticated user.</li>
+ object that matches the dn of the authenticated user.</li>
+
+ <li>Grant access if there is a <a href="#reqsearch">
+ <code>Require ldap-search</code></a>
+ directive, and the search filter successfully returns a single
+ matching object with any distinguished name.</li>
<li>otherwise, deny or decline access</li>
</ul>
be used which may require loading additional authorization modules.</p>
<ul>
- <li>Grant access if there is a <a href="#requser"><code>Require
- valid-user</code></a> directive. (requires
- <module>mod_authz_user</module>)</li>
+ <li>Grant access to all successfully authenticated users if
+ there is a <a href="#requser"><code>Require valid-user</code></a>
+ directive. (requires <module>mod_authz_user</module>)</li>
<li>Grant access if there is a <a
href="#reqgroup"><code>Require group</code></a> directive, and
- <module>mod_authz_groupfile</module> has been loaded with the
- <directive module="mod_authz_groupfile">AuthGroupFile</directive>
+ <module>mod_authz_groupfile</module> has been loaded with the
+ <directive module="mod_authz_groupfile">AuthGroupFile</directive>
directive set.</li>
-
+
<li>others...</li>
</ul>
<p>Apache's <directive module="mod_authz_core">Require</directive>
directives are used during the authorization phase to ensure that
- a user is allowed to access a resource. mod_authnz_ldap extends the
- authorization types with <code>ldap-user</code>, <code>ldap-dn</code>,
- <code>ldap-group</code>, <code>ldap-attribute</code> and
- <code>ldap-filter</code>. Other authorization types may also be
+ a user is allowed to access a resource. mod_authnz_ldap extends the
+ authorization types with <code>ldap-user</code>, <code>ldap-dn</code>,
+ <code>ldap-group</code>, <code>ldap-attribute</code> and
+ <code>ldap-filter</code>. Other authorization types may also be
used but may require that additional authorization modules be loaded.</p>
-<section id="reqvaliduser"><title>Require valid-user</title>
-
- <p>If this directive exists, <module>mod_authnz_ldap</module> grants
- access to any user that has successfully authenticated during the
- search/bind phase. Requires that <module>mod_authz_user</module> be
- loaded.</p>
-</section>
+ <p>Since v2.4.8, <a href="../expr.html">expressions</a> are supported
+ within the LDAP require directives.</p>
<section id="requser"><title>Require ldap-user</title>
granted access by using multiple <code>Require ldap-user</code>
directives, with one user per line. For example, with a <directive
module="mod_authnz_ldap">AuthLDAPURL</directive> of
- <code>ldap://ldap/o=Airius?cn</code> (i.e., <code>cn</code> is
+ <code>ldap://ldap/o=Example?cn</code> (i.e., <code>cn</code> is
used for searches), the following Require directives could be used
to restrict access:</p>
-<example>
-Require ldap-user "Barbara Jenson"<br />
-Require ldap-user "Fred User"<br />
-Require ldap-user "Joe Manager"<br />
-</example>
+<highlight language="config">
+Require ldap-user "Barbara Jenson"
+Require ldap-user "Fred User"
+Require ldap-user "Joe Manager"
+</highlight>
<p>Because of the way that <module>mod_authnz_ldap</module> handles this
directive, Barbara Jenson could sign on as <em>Barbara
<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>
-<example>Require ldap-user bjenson fuser jmanager</example>
+<highlight language="config">
+Require ldap-user bjenson fuser jmanager
+</highlight>
</section>
<section id="reqgroup"><title>Require ldap-group</title>
group. Note: Do not surround the group name with quotes.
For example, assume that the following entry existed in
the LDAP directory:</p>
-<example>
-dn: cn=Administrators, o=Airius<br />
-objectClass: groupOfUniqueNames<br />
-uniqueMember: cn=Barbara Jenson, o=Airius<br />
-uniqueMember: cn=Fred User, o=Airius<br />
-</example>
+<example><pre>
+dn: cn=Administrators, o=Example
+objectClass: groupOfUniqueNames
+uniqueMember: cn=Barbara Jenson, o=Example
+uniqueMember: cn=Fred User, o=Example
+</pre></example>
<p>The following directive would grant access to both Fred and
Barbara:</p>
-<example>Require ldap-group cn=Administrators, o=Airius</example>
+<highlight language="config">
+Require ldap-group cn=Administrators, o=Example
+</highlight>
<p>Members can also be found within sub-groups of a specified LDAP group
if <directive module="mod_authnz_ldap">AuthLDAPMaxSubGroupDepth</directive>
is set to a value greater than 0. For example, assume the following entries
exist in the LDAP directory:</p>
-<example>
-dn: cn=Employees, o=Airius<br />
-objectClass: groupOfUniqueNames<br />
-uniqueMember: cn=Managers, o=Airius<br />
-uniqueMember: cn=Administrators, o=Airius<br />
-uniqueMember: cn=Users, o=Airius<br />
-<br />
-dn: cn=Managers, o=Airius<br />
-objectClass: groupOfUniqueNames<br />
-uniqueMember: cn=Bob Ellis, o=Airius<br />
-uniqueMember: cn=Tom Jackson, o=Airius<br />
-<br />
-dn: cn=Administrators, o=Airius<br />
-objectClass: groupOfUniqueNames<br />
-uniqueMember: cn=Barbara Jenson, o=Airius<br />
-uniqueMember: cn=Fred User, o=Airius<br />
-<br />
-dn: cn=Users, o=Airius<br />
-objectClass: groupOfUniqueNames<br />
-uniqueMember: cn=Allan Jefferson, o=Airius<br />
-uniqueMember: cn=Paul Tilley, o=Airius<br />
-uniqueMember: cn=Temporary Employees, o=Airius<br />
-<br />
-dn: cn=Temporary Employees, o=Airius<br />
-objectClass: groupOfUniqueNames<br />
-uniqueMember: cn=Jim Swenson, o=Airius<br />
-uniqueMember: cn=Elliot Rhodes, o=Airius<br />
-</example>
+<example><pre>
+dn: cn=Employees, o=Example
+objectClass: groupOfUniqueNames
+uniqueMember: cn=Managers, o=Example
+uniqueMember: cn=Administrators, o=Example
+uniqueMember: cn=Users, o=Example
+
+dn: cn=Managers, o=Example
+objectClass: groupOfUniqueNames
+uniqueMember: cn=Bob Ellis, o=Example
+uniqueMember: cn=Tom Jackson, o=Example
+
+dn: cn=Administrators, o=Example
+objectClass: groupOfUniqueNames
+uniqueMember: cn=Barbara Jenson, o=Example
+uniqueMember: cn=Fred User, o=Example
+
+dn: cn=Users, o=Example
+objectClass: groupOfUniqueNames
+uniqueMember: cn=Allan Jefferson, o=Example
+uniqueMember: cn=Paul Tilley, o=Example
+uniqueMember: cn=Temporary Employees, o=Example
+
+dn: cn=Temporary Employees, o=Example
+objectClass: groupOfUniqueNames
+uniqueMember: cn=Jim Swenson, o=Example
+uniqueMember: cn=Elliot Rhodes, o=Example
+</pre></example>
<p>The following directives would allow access for Bob Ellis, Tom Jackson,
- Barbara Jensen, Fred User, Allan Jefferson, and Paul Tilley but would not
- allow access for Jim Swenson, or Elliot Rhodes (since they are at a
+ Barbara Jenson, Fred User, Allan Jefferson, and Paul Tilley but would not
+ allow access for Jim Swenson, or Elliot Rhodes (since they are at a
sub-group depth of 2):</p>
-<example>
-Require ldap-group cn=Employees, o-Airius<br />
-AuthLDAPSubGroupDepth 1<br />
-</example>
+<highlight language="config">
+Require ldap-group cn=Employees, o=Example
+AuthLDAPMaxSubGroupDepth 1
+</highlight>
<p>Behavior of this directive is modified by the <directive
module="mod_authnz_ldap">AuthLDAPGroupAttribute</directive>, <directive
<p>The following directive would grant access to a specific
DN:</p>
-<example>Require ldap-dn cn=Barbara Jenson, o=Airius</example>
+<highlight language="config">
+Require ldap-dn cn=Barbara Jenson, o=Example
+</highlight>
<p>Behavior of this directive is modified by the <directive
module="mod_authnz_ldap">AuthLDAPCompareDNOnServer</directive>
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>
- <example>Require ldap-attribute employeeType=active</example>
+ <highlight language="config">
+Require ldap-attribute "employeeType=active"
+</highlight>
<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 the
- corresponding attribute in the user object. If the value of the
+ 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 the
+ 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>
- <example>Require ldap-attribute city="San Jose" status=active</example>
+ <highlight language="config">
+Require ldap-attribute city="San Jose" "status=active"
+</highlight>
</section>
administrator to grant access based on a complex LDAP search filter.
If the dn returned by the filter search matches the authenticated user
dn, access is granted.</p>
-
+
<p>The following directive would grant access to anyone having a cell phone
and is in the marketing department</p>
- <example>Require ldap-filter &(cell=*)(department=marketing)</example>
+ <highlight language="config">
+Require ldap-filter "&(cell=*)(department=marketing)"
+</highlight>
- <p>The difference between the <code>Require ldap-filter</code> directive and the
- <code>Require ldap-attribute</code> directive is that <code>ldap-filter</code>
- performs a search operation on the LDAP directory using the specified search
- filter rather than a simple attribute comparison. If a simple attribute
- comparison is all that is required, the comparison operation performed by
- <code>ldap-attribute</code> will be faster than the search operation
+ <p>The difference between the <code>Require ldap-filter</code> directive and the
+ <code>Require ldap-attribute</code> directive is that <code>ldap-filter</code>
+ performs a search operation on the LDAP directory using the specified search
+ filter rather than a simple attribute comparison. If a simple attribute
+ comparison is all that is required, the comparison operation performed by
+ <code>ldap-attribute</code> will be faster than the search operation
used by <code>ldap-filter</code> especially within a large directory.</p>
+ <p>When using an <a href="../expr.html">expression</a> within the filter, care
+ must be taken to ensure that LDAP filters are escaped correctly to guard against
+ LDAP injection. The ldap function can be used for this purpose.</p>
+
+<highlight language="config">
+<LocationMatch "^/dav/(?<SITENAME>[^/]+)/">
+ Require ldap-filter "(memberOf=cn=%{ldap:%{unescape:%{env:MATCH_SITENAME}},ou=Websites,o=Example)"
+</LocationMatch>
+</highlight>
+
+</section>
+
+<section id="reqsearch"><title>Require ldap-search</title>
+
+ <p>The <code>Require ldap-search</code> directive allows the
+ administrator to grant access based on a generic LDAP search filter using an
+ <a href="../expr.html">expression</a>. If there is exactly one match to the search filter,
+ regardless of the distinguished name, access is granted.</p>
+
+ <p>The following directive would grant access to URLs that match the given objects in the
+ LDAP server:</p>
+
+<highlight language="config">
+<LocationMatch "^/dav/(?<SITENAME>[^/]+)/">
+Require ldap-search "(cn=%{ldap:%{unescape:%{env:MATCH_SITENAME}} Website)"
+</LocationMatch>
+</highlight>
+
+ <p>Note: care must be taken to ensure that any expressions are properly escaped to guard
+ against LDAP injection. The <strong>ldap</strong> function can be used as per the example
+ above.</p>
+
</section>
</section>
<ul>
<li>
Grant access to anyone who exists in the LDAP directory,
- using their UID for searches.
-<example>
-AuthLDAPURL "ldap://ldap1.airius.com:389/ou=People, o=Airius?uid?sub?(objectClass=*)"<br />
+ using their UID for searches.
+<highlight language="config">
+AuthLDAPURL "ldap://ldap1.example.com:389/ou=People, o=Example?uid?sub?(objectClass=*)"
Require valid-user
-</example>
+</highlight>
</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.
-<example>AuthLDAPURL "ldap://ldap1.airius.com ldap2.airius.com/ou=People, o=Airius"<br />
+ redundant LDAP server.
+<highlight language="config">
+AuthLDAPURL "ldap://ldap1.example.com ldap2.example.com/ou=People, o=Example"
Require valid-user
-</example>
+</highlight>
</li>
<li>
<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>.
-<example>
-AuthLDAPURL "ldap://ldap.airius.com/ou=People, o=Airius?cn"<br />
+ directory, such as <code>uid</code>.
+<highlight language="config">
+AuthLDAPURL "ldap://ldap.example.com/ou=People, o=Example?cn"
Require valid-user
-</example>
+</highlight>
</li>
<li>
Grant access to anybody in the Administrators group. The
- users must authenticate using their UID.
-<example>
-AuthLDAPURL ldap://ldap.airius.com/o=Airius?uid<br />
-Require ldap-group cn=Administrators, o=Airius
-</example>
+ users must authenticate using their UID.
+<highlight language="config">
+AuthLDAPURL ldap://ldap.example.com/o=Example?uid
+Require ldap-group cn=Administrators, o=Example
+</highlight>
+ </li>
+
+ <li>
+ Grant access to anybody in the group whose name matches the
+ hostname of the virtual host. In this example an
+ <a href="../expr.html">expression</a> is used to build the filter.
+<highlight language="config">
+AuthLDAPURL ldap://ldap.example.com/o=Example?uid
+Require ldap-group cn=%{SERVER_NAME}, o=Example
+</highlight>
</li>
<li>
- The next example assumes that everyone at Airius who
+ The next example assumes that everyone at Example 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:
-<example>
-AuthLDAPURL ldap://ldap.airius.com/o=Airius?uid??(qpagePagerID=*)<br />
+ alphanumeric pagers:
+<highlight language="config">
+AuthLDAPURL ldap://ldap.example.com/o=Example?uid??(qpagePagerID=*)
Require valid-user
-</example>
+</highlight>
</li>
<li>
a pager, plus grant access to Joe Manager, who doesn't
have a pager, but does need to access the same
resource:</p>
-<example>
-AuthLDAPURL ldap://ldap.airius.com/o=Airius?uid??(|(qpagePagerID=*)(uid=jmanager))<br />
+<highlight language="config">
+AuthLDAPURL ldap://ldap.example.com/o=Example?uid??(|(qpagePagerID=*)(uid=jmanager))
Require valid-user
-</example>
+</highlight>
<p>This last may look confusing at first, so it helps to
evaluate what the search filter will look like based on who
module="mod_ldap">LDAPTrustedGlobalCert</directive> and <directive
module="mod_ldap">LDAPTrustedMode</directive>.</p>
- <p>An optional second parameter can be added to the
+ <p>An optional second parameter can be added to the
<directive module="mod_authnz_ldap">AuthLDAPURL</directive> to override
the default connection type set by <directive module="mod_ldap">LDAPTrustedMode</directive>.
- This will allow the connection established by an <em>ldap://</em> Url
+ This will allow the connection established by an <em>ldap://</em> Url
to be upgraded to a secure connection on the same port.</p>
</section>
<section id="exposed"><title>Exposing Login Information</title>
- <p>When this module performs authentication, LDAP attributes specified
- in the <directive module="mod_authnz_ldap">AuthLDAPUrl</directive>
+ <p>when this module performs <em>authentication</em>, ldap attributes specified
+ in the <directive module="mod_authnz_ldap">authldapurl</directive>
directive are placed in environment variables with the prefix "AUTHENTICATE_".</p>
+ <p>when this module performs <em>authorization</em>, ldap attributes specified
+ in the <directive module="mod_authnz_ldap">authldapurl</directive>
+ directive are placed in environment variables with the prefix "AUTHORIZE_".</p>
+
<p>If the attribute field contains the username, common name
and telephone number of a user, a CGI program will have access to
this information without the need to make a second independent LDAP
subtree search for the attribute <em>userPrincipalName</em>, with
an empty search root, like so:</p>
-<example>
-AuthLDAPBindDN apache@example.com<br />
-AuthLDAPBindPassword password<br />
+<highlight language="config">
+AuthLDAPBindDN apache@example.com
+AuthLDAPBindPassword password
AuthLDAPURL ldap://10.0.0.1:3268/?userPrincipalName?sub
-</example>
+</highlight>
<p>Users will need to enter their User Principal Name as a login, in
the form <em>somebody@nz.example.com</em>.</p>
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>
-<example><pre>
-AuthLDAPURL "the url"
-AuthGroupFile <em>mygroupfile</em>
-Require group <em>mygroupfile</em>
-</pre></example>
+<highlight language="config">
+AuthLDAPURL "the url"
+AuthGroupFile "mygroupfile"
+Require group "mygroupfile"
+</highlight>
<section id="howitworks"><title>How It Works</title>
the LDAP directory is considered a valid user, whereas FrontPage
considers only those people in the local user file to be
valid. By substituting the ldap-group with group file authorization,
- Apache is allowed to consult the local user file (which is managed by
+ Apache is allowed to consult the local user file (which is managed by
FrontPage) - instead of LDAP - when handling authorizing the user.</p>
<p>Once directives have been added as specified above,
<module>mod_authn_file</module> and
<module>mod_authz_groupfile</module> in order to
use FrontPage support. This is because Apache will still use
- the <module>mod_authz_groupfile</module> group file for determine
+ the <module>mod_authz_groupfile</module> 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>
type="section">Location</directive> or <directive module="core"
type="section">Directory</directive> directives won't work. This
is because <module>mod_authnz_ldap</module> has to be able to grab
- the <directive module="mod_authn_file">AuthGroupFile</directive>
+ the <directive module="mod_authz_groupfile">AuthGroupFile</directive>
directive that is found in FrontPage <code>.htaccess</code>
files so that it knows where to look for the valid user list. If
the <module>mod_authnz_ldap</module> directives aren't in the same
</section>
</section>
+<directivesynopsis>
+<name>AuthLDAPAuthorizePrefix</name>
+<description>Specifies the prefix for environment variables set during
+authorization</description>
+<syntax>AuthLDAPAuthorizePrefix <em>prefix</em></syntax>
+<default>AuthLDAPAuthorizePrefix AUTHORIZE_</default>
+<contextlist><context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>AuthConfig</override>
+<compatibility>Available in version 2.3.6 and later</compatibility>
+<usage>
+ <p>This directive allows you to override the prefix used for environment
+ variables set during LDAP authorization. If <em>AUTHENTICATE_</em> is
+ specified, consumers of these environment variables see the same information
+ whether LDAP has performed authentication, authorization, or both.</p>
+
+ <note><title>Note</title>
+ No authorization variables are set when a user is authorized on the basis of
+ <code>Require valid-user</code>.
+ </note>
+</usage>
+</directivesynopsis>
+
+
+<directivesynopsis>
+<name>AuthLDAPBindAuthoritative</name>
+<description>Determines if other authentication providers are used when a user can be mapped to a DN but the server cannot successfully bind with the user's credentials.</description>
+<syntax>AuthLDAPBindAuthoritative off|on</syntax>
+<default>AuthLDAPBindAuthoritative on</default>
+<contextlist><context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>AuthConfig</override>
+<usage>
+ <p>By default, subsequent authentication providers are only queried if a
+ user cannot be mapped to a DN, but not if the user can be mapped to a DN and their
+ password cannot be verified with an LDAP bind.
+ If <directive>AuthLDAPBindAuthoritative</directive>
+ is set to <em>off</em>, other configured authentication modules will have
+ a chance to validate the user if the LDAP bind (with the current user's credentials)
+ fails for any reason.</p>
+ <p> This allows users present in both LDAP and
+ <directive module="mod_authn_file">AuthUserFile</directive> to authenticate
+ when the LDAP server is available but the user's account is locked or password
+ is otherwise unusable.</p>
+</usage>
+<seealso><directive module="mod_authn_file">AuthUserFile</directive></seealso>
+<seealso><directive module="mod_auth_basic">AuthBasicProvider</directive></seealso>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>AuthLDAPInitialBindAsUser</name>
+<description>Determines if the server does the initial DN lookup using the basic authentication users'
+own username, instead of anonymously or with hard-coded credentials for the server</description>
+<syntax>AuthLDAPInitialBindAsUser off|on</syntax>
+<default>AuthLDAPInitialBindAsUser off</default>
+<contextlist><context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>AuthConfig</override>
+<compatibility>Available in version 2.3.6 and later</compatibility>
+<usage>
+ <p>By default, the server either anonymously, or with a dedicated user and
+ password, converts the basic authentication username into an LDAP
+ distinguished name (DN). This directive forces the server to use the verbatim username
+ and password provided by the incoming user to perform the initial DN
+ search.</p>
+
+ <p> If the verbatim username can't directly bind, but needs some
+ cosmetic transformation, see <directive module="mod_authnz_ldap">
+ AuthLDAPInitialBindPattern</directive>.</p>
+
+ <p> This directive should only be used when your LDAP server doesn't
+ accept anonymous searches and you cannot use a dedicated
+ <directive module="mod_authnz_ldap">AuthLDAPBindDN</directive>.
+ </p>
+
+ <note><title>Not available with authorization-only</title>
+ This directive can only be used if this module authenticates the user, and
+ has no effect when this module is used exclusively for authorization.
+ </note>
+</usage>
+<seealso><directive module="mod_authnz_ldap">AuthLDAPInitialBindPattern</directive></seealso>
+<seealso><directive module="mod_authnz_ldap">AuthLDAPBindDN</directive></seealso>
+<seealso><directive module="mod_authnz_ldap">AuthLDAPCompareAsUser</directive></seealso>
+<seealso><directive module="mod_authnz_ldap">AuthLDAPSearchAsUser</directive></seealso>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>AuthLDAPInitialBindPattern</name>
+<description>Specifies the transformation of the basic authentication username to be used when binding to the LDAP server
+to perform a DN lookup</description>
+<syntax>AuthLDAPInitialBindPattern <em><var>regex</var> <var>substitution</var></em></syntax>
+<default>AuthLDAPInitialBindPattern (.*) $1 (remote username used verbatim)</default>
+<contextlist><context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>AuthConfig</override>
+<compatibility>Available in version 2.3.6 and later</compatibility>
+<usage>
+ <p>If <directive module="mod_authnz_ldap">AuthLDAPInitialBindAsUser</directive> is set to
+ <em>ON</em>, the basic authentication username will be transformed according to the
+ regular expression and substitution arguments.</p>
+
+ <p> The regular expression argument is compared against the current basic authentication username.
+ The substitution argument may contain backreferences, but has no other variable interpolation.</p>
+
+ <p> This directive should only be used when your LDAP server doesn't
+ accept anonymous searches and you cannot use a dedicated
+ <directive module="mod_authnz_ldap">AuthLDAPBindDN</directive>.
+ </p>
+
+ <highlight language="config">
+AuthLDAPInitialBindPattern (.+) $1@example.com
+ </highlight>
+ <highlight language="config">
+AuthLDAPInitialBindPattern (.+) cn=$1,dc=example,dc=com
+ </highlight>
+
+ <note><title>Not available with authorization-only</title>
+ This directive can only be used if this module authenticates the user, and
+ has no effect when this module is used exclusively for authorization.
+ </note>
+ <note><title>debugging</title>
+ The substituted DN is recorded in the environment variable
+ <em>LDAP_BINDASUSER</em>. If the regular expression does not match the input,
+ the verbatim username is used.
+ </note>
+</usage>
+<seealso><directive module="mod_authnz_ldap">AuthLDAPInitialBindAsUser</directive></seealso>
+<seealso><directive module="mod_authnz_ldap">AuthLDAPBindDN</directive></seealso>
+</directivesynopsis>
+
<directivesynopsis>
<name>AuthLDAPBindDN</name>
<description>Optional DN to use in binding to the LDAP server</description>
<directivesynopsis>
<name>AuthLDAPBindPassword</name>
-<description>Password used in conjuction with the bind DN</description>
+<description>Password used in conjunction with the bind DN</description>
<syntax>AuthLDAPBindPassword <em>password</em></syntax>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>AuthConfig</override>
+<compatibility><em>exec:</em> was added in 2.4.5.</compatibility>
<usage>
<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 <directive
module="mod_authnz_ldap">AuthLDAPBindDN</directive> and <directive
- module="mod_authnz_ldap">AuthLDAPBindPassword</directive> if you
- absolutely need them to search the directory.</p>
+ >AuthLDAPBindPassword</directive> if you
+ absolutely need them to search the directory.</p>
+
+ <p>If the value begins with exec: the resulting command will be
+ executed and the first line returned to standard output by the
+ program will be used as the password.</p>
+<highlight language="config">
+#Password used as-is
+AuthLDAPBindPassword secret
+
+#Run /path/to/program to get my password
+AuthLDAPBindPassword exec:/path/to/program
+
+#Run /path/to/otherProgram and provide arguments
+AuthLDAPBindPassword "exec:/path/to/otherProgram argument1"
+</highlight>
+
</usage>
</directivesynopsis>
</usage>
</directivesynopsis>
+<directivesynopsis>
+<name>AuthLDAPCompareAsUser</name>
+<description>Use the authenticated user's credentials to perform authorization comparisons</description>
+<syntax>AuthLDAPCompareAsUser on|off</syntax>
+<default>AuthLDAPCompareAsUser off</default>
+<contextlist><context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>AuthConfig</override>
+<compatibility>Available in version 2.3.6 and later</compatibility>
+
+<usage>
+ <p>When set, and <module>mod_authnz_ldap</module> has authenticated the
+ user, LDAP comparisons for authorization use the queried distinguished name (DN)
+ and HTTP basic authentication password of the authenticated user instead of
+ the servers configured credentials.</p>
+
+ <p> The <em>ldap-attribute</em>, <em>ldap-user</em>, and <em>ldap-group</em> (single-level only)
+ authorization checks use comparisons.</p>
+
+ <p>This directive only has effect on the comparisons performed during
+ nested group processing when <directive module="mod_authnz_ldap">
+ AuthLDAPSearchAsUser</directive> is also enabled.</p>
+
+ <p> This directive should only be used when your LDAP server doesn't
+ accept anonymous comparisons and you cannot use a dedicated
+ <directive module="mod_authnz_ldap">AuthLDAPBindDN</directive>.
+ </p>
+</usage>
+<seealso><directive module="mod_authnz_ldap">AuthLDAPInitialBindAsUser</directive></seealso>
+<seealso><directive module="mod_authnz_ldap">AuthLDAPSearchAsUser</directive></seealso>
+</directivesynopsis>
+
<directivesynopsis>
<name>AuthLDAPCompareDNOnServer</name>
<description>Use the LDAP server to compare the DNs</description>
<description>LDAP attributes used to identify the user members of
groups.</description>
<syntax>AuthLDAPGroupAttribute <em>attribute</em></syntax>
+<default>AuthLDAPGroupAttribute member uniquemember</default>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>AuthConfig</override>
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,
+ o=Example</code>. If this directive is set,
<module>mod_authnz_ldap</module> will check if the group has
- <code>cn=Babs Jenson, o=Airius</code> as a member. If this
+ <code>cn=Babs Jenson, o=Example</code> as a member. If this
directive is not set, then <module>mod_authnz_ldap</module> will
check if the group has <code>bjenson</code> as a member.</p>
</usage>
<description>Specifies the maximum sub-group nesting depth that will be
evaluated before the user search is discontinued.</description>
<syntax>AuthLDAPMaxSubGroupDepth <var>Number</var></syntax>
-<default>AuthLDAPMaxSubGroupDepth 10</default>
+<default>AuthLDAPMaxSubGroupDepth 0</default>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>AuthConfig</override>
+<compatibility>Available in version 2.3.0 and later, defaulted to 10 in 2.4.x and early 2.5</compatibility>
<usage>
<p>When this directive is set to a non-zero value <code>X</code>
level <code>X</code> specified by this directive.</p>
<p>See the <a href="#reqgroup"><code>Require ldap-group</code></a>
section for a more detailed example.</p>
+
+ <note><title>Nested groups performance</title>
+ <p> When <directive>AuthLDAPSubGroupAttribute</directive> overlaps with
+ <directive>AuthLDAPGroupAttribute</directive> (as it does by default and
+ as required by common LDAP schemas), uncached searching for subgroups in
+ large groups can be very slow. If you use large, non-nested groups, keep
+ <directive>AuthLDAPMaxSubGroupDepth</directive> set to zero.</p>
+ </note>
+
</usage>
</directivesynopsis>
<default>none</default>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
-<override>AuthConfig</override>
-
+<override>AuthConfig</override>
+
<usage>
- <p>If this directive is set, the value of the
+ <p>If this directive is set, the value of the
<code>REMOTE_USER</code> environment variable will be set to the
value of the attribute specified. Make sure that this attribute is
included in the list of attributes in the AuthLDAPUrl definition,
otherwise this directive will have no effect. This directive, if
- present, takes precedence over AuthLDAPRemoteUserIsDN. This
+ present, takes precedence over <directive module="mod_authnz_ldap"
+ >AuthLDAPRemoteUserIsDN</directive>. This
directive is useful should you want people to log into a website
using an email address, but a backend application expects the
username as a userid.</p>
+ <p> This directive only has effect when this module is used for
+ authentication.</p>
</usage>
</directivesynopsis>
distinguished name of the authenticated user, rather than just
the username that was passed by the client. It is turned off by
default.</p>
+ <p> This directive only has effect when this module is used for
+ authentication.</p>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>AuthLDAPSearchAsUser</name>
+<description>Use the authenticated user's credentials to perform authorization searches</description>
+<syntax>AuthLDAPSearchAsUser on|off</syntax>
+<default>AuthLDAPSearchAsUser off</default>
+<contextlist><context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>AuthConfig</override>
+<compatibility>Available in version 2.3.6 and later</compatibility>
+
+<usage>
+ <p>When set, and <module>mod_authnz_ldap</module> has authenticated the
+ user, LDAP searches for authorization use the queried distinguished name (DN)
+ and HTTP basic authentication password of the authenticated user instead of
+ the servers configured credentials.</p>
+
+ <p> The <em>ldap-filter</em> and <em>ldap-dn</em> authorization
+ checks use searches.</p>
+
+ <p>This directive only has effect on the comparisons performed during
+ nested group processing when <directive module="mod_authnz_ldap">
+ AuthLDAPCompareAsUser</directive> is also enabled.</p>
+
+ <p> This directive should only be used when your LDAP server doesn't
+ accept anonymous searches and you cannot use a dedicated
+ <directive module="mod_authnz_ldap">AuthLDAPBindDN</directive>.
+ </p>
</usage>
+<seealso><directive module="mod_authnz_ldap">AuthLDAPInitialBindAsUser</directive></seealso>
+<seealso><directive module="mod_authnz_ldap">AuthLDAPCompareAsUser</directive></seealso>
</directivesynopsis>
<directivesynopsis>
directive line, used to distinguish the members of the current group that
are groups.</description>
<syntax>AuthLDAPSubGroupAttribute <em>attribute</em></syntax>
+<default>AuthLDAPSubgroupAttribute member uniquemember</default>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>AuthConfig</override>
+<compatibility>Available in version 2.3.0 and later</compatibility>
<usage>
<p>An LDAP group object may contain members that are users and
members that are groups (called nested or sub groups). The
- <code>AuthLDAPSubGroupAttribute</code> directive identifies the
- labels of group members and the <code>AuthLDAPGroupAttribute</code>
+ <directive>AuthLDAPSubGroupAttribute</directive> directive identifies the
+ labels of group members and the <directive module="mod_authnz_ldap"
+ >AuthLDAPGroupAttribute</directive>
directive identifies the labels of the user members. Multiple
attributes can be used by specifying this directive multiple times.
If not specified, then <module>mod_authnz_ldap</module> uses the
<description>Specifies which LDAP objectClass values identify directory
objects that are groups during sub-group processing.</description>
<syntax>AuthLDAPSubGroupClass <em>LdapObjectClass</em></syntax>
+<default>AuthLDAPSubGroupClass groupOfNames groupOfUniqueNames</default>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>AuthConfig</override>
+<compatibility>Available in version 2.3.0 and later</compatibility>
<usage>
<p>An LDAP group object may contain members that are users and
members that are groups (called nested or sub groups). The
- <code>AuthLDAPSubGroupAttribute</code> directive identifies the
+ <directive module="mod_authnz_ldap">AuthLDAPSubGroupAttribute</directive>
+ directive identifies the
labels of members that may be sub-groups of the current group
- (as opposed to user members). The <code>AuthLDAPSubGroupClass</code>
+ (as opposed to user members). The <directive>AuthLDAPSubGroupClass</directive>
directive specifies the LDAP objectClass values used in verifying that
these potential sub-groups are in fact group objects. Verified sub-groups
can then be searched for more user or sub-group members. Multiple
to use. The syntax of the URL is</p>
<example>ldap://host:port/basedn?attribute?scope?filter</example>
<p>If you want to specify more than one LDAP URL that Apache should try in turn, the syntax is:</p>
-<example>AuthLDAPUrl "ldap://ldap1.example.com ldap2.example.com"</example>
-<p><em><strong>Caveat: </strong>If you specify multiple servers, you need to enclose the entire URL string in quotes;
-otherwise you will get an error: "AuthLDAPURL takes one argument, URL to define LDAP connection.." </em>
+<highlight language="config">
+AuthLDAPUrl "ldap://ldap1.example.com ldap2.example.com/dc=..."
+</highlight>
+<p><em><strong>Caveat: </strong>If you specify multiple servers, you need to enclose the entire URL string in quotes;
+otherwise you will get an error: "AuthLDAPURL takes one argument, URL to define LDAP connection.." </em>
You can of course use search parameters on each of these.</p>
<dl>
specify multiple, redundant LDAP servers, just list all
servers, separated by spaces. <module>mod_authnz_ldap</module>
will try connecting to each server in turn, until it makes a
- successful connection. If multiple ldap servers are specified,
+ successful connection. If multiple ldap servers are specified,
then entire LDAP URL must be encapsulated in double quotes.</p>
<p>Once a connection has been made to a server, that
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 more than sufficient for any application.</dd>
+ should be more than sufficient for any application. In 2.4.10 and later,
+ the keyword <code>none</code> disables the use of a filter; this is
+ required by some primitive LDAP servers.</dd>
</dl>
<p>When doing searches, the attribute, filter and username passed
<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
+ <code>ldap://ldap.example.com/o=Example?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>An optional parameter can be added to allow the LDAP Url to override
+ <p>An optional parameter can be added to allow the LDAP Url to override
the connection type. This parameter can be one of the following:</p>
<dl>
This is the same as <code>ldaps://</code></dd>
<dt>TLS | STARTTLS</dt>
<dd>Establish an upgraded secure connection on the default LDAP port.
- This connection will be initiated on port 389 by default and then
+ This connection will be initiated on port 389 by default and then
upgraded to a secure connection on the same port.</dd>
</dl>
<p>See above for examples of <directive
- module="mod_authnz_ldap">AuthLDAPURL</directive> URLs.</p>
+ module="mod_authnz_ldap">AuthLDAPUrl</directive> URLs.</p>
</usage>
</directivesynopsis>
projects / apache / blobdiff