Forms api - Mask all potential PII from error message #12471
Merged
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.
Following up on a recent incident where a JSON::ParserError displayed some PII when parsing an invalid payload - this surrounds the entire forms_api functionality, catches any errors, and raises them with every word entered by the user scrubbed from the message.
Summary
rescue
block to controller methodrescue
block, parse all values from the input and remove them from the error messageRelated issue(s)
Testing done
Screenshots
Test payload example
BEFORE:
AFTER:
In the scrubbed example we still get the failed JSON blob's structure, and we can see some newlines, which were the cause of our issue. This is related to the issue we fixed that caused the PII dump.
What areas of the site does it impact?
All forms using the forms_api (currently only 26-4555)
Acceptance criteria
Requested Feedback
Is there a better way you would suggest catching/raising this error? I noticed the
Common::Exceptions::etc.
error patterns but did not have success implementing them, and this is meant to catch any error type.