Skip to content

Commit

Permalink
Improve legibility of JSON-encoded Interactivity API store data.
Browse files Browse the repository at this point in the history 
The Interactivity API has been rendering client data in a SCRIPT element with the
type `application/json` so that it's not executed as a script, but is available
to one. The data runs through `wp_json_encode()` and is encoded with some flags
to ensure that potentially-dangerous characters are escaped.

However, this can lead to some challenges. Eagerly escaping when not necessary
can make the data difficult to comprehend when reading the output HTML. For example,
all non-ASCII Unicode characters are escaped with their code point equivalent.
This results in `\ud83c\udd70` instead of `🅰`.

In this patch, the flags for JSON encoding are refined to ensure what's necessary
while relaxing other rules (leaving in those Unicode characters if the blog charset
is UTF-8). This makes for Interactivity API data that's quicker as a human reader
to decipher and diagnose.

In summary:

 - This data is JSON encoded and printed in a `<script type="application/json">` tag.

 - If we ensure that `<` is never printed inside the data, it should be impossible to
   break out of the script tag and the browser treats everything as the element's `textContent`.

 - All other escaping becomes unnecessary at that point, including unicode escaping 
   if the page uses the UTF-8 charset (the same encoding as JSON).

See #6433 (review)

Developed in #6520
Discussed in https://core.trac.wordpress.org/ticket/61170

Fixes: #61170
Follow-up to: [57563].
Props: bjorsch, dmsnell, jonsurrell, sabernhardt, westonruter.


git-svn-id: https://develop.svn.wordpress.org/trunk@58159 602fd350-edb4-49c9-b593-d223f7449a82
  • Loading branch information
@dmsnell
dmsnell committed May 15, 2024
1 parent 3d0a228 commit 13d5244
Show file tree
Hide file tree
Showing 2 changed files with 96 additions and 7 deletions.
33 changes: 32 additions & 1 deletion src/wp-includes/interactivity-api/class-wp-interactivity-api.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,41 @@ public function print_client_interactivity_data() {
}

