walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update manual pages

This commit is contained in:
Tatsuhiro Tsujikawa 2021-09-23 11:45:10 +09:00
parent 308c73bfa2
commit 282050c596
5 changed files with 75 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/h2load.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "Sep 20, 2021" "1.45.0" "nghttp2" .TH "H2LOAD" "1" "Sep 23, 2021" "1.46.0-DEV" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .

2
doc/nghttp.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "Sep 20, 2021" "1.45.0" "nghttp2" .TH "NGHTTP" "1" "Sep 23, 2021" "1.46.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 client nghttp \- HTTP/2 client
. .

2
doc/nghttpd.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "Sep 20, 2021" "1.45.0" "nghttp2" .TH "NGHTTPD" "1" "Sep 23, 2021" "1.46.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

46
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "Sep 20, 2021" "1.45.0" "nghttp2" .TH "NGHTTPX" "1" "Sep 23, 2021" "1.46.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -1776,14 +1776,42 @@ Default: \fBcubic\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-frontend\-quic\-connection\-id\-encryption\-key=<HEXSTRING> .B \-\-frontend\-quic\-secret\-file=<PATH>
Specify Connection ID encryption key. The encryption Path to file that contains secure random data to be used
key must be 16 bytes, and it must be encoded in hex as QUIC keying materials. It is used to derive keys for
string (which is 32 bytes long). If this option is encrypting tokens and Connection IDs. It is not used to
omitted, new key is generated. In order to survive QUIC encrypt QUIC packets. Each line of this file must
connection in a configuration reload event, old and new contain exactly 136 bytes hex\-encoded string (when
configuration must have this option and share the same decoded the byte string is 68 bytes long). The first 2
key. bits of decoded byte string are used to identify the
keying material. An empty line or a line which starts
\(aq#\(aq is ignored. The file can contain more than one
keying materials. Because the identifier is 2 bits, at
most 4 keying materials are read and the remaining data
is discarded. The first keying material in the file is
primarily used for encryption and decryption for new
connection. The other ones are used to decrypt data for
the existing connections. Specifying multiple keying
materials enables key rotation. Please note that key
rotation does not occur automatically. User should
update files or change options values and restart
nghttpx gracefully. If opening or reading given file
fails, all loaded keying materials are discarded and it
is treated as if none of this option is given. If this
option is not given or an error occurred while opening
or reading a file, a keying material is generated
internally on startup and reload.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-quic\-server\-id=<HEXSTRING>
Specify server ID encoded in Connection ID to identify
this particular server instance. Connection ID is
encrypted and this part is not visible in public. It
must be 2 bytes long and must be encoded in hex string
(which is 4 bytes long). If this option is omitted, a
random server ID is generated on startup and
configuration reload.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP

43
doc/nghttpx.1.rst
View File

@ -1620,15 +1620,42 @@ HTTP/3 and QUIC
Default: ``cubic`` Default: ``cubic``
.. option:: --frontend-quic-connection-id-encryption-key=<HEXSTRING> .. option:: --frontend-quic-secret-file=<PATH>
Specify Connection ID encryption key. The encryption Path to file that contains secure random data to be used
key must be 16 bytes, and it must be encoded in hex as QUIC keying materials. It is used to derive keys for
string (which is 32 bytes long). If this option is encrypting tokens and Connection IDs. It is not used to
omitted, new key is generated. In order to survive QUIC encrypt QUIC packets. Each line of this file must
connection in a configuration reload event, old and new contain exactly 136 bytes hex-encoded string (when
configuration must have this option and share the same decoded the byte string is 68 bytes long). The first 2
key. bits of decoded byte string are used to identify the
keying material. An empty line or a line which starts
'#' is ignored. The file can contain more than one
keying materials. Because the identifier is 2 bits, at
most 4 keying materials are read and the remaining data
is discarded. The first keying material in the file is
primarily used for encryption and decryption for new
connection. The other ones are used to decrypt data for
the existing connections. Specifying multiple keying
materials enables key rotation. Please note that key
rotation does not occur automatically. User should
update files or change options values and restart
nghttpx gracefully. If opening or reading given file
fails, all loaded keying materials are discarded and it
is treated as if none of this option is given. If this
option is not given or an error occurred while opening
or reading a file, a keying material is generated
internally on startup and reload.
.. option:: --frontend-quic-server-id=<HEXSTRING>
Specify server ID encoded in Connection ID to identify
this particular server instance. Connection ID is
encrypted and this part is not visible in public. It
must be 2 bytes long and must be encoded in hex string
(which is 4 bytes long). If this option is omitted, a
random server ID is generated on startup and
configuration reload.
.. option:: --no-quic-bpf .. option:: --no-quic-bpf