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	 * @since 6.8.0 The stored key is now hashed using wp_fast_hash() instead of phpass.41	 *42	 * @param string $token A token generated by {@see WP_Recovery_Mode_Key_Service::generate_recovery_mode_token()}.43	 * @return string Recovery mode key.44	 */45	public function generate_and_store_recovery_mode_key( $token ) {46		$key = wp_generate_password( 22, false );47 48		$records = $this->get_keys();49 50		$records[ $token ] = array(51			'hashed_key' => wp_fast_hash( $key ),52			'created_at' => time(),53		);54 55		$this->update_keys( $records );56 57		/**58		 * Fires when a recovery mode key is generated.59		 *60		 * @since 5.2.061		 *62		 * @param string $token The recovery data token.63		 * @param string $key   The recovery mode key.64		 */65		do_action( 'generate_recovery_mode_key', $token, $key );66 67		return $key;68	}69 70	/**71	 * Verifies if the recovery mode key is correct.72	 *73	 * Recovery mode keys can only be used once; the key will be consumed in the process.74	 *75	 * @since 5.2.076	 *77	 * @param string $token The token used when generating the given key.78	 * @param string $key   The plain text key.79	 * @param int    $ttl   Time in seconds for the key to be valid for.80	 * @return true|WP_Error True on success, error object on failure.81	 */82	public function validate_recovery_mode_key( $token, $key, $ttl ) {83		$records = $this->get_keys();84 85		if ( ! isset( $records[ $token ] ) ) {86			return new WP_Error( 'token_not_found', __( 'Recovery Mode not initialized.' ) );87		}88 89		$record = $records[ $token ];90 91		$this->remove_key( $token );92 93		if ( ! is_array( $record ) || ! isset( $record['hashed_key'], $record['created_at'] ) ) {