Changeset 49752

Timestamp:

12/04/2020 09:42:52 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

App Passwords: Prevent conflicts when Basic Auth is already used by the site.

Application Passwords uses Basic Authentication to transfer authentication details. If the site is already using Basic Auth, for instance to implement a private staging environment, then the REST API will treat this as an authentication attempt and would end up generating an error for any REST API request.

Now, Application Password authentication will only be attempted if Application Passwords is in use by a site. This is flagged by setting an option whenever an Application Password is created. An upgrade routine is added to set this option if any App Passwords already exist.

Lastly, creating an Application Password will be prevented if the site appears to already be using Basic Authentication.

Props chexwarrior, georgestephanis, adamsilverstein, helen, Clorith, marybaum, TimothyBlynJacobs.
Fixes #51939.

Location:

trunk

Files:

• src/wp-admin/authorize-application.php (modified) (1 diff)
• src/wp-admin/includes/upgrade.php (modified) (2 diffs)
• src/wp-admin/user-edit.php (modified) (1 diff)
• src/wp-includes/class-wp-application-passwords.php (modified) (3 diffs)
• src/wp-includes/user.php (modified) (1 diff)
• src/wp-includes/version.php (modified) (1 diff)
• tests/phpunit/tests/auth.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-application-passwords-controller.php (modified) (1 diff)

trunk/src/wp-admin/authorize-application.php

@@ -86 +86 @@
         __( 'The Authorize Application request is not allowed.' ) . ' ' . implode( ' ', $is_valid->get_error_messages() ),
         __( 'Cannot Authorize Application' )
+    );
+}
+
+if ( ! empty( $_SERVER['PHP_AUTH_USER'] ) || ! empty( $_SERVER['PHP_AUTH_PW'] ) ) {
+    wp_die(
+        __( 'Your website appears to use Basic Authentication, which is not currently compatible with Application Passwords.' ),
+        __( 'Cannot Authorize Application' ),
+        array(
+            'response'  => 501,
+            'link_text' => __( 'Go Back' ),
+            'link_url'  => $reject_url ? add_query_arg( 'error', 'disabled', $reject_url ) : admin_url(),
+        )
     );
 }

trunk/src/wp-admin/includes/upgrade.php

@@ -875 +875 @@
     }
 
-    if ( $wp_current_db_version < 49735 ) {
+    if ( $wp_current_db_version < 49752 ) {
         upgrade_560();
     }
@@ -2279 +2279 @@
         delete_transient( 'dirsize_cache' );
     }
+
+    if ( $wp_current_db_version < 49752 ) {
+        $results = $wpdb->get_results(
+            $wpdb->prepare(
+                "SELECT 1 FROM {$wpdb->usermeta} WHERE meta_key = %s LIMIT 1",
+                WP_Application_Passwords::USERMETA_KEY_APPLICATION_PASSWORDS
+            )
+        );
+
+        if ( ! empty( $results ) ) {
+            update_site_option( WP_Application_Passwords::OPTION_KEY_IN_USE, 1 );
+        }
+    }
 }
 

trunk/src/wp-admin/user-edit.php

@@ -739 +739 @@
                 }
             }
