diff options
| author | Matteo Collina <hello@matteocollina.com> | 2020-05-14 21:21:34 +0300 |
|---|---|---|
| committer | Richard Lau <riclau@uk.ibm.com> | 2020-09-15 22:39:54 +0300 |
| commit | df08d527c2083b852d8456b88b39114f30525236 (patch) | |
| tree | 3957f9865debe958271ab09a941303dc90225f70 /doc/api/https.md | |
| parent | cb90248c145763502ee8fae67960d45293c9e0bf (diff) | |
http: add requestTimeout
This commits introduces a new http.Server option called requestTimeout
with a default value in milliseconds of 0.
If requestTimeout is set to a positive value, the server will start a new
timer set to expire in requestTimeout milliseconds when a new connection
is established. The timer is also set again if new requests after the
first are received on the socket (this handles pipelining and keep-alive
cases).
The timer is cancelled when:
1. the request body is completely received by the server.
2. the response is completed. This handles the case where the
application responds to the client without consuming the request body.
3. the connection is upgraded, like in the WebSocket case.
If the timer expires, then the server responds with status code 408 and
closes the connection.
CVE-2020-8251
PR-URL: https://github.com/nodejs-private/node-private/pull/208
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Co-Authored-By: Paolo Insogna <paolo@cowtech.it>
Co-Authored-By: Robert Nagy <ronagy@icloud.com>
Diffstat (limited to 'doc/api/https.md')
| -rw-r--r-- | doc/api/https.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/api/https.md b/doc/api/https.md index f94bf7f4e9e..8dbe4d2f224 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -113,6 +113,15 @@ This method is identical to [`server.listen()`][] from [`net.Server`][]. See [`http.Server#maxHeadersCount`][]. +### `server.requestTimeout` +<!-- YAML +added: REPLACEME +--> + +* {number} **Default:** `0` + +See [`http.Server#requestTimeout`][]. + ### `server.setTimeout([msecs][, callback])` <!-- YAML added: v0.11.2 @@ -451,6 +460,7 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p [`http.Server#headersTimeout`]: http.html#http_server_headerstimeout [`http.Server#keepAliveTimeout`]: http.html#http_server_keepalivetimeout [`http.Server#maxHeadersCount`]: http.html#http_server_maxheaderscount +[`http.Server#requestTimeout`]: http.html#http_server_requesttimeout [`http.Server#setTimeout()`]: http.html#http_server_settimeout_msecs_callback [`http.Server#timeout`]: http.html#http_server_timeout [`http.Server`]: http.html#http_class_http_server |