Avoid usage of html_safe #305
Merged
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
thomasleese
approved these changes
May 11, 2018
sihugh
reviewed
May 11, 2018
| it "doesn't use `html_safe`" do | ||
| files_with_html_safe = `grep -rni "html_safe" app/views/govuk_publishing_components/components`.lines | ||
|
|
||
| expect(files_with_html_safe).to be_empty |
sihugh
requested changes
May 11, 2018
There was a problem hiding this comment.
It needs a rebase to resolve the conflict in CHANGELOG.md. If you're doing that, could you fix the link to http://api.rubyonrails.org/classes/ActionView/Helpers/OutputSafetyHelper.html in the commit message for the to_sentence view helper? It's wrapped over two lines and confused me for a second when I followed it and it didn't work.
Looks great otherwise 👍
The `to_sentence` helper knows about safe and unsafe HTML and will escape the unsafe input and not safe input like `hidden_links`. See: http://api.rubyonrails.org/classes/ActionView/Helpers/OutputSafetyHelper.html#method-i-to_sentence
This means the application will have to call `html_safe` on the thing itself. This seems to only be used by the `frontend` application.
Now that we've removed all `html_safe` from the components we can add a test to make sure we don't add it back.
sihugh
approved these changes
May 11, 2018
Merged
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.
This is a follow up to an incident last month where we found a XSS vulnerability caused by
html_safebeing called on untrusted user input (see alphagov/finder-frontend#480 and follow ups).To avoid recurrence, this PR makes sure that 1) we're never calling
html_safeso that everything is escaped by default, 2) we can't use it anymore. This makes escaping and callinghtml_safethe exclusive responsibility of the application.See the individual commits for details.