Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tls: add debugging to native TLS code #26843

Closed
wants to merge 3 commits into from
Closed

tls: add debugging to native TLS code #26843

wants to merge 3 commits into from

Conversation

addaleax
Copy link
Member

This is an attempt to make investigating the TLS state machine a bit more feasible.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines

@nodejs-github-bot
Copy link
Collaborator

@addaleax build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/3000/pipeline

@nodejs-github-bot nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. tls Issues and PRs related to the tls subsystem. labels Mar 21, 2019
sam-github
sam-github approved these changes Mar 21, 2019
View reviewed changes
Copy link
Contributor

@sam-github sam-github left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

I suggest you add to every Debug() message whether its client or server. If you are running standalone node code, you know, but almost all the code I debugged had both a client and server in the same process (all our unit tests do), so having intermixed debug output and not knowing whether it was from client or server state made the debug output not very useful. I added client/server indications to both js debug statements, and the C++ fprintfs I was using.

Would be useful to add some info on how to enable the debug messages. I could't figure it out in 2 minutes of grepping and tag searching. I'm sure its only a couple more minutes till I find out how its enabled, probably I can git blame and find the original PRs, but a few comments in debug_utils.[h,cc] about how its supposed to use would be very much appreciated.

src/tls_wrap.cc Outdated
// Ignore cycling data if ClientHello wasn't yet parsed
if (!hello_parser_.IsEnded())
if (!hello_parser_.IsEnded()) {
Debug(this, "Bailing out of ClearIn(), hello_parser_ active");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "Not yet ready for " would be more clear than "Bailing out". The debug is mostly useful while reading the source, but Bailing sounds to me like a permanent state, but its just temporary.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I replaced all occurrences of Bailing out of with Returning from, that seems like the most accurate statement

@addaleax
Copy link
Member Author

I suggest you add to every Debug() message whether its client or server. If you are running standalone node code, you know, but almost all the code I debugged had both a client and server in the same process (all our unit tests do), so having intermixed debug output and not knowing whether it was from client or server state made the debug output not very useful. I added client/server indications to both js debug statements, and the C++ fprintfs I was using.

Done 👍

Would be useful to add some info on how to enable the debug messages. I could't figure it out in 2 minutes of grepping and tag searching. I'm sure its only a couple more minutes till I find out how its enabled, probably I can git blame and find the original PRs, but a few comments in debug_utils.[h,cc] about how its supposed to use would be very much appreciated.

Setting NODE_DEBUG_NATIVE=tls should do the trick – it’s mentioned in all of the CLI docs, fwiw. It should probably be mentioned in something like #26665 as well?

@danbev
Copy link
Contributor

danbev commented Mar 25, 2019

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

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 25, 2019
@addaleax
Copy link
Member Author

Landed in f87b3a7, 2d5387e

@addaleax addaleax closed this Mar 26, 2019
@addaleax addaleax deleted the tls-x branch March 26, 2019 11:06
addaleax added a commit that referenced this pull request Mar 26, 2019
@addaleax
tls: add CHECK for impossible condition
f87b3a7 
PR-URL: #26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
addaleax added a commit that referenced this pull request Mar 26, 2019
@addaleax
tls: add debugging to native TLS code
2d5387e 
PR-URL: #26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@targos
Copy link
Member

targos commented Mar 28, 2019

Doesn't land cleanly on v11.x-staging. Does it depend on #26951 ?

@sam-github
Copy link
Contributor

I'll try to cherry-pick it onto #26951 and see if it land clean there.

@sam-github sam-github mentioned this pull request Mar 29, 2019
Closed
4 tasks
@sam-github
Copy link
Contributor

yeah, cherry picks clean after TLS1.3

sam-github pushed a commit to sam-github/node that referenced this pull request Apr 11, 2019
@addaleax @sam-github
tls: add CHECK for impossible condition
fc0fc8a 
PR-URL: nodejs#26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
sam-github pushed a commit to sam-github/node that referenced this pull request Apr 11, 2019
@addaleax @sam-github
tls: add debugging to native TLS code
2aaffb6 
PR-URL: nodejs#26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
BethGriggs pushed a commit that referenced this pull request Apr 15, 2019
@addaleax @BethGriggs
tls: add CHECK for impossible condition
225417b 
Backport-PR-URL: #26951
PR-URL: #26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
BethGriggs pushed a commit that referenced this pull request Apr 15, 2019
@addaleax @BethGriggs
tls: add debugging to native TLS code
d2666e6 
Backport-PR-URL: #26951
PR-URL: #26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@codebytere codebytere mentioned this pull request Apr 19, 2019
Merged
This was referenced Apr 23, 2019
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
@addaleax addaleax mentioned this pull request May 29, 2019
Closed
4 tasks
addaleax added a commit to addaleax/node that referenced this pull request May 30, 2019
@addaleax
tls: add CHECK for impossible condition
7b3277e 
PR-URL: nodejs#26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
addaleax added a commit to addaleax/node that referenced this pull request May 30, 2019
@addaleax
tls: add debugging to native TLS code
b043cc1 
PR-URL: nodejs#26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@addaleax addaleax mentioned this pull request May 30, 2019
Closed
BethGriggs pushed a commit that referenced this pull request Jul 16, 2019
@addaleax @BethGriggs
tls: add CHECK for impossible condition
2cd63ca 
Backport-PR-URL: #27967
PR-URL: #26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
BethGriggs pushed a commit that referenced this pull request Jul 16, 2019
@addaleax @BethGriggs
tls: add debugging to native TLS code
ed50382 
Backport-PR-URL: #27967
PR-URL: #26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
BethGriggs pushed a commit that referenced this pull request Jul 17, 2019
@addaleax @BethGriggs
tls: add CHECK for impossible condition
99dad28 
Backport-PR-URL: #27967
PR-URL: #26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
BethGriggs pushed a commit that referenced this pull request Jul 17, 2019
@addaleax @BethGriggs
tls: add debugging to native TLS code
75052ca 
Backport-PR-URL: #27967
PR-URL: #26843
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BethGriggs BethGriggs mentioned this pull request Jul 17, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BridgeAR BridgeAR BridgeAR approved these changes

@JungMinu JungMinu JungMinu approved these changes

@tniessen tniessen tniessen approved these changes

@cjihrig cjihrig cjihrig approved these changes

@jasnell jasnell jasnell approved these changes

@bnoordhuis bnoordhuis bnoordhuis approved these changes

@sam-github sam-github sam-github approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. c++ Issues and PRs that require attention from people who are familiar with C++. tls Issues and PRs related to the tls subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.