Changeset 49752 for trunk/src/wp-includes/class-wp-application-passwords.php

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.

File:

• trunk/src/wp-includes/class-wp-application-passwords.php (modified) (3 diffs)

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 );
         }