<!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>[49380] trunk: XML-RPC: Improve error messages for unprivileged users.</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/49380">49380</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/49380","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-10-29 17:42:13 +0000 (Thu, 29 Oct 2020)</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'>XML-RPC: Improve error messages for unprivileged users.
Add specific permission checks to avoid ambiguous failure messages.
Props zieladam, peterwilsoncc, xknown, whyisjake.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpxmlrpcserverphp">trunk/src/wp-includes/class-wp-xmlrpc-server.php</a></li>
<li><a href="#trunktestsphpunittestsxmlrpcwpnewCommentphp">trunk/tests/phpunit/tests/xmlrpc/wp/newComment.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpxmlrpcserverphp"></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/class-wp-xmlrpc-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-xmlrpc-server.php 2020-10-29 17:33:43 UTC (rev 49379)
+++ trunk/src/wp-includes/class-wp-xmlrpc-server.php 2020-10-29 17:42:13 UTC (rev 49380)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3876,6 +3876,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return new IXR_Error( 403, __( 'Sorry, comments are closed for this item.' ) );
</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">+ if (
+ 'publish' === get_post_status( $post_id ) &&
+ ! current_user_can( 'edit_post', $post_id ) &&
+ post_password_required( $post_id )
+ ) {
+ return new IXR_Error( 403, __( 'Sorry, you are not allowed to comment on this post.' ) );
+ }
+
+ if (
+ 'private' === get_post_status( $post_id ) &&
+ ! current_user_can( 'read_post', $post_id )
+ ) {
+ return new IXR_Error( 403, __( 'Sorry, you are not allowed to comment on this post.' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $comment = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_post_ID' => $post_id,
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_content' => trim( $content_struct['content'] ),
</span></span></pre></div>
<a id="trunktestsphpunittestsxmlrpcwpnewCommentphp"></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/xmlrpc/wp/newComment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/xmlrpc/wp/newComment.php 2020-10-29 17:33:43 UTC (rev 49379)
+++ trunk/tests/phpunit/tests/xmlrpc/wp/newComment.php 2020-10-29 17:42:13 UTC (rev 49380)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,15 +6,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_XMLRPC_wp_newComment extends WP_XMLRPC_UnitTestCase {
</span><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">- * Post object for shared fixture.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Array of posts.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @var WP_Post
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @var WP_Post[]
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static $post;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static $posts;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * User IDs.
+ *
+ * Array of user IDs keyed by role.
+ *
+ * @var int[]
+ */
+ public static $user_ids;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public static function wpSetUpBeforeClass( $factory ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::make_user_by_role( 'administrator' );
- self::$post = $factory->post->create_and_get();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$user_ids = array(
+ 'administrator' => self::make_user_by_role( 'administrator' ),
+ 'contributor' => self::make_user_by_role( 'contributor' ),
+ );
+ self::$posts['publish'] = $factory->post->create_and_get();
+ self::$posts['password'] = $factory->post->create_and_get(
+ array(
+ 'post_password' => 'xmlrpc',
+ 'post_author' => self::$user_ids['administrator'],
+ )
+ );
+ self::$posts['private'] = $factory->post->create_and_get(
+ array(
+ 'post_status' => 'private',
+ 'post_author' => self::$user_ids['administrator'],
+ )
+ );
+ self::$posts['private_contributor'] = $factory->post->create_and_get(
+ array(
+ 'post_status' => 'private',
+ 'post_author' => self::$user_ids['contributor'],
+ )
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_valid_comment() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,7 +53,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::$post->ID,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$posts['publish']->ID,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => rand_str( 100 ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,7 +69,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::$post->ID,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$posts['publish']->ID,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,7 +89,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::$post->ID,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$posts['publish']->ID,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => ' ',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,7 +109,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::$post->ID,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$posts['publish']->ID,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => '0',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,7 +129,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::$post->ID,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$posts['publish']->ID,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => ' ',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -139,7 +169,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::$post->ID,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$posts['publish']->ID,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => rand_str( 100 ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -168,7 +198,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><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">- self::$post->ID,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$posts['publish']->ID,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'author' => 'WordPress',
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_email' => 'noreply@wordpress.org',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -193,7 +223,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><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">- self::$post->ID,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$posts['publish']->ID,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'author' => 'WordPress',
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_email' => 'noreply at wordpress.org',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -218,7 +248,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><span class="cx" style="display: block; padding: 0 10px"> 'administrator',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::$post->ID,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$posts['publish']->ID,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'author' => 'WordPress',
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_email' => 'noreply at wordpress.org',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -232,4 +262,131 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $user_id, (int) $comment->user_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Ensure users can only comment on posts they're permitted to access.
+ *
+ * @dataProvider data_comments_observe_post_permissions
+ *
+ * @param string $post_key Post identifier from the self::$posts array.
+ * @param string $username Username leaving comment.
+ * @param bool $expected Expected result. True: successfull comment. False: Refused comment.
+ * @param string $anon_callback Optional. Allow anonymous comment callback. Default __return_false.
+ */
+ function test_comments_observe_post_permissions( $post_key, $username, $expected, $anon_callback = '__return_false' ) {
+ add_filter( 'xmlrpc_allow_anonymous_comments', $anon_callback );
+
+ $comment_args = array(
+ 1,
+ $username,
+ $username,
+ self::$posts[ $post_key ]->ID,
+ array(
+ 'author' => 'WordPress',
+ 'author_email' => 'noreply@wordpress.org',
+ 'content' => 'Test Comment',
+ ),
+ );
+
+ $result = $this->myxmlrpcserver->wp_newComment( $comment_args );
+ if ( $expected ) {
+ $this->assertInternalType( 'int', $result );
+ return;
+ }
+
+ $this->assertIXRError( $result );
+ $this->assertSame( 403, $result->code );
+ }
+
+ /**
+ * Data provider for test_comments_observe_post_permissions.
+ *
+ * @return array[] {
+ * @type string Post identifier from the self::$posts array.
+ * @type string Username leaving comment.
+ * @type bool Expected result. True: successfull comment. False: Refused comment.
+ * @type string Optional. Allow anonymous comment callback. Default __return_false.
+ * }
+ */
+ function data_comments_observe_post_permissions() {
+ return array(
+ // 0: Post author, password protected public post.
+ array(
+ 'password',
+ 'administrator',
+ true,
+ ),
+ // 1: Low privileged non-author, password protected public post.
+ array(
+ 'password',
+ 'contributor',
+ false,
+ ),
+ // 2: Anonymous user, password protected public post.
+ array(
+ 'password',
+ '', // Anonymous user.
+ false,
+ ),
+ // 3: Anonymous user, anon comments allowed, password protected public post.
+ array(
+ 'password',
+ '', // Anonymous user.
+ false,
+ '__return_true',
+ ),
+
+ // 4: Post author, private post.
+ array(
+ 'private',
+ 'administrator',
+ true,
+ ),
+ // 5: Low privileged non-author, private post.
+ array(
+ 'private',
+ 'contributor',
+ false,
+ ),
+ // 6: Anonymous user, private post.
+ array(
+ 'private',
+ '', // Anonymous user.
+ false,
+ ),
+ // 7: Anonymous user, anon comments allowed, private post.
+ array(
+ 'private',
+ '', // Anonymous user.
+ false,
+ '__return_true',
+ ),
+
+ // 8: High privileged non-author, private post.
+ array(
+ 'private_contributor',
+ 'administrator',
+ true,
+ ),
+ // 9: Low privileged author, private post.
+ array(
+ 'private_contributor',
+ 'contributor',
+ true,
+ ),
+ // 10: Anonymous user, private post.
+ array(
+ 'private_contributor',
+ '', // Anonymous user.
+ false,
+ ),
+ // 11: Anonymous user, anon comments allowed, private post.
+ array(
+ 'private_contributor',
+ '', // Anonymous user.
+ false,
+ '__return_true',
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>