Obfuscate Credentials in Logs #312
Merged
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
dmikusa
reviewed
Feb 6, 2024
dmikusa
added
type:bug
dmikusa
reviewed
Feb 15, 2024
dmikusa
reviewed
Feb 15, 2024
dmikusa
requested changes
Feb 15, 2024
Co-authored-by: Daniel Mikusa <dan@mikusa.com>
|
Sure, they are okay. Thanks for the review. |
dmikusa
approved these changes
Feb 15, 2024
dmikusa
added a commit
to paketo-buildpacks/libpak-tools
that referenced
this pull request
Nov 9, 2024
Signed-off-by: Daniel Mikusa <dan@mikusa.com>
dmikusa
added a commit
that referenced
this pull request
Nov 12, 2024
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.
Summary
When using HTTP basic authentication credentials in binding URIs, this change obfuscates the username and password in the log entries.
Use Cases
When adding a binding for an artifact hosted in a private registry, it can be necessary to provide HTTP basic authentication credentials with the URI. This already works fine for downloading the desired dependency. However, when doing so, the username and password that are part of the URI, get printed to stdout in plain text at the moment. This PR should solve this issue by obfuscating the credentials.
To make sure this change has no adverse side effects in case the provided URI is not well-formed, this implementation uses a regular expression instead of trying to parse the string to a "net/url" object.
Checklist