granicus.if.org Git - apache/blob - docs/manual/mod/mod_log_forensic.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_log_forensic - Apache HTTP Server Version 2.5</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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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.5</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_log_forensic</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_log_forensic.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../ja/mod/mod_log_forensic.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  29 <a href="../tr/mod/mod_log_forensic.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Forensic Logging of the requests made to the server</td></tr>
  32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>log_forensic_module</td></tr>
  34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_log_forensic.c</td></tr></table>
  35 <h3>Summary</h3>
  36
  37     <p>This module provides for forensic logging of client
  38     requests. Logging is done before and after processing a request, so the
  39     forensic log contains two log lines for each request.
  40     The forensic logger is very strict, which means:</p>
  41
  42     <ul>
  43     <li>The format is fixed. You cannot modify the logging format at
  44     runtime.</li>
  45     <li>If it cannot write its data, the child process
  46     exits immediately and may dump core (depending on your
  47     <code class="directive"><a href="../mod/mpm_common.html#coredumpdirectory">CoreDumpDirectory</a></code>
  48     configuration).</li>
  49     </ul>
  50
  51     <p>The <code>check_forensic</code> script, which can be found in the
  52     distribution's support directory, may be helpful in evaluating the
  53     forensic log output.</p>
  54 </div>
  55 <div id="quickview"><h3>Topics</h3>
  56 <ul id="topics">
  57 <li><img alt="" src="../images/down.gif" /> <a href="#formats">Forensic Log Format</a></li>
  58 <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Considerations</a></li>
  59 </ul><h3 class="directives">Directives</h3>
  60 <ul id="toc">
  61 <li><img alt="" src="../images/down.gif" /> <a href="#forensiclog">ForensicLog</a></li>
  62 </ul>
  63 <h3>See also</h3>
  64 <ul class="seealso">
  65 <li><a href="../logs.html">Apache Log Files</a></li>
  66 <li><code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code></li>
  67 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  68 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  69 <div class="directive-section"><h2><a name="ForensicLog" id="ForensicLog">ForensicLog</a> <a name="forensiclog" id="forensiclog">Directive</a></h2>
  70 <table class="directive">
  71 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets filename of the forensic log</td></tr>
  72 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ForensicLog <var>filename</var>|<var>pipe</var></code></td></tr>
  73 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  74 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  75 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_log_forensic</td></tr>
  76 </table>
  77     <p>The <code class="directive">ForensicLog</code> directive is used to
  78     log requests to the server for forensic analysis. Each log entry
  79     is assigned a unique ID which can be associated with the request
  80     using the normal <code class="directive"><a href="../mod/mod_log_config.html#customlog">CustomLog</a></code>
  81     directive. <code class="module"><a href="../mod/mod_log_forensic.html">mod_log_forensic</a></code> creates a token called
  82     <code>forensic-id</code>, which can be added to the transfer log
  83     using the <code>%{forensic-id}n</code> format string.</p>
  84
  85     <p>The argument, which specifies the location to which
  86     the logs will be written, can take one of the following two
  87     types of values:</p>
  88
  89     <dl>
  90       <dt><var>filename</var></dt>
  91       <dd>A filename, relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</dd>
  92
  93       <dt><var>pipe</var></dt>
  94       <dd>The pipe character "<code>|</code>", followed by the path
  95       to a program to receive the log information on its standard
  96       input. The program name can be specified relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code> directive.
  97
  98       <div class="warning"><h3>Security:</h3>
  99       <p>If a program is used, then it will be run as the user who
 100       started <code class="program"><a href="../programs/httpd.html">httpd</a></code>. This will be root if the server was
 101       started by root; be sure that the program is secure or switches to a
 102       less privileged user.</p>
 103       </div>
 104
 105       <div class="note"><h3>Note</h3>
 106         <p>When entering a file path on non-Unix platforms, care should be taken
 107         to make sure that only forward slashes are used even though the platform
 108         may allow the use of back slashes. In general it is a good idea to always
 109         use forward slashes throughout the configuration files.</p>
 110       </div></dd>
 111     </dl>
 112
 113 </div>
 114 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 115 <div class="section">
 116 <h2><a name="formats" id="formats">Forensic Log Format</a></h2>
 117     <p>Each request is logged two times. The first time is <em>before</em> it's
 118     processed further (that is, after receiving the headers). The second log
 119     entry is written <em>after</em> the request processing at the same time
 120     where normal logging occurs.</p>
 121
 122     <p>In order to identify each request, a unique request ID is assigned.
 123     This forensic ID can be cross logged in the normal transfer log using the
 124     <code>%{forensic-id}n</code> format string. If you're using
 125     <code class="module"><a href="../mod/mod_unique_id.html">mod_unique_id</a></code>, its generated ID will be used.</p>
 126
 127     <p>The first line logs the forensic ID, the request line and all received
 128     headers, separated by pipe characters (<code>|</code>). A sample line
 129     looks like the following (all on one line):</p>
 130
 131     <div class="example"><p><code>
 132         +yQtJf8CoAB4AAFNXBIEAAAAA|GET /manual/de/images/down.gif
 133         HTTP/1.1|Host:localhost%3a8080|User-Agent:Mozilla/5.0 (X11;
 134         U; Linux i686; en-US; rv%3a1.6) Gecko/20040216
 135         Firefox/0.8|Accept:image/png, <var>etc...</var>
 136     </code></p></div>
 137
 138     <p>The plus character at the beginning indicates that this is the first log
 139     line of this request. The second line just contains a minus character and
 140     the ID again:</p>
 141
 142     <div class="example"><p><code>
 143       -yQtJf8CoAB4AAFNXBIEAAAAA
 144     </code></p></div>
 145
 146     <p>The <code>check_forensic</code> script takes as its argument the name
 147     of the logfile. It looks for those <code>+</code>/<code>-</code> ID pairs
 148     and complains if a request was not completed.</p>
 149 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 150 <div class="section">
 151 <h2><a name="security" id="security">Security Considerations</a></h2>
 152     <p>See the <a href="../misc/security_tips.html#serverroot">security tips</a>
 153     document for details on why your security could be compromised
 154     if the directory where logfiles are stored is writable by
 155     anyone other than the user that starts the server.</p>
 156     <p>The log files may contain sensitive data such as the contents of
 157     <code>Authorization:</code> headers (which can contain passwords), so
 158     they should not be readable by anyone except the user that starts the
 159     server.</p>
 160 </div>
 161 </div>
 162 <div class="bottomlang">
 163 <p><span>Available Languages: </span><a href="../en/mod/mod_log_forensic.html" title="English">&nbsp;en&nbsp;</a> |
 164 <a href="../ja/mod/mod_log_forensic.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 165 <a href="../tr/mod/mod_log_forensic.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 166 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 167 <script type="text/javascript"><!--//--><![CDATA[//><!--
 168 var comments_shortname = 'httpd';
 169 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_log_forensic.html';
 170 (function(w, d) {
 171     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 172         d.write('<div id="comments_thread"><\/div>');
 173         var s = d.createElement('script');
 174         s.type = 'text/javascript';
 175         s.async = true;
 176         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 177         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 178     }
 179     else {
 180         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 181     }
 182 })(window, document);
 183 //--><!]]></script></div><div id="footer">
 184 <p class="apache">Copyright 2015 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>
 185 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 186 if (typeof(prettyPrint) !== 'undefined') {
 187     prettyPrint();
 188 }
 189 //--><!]]></script>
 190 </body></html>