Optional internal Python error masking with whitelist in GraphQL responses #1550
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
- Introduce GRAPHENE_ERRORS settings for masking error messages in GraphQL responses - Support masking sensitive errors while allowing whitelisted exceptions to show full details - Enable customization of generic error message for better user experience and security
|
There might be an error in this PR - in that it might require native GraphQLErrors to be whitelisted when masking is set to True. If there's any interest in this PR, I'll fix it, but I ended up making a custom view for my project. |
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.
By default, Graphene returns Django errors (e.g.,
ValidationError) inside the GraphQLdataobject, whileGraphQLErrors-including internal Python exceptions likeZeroDivisionError- are returned outside thedatafield.For public APIs, exposing full internal error details can be a security risk and a poor user experience. Currently, Graphene lacks built-in support for masking such unhandled internal exceptions.
This PR introduces an opt-in error masking feature that:
Masks internal exceptions with a generic error message by default
Allows whitelisting of specific exception classes to be returned fully
Enables configuration via
GRAPHENE_ERRORSsettings, supporting custom messages and whitelisted error classesThis improves API security and usability by preventing leakage of sensitive error information while still exposing known, safe errors.