granicus.if.org Git - apache/blob - docs/manual/mod/mod_reqtimeout.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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_reqtimeout - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <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>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_reqtimeout.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
  33 </td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>reqtimeout_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_reqtimeout.c</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <p>This module provides a convenient way to set timeouts and minimum data
  40     rates for receiving requests. Should a timeout occur or a data rate be
  41     to low, the corresponding connection will be closed by the server.</p>
  42
  43     <p>This is logged at <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code>
  44     <code>info</code>.</p>
  45
  46     <p>If needed, the <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> directive
  47     can be tweaked to explicitly log it:</p>
  48     <pre class="prettyprint lang-config">LogLevel reqtimeout:info</pre>
  49
  50 </div>
  51 <div id="quickview"><h3>Topics</h3>
  52 <ul id="topics">
  53 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  54 </ul><h3 class="directives">Directives</h3>
  55 <ul id="toc">
  56 <li><img alt="" src="../images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
  57 </ul>
  58 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_reqtimeout">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_reqtimeout">Report a bug</a></li></ul><h3>See also</h3>
  59 <ul class="seealso">
  60 <li><a href="#comments_section">Comments</a></li></ul></div>
  61 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  62 <div class="section">
  63 <h2><a name="examples" id="examples">Examples</a> <a title="Permanent link" href="#examples" class="permalink">&para;</a></h2>
  64
  65     <ol>
  66       <li>
  67         Allow for 5 seconds to complete the TLS handshake, 10 seconds to
  68         receive the request headers and 30 seconds for receiving the
  69         request body:
  70
  71         <pre class="prettyprint lang-config">RequestReadTimeout handshake=5 header=10 body=30</pre>
  72
  73       </li>
  74
  75       <li>
  76         Allow at least 10 seconds to receive the request body.
  77         If the client sends data, increase the timeout by 1 second for every
  78         1000 bytes received, with no upper limit for the timeout (except for
  79         the limit given indirectly by
  80         <code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
  81
  82         <pre class="prettyprint lang-config">RequestReadTimeout body=10,MinRate=1000</pre>
  83
  84       </li>
  85
  86       <li>
  87         Allow at least 10 seconds to receive the request headers.
  88         If the client sends data, increase the timeout by 1 second for every
  89         500 bytes received. But do not allow more than 30 seconds for the
  90         request headers:
  91
  92         <pre class="prettyprint lang-config">RequestReadTimeout header=10-30,MinRate=500</pre>
  93
  94       </li>
  95
  96       <li>
  97         Usually, a server should have both header and body timeouts configured.
  98         If a common configuration is used for http and https virtual hosts, the
  99         timeouts should not be set too low:
 100
 101         <pre class="prettyprint lang-config">RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500</pre>
 102
 103       </li>
 104
 105     </ol>
 106 </div>
 107 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 108 <div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a> <a title="Permanent link" href="#requestreadtimeout" class="permalink">&para;</a></h2>
 109 <table class="directive">
 110 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for completing the TLS handshake, receiving
 111 the request headers and/or body from client.
 112 </td></tr>
 113 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
 114 [handshake=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
 115 [header=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
 116 [body=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
 117 </code></td></tr>
 118 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RequestReadTimeout handshake=0 header=20-40,MinRate=500 body=20,MinRate=500</code></td></tr>
 119 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 120 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 121 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
 122 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Defaulted to disabled in version 2.3.14 and earlier. The
 123 <code>handshake</code> stage is available since version 2.4.39.
 124 </td></tr>
 125 </table>
 126     <p>This directive can set various timeouts for completing the TLS handshake,
 127     receiving the request headers and/or the request body from the client.
 128     If the client fails to complete each of these stages within the configured
 129     time, a <code>408 REQUEST TIME OUT</code> error is sent.</p>
 130
 131     <p>For SSL virtual hosts, the <code>handshake</code> timeout values is the time
 132     needed to do the initial SSL handshake.  If the user's browser is configured to
 133     query certificate revocation lists and the CRL server is not reachable, the
 134     initial SSL handshake may take a significant time until the browser gives up
 135     waiting for the CRL.  Therefore the <code>handshake</code> timeout should take
 136     this possible overhead into consideration for SSL virtual hosts (if necessary).
 137     The body timeout values include the time needed for SSL renegotiation
 138     (if necessary).</p>
 139
 140     <p>When an <code class="directive"><a href="../mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
 141     (usually the case on Linux and FreeBSD), the socket is not sent to the
 142     server process before at least one byte (or the whole request for
 143     <code>httpready</code>) is received. The handshake and header timeouts
 144     configured with <code class="directive">RequestReadTimeout</code> are only effective
 145     after the server process has received the socket.</p>
 146
 147     <p>For each of the three timeout stages (handshake, header or body), there are
 148     three ways to specify the timeout:
 149     </p>
 150
 151     <ul>
 152
 153     <li><strong>Fixed timeout value</strong>:<br />
 154
 155     <div class="example"><p><code><var>stage</var>=<var>timeout</var></code></p></div>
 156
 157     <p>The time in seconds allowed for completing the whole stage (handshaking,
 158     reading all of the request headers or body). A value of 0 means no limit.</p>
 159     </li>
 160
 161     <li><strong>Disable module for a vhost</strong>:<br />
 162
 163     <div class="example"><p><code>handshake=0 header=0 body=0</code></p></div>
 164
 165     <p>This disables <code class="module"><a href="../mod/mod_reqtimeout.html">mod_reqtimeout</a></code> completely (note that
 166     <code>handshake=0</code> is the default already and could be omitted).</p>
 167     </li>
 168
 169     <li><strong>Timeout value that is increased when data is
 170     received</strong>:<br />
 171     <div class="example"><p><code>
 172     <var>stage</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
 173     </code></p></div>
 174
 175     <p>Same as above, but whenever data is received, the timeout value is
 176     increased according to the specified minimum data rate (in bytes per
 177     second).</p>
 178     </li>
 179
 180     <li><strong>Timeout value that is increased when data is received, with an
 181     upper bound</strong>:<br />
 182     <div class="example"><p><code>
 183     <var>stage</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
 184     </code></p></div>
 185
 186     <p>Same as above, but the timeout will not be increased above the second
 187     value of the specified timeout range.</p>
 188     </li>
 189
 190     </ul>
 191
 192
 193 </div>
 194 </div>
 195 <div class="bottomlang">
 196 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a> |
 197 <a href="../fr/mod/mod_reqtimeout.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 198 </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>
 199 <script type="text/javascript"><!--//--><![CDATA[//><!--
 200 var comments_shortname = 'httpd';
 201 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_reqtimeout.html';
 202 (function(w, d) {
 203     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 204         d.write('<div id="comments_thread"><\/div>');
 205         var s = d.createElement('script');
 206         s.type = 'text/javascript';
 207         s.async = true;
 208         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 209         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 210     }
 211     else {
 212         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 213     }
 214 })(window, document);
 215 //--><!]]></script></div><div id="footer">
 216 <p class="apache">Copyright 2019 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>
 217 <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[//><!--
 218 if (typeof(prettyPrint) !== 'undefined') {
 219     prettyPrint();
 220 }
 221 //--><!]]></script>
 222 </body></html>