if ( ! empty( $interactivity_data ) ) {
/*
* This data will be printed as JSON inside a script tag like this:
* <script type="application/json"></script>
*
* A script tag must be closed by a sequence beginning with `</`. It's impossible to
* close a script tag without using `<`. We ensure that `<` is escaped and `/` can
* remain unescaped, so `</script>` will be printed as `\u003C/script\u00E3`.
*
* - JSON_HEX_TAG: All < and > are converted to \u003C and \u003E.
* - JSON_UNESCAPED_SLASHES: Don't escape /.
*
* If the page will use UTF-8 encoding, it's safe to print unescaped unicode:
*
* - JSON_UNESCAPED_UNICODE: Encode multibyte Unicode characters literally (instead of as `\uXXXX`).
* - JSON_UNESCAPED_LINE_TERMINATORS: The line terminators are kept unescaped when
* JSON_UNESCAPED_UNICODE is supplied. It uses the same behaviour as it was
* before PHP 7.1 without this constant. Available as of PHP 7.1.0.
*
* The JSON specification requires encoding in UTF-8, so if the generated HTML page
* is not encoded in UTF-8 then it's not safe to include those literals. They must
* be escaped to avoid encoding issues.
*
* @see https://www.rfc-editor.org/rfc/rfc8259.html for details on encoding requirements.
* @see https://www.php.net/manual/en/json.constants.php for details on these constants.
* @see https://html.spec.whatwg.org/#script-data-state for details on script tag parsing.
*/
$json_encode_flags = JSON_HEX_TAG | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_LINE_TERMINATORS;
if ( ! is_utf8_charset() ) {
$json_encode_flags = JSON_HEX_TAG | JSON_UNESCAPED_SLASHES;
}

wp_print_inline_script_tag(
wp_json_encode(
$interactivity_data,
JSON_HEX_TAG | JSON_HEX_AMP
$json_encode_flags
),
array(
'type' => 'application/json',
Expand Down
70 changes: 64 additions & 6 deletions tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ public function set_up() {
$this->interactivity = new WP_Interactivity_API();
}

public function charset_iso_8859_1() {
return 'iso-8859-1';
}

/**
* Tests that the state and config methods return an empty array at the
* beginning.
Expand Down Expand Up @@ -349,22 +353,76 @@ public function test_config_printed_correctly_with_nested_empty_array() {
* properly escaped.
*
* @ticket 60356
* @ticket 61170
*
* @covers ::state
* @covers ::config
* @covers ::print_client_interactivity_data
*/
public function test_state_and_config_escape_special_characters() {
$this->interactivity->state( 'myPlugin', array( 'amps' => 'http://site.test/?foo=1&baz=2' ) );
$this->interactivity->config( 'myPlugin', array( 'tags' => 'Tags: <!-- <script>' ) );
$this->interactivity->state(
'myPlugin',
array(
'ampersand' => '&',
'less-than sign' => '<',
'greater-than sign' => '>',
'solidus' => '/',
'line separator' => "\u{2028}",
'paragraph separator' => "\u{2029}",
'flag of england' => "\u{1F3F4}\u{E0067}\u{E0062}\u{E0065}\u{E006E}\u{E0067}\u{E007F}",
'malicious script closer' => '</script>',
'entity-encoded malicious script closer' => '&lt;/script&gt;',
)
);
$this->interactivity->config( 'myPlugin', array( 'chars' => '&<>/' ) );

$interactivity_data_markup = get_echo( array( $this->interactivity, 'print_client_interactivity_data' ) );
preg_match( '/<script type="application\/json" id="wp-interactivity-data">.*?(\{.*\}).*?<\/script>/s', $interactivity_data_markup, $interactivity_data_string );
preg_match( '~<script type="application/json" id="wp-interactivity-data">\s*(\{.*\})\s*</script>~s', $interactivity_data_markup, $interactivity_data_string );

$this->assertEquals(
'{"config":{"myPlugin":{"tags":"Tags: \u003C!-- \u003Cscript\u003E"}},"state":{"myPlugin":{"amps":"http:\/\/site.test\/?foo=1\u0026baz=2"}}}',
$interactivity_data_string[1]
$expected = <<<"JSON"
{"config":{"myPlugin":{"chars":"&\\u003C\\u003E/"}},"state":{"myPlugin":{"ampersand":"&","less-than sign":"\\u003C","greater-than sign":"\\u003E","solidus":"/","line separator":"\u{2028}","paragraph separator":"\u{2029}","flag of england":"\u{1F3F4}\u{E0067}\u{E0062}\u{E0065}\u{E006E}\u{E0067}\u{E007F}","malicious script closer":"\\u003C/script\\u003E","entity-encoded malicious script closer":"&lt;/script&gt;"}}}
JSON;
$this->assertEquals( $expected, $interactivity_data_string[1] );
}

/**
* Tests that special characters in the initial state and configuration are
* properly escaped when the blog_charset is not UTF-8 (unicode compatible).
*
* This this test, unicode and line terminators should be escaped to their
* JSON unicode sequences.
*
* @ticket 61170
*
* @covers ::state
* @covers ::config
* @covers ::print_client_interactivity_data
*/
public function test_state_and_config_escape_special_characters_non_utf8() {
add_filter( 'pre_option_blog_charset', array( $this, 'charset_iso_8859_1' ) );
$this->interactivity->state(
'myPlugin',
array(
'ampersand' => '&',
'less-than sign' => '<',
'greater-than sign' => '>',
'solidus' => '/',
'line separator' => "\u{2028}",
'paragraph separator' => "\u{2029}",
'flag of england' => "\u{1F3F4}\u{E0067}\u{E0062}\u{E0065}\u{E006E}\u{E0067}\u{E007F}",
'malicious script closer' => '</script>',
'entity-encoded malicious script closer' => '&lt;/script&gt;',
)
);
$this->interactivity->config( 'myPlugin', array( 'chars' => '&<>/' ) );

$interactivity_data_markup = get_echo( array( $this->interactivity, 'print_client_interactivity_data' ) );
preg_match( '~<script type="application/json" id="wp-interactivity-data">\s*(\{.*\})\s*</script>~s', $interactivity_data_markup, $interactivity_data_string );

$expected = <<<"JSON"
{"config":{"myPlugin":{"chars":"&\\u003C\\u003E/"}},"state":{"myPlugin":{"ampersand":"&","less-than sign":"\\u003C","greater-than sign":"\\u003E","solidus":"/","line separator":"\\u2028","paragraph separator":"\\u2029","flag of england":"\\ud83c\\udff4\\udb40\\udc67\\udb40\\udc62\\udb40\\udc65\\udb40\\udc6e\\udb40\\udc67\\udb40\\udc7f","malicious script closer":"\\u003C/script\\u003E","entity-encoded malicious script closer":"&lt;/script&gt;"}}}
JSON;
$this->assertEquals( $expected, $interactivity_data_string[1] );
}

/**
Expand Down

0 comments on commit 13d5244

Please sign in to comment.