feat: Support dumping TLS key log in NSS format for debugging #267
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fabpot
requested changes
Feb 8, 2023
commands/local_server_start.go
Outdated
| @@ -169,6 +174,17 @@ var localServerStartCmd = &console.Command{ | |||
| } | |||
| } | |||
|
|
|||
| // If 'SSLKEYLOGFILE' environment variable is set, uses this as a destination of TLS key log. | |||
| // In this context, the name 'SSLKEYLOGFILE' is common, so using 'SSL' instead of 'TLS' name. | |||
| // The key log file from the console argument or YAML config is preferred than the environment variable. | |||
There was a problem hiding this comment.
I would have expected the env var to take precedence.
There was a problem hiding this comment.
Okay, I am going to change the behaviour.
fabpot
approved these changes
Feb 8, 2023
tucksaun
reviewed
Feb 8, 2023
| // If 'SSLKEYLOGFILE' environment variable is set, uses this as a destination of TLS key log. | ||
| // In this context, the name 'SSLKEYLOGFILE' is common, so using 'SSL' instead of 'TLS' name. | ||
| // This environment variable is preferred than the key log file from the console argument. | ||
| if path := os.Getenv("SSLKEYLOGFILE"); path != "" { |
There was a problem hiding this comment.
it's possible to let console take care of this by specifying EnvVars on the associated flags.
See #268
There was a problem hiding this comment.
I did not know about flags handling environment variables.
Thank you for the refactoring!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request proposes to add TLS key logging in NSS format for debugging TLS connection.
It can be used for decrypting the encrypted data in TLS packets between the client and Symfony Local Web Server using Wireshark or something.
In addition to adding
--tls-key-log-fileargument, this adds support ofSSLKEYLOGFILEenvironment variable for the same usage. The variable name is common in many applications.The NSS Key Log Format is described here:
https://firefox-source-docs.mozilla.org/security/nss/legacy/key_log_format/index.html
Example of the key log: