[v10.x] doc: describe tls.DEFAULT_MIN_VERSION/_MAX_VERSION #28827
Conversation
Add documentation for tls.DEFAULT_MAX_VERSION and tls.DEFAULT_MIN_VERSION, which existed in v10.6.0 Fixes: nodejs#28758 Refs: nodejs#26821
addaleax
changed the title
doc/api/cli.md
Outdated
| @@ -773,6 +773,8 @@ greater than `4` (its current default value). For more information, see the | |||
| [`Buffer`]: buffer.html#buffer_class_buffer | |||
| [`SlowBuffer`]: buffer.html#buffer_class_slowbuffer | |||
| [`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 | |||
There was a problem hiding this comment.
I feel like these should be added to the other file?
There was a problem hiding this comment.
I back-ported this commit from cli.md to 10.x. However, if it is needed in other file (tls.md) I can certainly move/add it there. Do you have any suggestions on where to include it in the tls.md.
There was a problem hiding this comment.
On further analysis I realized as the cli options (--tls-max-vXX, --tls-min-vXX) are not supported in v10, there are no corresponding sections for command line option in this file. So these changes do not need to be back ported. I will revert these lines. Thanks.
doc/api/tls.md
Outdated
| @@ -1198,12 +1198,12 @@ changes: | |||
| `object.passphrase` if provided, or `options.passphrase` if it is not. | |||
| * `maxVersion` {string} Optionally set the maximum TLS version to allow. One | |||
| of `TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the | |||
| `secureProtocol` option, use one or the other. **Default:** `'TLSv1.2'`. | |||
| `secureProtocol` option, use one or the other. **Default:** [`tls.DEFAULT_MAX_VERSION`][]. | |||
There was a problem hiding this comment.
I’d expect the linter to complain about the line length here, so:
| `secureProtocol` option, use one or the other. **Default:** [`tls.DEFAULT_MAX_VERSION`][]. | |
| `secureProtocol` option, use one or the other. | |
| **Default:** [`tls.DEFAULT_MAX_VERSION`][]. |
|
Adding right after in should fix the build failure. |
|
Thanks @nitinsurana @addaleax . The lint error was coming from cli.md due to unused links. Also, these links were needed in tls.md. I have fixed it in the latest commit. |
|
I think the crashes on CI will be fixed when #25079 is backported to the v10.x-staging branch. In the meantime, hopefully Resume Build once or twice will fix.... |
Fix for the crash has landed. Time to launch CI again.... |
Add documentation for tls.DEFAULT_MAX_VERSION and tls.DEFAULT_MIN_VERSION, which existed in v10.6.0 Fixes: #28758 Refs: #26821 PR-URL: #28827 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>
PR-URL: #28827 Fixes: #28758 Refs: #26821 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>
Add documentation for tls.DEFAULT_MAX_VERSION and
tls.DEFAULT_MIN_VERSION, which existed in v10.6.0
Fixes: #28758
Refs: #26821
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes