JezK

Edit File: class-wp-application-passwords.php

<?php
/**
 * WP_Application_Passwords class
 *
 * @package WordPress
 * @since   5.6.0
 */

/**
 * Class for displaying, modifying, and sanitizing application passwords.
 *
 * @package WordPress
 */
#[AllowDynamicProperties]
class WP_Application_Passwords {

/**
	 * The application passwords user meta key.
	 *
	 * @since 5.6.0
	 *
	 * @var string
	 */
	const USERMETA_KEY_APPLICATION_PASSWORDS = '_application_passwords';

/**
	 * The option name used to store whether application passwords are in use.
	 *
	 * @since 5.6.0
	 *
	 * @var string
	 */
	const OPTION_KEY_IN_USE = 'using_application_passwords';

/**
	 * The generated application password length.
	 *
	 * @since 5.6.0
	 *
	 * @var int
	 */
	const PW_LENGTH = 24;

/**
	 * Checks if application passwords are being used by the site.
	 *
	 * This returns true if at least one application password has ever been created.
	 *
	 * @since 5.6.0
	 *
	 * @return bool
	 */
	public static function is_in_use() {
		$network_id = get_main_network_id();
		return (bool) get_network_option( $network_id, self::OPTION_KEY_IN_USE );
	}

/**
	 * Creates a new application password.
	 *
	 * @since 5.6.0
	 * @since 5.7.0 Returns WP_Error if application name already exists.
	 * @since 6.8.0 The hashed password value now uses wp_fast_hash() instead of phpass.
	 *
	 * @param int   $user_id  User ID.
	 * @param array $args     {
	 *     Arguments used to create the application password.
	 *
	 *     @type string $name   The name of the application password.
	 *     @type string $app_id A UUID provided by the application to uniquely identify it.
	 * }
	 * @return array|WP_Error {
	 *     Application password details, or a WP_Error instance if an error occurs.
	 *
	 *     @type string $0 The generated application password in plain text.
	 *     @type array  $1 {
	 *         The details about the created password.
	 *
	 *         @type string $uuid      The unique identifier for the application password.
	 *         @type string $app_id    A UUID provided by the application to uniquely identify it.
	 *         @type string $name      The name of the application password.
	 *         @type string $password  A one-way hash of the password.
	 *         @type int    $created   Unix timestamp of when the password was created.
	 *         @type null   $last_used Null.
	 *         @type null   $last_ip   Null.
	 *     }
	 * }
	 */
	public static function create_new_application_password( $user_id, $args = array() ) {
		if ( ! empty( $args['name'] ) ) {
			$args['name'] = sanitize_text_field( $args['name'] );
		}

if ( empty( $args['name'] ) ) {
			return new WP_Error( 'application_password_empty_name', __( 'An application name is required to create an application password.' ), array( 'status' => 400 ) );
		}

$new_password    = wp_generate_password( static::PW_LENGTH, false );
		$hashed_password = self::hash_password( $new_password );

$new_item = array(
			'uuid'      => wp_generate_uuid4(),
			'app_id'    => empty( $args['app_id'] ) ? '' : $args['app_id'],
			'name'      => $args['name'],
			'password'  => $hashed_password,
			'created'   => time(),
			'last_used' => null,
			'last_ip'   => null,
		);

$passwords   = static::get_user_application_passwords( $user_id );
		$passwords[] = $new_item;
		$saved       = static::set_user_application_passwords( $user_id, $passwords );

if ( ! $saved ) {
			return new WP_Error( 'db_error', __( 'Could not save application password.' ) );
		}

$network_id = get_main_network_id();
		if ( ! get_network_option( $network_id, self::OPTION_KEY_IN_USE ) ) {
			update_network_option( $network_id, self::OPTION_KEY_IN_USE, true );
		}

/**
		 * Fires when an application password is created.
		 *
		 * @since 5.6.0
		 * @since 6.8.0 The hashed password value now uses wp_fast_hash() instead of phpass.
		 *
		 * @param int    $user_id      The user ID.
		 * @param array  $new_item     {
		 *     The details about the created password.
		 *
		 *     @type string $uuid      The unique identifier for the application password.
		 *     @type string $app_id    A UUID provided by the application to uniquely identify it.
		 *     @type string $name      The name of the application password.
		 *     @type string $password  A one-way hash of the password.
		 *     @type int    $created   Unix timestamp of when the password was created.
		 *     @type null   $last_used Null.
		 *     @type null   $last_ip   Null.
		 * }
		 * @param string $new_password The generated application password in plain text.
		 * @param array  $args         {
		 *     Arguments used to create the application password.
		 *
		 *     @type string $name   The name of the application password.
		 *     @type string $app_id A UUID provided by the application to uniquely identify it.
		 * }
		 */
		do_action( 'wp_create_application_password', $user_id, $new_item, $new_password, $args );

return array( $new_password, $new_item );
	}

/**
	 * Gets a user's application passwords.
	 *
	 * @since 5.6.0
	 *
	 * @param int $user_id User ID.
	 * @return array {
	 *     The list of application passwords.
	 *
	 *     @type array ...$0 {
	 *         @type string      $uuid      The unique identifier for the application password.
	 *         @type string      $app_id    A UUID provided by the application to uniquely identify it.
	 *         @type string      $name      The name of the application password.
	 *         @type string      $password  A one-way hash of the password.
	 *         @type int         $created   Unix timestamp of when the password was created.
	 *         @type int|null    $last_used The Unix timestamp of the GMT date the application password was last used.
	 *         @type string|null $last_ip   The IP address the application password was last used by.
	 *     }
	 * }
	 */
	public static function get_user_application_passwords( $user_id ) {
		$passwords = get_user_meta( $user_id, static::USERMETA_KEY_APPLICATION_PASSWORDS, true );

if ( ! is_array( $passwords ) ) {
			return array();
		}

$save = false;

foreach ( $passwords as $i => $password ) {
			if ( ! isset( $password['uuid'] ) ) {
				$passwords[ $i ]['uuid'] = wp_generate_uuid4();
				$save                    = true;
			}
		}

if ( $save ) {
			static::set_user_application_passwords( $user_id, $passwords );
		}

return $passwords;
	}

/**
	 * Gets a user's application password with the given UUID.
	 *
	 * @since 5.6.0
	 *
	 * @param int    $user_id User ID.
	 * @param string $uuid    The password's UUID.
	 * @return array|null {
	 *     The application password if found, null otherwise.
	 *
	 *     @type string      $uuid      The unique identifier for the application password.
	 *     @type string      $app_id    A UUID provided by the application to uniquely identify it.
	 *     @type string      $name      The name of the application password.
	 *     @type string      $password  A one-way hash of the password.
	 *     @type int         $created   Unix timestamp of when the password was created.
	 *     @type int|null    $last_used The Unix timestamp of the GMT date the application password was last used.
	 *     @type string|null $last_ip   The IP address the application password was last used by.
	 * }
	 */
	public static function get_user_application_password( $user_id, $uuid ) {
		$passwords = static::get_user_application_passwords( $user_id );

foreach ( $passwords as $password ) {
			if ( $password['uuid'] === $uuid ) {
				return $password;
			}
		}

return null;
	}

/**
	 * Checks if an application password with the given name exists for this user.
	 *
	 * @since 5.7.0
	 *
	 * @param int    $user_id User ID.
	 * @param string $name    Application name.
	 * @return bool Whether the provided application name exists.
	 */
	public static function application_name_exists_for_user( $user_id, $name ) {
		$passwords = static::get_user_application_passwords( $user_id );

foreach ( $passwords as $password ) {
			if ( strtolower( $password['name'] ) === strtolower( $name ) ) {
				return true;
			}
		}

return false;
	}

/**
	 * Updates an application password.
	 *
	 * @since 5.6.0
	 * @since 6.8.0 The actual password should now be hashed using wp_fast_hash().
	 *
	 * @param int    $user_id User ID.
	 * @param string $uuid    The password's UUID.
	 * @param array  $update  {
	 *     Information about the application password to update.
	 *
	 *     @type string      $uuid      The unique identifier for the application password.
	 *     @type string      $app_id    A UUID provided by the application to uniquely identify it.
	 *     @type string      $name      The name of the application password.
	 *     @type string      $password  A one-way hash of the password.
	 *     @type int         $created   Unix timestamp of when the password was created.
	 *     @type int|null    $last_used The Unix timestamp of the GMT date the application password was last used.
	 *     @type string|null $last_ip   The IP address the application password was last used by.
	 * }
	 * @return true|WP_Error True if successful, otherwise a WP_Error instance is returned on error.
	 */
	public static function update_application_password( $user_id, $uuid, $update = array() ) {
		$passwords = static::get_user_application_passwords( $user_id );

foreach ( $passwords as &$item ) {
			if ( $item['uuid'] !== $uuid ) {
				continue;
			}

if ( ! empty( $update['name'] ) ) {
				$update['name'] = sanitize_text_field( $update['name'] );
			}

$save = false;

if ( ! empty( $update['name'] ) && $item['name'] !== $update['name'] ) {
				$item['name'] = $update['name'];
				$save         = true;
			}

if ( $save ) {
				$saved = static::set_user_application_passwords( $user_id, $passwords );

if ( ! $saved ) {
					return new WP_Error( 'db_error', __( 'Could not save application password.' ) );
				}
			}

/**
			 * Fires when an application password is updated.
			 *
			 * @since 5.6.0
			 * @since 6.8.0 The password is now hashed using wp_fast_hash() instead of phpass.
			 *              Existing passwords may still be hashed using phpass.
			 *
			 * @param int   $user_id The user ID.
			 * @param array $item    {
			 *     The updated application password details.
			 *
			 *     @type string      $uuid      The unique identifier for the application password.
			 *     @type string      $app_id    A UUID provided by the application to uniquely identify it.
			 *     @type string      $name      The name of the application password.
			 *     @type string      $password  A one-way hash of the password.
			 *     @type int         $created   Unix timestamp of when the password was created.
			 *     @type int|null    $last_used The Unix timestamp of the GMT date the application password was last used.
			 *     @type string|null $last_ip   The IP address the application password was last used by.
			 * }
			 * @param array $update  The information to update.
			 */
			do_action( 'wp_update_application_password', $user_id, $item, $update );

return true;
		}

return new WP_Error( 'application_password_not_found', __( 'Could not find an application password with that id.' ) );
	}

/**
	 * Records that an application password has been used.
	 *
	 * @since 5.6.0
	 *
	 * @param int    $user_id User ID.
	 * @param string $uuid    The password's UUID.
	 * @return true|WP_Error True if the usage was recorded, a WP_Error if an error occurs.
	 */
	public static function record_application_password_usage( $user_id, $uuid ) {
		$passwords = static::get_user_application_passwords( $user_id );

foreach ( $passwords as &$password ) {
			if ( $password['uuid'] !== $uuid ) {
				continue;
			}

// Only record activity once a day.
			if ( $password['last_used'] + DAY_IN_SECONDS > time() ) {
				return true;
			}

$password['last_used'] = time();
			$password['last_ip']   = $_SERVER['REMOTE_ADDR'];

$saved = static::set_user_application_passwords( $user_id, $passwords );

if ( ! $saved ) {
				return new WP_Error( 'db_error', __( 'Could not save application password.' ) );
			}

return true;
		}

// Specified application password not found!
		return new WP_Error( 'application_password_not_found', __( 'Could not find an application password with that id.' ) );
	}

/**
	 * Deletes an application password.
	 *
	 * @since 5.6.0
	 *
	 * @param int    $user_id User ID.
	 * @param string $uuid    The password's UUID.
	 * @return true|WP_Error Whether the password was successfully found and deleted, a WP_Error otherwise.
	 */
	public static function delete_application_password( $user_id, $uuid ) {
		$passwords = static::get_user_application_passwords( $user_id );

foreach ( $passwords as $key => $item ) {
			if ( $item['uuid'] === $uuid ) {
				unset( $passwords[ $key ] );
				$saved = static::set_user_application_passwords( $user_id, $passwords );

if ( ! $saved ) {
					return new WP_Error( 'db_error', __( 'Could not delete application password.' ) );
				}

/**
				 * Fires when an application password is deleted.
				 *
				 * @since 5.6.0
				 *
				 * @param int   $user_id The user ID.
				 * @param array $item    The data about the application password.
				 */
				do_action( 'wp_delete_application_password', $user_id, $item );

return true;
			}
		}

return new WP_Error( 'application_password_not_found', __( 'Could not find an application password with that id.' ) );
	}

/**
	 * Deletes all application passwords for the given user.
	 *
	 * @since 5.6.0
	 *
	 * @param int $user_id User ID.
	 * @return int|WP_Error The number of passwords that were deleted or a WP_Error on failure.
	 */
	public static function delete_all_application_passwords( $user_id ) {
		$passwords = static::get_user_application_passwords( $user_id );

if ( $passwords ) {
			$saved = static::set_user_application_passwords( $user_id, array() );

if ( ! $saved ) {
				return new WP_Error( 'db_error', __( 'Could not delete application passwords.' ) );
			}

foreach ( $passwords as $item ) {
				/** This action is documented in wp-includes/class-wp-application-passwords.php */
				do_action( 'wp_delete_application_password', $user_id, $item );
			}

return count( $passwords );
		}

return 0;
	}

/**
	 * Sets a user's application passwords.
	 *
	 * @since 5.6.0
	 *
	 * @param int   $user_id   User ID.
	 * @param array $passwords {
	 *     The list of application passwords.
	 *
	 *     @type array ...$0 {
	 *         @type string      $uuid      The unique identifier for the application password.
	 *         @type string      $app_id    A UUID provided by the application to uniquely identify it.
	 *         @type string      $name      The name of the application password.
	 *         @type string      $password  A one-way hash of the password.
	 *         @type int         $created   Unix timestamp of when the password was created.
	 *         @type int|null    $last_used The Unix timestamp of the GMT date the application password was last used.
	 *         @type string|null $last_ip   The IP address the application password was last used by.
	 *     }
	 * }
	 * @return int|bool User meta ID if the key didn't exist (ie. this is the first time that an application password
	 *                  has been saved for the user), true on successful update, false on failure or if the value passed
	 *                  is the same as the one that is already in the database.
	 */
	protected static function set_user_application_passwords( $user_id, $passwords ) {
		return update_user_meta( $user_id, static::USERMETA_KEY_APPLICATION_PASSWORDS, $passwords );
	}

/**
	 * Sanitizes and then splits a password into smaller chunks.
	 *
	 * @since 5.6.0
	 *
	 * @param string $raw_password The raw application password.
	 * @return string The chunked password.
	 */
	public static function chunk_password(
		#[\SensitiveParameter]
		$raw_password
	) {
		$raw_password = preg_replace( '/[^a-z\d]/i', '', $raw_password );

return trim( chunk_split( $raw_password, 4, ' ' ) );
	}

/**
	 * Hashes a plaintext application password.
	 *
	 * @since 6.8.0
	 *
	 * @param string $password Plaintext password.
	 * @return string Hashed password.
	 */
	public static function hash_password(
		#[\SensitiveParameter]
		string $password
	): string {
		return wp_fast_hash( $password );
	}

/**
	 * Checks a plaintext application password against a hashed password.
	 *
	 * @since 6.8.0
	 *
	 * @param string $password Plaintext password.
	 * @param string $hash     Hash of the password to check against.
	 * @return bool Whether the password matches the hashed password.
	 */
	public static function check_password(
		#[\SensitiveParameter]
		string $password,
		string $hash
	): bool {
		if ( ! str_starts_with( $hash, '$generic$' ) ) {
			/*
			 * If the hash doesn't start with `$generic$`, it is a hash created with `wp_hash_password()`.
			 * This is the case for application passwords created before 6.8.0.
			 */
			return wp_check_password( $password, $hash );
		}

return wp_verify_fast_hash( $password, $hash );
	}
}

