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

examples: configure KeyLogFile for all examples. #1423

Merged
merged 1 commit into from
Aug 29, 2023

Conversation

cpu
Copy link
Member

@cpu cpu commented Aug 28, 2023

The example programs distributed with Rustls are often used to demonstrate TLS features, or debug issues, that require being able to view plaintext data captured in a pcap (e.g. with Wireshark). As one concrete example a modified simple_0rtt_client.rs, was used to help debug #1406.

To make this convenient this commit updates the examples (minus the MIO examples that already did so ) to configure Rustls with a KeyLogFile implementation of the KeyLog trait. Users can then specify the SSLKEYLOGFILE environment variable to log the required session secrets for use with their pcap tool of choice.

The example programs distributed with Rustls are often used to
demonstrate TLS features, or debug issues, that require being able to
view plaintext data captured in a pcap (e.g. with Wireshark).

To make this convenient this commit updates the examples (minus the MIO
examples that already did so ) to configure Rustls with a `KeyLogFile`
implementation of the `KeyLog` trait. Users can then specify the
`SSLKEYLOGFILE` environment variable to log the required session secrets
for use with their pcap tool of choice.
@cpu cpu self-assigned this Aug 28, 2023
@codecov
Copy link

codecov bot commented Aug 28, 2023

Codecov Report

Merging #1423 (48c8aaf) into main (0f5deca) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1423   +/-   ##
=======================================
  Coverage   96.49%   96.49%           
=======================================
  Files          71       71           
  Lines       15169    15169           
=======================================
  Hits        14637    14637           
  Misses        532      532           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ctz ctz added this pull request to the merge queue Aug 29, 2023
Merged via the queue into rustls:main with commit c29c75b Aug 29, 2023
21 checks passed
@cpu cpu deleted the cpu-sslkeylogfile-examples branch August 29, 2023 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants