summaryrefslogtreecommitdiff
path: root/doc/api/tls.md
diff options
context:
space:
mode:
authorSam Roberts <vieuxtech@gmail.com>2018-12-21 08:25:17 -0800
committerSam Roberts <vieuxtech@gmail.com>2018-12-27 14:31:48 -0800
commitb03ba38a57c4be800f6357b6ee5a0e2661a6fc54 (patch)
tree755eb6e08f7f3198dc478a4da8e54cc9de06d8fc /doc/api/tls.md
parentca9c0c90c28ed012cdd5be4e94a974ad07fd9b9a (diff)
downloadandroid-node-v8-b03ba38a57c4be800f6357b6ee5a0e2661a6fc54.tar.gz
android-node-v8-b03ba38a57c4be800f6357b6ee5a0e2661a6fc54.tar.bz2
android-node-v8-b03ba38a57c4be800f6357b6ee5a0e2661a6fc54.zip
doc: link and expand --tls-cipher-list docs
Link to the cli docs for --tls-cipher-list, and link to and mention that NODE_OPTIONS can also be used. PR-URL: https://github.com/nodejs/node/pull/25174 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Diffstat (limited to 'doc/api/tls.md')
-rw-r--r--doc/api/tls.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md
index d9c332c03d..78f7f051eb 100644
--- a/doc/api/tls.md
+++ b/doc/api/tls.md
@@ -169,12 +169,16 @@ HIGH:
!CAMELLIA
```
-This default can be replaced entirely using the `--tls-cipher-list` command
-line switch. For instance, the following makes
-`ECDHE-RSA-AES128-GCM-SHA256:!RC4` the default TLS cipher suite:
+This default can be replaced entirely using the [`--tls-cipher-list`][] command line
+switch (directly, or via the [`NODE_OPTIONS`][] environment variable). For
+instance, the following makes `ECDHE-RSA-AES128-GCM-SHA256:!RC4` the default
+TLS cipher suite:
```sh
-node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"
+node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4" server.js
+
+export NODE_OPTIONS=--tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"
+node server.js
```
The default can also be replaced on a per client or server basis using the
@@ -1414,6 +1418,8 @@ where `secureSocket` has the same API as `pair.cleartext`.
[`'secureConnect'`]: #tls_event_secureconnect
[`'secureConnection'`]: #tls_event_secureconnection
+[`--tls-cipher-list`]: cli.html#cli_tls_cipher_list_list
+[`NODE_OPTIONS`]: cli.html#cli_node_options_options
[`SSL_CTX_set_timeout`]: https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_timeout.html
[`crypto.getCurves()`]: crypto.html#crypto_crypto_getcurves
[`dns.lookup()`]: dns.html#dns_dns_lookup_hostname_options_callback