home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278320_mod_ldap.xml < prev    next >
Extensible Markup Language  |  2004-09-20  |  14KB  |  343 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.3.2.9 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <modulesynopsis metafile="mod_ldap.xml.meta">
  23.  
  24. <name>mod_ldap</name>
  25. <description>LDAP connection pooling and result caching services for use
  26. by other LDAP modules</description>
  27. <status>Experimental</status>
  28. <sourcefile>util_ldap.c</sourcefile>
  29. <identifier>ldap_module</identifier>
  30. <compatibility>Available in version 2.0.41 and later</compatibility>
  31.  
  32. <summary>
  33.     <p>This module was created to improve the performance of
  34.     websites relying on backend connections to LDAP servers. In
  35.     addition to the functions provided by the standard LDAP
  36.     libraries, this module adds an LDAP connection pool and an LDAP
  37.     shared memory cache.</p>
  38.  
  39.     <p>To enable this module, LDAP support must be compiled into
  40.     apr-util. This is achieved by adding the <code>--with-ldap</code>
  41.     flag to the <code>./configure</code> script when building
  42.     Apache.</p>
  43.  
  44.     <p>SSL support requires that <module>mod_ldap</module> be linked
  45.     with one of the following LDAP SDKs: <a href="http://www.openldap.org/">
  46.     OpenLDAP SDK</a> (both 1.x and 2.x), <a href="http://developer.novell.com/ndk/cldap.htm">
  47.     Novell LDAP SDK</a> or the <a href="http://www.iplanet.com/downloads/developer/">
  48.     iPlanet(Netscape)</a> SDK.</p>
  49.  
  50. </summary>
  51.  
  52. <section id="exampleconfig"><title>Example Configuration</title>
  53.     <p>The following is an example configuration that uses
  54.     <module>mod_ldap</module> to increase the performance of HTTP Basic
  55.     authentication provided by <module>mod_auth_ldap</module>.</p>
  56.  
  57.     <example>
  58.       # Enable the LDAP connection pool and shared<br />
  59.       # memory cache. Enable the LDAP cache status<br />
  60.       # handler. Requires that mod_ldap and mod_auth_ldap<br />
  61.       # be loaded. Change the "yourdomain.example.com" to<br />
  62.       # match your domain.<br />
  63.       <br />
  64.       LDAPSharedCacheSize 200000<br />
  65.       LDAPCacheEntries 1024<br />
  66.       LDAPCacheTTL 600<br />
  67.       LDAPOpCacheEntries 1024<br />
  68.       LDAPOpCacheTTL 600<br />
  69.       <br />
  70.       <Location /ldap-status><br />
  71.       <indent>
  72.         SetHandler ldap-status<br />
  73.         Order deny,allow<br />
  74.         Deny from all<br />
  75.         Allow from yourdomain.example.com<br />
  76.         AuthLDAPEnabled on<br />
  77.         AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one<br />
  78.         AuthLDAPAuthoritative on<br />
  79.         require valid-user<br />
  80.       </indent>
  81.       </Location>
  82.     </example>
  83. </section>
  84.  
  85. <section id="pool"><title>LDAP Connection Pool</title>
  86.  
  87.     <p>LDAP connections are pooled from request to request. This
  88.     allows the LDAP server to remain connected and bound ready for
  89.     the next request, without the need to unbind/connect/rebind.
  90.     The performance advantages are similar to the effect of HTTP
  91.     keepalives.</p>
  92.  
  93.     <p>On a busy server it is possible that many requests will try
  94.     and access the same LDAP server connection simultaneously.
  95.     Where an LDAP connection is in use, Apache will create a new
  96.     connection alongside the original one. This ensures that the
  97.     connection pool does not become a bottleneck.</p>
  98.  
  99.     <p>There is no need to manually enable connection pooling in
  100.     the Apache configuration. Any module using this module for
  101.     access to LDAP services will share the connection pool.</p>
  102. </section>
  103.  
  104. <section id="cache"><title>LDAP Cache</title>
  105.  
  106.     <p>For improved performance, <module>mod_ldap</module> uses an aggressive
  107.     caching strategy to minimize the number of times that the LDAP
  108.     server must be contacted. Caching can easily double or triple
  109.     the throughput of Apache when it is serving pages protected
  110.     with mod_auth_ldap. In addition, the load on the LDAP server
  111.     will be significantly decreased.</p>
  112.  
  113.     <p><module>mod_ldap</module> supports two types of LDAP caching during
  114.     the search/bind phase with a <em>search/bind cache</em> and
  115.     during the compare phase with two <em>operation
  116.     caches</em>. Each LDAP URL that is used by the server has
  117.     its own set of these three caches.</p>
  118.  
  119.     <section id="search-bind"><title>The Search/Bind Cache</title>
  120.       <p>The process of doing a search and then a bind is the
  121.       most time-consuming aspect of LDAP operation, especially if
  122.       the directory is large. The search/bind cache is used to
  123.       cache all searches that resulted in successful binds.
  124.       Negative results (<em>i.e.</em>, unsuccessful searches, or searches
  125.       that did not result in a successful bind) are not cached.
  126.       The rationale behind this decision is that connections with
  127.       invalid credentials are only a tiny percentage of the total
  128.       number of connections, so by not caching invalid
  129.       credentials, the size of the cache is reduced.</p>
  130.  
  131.       <p><module>mod_ldap</module> stores the username, the DN
  132.       retrieved, the password used to bind, and the time of the bind
  133.       in the cache. Whenever a new connection is initiated with the
  134.       same username, <module>mod_ldap</module> compares the password
  135.       of the new connection with the password in the cache. If the
  136.       passwords match, and if the cached entry is not too old,
  137.       <module>mod_ldap</module> bypasses the search/bind phase.</p>
  138.  
  139.       <p>The search and bind cache is controlled with the <directive
  140.       module="mod_ldap">LDAPCacheEntries</directive> and <directive
  141.       module="mod_ldap">LDAPCacheTTL</directive> directives.</p>
  142.     </section>
  143.  
  144.     <section id="opcaches"><title>Operation Caches</title>
  145.       <p>During attribute and distinguished name comparison
  146.       functions, <module>mod_ldap</module> uses two operation caches
  147.       to cache the compare operations. The first compare cache is
  148.       used to cache the results of compares done to test for LDAP
  149.       group membership. The second compare cache is used to cache
  150.       the results of comparisons done between distinguished
  151.       names.</p>
  152.  
  153.       <p>The behavior of both of these caches is controlled with
  154.       the <directive module="mod_ldap">LDAPOpCacheEntries</directive>
  155.       and <directive module="mod_ldap">LDAPOpCacheTTL</directive>
  156.       directives.</p>
  157.     </section>
  158.  
  159.     <section id="monitoring"><title>Monitoring the Cache</title>
  160.       <p><module>mod_ldap</module> has a content handler that allows
  161.       administrators to monitor the cache performance. The name of
  162.       the content handler is <code>ldap-status</code>, so the
  163.       following directives could be used to access the
  164.       <module>mod_ldap</module> cache information:</p>
  165.  
  166.       <example>
  167.         <Location /server/cache-info><br />
  168.         <indent>
  169.           SetHandler ldap-status<br />
  170.         </indent>
  171.         </Location>
  172.       </example>
  173.  
  174.       <p>By fetching the URL <code>http://servername/cache-info</code>,
  175.       the administrator can get a status report of every cache that is used
  176.       by <module>mod_ldap</module> cache. Note that if Apache does not
  177.       support shared memory, then each <code>httpd</code> instance has its
  178.       own cache, so reloading the URL will result in different
  179.       information each time, depending on which <code>httpd</code>
  180.       instance processes the request.</p>
  181.     </section>
  182. </section>
  183.  
  184. <section id="usingssltls"><title>Using SSL</title>
  185.  
  186.     <p>The ability to create an SSL connections to an LDAP server 
  187.     is defined by the directives <directive module="mod_ldap">
  188.     LDAPTrustedCA</directive> and <directive module="mod_ldap">
  189.     LDAPTrustedCAType</directive>. These directives specify the certificate
  190.     file or database and the certificate type. Whenever the LDAP url
  191.     includes <em>ldaps://</em>, <module>mod_ldap</module> will establish
  192.     a secure connection to the LDAP server.</p>
  193.  
  194.     <example>
  195.       # Establish an SSL LDAP connection. Requires that <br />
  196.       # mod_ldap and mod_auth_ldap be loaded. Change the <br />
  197.       # "yourdomain.example.com" to match your domain.<br />
  198.       <br />
  199.       LDAPTrustedCA /certs/certfile.der<br />
  200.       LDAPTrustedCAType DER_FILE<br />
  201.       <br />
  202.       <Location /ldap-status><br />
  203.       <indent>
  204.         SetHandler ldap-status<br />
  205.         Order deny,allow<br />
  206.         Deny from all<br />
  207.         Allow from yourdomain.example.com<br />
  208.         AuthLDAPEnabled on<br />
  209.         AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
  210.         AuthLDAPAuthoritative on<br />
  211.         require valid-user<br />
  212.       </indent>
  213.       </Location>
  214.     </example>
  215.  
  216.     <p>If <module>mod_ldap</module> is linked against the
  217.     Netscape/iPlanet LDAP SDK, it will not talk to any SSL server
  218.     unless that server has a certificate signed by a known Certificate
  219.     Authority. As part of the configuration
  220.     <module>mod_ldap</module> needs to be told where it can find
  221.     a database containing the known CAs. This database is in the same
  222.     format as Netscape Communicator's <code>cert7.db</code>
  223.     database. The easiest way to get this file is to start up a fresh
  224.     copy of Netscape, and grab the resulting
  225.     <code>$HOME/.netscape/cert7.db</code> file.</p>
  226.  
  227. </section>
  228.  
  229. <directivesynopsis>
  230. <name>LDAPSharedCacheSize</name>
  231. <description>Size in bytes of the shared-memory cache</description>
  232. <syntax>LDAPSharedCacheSize <var>bytes</var></syntax>
  233. <default>LDAPSharedCacheSize 102400</default>
  234. <contextlist><context>server config</context></contextlist>
  235.  
  236. <usage>
  237.     <p>Specifies the number of bytes to allocate for the shared
  238.     memory cache. The default is 100kb. If set to 0, shared memory
  239.     caching will not be used.</p>
  240. </usage>
  241. </directivesynopsis>
  242.  
  243. <directivesynopsis>
  244. <name>LDAPSharedCacheFile</name>
  245. <description>Sets the shared memory cache file</description>
  246. <syntax>LDAPSharedCacheFile <var>directory-path/filename</var></syntax>
  247. <contextlist><context>server config</context></contextlist>
  248.  
  249. <usage>
  250.     <p>Specifies the directory path and file name of the shared memory
  251.     cache file. If not set, anonymous shared memory will be used if the
  252.     platform supports it.</p>
  253. </usage>
  254. </directivesynopsis>
  255.  
  256. <directivesynopsis>
  257. <name>LDAPCacheEntries</name>
  258. <description>Maximum number of entries in the primary LDAP cache</description>
  259. <syntax>LDAPCacheEntries <var>number</var></syntax>
  260. <default>LDAPCacheEntries 1024</default>
  261. <contextlist><context>server config</context></contextlist>
  262.  
  263. <usage>
  264.     <p>Specifies the maximum size of the primary LDAP cache. This
  265.     cache contains successful search/binds. Set it to 0 to turn off
  266.     search/bind caching. The default size is 1024 cached
  267.     searches.</p>
  268. </usage>
  269. </directivesynopsis>
  270.  
  271. <directivesynopsis>
  272. <name>LDAPCacheTTL</name>
  273. <description>Time that cached items remain valid</description>
  274. <syntax>LDAPCacheTTL <var>seconds</var></syntax>
  275. <default>LDAPCacheTTL 600</default>
  276. <contextlist><context>server config</context></contextlist>
  277.  
  278. <usage>
  279.     <p>Specifies the time (in seconds) that an item in the
  280.     search/bind cache remains valid. The default is 600 seconds (10
  281.     minutes).</p>
  282. </usage>
  283. </directivesynopsis>
  284.  
  285. <directivesynopsis>
  286. <name>LDAPOpCacheEntries</name>
  287. <description>Number of entries used to cache LDAP compare 
  288. operations</description>
  289. <syntax>LDAPOpCacheEntries <var>number</var></syntax>
  290. <default>LDAPOpCacheEntries 1024</default>
  291. <contextlist><context>server config</context></contextlist>
  292.  
  293. <usage>
  294.     <p>This specifies the number of entries <module>mod_ldap</module>
  295.     will use to cache LDAP compare operations. The default is 1024
  296.     entries.  Setting it to 0 disables operation caching.</p>
  297. </usage>
  298. </directivesynopsis>
  299.  
  300. <directivesynopsis>
  301. <name>LDAPOpCacheTTL</name>
  302. <description>Time that entries in the operation cache remain
  303. valid</description>
  304. <syntax>LDAPOpCacheTTL <var>seconds</var></syntax>
  305. <default>LDAPOpCacheTTL 600</default>
  306. <contextlist><context>server config</context></contextlist>
  307.  
  308. <usage>
  309.     <p>Specifies the time (in seconds) that entries in the
  310.     operation cache remain valid. The default is 600 seconds.</p>
  311. </usage>
  312. </directivesynopsis>
  313.  
  314. <directivesynopsis>
  315. <name>LDAPTrustedCA</name>
  316. <description>Sets the file containing the trusted Certificate Authority certificate or database</description>
  317. <syntax>LDAPTrustedCA <var>directory-path/filename</var></syntax>
  318. <contextlist><context>server config</context></contextlist>
  319.  
  320. <usage>
  321.     <p>It specifies the directory path and file name of the trusted CA
  322.     <module>mod_ldap</module> should use when establishing an SSL
  323.     connection to an LDAP server. If using the Netscape/iPlanet Directory
  324.     SDK, the file name should be <code>cert7.db</code>.</p>
  325. </usage>
  326. </directivesynopsis>
  327.  
  328. <directivesynopsis>
  329. <name>LDAPTrustedCAType</name>
  330. <description>Specifies the type of the Certificate Authority file</description>
  331. <syntax>LDAPTrustedCAType <var>type</var></syntax>
  332. <contextlist><context>server config</context></contextlist>
  333.  
  334. <usage>
  335.     <p>The following types are supported:<br />
  336.           DER_FILE      - file in binary DER format<br />
  337.           BASE64_FILE   - file in Base64 format<br />
  338.           CERT7_DB_PATH - Netscape certificate database file ")</p>
  339. </usage>
  340. </directivesynopsis>
  341.  
  342. </modulesynopsis>
  343.