tls,cli: add --trace-tls command-line flag by cjihrig · Pull Request #27497 · nodejs/node

cjihrig · 2019-04-30T16:36:11Z

This PR adds a --trace-tls CLI flag. The purpose is to enable tracing of TLS connections without the need to modify existing application code.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

nodejs-github-bot · 2019-04-30T16:36:12Z

Lite-CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3399

mscdex · 2019-04-30T16:45:13Z

I think all that's needed is the environment variable support since adedbb1 already landed?

cjihrig · 2019-04-30T16:48:58Z

I think adedbb1 would only support tracing secure sockets created in a server context. tls.connect() would still require changing application code.

mscdex · 2019-04-30T16:52:35Z

I see. Maybe the description should mention this is for client sockets only?

sam-github · 2019-04-30T17:18:05Z

re:

I think adedbb1 would only support tracing secure sockets created in a server context. tls.connect() would still require changing application code.

Both client and server required changing app code, but client needed tls.connect().enableTrace(), it didn't use an option property because I often found it useful to turn trace on only after handshake.

The option property makes sense, though, it makes the API a bit more consistent.

2 suggestions:

consider instead of using an env var, have a CLI option --enable-tls-trace (or --tls-enable-trace?), then it can be done with an env var (with NODE_OPTIONS) or by CLI, we don't have to be so opinionated as to how users will want to set it.
consider having the ENV var (CLI option?) set the intial value of tls.DEFAULT_ENABLE_TRACE to true, so that the property can be set globally in code with tls.DEFAULT_ENABLE_TRACE = true (this is the pattern for a number of the existing CLI/env controllable defaults)

richardlau · 2019-04-30T18:33:19Z

Does this need a brand new environment variable? It looks like it could be a category for the existing NODE_DEBUG. Or as @sam-github suggests it could be a command line option that could be enabled via NODE_OPTIONS.

cjihrig · 2019-04-30T18:37:30Z

Both client and server required changing app code

Sorry, I meant that adding a new environment variable alone was not adequate for the client.

It looks like it could be a category for the existing NODE_DEBUG

That's actually my preference, and was my first idea. However, the format of the output is different enough that I didn't think it made sense.

I'll move this to a CLI flag.

nodejs-github-bot · 2019-05-01T21:57:08Z

CI: https://ci.nodejs.org/job/node-test-pull-request/22864/

nodejs-github-bot · 2019-05-02T13:11:27Z

CI: https://ci.nodejs.org/job/node-test-pull-request/22888/

EDIT(cjihrig): CI was green.

PR-URL: nodejs#27497 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

This commit adds the enableTrace option to the TLSSocket constructor. It also plumbs the option through other relevant APIs. PR-URL: nodejs#27497 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

This commit adds a --trace-tls command-line flag. The purpose is to enable tracing of TLS connections without the need to modify existing application code. PR-URL: nodejs#27497 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

PR-URL: #27497 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

This commit adds the enableTrace option to the TLSSocket constructor. It also plumbs the option through other relevant APIs. PR-URL: #27497 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

This commit adds a --trace-tls command-line flag. The purpose is to enable tracing of TLS connections without the need to modify existing application code. PR-URL: #27497 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Notable changes: * tls: * Added an `enableTrace()` method to `TLSSocket` and an `enableTrace` option to `tls.createServer()`. When enabled, TSL packet trace information is written to `stderr`. This can be used to debug TLS connection problems. #27497 * cli: * Added a `--trace-tls` command-line flag that enables tracing of TLS connections without the need to modify existing application code. #27497 * Added a `--cpu-prof-interval` command-line flag. It can be used to specify the sampling interval for the CPU profiles generated by `--cpu-prof`. #27535 * module: * Added the `createRequire()` method. It allows to create a require function a file URL object, a file URL string or an absolute path string. The existing `createRequireFromPath()` method is now deprecated #27405. * Throw on `require('./path.mjs')`. This is technically a breaking change that should have landed with Node.js 12.0.0. It is necessary to have this to keep the possibility for a future minor version to load ES Modules with the require function. #27417 * meta: * Added Christian Clauss (https://github.com/cclauss) to collaborators. #27554 PR-URL: #27578

