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