node/doc/api
Sam Roberts 80efb80f3f tls: cli option to enable TLS key logging to file
Debugging HTTPS or TLS connections from a Node.js app with (for example)
Wireshark is unreasonably difficult without the ability to get the TLS
key log. In theory, the application can be modified to use the
`'keylog'` event directly, but for complex apps, or apps that define
there own HTTPS Agent (like npm), this is unreasonably difficult.

Use of the option triggers a warning to be emitted so the user is
clearly notified of what is happening and its effect.

PR-URL: https://github.com/nodejs/node/pull/30055
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
2019-11-20 08:00:02 -08:00
..
addons.md src: deprecate two- and one-argument AtExit() 2019-11-05 23:59:02 +01:00
assert.md doc: adds NO_COLOR to assert doc page 2019-11-18 15:46:53 +01:00
async_hooks.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
buffer.md doc: remove dashes 2019-10-26 08:39:41 -07:00
child_process.md child_process,cluster: allow using V8 serialization API 2019-11-05 23:07:04 +01:00
cli.md tls: cli option to enable TLS key logging to file 2019-11-20 08:00:02 -08:00
cluster.md child_process,cluster: allow using V8 serialization API 2019-11-05 23:07:04 +01:00
console.md doc, console: remove non-existant methods from docs 2019-11-13 07:40:51 +01:00
crypto.md 2019-11-05, Version 13.1.0 (Current) 2019-11-05 19:39:20 +01:00
debugger.md doc: remove dashes 2019-10-26 08:39:41 -07:00
deprecations.md doc: remove dashes 2019-10-26 08:39:41 -07:00
dgram.md 2019-11-05, Version 13.1.0 (Current) 2019-11-05 19:39:20 +01:00
dns.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
documentation.md doc: remove multiple consecutive blank lines 2019-08-31 15:27:58 -07:00
domain.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
errors.md worker: allow specifying resource limits 2019-11-05 19:57:13 +01:00
esm.md doc: update outdated commonjs compat info 2019-11-17 01:08:09 -08:00
events.md doc: remove "it is important to" phrasing 2019-10-26 16:33:24 -07:00
fs.md 2019-11-05, Version 13.1.0 (Current) 2019-11-05 19:39:20 +01:00
globals.md doc: delete "a number of" things in the docs 2019-10-26 11:25:43 -07:00
http2.md doc: explain http2 aborted event callback 2019-11-03 18:52:20 +05:30
http.md doc: update http.md mention of socket 2019-11-19 15:58:25 +01:00
https.md https: add client support for TLS keylog events 2019-11-19 22:23:23 -08:00
index.md doc: remove dashes 2019-10-26 08:39:41 -07:00
inspector.md doc: remove dashes 2019-10-26 08:39:41 -07:00
intl.md tools: support full-icu by default 2019-10-03 15:21:26 -07:00
modules.md doc: fix some recent doc nits 2019-11-12 16:55:27 -08:00
n-api.md doc: fix up N-API doc 2019-11-12 17:11:39 -08:00
net.md doc: remove dashes 2019-10-26 08:39:41 -07:00
os.md doc: revise os.md 2019-10-26 16:10:12 -07:00
path.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
perf_hooks.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
policy.md doc: remove dashes 2019-10-26 08:39:41 -07:00
process.md child_process,cluster: allow using V8 serialization API 2019-11-05 23:07:04 +01:00
punycode.md doc: prevent some redirections 2018-07-14 22:57:03 +03:00
querystring.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
readline.md doc: remove dashes 2019-10-26 08:39:41 -07:00
repl.md doc: remove dashes 2019-10-26 08:39:41 -07:00
report.md doc: remove dashes 2019-10-26 08:39:41 -07:00
stream.md stream: increase MAX_HWM 2019-11-11 19:50:40 -08:00
string_decoder.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
synopsis.md doc: move Usage and Example to same header level 2019-07-09 19:45:20 -07:00
timers.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
tls.md doc: remove dashes 2019-10-26 08:39:41 -07:00
tracing.md doc: remove dashes 2019-10-26 08:39:41 -07:00
tty.md doc: remove dashes 2019-10-26 08:39:41 -07:00
url.md doc: add entry to url.parse() changes metadata 2019-11-15 15:47:01 +01:00
util.md doc: delete "a number of" things in the docs 2019-10-26 11:25:43 -07:00
v8.md v8: mark serdes API as stable 2019-11-06 00:09:26 +01:00
vm.md esm: unflag --experimental-modules 2019-11-12 14:04:55 -08:00
worker_threads.md worker: allow specifying resource limits 2019-11-05 19:57:13 +01:00
zlib.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00