Uh oh!
There was an error while loading. Please reload this page.
[6.x] Add safe option to to_json for HTML-embedded JSON - #15260
Merged
Conversation
Bare json_encode omits JSON_HEX_TAG, so CMS strings with </script> can break out of script elements. Opt-in :safe matches Laravel @JSON without changing default to_json output.
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
Summary
Bare
json_encodeoutput (whatto_jsonuses today) can allow strings containing</script>to break out of HTML<script>elements, includingapplication/ld+json. Laravel’s@json/Js::from()already apply the JSON HEX flags; Antlers had no equivalent.This adds an opt-in
safeparameter so existingto_jsonoutput stays unchanged:{{ value | to_json:safe }}{{ value | to_json:pretty:safe }}or{{ value | to_json:safe:pretty }}When
safeis present, encoding usesJSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT.Modifier docs live in the separate docs repo and need a follow-up update.
Test plan
to_json/to_json:prettyoutput unchangedto_json:safehex-encodes HTML-sensitive characters and does not contain raw</script>json_decodes back to the original valueprettyandsafework together in either param order