summaryrefslogtreecommitdiff
path: root/doc/api/tls.md
diff options
context:
space:
mode:
authorBrian White <mscdex@mscdex.net>2018-06-27 03:07:13 -0400
committerBrian White <mscdex@mscdex.net>2018-07-03 16:30:17 -0400
commitc267639daa0cc0ef55501fcdc8c385292a9ed927 (patch)
treeea91625a29e54ea4919443305aaf7a0f3235a0bf /doc/api/tls.md
parent6e16ad7a63ba843aafa1284e51ce220a775e11d8 (diff)
downloadandroid-node-v8-c267639daa0cc0ef55501fcdc8c385292a9ed927.tar.gz
android-node-v8-c267639daa0cc0ef55501fcdc8c385292a9ed927.tar.bz2
android-node-v8-c267639daa0cc0ef55501fcdc8c385292a9ed927.zip
doc: clarify ciphers option format
PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc/api/tls.md')
-rw-r--r--doc/api/tls.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md
index 9d71308887..e69d0ea17e 100644
--- a/doc/api/tls.md
+++ b/doc/api/tls.md
@@ -1050,6 +1050,8 @@ changes:
certificate, and the handshake will fail.
* `ciphers` {string} Optional cipher suite specification, replacing the
default. For more information, see [modifying the default cipher suite][].
+ Permitted ciphers can be obtained via [`tls.getCiphers()`][]. Cipher names
+ must be uppercased in order for OpenSSL to accept them.
* `clientCertEngine` {string} Optional name of an OpenSSL engine which can
provide the client certificate.
* `crl` {string|string[]|Buffer|Buffer[]} Optional PEM formatted
@@ -1386,6 +1388,7 @@ where `secureSocket` has the same API as `pair.cleartext`.
[`tls.createSecureContext()`]: #tls_tls_createsecurecontext_options
[`tls.createSecurePair()`]: #tls_tls_createsecurepair_context_isserver_requestcert_rejectunauthorized_options
[`tls.createServer()`]: #tls_tls_createserver_options_secureconnectionlistener
+[`tls.getCiphers()`]: #tls_tls_getciphers
[Chrome's 'modern cryptography' setting]: https://www.chromium.org/Home/chromium-security/education/tls#TOC-Cipher-Suites
[DHE]: https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange
[ECDHE]: https://en.wikipedia.org/wiki/Elliptic_curve_Diffie%E2%80%93Hellman