Skip to content
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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: clarify supported versus enabled TLS ciphers #42063

Merged
merged 2 commits into from Feb 22, 2022
Merged

doc: clarify supported versus enabled TLS ciphers #42063

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef9406e
doc: clarify supported versus enabled TLS ciphers
tniessen Feb 20, 2022
17dc522
doc: match heading in link text
tniessen Feb 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/api/tls.md
View file
Open in desktop
Expand Up @@ -2101,6 +2101,9 @@ Returns an array with the names of the supported TLS ciphers. The names are
lower-case for historical reasons, but must be uppercased to be used in
the `ciphers` option of [`tls.createSecureContext()`][].

Not all supported ciphers are enabled by default. See
Copy link
Contributor

@thernstig thernstig Feb 21, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ciphers -> cipher suites (though that should also change the above line "TLS ciphers" -> "TLS cipher suites".

Maybe I am nit-picky here, but each string shown is a suite that contains many ciphers, although of course "ciphers" (plural) covers that in a sense.

At the same time, the option is called ciphers and not cipher_suites, so keeping "ciphers" only might make sense.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, node uses the terms ciphers and cipher suites similarly, which is technically not quite correct. I can try to make things more consistent in a follow-up PR.

[modifying the default cipher suite][].
tniessen marked this conversation as resolved.
Show resolved Hide resolved

Cipher names that start with `'tls_'` are for TLSv1.3, all the others are for
TLSv1.2 and below.

Expand Down