fix(security): wire Trusted Types into the framework's HTML sinks - #191
Merged
Conversation
createTrustedHtml/getTrustedTypesPolicy existed but no DOM-write path called them, so under an enforced require-trusted-types-for 'script' CSP every innerHTML/insertAdjacentHTML assignment threw (framework broken), and the documented 'Trusted Types / CSP compliance' property was absent. Added trustedHtmlForSink(rawHtml): returns a TrustedHTML when a policy is active, otherwise the sanitized string, sanitizing exactly once. Routed all sanitized sinks through it — setHtml/createElementFromHtml/ insertContent (core/dom), Collection.html/insertAll (core/collection), bq-html (sanitized branch) and bq-html-safe (view directives). The explicit htmlUnsafe / sanitize:false escape hatches are left as raw writes. Corrected the sanitizeHtml JSDoc to describe the actual behavior. Fixes #171 Co-Authored-By: Claude Fable 5 <[email protected]>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
core
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
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.
Summary
Fixes #171 (Medium).
createTrustedHtml/getTrustedTypesPolicyexisted but no DOM-write path called them — they were only re-exported. So under an enforcedrequire-trusted-types-for 'script'CSP, everyinnerHTML =/insertAdjacentHTMLindom.ts/collection.ts/element.ts/directives threw (framework fails closed but non-functional), and the documented "Trusted Types / CSP compliance" property was simply absent.Fix
New
trustedHtmlForSink(rawHtml)insecurity/trusted-types.ts: returns aTrustedHTMLwhen a policy is active (so the write satisfies enforced TT), otherwise the sanitized string — sanitizing exactly once. All sanitized sinks now route through it:core/dom.ts:setHtml,createElementFromHtml,insertContentcore/collection.ts:Collection.html(),insertAll()view/directives:bq-html(sanitized branch),bq-html-safeelement.tshtml()inherits it viasetHtmlThe explicit
htmlUnsafe()/sanitize: falseescape hatches are deliberately left as raw writes (bypassing sanitization is their documented purpose). ThesanitizeHtmlJSDoc is corrected to describe actual behavior (returns a branded string; the framework's sinks wrap it for TT).Verification
trustedHtmlForSinkinvokespolicy.createHTMLand returns the brandedTrustedHTML.tsc --noEmit+ eslint clean.🤖 Generated with Claude Code