home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2004 March / PCWMAR04.iso / Software / Resources / Apache / apache_2.0.48-win32-x86-no_ssl.exe / F254349_mod_negotiation.xml < prev    next >
Encoding:
Text File  |  2003-04-15  |  11.2 KB  |  302 lines
  1. of the new connection with the password in the cache. If the
  2.       passwords match, and if the cached entry is not too old,
  3.       <module>mod_ldap</module> bypasses the search/bind phase.</p>
  4.  
  5.       <p>The search and bind cache is controlled with the <directive
  6.       module="mod_ldap">LDAPCacheEntries</directive> and <directive
  7.       module="mod_ldap">LDAPCacheTTL</directive> directives.</p>
  8.     </section>
  9.  
  10.     <section id="opcaches"><title>Operation Caches</title>
  11.       <p>During attribute and distinguished name comparison
  12.       functions, <module>mod_ldap</module> uses two operation caches
  13.       to cache the compare operations. The first compare cache is
  14.       used to cache the results of compares done to test for LDAP
  15.       group membership. The second compare cache is used to cache
  16.       the results of comparisons done between distinguished
  17.       names.</p>
  18.  
  19.       <p>The behavior of both of these caches is controlled with
  20.       the <directive module="mod_ldap">LDAPOpCacheEntries</directive>
  21.       and <directive module="mod_ldap">LDAPOpCacheTTL</directive>
  22.       directives.</p>
  23.     </section>
  24.  
  25.     <section id="monitoring"><title>Monitoring the Cache</title>
  26.       <p><module>mod_ldap</module> has a content handler that allows
  27.       administrators to monitor the cache performance. The name of
  28.       the content handler is <code>ldap-status</code>, so the
  29.       following directives could be used to access the
  30.       <module>mod_ldap</module> cache information:</p>
  31.  
  32.       <example>
  33.         <Location /server/cache-info><br />
  34.         <indent>
  35.           SetHandler ldap-status<br />
  36.         </indent>
  37.         </Location>
  38.       </example>
  39.  
  40.       <p>By fetching the URL <code>http://servername/cache-info</code>,
  41.       the administrator can get a status report of every cache that is used
  42.       by <module>mod_ldap</module> cache. Note that if Apache does not
  43.       support shared memory, then each <code>httpd</code> instance has its
  44.       own cache, so reloading the URL will result in different
  45.       information each time, depending on which <code>httpd</code>
  46.       instance processes the request.</p>
  47.     </section>
  48. </section>
  49.  
  50. <section id="usingssltls"><title>Using SSL</title>
  51.  
  52.     <p>The ability to create an SSL connections to an LDAP server 
  53.     is defined by the directives <directive module="mod_ldap">
  54.     LDAPTrustedCA</directive> and <directive module="mod_ldap">
  55.     LDAPTrustedCAType</directive>. These directives specify the certificate
  56.     file or database and the certificate type. Whenever the LDAP url
  57.     includes <em>ldaps://</em>, <module>mod_ldap</module> will establish
  58.     a secure connection to the LDAP server.</p>
  59.  
  60.     <example>
  61.       # Establish an SSL LDAP connection. Requires that <br />
  62.       # mod_ldap and mod_auth_ldap be loaded. Change the <br />
  63.       # "yourdomain.example.com" to match your domain.<br />
  64.       <br />
  65.       LDAPTrustedCA /certs/certfile.der<br />
  66.       LDAPTrustedCAType DER_FILE<br />
  67.       <br />
  68.       <Location /ldap-status><br />
  69.       <indent>
  70.         SetHandler ldap-status<br />
  71.         Order deny,allow<br />
  72.         Deny from all<br />
  73.         Allow from yourdomain.example.com<br />
  74.         AuthLDAPEnabled on<br />
  75.         AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
  76.         AuthLDAPAuthoritative on<br />
  77.         require valid-user<br />
  78.       </indent>
  79.       </Location>
  80.     </example>
  81.  
  82.     <p>If <module>mod_ldap</module> is linked against the
  83.     Netscape/iPlanet LDAP SDK, it will not talk to any SSL server
  84.     unless that server has a certificate signed by a known Certificate
  85.     Authority. As part of the configuration
  86.     <module>mod_ldap</module> needs to be told where it can find
  87.     a database containing the known CAs. This database is in the same
  88.     format as Netscape Communicator's <code>cert7.db</code>
  89.     database. The easiest way to get this file is to start up a fresh
  90.     copy of Netscape, and grab the resulting
  91.     <code>$HOME/.netscape/cert7.db</code> file.</p>
  92.  
  93. </section>
  94.  
  95. <directivesynopsis>
  96. <name>LDAPSharedCacheSize</name>
  97. <description>Size in bytes of the shared-memory cache</description>
  98. <syntax>LDAPSharedCacheSize <var>bytes</var></syntax>
  99. <default>LDAPSharedCacheSize 102400</default>
  100. <contextlist><context>server config</context></contextlist>
  101.  
  102. <usage>
  103.     <p>Specifies the number of bytes to specify for the shared
  104.     memory cache. The default is 100kb.</p>
  105. </usage>
  106. </directivesynopsis>
  107.  
  108. <directivesynopsis>
  109. <name>LDAPCacheEntries</name>
  110. <description>Maximum number of entires in the primary LDAP cache</description>
  111. <syntax>LDAPCacheEntries <var>number</var></syntax>
  112. <default>LDAPCacheEntries 1024</default>
  113. <contextlist><context>server config</context></contextlist>
  114.  
  115. <usage>
  116.     <p>Specifies the maximum size of the primary LDAP cache. This
  117.     cache contains successful search/binds. Set it to 0 to turn off
  118.     search/bind caching. The default size is 1024 cached
  119.     searches.</p>
  120. </usage>
  121. </directivesynopsis>
  122.  
  123. <directivesynopsis>
  124. <name>LDAPCacheTTL</name>
  125. <description>Time that cached items remain valid</description>
  126. <syntax>LDAPCacheTTL <var>seconds</var></syntax>
  127. <default>LDAPCacheTTL 600</default>
  128. <contextlist><context>server config</context></contextlist>
  129.  
  130. <usage>
  131.     <p>Specifies the time (in seconds) that an item in the
  132.     search/bind cache remains valid. The default is 600 seconds (10
  133.     minutes).</p>
  134. </usage>
  135. </directivesynopsis>
  136.  
  137. <directivesynopsis>
  138. <name>LDAPOpCacheEntries</name>
  139. <description>Number of entries used to cache LDAP compare 
  140. operations</description>
  141. <syntax>LDAPOpCacheEntries <var>number</var></syntax>
  142. <default>LDAPOpCacheEntries 1024</default>
  143. <contextlist><context>server config</context></contextlist>
  144.  
  145. <usage>
  146.     <p>This specifies the number of entries <module>mod_ldap</module>
  147.     will use to cache LDAP compare operations. The default is 1024
  148.     entries.  Setting it to 0 disables operation caching.</p>
  149. </usage>
  150. </directivesynopsis>
  151.  
  152. <directivesynopsis>
  153. <name>LDAPOpCacheTTL</name>
  154. <description>Time that entries in the operation cache remain
  155. valid</description>
  156. <syntax>LDAPOpCacheTTL <var>seconds</var></syntax>
  157. <default>LDAPOpCacheTTL 600</default>
  158. <contextlist><context>server config</context></contextlist>
  159.  
  160. <usage>
  161.     <p>Specifies the time (in seconds) that entries in the
  162.     operation cache remain valid. The default is 600 seconds.</p>
  163. </usage>
  164. </directivesynopsis>
  165.  
  166. <directivesynopsis>
  167. <name>LDAPTrustedCA</name>
  168. <description>Sets the file containing the trusted Certificate Authority certificate or database</description>
  169. <syntax>LDAPTrustedCA <var>directory-path/filename</var></syntax>
  170. <contextlist><context>server config</context></contextlist>
  171.  
  172. <usage>
  173.     <p>It specifies the directory path and file name of the trusted CA
  174.     <module>mod_ldap</module> should use when establishing an SSL
  175.     connection to an LDAP server. If using the Netscape/iPlanet Directory
  176.     SDK, the file name should be <code>cert7.db</code>.</p>
  177. </usage>
  178. </directivesynopsis>
  179.  
  180. <directivesynopsis>
  181. <name>LDAPTrustedCAType</name>
  182. <description>Specifies the type of the Certificate Authority file</description>
  183. <syntax>LDAPTrustedCAType <var>type</var></syntax>
  184. <contextlist><context>server config</context></contextlist>
  185.  
  186. <usage>
  187.     <p>The following types are supported:<br />
  188.           DER_FILE      - file in binary DER format<br />
  189.           BASE64_FILE   - file in Base64 format<br />
  190.           CERT7_DB_PATH - Netscape certificate database file ")</p>
  191. </usage>
  192. </directivesynopsis>
  193.  
  194. </modulesynopsis>
  195. <?xml version="1.0" encoding="UTF-8" ?>
  196.  
  197. <metafile>
  198.   <basename>mod_ldap</basename>
  199.   <path>/mod/</path>
  200.   <relpath>..</relpath>
  201.  
  202.   <variants>
  203.     <variant>en</variant>
  204.   </variants>
  205. </metafile>
  206. <?xml version="1.0"?>
  207. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  208. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  209. <modulesynopsis metafile="mod_logio.xml.meta">
  210.  
  211. <name>mod_logio</name>
  212. <description>Logging of input and output bytes per request</description>
  213. <status>Base</status>
  214. <sourcefile>mod_logio.c</sourcefile>
  215. <identifier>logio_module</identifier>
  216.  
  217. <summary>
  218.  
  219.     <p>This module provides the logging of input and output number of
  220.     bytes received/sent per request. The numbers reflect the actual bytes
  221.     as received on the network, which then takes into account the
  222.     headers and bodies of requests and responses. The counting is done
  223.     before SSL/TLS on input and after SSL/TLS on output, so the numbers
  224.     will correctly reflect any changes made by encryption.</p>
  225.  
  226.     <p>This module requires <module>mod_log_config</module>.</p>
  227.  
  228. </summary>
  229.  
  230. <seealso><module>mod_log_config</module></seealso>
  231. <seealso><a href="../logs.html">Apache Log Files</a></seealso>
  232.  
  233. <section id="formats">
  234. <title>Custom Log Formats</title>
  235.  
  236.     <p>This modules adds two new logging directives. The characteristics of the
  237.     request itself are logged by placing "<code>%</code>" directives in
  238.     the format string, which are replaced in the log file by the values as
  239.     follows:</p>
  240.  
  241.     <table border="1" style="zebra">
  242.     <tr><th>Format String</th>
  243.         <th>Description</th></tr>
  244.  
  245.     <tr><td><code>%...I</code></td>
  246.         <td>Bytes received, including request and headers, cannot be
  247.         zero.</td></tr>
  248.  
  249.     <tr><td><code>%...O</code></td>
  250.         <td>Bytes sent, including headers, cannot be zero.</td></tr>
  251.     </table>
  252.  
  253.     <p>Usually, the functionality is used like this:</p>
  254.  
  255.     <dl>
  256.       <dt>Combined I/O log format:</dt>
  257.       <dd><code>"%h %l %u %t \"%r\" %>s %b \"%{Referer}i\"
  258.       \"%{User-agent}i\" %I %O"</code></dd>
  259.     </dl>
  260. </section>
  261.  
  262. </modulesynopsis>
  263. <?xml version="1.0" encoding="UTF-8" ?>
  264.  
  265. <metafile>
  266.   <basename>mod_logio</basename>
  267.   <path>/mod/</path>
  268.   <relpath>..</relpath>
  269.  
  270.   <variants>
  271.     <variant>en</variant>
  272.   </variants>
  273. </metafile>
  274. <?xml version="1.0"?>
  275. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  276. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  277. <modulesynopsis metafile="mod_log_config.xml.meta">
  278.  
  279. <name>mod_log_config</name>
  280. <description>Logging of the requests made to the server</description>
  281. <status>Base</status>
  282. <sourcefile>mod_log_config.c</sourcefile>
  283. <identifier>log_config_module</identifier>
  284.  
  285. <summary>
  286.     <p>This module provides for flexible logging of client
  287.     requests. Logs are written in a customizable format, and may be
  288.     written directly to a file, or to an external program.
  289.     Conditional logging is provided so that individual requests may
  290.     be included or excluded from the logs based on characteristics
  291.     of the request.</p>
  292.  
  293.     <p>Three directives are provided by this module:
  294.     <directive module="mod_log_config">TransferLog</directive> to create
  295.     a log file, <directive module="mod_log_config">LogFormat</directive>
  296.     to set a custom format, and <directive module="mod_log_config"
  297.     >CustomLog</directive> to define a log file and format in one
  298.     step. The <directive>TransferLog</directive> and <directive
  299.     >CustomLog</directive> directives can be used multiple times in each
  300.     server to cause each request to be logged to multiple files.</p>
  301. </summary>
  302. <seealso><a href="../log