Redact potentially sensitive config keys from log messages #62
Conversation
This file contains 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
- It might be overkill to redact a lot of the keys, but its probably better to be safe than sorry
- I found another place where the password is getting redacted so I thought it might be good to use the same function to do it everywhere
- It lives under docker
NoxHarmonium
commented
Nov 20, 2024
| @@ -11,15 +11,15 @@ jobs: | |||
|
|
|||
| strategy: | |||
| matrix: | |||
| python-version: ["3.8", "3.9", "3.10"] | |||
| python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] | |||
There was a problem hiding this comment.
I wasn't sure if we wanted to remove some of the older versions, looks like Python 3.8 is EOL, but the builds run in parallel so it doesn't seem to hurt to have more versions in there.
NoxHarmonium
commented
Nov 20, 2024
| # "sasl.login.class", | ||
| # "sasl.mechanism", | ||
| # "sasl.oauthbearer.jwks.endpoint.url", | ||
| # "sasl.oauthbearer.token.endpoint.url", |
There was a problem hiding this comment.
I don't usually like having a heap of commented out code like this, but it is handy to see at a glance what keys are getting redacted so I left it in for now.
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.
As discussed in #61 I have created a whitelist of config values that are considered non-sensitive, and all others will be redacted with the string "****"
I noticed there was some other code that redacts the SASL password so I switched that to use the new redact function so everything is consistent.
I also have made some small changes to the CI pipeline as it was not building properly when trying to test the fork (and added some newer python versions).
Fixes #61, Fixes #60