granicus.if.org Git - apache/blob - docs/manual/mod/mod_ident.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_ident.xml.meta">
  24
  25 <name>mod_ident</name>
  26 <description>RFC 1413 ident lookups</description>
  27 <status>Extension</status>
  28 <sourcefile>mod_ident.c</sourcefile>
  29 <identifier>ident_module</identifier>
  30
  31 <summary>
  32     <p>This module queries an <a href="http://www.ietf.org/rfc/rfc1413.txt"
  33     >RFC 1413</a> compatible daemon on a remote host to look up the owner of
  34     a connection.</p>
  35 </summary>
  36 <seealso><module>mod_log_config</module></seealso>
  37
  38 <directivesynopsis>
  39 <name>IdentityCheck</name>
  40 <description>Enables logging of the RFC 1413 identity of the remote
  41 user</description>
  42 <syntax>IdentityCheck On|Off</syntax>
  43 <default>IdentityCheck Off</default>
  44 <contextlist><context>server config</context><context>virtual host</context>
  45 <context>directory</context></contextlist>
  46
  47 <usage>
  48     <p>This directive enables <a href="http://www.ietf.org/rfc/rfc1413.txt"
  49     >RFC 1413</a>-compliant logging of the remote user name for each
  50     connection, where the client machine runs identd or something similar.
  51     This information is logged in the access log using the <code>%...l</code>
  52     <a href="mod_log_config.html#formats">format string</a>.</p>
  53
  54     <note>
  55       The information should not be trusted in any way except for
  56       rudimentary usage tracking.
  57     </note>
  58
  59     <p>Note that this can cause serious latency problems accessing
  60     your server since every request requires one of these lookups
  61     to be performed. When firewalls or proxy servers are involved,
  62     each lookup might possibly fail and add a latency duration as
  63     defined by the <directive module="mod_ident"
  64     >IdentityCheckTimeout</directive> directive to each hit. So in
  65     general this is not very useful on public servers accessible from
  66     the Internet.</p>
  67 </usage>
  68 </directivesynopsis>
  69
  70 <directivesynopsis>
  71 <name>IdentityCheckTimeout</name>
  72 <description>Determines the timeout duration for ident requests</description>
  73 <syntax>IdentityCheckTimeout <var>seconds</var></syntax>
  74 <default>IdentityCheckTimeout 30</default>
  75 <contextlist><context>server config</context><context>virtual host</context>
  76 <context>directory</context></contextlist>
  77 <usage>
  78     <p>This directive specifies the timeout duration of an ident
  79     request. The default value of 30 seconds is recommended by <a
  80     href="http://www.ietf.org/rfc/rfc1413.txt">RFC 1413</a>, mainly because
  81     of possible network latency. However, you may want to adjust the
  82     timeout value according to your local network speed.</p>
  83 </usage>
  84 </directivesynopsis>
  85
  86 </modulesynopsis>
  87