Skip to content

[v10.x] tls: expose keylog event on TLSSocket #31582

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
Closed
wants to merge 1 commit into from
Closed

[v10.x] tls: expose keylog event on TLSSocket #31582

wants to merge 1 commit into from

Conversation

@mildsunrise
Copy link
Contributor

@mildsunrise mildsunrise commented Jan 30, 2020

Backport of #27654.

I had to modify test-tls-keylog-tlsv13.js to use TLS 1.2 connections as (AFAIK) v10 is not going to support TLS 1.3. I also modified the count from 5 to 1, because TLS 1.2 handshakes only emit 1 keylog event. Should I rename the file to test-tls-keylog-tlsv12.js?

@nodejs-github-bot nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. v10.x labels Jan 30, 2020
sam-github
sam-github approved these changes Jan 30, 2020
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. @nodejs/lts would have a better idea whether renaming file makes things better, or is just another source of merge conflicts. I'm OK with leaving the file name as-is.

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Feb 25, 2020

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

@mildsunrise
Copy link
Contributor Author

mildsunrise commented Feb 25, 2020

wait, I see there's ubuntu1804_sharedlibs_openssl110_x64... do we need to support OpenSSL 1.1.0? if so then this can't be merged

@bnoordhuis
Copy link
Member

bnoordhuis commented Feb 25, 2020

It's okay to disable the functionality with #if OPENSSL_VERSION_NUMBER < 0x1010100fL. That buildbot is so we know when a change breaks distro builds.

@richardlau richardlau mentioned this pull request Feb 26, 2020
Closed
@mildsunrise mildsunrise force-pushed the v10.x-tls-keylog branch 2 times, most recently from 15c9ce9 to 1ff0c68 Compare February 28, 2020 13:37
@mildsunrise
Copy link
Contributor Author

mildsunrise commented Feb 28, 2020

Okay! I've suppressed the SSL_CTX_set_keylog_callback call, the build should work now.

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Feb 28, 2020

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

@bnoordhuis
Copy link
Member

bnoordhuis commented Feb 28, 2020

@mildsunrise Do you want me to nominate you for collaborator status? I.e., get your commit bit? You've done enough high-impact work to qualify, IMO.

@mildsunrise
Copy link
Contributor Author

mildsunrise commented Feb 28, 2020

Oh, I forgot to skip the test when needed... it should be complete now

@mildsunrise Do you want me to nominate you for collaborator status? I.e., get your commit bit? You've done enough high-impact work to qualify, IMO.

It'd be a pleasure! :)

@bnoordhuis
Copy link
Member

bnoordhuis commented Feb 28, 2020

#32014 :)

@nodejs-github-bot

This comment has been minimized.

Sign in to view
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 9, 2020

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

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 10, 2020

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

@BethGriggs
Copy link
Member

BethGriggs commented Mar 11, 2020

In the most recent CI, the Windows failures are flakes, but the failure on ubuntu1804_sharedlibs_openssl110_x64 seems real - https://ci.nodejs.org/job/node-test-commit-linux-containered/18601/nodes=ubuntu1804_sharedlibs_openssl110_x64/testReport/junit/(root)/test/parallel_test_tls_keylog_tlsv13/

sam-github
sam-github suggested changes Mar 11, 2020
View reviewed changes
@sam-github
Copy link
Contributor

sam-github commented Mar 11, 2020

Keylog support isn't available on that openssl version, but the regex that was added to check had a small typo. Passed for me locally after (by skipping the test).

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 11, 2020

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

@sam-github
Copy link
Contributor

sam-github commented Mar 11, 2020

Should I rename the file to test-tls-keylog-tlsv12.js

Yes, please.

@mildsunrise
tls: expose keylog event on TLSSocket
f82b4ae 
Exposes SSL_CTX_set_keylog_callback in the form of a `keylog` event
that is emitted on clients and servers. This enables easy debugging
of TLS connections with i.e. Wireshark, which is a long-requested
feature.

PR-URL: nodejs#27654
Refs: nodejs#2363
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Sam Roberts <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@mildsunrise
Copy link
Contributor Author

mildsunrise commented Mar 11, 2020

Totally right, that was a typo. I've renamed the file and squashed, hopefully everything is in order now (sorry for taking so many attempts to get it right 😅)

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 12, 2020

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

BethGriggs pushed a commit that referenced this pull request Mar 12, 2020
@mildsunrise @BethGriggs
tls: expose keylog event on TLSSocket
a2b0e9e 
Exposes SSL_CTX_set_keylog_callback in the form of a `keylog` event
that is emitted on clients and servers. This enables easy debugging
of TLS connections with i.e. Wireshark, which is a long-requested
feature.

PR-URL: #27654
Backport-PR-URL: #31582
Refs: #2363
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Sam Roberts <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@BethGriggs
Copy link
Member

BethGriggs commented Mar 12, 2020

Landed in a2b0e9e 🎉

@BethGriggs BethGriggs closed this Mar 12, 2020
@mildsunrise mildsunrise deleted the v10.x-tls-keylog branch March 12, 2020 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bnoordhuis bnoordhuis bnoordhuis approved these changes

@BethGriggs BethGriggs BethGriggs approved these changes

+2 more reviewers

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

@devnexen devnexen devnexen approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@mildsunrise @nodejs-github-bot @bnoordhuis @BethGriggs @sam-github @devnexen