From 5f1866fd6be9b32e58c8c6d59e51ac83a06819fc Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sun, 14 Feb 2016 00:29:07 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 2 +- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 102 ++++++++++++++++++++++++++++++++++++++-------- doc/nghttpx.1.rst | 89 +++++++++++++++++++++++++++++++++------- 5 files changed, 161 insertions(+), 36 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index f9dab89e..a6db9aea 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "February 07, 2016" "1.8.0-DEV" "nghttp2" +.TH "H2LOAD" "1" "February 14, 2016" "1.8.0-DEV" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index ad205088..24beec68 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "February 07, 2016" "1.8.0-DEV" "nghttp2" +.TH "NGHTTP" "1" "February 14, 2016" "1.8.0-DEV" "nghttp2" .SH NAME nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index e93ccc8a..a3b7bc9f 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "February 07, 2016" "1.8.0-DEV" "nghttp2" +.TH "NGHTTPD" "1" "February 14, 2016" "1.8.0-DEV" "nghttp2" .SH NAME nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 90ee5a1f..a89f545f 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "February 07, 2016" "1.8.0-DEV" "nghttp2" +.TH "NGHTTPX" "1" "February 14, 2016" "1.8.0-DEV" "nghttp2" .SH NAME nghttpx \- HTTP/2 proxy . @@ -136,13 +136,13 @@ Default: \fB512\fP .UNINDENT .INDENT 0.0 .TP -.B \-\-backend\-ipv4 -Resolve backend hostname to IPv4 address only. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-backend\-ipv6 -Resolve backend hostname to IPv6 address only. +.B \-\-backend\-address\-family=(auto|IPv4|IPv6) +Specify address family of backend connections. If +"auto" is given, both IPv4 and IPv6 are considered. If +"IPv4" is given, only IPv4 address is considered. If +"IPv6" is given, only IPv6 address is considered. +.sp +Default: \fBauto\fP .UNINDENT .INDENT 0.0 .TP @@ -534,16 +534,27 @@ required. .INDENT 0.0 .TP .B \-\-tls\-ticket\-key\-memcached=, -Specify address of memcached server to store session -cache. This enables shared TLS ticket key between -multiple nghttpx instances. nghttpx does not set TLS -ticket key to memcached. The external ticket key -generator is required. nghttpx just gets TLS ticket -keys from memcached, and use them, possibly replacing -current set of keys. It is up to extern TLS ticket key -generator to rotate keys frequently. See "TLS SESSION -TICKET RESUMPTION" section in manual page to know the -data format in memcached entry. +Specify address of memcached server to get TLS ticket +keys for session resumption. This enables shared TLS +ticket key between multiple nghttpx instances. nghttpx +does not set TLS ticket key to memcached. The external +ticket key generator is required. nghttpx just gets TLS +ticket keys from memcached, and use them, possibly +replacing current set of keys. It is up to extern TLS +ticket key generator to rotate keys frequently. See +"TLS SESSION TICKET RESUMPTION" section in manual page +to know the data format in memcached entry. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-tls\-ticket\-key\-memcached\-address\-family=(auto|IPv4|IPv6) +Specify address family of memcached connections to get +TLS ticket keys. If "auto" is given, both IPv4 and IPv6 +are considered. If "IPv4" is given, only IPv4 address +is considered. If "IPv6" is given, only IPv6 address is +considered. +.sp +Default: \fBauto\fP .UNINDENT .INDENT 0.0 .TP @@ -581,6 +592,24 @@ aes\-128\-cbc is used. .UNINDENT .INDENT 0.0 .TP +.B \-\-tls\-ticket\-key\-memcached\-tls +Enable SSL/TLS on memcached connections to get TLS +ticket keys. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-tls\-ticket\-key\-memcached\-cert\-file= +Path to client certificate for memcached connections to +get TLS ticket keys. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-tls\-ticket\-key\-memcached\-private\-key\-file= +Path to client private key for memcached connections to +get TLS ticket keys. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-fetch\-ocsp\-response\-file= Path to fetch\-ocsp\-response script file. It should be absolute path. @@ -608,6 +637,35 @@ multiple nghttpx instances. .UNINDENT .INDENT 0.0 .TP +.B \-\-tls\-session\-cache\-memcached\-address\-family=(auto|IPv4|IPv6) +Specify address family of memcached connections to store +session cache. If "auto" is given, both IPv4 and IPv6 +are considered. If "IPv4" is given, only IPv4 address +is considered. If "IPv6" is given, only IPv6 address is +considered. +.sp +Default: \fBauto\fP +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-tls\-session\-cache\-memcached\-tls +Enable SSL/TLS on memcached connections to store session +cache. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-tls\-session\-cache\-memcached\-cert\-file= +Path to client certificate for memcached connections to +store session cache. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-tls\-session\-cache\-memcached\-private\-key\-file= +Path to client private key for memcached connections to +store session cache. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-tls\-dyn\-rec\-warmup\-threshold= Specify the threshold size for TLS dynamic record size behaviour. During a TLS session, after the threshold @@ -1251,6 +1309,10 @@ insert serialized session data to memcached with \fBnghttpx:tls\-session\-cache:\fP + lowercased hex string of session ID as a memcached entry key, with expiry time 12 hours. Session timeout is set to 12 hours. +.sp +By default, connections to memcached server are not encrypted. To +enable encryption, use \fI\%\-\-tls\-session\-cache\-memcached\-tls\fP +option. .SS TLS SESSION TICKET RESUMPTION .sp By default, session ticket is shared by all worker threads. The @@ -1295,6 +1357,10 @@ used, LEN must be 48. If keys. The key appeared first is used as encryption key. All the remaining keys are used as decryption only. .sp +By default, connections to memcached server are not encrypted. To +enable encryption, use \fI\%\-\-tls\-ticket\-key\-memcached\-tls\fP +option. +.sp If \fI\%\-\-tls\-ticket\-key\-file\fP is given, encryption key is read from the given file. In this case, nghttpx does not rotate key automatically. To rotate key, one has to restart nghttpx (see diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index ffafa2bf..42aa4642 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -116,13 +116,14 @@ Connections Default: ``512`` -.. option:: --backend-ipv4 +.. option:: --backend-address-family=(auto|IPv4|IPv6) - Resolve backend hostname to IPv4 address only. + Specify address family of backend connections. If + "auto" is given, both IPv4 and IPv6 are considered. If + "IPv4" is given, only IPv4 address is considered. If + "IPv6" is given, only IPv6 address is considered. -.. option:: --backend-ipv6 - - Resolve backend hostname to IPv6 address only. + Default: ``auto`` .. option:: --backend-http-proxy-uri= @@ -477,16 +478,26 @@ SSL/TLS .. option:: --tls-ticket-key-memcached=, - Specify address of memcached server to store session - cache. This enables shared TLS ticket key between - multiple nghttpx instances. nghttpx does not set TLS - ticket key to memcached. The external ticket key - generator is required. nghttpx just gets TLS ticket - keys from memcached, and use them, possibly replacing - current set of keys. It is up to extern TLS ticket key - generator to rotate keys frequently. See "TLS SESSION - TICKET RESUMPTION" section in manual page to know the - data format in memcached entry. + Specify address of memcached server to get TLS ticket + keys for session resumption. This enables shared TLS + ticket key between multiple nghttpx instances. nghttpx + does not set TLS ticket key to memcached. The external + ticket key generator is required. nghttpx just gets TLS + ticket keys from memcached, and use them, possibly + replacing current set of keys. It is up to extern TLS + ticket key generator to rotate keys frequently. See + "TLS SESSION TICKET RESUMPTION" section in manual page + to know the data format in memcached entry. + +.. option:: --tls-ticket-key-memcached-address-family=(auto|IPv4|IPv6) + + Specify address family of memcached connections to get + TLS ticket keys. If "auto" is given, both IPv4 and IPv6 + are considered. If "IPv4" is given, only IPv4 address + is considered. If "IPv6" is given, only IPv6 address is + considered. + + Default: ``auto`` .. option:: --tls-ticket-key-memcached-interval= @@ -518,6 +529,21 @@ SSL/TLS either aes-128-cbc or aes-256-cbc. By default, aes-128-cbc is used. +.. option:: --tls-ticket-key-memcached-tls + + Enable SSL/TLS on memcached connections to get TLS + ticket keys. + +.. option:: --tls-ticket-key-memcached-cert-file= + + Path to client certificate for memcached connections to + get TLS ticket keys. + +.. option:: --tls-ticket-key-memcached-private-key-file= + + Path to client private key for memcached connections to + get TLS ticket keys. + .. option:: --fetch-ocsp-response-file= Path to fetch-ocsp-response script file. It should be @@ -541,6 +567,31 @@ SSL/TLS cache. This enables shared session cache between multiple nghttpx instances. +.. option:: --tls-session-cache-memcached-address-family=(auto|IPv4|IPv6) + + Specify address family of memcached connections to store + session cache. If "auto" is given, both IPv4 and IPv6 + are considered. If "IPv4" is given, only IPv4 address + is considered. If "IPv6" is given, only IPv6 address is + considered. + + Default: ``auto`` + +.. option:: --tls-session-cache-memcached-tls + + Enable SSL/TLS on memcached connections to store session + cache. + +.. option:: --tls-session-cache-memcached-cert-file= + + Path to client certificate for memcached connections to + store session cache. + +.. option:: --tls-session-cache-memcached-private-key-file= + + Path to client private key for memcached connections to + store session cache. + .. option:: --tls-dyn-rec-warmup-threshold= Specify the threshold size for TLS dynamic record size @@ -1134,6 +1185,10 @@ insert serialized session data to memcached with as a memcached entry key, with expiry time 12 hours. Session timeout is set to 12 hours. +By default, connections to memcached server are not encrypted. To +enable encryption, use :option:`--tls-session-cache-memcached-tls` +option. + TLS SESSION TICKET RESUMPTION ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1173,6 +1228,10 @@ used, LEN must be 48. If keys. The key appeared first is used as encryption key. All the remaining keys are used as decryption only. +By default, connections to memcached server are not encrypted. To +enable encryption, use :option:`--tls-ticket-key-memcached-tls` +option. + If :option:`--tls-ticket-key-file` is given, encryption key is read from the given file. In this case, nghttpx does not rotate key automatically. To rotate key, one has to restart nghttpx (see