Changeset 45211 for trunk/src/wp-includes/class-wp-recovery-mode-key-service.php

Timestamp:

04/16/2019 05:08:16 AM (4 years ago)

Author:

flixos90

Message:

Bootstrap/Load: Allow more than one recovery link to be valid at a time.

While currently a recovery link is only made available via the admin email address, this will be expanded in the future. In order to accomplish that, the mechanisms to store and validate recovery keys must support multiple keys to be valid at the same time.

This changeset adds that support, adding an additional token parameter which is part of a recovery link in addition to the key. A key itself is always associated with a token, so the two are only valid in combination. These associations are stored in a new recovery_keys option, which is regularly cleared in a new Cron hook, to prevent potential cluttering from unused recovery keys.

This changeset does not have any user-facing implications otherwise.

Props pbearne, timothyblynjacobs.
Fixes #46595. See #46130.

File:

• trunk/src/wp-includes/class-wp-recovery-mode-key-service.php (modified) (6 diffs)

trunk/src/wp-includes/class-wp-recovery-mode-key-service.php

@@ -1 +1 @@
 <?php
 /**
- * Error Protection API: WP_Recovery_Mode_Key_service class
+ * Error Protection API: WP_Recovery_Mode_Key_Service class
  *
  * @package WordPress
@@ -15 +15 @@
 
     /**
+     * The option name used to store the keys.
+     *
+     * @since 5.2.0
+     * @var string
+     */
+    private $option_name = 'recovery_keys';
+
+    /**
+     * Creates a recovery mode token.
+     *
+     * @since 5.2.0
+     *
+     * @return string $token A random string to identify its associated key in storage.
+     */
+    public function generate_recovery_mode_token() {
+        return wp_generate_password( 22, false );
+    }
+
+    /**
      * Creates a recovery mode key.
      *
@@ -21 +40 @@
      * @global PasswordHash $wp_hasher
      *
-     * @return string Recovery mode key.
+     * @param string $token A token generated by {@see generate_recovery_mode_token()}.
+     * @return string $key Recovery mode key.
      */
-    public function generate_and_store_recovery_mode_key() {
+    public function generate_and_store_recovery_mode_key( $token ) {
 
         global $wp_hasher;
 
         $key = wp_generate_password( 22, false );
-
-        /**
-         * Fires when a recovery mode key is generated for a user.
-         *
-         * @since 5.2.0
-         *
-         * @param string $key The recovery mode key.
-         */
-        do_action( 'generate_recovery_mode_key', $key );
 
         if ( empty( $wp_hasher ) ) {
@@ -45 +56 @@
         $hashed = $wp_hasher->HashPassword( $key );
 
-        update_option(
-            'recovery_key',
-            array(
-                'hashed_key' => $hashed,
-                'created_at' => time(),
-            )
+        $records = $this->get_keys();
+
+        $records[ $token ] = array(
+            'hashed_key' => $hashed,
+            'created_at' => time(),
         );
+
+        $this->update_keys( $records );
+
+        /**
+         * Fires when a recovery mode key is generated.
+         *
+         * @since 5.2.0
+         *
+         * @param string $token The recovery data token.
+         * @param string $key   The recovery mode key.
+         */
+        do_action( 'generate_recovery_mode_key', $token, $key );
 
         return $key;
@@ -59 +81 @@
      * Verifies if the recovery mode key is correct.
      *
+     * Recovery mode keys can only be used once; the key will be consumed in the process.
+     *
      * @since 5.2.0
      *
-     * @param string $key The unhashed key.
-     * @param int    $ttl Time in seconds for the key to be valid for.
+     * @param string $token The token used when generating the given key.
+     * @param string $key   The unhashed key.
+     * @param int    $ttl   Time in seconds for the key to be valid for.
      * @return true|WP_Error True on success, error object on failure.
      */
-    public function validate_recovery_mode_key( $key, $ttl ) {
+    public function validate_recovery_mode_key( $token, $key, $ttl ) {
 
-        $record = get_option( 'recovery_key' );
+        $records = $this->get_keys();
 
-        if ( ! $record ) {
-            return new WP_Error( 'no_recovery_key_set', __( 'Recovery Mode not initialized.' ) );
+        if ( ! isset( $records[ $token ] ) ) {
+            return new WP_Error( 'token_not_found', __( 'Recovery Mode not initialized.' ) );
         }
+
+        $record = $records[ $token ];
+
+        $this->remove_key( $token );
 
         if ( ! is_array( $record ) || ! isset( $record['hashed_key'], $record['created_at'] ) ) {
@@ -87 +116 @@
         return true;
     }
+
+    /**
+     * Removes expired recovery mode keys.
+     *
+     * @since 5.2.0
+     *
+     * @param int $ttl Time in seconds for the keys to be valid for.
+     */
+    public function clean_expired_keys( $ttl ) {
+
+        $records = $this->get_keys();
+
+        foreach ( $records as $key => $record ) {
+            if ( ! isset( $record['created_at'] ) || time() > $record['created_at'] + $ttl ) {
+                unset( $records[ $key ] );
+            }
+        }
+
+        $this->update_keys( $records );
+    }
+
+    /**
+     * Removes a used recovery key.
+     *
+     * @since 5.2.0
+     *
+     * @param string $token The token used when generating a recovery mode key.
+     */
+    private function remove_key( $token ) {
+
+        $records = $this->get_keys();
+
+        if ( ! isset( $records[ $token ] ) ) {
+            return;
+        }
+
+        unset( $records[ $token ] );
+
+        $this->update_keys( $records );
+    }
+
+    /**
+     * Gets the recovery key records.
+     *
+     * @since 5.2.0
+     *
+     * @return array Associative array of $token => $data pairs, where $data has keys 'hashed_key'
+     *               and 'created_at'.
+     */
+    private function get_keys() {
+        return (array) get_option( $this->option_name, array() );
+    }
+
+    /**
+     * Updates the recovery key records.
+     *
+     * @since 5.2.0
+     *
+     * @param array $keys Associative array of $token => $data pairs, where $data has keys 'hashed_key'
+     *                    and 'created_at'.
+     * @return bool True on success, false on failure.
+     */
+    private function update_keys( array $keys ) {
+        return update_option( $this->option_name, $keys );
+    }
 }