mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-22 17:18:32 +01:00
e612354728
In [50030] we enforced that Application Passwords have unique names. This was done with the assumption that applications would not connect to a user multiple times. However, in practice we've seen applications run into issues with the unique name constraint. Depending on the app, they may not know if they've been authorized before, or they may intentionally allow connecting multiple times. To prevent friction, App developers need to make their App Name unique, and in doing so often include things like the current date & time, which is already included in the App Passwords list table. This commit removes this requirement to simplify usage of the Authorize Application flow. Props mark-k, Boniu91, timothyblynjacobs, peterwilsoncc. Fixes #54213. Built from https://develop.svn.wordpress.org/trunk@59084 git-svn-id: http://core.svn.wordpress.org/trunk@58480 1a063a9b-81f0-0310-95a4-ce76da25c4cd
468 lines
15 KiB
PHP
468 lines
15 KiB
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.
|
|
*
|
|
* @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 = wp_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
|
|
*
|
|
* @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
|
|
*
|
|
* @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
|
|
*
|
|
* @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( $raw_password ) {
|
|
$raw_password = preg_replace( '/[^a-z\d]/i', '', $raw_password );
|
|
|
|
return trim( chunk_split( $raw_password, 4, ' ' ) );
|
|
}
|
|
}
|