WP_Recovery_Mode_Key_Service

14#[AllowDynamicProperties]15final class WP_Recovery_Mode_Key_Service {16 17	/**18	 * The option name used to store the keys.19	 *20	 * @since 5.2.021	 * @var string22	 */23	private $option_name = 'recovery_keys';24 25	/**26	 * Creates a recovery mode token.27	 *28	 * @since 5.2.029	 *30	 * @return string A random string to identify its associated key in storage.31	 */32	public function generate_recovery_mode_token() {33		return wp_generate_password( 22, false );34	}35 36	/**37	 * Creates a recovery mode key.38	 *39	 * @since 5.2.040	 *41	 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.42	 *43	 * @param string $token A token generated by {@see generate_recovery_mode_token()}.44	 * @return string Recovery mode key.45	 */46	public function generate_and_store_recovery_mode_key( $token ) {47 48		global $wp_hasher;49 50		$key = wp_generate_password( 22, false );51 52		if ( empty( $wp_hasher ) ) {53			require_once ABSPATH . WPINC . '/class-phpass.php';54			$wp_hasher = new PasswordHash( 8, true );55		}56 57		$hashed = $wp_hasher->HashPassword( $key );58 59		$records = $this->get_keys();60 61		$records[ $token ] = array(62			'hashed_key' => $hashed,63			'created_at' => time(),64		);65 66		$this->update_keys( $records );67 68		/**69		 * Fires when a recovery mode key is generated.70		 *71		 * @since 5.2.072		 *73		 * @param string $token The recovery data token.74		 * @param string $key   The recovery mode key.75		 */76		do_action( 'generate_recovery_mode_key', $token, $key );77 78		return $key;79	}80 81	/**82	 * Verifies if the recovery mode key is correct.83	 *84	 * Recovery mode keys can only be used once; the key will be consumed in the process.85	 *86	 * @since 5.2.087	 *88	 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.89	 *90	 * @param string $token The token used when generating the given key.91	 * @param string $key   The unhashed key.92	 * @param int    $ttl   Time in seconds for the key to be valid for.93	 * @return true|WP_Error True on success, error object on failure.