Fix CodeQL 'Information exposure through an exception' issues #928
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
Signed-off-by: Steve Scargall <37674041+sscargal@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses 5 CodeQL security vulnerabilities related to information exposure through exception messages. The changes prevent potentially sensitive exception details from being leaked to API consumers by replacing direct exception string interpolation with a centralized error formatting function that returns sanitized, user-friendly error messages.
Key Changes:
- Introduced a
format_error_response()helper function to standardize error handling - Replaced direct exception exposure in all exception handlers with calls to the new helper
- Maintained appropriate logging while preventing information leakage to end users
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Steve Scargall <37674041+sscargal@users.noreply.github.com>
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.
Purpose of the change
This addresses the 5 CodeQL "Information exposure through an exception" issues.
Description
GitHub CodeQL highlighted some potential security issues relating to the examples/v1/writing_assistant/writing_assistant_server.py file:
The resolution is to remove all occurrences of
{e!s}and replace it with a more human-friendly message. Rather than generic messages, we can still include useful information from the exception without displaying the full data or stack by introducing a newformat_error_response()function to process the exception and return relevant information only.Fixes/Closes
Fixes CodeQL issues 39, 40, 41, 42, & 43.
Type of change
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
Checklist
Maintainer Checklist
Screenshots/Gifs
See above
Further comments
None