Ensure log does not contain ANSI sequences or control codes #1604
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
freakboy3742
requested changes
Jan 14, 2024
src/briefcase/console.py
Outdated
| @@ -399,7 +412,8 @@ def _build_log(self, command): | |||
| # build log header and export buffered log from Rich | |||
| uname = platform.uname() | |||
| sanitized_env_vars = "\n".join( | |||
| f" {env_var}={value if not SENSITIVE_SETTING_RE.search(env_var) else '********************'}" | |||
| f"\t{env_var}=" | |||
| f"{sanitize_text(value) if not SENSITIVE_SETTING_RE.search(env_var) else '********************'}" | |||
There was a problem hiding this comment.
Is this advisable? Environment variables are something that we really need to know verbatim - any manipulation could lead us to believe that one value has been set, when it's actually a different value.
To be clear - I can't think of a reason why the user's PS1 setting could cause a problem, but then, that's likely a lack of imagination on my part.
There was a problem hiding this comment.
Yeah; that's fair....and it's really of marginal value to remove these anyway.
freakboy3742
approved these changes
Jan 15, 2024
There was a problem hiding this comment.
Looks good - and I'm going to need the cleansing utility to get #1606 working, so this is really timely :-)
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.
Changes
Notes
PR Checklist: