Redact ?token= querystring parameter from GHES <3.8 archive URLs in logs
#1152
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
timrogers
commented
Oct 24, 2023
src/Octoshift/Services/OctoLogger.cs
Outdated
| @@ -156,5 +155,17 @@ public virtual void LogSuccess(string msg) | |||
| Console.ResetColor(); | |||
| } | |||
|
|
|||
| public virtual void RegisterSecret(string secret) => _secrets.Add(secret); | |||
There was a problem hiding this comment.
We could also avoid this refactor, and keep a separate list of _secrets which we replace as well as the "redaction patterns". That's probably a safer approach to avoid surprises - but I'd love to hear what y'all think.
… logs Existing code allows us to redact secrets in the logs outputted to the shell and to log files. Secret strings are registered, and then replaced in the output. This PR also allows classes using `OctoLogger` to register regular expressions to replace, and begins redacting GHES download tokens for GHES <3.8. Fixes #1151.
timrogers
commented
Oct 31, 2023
| @@ -188,6 +189,8 @@ public override MigrateRepoCommandHandler BuildHandler(MigrateRepoCommandArgs ar | |||
| var ghesVersionChecker = ghesVersionCheckerFactory.Create(ghesApi); | |||
| var warningsCountLogger = sp.GetRequiredService<WarningsCountLogger>(); | |||
|
|
|||
| log.AddRedactionPattern(new Regex("\\?token=[A-Z0-9]{29}")); | |||
There was a problem hiding this comment.
I have manually tested that this works as expected on GHES 3.7, and the URL is not logged.
timrogers
force-pushed
the
timrogers/fix-1151
branch
from
223aaaf to
9f78feb
Compare
ArinGhazarian
approved these changes
Nov 10, 2023
|
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.
Existing code allows us to redact secrets in the logs to stop them being outputted to the shell and to log files. Secret strings are registered during execution, and then replaced in the output.
This PR also allows classes using
OctoLoggerto register regular expressions to replace, and begins redacting GHES download tokens for GHES <3.8 using a simple regular expression.Fixes #1151.
ThirdPartyNotices.txt(if applicable)