Skip to content

Commit c267639

Browse files
committed
doc: clarify ciphers option format
PR-URL: #21557 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
1 parent 6e16ad7 commit c267639

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/api/tls.md

+3
Original file line numberDiff line numberDiff line change
@@ -1050,6 +1050,8 @@ changes:
10501050
certificate, and the handshake will fail.
10511051
* `ciphers` {string} Optional cipher suite specification, replacing the
10521052
default. For more information, see [modifying the default cipher suite][].
1053+
Permitted ciphers can be obtained via [`tls.getCiphers()`][]. Cipher names
1054+
must be uppercased in order for OpenSSL to accept them.
10531055
* `clientCertEngine` {string} Optional name of an OpenSSL engine which can
10541056
provide the client certificate.
10551057
* `crl` {string|string[]|Buffer|Buffer[]} Optional PEM formatted
@@ -1386,6 +1388,7 @@ where `secureSocket` has the same API as `pair.cleartext`.
13861388
[`tls.createSecureContext()`]: #tls_tls_createsecurecontext_options
13871389
[`tls.createSecurePair()`]: #tls_tls_createsecurepair_context_isserver_requestcert_rejectunauthorized_options
13881390
[`tls.createServer()`]: #tls_tls_createserver_options_secureconnectionlistener
1391+
[`tls.getCiphers()`]: #tls_tls_getciphers
13891392
[Chrome's 'modern cryptography' setting]: https://www.chromium.org/Home/chromium-security/education/tls#TOC-Cipher-Suites
13901393
[DHE]: https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange
13911394
[ECDHE]: https://en.wikipedia.org/wiki/Elliptic_curve_Diffie%E2%80%93Hellman

0 commit comments

Comments
 (0)