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.

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

Enabling SSLKEYLOGFILE Capability #19081

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tnetennba-tmp
Copy link

Purpose:

To enable SSLKEYLOGFILE capabilities as described in [1], [2]. This will enable diagnostic tools to inspect the contents of Chia's encrypted WebSocket messages, making it easier to debug or analyze Chia's networking protocol.

[1] https://www.ietf.org/archive/id/draft-ietf-tls-keylogfile-02.txt
[2] https://docs.python.org/3/library/ssl.html#ssl.SSLContext.keylog_filename

Current Behavior:

New Behavior:

By defining a keyfile path in any of the following environmental variables, TLS keys are written to that keyfile. Diagnostic tools like Wireshark can reference this keyfile and decrypt the network traffic.

CHIA_SSLKEYLOGFILENAME_SERVER
CHIA_SSLKEYLOGFILENAME_ROOT
CHIA_SSLKEYLOGFILENAME_CLIENT

Testing Notes:

@tnetennba-tmp tnetennba-tmp requested a review from a team as a code owner December 21, 2024 20:58
@aqk aqk requested review from altendky and bramv-chia December 21, 2024 21:00
@altendky altendky added the Added Required label for PR that categorizes merge commit message as "Added" for changelog label Dec 23, 2024
Copy link

Pull Request Test Coverage Report for Build 12448397037

Details

  • 7 of 10 (70.0%) changed or added relevant lines in 1 file are covered.
  • 45 unchanged lines in 12 files lost coverage.
  • Overall coverage decreased (-0.02%) to 91.522%

Changes Missing Coverage Covered Lines Changed/Added Lines %
chia/server/server.py 7 10 70.0%
Files with Coverage Reduction New Missed Lines %
chia/full_node/pending_tx_cache.py 1 96.55%
chia/wallet/util/wallet_sync_utils.py 1 86.07%
chia/plotters/plotters.py 1 90.94%
chia/util/files.py 2 91.38%
chia/server/node_discovery.py 2 81.47%
chia/consensus/blockchain.py 2 94.1%
chia/timelord/timelord_launcher.py 2 90.71%
chia/wallet/wallet_node.py 4 88.03%
chia/_tests/core/util/test_lockfile.py 4 88.43%
chia/plotters/madmax.py 6 44.58%
Totals Coverage Status
Change from base Build 12437328436: -0.02%
Covered Lines: 105250
Relevant Lines: 114822

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Added Required label for PR that categorizes merge commit message as "Added" for changelog community-pr
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants