fix: Unescape HTML entities for alternate DOMPurify check #2630
Conversation
This file contains 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
|
Removed vultr server and associated DNS entries |
DafyddLlyr
force-pushed
the
dp/dompurify-character-conversion
branch
from
07715d5 to
18d0f05
Compare
DafyddLlyr
changed the title
DafyddLlyr
commented
Jan 4, 2024
| const logUncleanHTMLError = (input: string, cleanHTML: string) => { | ||
| const userId = userContext.getStore()?.user.sub; | ||
|
|
||
| console.error({ |
There was a problem hiding this comment.
I think this should be fine, I'll check on staging. We might need to use the logger.notify() method Ben wrote if this doesn't get caught by Airbrake.
DafyddLlyr
commented
Jan 4, 2024
| }); | ||
| }; | ||
|
|
||
| const unescapeHTML = (input: string): string => |
There was a problem hiding this comment.
I tested a number of other HTML entities and these were the only one which were getting caught.
Tiptap is converting the quotation marks, and DOMPurify appears to be converting all HTML entities apart from .
jessicamcinchak
approved these changes
Jan 4, 2024
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.
What's the problem?
Originally picked up here - https://opensystemslab.slack.com/archives/C01E3AC0C03/p1703175603781519 (OSL Slack)
A permission error is thrown when attempting to copy some flows from the "Templates" team, despite the users in question having the requisite permission level.
What's the cause?
The logged error is misleading, it's actually an input validation error that's being thrown - the try/catch block just didn't account for this.
What's happening here is that the simple
length === lengthcheck for DOMPurify is not accounting for HTML entities (see screenshot below).There isn't a simple alternative way of checking that DOMPurify has modified content unfortunately. We can't check string equality directly as the order of HTML attributes in sanitised content can differ from the original (and there's not a method of preserving this). Please see comment from DOMPurify readme below on checking for removed attributes directly -
Source: https://github.com/cure53/DOMPurify?tab=readme-ov-file#okay-makes-sense-lets-move-on
What's the solution?
Check length, and then unescape known HTML entities which are converted, and re-check. I'll be honest this doesn't feel ideal but it's the best / simplest solution I've reached.
I'm throwing noisy errors here so that we can more easily spot any more issues going forward.