fix: log entries created from user input #68
Merged
Conversation
This file contains hidden or 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
CodeQL reported this as an issue. Letting Copilot fix it. Signed-off-by: Chris Gianelloni <[email protected]> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR addresses a logging issue reported by CodeQL by sanitizing user input before logging to prevent potential log injection or formatting issues.
- Introduces sanitization of newline characters from log values.
- Adds an import for the strings package to enable the sanitization.
Comment on lines
+58
to
+60
| // Sanitize the value to remove newline characters | ||
| sanitizedValue := strings.ReplaceAll(kv.Value, "\n", "") | ||
| sanitizedValue = strings.ReplaceAll(sanitizedValue, "\r", "") |
There was a problem hiding this comment.
[nitpick] While sanitizing newline characters helps mitigate log injection issues, consider whether additional sanitization (e.g., for carriage returns or other control characters) might be required based on the application's context.
Suggested change
| // Sanitize the value to remove newline characters | |
| sanitizedValue := strings.ReplaceAll(kv.Value, "\n", "") | |
| sanitizedValue = strings.ReplaceAll(sanitizedValue, "\r", "") | |
| // Sanitize the value to remove all control characters | |
| sanitizedValue := sanitizeString(kv.Value) |
Copilot uses AI. Check for mistakes.
|
"We reviewed ourselves and decided to nit pick ourselves" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
CodeQL reported this as an issue. Letting Copilot fix it.