Notable changes: * deps: * Updated llhttp to 1.1.3. This fixes a bug that made Node.js' HTTP parser refuse any request URL that contained the "|" (vertical bar) character. #27595 * tls: * Added an `enableTrace()` method to `TLSSocket` and an `enableTrace` option to `tls.createServer()`. When enabled, TSL packet trace information is written to `stderr`. This can be used to debug TLS connection problems. #27497 #27376 * cli: * Added a `--trace-tls` command-line flag that enables tracing of TLS connections without the need to modify existing application code. #27497 * Added a `--cpu-prof-interval` command-line flag. It can be used to specify the sampling interval for the CPU profiles generated by `--cpu-prof`. #27535 * module: * Added the `createRequire()` method. It allows to create a require function from a file URL object, a file URL string or an absolute path string. The existing `createRequireFromPath()` method is now deprecated #27405. * Throw on `require('./path.mjs')`. This is technically a breaking change that should have landed with Node.js 12.0.0. It is necessary to have this to keep the possibility for a future minor version to load ES Modules with the require function. #27417 * repl: * The REPL now supports multi-line statements using `BigInt` literals as well as public and private class fields and methods. #27400 * The REPL now supports tab autocompletion of file paths with `fs` methods. #26648 * meta: * Added Christian Clauss (https://github.com/cclauss) to collaborators. #27554 PR-URL: #27578

nodejs-github-bot added the tls Issues and PRs related to the tls subsystem. label Apr 30, 2019

richardlau reviewed Apr 30, 2019
View reviewed changes

Comment threaddoc/api/tls.md Outdated
Comment threaddoc/api/tls.md Outdated

cjihrig force-pushed the tls-trace branch from b76f16a to f181020Compare April 30, 2019 21:29

cjihrig added the semver-minor PRs that contain new features and should be released in the next minor version. label Apr 30, 2019

cjihrig force-pushed the tls-trace branch from f181020 to 6094f0aCompare April 30, 2019 22:54

cjihrig changed the title ~~tls,cli: add NODE_TLS_TRACE environment variable~~tls,cli: add --trace-tls command-line flagApr 30, 2019

addaleax approved these changes May 1, 2019
View reviewed changes

richardlau approved these changes May 1, 2019
View reviewed changes

Trott approved these changes May 2, 2019
View reviewed changes

cjihrig added 3 commits May 2, 2019 12:37

tls: simplify enableTrace logic
b233d02
PR-URL: nodejs#27497 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

cjihrig force-pushed the tls-trace branch from 6094f0a to 495822fCompare May 2, 2019 16:38

cjihrig merged commit 495822f into nodejs:masterMay 2, 2019

targos pushed a commit that referenced this pull request May 4, 2019
tls: simplify enableTrace logic
576fe33
PR-URL: #27497 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

targos mentioned this pull request May 6, 2019
v12.2.0 proposal #27578
Merged

sam-github mentioned this pull request May 16, 2019
Node 11.9+ Exception on openssl digital envelope routines cipher parameter evp_lib.c #27213
Closed

cjihrig deleted the tls-trace branch May 16, 2019 18:31

BethGriggs added the lts-watch-v10.x label Aug 20, 2019

BethGriggs added the backport-requested-v10.x label Oct 17, 2019

Navigation Menu

Uh oh!

Uh oh!

tls,cli: add --trace-tls command-line flag - #27497

tls,cli: add --trace-tls command-line flag#27497
cjihrig merged 3 commits into
nodejs:masterfrom
cjihrig:tls-trace

cjihrig commented Apr 30, 2019•
edited
Loading

Uh oh!

nodejs-github-bot commented Apr 30, 2019

Uh oh!

mscdex commented Apr 30, 2019

Uh oh!

cjihrig commented Apr 30, 2019

Uh oh!

mscdex commented Apr 30, 2019

Uh oh!

sam-github commented Apr 30, 2019

Uh oh!

richardlau commented Apr 30, 2019

Uh oh!

Uh oh!

Uh oh!

cjihrig commented Apr 30, 2019•
edited
Loading

Uh oh!

nodejs-github-bot commented May 1, 2019

Uh oh!

nodejs-github-bot commented May 2, 2019•
edited by cjihrig
Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Uh oh!

Uh oh!

Conversation

cjihrig commented Apr 30, 2019• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

nodejs-github-bot commented Apr 30, 2019

Uh oh!

mscdex commented Apr 30, 2019

Uh oh!

cjihrig commented Apr 30, 2019

Uh oh!

mscdex commented Apr 30, 2019

Uh oh!

sam-github commented Apr 30, 2019

Uh oh!

richardlau commented Apr 30, 2019

Uh oh!

Uh oh!

Uh oh!

cjihrig commented Apr 30, 2019• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented May 1, 2019

Uh oh!

nodejs-github-bot commented May 2, 2019• edited by cjihrig Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

cjihrig commented Apr 30, 2019•
edited
Loading

cjihrig commented Apr 30, 2019•
edited
Loading

nodejs-github-bot commented May 2, 2019•
edited by cjihrig
Loading