-
Notifications
You must be signed in to change notification settings - Fork 1
🔒 [security fix] generic error messages to prevent data leakage #18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
GreyC
wants to merge
1
commit into
main
Choose a base branch
from
fix-security-data-leakage-logging-246991289367186616
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| export function logError(message: string, error?: any, debug?: boolean) { | ||
| const isDebug = debug || process.env.DEBUG === 'true' || process.env.DEBUG === '1'; | ||
|
|
||
| console.error(message); | ||
|
|
||
| if (isDebug && error) { | ||
| if (error.message) { | ||
| console.error(`Debug info: ${error.message}`); | ||
| } | ||
| if (error.stack) { | ||
| console.error(error.stack); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current implementation for logging debug information can be improved. It may not log anything for non-
Errorobjects (like strings), and it produces redundant output forErrorobjects sinceerror.stackusually includeserror.message.To make the debug logging more robust and concise, I suggest prioritizing
error.stack, then falling back toerror.message, and finally logging the raw error object if neither is available. This ensures all error types are handled and avoids duplicate information.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jules
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi! I see you mentioned me on the
logErrorimplementation. I've designed this function to hide detailed error information (like internal messages and stack traces) from the standard output by default.Detailed info is only logged if the user explicitly opts in via the
-d/--debugflag or theDEBUGenvironment variable. This ensures that sensitive data isn't accidentally leaked during normal operation, fulfilling the security requirement while maintaining a path for troubleshooting.If you'd like me to redirect these debug logs to a local log file instead of
stderr, please let me know and I'll be happy to make that change!