doc: describe tls.DEFAULT_MIN_VERSION/_MAX_VERSION
PR-URL: https://github.com/nodejs/node/pull/26821 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
parent
97737fd5fb
commit
d989e20717
@ -448,38 +448,40 @@ with crypto support (default).
|
|||||||
added: REPLACEME
|
added: REPLACEME
|
||||||
-->
|
-->
|
||||||
|
|
||||||
Set default [`maxVersion`][] to `'TLSv1.2'`. Use to disable support for TLSv1.3.
|
Set [`tls.DEFAULT_MAX_VERSION`][] to 'TLSv1.2'. Use to disable support for
|
||||||
|
TLSv1.3.
|
||||||
|
|
||||||
### `--tls-max-v1.3`
|
### `--tls-max-v1.3`
|
||||||
<!-- YAML
|
<!-- YAML
|
||||||
added: REPLACEME
|
added: REPLACEME
|
||||||
-->
|
-->
|
||||||
|
|
||||||
Set default [`maxVersion`][] to `'TLSv1.3'`. Use to enable support for TLSv1.3.
|
Set default [`tls.DEFAULT_MAX_VERSION`][] to 'TLSv1.3'. Use to enable support
|
||||||
|
for TLSv1.3.
|
||||||
|
|
||||||
### `--tls-min-v1.0`
|
### `--tls-min-v1.0`
|
||||||
<!-- YAML
|
<!-- YAML
|
||||||
added: REPLACEME
|
added: REPLACEME
|
||||||
-->
|
-->
|
||||||
|
|
||||||
Set default [`minVersion`][] to `'TLSv1'`. Use for compatibility with old TLS
|
Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1'. Use for compatibility with
|
||||||
clients or servers.
|
old TLS clients or servers.
|
||||||
|
|
||||||
### `--tls-min-v1.1`
|
### `--tls-min-v1.1`
|
||||||
<!-- YAML
|
<!-- YAML
|
||||||
added: REPLACEME
|
added: REPLACEME
|
||||||
-->
|
-->
|
||||||
|
|
||||||
Set default [`minVersion`][] to `'TLSv1.1'`. Use for compatibility with old TLS
|
Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1.1'. Use for compatibility
|
||||||
clients or servers.
|
with old TLS clients or servers.
|
||||||
|
|
||||||
### `--tls-min-v1.3`
|
### `--tls-min-v1.3`
|
||||||
<!-- YAML
|
<!-- YAML
|
||||||
added: REPLACEME
|
added: REPLACEME
|
||||||
-->
|
-->
|
||||||
|
|
||||||
Set default [`minVersion`][] to `'TLSv1.3'`. Use to disable support for TLSv1.2
|
Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1.3'. Use to disable support
|
||||||
in favour of TLSv1.3, which is more secure.
|
for TLSv1.2, which is not as secure as TLSv1.3.
|
||||||
|
|
||||||
### `--trace-deprecation`
|
### `--trace-deprecation`
|
||||||
<!-- YAML
|
<!-- YAML
|
||||||
@ -918,9 +920,9 @@ greater than `4` (its current default value). For more information, see the
|
|||||||
[`--openssl-config`]: #cli_openssl_config_file
|
[`--openssl-config`]: #cli_openssl_config_file
|
||||||
[`Buffer`]: buffer.html#buffer_class_buffer
|
[`Buffer`]: buffer.html#buffer_class_buffer
|
||||||
[`SlowBuffer`]: buffer.html#buffer_class_slowbuffer
|
[`SlowBuffer`]: buffer.html#buffer_class_slowbuffer
|
||||||
[`maxVersion`]: tls.html#tls_tls_createsecurecontext_options
|
|
||||||
[`minVersion`]: tls.html#tls_tls_createsecurecontext_options
|
|
||||||
[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn
|
[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn
|
||||||
|
[`tls.DEFAULT_MAX_VERSION`]: tls.html#tls_tls_default_max_version
|
||||||
|
[`tls.DEFAULT_MIN_VERSION`]: tls.html#tls_tls_default_min_version
|
||||||
[Chrome DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/
|
[Chrome DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/
|
||||||
[REPL]: repl.html
|
[REPL]: repl.html
|
||||||
[ScriptCoverage]: https://chromedevtools.github.io/devtools-protocol/tot/Profiler#type-ScriptCoverage
|
[ScriptCoverage]: https://chromedevtools.github.io/devtools-protocol/tot/Profiler#type-ScriptCoverage
|
||||||
|
@ -1358,20 +1358,13 @@ changes:
|
|||||||
* `maxVersion` {string} Optionally set the maximum TLS version to allow. One
|
* `maxVersion` {string} Optionally set the maximum TLS version to allow. One
|
||||||
of `TLSv1.3`, `TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified
|
of `TLSv1.3`, `TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified
|
||||||
along with the `secureProtocol` option, use one or the other.
|
along with the `secureProtocol` option, use one or the other.
|
||||||
**Default:** `'TLSv1.3'`, unless changed using CLI options. Using
|
**Default:** [`tls.DEFAULT_MAX_VERSION`][].
|
||||||
`--tls-max-v1.2` sets the default to `'TLSv1.2`'. Using `--tls-max-v1.3`
|
|
||||||
sets the default to `'TLSv1.3'`. If multiple of the options are provided,
|
|
||||||
the highest maximum is used.
|
|
||||||
* `minVersion` {string} Optionally set the minimum TLS version to allow. One
|
* `minVersion` {string} Optionally set the minimum TLS version to allow. One
|
||||||
of `TLSv1.3`, `TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified
|
of `TLSv1.3`, `TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified
|
||||||
along with the `secureProtocol` option, use one or the other. It is not
|
along with the `secureProtocol` option, use one or the other. It is not
|
||||||
recommended to use less than TLSv1.2, but it may be required for
|
recommended to use less than TLSv1.2, but it may be required for
|
||||||
interoperability.
|
interoperability.
|
||||||
**Default:** `'TLSv1.2'`, unless changed using CLI options. Using
|
**Default:** [`tls.DEFAULT_MIN_VERSION`][].
|
||||||
`--tls-min-v1.0` sets the default to `'TLSv1'`. Using `--tls-min-v1.1` sets
|
|
||||||
the default to `'TLSv1.1'`. Using `--tls-min-v1.3` sets the default to
|
|
||||||
`'TLSv1.3'`. If multiple of the options are provided, the lowest minimum is
|
|
||||||
used.
|
|
||||||
* `passphrase` {string} Shared passphrase used for a single private key and/or
|
* `passphrase` {string} Shared passphrase used for a single private key and/or
|
||||||
a PFX.
|
a PFX.
|
||||||
* `pfx` {string|string[]|Buffer|Buffer[]|Object[]} PFX or PKCS12 encoded
|
* `pfx` {string|string[]|Buffer|Buffer[]|Object[]} PFX or PKCS12 encoded
|
||||||
@ -1537,6 +1530,35 @@ The default curve name to use for ECDH key agreement in a tls server. The
|
|||||||
default value is `'auto'`. See [`tls.createSecureContext()`] for further
|
default value is `'auto'`. See [`tls.createSecureContext()`] for further
|
||||||
information.
|
information.
|
||||||
|
|
||||||
|
## tls.DEFAULT_MAX_VERSION
|
||||||
|
<!-- YAML
|
||||||
|
added: v11.4.0
|
||||||
|
-->
|
||||||
|
|
||||||
|
* {string} The default value of the `maxVersion` option of
|
||||||
|
[`tls.createSecureContext()`][]. It can be assigned any of the supported TLS
|
||||||
|
protocol versions, `TLSv1.3`, `TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`.
|
||||||
|
**Default:** `'TLSv1.3'`, unless changed using CLI options. Using
|
||||||
|
`--tls-max-v1.2` sets the default to `'TLSv1.2`'. Using `--tls-max-v1.3` sets
|
||||||
|
the default to `'TLSv1.3'`. If multiple of the options are provided, the
|
||||||
|
highest maximum is used.
|
||||||
|
|
||||||
|
|
||||||
|
## tls.DEFAULT_MIN_VERSION
|
||||||
|
<!-- YAML
|
||||||
|
added: v11.4.0
|
||||||
|
-->
|
||||||
|
|
||||||
|
* {string} The default value of the `minVersion` option of
|
||||||
|
[`tls.createSecureContext()`][]. It can be assigned any of the supported TLS
|
||||||
|
protocol versions, `'TLSv1.3'`, `TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`.
|
||||||
|
**Default:** `'TLSv1.2'`, unless changed using CLI options. Using
|
||||||
|
`--tls-min-v1.0` sets the default to `'TLSv1'`. Using `--tls-min-v1.1` sets
|
||||||
|
the default to `'TLSv1.1'`. Using `--tls-min-v1.3` sets the default to
|
||||||
|
`'TLSv1.3'`. If multiple of the options are provided, the lowest minimum is
|
||||||
|
used.
|
||||||
|
|
||||||
|
|
||||||
## Deprecated APIs
|
## Deprecated APIs
|
||||||
|
|
||||||
### Class: CryptoStream
|
### Class: CryptoStream
|
||||||
@ -1664,6 +1686,8 @@ where `secureSocket` has the same API as `pair.cleartext`.
|
|||||||
[`server.setTicketKeys()`]: #tls_server_setticketkeys_keys
|
[`server.setTicketKeys()`]: #tls_server_setticketkeys_keys
|
||||||
[`socket.setTimeout(timeout)`]: #net_socket_settimeout_timeout_callback
|
[`socket.setTimeout(timeout)`]: #net_socket_settimeout_timeout_callback
|
||||||
[`tls.DEFAULT_ECDH_CURVE`]: #tls_tls_default_ecdh_curve
|
[`tls.DEFAULT_ECDH_CURVE`]: #tls_tls_default_ecdh_curve
|
||||||
|
[`tls.DEFAULT_MAX_VERSION`]: #tls_tls_default_max_version
|
||||||
|
[`tls.DEFAULT_MIN_VERSION`]: #tls_tls_default_min_version
|
||||||
[`tls.Server`]: #tls_class_tls_server
|
[`tls.Server`]: #tls_class_tls_server
|
||||||
[`tls.TLSSocket.getPeerCertificate()`]: #tls_tlssocket_getpeercertificate_detailed
|
[`tls.TLSSocket.getPeerCertificate()`]: #tls_tlssocket_getpeercertificate_detailed
|
||||||
[`tls.TLSSocket.getSession()`]: #tls_tlssocket_getsession
|
[`tls.TLSSocket.getSession()`]: #tls_tlssocket_getsession
|
||||||
|
Loading…
x
Reference in New Issue
Block a user