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
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>
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.2</p>
17
<img alt="" src="../images/feather.gif" /></div>
18
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
20
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Modules</a></div>
21
<div id="page-content">
22
<div id="preamble"><h1>Apache Module mod_ldap</h1>
24
<p><span>Available Languages: </span><a href="../en/mod/mod_ldap.html" title="English"> en </a></p>
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>
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>
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
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>
57
<div id="quickview"><h3 class="directives">Directives</h3>
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>
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>
79
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
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>
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 />
93
LDAPSharedCacheSize 200000<br />
94
LDAPCacheEntries 1024<br />
95
LDAPCacheTTL 600<br />
96
LDAPOpCacheEntries 1024<br />
97
LDAPOpCacheTTL 600<br />
99
<Location /ldap-status><br />
100
<span class="indent">
101
SetHandler ldap-status<br />
102
Order deny,allow<br />
104
Allow from yourdomain.example.com<br />
105
AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one<br />
106
AuthzLDAPAuthoritative off<br />
107
require valid-user<br />
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>
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
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>
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>
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>
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>
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>
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>
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>
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
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>
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>
192
<div class="example"><p><code>
193
<Location /server/cache-info><br />
194
<span class="indent">
195
SetHandler ldap-status<br />
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>
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>
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="# ldaptrustedglobalcert">
214
LDAPTrustedGlobalCert</a></code>, <code class="directive"><a href="# ldaptrustedclientcert">
215
LDAPTrustedClientCert</a></code> and <code class="directive"><a href="# 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>
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 />
225
LDAPTrustedGlobalCert CA_DER /certs/certfile.der<br />
227
<Location /ldap-status><br />
228
<span class="indent">
229
SetHandler ldap-status<br />
230
Order deny,allow<br />
232
Allow from yourdomain.example.com<br />
233
AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
234
AuthzLDAPAuthoritative off<br />
235
require valid-user<br />
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 />
245
LDAPTrustedGlobalCert CA_DER /certs/certfile.der<br />
247
<Location /ldap-status><br />
248
<span class="indent">
249
SetHandler ldap-status<br />
250
Order deny,allow<br />
252
Allow from yourdomain.example.com<br />
253
AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one TLS<br />
254
AuthzLDAPAuthoritative off<br />
255
require valid-user<br />
260
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
261
<div class="section">
262
<h2><a name="settingcerts" id="settingcerts">SSL/TLS Certificates</a></h2>
264
<p>The different LDAP SDKs have widely different methods of setting
265
and handling both CA and client side certificates.</p>
267
<p>If you intend to use SSL or TLS, read this section CAREFULLY so as to
268
understand the differences between configurations on the different LDAP
269
toolkits supported.</p>
271
<h3><a name="settingcerts-netscape" id="settingcerts-netscape">Netscape/Mozilla/iPlanet SDK</a></h3>
272
<p>CA certificates are specified within a file called cert7.db.
273
The SDK will not talk to any LDAP server whose certificate was
274
not signed by a CA specified in this file. If
275
client certificates are required, an optional key3.db file may
276
be specified with an optional password. The secmod file can be
277
specified if required. These files are in the same format as
278
used by the Netscape Communicator or Mozilla web browsers. The easiest
279
way to obtain these files is to grab them from your browser
282
<p>Client certificates are specified per connection using the
283
LDAPTrustedClientCert directive by referring
284
to the certificate "nickname". An optional password may be
285
specified to unlock the certificate's private key.</p>
287
<p>The SDK supports SSL only. An attempt to use STARTTLS will cause
288
an error when an attempt is made to contact the LDAP server at
291
<div class="example"><p><code>
292
# Specify a Netscape CA certificate file<br />
293
LDAPTrustedGlobalCert CA_CERT7_DB /certs/cert7.db<br />
294
# Specify an optional key3.db file for client certificate support<br />
295
LDAPTrustedGlobalCert CERT_KEY3_DB /certs/key3.db<br />
296
# Specify the secmod file if required<br />
297
LDAPTrustedGlobalCert CA_SECMOD /certs/secmod<br />
298
<Location /ldap-status><br />
299
<span class="indent">
300
SetHandler ldap-status<br />
301
Order deny,allow<br />
303
Allow from yourdomain.example.com<br />
304
LDAPTrustedClientCert CERT_NICKNAME <nickname> [password]<br />
305
AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
306
AuthzLDAPAuthoritative off<br />
307
require valid-user<br />
314
<h3><a name="settingcerts-novell" id="settingcerts-novell">Novell SDK</a></h3>
316
<p>One or more CA certificates must be specified for the Novell
317
SDK to work correctly. These certificates can be specified as
318
binary DER or Base64 (PEM) encoded files.</p>
320
<p>Note: Client certificates are specified globally rather than per
321
connection, and so must be specified with the LDAPTrustedGlobalCert
322
directive as below. Trying to set client certificates via the
323
LDAPTrustedClientCert directive will cause an error to be logged
324
when an attempt is made to connect to the LDAP server..</p>
326
<p>The SDK supports both SSL and STARTTLS, set using the
327
LDAPTrustedMode parameter. If an ldaps:// URL is specified,
328
SSL mode is forced, override this directive.</p>
330
<div class="example"><p><code>
331
# Specify two CA certificate files<br />
332
LDAPTrustedGlobalCert CA_DER /certs/cacert1.der<br />
333
LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem<br />
334
# Specify a client certificate file and key<br />
335
LDAPTrustedGlobalCert CERT_BASE64 /certs/cert1.pem<br />
336
LDAPTrustedGlobalCert KEY_BASE64 /certs/key1.pem [password]<br />
337
# Do not use this directive, as it will throw an error<br />
338
#LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem<br />
343
<h3><a name="settingcerts-openldap" id="settingcerts-openldap">OpenLDAP SDK</a></h3>
345
<p>One or more CA certificates must be specified for the OpenLDAP
346
SDK to work correctly. These certificates can be specified as
347
binary DER or Base64 (PEM) encoded files.</p>
349
<p>Client certificates are specified per connection using the
350
LDAPTrustedClientCert directive.</p>
352
<p>The documentation for the SDK claims to support both SSL and
353
STARTTLS, however STARTTLS does not seem to work on all versions
354
of the SDK. The SSL/TLS mode can be set using the
355
LDAPTrustedMode parameter. If an ldaps:// URL is specified,
356
SSL mode is forced. The OpenLDAP documentation notes that SSL
357
(ldaps://) support has been deprecated to be replaced with TLS,
358
although the SSL functionality still works.</p>
360
<div class="example"><p><code>
361
# Specify two CA certificate files<br />
362
LDAPTrustedGlobalCert CA_DER /certs/cacert1.der<br />
363
LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem<br />
364
<Location /ldap-status><br />
365
<span class="indent">
366
SetHandler ldap-status<br />
367
Order deny,allow<br />
369
Allow from yourdomain.example.com<br />
370
LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem<br />
371
LDAPTrustedClientCert KEY_BASE64 /certs/key1.pem<br />
372
AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
373
AuthzLDAPAuthoritative off<br />
374
require valid-user<br />
381
<h3><a name="settingcerts-solaris" id="settingcerts-solaris">Solaris SDK</a></h3>
383
<p>SSL/TLS for the native Solaris LDAP libraries is not yet
384
supported. If required, install and use the OpenLDAP libraries
389
<h3><a name="settingcerts-microsoft" id="settingcerts-microsoft">Microsoft SDK</a></h3>
391
<p>SSL/TLS certificate configuration for the native Microsoft
392
LDAP libraries is done inside the system registry, and no
393
configuration directives are required.</p>
395
<p>Both SSL and TLS are supported by using the ldaps:// URL
396
format, or by using the LDAPTrustedMode directive accordingly.</p>
398
<p>Note: The status of support for client certificates is not yet known
399
for this toolkit.</p>
404
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
405
<div class="directive-section"><h2><a name="LDAPCacheEntries" id="LDAPCacheEntries">LDAPCacheEntries</a> <a name="ldapcacheentries" id="ldapcacheentries">Directive</a></h2>
406
<table class="directive">
407
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum number of entries in the primary LDAP cache</td></tr>
408
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPCacheEntries <var>number</var></code></td></tr>
409
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPCacheEntries 1024</code></td></tr>
410
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
411
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
412
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
414
<p>Specifies the maximum size of the primary LDAP cache. This
415
cache contains successful search/binds. Set it to 0 to turn off
416
search/bind caching. The default size is 1024 cached
420
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
421
<div class="directive-section"><h2><a name="LDAPCacheTTL" id="LDAPCacheTTL">LDAPCacheTTL</a> <a name="ldapcachettl" id="ldapcachettl">Directive</a></h2>
422
<table class="directive">
423
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Time that cached items remain valid</td></tr>
424
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPCacheTTL <var>seconds</var></code></td></tr>
425
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPCacheTTL 600</code></td></tr>
426
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
427
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
428
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
430
<p>Specifies the time (in seconds) that an item in the
431
search/bind cache remains valid. The default is 600 seconds (10
435
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
436
<div class="directive-section"><h2><a name="LDAPConnectionTimeout" id="LDAPConnectionTimeout">LDAPConnectionTimeout</a> <a name="ldapconnectiontimeout" id="ldapconnectiontimeout">Directive</a></h2>
437
<table class="directive">
438
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies the socket connection timeout in seconds</td></tr>
439
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPConnectionTimeout <var>seconds</var></code></td></tr>
440
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
441
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
442
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
444
<p>Specifies the timeout value (in seconds) in which the module will
445
attempt to connect to the LDAP server. If a connection is not
446
successful with the timeout period, either an error will be
447
returned or the module will attempt to connect to a secondary LDAP
448
server if one is specified. The default is 10 seconds.</p>
451
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
452
<div class="directive-section"><h2><a name="LDAPOpCacheEntries" id="LDAPOpCacheEntries">LDAPOpCacheEntries</a> <a name="ldapopcacheentries" id="ldapopcacheentries">Directive</a></h2>
453
<table class="directive">
454
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of entries used to cache LDAP compare
456
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPOpCacheEntries <var>number</var></code></td></tr>
457
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPOpCacheEntries 1024</code></td></tr>
458
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
459
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
460
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
462
<p>This specifies the number of entries <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code>
463
will use to cache LDAP compare operations. The default is 1024
464
entries. Setting it to 0 disables operation caching.</p>
467
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
468
<div class="directive-section"><h2><a name="LDAPOpCacheTTL" id="LDAPOpCacheTTL">LDAPOpCacheTTL</a> <a name="ldapopcachettl" id="ldapopcachettl">Directive</a></h2>
469
<table class="directive">
470
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Time that entries in the operation cache remain
472
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPOpCacheTTL <var>seconds</var></code></td></tr>
473
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPOpCacheTTL 600</code></td></tr>
474
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
475
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
476
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
478
<p>Specifies the time (in seconds) that entries in the
479
operation cache remain valid. The default is 600 seconds.</p>
482
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
483
<div class="directive-section"><h2><a name="LDAPSharedCacheFile" id="LDAPSharedCacheFile">LDAPSharedCacheFile</a> <a name="ldapsharedcachefile" id="ldapsharedcachefile">Directive</a></h2>
484
<table class="directive">
485
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the shared memory cache file</td></tr>
486
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPSharedCacheFile <var>directory-path/filename</var></code></td></tr>
487
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
488
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
489
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
491
<p>Specifies the directory path and file name of the shared memory
492
cache file. If not set, anonymous shared memory will be used if the
493
platform supports it.</p>
496
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
497
<div class="directive-section"><h2><a name="LDAPSharedCacheSize" id="LDAPSharedCacheSize">LDAPSharedCacheSize</a> <a name="ldapsharedcachesize" id="ldapsharedcachesize">Directive</a></h2>
498
<table class="directive">
499
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size in bytes of the shared-memory cache</td></tr>
500
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPSharedCacheSize <var>bytes</var></code></td></tr>
501
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPSharedCacheSize 102400</code></td></tr>
502
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
503
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
504
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
506
<p>Specifies the number of bytes to allocate for the shared
507
memory cache. The default is 100kb. If set to 0, shared memory
508
caching will not be used.</p>
511
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
512
<div class="directive-section"><h2><a name="LDAPTrustedClientCert" id="LDAPTrustedClientCert">LDAPTrustedClientCert</a> <a name="ldaptrustedclientcert" id="ldaptrustedclientcert">Directive</a></h2>
513
<table class="directive">
514
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the file containing or nickname referring to a per
515
connection client certificate. Not all LDAP toolkits support per
516
connection client certificates.</td></tr>
517
<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>
518
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
519
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
520
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
522
<p>It specifies the directory path, file name or nickname of a
523
per connection client certificate used when establishing an SSL
524
or TLS connection to an LDAP server. Different locations or
525
directories may have their own independant client certificate
526
settings. Some LDAP toolkits (notably Novell)
527
do not support per connection client certificates, and will throw an
528
error on LDAP server connection if you try to use this directive
529
(Use the LDAPTrustedGlobalCert directive instead for Novell client
530
certificates - See the SSL/TLS certificate guide above for details).
531
The type specifies the kind of certificate parameter being
532
set, depending on the LDAP toolkit being used. Supported types are:</p>
534
<li>CERT_DER - binary DER encoded client certificate</li>
535
<li>CERT_BASE64 - PEM encoded client certificate</li>
536
<li>CERT_NICKNAME - Client certificate "nickname" (Netscape SDK)</li>
537
<li>KEY_DER - binary DER encoded private key</li>
538
<li>KEY_BASE64 - PEM encoded private key</li>
542
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
543
<div class="directive-section"><h2><a name="LDAPTrustedGlobalCert" id="LDAPTrustedGlobalCert">LDAPTrustedGlobalCert</a> <a name="ldaptrustedglobalcert" id="ldaptrustedglobalcert">Directive</a></h2>
544
<table class="directive">
545
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the file or database containing global trusted
546
Certificate Authority or global client certificates</td></tr>
547
<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>
548
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
549
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
550
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
552
<p>It specifies the directory path and file name of the trusted CA
553
certificates and/or system wide client certificates <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code>
554
should use when establishing an SSL or TLS connection to an LDAP
555
server. Note that all certificate information specified using this directive
556
is applied globally to the entire server installation. Some LDAP toolkits
557
(notably Novell) require all client certificates to be set globally using
558
this directive. Most other toolkits require clients certificates to be set
559
per Directory or per Location using LDAPTrustedClientCert. If you get this
560
wrong, an error may be logged when an attempt is made to contact the LDAP
561
server, or the connection may silently fail (See the SSL/TLS certificate
562
guide above for details).
563
The type specifies the kind of certificate parameter being
564
set, depending on the LDAP toolkit being used. Supported types are:</p>
566
<li>CA_DER - binary DER encoded CA certificate</li>
567
<li>CA_BASE64 - PEM encoded CA certificate</li>
568
<li>CA_CERT7_DB - Netscape cert7.db CA certificate database file</li>
569
<li>CA_SECMOD - Netscape secmod database file</li>
570
<li>CERT_DER - binary DER encoded client certificate</li>
571
<li>CERT_BASE64 - PEM encoded client certificate</li>
572
<li>CERT_KEY3_DB - Netscape key3.db client certificate database file</li>
573
<li>CERT_NICKNAME - Client certificate "nickname" (Netscape SDK)</li>
574
<li>CERT_PFX - PKCS#12 encoded client certificate (Novell SDK)</li>
575
<li>KEY_DER - binary DER encoded private key</li>
576
<li>KEY_BASE64 - PEM encoded private key</li>
577
<li>KEY_PFX - PKCS#12 encoded private key (Novell SDK)</li>
581
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
582
<div class="directive-section"><h2><a name="LDAPTrustedMode" id="LDAPTrustedMode">LDAPTrustedMode</a> <a name="ldaptrustedmode" id="ldaptrustedmode">Directive</a></h2>
583
<table class="directive">
584
<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>
585
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPTrustedMode <var>type</var></code></td></tr>
586
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
587
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
588
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
590
<p>The following modes are supported:</p>
592
<li>NONE - no encryption</li>
593
<li>SSL - ldaps:// encryption on default port 636</li>
594
<li>TLS - STARTTLS encryption on default port 389</li>
597
<p>Not all LDAP toolkits support all the above modes. An error message
598
will be logged at runtime if a mode is not supported, and the
599
connection to the LDAP server will fail.
602
<p>If an ldaps:// URL is specified, the mode becomes SSL and the setting
603
of LDAPTrustedMode is ignored.</p>
606
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
607
<div class="directive-section"><h2><a name="LDAPVerifyServerCert" id="LDAPVerifyServerCert">LDAPVerifyServerCert</a> <a name="ldapverifyservercert" id="ldapverifyservercert">Directive</a></h2>
608
<table class="directive">
609
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Force server certificate verification</td></tr>
610
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPVerifyServerCert <var>On|Off</var></code></td></tr>
611
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPVerifyServerCert On</code></td></tr>
612
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
613
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
614
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
616
<p>Specifies whether to force the verification of a
617
server certificate when establishing an SSL connection to the
622
<div class="bottomlang">
623
<p><span>Available Languages: </span><a href="../en/mod/mod_ldap.html" title="English"> en </a></p>
624
</div><div id="footer">
625
<p class="apache">Copyright 2006 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>
626
<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>
b'\\ No newline at end of file'
added
removed
docs/manual/mod/mod_ldap.html.en
