<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56096] trunk: REST API: Expose current $request object to cors_header filters in WP_REST_SERVER->serve_request().</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56096">56096</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56096","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>kadamwhite</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-06-28 17:37:52 +0000 (Wed, 28 Jun 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>REST API: Expose current $request object to cors_header filters in WP_REST_SERVER->serve_request().
Allows headers to be more easily set on a per-response basis when more or less security is needed on a specific route.
Props bor0, rachelbaker, spacedmonkey, chaion07, oglekler, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/57752">#57752</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiclasswprestserverphp">trunk/src/wp-includes/rest-api/class-wp-rest-server.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestserverphp">trunk/tests/phpunit/tests/rest-api/rest-server.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiclasswprestserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/class-wp-rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2023-06-28 17:24:36 UTC (rev 56095)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2023-06-28 17:37:52 UTC (rev 56096)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -321,44 +321,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * https://miki.it/blog/2014/7/8/abusing-jsonp-with-rosetta-flash/
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $this->send_header( 'X-Content-Type-Options', 'nosniff' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $expose_headers = array( 'X-WP-Total', 'X-WP-TotalPages', 'Link' );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the list of response headers that are exposed to REST API CORS requests.
- *
- * @since 5.5.0
- *
- * @param string[] $expose_headers The list of response headers to expose.
- */
- $expose_headers = apply_filters( 'rest_exposed_cors_headers', $expose_headers );
-
- $this->send_header( 'Access-Control-Expose-Headers', implode( ', ', $expose_headers ) );
-
- $allow_headers = array(
- 'Authorization',
- 'X-WP-Nonce',
- 'Content-Disposition',
- 'Content-MD5',
- 'Content-Type',
- );
-
- /**
- * Filters the list of request headers that are allowed for REST API CORS requests.
- *
- * The allowed headers are passed to the browser to specify which
- * headers can be passed to the REST API. By default, we allow the
- * Content-* headers needed to upload files to the media endpoints.
- * As well as the Authorization and Nonce headers for allowing authentication.
- *
- * @since 5.5.0
- *
- * @param string[] $allow_headers The list of request headers to allow.
- */
- $allow_headers = apply_filters( 'rest_allowed_cors_headers', $allow_headers );
-
- $this->send_header( 'Access-Control-Allow-Headers', implode( ', ', $allow_headers ) );
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * Filters whether to send nocache headers on a REST API request.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -436,6 +400,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_method( $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $expose_headers = array( 'X-WP-Total', 'X-WP-TotalPages', 'Link' );
+
+ /**
+ * Filters the list of response headers that are exposed to REST API CORS requests.
+ *
+ * @since 5.5.0
+ *
+ * @param string[] $expose_headers The list of response headers to expose.
+ * @param WP_REST_Request The request in context.
+ */
+ $expose_headers = apply_filters( 'rest_exposed_cors_headers', $expose_headers, $request );
+
+ $this->send_header( 'Access-Control-Expose-Headers', implode( ', ', $expose_headers ) );
+
+ $allow_headers = array(
+ 'Authorization',
+ 'X-WP-Nonce',
+ 'Content-Disposition',
+ 'Content-MD5',
+ 'Content-Type',
+ );
+
+ /**
+ * Filters the list of request headers that are allowed for REST API CORS requests.
+ *
+ * The allowed headers are passed to the browser to specify which
+ * headers can be passed to the REST API. By default, we allow the
+ * Content-* headers needed to upload files to the media endpoints.
+ * As well as the Authorization and Nonce headers for allowing authentication.
+ *
+ * @since 5.5.0
+ *
+ * @param string[] $allow_headers The list of request headers to allow.
+ * @param WP_REST_Request The request in context.
+ */
+ $allow_headers = apply_filters( 'rest_allowed_cors_headers', $allow_headers, $request );
+
+ $this->send_header( 'Access-Control-Allow-Headers', implode( ', ', $allow_headers ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $result = $this->check_authentication();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_wp_error( $result ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-server.php 2023-06-28 17:24:36 UTC (rev 56095)
+++ trunk/tests/phpunit/tests/rest-api/rest-server.php 2023-06-28 17:37:52 UTC (rev 56096)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2200,6 +2200,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 500, rest_get_server()->status );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 57752
+ */
+ public function test_rest_exposed_cors_headers_filter_receives_request_object() {
+ $mock_hook = new MockAction();
+ add_filter( 'rest_exposed_cors_headers', array( $mock_hook, 'filter' ), 10, 2 );
+
+ rest_get_server()->serve_request( '/test-exposed-cors-headers' );
+
+ $this->assertCount( 1, $mock_hook->get_events() );
+ $this->assertCount( 2, $mock_hook->get_events()[0]['args'] );
+ $this->assertInstanceOf( 'WP_REST_Request', $mock_hook->get_events()[0]['args'][1] );
+ $this->assertSame( '/test-exposed-cors-headers', $mock_hook->get_events()[0]['args'][1]->get_route() );
+ }
+
+ /**
+ * @ticket 57752
+ */
+ public function test_rest_allowed_cors_headers_filter_receives_request_object() {
+ $mock_hook = new MockAction();
+ add_filter( 'rest_allowed_cors_headers', array( $mock_hook, 'filter' ), 10, 2 );
+
+ rest_get_server()->serve_request( '/test-allowed-cors-headers' );
+
+ $this->assertCount( 1, $mock_hook->get_events() );
+ $this->assertCount( 2, $mock_hook->get_events()[0]['args'] );
+ $this->assertInstanceOf( 'WP_REST_Request', $mock_hook->get_events()[0]['args'][1] );
+ $this->assertSame( '/test-allowed-cors-headers', $mock_hook->get_events()[0]['args'][1]->get_route() );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function _validate_as_integer_123( $value, $request, $key ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_int( $value ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'some-error', 'This is not valid!' );
</span></span></pre>
</div>
</div>
</body>
</html>