<!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>[52398] trunk: Application Passwords: Show HTTPS required message without filtering when not enabled or not in local environment.</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/52398">52398</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/52398","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-12-21 02:43:18 +0000 (Tue, 21 Dec 2021)</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'>Application Passwords: Show HTTPS required message without filtering when not enabled or not in local environment.
When `add_filter( 'wp_is_application_passwords_available', '__return_false' )` exists, HTTPS requirement message is shown even if HTTPS is enabled on the site. This happens because `wp_is_application_passwords_available_for_user()` first invokes `wp_is_application_passwords_available()` which is filterable. The situation could happen if the `'wp_is_application_passwords_available_for_user'` filter returns `false`.
To fix this, the check for HTTPS (or if in a 'local' environment) is moved to a new function called `wp_is_application_passwords_supported()`. Then the return from this function is used as an OR condition for the Application Passwords section and for displaying the HTTPS required message.
Tests are included for both `wp_is_application_passwords_supported()` and `wp_is_application_passwords_available()`.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/51980">[51980]</a>, <a href="https://core.trac.wordpress.org/changeset/51988">[51988]</a>.
Props davidbinda, SergeyBiryukov, ocean90, felipeelia, costdev, hellofromTonya.
Fixes <a href="https://core.trac.wordpress.org/ticket/53658">#53658</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminusereditphp">trunk/src/wp-admin/user-edit.php</a></li>
<li><a href="#trunksrcwpincludesloadphp">trunk/src/wp-includes/load.php</a></li>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestapplicationpasswordscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-application-passwords-controller.php</a></li>
<li><a href="#trunktestsqunitfixtureswpapigeneratedjs">trunk/tests/qunit/fixtures/wp-api-generated.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminusereditphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/user-edit.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/user-edit.php 2021-12-21 00:26:44 UTC (rev 52397)
+++ trunk/src/wp-admin/user-edit.php 2021-12-21 02:43:18 UTC (rev 52398)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -733,6 +733,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> </table>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php if ( wp_is_application_passwords_available_for_user( $user_id ) || ! wp_is_application_passwords_supported() ) : // phpcs:disable Generic.WhiteSpace.ScopeIndent ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> <div class="application-passwords hide-if-no-js" id="application-passwords-section">
</span><span class="cx" style="display: block; padding: 0 10px"> <h2><?php _e( 'Application Passwords' ); ?></h2>
</span><span class="cx" style="display: block; padding: 0 10px"> <p><?php _e( 'Application passwords allow authentication via non-interactive systems, such as XML-RPC or the REST API, without providing your actual password. Application passwords can be easily revoked. They cannot be used for traditional logins to your website.' ); ?></p>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -796,7 +797,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $application_passwords_list_table->display();
</span><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php else : ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php elseif ( ! wp_is_application_passwords_supported() ) : ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> <p><?php _e( 'The application password feature requires HTTPS, which is not enabled on this site.' ); ?></p>
</span><span class="cx" style="display: block; padding: 0 10px"> <p>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -809,6 +810,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </p>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php endif; ?>
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php endif; // phpcs:enable Generic.WhiteSpace.ScopeIndent ?>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> if ( IS_PROFILE_PAGE ) {
</span></span></pre></div>
<a id="trunksrcwpincludesloadphp"></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/load.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/load.php 2021-12-21 00:26:44 UTC (rev 52397)
+++ trunk/src/wp-includes/load.php 2021-12-21 02:43:18 UTC (rev 52398)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -191,7 +191,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_environment_type() {
</span><span class="cx" style="display: block; padding: 0 10px"> static $current_env = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $current_env ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! defined( 'WP_RUN_CORE_TESTS' ) && $current_env ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return $current_env;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesuserphp"></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/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2021-12-21 00:26:44 UTC (rev 52397)
+++ trunk/src/wp-includes/user.php 2021-12-21 02:43:18 UTC (rev 52398)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4658,10 +4658,24 @@
</span><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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if Application Passwords is supported.
+ *
+ * Application Passwords is supported only by sites using SSL or local environments
+ * but may be made available using the {@see 'wp_is_application_passwords_available'} filter.
+ *
+ * @since 5.9.0
+ *
+ * @return bool
+ */
+function wp_is_application_passwords_supported() {
+ return is_ssl() || 'local' === wp_get_environment_type();
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Checks if Application Passwords is globally available.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * By default, Application Passwords is available to all sites using SSL or to local environments.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Use {@see 'wp_is_application_passwords_available'} to adjust its availability.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Use the {@see 'wp_is_application_passwords_available'} filter to adjust its availability.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4668,8 +4682,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_is_application_passwords_available() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $available = is_ssl() || 'local' === wp_get_environment_type();
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether Application Passwords is available.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4677,7 +4689,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $available True if available, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'wp_is_application_passwords_available', $available );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'wp_is_application_passwords_available', wp_is_application_passwords_supported() );
</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"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestapplicationpasswordscontrollerphp"></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-application-passwords-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-application-passwords-controller.php 2021-12-21 00:26:44 UTC (rev 52397)
+++ trunk/tests/phpunit/tests/rest-api/rest-application-passwords-controller.php 2021-12-21 02:43:18 UTC (rev 52398)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -947,6 +947,86 @@
</span><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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 53658
+ *
+ * @covers ::wp_is_application_passwords_supported
+ */
+ public function test_wp_is_application_passwords_supported_with_https_only() {
+ $_SERVER['HTTPS'] = 'on';
+ $this->assertTrue( wp_is_application_passwords_supported() );
+ }
+
+ /**
+ * @ticket 53658
+ *
+ * @covers ::wp_is_application_passwords_supported
+ */
+ public function test_wp_is_application_passwords_supported_with_local_environment_only() {
+ putenv( 'WP_ENVIRONMENT_TYPE=local' );
+
+ $actual = wp_is_application_passwords_supported();
+
+ // Revert to default behaviour so that other tests are not affected.
+ putenv( 'WP_ENVIRONMENT_TYPE' );
+
+ $this->assertTrue( $actual );
+ }
+
+ /**
+ * @dataProvider data_wp_is_application_passwords_available
+ *
+ * @ticket 53658
+ *
+ * @covers ::wp_is_application_passwords_available
+ *
+ * @param bool|string $expected The expected value.
+ * @param string|null $callback Optional. The callback for the `wp_is_application_passwords_available` hook.
+ * Default: null.
+ */
+ public function test_wp_is_application_passwords_available( $expected, $callback = null ) {
+ remove_filter( 'wp_is_application_passwords_available', '__return_true' );
+
+ if ( $callback ) {
+ add_filter( 'wp_is_application_passwords_available', $callback );
+ }
+
+ if ( 'default' === $expected ) {
+ putenv( 'WP_ENVIRONMENT_TYPE=local' );
+ $expected = wp_is_application_passwords_supported();
+ }
+
+ $actual = wp_is_application_passwords_available();
+
+ if ( 'default' === $expected ) {
+ // Revert to default behaviour so that other tests are not affected.
+ putenv( 'WP_ENVIRONMENT_TYPE' );
+ }
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_wp_is_application_passwords_available() {
+ return array(
+ 'availability not forced' => array(
+ 'expected' => 'default',
+ ),
+ 'availability forced true' => array(
+ 'expected' => true,
+ 'callback' => '__return_true',
+ ),
+ 'availability forced false' => array(
+ 'expected' => false,
+ 'callback' => '__return_false',
+ ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Sets up a REST API request to be authenticated using an App Password.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.7.0
</span></span></pre></div>
<a id="trunktestsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api-generated.js 2021-12-21 00:26:44 UTC (rev 52397)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2021-12-21 02:43:18 UTC (rev 52398)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,7 +18,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "wp-site-health/v1",
</span><span class="cx" style="display: block; padding: 0 10px"> "wp-block-editor/v1"
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "authentication": [],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "authentication": {
+ "application-passwords": {
+ "endpoints": {
+ "authorization": "http://example.org/wp-admin/authorize-application.php"
+ }
+ }
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "routes": {
</span><span class="cx" style="display: block; padding: 0 10px"> "/": {
</span><span class="cx" style="display: block; padding: 0 10px"> "namespace": "",
</span></span></pre>
</div>
</div>
</body>
</html>