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" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.3</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <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.3</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_ldap</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_ldap.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>LDAP connection pooling and result caching services for use
  27 by other LDAP modules</td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>ldap_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>util_ldap.c</td></tr>
  31 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.41 and later</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <p>This module was created to improve the performance of
  35     websites relying on backend connections to LDAP servers. In
  36     addition to the functions provided by the standard LDAP
  37     libraries, this module adds an LDAP connection pool and an LDAP
  38     shared memory cache.</p>
  39
  40     <p>To enable this module, LDAP support must be compiled into
  41     apr-util. This is achieved by adding the <code>--with-ldap</code>
  42     flag to the <code class="program"><a href="../programs/configure.html">configure</a></code> script when building
  43     Apache.</p>
  44
  45     <p>SSL/TLS support is dependant on which LDAP toolkit has been
  46     linked to <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>. As of this writing, APR-util supports:
  47     <a href="http://www.openldap.org/">OpenLDAP SDK</a> (2.x or later),
  48     <a href="http://developer.novell.com/ndk/cldap.htm">Novell LDAP
  49     SDK</a>, <a href="http://www.mozilla.org/directory/csdk.html">
  50     Mozilla LDAP SDK</a>, native Solaris LDAP SDK (Mozilla based),
  51     native Microsoft LDAP SDK, or the
  52     <a href="http://www.iplanet.com/downloads/developer/">iPlanet
  53     (Netscape)</a> SDK. See the <a href="http://apr.apache.org">APR</a>
  54     website for details.</p>
  55
  56 </div>
  57 <div id="quickview"><h3 class="directives">Directives</h3>
  58 <ul id="toc">
  59 <li><img alt="" src="../images/down.gif" /> <a href="#ldapcacheentries">LDAPCacheEntries</a></li>
  60 <li><img alt="" src="../images/down.gif" /> <a href="#ldapcachettl">LDAPCacheTTL</a></li>
  61 <li><img alt="" src="../images/down.gif" /> <a href="#ldapconnectiontimeout">LDAPConnectionTimeout</a></li>
  62 <li><img alt="" src="../images/down.gif" /> <a href="#ldapopcacheentries">LDAPOpCacheEntries</a></li>
  63 <li><img alt="" src="../images/down.gif" /> <a href="#ldapopcachettl">LDAPOpCacheTTL</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#ldapsharedcachefile">LDAPSharedCacheFile</a></li>
  65 <li><img alt="" src="../images/down.gif" /> <a href="#ldapsharedcachesize">LDAPSharedCacheSize</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#ldaptrustedclientcert">LDAPTrustedClientCert</a></li>
  67 <li><img alt="" src="../images/down.gif" /> <a href="#ldaptrustedglobalcert">LDAPTrustedGlobalCert</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#ldaptrustedmode">LDAPTrustedMode</a></li>
  69 <li><img alt="" src="../images/down.gif" /> <a href="#ldapverifyservercert">LDAPVerifyServerCert</a></li>
  70 </ul>
  71 <h3>Topics</h3>
  72 <ul id="topics">
  73 <li><img alt="" src="../images/down.gif" /> <a href="#exampleconfig">Example Configuration</a></li>
  74 <li><img alt="" src="../images/down.gif" /> <a href="#pool">LDAP Connection Pool</a></li>
  75 <li><img alt="" src="../images/down.gif" /> <a href="#cache">LDAP Cache</a></li>
  76 <li><img alt="" src="../images/down.gif" /> <a href="#usingssltls">Using SSL/TLS</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#settingcerts">SSL/TLS Certificates</a></li>
  78 </ul></div>
  79 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  80 <div class="section">
  81 <h2><a name="exampleconfig" id="exampleconfig">Example Configuration</a></h2>
  82     <p>The following is an example configuration that uses
  83     <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> to increase the performance of HTTP Basic
  84     authentication provided by <code class="module"><a href="../mod/mod_authnz_ldap.html">mod_authnz_ldap</a></code>.</p>
  85
  86     <div class="example"><p><code>
  87       # Enable the LDAP connection pool and shared<br />
  88       # memory cache. Enable the LDAP cache status<br />
  89       # handler. Requires that mod_ldap and mod_authnz_ldap<br />
  90       # be loaded. Change the "yourdomain.example.com" to<br />
  91       # match your domain.<br />
  92       <br />
  93       LDAPSharedCacheSize 200000<br />
  94       LDAPCacheEntries 1024<br />
  95       LDAPCacheTTL 600<br />
  96       LDAPOpCacheEntries 1024<br />
  97       LDAPOpCacheTTL 600<br />
  98       <br />
  99       &lt;Location /ldap-status&gt;<br />
 100       <span class="indent">
 101         SetHandler ldap-status<br />
 102         Order deny,allow<br />
 103         Deny from all<br />
 104         Allow from yourdomain.example.com<br />
 105         AuthLDAPEnabled on<br />
 106         AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one<br />
 107         require valid-user<br />
 108       </span>
 109       &lt;/Location&gt;
 110     </code></p></div>
 111 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 112 <div class="section">
 113 <h2><a name="pool" id="pool">LDAP Connection Pool</a></h2>
 114
 115     <p>LDAP connections are pooled from request to request. This
 116     allows the LDAP server to remain connected and bound ready for
 117     the next request, without the need to unbind/connect/rebind.
 118     The performance advantages are similar to the effect of HTTP
 119     keepalives.</p>
 120
 121     <p>On a busy server it is possible that many requests will try
 122     and access the same LDAP server connection simultaneously.
 123     Where an LDAP connection is in use, Apache will create a new
 124     connection alongside the original one. This ensures that the
 125     connection pool does not become a bottleneck.</p>
 126
 127     <p>There is no need to manually enable connection pooling in
 128     the Apache configuration. Any module using this module for
 129     access to LDAP services will share the connection pool.</p>
 130 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 131 <div class="section">
 132 <h2><a name="cache" id="cache">LDAP Cache</a></h2>
 133
 134     <p>For improved performance, <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> uses an aggressive
 135     caching strategy to minimize the number of times that the LDAP
 136     server must be contacted. Caching can easily double or triple
 137     the throughput of Apache when it is serving pages protected
 138     with mod_authnz_ldap. In addition, the load on the LDAP server
 139     will be significantly decreased.</p>
 140
 141     <p><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> supports two types of LDAP caching during
 142     the search/bind phase with a <em>search/bind cache</em> and
 143     during the compare phase with two <em>operation
 144     caches</em>. Each LDAP URL that is used by the server has
 145     its own set of these three caches.</p>
 146
 147     <h3><a name="search-bind" id="search-bind">The Search/Bind Cache</a></h3>
 148       <p>The process of doing a search and then a bind is the
 149       most time-consuming aspect of LDAP operation, especially if
 150       the directory is large. The search/bind cache is used to
 151       cache all searches that resulted in successful binds.
 152       Negative results (<em>i.e.</em>, unsuccessful searches, or searches
 153       that did not result in a successful bind) are not cached.
 154       The rationale behind this decision is that connections with
 155       invalid credentials are only a tiny percentage of the total
 156       number of connections, so by not caching invalid
 157       credentials, the size of the cache is reduced.</p>
 158
 159       <p><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> stores the username, the DN
 160       retrieved, the password used to bind, and the time of the bind
 161       in the cache. Whenever a new connection is initiated with the
 162       same username, <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> compares the password
 163       of the new connection with the password in the cache. If the
 164       passwords match, and if the cached entry is not too old,
 165       <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> bypasses the search/bind phase.</p>
 166
 167       <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>
 168
 169
 170     <h3><a name="opcaches" id="opcaches">Operation Caches</a></h3>
 171       <p>During attribute and distinguished name comparison
 172       functions, <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> uses two operation caches
 173       to cache the compare operations. The first compare cache is
 174       used to cache the results of compares done to test for LDAP
 175       group membership. The second compare cache is used to cache
 176       the results of comparisons done between distinguished
 177       names.</p>
 178
 179       <p>The behavior of both of these caches is controlled with
 180       the <code class="directive"><a href="#ldapopcacheentries">LDAPOpCacheEntries</a></code>
 181       and <code class="directive"><a href="#ldapopcachettl">LDAPOpCacheTTL</a></code>
 182       directives.</p>
 183
 184
 185     <h3><a name="monitoring" id="monitoring">Monitoring the Cache</a></h3>
 186       <p><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> has a content handler that allows
 187       administrators to monitor the cache performance. The name of
 188       the content handler is <code>ldap-status</code>, so the
 189       following directives could be used to access the
 190       <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> cache information:</p>
 191
 192       <div class="example"><p><code>
 193         &lt;Location /server/cache-info&gt;<br />
 194         <span class="indent">
 195           SetHandler ldap-status<br />
 196         </span>
 197         &lt;/Location&gt;
 198       </code></p></div>
 199
 200       <p>By fetching the URL <code>http://servername/cache-info</code>,
 201       the administrator can get a status report of every cache that is used
 202       by <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> cache. Note that if Apache does not
 203       support shared memory, then each <code class="program"><a href="../programs/httpd.html">httpd</a></code> instance has its
 204       own cache, so reloading the URL will result in different
 205       information each time, depending on which <code class="program"><a href="../programs/httpd.html">httpd</a></code>
 206       instance processes the request.</p>
 207
 208 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 209 <div class="section">
 210 <h2><a name="usingssltls" id="usingssltls">Using SSL/TLS</a></h2>
 211
 212     <p>The ability to create an SSL and TLS connections to an LDAP server
 213     is defined by the directives <code class="directive"><a href="#&#10;    ldaptrustedglobalcert">
 214     LDAPTrustedGlobalCert</a></code>, <code class="directive"><a href="#&#10;    ldaptrustedclientcert">
 215     LDAPTrustedClientCert</a></code> and <code class="directive"><a href="#&#10;    ldaptrustedmode">
 216     LDAPTrustedMode</a></code>. These directives specify the CA and
 217     optional client certificates to be used, as well as the type of
 218     encryption to be used on the connection (none, SSL or TLS/STARTTLS).</p>
 219
 220     <div class="example"><p><code>
 221       # Establish an SSL LDAP connection on port 636. Requires that <br />
 222       # mod_ldap and mod_authnz_ldap be loaded. Change the <br />
 223       # "yourdomain.example.com" to match your domain.<br />
 224       <br />
 225       LDAPTrustedGlobalCert CA_DER /certs/certfile.der<br />
 226       <br />
 227       &lt;Location /ldap-status&gt;<br />
 228       <span class="indent">
 229         SetHandler ldap-status<br />
 230         Order deny,allow<br />
 231         Deny from all<br />
 232         Allow from yourdomain.example.com<br />
 233         AuthLDAPEnabled on<br />
 234         AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
 235         require valid-user<br />
 236       </span>
 237       &lt;/Location&gt;
 238     </code></p></div>
 239
 240     <div class="example"><p><code>
 241       # Establish a TLS LDAP connection on port 389. Requires that <br />
 242       # mod_ldap and mod_authnz_ldap be loaded. Change the <br />
 243       # "yourdomain.example.com" to match your domain.<br />
 244       <br />
 245       LDAPTrustedGlobalCert CA_DER /certs/certfile.der<br />
 246       <br />
 247       &lt;Location /ldap-status&gt;<br />
 248       <span class="indent">
 249         SetHandler ldap-status<br />
 250         Order deny,allow<br />
 251         Deny from all<br />
 252         Allow from yourdomain.example.com<br />
 253         AuthLDAPEnabled on<br />
 254         LDAPTrustedMode TLS
 255         AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one<br />
 256         require valid-user<br />
 257       </span>
 258       &lt;/Location&gt;
 259     </code></p></div>
 260
 261 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 262 <div class="section">
 263 <h2><a name="settingcerts" id="settingcerts">SSL/TLS Certificates</a></h2>
 264
 265     <p>The different LDAP SDKs have widely different methods of setting
 266     and handling both CA and client side certificates.</p>
 267
 268     <p>If you intend to use SSL or TLS, read this section CAREFULLY so as to
 269     understand the differences between configurations on the different LDAP
 270     toolkits supported.</p>
 271
 272     <h3><a name="settingcerts-netscape" id="settingcerts-netscape">Netscape/Mozilla/iPlanet SDK</a></h3>
 273         <p>CA certificates are specified within a file called cert7.db.
 274         The SDK will not talk to any LDAP server whose certificate was
 275         not signed by a CA specified in this file. If
 276         client certificates are required, an optional key3.db file may
 277         be specified with an optional password. The secmod file can be
 278         specified if required. These files are in the same format as
 279         used by the Netscape Communicator or Mozilla web browsers. The easiest
 280         way to obtain these files is to grab them from your browser
 281         installation.</p>
 282
 283         <p>Client certificates are specified per connection using the
 284         LDAPTrustedClientCert directive by referring
 285         to the certificate "nickname". An optional password may be
 286         specified to unlock the certificate's private key.</p>
 287
 288         <p>The SDK supports SSL only. An attempt to use STARTTLS will cause
 289         an error when an attempt is made to contact the LDAP server at
 290         runtime.</p>
 291
 292         <div class="example"><p><code>
 293             # Specify a Netscape CA certificate file<br />
 294             LDAPTrustedGlobalCert CA_CERT7_DB /certs/cert7.db<br />
 295             # Specify an optional key3.db file for client certificate support<br />
 296             LDAPTrustedGlobalCert CERT_KEY3_DB /certs/key3.db<br />
 297             # Specify the secmod file if required<br />
 298             LDAPTrustedGlobalCert CA_SECMOD /certs/secmod<br />
 299             &lt;Location /ldap-status&gt;<br />
 300             <span class="indent">
 301                 SetHandler ldap-status<br />
 302                 Order deny,allow<br />
 303                 Deny from all<br />
 304                 Allow from yourdomain.example.com<br />
 305                 AuthLDAPEnabled on<br />
 306                 LDAPTrustedClientCert CERT_NICKNAME &lt;nickname&gt; [password]<br />
 307                 AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
 308                 require valid-user<br />
 309             </span>
 310             &lt;/Location&gt;
 311         </code></p></div>
 312
 313
 314
 315     <h3><a name="settingcerts-novell" id="settingcerts-novell">Novell SDK</a></h3>
 316
 317         <p>One or more CA certificates must be specified for the Novell
 318         SDK to work correctly. These certificates can be specified as
 319         binary DER or Base64 (PEM) encoded files.</p>
 320
 321         <p>Note: Client certificates are specified globally rather than per
 322         connection, and so must be specified with the LDAPTrustedGlobalCert
 323         directive as below. Trying to set client certificates via the
 324         LDAPTrustedClientCert directive will cause an error to be logged
 325         when an attempt is made to connect to the LDAP server..</p>
 326
 327         <p>The SDK supports both SSL and STARTTLS, set using the
 328         LDAPTrustedMode parameter. If an ldaps:// URL is specified,
 329         SSL mode is forced, override this directive.</p>
 330
 331         <div class="example"><p><code>
 332              # Specify two CA certificate files<br />
 333              LDAPTrustedGlobalCert CA_DER /certs/cacert1.der<br />
 334              LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem<br />
 335              # Specify a client certificate file and key<br />
 336              LDAPTrustedGlobalCert CERT_BASE64 /certs/cert1.pem<br />
 337              LDAPTrustedGlobalCert KEY_BASE64 /certs/key1.pem [password]<br />
 338              # Do not use this directive, as it will throw an error<br />
 339              #LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem<br />
 340         </code></p></div>
 341
 342
 343
 344     <h3><a name="settingcerts-openldap" id="settingcerts-openldap">OpenLDAP SDK</a></h3>
 345
 346         <p>One or more CA certificates must be specified for the OpenLDAP
 347         SDK to work correctly. These certificates can be specified as
 348         binary DER or Base64 (PEM) encoded files.</p>
 349
 350         <p>Client certificates are specified per connection using the
 351         LDAPTrustedClientCert directive.</p>
 352
 353         <p>The documentation for the SDK claims to support both SSL and
 354         STARTTLS, however STARTTLS does not seem to work on all versions
 355         of the SDK. The SSL/TLS mode can be set using the
 356         LDAPTrustedMode parameter. If an ldaps:// URL is specified,
 357         SSL mode is forced. The OpenLDAP documentation notes that SSL
 358         (ldaps://) support has been deprecated to be replaced with TLS,
 359         although the SSL functionality still works.</p>
 360
 361         <div class="example"><p><code>
 362              # Specify two CA certificate files<br />
 363              LDAPTrustedGlobalCert CA_DER /certs/cacert1.der<br />
 364              LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem<br />
 365             &lt;Location /ldap-status&gt;<br />
 366             <span class="indent">
 367                 SetHandler ldap-status<br />
 368                 Order deny,allow<br />
 369                 Deny from all<br />
 370                 Allow from yourdomain.example.com<br />
 371                 AuthLDAPEnabled on<br />
 372                 LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem<br />
 373                 LDAPTrustedClientCert KEY_BASE64 /certs/key1.pem<br />
 374                 AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
 375                 require valid-user<br />
 376             </span>
 377             &lt;/Location&gt;
 378         </code></p></div>
 379
 380
 381
 382     <h3><a name="settingcerts-solaris" id="settingcerts-solaris">Solaris SDK</a></h3>
 383
 384         <p>SSL/TLS for the native Solaris LDAP libraries is not yet
 385         supported. If required, install and use the OpenLDAP libraries
 386         instead.</p>
 387
 388
 389
 390     <h3><a name="settingcerts-microsoft" id="settingcerts-microsoft">Microsoft SDK</a></h3>
 391
 392         <p>SSL/TLS certificate configuration for the native Microsoft
 393         LDAP libraries is done inside the system registry, and no
 394         configuration directives are required.</p>
 395
 396         <p>Both SSL and TLS are supported by using the ldaps:// URL
 397         format, or by using the LDAPTrustedMode directive accordingly.</p>
 398
 399         <p>Note: The status of support for client certificates is not yet known
 400         for this toolkit.</p>
 401
 402
 403
 404 </div>
 405 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 406 <div class="directive-section"><h2><a name="LDAPCacheEntries" id="LDAPCacheEntries">LDAPCacheEntries</a> <a name="ldapcacheentries" id="ldapcacheentries">Directive</a></h2>
 407 <table class="directive">
 408 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum number of entries in the primary LDAP cache</td></tr>
 409 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPCacheEntries <var>number</var></code></td></tr>
 410 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPCacheEntries 1024</code></td></tr>
 411 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 412 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 413 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 414 </table>
 415     <p>Specifies the maximum size of the primary LDAP cache. This
 416     cache contains successful search/binds. Set it to 0 to turn off
 417     search/bind caching. The default size is 1024 cached
 418     searches.</p>
 419
 420 </div>
 421 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 422 <div class="directive-section"><h2><a name="LDAPCacheTTL" id="LDAPCacheTTL">LDAPCacheTTL</a> <a name="ldapcachettl" id="ldapcachettl">Directive</a></h2>
 423 <table class="directive">
 424 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Time that cached items remain valid</td></tr>
 425 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPCacheTTL <var>seconds</var></code></td></tr>
 426 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPCacheTTL 600</code></td></tr>
 427 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 428 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 429 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 430 </table>
 431     <p>Specifies the time (in seconds) that an item in the
 432     search/bind cache remains valid. The default is 600 seconds (10
 433     minutes).</p>
 434
 435 </div>
 436 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 437 <div class="directive-section"><h2><a name="LDAPConnectionTimeout" id="LDAPConnectionTimeout">LDAPConnectionTimeout</a> <a name="ldapconnectiontimeout" id="ldapconnectiontimeout">Directive</a></h2>
 438 <table class="directive">
 439 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies the socket connection timeout in seconds</td></tr>
 440 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPConnectionTimeout <var>seconds</var></code></td></tr>
 441 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 442 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 443 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 444 </table>
 445     <p>Specifies the timeout value (in seconds) in which the module will
 446     attempt to connect to the LDAP server.  If a connection is not
 447     successful with the timeout period, either an error will be
 448     returned or the module will attempt to connect to a secondary LDAP
 449     server if one is specified. The default is 10 seconds.</p>
 450
 451 </div>
 452 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 453 <div class="directive-section"><h2><a name="LDAPOpCacheEntries" id="LDAPOpCacheEntries">LDAPOpCacheEntries</a> <a name="ldapopcacheentries" id="ldapopcacheentries">Directive</a></h2>
 454 <table class="directive">
 455 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of entries used to cache LDAP compare
 456 operations</td></tr>
 457 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPOpCacheEntries <var>number</var></code></td></tr>
 458 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPOpCacheEntries 1024</code></td></tr>
 459 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 460 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 461 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 462 </table>
 463     <p>This specifies the number of entries <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code>
 464     will use to cache LDAP compare operations. The default is 1024
 465     entries.  Setting it to 0 disables operation caching.</p>
 466
 467 </div>
 468 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 469 <div class="directive-section"><h2><a name="LDAPOpCacheTTL" id="LDAPOpCacheTTL">LDAPOpCacheTTL</a> <a name="ldapopcachettl" id="ldapopcachettl">Directive</a></h2>
 470 <table class="directive">
 471 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Time that entries in the operation cache remain
 472 valid</td></tr>
 473 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPOpCacheTTL <var>seconds</var></code></td></tr>
 474 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPOpCacheTTL 600</code></td></tr>
 475 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 476 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 477 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 478 </table>
 479     <p>Specifies the time (in seconds) that entries in the
 480     operation cache remain valid. The default is 600 seconds.</p>
 481
 482 </div>
 483 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 484 <div class="directive-section"><h2><a name="LDAPSharedCacheFile" id="LDAPSharedCacheFile">LDAPSharedCacheFile</a> <a name="ldapsharedcachefile" id="ldapsharedcachefile">Directive</a></h2>
 485 <table class="directive">
 486 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the shared memory cache file</td></tr>
 487 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPSharedCacheFile <var>directory-path/filename</var></code></td></tr>
 488 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 489 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 490 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 491 </table>
 492     <p>Specifies the directory path and file name of the shared memory
 493     cache file. If not set, anonymous shared memory will be used if the
 494     platform supports it.</p>
 495
 496 </div>
 497 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 498 <div class="directive-section"><h2><a name="LDAPSharedCacheSize" id="LDAPSharedCacheSize">LDAPSharedCacheSize</a> <a name="ldapsharedcachesize" id="ldapsharedcachesize">Directive</a></h2>
 499 <table class="directive">
 500 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size in bytes of the shared-memory cache</td></tr>
 501 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPSharedCacheSize <var>bytes</var></code></td></tr>
 502 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPSharedCacheSize 102400</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>Specifies the number of bytes to allocate for the shared
 508     memory cache. The default is 100kb. If set to 0, shared memory
 509     caching will not be used.</p>
 510
 511 </div>
 512 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 513 <div class="directive-section"><h2><a name="LDAPTrustedClientCert" id="LDAPTrustedClientCert">LDAPTrustedClientCert</a> <a name="ldaptrustedclientcert" id="ldaptrustedclientcert">Directive</a></h2>
 514 <table class="directive">
 515 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the file containing or nickname referring to a per
 516 connection client certificate. Not all LDAP toolkits support per
 517 connection client certificates.</td></tr>
 518 <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>
 519 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 520 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 521 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 522 </table>
 523     <p>It specifies the directory path, file name or nickname of a
 524     per connection client certificate used when establishing an SSL
 525     or TLS connection to an LDAP server. Different locations or
 526     directories may have their own independant client certificate
 527     settings. Some LDAP toolkits (notably Novell)
 528     do not support per connection client certificates, and will throw an
 529     error on LDAP server connection if you try to use this directive
 530     (Use the LDAPTrustedGlobalCert directive instead for Novell client
 531     certificates - See the SSL/TLS certificate guide above for details).
 532     The type specifies the kind of certificate parameter being
 533     set, depending on the LDAP toolkit being used. Supported types are:</p>
 534     <ul>
 535       <li>CERT_DER - binary DER encoded client certificate</li>
 536       <li>CERT_BASE64 - PEM encoded client certificate</li>
 537       <li>CERT_NICKNAME - Client certificate "nickname" (Netscape SDK)</li>
 538       <li>KEY_DER - binary DER encoded private key</li>
 539       <li>KEY_BASE64 - PEM encoded private key</li>
 540     </ul>
 541
 542 </div>
 543 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 544 <div class="directive-section"><h2><a name="LDAPTrustedGlobalCert" id="LDAPTrustedGlobalCert">LDAPTrustedGlobalCert</a> <a name="ldaptrustedglobalcert" id="ldaptrustedglobalcert">Directive</a></h2>
 545 <table class="directive">
 546 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the file or database containing global trusted
 547 Certificate Authority or global client certificates</td></tr>
 548 <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>
 549 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 550 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 551 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 552 </table>
 553     <p>It specifies the directory path and file name of the trusted CA
 554     certificates and/or system wide client certificates <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code>
 555     should use when establishing an SSL or TLS connection to an LDAP
 556     server. Note that all certificate information specified using this directive
 557     is applied globally to the entire server installation. Some LDAP toolkits
 558     (notably Novell) require all client certificates to be set globally using
 559     this directive. Most other toolkits require clients certificates to be set
 560     per Directory or per Location using LDAPTrustedClientCert. If you get this
 561     wrong, an error may be logged when an attempt is made to contact the LDAP
 562     server, or the connection may silently fail (See the SSL/TLS certificate
 563     guide above for details).
 564     The type specifies the kind of certificate parameter being
 565     set, depending on the LDAP toolkit being used. Supported types are:</p>
 566     <ul>
 567       <li>CA_DER - binary DER encoded CA certificate</li>
 568       <li>CA_BASE64 - PEM encoded CA certificate</li>
 569       <li>CA_CERT7_DB - Netscape cert7.db CA certificate database file</li>
 570       <li>CA_SECMOD - Netscape secmod database file</li>
 571       <li>CERT_DER - binary DER encoded client certificate</li>
 572       <li>CERT_BASE64 - PEM encoded client certificate</li>
 573       <li>CERT_KEY3_DB - Netscape key3.db client certificate database file</li>
 574       <li>CERT_NICKNAME - Client certificate "nickname" (Netscape SDK)</li>
 575       <li>CERT_PFX - PKCS#12 encoded client certificate (Novell SDK)</li>
 576       <li>KEY_DER - binary DER encoded private key</li>
 577       <li>KEY_BASE64 - PEM encoded private key</li>
 578       <li>KEY_PFX - PKCS#12 encoded private key (Novell SDK)</li>
 579     </ul>
 580
 581 </div>
 582 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 583 <div class="directive-section"><h2><a name="LDAPTrustedMode" id="LDAPTrustedMode">LDAPTrustedMode</a> <a name="ldaptrustedmode" id="ldaptrustedmode">Directive</a></h2>
 584 <table class="directive">
 585 <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>
 586 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPTrustedMode <var>type</var></code></td></tr>
 587 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 588 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 589 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 590 </table>
 591     <p>The following modes are supported:</p>
 592     <ul>
 593       <li>NONE - no encryption</li>
 594       <li>SSL - ldaps:// encryption on default port 636</li>
 595       <li>TLS - STARTTLS encryption on default port 389</li>
 596     </ul>
 597
 598     <p>Not all LDAP toolkits support all the above modes. An error message
 599     will be logged at runtime if a mode is not supported, and the
 600     connection to the LDAP server will fail.
 601     </p>
 602
 603     <p>If an ldaps:// URL is specified, the mode becomes SSL and the setting
 604     of LDAPTrustedMode is ignored.</p>
 605
 606 </div>
 607 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 608 <div class="directive-section"><h2><a name="LDAPVerifyServerCert" id="LDAPVerifyServerCert">LDAPVerifyServerCert</a> <a name="ldapverifyservercert" id="ldapverifyservercert">Directive</a></h2>
 609 <table class="directive">
 610 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Force server certificate verification</td></tr>
 611 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPVerifyServerCert <var>On|Off</var></code></td></tr>
 612 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPVerifyServerCert On</code></td></tr>
 613 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</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>Specifies whether to force the verification of a
 618      server certificate when establishing an SSL connection to the
 619      LDAP server.</p>
 620
 621 </div>
 622 </div>
 623 <div class="bottomlang">
 624 <p><span>Available Languages: </span><a href="../en/mod/mod_ldap.html" title="English">&nbsp;en&nbsp;</a></p>
 625 </div><div id="footer">
 626 <p class="apache">Copyright 1995-2006 The Apache Software Foundation or its licensors, as applicable.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 627 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 628 </body></html>