✨ feat(clean): report what the sanitizer dropped#557
Merged
Conversation
A caller tuning a sanitizer policy could see only the cleaned string, never which tags or attributes the policy removed, so narrowing or widening an allowlist was guesswork. bleach, nh3, and html-sanitizer expose no such report; DOMPurify does, through DOMPurify.removed. sanitize_report() returns the cleaned HTML paired with one Removed record per dropped element or stripped attribute, in the order the walk reached them. The C walk appends each drop to a caller-owned list only when reporting is on, so the plain sanitize() path adds nothing but a NULL check. Closes tox-dev#528
6328d5d to
6c680ad
Compare
Merging this PR will not alter performance
Performance Changes
Comparing Footnotes
|
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
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.
A caller tuning a sanitizer policy could see only the cleaned string, never which tags or attributes the policy removed, so narrowing or widening an allowlist meant guessing. bleach,
nh3, andhtml-sanitizerexpose no such report; DOMPurify does, throughDOMPurify.removed. 🔍sanitize_report()(andSanitizer.sanitize_report()) return the cleaned HTML paired with oneRemovedrecord per dropped element or stripped attribute, in the order the walk reached them:Removed(tag="a", attribute="onclick")for a stripped attribute,Removed(tag="script", attribute=None)for a removed, stripped, or escaped element. Clean input gives an empty list.The audit runs inside the existing C walk. Each drop appends to a caller-owned list only when reporting is on, so the plain
sanitize()path pays oneNULLcheck and nothing else. Asanitize-reportbenchmark gates the reporting path under CodSpeed.Closes #528