granicus.if.org Git - apache/blob - docs/manual/mod/mod_ldap.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_ldap - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.4</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.4</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_ldap</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_ldap.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_ldap.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  29 </div>
  30 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>LDAP connection pooling and result caching services for use
  31 by other LDAP modules</td></tr>
  32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>ldap_module</td></tr>
  34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>util_ldap.c</td></tr>
  35 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.41 and later</td></tr></table>
  36 <h3>Summary</h3>
  37
  38     <p>This module was created to improve the performance of
  39     websites relying on backend connections to LDAP servers. In
  40     addition to the functions provided by the standard LDAP
  41     libraries, this module adds an LDAP connection pool and an LDAP
  42     shared memory cache.</p>
  43
  44     <p>To enable this module, LDAP support must be compiled into
  45     apr-util. This is achieved by adding the <code>--with-ldap</code>
  46     flag to the <code class="program"><a href="../programs/configure.html">configure</a></code> script when building
  47     Apache.</p>
  48
  49     <p>SSL/TLS support is dependant on which LDAP toolkit has been
  50     linked to <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>. As of this writing, APR-util supports:
  51     <a href="http://www.openldap.org/">OpenLDAP SDK</a> (2.x or later),
  52     <a href="http://developer.novell.com/ndk/cldap.htm">Novell LDAP
  53     SDK</a>, <a href="http://www.mozilla.org/directory/csdk.html">
  54     Mozilla LDAP SDK</a>, native Solaris LDAP SDK (Mozilla based),
  55     native Microsoft LDAP SDK, or the
  56     <a href="http://www.iplanet.com/downloads/developer/">iPlanet
  57     (Netscape)</a> SDK. See the <a href="http://apr.apache.org">APR</a>
  58     website for details.</p>
  59
  60 </div>
  61 <div id="quickview"><h3 class="directives">Directives</h3>
  62 <ul id="toc">
  63 <li><img alt="" src="../images/down.gif" /> <a href="#ldapcacheentries">LDAPCacheEntries</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#ldapcachettl">LDAPCacheTTL</a></li>
  65 <li><img alt="" src="../images/down.gif" /> <a href="#ldapconnectionpoolttl">LDAPConnectionPoolTTL</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#ldapconnectiontimeout">LDAPConnectionTimeout</a></li>
  67 <li><img alt="" src="../images/down.gif" /> <a href="#ldaplibrarydebug">LDAPLibraryDebug</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#ldapopcacheentries">LDAPOpCacheEntries</a></li>
  69 <li><img alt="" src="../images/down.gif" /> <a href="#ldapopcachettl">LDAPOpCacheTTL</a></li>
  70 <li><img alt="" src="../images/down.gif" /> <a href="#ldapreferralhoplimit">LDAPReferralHopLimit</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#ldapreferrals">LDAPReferrals</a></li>
  72 <li><img alt="" src="../images/down.gif" /> <a href="#ldapretries">LDAPRetries</a></li>
  73 <li><img alt="" src="../images/down.gif" /> <a href="#ldapretrydelay">LDAPRetryDelay</a></li>
  74 <li><img alt="" src="../images/down.gif" /> <a href="#ldapsharedcachefile">LDAPSharedCacheFile</a></li>
  75 <li><img alt="" src="../images/down.gif" /> <a href="#ldapsharedcachesize">LDAPSharedCacheSize</a></li>
  76 <li><img alt="" src="../images/down.gif" /> <a href="#ldaptimeout">LDAPTimeout</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#ldaptrustedclientcert">LDAPTrustedClientCert</a></li>
  78 <li><img alt="" src="../images/down.gif" /> <a href="#ldaptrustedglobalcert">LDAPTrustedGlobalCert</a></li>
  79 <li><img alt="" src="../images/down.gif" /> <a href="#ldaptrustedmode">LDAPTrustedMode</a></li>
  80 <li><img alt="" src="../images/down.gif" /> <a href="#ldapverifyservercert">LDAPVerifyServerCert</a></li>
  81 </ul>
  82 <h3>Topics</h3>
  83 <ul id="topics">
  84 <li><img alt="" src="../images/down.gif" /> <a href="#exampleconfig">Example Configuration</a></li>
  85 <li><img alt="" src="../images/down.gif" /> <a href="#pool">LDAP Connection Pool</a></li>
  86 <li><img alt="" src="../images/down.gif" /> <a href="#cache">LDAP Cache</a></li>
  87 <li><img alt="" src="../images/down.gif" /> <a href="#usingssltls">Using SSL/TLS</a></li>
  88 <li><img alt="" src="../images/down.gif" /> <a href="#settingcerts">SSL/TLS Certificates</a></li>
  89 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  90 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  91 <div class="section">
  92 <h2><a name="exampleconfig" id="exampleconfig">Example Configuration</a></h2>
  93     <p>The following is an example configuration that uses
  94     <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> to increase the performance of HTTP Basic
  95     authentication provided by <code class="module"><a href="../mod/mod_authnz_ldap.html">mod_authnz_ldap</a></code>.</p>
  96
  97     <pre class="prettyprint lang-config">
  98 # Enable the LDAP connection pool and shared
  99 # memory cache. Enable the LDAP cache status
 100 # handler. Requires that mod_ldap and mod_authnz_ldap
 101 # be loaded. Change the "yourdomain.example.com" to
 102 # match your domain.
 103
 104 LDAPSharedCacheSize 500000
 105 LDAPCacheEntries 1024
 106 LDAPCacheTTL 600
 107 LDAPOpCacheEntries 1024
 108 LDAPOpCacheTTL 600
 109
 110 &lt;Location /ldap-status&gt;
 111     SetHandler ldap-status
 112
 113     Require host yourdomain.example.com
 114
 115     Satisfy any
 116     AuthType Basic
 117     AuthName "LDAP Protected"
 118     AuthBasicProvider ldap
 119     AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one
 120     Require valid-user
 121 &lt;/Location&gt;
 122     </pre>
 123
 124 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 125 <div class="section">
 126 <h2><a name="pool" id="pool">LDAP Connection Pool</a></h2>
 127
 128     <p>LDAP connections are pooled from request to request. This
 129     allows the LDAP server to remain connected and bound ready for
 130     the next request, without the need to unbind/connect/rebind.
 131     The performance advantages are similar to the effect of HTTP
 132     keepalives.</p>
 133
 134     <p>On a busy server it is possible that many requests will try
 135     and access the same LDAP server connection simultaneously.
 136     Where an LDAP connection is in use, Apache will create a new
 137     connection alongside the original one. This ensures that the
 138     connection pool does not become a bottleneck.</p>
 139
 140     <p>There is no need to manually enable connection pooling in
 141     the Apache configuration. Any module using this module for
 142     access to LDAP services will share the connection pool.</p>
 143
 144     <p>LDAP connections can keep track of the ldap client
 145     credentials used when binding to an LDAP server. These
 146     credentials can be provided to LDAP servers that do not
 147     allow anonymous binds during referral chasing. To control
 148     this feature, see the
 149     <code class="directive"><a href="#ldapreferrals">LDAPReferrals</a></code> and
 150     <code class="directive"><a href="#ldapreferralhoplimit">LDAPReferralHopLimit</a></code>
 151     directives. By default, this feature is enabled.</p>
 152 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 153 <div class="section">
 154 <h2><a name="cache" id="cache">LDAP Cache</a></h2>
 155
 156     <p>For improved performance, <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> uses an aggressive
 157     caching strategy to minimize the number of times that the LDAP
 158     server must be contacted. Caching can easily double or triple
 159     the throughput of Apache when it is serving pages protected
 160     with mod_authnz_ldap. In addition, the load on the LDAP server
 161     will be significantly decreased.</p>
 162
 163     <p><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> supports two types of LDAP caching during
 164     the search/bind phase with a <em>search/bind cache</em> and
 165     during the compare phase with two <em>operation
 166     caches</em>. Each LDAP URL that is used by the server has
 167     its own set of these three caches.</p>
 168
 169     <h3><a name="search-bind" id="search-bind">The Search/Bind Cache</a></h3>
 170       <p>The process of doing a search and then a bind is the
 171       most time-consuming aspect of LDAP operation, especially if
 172       the directory is large. The search/bind cache is used to
 173       cache all searches that resulted in successful binds.
 174       Negative results (<em>i.e.</em>, unsuccessful searches, or searches
 175       that did not result in a successful bind) are not cached.
 176       The rationale behind this decision is that connections with
 177       invalid credentials are only a tiny percentage of the total
 178       number of connections, so by not caching invalid
 179       credentials, the size of the cache is reduced.</p>
 180
 181       <p><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> stores the username, the DN
 182       retrieved, the password used to bind, and the time of the bind
 183       in the cache. Whenever a new connection is initiated with the
 184       same username, <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> compares the password
 185       of the new connection with the password in the cache. If the
 186       passwords match, and if the cached entry is not too old,
 187       <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> bypasses the search/bind phase.</p>
 188
 189       <p>The search and bind cache is controlled with the <code class="directive"><a href="#ldapcacheentries">LDAPCacheEntries</a></code> and <code class="directive"><a href="#ldapcachettl">LDAPCacheTTL</a></code> directives.</p>
 190
 191
 192     <h3><a name="opcaches" id="opcaches">Operation Caches</a></h3>
 193       <p>During attribute and distinguished name comparison
 194       functions, <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> uses two operation caches
 195       to cache the compare operations. The first compare cache is
 196       used to cache the results of compares done to test for LDAP
 197       group membership. The second compare cache is used to cache
 198       the results of comparisons done between distinguished
 199       names.</p>
 200
 201       <p>Note that, when group membership is being checked, any sub-group
 202       comparison results are cached to speed future sub-group comparisons.</p>
 203
 204       <p>The behavior of both of these caches is controlled with
 205       the <code class="directive"><a href="#ldapopcacheentries">LDAPOpCacheEntries</a></code>
 206       and <code class="directive"><a href="#ldapopcachettl">LDAPOpCacheTTL</a></code>
 207       directives.</p>
 208
 209
 210     <h3><a name="monitoring" id="monitoring">Monitoring the Cache</a></h3>
 211       <p><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> has a content handler that allows
 212       administrators to monitor the cache performance. The name of
 213       the content handler is <code>ldap-status</code>, so the
 214       following directives could be used to access the
 215       <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> cache information:</p>
 216
 217       <pre class="prettyprint lang-config">
 218 &lt;Location /server/cache-info&gt;
 219     SetHandler ldap-status
 220 &lt;/Location&gt;
 221       </pre>
 222
 223
 224       <p>By fetching the URL <code>http://servername/cache-info</code>,
 225       the administrator can get a status report of every cache that is used
 226       by <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> cache. Note that if Apache does not
 227       support shared memory, then each <code class="program"><a href="../programs/httpd.html">httpd</a></code> instance has its
 228       own cache, so reloading the URL will result in different
 229       information each time, depending on which <code class="program"><a href="../programs/httpd.html">httpd</a></code>
 230       instance processes the request.</p>
 231
 232 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 233 <div class="section">
 234 <h2><a name="usingssltls" id="usingssltls">Using SSL/TLS</a></h2>
 235
 236     <p>The ability to create an SSL and TLS connections to an LDAP server
 237     is defined by the directives
 238     <code class="directive"><a href="#ldaptrustedglobalcert">LDAPTrustedGlobalCert</a></code>,
 239     <code class="directive"><a href="#ldaptrustedclientcert">LDAPTrustedClientCert</a></code>
 240      and <code class="directive"><a href="#ldaptrustedmode">LDAPTrustedMode</a></code>.
 241     These directives specify the CA and optional client certificates to be used,
 242     as well as the type of encryption to be used on the connection (none, SSL or
 243     TLS/STARTTLS).</p>
 244
 245     <pre class="prettyprint lang-config">
 246 # Establish an SSL LDAP connection on port 636. Requires that
 247 # mod_ldap and mod_authnz_ldap be loaded. Change the
 248 # "yourdomain.example.com" to match your domain.
 249
 250 LDAPTrustedGlobalCert CA_DER /certs/certfile.der
 251
 252 &lt;Location /ldap-status&gt;
 253     SetHandler ldap-status
 254
 255     Require host yourdomain.example.com
 256
 257     Satisfy any
 258     AuthType Basic
 259     AuthName "LDAP Protected"
 260     AuthBasicProvider ldap
 261     AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one
 262     Require valid-user
 263 &lt;/Location&gt;
 264     </pre>
 265
 266
 267     <pre class="prettyprint lang-config">
 268 # Establish a TLS LDAP connection on port 389. Requires that
 269 # mod_ldap and mod_authnz_ldap be loaded. Change the
 270 # "yourdomain.example.com" to match your domain.
 271
 272 LDAPTrustedGlobalCert CA_DER /certs/certfile.der
 273
 274 &lt;Location /ldap-status&gt;
 275     SetHandler ldap-status
 276
 277     Require host yourdomain.example.com
 278
 279     Satisfy any
 280     AuthType Basic
 281     AuthName "LDAP Protected"
 282     AuthBasicProvider ldap
 283     AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one TLS
 284     Require valid-user
 285 &lt;/Location&gt;
 286     </pre>
 287
 288
 289 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 290 <div class="section">
 291 <h2><a name="settingcerts" id="settingcerts">SSL/TLS Certificates</a></h2>
 292
 293     <p>The different LDAP SDKs have widely different methods of setting
 294     and handling both CA and client side certificates.</p>
 295
 296     <p>If you intend to use SSL or TLS, read this section CAREFULLY so as to
 297     understand the differences between configurations on the different LDAP
 298     toolkits supported.</p>
 299
 300     <h3><a name="settingcerts-netscape" id="settingcerts-netscape">Netscape/Mozilla/iPlanet SDK</a></h3>
 301         <p>CA certificates are specified within a file called cert7.db.
 302         The SDK will not talk to any LDAP server whose certificate was
 303         not signed by a CA specified in this file. If
 304         client certificates are required, an optional key3.db file may
 305         be specified with an optional password. The secmod file can be
 306         specified if required. These files are in the same format as
 307         used by the Netscape Communicator or Mozilla web browsers. The easiest
 308         way to obtain these files is to grab them from your browser
 309         installation.</p>
 310
 311         <p>Client certificates are specified per connection using the
 312         LDAPTrustedClientCert directive by referring
 313         to the certificate "nickname". An optional password may be
 314         specified to unlock the certificate's private key.</p>
 315
 316         <p>The SDK supports SSL only. An attempt to use STARTTLS will cause
 317         an error when an attempt is made to contact the LDAP server at
 318         runtime.</p>
 319
 320         <pre class="prettyprint lang-config">
 321 # Specify a Netscape CA certificate file
 322 LDAPTrustedGlobalCert CA_CERT7_DB /certs/cert7.db
 323 # Specify an optional key3.db file for client certificate support
 324 LDAPTrustedGlobalCert CERT_KEY3_DB /certs/key3.db
 325 # Specify the secmod file if required
 326 LDAPTrustedGlobalCert CA_SECMOD /certs/secmod
 327 &lt;Location /ldap-status&gt;
 328     SetHandler ldap-status
 329
 330     Require host yourdomain.example.com
 331
 332     Satisfy any
 333     AuthType Basic
 334     AuthName "LDAP Protected"
 335     AuthBasicProvider ldap
 336     LDAPTrustedClientCert CERT_NICKNAME &lt;nickname&gt; [password]
 337     AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one
 338     Require valid-user
 339 &lt;/Location&gt;
 340         </pre>
 341
 342
 343
 344
 345     <h3><a name="settingcerts-novell" id="settingcerts-novell">Novell SDK</a></h3>
 346
 347         <p>One or more CA certificates must be specified for the Novell
 348         SDK to work correctly. These certificates can be specified as
 349         binary DER or Base64 (PEM) encoded files.</p>
 350
 351         <p>Note: Client certificates are specified globally rather than per
 352         connection, and so must be specified with the LDAPTrustedGlobalCert
 353         directive as below. Trying to set client certificates via the
 354         LDAPTrustedClientCert directive will cause an error to be logged
 355         when an attempt is made to connect to the LDAP server..</p>
 356
 357         <p>The SDK supports both SSL and STARTTLS, set using the
 358         LDAPTrustedMode parameter. If an ldaps:// URL is specified,
 359         SSL mode is forced, override this directive.</p>
 360
 361         <pre class="prettyprint lang-config">
 362 # Specify two CA certificate files
 363 LDAPTrustedGlobalCert CA_DER /certs/cacert1.der
 364 LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem
 365 # Specify a client certificate file and key
 366 LDAPTrustedGlobalCert CERT_BASE64 /certs/cert1.pem
 367 LDAPTrustedGlobalCert KEY_BASE64 /certs/key1.pem [password]
 368 # Do not use this directive, as it will throw an error
 369 #LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem
 370         </pre>
 371
 372
 373
 374
 375     <h3><a name="settingcerts-openldap" id="settingcerts-openldap">OpenLDAP SDK</a></h3>
 376
 377         <p>One or more CA certificates must be specified for the OpenLDAP
 378         SDK to work correctly. These certificates can be specified as
 379         binary DER or Base64 (PEM) encoded files.</p>
 380
 381         <p>Both CA and client certificates may be specified globally
 382         (LDAPTrustedGlobalCert) or per-connection (LDAPTrustedClientCert).
 383         When any settings are specified per-connection, the global
 384         settings are superceded.</p>
 385
 386         <p>The documentation for the SDK claims to support both SSL and
 387         STARTTLS, however STARTTLS does not seem to work on all versions
 388         of the SDK. The SSL/TLS mode can be set using the
 389         LDAPTrustedMode parameter. If an ldaps:// URL is specified,
 390         SSL mode is forced. The OpenLDAP documentation notes that SSL
 391         (ldaps://) support has been deprecated to be replaced with TLS,
 392         although the SSL functionality still works.</p>
 393
 394         <pre class="prettyprint lang-config">
 395 # Specify two CA certificate files
 396 LDAPTrustedGlobalCert CA_DER /certs/cacert1.der
 397 LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem
 398 &lt;Location /ldap-status&gt;
 399     SetHandler ldap-status
 400
 401     Require host yourdomain.example.com
 402
 403     LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem
 404     LDAPTrustedClientCert KEY_BASE64 /certs/key1.pem
 405     # CA certs respecified due to per-directory client certs
 406     LDAPTrustedClientCert CA_DER /certs/cacert1.der
 407     LDAPTrustedClientCert CA_BASE64 /certs/cacert2.pem
 408     Satisfy any
 409     AuthType Basic
 410     AuthName "LDAP Protected"
 411     AuthBasicProvider ldap
 412     AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one
 413     Require valid-user
 414 &lt;/Location&gt;
 415         </pre>
 416
 417
 418
 419
 420     <h3><a name="settingcerts-solaris" id="settingcerts-solaris">Solaris SDK</a></h3>
 421
 422         <p>SSL/TLS for the native Solaris LDAP libraries is not yet
 423         supported. If required, install and use the OpenLDAP libraries
 424         instead.</p>
 425
 426
 427
 428     <h3><a name="settingcerts-microsoft" id="settingcerts-microsoft">Microsoft SDK</a></h3>
 429
 430         <p>SSL/TLS certificate configuration for the native Microsoft
 431         LDAP libraries is done inside the system registry, and no
 432         configuration directives are required.</p>
 433
 434         <p>Both SSL and TLS are supported by using the ldaps:// URL
 435         format, or by using the LDAPTrustedMode directive accordingly.</p>
 436
 437         <p>Note: The status of support for client certificates is not yet known
 438         for this toolkit.</p>
 439
 440
 441
 442 </div>
 443 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 444 <div class="directive-section"><h2><a name="LDAPCacheEntries" id="LDAPCacheEntries">LDAPCacheEntries</a> <a name="ldapcacheentries" id="ldapcacheentries">Directive</a></h2>
 445 <table class="directive">
 446 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum number of entries in the primary LDAP cache</td></tr>
 447 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPCacheEntries <var>number</var></code></td></tr>
 448 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPCacheEntries 1024</code></td></tr>
 449 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 450 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 451 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 452 </table>
 453     <p>Specifies the maximum size of the primary LDAP cache. This
 454     cache contains successful search/binds. Set it to 0 to turn off
 455     search/bind caching. The default size is 1024 cached
 456     searches.</p>
 457
 458 </div>
 459 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 460 <div class="directive-section"><h2><a name="LDAPCacheTTL" id="LDAPCacheTTL">LDAPCacheTTL</a> <a name="ldapcachettl" id="ldapcachettl">Directive</a></h2>
 461 <table class="directive">
 462 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Time that cached items remain valid</td></tr>
 463 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPCacheTTL <var>seconds</var></code></td></tr>
 464 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPCacheTTL 600</code></td></tr>
 465 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 466 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 467 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 468 </table>
 469     <p>Specifies the time (in seconds) that an item in the
 470     search/bind cache remains valid. The default is 600 seconds (10
 471     minutes).</p>
 472
 473 </div>
 474 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 475 <div class="directive-section"><h2><a name="LDAPConnectionPoolTTL" id="LDAPConnectionPoolTTL">LDAPConnectionPoolTTL</a> <a name="ldapconnectionpoolttl" id="ldapconnectionpoolttl">Directive</a></h2>
 476 <table class="directive">
 477 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Discard backend connections that have been sitting in the connection pool too long</td></tr>
 478 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPConnectionPoolTTL <var>n</var></code></td></tr>
 479 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPConnectionPoolTTL -1</code></td></tr>
 480 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 481 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 482 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 483 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache HTTP Server 2.3.12 and later</td></tr>
 484 </table>
 485     <p>Specifies the maximum age, in seconds, that a pooled LDAP connection can remain idle
 486     and still be available for use.  Connections are cleaned up when they are next needed,
 487     not asynchronously.</p>
 488
 489     <p>A setting of 0 causes connections to never be saved in the backend
 490     connection pool.  The default value of -1, and any other negative value,
 491      allows connections of any age to be reused.</p>
 492
 493     <div class="note"><p>This timeout defaults to units of seconds, but accepts
 494     suffixes for milliseconds (ms), minutes (min), and hours (h).
 495     </p></div>
 496
 497 </div>
 498 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 499 <div class="directive-section"><h2><a name="LDAPConnectionTimeout" id="LDAPConnectionTimeout">LDAPConnectionTimeout</a> <a name="ldapconnectiontimeout" id="ldapconnectiontimeout">Directive</a></h2>
 500 <table class="directive">
 501 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies the socket connection timeout in seconds</td></tr>
 502 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPConnectionTimeout <var>seconds</var></code></td></tr>
 503 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 504 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 505 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 506 </table>
 507     <p>This directive configures the LDAP_OPT_NETWORK_TIMEOUT (or LDAP_OPT_CONNECT_TIMEOUT)
 508     option in the underlying LDAP client library, when available.  This value
 509     typically controls how long the LDAP client library will wait for the TCP
 510     connection to the LDAP server to complete.</p>
 511
 512     <p> If a connection is not successful with the timeout period, either an error will be
 513     returned or the LDAP client library will attempt to connect to a secondary LDAP
 514     server if one is specified (via a space-separated list of hostnames in the
 515     <code class="directive"><a href="../mod/mod_authnz_ldap.html#authldapurl">AuthLDAPURL</a></code>).</p>
 516
 517     <p>The default is 10 seconds, if the LDAP client library linked with the
 518     server supports the LDAP_OPT_NETWORK_TIMEOUT option.</p>
 519
 520     <div class="note">LDAPConnectionTimeout is only available when the LDAP client library linked
 521     with the server supports the LDAP_OPT_NETWORK_TIMEOUT
 522     (or LDAP_OPT_CONNECT_TIMEOUT) option, and the ultimate behavior is
 523     dictated entirely by the LDAP client library.
 524     </div>
 525
 526 </div>
 527 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 528 <div class="directive-section"><h2><a name="LDAPLibraryDebug" id="LDAPLibraryDebug">LDAPLibraryDebug</a> <a name="ldaplibrarydebug" id="ldaplibrarydebug">Directive</a></h2>
 529 <table class="directive">
 530 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable debugging in the LDAP SDK</td></tr>
 531 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPLibraryDebug <var>7</var></code></td></tr>
 532 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>disabled</code></td></tr>
 533 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 534 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 535 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 536 </table>
 537     <p>Turns on SDK-specific LDAP debug options that generally cause the LDAP
 538     SDK to log verbose trace information to the main Apache error log.
 539     The trace messages from the LDAP SDK provide gory details that
 540     can be useful during debugging of connectivity problems with backend LDAP servers</p>
 541
 542     <p>This option is only configurable when Apache HTTP Server is linked with
 543     an LDAP SDK that implements <code>LDAP_OPT_DEBUG</code> or
 544     <code>LDAP_OPT_DEBUG_LEVEL</code>, such as OpenLDAP (a value of 7 is verbose)
 545     or Tivoli Directory Server (a value of 65535 is verbose).</p>
 546
 547     <div class="warning">
 548     <p>The logged information will likely contain plaintext credentials being used or
 549     validated by LDAP authentication, so care should be taken in protecting and purging
 550     the error log when this directive is used.</p>
 551     </div>
 552
 553
 554 </div>
 555 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 556 <div class="directive-section"><h2><a name="LDAPOpCacheEntries" id="LDAPOpCacheEntries">LDAPOpCacheEntries</a> <a name="ldapopcacheentries" id="ldapopcacheentries">Directive</a></h2>
 557 <table class="directive">
 558 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of entries used to cache LDAP compare
 559 operations</td></tr>
 560 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPOpCacheEntries <var>number</var></code></td></tr>
 561 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPOpCacheEntries 1024</code></td></tr>
 562 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 563 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 564 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 565 </table>
 566     <p>This specifies the number of entries <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code>
 567     will use to cache LDAP compare operations. The default is 1024
 568     entries.  Setting it to 0 disables operation caching.</p>
 569
 570 </div>
 571 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 572 <div class="directive-section"><h2><a name="LDAPOpCacheTTL" id="LDAPOpCacheTTL">LDAPOpCacheTTL</a> <a name="ldapopcachettl" id="ldapopcachettl">Directive</a></h2>
 573 <table class="directive">
 574 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Time that entries in the operation cache remain
 575 valid</td></tr>
 576 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPOpCacheTTL <var>seconds</var></code></td></tr>
 577 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPOpCacheTTL 600</code></td></tr>
 578 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 579 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 580 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 581 </table>
 582     <p>Specifies the time (in seconds) that entries in the
 583     operation cache remain valid. The default is 600 seconds.</p>
 584
 585 </div>
 586 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 587 <div class="directive-section"><h2><a name="LDAPReferralHopLimit" id="LDAPReferralHopLimit">LDAPReferralHopLimit</a> <a name="ldapreferralhoplimit" id="ldapreferralhoplimit">Directive</a></h2>
 588 <table class="directive">
 589 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The maximum number of referral hops to chase before terminating an LDAP query.</td></tr>
 590 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPReferralHopLimit <var>number</var></code></td></tr>
 591 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SDK dependent, typically between 5 and 10</code></td></tr>
 592 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 593 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 594 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 595 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 596 </table>
 597     <p>This directive, if enabled by the <code>LDAPReferrals</code> directive,
 598     limits the number of referral hops that are followed before terminating an
 599     LDAP query.</p>
 600
 601 <div class="warning">
 602 <p> Support for this tunable is uncommon in LDAP SDKs.</p>
 603 </div>
 604
 605 </div>
 606 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 607 <div class="directive-section"><h2><a name="LDAPReferrals" id="LDAPReferrals">LDAPReferrals</a> <a name="ldapreferrals" id="ldapreferrals">Directive</a></h2>
 608 <table class="directive">
 609 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable referral chasing during queries to the LDAP server.</td></tr>
 610 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPReferrals <var>On|Off</var></code></td></tr>
 611 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPReferrals On</code></td></tr>
 612 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 613 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 614 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 615 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 616 </table>
 617     <p>Some LDAP servers divide their directory among multiple domains and use referrals
 618     to direct a client when a domain boundary is crossed. By setting <code>LDAPReferrals On</code>
 619     referrals will be chased (setting it to off causes referrals to be ignored). The directive
 620     <code>LDAPReferralHopLimit</code> works in conjunction with this directive to limit the
 621     number of referral hops to follow before terminating the LDAP query. When referral processing
 622     is enabled client credentials will be provided, via a rebind callback, for any LDAP server
 623     requiring them. </p>
 624
 625 </div>
 626 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 627 <div class="directive-section"><h2><a name="LDAPRetries" id="LDAPRetries">LDAPRetries</a> <a name="ldapretries" id="ldapretries">Directive</a></h2>
 628 <table class="directive">
 629 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the number of LDAP server retries.</td></tr>
 630 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPRetries <var>number-of-retries</var></code></td></tr>
 631 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPRetries 3</code></td></tr>
 632 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 633 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 634 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 635 </table>
 636     <p>The server will retry failed LDAP requests up to
 637     <code class="directive">LDAPRetries</code> times.  Setting this
 638     directive to 0 disables retries.</p>
 639     <p>LDAP errors such as timeouts and refused connections are retryable.</p>
 640
 641 </div>
 642 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 643 <div class="directive-section"><h2><a name="LDAPRetryDelay" id="LDAPRetryDelay">LDAPRetryDelay</a> <a name="ldapretrydelay" id="ldapretrydelay">Directive</a></h2>
 644 <table class="directive">
 645 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the delay between LDAP server retries.</td></tr>
 646 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPRetryDelay <var>seconds</var></code></td></tr>
 647 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPRetryDelay 0</code></td></tr>
 648 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 649 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 650 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 651 </table>
 652     <p>If <code class="directive">LDAPRetryDelay</code> is set to a non-zero
 653     value, the server will delay retrying an LDAP request for the
 654     specified amount of time.  Setting this directive to 0 will
 655     result in any retry to occur without delay.</p>
 656
 657     <p>LDAP errors such as timeouts and refused connections are retryable.</p>
 658
 659 </div>
 660 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 661 <div class="directive-section"><h2><a name="LDAPSharedCacheFile" id="LDAPSharedCacheFile">LDAPSharedCacheFile</a> <a name="ldapsharedcachefile" id="ldapsharedcachefile">Directive</a></h2>
 662 <table class="directive">
 663 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the shared memory cache file</td></tr>
 664 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPSharedCacheFile <var>directory-path/filename</var></code></td></tr>
 665 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 666 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 667 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 668 </table>
 669     <p>Specifies the directory path and file name of the shared memory
 670     cache file. If not set, anonymous shared memory will be used if the
 671     platform supports it.</p>
 672
 673 </div>
 674 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 675 <div class="directive-section"><h2><a name="LDAPSharedCacheSize" id="LDAPSharedCacheSize">LDAPSharedCacheSize</a> <a name="ldapsharedcachesize" id="ldapsharedcachesize">Directive</a></h2>
 676 <table class="directive">
 677 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size in bytes of the shared-memory cache</td></tr>
 678 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPSharedCacheSize <var>bytes</var></code></td></tr>
 679 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPSharedCacheSize 500000</code></td></tr>
 680 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 681 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 682 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 683 </table>
 684     <p>Specifies the number of bytes to allocate for the shared
 685     memory cache. The default is 500kb. If set to 0, shared memory
 686     caching will not be used and every HTTPD process will create its
 687     own cache.</p>
 688
 689 </div>
 690 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 691 <div class="directive-section"><h2><a name="LDAPTimeout" id="LDAPTimeout">LDAPTimeout</a> <a name="ldaptimeout" id="ldaptimeout">Directive</a></h2>
 692 <table class="directive">
 693 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies the timeout for LDAP search and bind operations, in seconds</td></tr>
 694 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPTimeout <var>seconds</var></code></td></tr>
 695 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPTimeout 60</code></td></tr>
 696 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 697 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 698 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 699 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache HTTP Server 2.3.5 and later</td></tr>
 700 </table>
 701     <p>This directive configures the timeout for bind and search operations, as well as
 702     the LDAP_OPT_TIMEOUT option in the underlying LDAP client library, when available.</p>
 703
 704     <p> If the timeout expires, httpd will retry in case an existing connection has
 705     been silently dropped by a firewall. However, performance will be much better if
 706     the firewall is configured to send TCP RST packets instead of silently dropping
 707     packets.</p>
 708
 709     <div class="note">
 710     <p>Timeouts for ldap compare operations requires an SDK with LDAP_OPT_TIMEOUT, such as OpenLDAP &gt;= 2.4.4.</p>
 711     </div>
 712
 713
 714 </div>
 715 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 716 <div class="directive-section"><h2><a name="LDAPTrustedClientCert" id="LDAPTrustedClientCert">LDAPTrustedClientCert</a> <a name="ldaptrustedclientcert" id="ldaptrustedclientcert">Directive</a></h2>
 717 <table class="directive">
 718 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the file containing or nickname referring to a per
 719 connection client certificate. Not all LDAP toolkits support per
 720 connection client certificates.</td></tr>
 721 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPTrustedClientCert <var>type</var> <var>directory-path/filename/nickname</var> <var>[password]</var></code></td></tr>
 722 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 723 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 724 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 725 </table>
 726     <p>It specifies the directory path, file name or nickname of a
 727     per connection client certificate used when establishing an SSL
 728     or TLS connection to an LDAP server. Different locations or
 729     directories may have their own independant client certificate
 730     settings. Some LDAP toolkits (notably Novell)
 731     do not support per connection client certificates, and will throw an
 732     error on LDAP server connection if you try to use this directive
 733     (Use the LDAPTrustedGlobalCert directive instead for Novell client
 734     certificates - See the SSL/TLS certificate guide above for details).
 735     The type specifies the kind of certificate parameter being
 736     set, depending on the LDAP toolkit being used. Supported types are:</p>
 737     <ul>
 738       <li>CA_DER - binary DER encoded CA certificate</li>
 739       <li>CA_BASE64 - PEM encoded CA certificate</li>
 740       <li>CERT_DER - binary DER encoded client certificate</li>
 741       <li>CERT_BASE64 - PEM encoded client certificate</li>
 742       <li>CERT_NICKNAME - Client certificate "nickname" (Netscape SDK)</li>
 743       <li>KEY_DER - binary DER encoded private key</li>
 744       <li>KEY_BASE64 - PEM encoded private key</li>
 745     </ul>
 746
 747 </div>
 748 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 749 <div class="directive-section"><h2><a name="LDAPTrustedGlobalCert" id="LDAPTrustedGlobalCert">LDAPTrustedGlobalCert</a> <a name="ldaptrustedglobalcert" id="ldaptrustedglobalcert">Directive</a></h2>
 750 <table class="directive">
 751 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the file or database containing global trusted
 752 Certificate Authority or global client certificates</td></tr>
 753 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPTrustedGlobalCert <var>type</var> <var>directory-path/filename</var> <var>[password]</var></code></td></tr>
 754 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 755 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 756 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 757 </table>
 758     <p>It specifies the directory path and file name of the trusted CA
 759     certificates and/or system wide client certificates <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code>
 760     should use when establishing an SSL or TLS connection to an LDAP
 761     server. Note that all certificate information specified using this directive
 762     is applied globally to the entire server installation. Some LDAP toolkits
 763     (notably Novell) require all client certificates to be set globally using
 764     this directive. Most other toolkits require clients certificates to be set
 765     per Directory or per Location using LDAPTrustedClientCert. If you get this
 766     wrong, an error may be logged when an attempt is made to contact the LDAP
 767     server, or the connection may silently fail (See the SSL/TLS certificate
 768     guide above for details).
 769     The type specifies the kind of certificate parameter being
 770     set, depending on the LDAP toolkit being used. Supported types are:</p>
 771     <ul>
 772       <li>CA_DER - binary DER encoded CA certificate</li>
 773       <li>CA_BASE64 - PEM encoded CA certificate</li>
 774       <li>CA_CERT7_DB - Netscape cert7.db CA certificate database file</li>
 775       <li>CA_SECMOD - Netscape secmod database file</li>
 776       <li>CERT_DER - binary DER encoded client certificate</li>
 777       <li>CERT_BASE64 - PEM encoded client certificate</li>
 778       <li>CERT_KEY3_DB - Netscape key3.db client certificate database file</li>
 779       <li>CERT_NICKNAME - Client certificate "nickname" (Netscape SDK)</li>
 780       <li>CERT_PFX - PKCS#12 encoded client certificate (Novell SDK)</li>
 781       <li>KEY_DER - binary DER encoded private key</li>
 782       <li>KEY_BASE64 - PEM encoded private key</li>
 783       <li>KEY_PFX - PKCS#12 encoded private key (Novell SDK)</li>
 784     </ul>
 785
 786 </div>
 787 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 788 <div class="directive-section"><h2><a name="LDAPTrustedMode" id="LDAPTrustedMode">LDAPTrustedMode</a> <a name="ldaptrustedmode" id="ldaptrustedmode">Directive</a></h2>
 789 <table class="directive">
 790 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies the SSL/TLS mode to be used when connecting to an LDAP server.</td></tr>
 791 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPTrustedMode <var>type</var></code></td></tr>
 792 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 793 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 794 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 795 </table>
 796     <p>The following modes are supported:</p>
 797     <ul>
 798       <li>NONE - no encryption</li>
 799       <li>SSL - ldaps:// encryption on default port 636</li>
 800       <li>TLS - STARTTLS encryption on default port 389</li>
 801     </ul>
 802
 803     <p>Not all LDAP toolkits support all the above modes. An error message
 804     will be logged at runtime if a mode is not supported, and the
 805     connection to the LDAP server will fail.
 806     </p>
 807
 808     <p>If an ldaps:// URL is specified, the mode becomes SSL and the setting
 809     of LDAPTrustedMode is ignored.</p>
 810
 811 </div>
 812 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 813 <div class="directive-section"><h2><a name="LDAPVerifyServerCert" id="LDAPVerifyServerCert">LDAPVerifyServerCert</a> <a name="ldapverifyservercert" id="ldapverifyservercert">Directive</a></h2>
 814 <table class="directive">
 815 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Force server certificate verification</td></tr>
 816 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPVerifyServerCert <var>On|Off</var></code></td></tr>
 817 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPVerifyServerCert On</code></td></tr>
 818 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 819 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 820 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 821 </table>
 822     <p>Specifies whether to force the verification of a
 823     server certificate when establishing an SSL connection to the
 824     LDAP server.</p>
 825
 826 </div>
 827 </div>
 828 <div class="bottomlang">
 829 <p><span>Available Languages: </span><a href="../en/mod/mod_ldap.html" title="English">&nbsp;en&nbsp;</a> |
 830 <a href="../fr/mod/mod_ldap.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 831 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 832 <script type="text/javascript"><!--//--><![CDATA[//><!--
 833 var comments_shortname = 'httpd';
 834 var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_ldap.html';
 835 (function(w, d) {
 836     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 837         d.write('<div id="comments_thread"><\/div>');
 838         var s = d.createElement('script');
 839         s.type = 'text/javascript';
 840         s.async = true;
 841         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 842         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 843     }
 844     else {
 845         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 846     }
 847 })(window, document);
 848 //--><!]]></script></div><div id="footer">
 849 <p class="apache">Copyright 2012 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>
 850 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 851 if (typeof(prettyPrint) !== 'undefined') {
 852     prettyPrint();
 853 }
 854 //--><!]]></script>
 855 </body></html>