-
Notifications
You must be signed in to change notification settings - Fork 100
Disable Html.Attributes.srcdoc #281
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
lydell
wants to merge
1
commit into
elm:master
Choose a base branch
from
lydell:iframe-security-fix-2
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # iframe srcdoc security | ||
|
|
||
| There used to be an `Html.Attributes.srcdoc` function. Well, there technically still is one, but all it does is take you here. As it turns out, `srcdoc` on an iframes is a security issue. It allows Elm packages to execute JavaScript code without you knowing. Maybe you thought you were rendering an icon from a package, but behind the scenes it also stole all data on your page. Oops! | ||
|
|
||
| If you have code like this: | ||
|
|
||
| ```elm | ||
| Html.iframe [ Html.Attributes.srcdoc myHtml ] [] | ||
| ``` | ||
|
|
||
| Then you can change it to a web component: | ||
|
|
||
| ```elm | ||
| Html.node "my-iframe" [ Html.Attributes.attribute "html" myHtml ] [] | ||
| ``` | ||
|
|
||
| ```js | ||
| /** | ||
| * This custom element forwards the `html` attribute to `srcdoc` on an `iframe`. | ||
| * | ||
| * Example: | ||
| * | ||
| * <my-iframe html="<p>Hello</p>"></my-iframe> | ||
| * | ||
| * Becomes: | ||
| * | ||
| * <my-iframe html="<p>Hello</p>"> | ||
| * <iframe srcdoc="<p>Hello</p>" sandbox=""></iframe> | ||
| * </my-iframe> | ||
| */ | ||
| customElements.define( | ||
| 'my-iframe', | ||
| class extends HTMLElement { | ||
| iframe = document.createElement('iframe'); | ||
|
|
||
| connectedCallback() { | ||
| // It's important to set `sandbox` on iframes for security. | ||
| // https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe#sandbox | ||
| this.iframe.sandbox = ''; | ||
| this.appendChild(this.iframe); | ||
| } | ||
|
|
||
| // Note: You can't call the attribute `srcdoc` even on the custom element. | ||
| // For simplicity, Elm forbids that name regardless of element. | ||
| // Simply choose another name. | ||
| static observedAttributes = ['html']; | ||
|
|
||
| attributeChangedCallback(name, _oldValue, newValue) { | ||
| switch (name) { | ||
| case 'html': | ||
| if (newValue === null) { | ||
| this.iframe.removeAttribute('srcdoc'); | ||
| } else { | ||
| this.iframe.setAttribute('srcdoc', newValue); | ||
| } | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| ); | ||
| ``` | ||
|
|
||
| Why is a web component safer than using an iframe directly? The difference is that an Elm package can't ship the JavaScript web component definition, only the Elm code that tries to render it. And with the web component, you can guarantee that the `sandbox` attribute is set _before_ `srcdoc`. |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This wording is inspired by elm/virtual-dom:
https://github.com/elm/virtual-dom/blob/faa43820c372b1a3077582887971686f7ba1474d/src/Elm/Kernel/VirtualDom.js#L309-L321
Note that in the linked code, the message does not appear in
--optimizemode. I don’t think it’s worth the effort doing the same here, since nobody will useHtml.Attributes.srcdocin production, since it no longer does anything useful.