[v10.x] doc: describe tls.DEFAULT_MIN_VERSION/_MAX_VERSION by ckarande · Pull Request #28827 · nodejs/node (original) (raw)
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Conversation15 Commits2 Checks0 Files changed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
[ Show hidden characters]({{ revealButtonHref }})
Add documentation for tls.DEFAULT_MAX_VERSION and
tls.DEFAULT_MIN_VERSION, which existed in v10.6.0
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes- documentation is changed or added
- commit message follows commit guidelines
Add documentation for tls.DEFAULT_MAX_VERSION and tls.DEFAULT_MIN_VERSION, which existed in v10.6.0
Fixes: nodejs#28758 Refs: nodejs#26821
doc: describe tls.DEFAULT_MIN_VERSION/_MAX_VERSION [v10.x] doc: describe tls.DEFAULT_MIN_VERSION/_MAX_VERSION
| @@ -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 |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like these should be added to the other file?
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| @@ -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`][]. |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
`[`tls.DEFAULT_MAX_VERSION`]: #tls_tls_default_max_version`
`[`tls.DEFAULT_MIN_VERSION`]: #tls_tls_defaut_min_version`
right after
`[`tls.DEFAULT_ECDH_CURVE`]: #tls_tls_default_ecdh_curve`
in tls.md
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....
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....
Backport is in #28832. After that lands, CI here should be green or at least green-ish-er.
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....
Backport is in #28832. After that lands, CI here should be green or at least green-ish-er.
Fix for the crash has landed. Time to launch CI again....
BethGriggs pushed a commit that referenced this pull request
Add documentation for tls.DEFAULT_MAX_VERSION and tls.DEFAULT_MIN_VERSION, which existed in v10.6.0
PR-URL: #28827 Reviewed-By: Anna Henningsen anna@addaleax.net Reviewed-By: Beth Griggs Bethany.Griggs@uk.ibm.com
BethGriggs pushed a commit that referenced this pull request
PR-URL: #28827 Fixes: #28758 Refs: #26821 Reviewed-By: Anna Henningsen anna@addaleax.net Reviewed-By: Beth Griggs Bethany.Griggs@uk.ibm.com
Labels
Issues and PRs related to the documentations.