BanaBridge News https://validator.w3.org/feed/docs/rss2.html Court Orders Ex-Weah Protocol Chief Jailed on US$8 Million Bail, Sends 15 Jurors to Prison Over Misconduct Women Renew Call for War and Economic Crimes Court at Liberia’s Historic Peace Prayer Site Finance Minister Ngafuan Urges Transparency, Accountability as Liberia Advances ARREST Agenda at UN Retreat PPCC Donates ICT Equipment to 50 Government Institutions to Expand Electronic Procurement System Liberia Commissions €100,000 Elemental Analyzer to Strengthen Environmental Research and Food Security EPA Ends 16 Years of Renting with Purchase of Permanent Headquarters West African Tax Bodies Deepen Partnership to Boost Revenue Mobilization, Launch Carbon Tax Study Liberia Hosts Sierra Leone Procurement Delegation for E-GP Reform Study Tour World Bank Praises Liberia’s Central Bank for Economic Stability and Private Sector Progress Liberians See Slight Improvement in Corruption Fight, But Graft Still Viewed as Widespread, CENTAL Report Finds Canada Afrique Care Foundation Set for Official Launch, Expanding Free Mental Health Access Across Canada and Africa Weah Claims Liberia Has Become a “Narco State” as Opposition Rallies Behind Calls for Independent Probe into US$19 Million Cocaine Bust EPA Boss Calls for Stronger Student Engagement, Unveils Push for Academic Partnership at UL Climate Symposium Education Minister Urges Students to Embrace Tax Responsibility at National Student Tax Day CDC Secretary General Urges U.S. Government to Review Support to Liberia National Police Liberia Partners with CACFO to Expand Mental Health Services Ahead of Global Launch Wreh-Toe Appointed Board Chair of CACFO as Foundation Strengthens Mental Health Push GIABA Opens New Information Center Headquarters in Abidjan Liberia Wins Fresh Backing as World Bank Group Executive Praises Progress, Pushes Faster Project Delivery LRA Honors Liberia’s Top Taxpayers as Revenue Collections Hit Historic High Root Cause in Question as Border Tensions Persist After Conakry Peace Deal From Enforcement to Innovation: EPA Marks 2025 as a Defining Year for Liberia’s Environment Weah Declares ‘Road to 2029 Begins Today’ as CDC Marks 22nd Anniversary in Zwedru 500 Documented Governance Failures: Activist Publishes Sweeping End-of-Year Indictment of Boakai Administration CDC Calls for Probe into Border Crisis, Cites Alleged Mining Activities Liberia Moves to Strengthen Small Businesses with $672,000 Packaging Solution Initiative Former Public Works Minister Ruth Coker Collins Defends Zwedru Corridor Strategy, Calls for “Facts Over Rhetoric” in Infrastructure Debate Power Shake-Up in CDC Diaspora: NEC Dissolves CDC-USA Interim Leadership, Appoints Rev. Muin to Lead U.S. Chapter Tweah Reemerges, Sparks Fierce National Debate Over Governance and Liberia’s Future Koijee Slams Tribal Politics and Political Manipulation in Lofa, Accuses Boakai Government Mali and Burkina Faso Impose Reciprocal Travel Ban on U.S. Citizens Guinea Election: A Turn Toward Continuity Amid Questions of Democratic Credibility Liberia’s Revenue Grows Stronger as LRA Exceeds National Target for Second Year Liberia’s Gender Legal Landscape: Laws in Place, Systems Lag Far Behind Liberia’s Economy Gains Momentum as CBL Governor Highlights Progress at ECOWAS Meeting Liberia Positions Itself for Eco Currency Entry as Economy Expands by 5.1% From Overcrowded Classrooms to Renewal: NPA Mobilizes $1 Million to Transform UL Ex-Public Works Minister Ruth Coker Collins Slams Ministry’s “Lack of Capacity,” Defends Her Infrastructure Record CDC Expels Three Senior Members, Citing Alleged Alignment With Government and Undermining Party Ideology UL to Celebrate 75 Years of Excellence Saudi Fund Advances Liberia’s Push for Major Infrastructure Development West African Financial Leaders Convene in Monrovia for ECOWAS Statutory Meetings Unlocking Liberia’s Potential: Government Launches Major Revenue and Transparency Reforms Incremental Gains, Enduring Impunity: Liberia’s CPI Improvement Fails the Test of Reform Boakai’s Call for Unity Faces Scrutiny as Opposition, Citizens Question Actions Behind the Words REMAPSEN Liberia Set to Strengthen Health and Environmental Reporting Energy Sector Women Step Into the Spotlight at Liberia’s International Women’s Day Celebration FeJAL Concludes Three-Day Retreat, Honors Outstanding Women Journalists Dr. Rasha Kelej Named Among Africa’s 100 Most Influential Leaders LAVA Honored for Strengthening Liberia–U.S. Ties at 2025 Military Ball