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

Timestamp:

04/16/2019 05:08:16 AM (6 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-link-service.php (modified) (6 diffs)

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

@@ -38 +38 @@
      *
      * @param WP_Recovery_Mode_Cookie_Service $cookie_service Service to handle setting the recovery mode cookie.
+     * @param WP_Recovery_Mode_Key_Service    $key_service    Service to handle generating recovery mode keys.
      */
-    public function __construct( WP_Recovery_Mode_Cookie_Service $cookie_service ) {
+    public function __construct( WP_Recovery_Mode_Cookie_Service $cookie_service, WP_Recovery_Mode_Key_Service $key_service ) {
         $this->cookie_service = $cookie_service;
-        $this->key_service    = new WP_Recovery_Mode_Key_Service();
+        $this->key_service    = $key_service;
     }
 
@@ -54 +55 @@
      */
     public function generate_url() {
-        $key = $this->key_service->generate_and_store_recovery_mode_key();
+        $token = $this->key_service->generate_recovery_mode_token();
+        $key   = $this->key_service->generate_and_store_recovery_mode_key( $token );
 
-        return $this->get_recovery_mode_begin_url( $key );
+        return $this->get_recovery_mode_begin_url( $token, $key );
     }
 
@@ -71 +73 @@
         }
 
-        if ( ! isset( $_GET['action'], $_GET['rm_key'] ) || self::LOGIN_ACTION_ENTER !== $_GET['action'] ) {
+        if ( ! isset( $_GET['action'], $_GET['rm_token'], $_GET['rm_key'] ) || self::LOGIN_ACTION_ENTER !== $_GET['action'] ) {
             return;
         }
@@ -79 +81 @@
         }
 
-        $validated = $this->key_service->validate_recovery_mode_key( $_GET['rm_key'], $ttl );
+        $validated = $this->key_service->validate_recovery_mode_key( $_GET['rm_token'], $_GET['rm_key'], $ttl );
 
         if ( is_wp_error( $validated ) ) {
@@ -97 +99 @@
      * @since 5.2.0
      *
-     * @param string $key Recovery Mode key created by {@see generate_and_store_recovery_mode_key()}
+     * @param string $token Recovery Mode token created by {@see generate_recovery_mode_token()}.
+     * @param string $key   Recovery Mode key created by {@see generate_and_store_recovery_mode_key()}.
      * @return string Recovery mode begin URL.
      */
-    private function get_recovery_mode_begin_url( $key ) {
+    private function get_recovery_mode_begin_url( $token, $key ) {
 
         $url = add_query_arg(
             array(
-                'action' => self::LOGIN_ACTION_ENTER,
-                'rm_key' => $key,
+                'action'   => self::LOGIN_ACTION_ENTER,
+                'rm_token' => $token,
+                'rm_key'   => $key,
             ),
             wp_login_url()
@@ -115 +119 @@
          * @since 5.2.0
          *
-         * @param string $url
-         * @param string $key
+         * @param string $url   The generated recovery mode begin URL.
+         * @param string $token The token used to identify the key.
+         * @param string $key   The recovery mode key.
          */
-        return apply_filters( 'recovery_mode_begin_url', $url, $key );
+        return apply_filters( 'recovery_mode_begin_url', $url, $token, $key );
     }
 }