redact s3 credential values when printing config to logs #5961
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
afayngelerindbx
force-pushed
the
redact-s3-cred
branch
2 times, most recently
from
d413498 to
50b97af
Compare
afayngelerindbx
force-pushed
the
redact-s3-cred
branch
from
50b97af to
fe89098
Compare
kavirajk
reviewed
Apr 20, 2022
| @@ -69,8 +85,8 @@ type S3Config struct { | |||
| BucketNames string | |||
| Endpoint string `yaml:"endpoint"` | |||
| Region string `yaml:"region"` | |||
| AccessKeyID string `yaml:"access_key_id"` | |||
| SecretAccessKey string `yaml:"secret_access_key"` | |||
| AccessKeyID secret `yaml:"access_key_id"` | |||
There was a problem hiding this comment.
I'm failing to understand how this will redact when printing these configs in logs. Can you clarify?
- Can you tell me where exactly it's getting logged?
- Even with this change, if we log the config (either logfmt or json), it's still going to be visible correct?
- Only advantage of adding this
secrettype I see is when we print the config after marshalling into YAML, it won't be visible. Is that your real use case? can you help me understand how it's useful?
There was a problem hiding this comment.
Thanks for taking a look!
When I set the -print-config-stderr or -log-config-reverse-order, loki marshals the config to YAML and dumps it to stderr. This diff forces S3 credentials to be redacted from this output. I will update the PR description as well.
There was a problem hiding this comment.
Thanks @afayngelerindbx for the clarification :)
This was referenced Jun 28, 2022
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.
What this PR does / why we need it:
This PR makes sure that we don't commit S3 credential values to logs when using
-print-config-stderrand-log-config-reverse-orderflags.Checklist
CHANGELOG.mdabout the changes.