-            ?>
-        <div class="create-application-password form-wrap">
-            <div class="form-field">
-                <label for="new_application_password_name"><?php _e( 'New Application Password Name' ); ?></label>
-                <input type="text" size="30" id="new_application_password_name" name="new_application_password_name" placeholder="<?php esc_attr_e( 'WordPress App on My Phone' ); ?>" class="input" aria-required="true" aria-describedby="new_application_password_name_desc" />
-                <p class="description" id="new_application_password_name_desc"><?php _e( 'Required to create an Application Password, but not to update the user.' ); ?></p>
+
+            if ( empty( $_SERVER['PHP_AUTH_USER'] ) && empty( $_SERVER['PHP_AUTH_PW'] ) ) {
+                ?>
+            <div class="create-application-password form-wrap">
+                <div class="form-field">
+                    <label for="new_application_password_name"><?php _e( 'New Application Password Name' ); ?></label>
+                    <input type="text" size="30" id="new_application_password_name" name="new_application_password_name" placeholder="<?php esc_attr_e( 'WordPress App on My Phone' ); ?>" class="input" aria-required="true" aria-describedby="new_application_password_name_desc" />
+                    <p class="description" id="new_application_password_name_desc"><?php _e( 'Required to create an Application Password, but not to update the user.' ); ?></p>
+                </div>
+
+                <?php
+                /**
+                 * Fires in the create Application Passwords form.
+                 *
+                 * @since 5.6.0
+                 *
+                 * @param WP_User $profileuser The current WP_User object.
+                 */
+                do_action( 'wp_create_application_password_form', $profileuser );
+                ?>
+
+                <?php submit_button( __( 'Add New Application Password' ), 'secondary', 'do_new_application_password' ); ?>
             </div>
-
-            <?php
-            /**
-             * Fires in the create Application Passwords form.
-             *
-             * @since 5.6.0
-             *
-             * @param WP_User $profileuser The current WP_User object.
-             */
-            do_action( 'wp_create_application_password_form', $profileuser );
-            ?>
-
-            <?php submit_button( __( 'Add New Application Password' ), 'secondary', 'do_new_application_password' ); ?>
-        </div>
+        <?php } else { ?>
+            <div class="notice notice-error inline">
+                <p><?php _e( 'Your website appears to use Basic Authentication, which is not currently compatible with Application Passwords.' ); ?></p>
+            </div>
+        <?php } ?>
 
         <div class="application-passwords-list-table-wrapper">

trunk/src/wp-includes/class-wp-application-passwords.php

@@ -24 +24 @@
 
     /**
+     * The option name used to store whether application passwords is in use.
+     *
+     * @since 5.6.0
+     *
+     * @type string
+     */
+    const OPTION_KEY_IN_USE = 'using_application_passwords';
+
+    /**
      * The generated application password length.
      *
@@ -31 +40 @@
      */
     const PW_LENGTH = 24;
+
+    /**
+     * Checks if Application Passwords are being used by the site.
+     *
+     * This returns true if at least one App Password has ever been created.
+     *
+     * @since 5.6.0
+     *
+     * @return bool
+     */
+    public static function is_in_use() {
+        return (bool) get_site_option( self::OPTION_KEY_IN_USE );
+    }
 
     /**
@@ -66 +88 @@
         if ( ! $saved ) {
             return new WP_Error( 'db_error', __( 'Could not save application password.' ) );
+        }
+
+        if ( ! get_site_option( self::OPTION_KEY_IN_USE ) ) {
+            update_site_option( self::OPTION_KEY_IN_USE, true );
         }
 

trunk/src/wp-includes/user.php

@@ -311 +311 @@
 function wp_authenticate_application_password( $input_user, $username, $password ) {
     if ( $input_user instanceof WP_User ) {
+        return $input_user;
+    }
+
+    if ( ! WP_Application_Passwords::is_in_use() ) {
         return $input_user;
     }

trunk/src/wp-includes/version.php

@@ -21 +21 @@
  * @global int $wp_db_version
  */
-$wp_db_version = 49735;
+$wp_db_version = 49752;
 
 /**

trunk/tests/phpunit/tests/auth.php

@@ -38 +38 @@
         $this->user = clone self::$_user;
         wp_set_current_user( self::$user_id );
+        update_site_option( 'using_application_passwords', 1 );
     }
 
@@ -605 +606 @@
         $this->assertSame( self::$user_id, $user->ID );
     }
+
+    /**
+     * @ticket 51939
+     */
+    public function test_authenticate_application_password_returns_null_if_not_in_use() {
+        delete_site_option( 'using_application_passwords' );
+
+        $authenticated = wp_authenticate_application_password( null, 'idonotexist', 'password' );
+        $this->assertNull( $authenticated );
+    }
 }

trunk/tests/phpunit/tests/rest-api/rest-application-passwords-controller.php

@@ -406 +406 @@
 
     /**
+     * @ticket 51939
+     */
+    public function test_create_item_records_app_passwords_in_use() {
+        wp_set_current_user( self::$admin );
+
+        $this->assertFalse( WP_Application_Passwords::is_in_use() );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/users/me/application-passwords' );
+        $request->set_body_params( array( 'name' => 'App' ) );
+        $response = rest_do_request( $request );
+
+        $this->assertSame( 201, $response->get_status() );
+        $this->assertTrue( WP_Application_Passwords::is_in_use() );
+    }
+
+    /**
      * @ticket 42790
      */