Skip to content

Commit dad5f3a

Browse files
tniessendanielleadams
authored andcommitted
doc: clarify supported versus enabled TLS ciphers
PR-URL: #42063 Refs: #42059 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Harshitha K P <[email protected]> Reviewed-By: Juan José Arboleda <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent e6d3411 commit dad5f3a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/api/tls.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1785,7 +1785,7 @@ changes:
17851785
See [OpenSSL man pages](https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set1_sigalgs_list.html)
17861786
for more info.
17871787
* `ciphers` {string} Cipher suite specification, replacing the default. For
1788-
more information, see [modifying the default cipher suite][]. Permitted
1788+
more information, see [Modifying the default TLS cipher suite][]. Permitted
17891789
ciphers can be obtained via [`tls.getCiphers()`][]. Cipher names must be
17901790
uppercased in order for OpenSSL to accept them.
17911791
* `clientCertEngine` {string} Name of an OpenSSL engine which can provide the
@@ -2087,6 +2087,9 @@ Returns an array with the names of the supported TLS ciphers. The names are
20872087
lower-case for historical reasons, but must be uppercased to be used in
20882088
the `ciphers` option of [`tls.createSecureContext()`][].
20892089

2090+
Not all supported ciphers are enabled by default. See
2091+
[Modifying the default TLS cipher suite][].
2092+
20902093
Cipher names that start with `'tls_'` are for TLSv1.3, all the others are for
20912094
TLSv1.2 and below.
20922095

@@ -2155,6 +2158,7 @@ added: v11.4.0
21552158
[Chrome's 'modern cryptography' setting]: https://www.chromium.org/Home/chromium-security/education/tls#TOC-Cipher-Suites
21562159
[DHE]: https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange
21572160
[ECDHE]: https://en.wikipedia.org/wiki/Elliptic_curve_Diffie%E2%80%93Hellman
2161+
[Modifying the default TLS cipher suite]: #modifying-the-default-tls-cipher-suite
21582162
[Mozilla's publicly trusted list of CAs]: https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt
21592163
[OCSP request]: https://en.wikipedia.org/wiki/OCSP_stapling
21602164
[OpenSSL Options]: crypto.md#openssl-options
@@ -2206,6 +2210,5 @@ added: v11.4.0
22062210
[certificate object]: #certificate-object
22072211
[cipher list format]: https://www.openssl.org/docs/man1.1.1/man1/ciphers.html#CIPHER-LIST-FORMAT
22082212
[forward secrecy]: https://en.wikipedia.org/wiki/Perfect_forward_secrecy
2209-
[modifying the default cipher suite]: #modifying-the-default-tls-cipher-suite
22102213
[perfect forward secrecy]: #perfect-forward-secrecy
22112214
[specific attacks affecting larger AES key sizes]: https://www.schneier.com/blog/archives/2009/07/another_new_aes.html

0 commit comments

Comments
 (0)