mainwp-child/class/class-mainwp-connect.php
thanghv 3d888cea6e Fixed: stagging compatible update issue
Fixed: file size error for some host
Added: reconnect with user pw
2024-12-10 19:55:36 +07:00

1172 lines
47 KiB
PHP

<?php
/**
* MainWP Connect
*
* Manage connection between MainWP Dashboard and the child site.
*
* @package MainWP\Child
*/
namespace MainWP\Child;
/**
* Class MainWP_Connect
*
* Manage connection between MainWP Dashboard and the child site.
*/
class MainWP_Connect { //phpcs:ignore -- NOSONAR - multi methods.
/**
* Public static variable to hold the single instance of the class.
*
* @var mixed Default null
*/
public static $instance = null;
/**
* Private variable to hold the connect user.
*
* @var mixed Default null
*/
private $connect_user = null;
/**
* Private variable to hold the max history value.
*
* @var int $maxHistory Max history.
*/
private $maxHistory = 5;
/**
* Method get_class_name()
*
* Get class name.
*
* @return string __CLASS__ Class name.
*/
public static function get_class_name() {
return __CLASS__;
}
/**
* Method instance()
*
* Create a public static instance.
*
* @return mixed Class instance.
*/
public static function instance() {
if ( null === static::$instance ) {
static::$instance = new self();
}
return static::$instance;
}
/**
* Method register_site()
*
* Register the current WordPress site thus generating teh public key.
*
* @uses \MainWP\Child\MainWP_Child_Branding::save_branding_options()
* @uses \MainWP\Child\MainWP_Child_Stats::get_site_stats()
* @uses \MainWP\Child\MainWP_Helper::instance()->error()
* @uses \MainWP\Child\MainWP_Helper::is_ssl_enabled()
* @uses \MainWP\Child\MainWP_Helper::update_option()
*/
public function register_site() { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
/**
* Current user global.
*
* @global string
*/
global $current_user;
$information = array();
// phpcs:disable WordPress.Security.NonceVerification, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
// Check if the user is valid & login.
if ( ! isset( $_POST['user'] ) || ! isset( $_POST['pubkey'] ) ) {
MainWP_Helper::instance()->error( sprintf( esc_html__( 'Public key could not be set. Please make sure that the OpenSSL library has been configured correctly on your MainWP Dashboard. For additional help, please check this %1$shelp document%2$s.', 'mainwp-child' ), '<strong><a href="https://kb.mainwp.com/docs/cant-connect-website-getting-the-invalid-request-error-message/" target="_blank">', '</a></strong>' ), 'REG_ERROR1' );
}
// Already added - can't readd. Deactivate plugin.
if ( get_option( 'mainwp_child_pubkey' ) ) {
// if register verified, then go to next step.
if ( ! $this->is_verified_register( wp_unslash( $_POST['user'] ) ) ) {
// Set disconnect status to yes here, it will empty after reconnected.
MainWP_Child_Branding::instance()->save_branding_options( 'branding_disconnected', 'yes' );
MainWP_Helper::instance()->error( esc_html__( 'Public key already set. Please deactivate & reactivate the MainWP Child plugin on the child site and try again.', 'mainwp-child' ), 'REG_ERROR2' );
}
}
$uniqueId = MainWP_Helper::get_site_unique_id();
// Check the Unique Security ID.
if ( '' !== $uniqueId ) {
if ( ! isset( $_POST['uniqueId'] ) || ( '' === $_POST['uniqueId'] ) ) {
MainWP_Helper::instance()->error( esc_html__( 'This child site is set to require a unique security ID. Please enter it before the connection can be established.', 'mainwp-child' ), 'REG_ERROR3' );
} elseif ( $uniqueId !== $_POST['uniqueId'] ) {
MainWP_Helper::instance()->error( esc_html__( 'The unique security ID mismatch! Please correct it before the connection can be established.', 'mainwp-child' ), 'REG_ERROR4' );
}
}
// Check SSL Requirement.
if ( ! MainWP_Helper::is_ssl_enabled() && ( ! defined( 'MAINWP_ALLOW_NOSSL_CONNECT' ) || ! MAINWP_ALLOW_NOSSL_CONNECT ) ) {
MainWP_Helper::instance()->error( esc_html__( 'OpenSSL library is required on the child site to set up a secure connection.', 'mainwp-child' ), 'REG_ERROR5' );
}
// Check Curl SSL Requirement.
if ( ! MainWP_Child_Server_Information_Base::get_curl_support() ) {
MainWP_Helper::instance()->error( esc_html__( 'cURL Extension not enabled on the child site server. Please contact your host support and have them enabled it for you.', 'mainwp-child' ), 'REG_ERROR6' );
}
if ( ! empty( $_POST['user'] ) && ! $this->is_verified_register( wp_unslash( $_POST['user'] ) ) ) {
if ( isset( $_POST['regverify'] ) ) {
MainWP_Helper::instance()->error( esc_html__( 'Failed to reconnect to the site. Please remove the site and add it again.', 'mainwp-child' ), 'reconnect_failed' );
} else {
MainWP_Helper::instance()->error( esc_html__( 'Unable to connect to the site. Please verify that your Admin Username and Password are correct and try again.', 'mainwp-child' ), 'REG_ERROR7' );
}
}
// Check if the user exists and if yes, check if it's administartor user.
if ( empty( $_POST['user'] ) || ! $this->login( wp_unslash( $_POST['user'] ) ) ) {
MainWP_Helper::instance()->error( esc_html__( 'Administrator user does not exist. Please verify that the user is an existing administrator.', 'mainwp-child' ), 'REG_ERROR8' );
}
if ( ! MainWP_Helper::is_admin() ) {
MainWP_Helper::instance()->error( esc_html__( 'User is not an administrator. Please use an administrator user to establish the connection.', 'mainwp-child' ), 'REG_ERROR9' );
}
// Update the mainwp_child_pubkey option.
MainWP_Helper::update_option( 'mainwp_child_pubkey', ( isset( $_POST['pubkey'] ) ? base64_encode( wp_unslash( $_POST['pubkey'] ) ) : '' ), 'yes' ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions -- base64_encode function is used for the backwards compatibility.
// Save the server.
MainWP_Child_Keys_Manager::update_encrypted_option( 'mainwp_child_server', ! empty( $_POST['server'] ) ? wp_unslash( $_POST['server'] ) : '' );
// Save the nonce.
MainWP_Helper::update_option( 'mainwp_child_nonce', 0 );
MainWP_Helper::update_option( 'mainwp_child_connected_admin', $current_user->user_login, 'yes' );
// register success.
$new_verify = $this->may_be_generate_register_verify();
if ( ! empty( $new_verify ) ) {
$information['regverify'] = $new_verify; // get reg verify value.
}
$information['register'] = 'OK';
$information['uniqueId'] = MainWP_Helper::get_site_unique_id();
$information['user'] = isset( $_POST['user'] ) ? sanitize_text_field( wp_unslash( $_POST['user'] ) ) : '';
// phpcs:enable WordPress.Security.NonceVerification, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
MainWP_Child_Stats::get_instance()->get_site_stats( $information ); // get stats and exit.
}
/**
* Method validate_register().
*
* @param string $key_value Key & value.
* @param string $act Action.
* @param string $user_name user name.
*
* @return mixed
*/
public function validate_register( $key_value, $act = 'verify', $user_name = false ) { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
$user_id = 0;
if ( ! empty( $user_name ) ) {
$user = get_user_by( 'login', $user_name );
$user_id = $user ? $user->ID : false;
} else {
$user = $this->get_connected_user();
$user_id = $user ? $user->ID : false;
}
if ( empty( $user_id ) ) {
return false;
}
$_values = get_user_option( 'mainwp_child_user_verified_registers', $user_id );
$saved_values = ! empty( $_values ) ? json_decode( $_values, true ) : array();
if ( ! is_array( $saved_values ) ) {
$saved_values = array();
}
$verify_key = '';
$verify_secrect = '';
if ( ! empty( $key_value ) && false !== strpos( $key_value, '-' ) ) {
list( $verify_key, $verify_secrect ) = explode( '-', $key_value );
}
$gen_verify = '';
if ( 'verify' === $act ) {
$found_secure = '';
$hash_key = hash_hmac( 'sha256', $verify_key, 'register-verify' );
foreach ( $saved_values as $info ) {
if ( is_array( $info ) && ! empty( $info['hash_key'] ) && $hash_key === $info['hash_key'] ) {
$found_secure = $info['secure'];
break;
}
}
return ! empty( $found_secure ) && hash_equals( $found_secure, $verify_secrect );
} elseif ( 'generate' === $act ) {
$gen_values = $this->generate_verify_hash();
$saved_values[] = array(
'hash_key' => $gen_values['hash_key'],
'secure' => $gen_values['secure'],
'date' => gmdate( 'Y-m-d H:i:s' ),
);
$gen_verify = $gen_values['key'] . '-' . $gen_values['secure'];
} elseif ( 'remove' === $act ) {
if ( ! empty( $saved_values ) ) {
array_pop( $saved_values );
}
} else {
return false;
}
if ( 5 < count( $saved_values ) ) {
array_shift( $saved_values );
}
update_user_option( $user_id, 'mainwp_child_user_verified_registers', wp_json_encode( $saved_values ) );
if ( ! empty( $gen_verify ) ) {
return $gen_verify;
}
}
/**
* Method is_verified_register().
*
* @param string $user_name User name.
*
* @return bool
*/
public function is_verified_register( $user_name ) { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
if ( ! $this->is_enabled_user_passwd_auth( $user_name ) ) {
return true; // not enable passwd auth, then return true.
}
//phpcs:disable WordPress.Security.NonceVerification
$user_pwd = isset( $_POST['userpwd'] ) ? trim( rawurldecode( $_POST['userpwd'] ) ) : ''; //phpcs:ignore -- NOSONAR - ok.
$reg_verify = isset( $_POST['regverify'] ) ? sanitize_text_field(wp_unslash( $_POST['regverify'] )) : ''; //phpcs:ignore -- NOSONAR - ok.
$is_valid_pwd = -1;
if ( ! empty( $user_pwd ) ) {
$is_valid_pwd = $this->is_valid_user_pwd( $user_name, $user_pwd );
return $is_valid_pwd ? true : false;
}
$is_dash_version_older_than_ver53 = empty( $_POST['mainwpver'] ) || version_compare( $_POST['mainwpver'], '5.3', '<' ) ? true : false;
if ( empty( $reg_verify ) && $this->is_never_verify_register( $user_name ) && $is_dash_version_older_than_ver53 ) {
// set it is valid one time.
return true;
}
//phpcs:enable WordPress.Security.NonceVerification
$is_valid_regis = $this->validate_register( $reg_verify, 'verify', $user_name );
return $is_valid_regis ? true : false;
}
/**
* Method is_enabled_user_passwd_auth().
*
* @param string $user_name User name.
*
* @return bool
*/
public function is_enabled_user_passwd_auth( $user_name ) {
$user = get_user_by( 'login', $user_name );
if ( ! $user ) {
return true;
}
$enable_pwd_auth_connect = get_user_option( 'mainwp_child_user_enable_passwd_auth_connect', $user->ID );
if ( false === $enable_pwd_auth_connect || '1' === $enable_pwd_auth_connect ) {
return true;
}
return false;
}
/**
* Method may_be_generate_register_verify().
*
* @return string
*/
private function may_be_generate_register_verify() { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
//phpcs:disable WordPress.Security.NonceVerification
$is_dash_version_older_than_ver53 = empty( $_POST['mainwpver'] ) || version_compare( $_POST['mainwpver'], '5.3', '<' ) ? true : false;
if ( $is_dash_version_older_than_ver53 ) {
return false; // not genereate verify registers for dashboard version before 5.2.
}
$reg_verify = isset( $_POST['regverify'] ) ? sanitize_text_field(wp_unslash( $_POST['regverify'] )) : ''; //phpcs:ignore -- NOSONAR - ok.
//phpcs:enable WordPress.Security.NonceVerification
if ( empty( $reg_verify ) ) {
return $this->validate_register( false, 'generate' );
}
$is_valid_regis = $this->validate_register( $reg_verify );
if ( $is_valid_regis ) { // do not need to generate.
return false;
}
// generate a new one, in case connection was validated.
return $this->validate_register( $reg_verify, 'generate' );
}
/**
* Method is_valid_user_pwd()
*
* Parse inistial authentication.
*
* @param string $username Admin login name.
* @param string $pwd Admin password.
*
* @return bool ture|false.
*/
public function is_valid_user_pwd( $username, $pwd ) { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
$user = get_user_by( 'login', $username );
if ( $user && ! empty( $user->user_pass ) ) {
return wp_check_password( $pwd, $user->user_pass, $user->ID );
}
return false;
}
/**
* Method generate_verify_hash()
*
* Generates a random hash to be used when generating the key and secret.
*
* @return array Returns.
*/
private function generate_verify_hash() {
$key = MainWP_Helper::rand_str_key();
return array(
'key' => $key,
'secure' => MainWP_Helper::rand_str_key(),
'hash_key' => hash_hmac( 'sha256', $key, 'register-verify' ),
);
}
/**
* Method is_never_verify_register()
*
* @param string $user_name Admin login name.
*
* @return bool ture|false.
*/
public function is_never_verify_register( $user_name ) { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
$user = get_user_by( 'login', $user_name );
if ( $user && ! empty( $user->ID ) ) {
$_values = get_user_option( 'mainwp_child_user_verified_registers', $user->ID );
$saved_values = ! empty( $_values ) ? json_decode( $_values, true ) : array();
if ( ! is_array( $saved_values ) ) {
$saved_values = array();
}
return empty( $saved_values ) ? true : false;
}
return false;
}
/**
* Method parse_init_auth()
*
* Parse inistial authentication.
*
* @param bool $auth True is authenticated, false if not.
*
* @return bool ture|false.
*
* @uses \MainWP\Child\MainWP_Child_Callable::is_callable_function()
* @uses \MainWP\Child\MainWP_Child_Callable::is_callable_function_no_auth()
* @uses \MainWP\Child\MainWP_Helper::instance()->error()
*/
public function parse_init_auth( $auth = false ) { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
// phpcs:disable WordPress.Security.NonceVerification
if ( ! $auth && isset( $_POST['mainwpsignature'] ) ) { // with 'mainwpsignature' then need to callable functions.
MainWP_Helper::instance()->error( esc_html__( 'Authentication failed! Please deactivate & re-activate the MainWP Child plugin on this child site and try again.', 'mainwp-child' ), 'PARSE_ERROR1' );
}
if ( ! $auth && isset( $_POST['function'] ) ) {
$func = isset( $_POST['function'] ) ? sanitize_text_field( wp_unslash( $_POST['function'] ) ) : '';
$callable = MainWP_Child_Callable::get_instance()->is_callable_function( $func );
$callable_no_auth = MainWP_Child_Callable::get_instance()->is_callable_function_no_auth( $func );
if ( $callable && ! $callable_no_auth && isset( $_POST['mainwpsignature'] ) ) {
MainWP_Helper::instance()->error( esc_html__( 'Authentication failed! Please deactivate & re-activate the MainWP Child plugin on this site and try again.', 'mainwp-child' ), 'PARSE_ERROR2' );
}
}
if ( $auth ) {
$auth_user = false;
// Check if the user exists & is an administrator.
if ( isset( $_POST['function'] ) && isset( $_POST['user'] ) ) {
$uname = '';
$user = null;
if ( isset( $_POST['alt_user'] ) && ! empty( $_POST['alt_user'] ) ) {
$uname = isset( $_POST['alt_user'] ) ? sanitize_text_field( wp_unslash( $_POST['alt_user'] ) ) : '';
if ( $this->check_login_as( $uname ) ) {
$auth_user = $uname;
// get alternative admin user.
$user = get_user_by( 'login', $auth_user );
}
}
// if alternative admin not existed.
if ( ! $user ) {
// check connected admin existed.
$uname = isset( $_POST['user'] ) ? sanitize_text_field( wp_unslash( $_POST['user'] ) ) : '';
$user = get_user_by( 'login', $uname );
$auth_user = $uname;
}
if ( ! $user ) {
MainWP_Helper::instance()->error( esc_html__( 'Unexisting administrator user. Please verify that it is an existing administrator.', 'mainwp-child' ), 'PARSE_ERROR3' );
}
if ( ! MainWP_Helper::is_admin( $user ) ) {
MainWP_Helper::instance()->error( esc_html__( 'User not administrator. Please use an administrator user to establish the connection.', 'mainwp-child' ), 'PARSE_ERROR4' );
}
// try to login.
$logged_in = $this->login( $auth_user );
// check just clone admin here.
$just_clone_admin = get_option( 'mainwp_child_just_clone_admin' );
$clone_sync = false;
if ( ! empty( $just_clone_admin ) ) {
delete_option( 'mainwp_child_just_clone_admin' );
if ( $uname !== $just_clone_admin ) {
$clone_sync = true;
}
}
// authed.
if ( $clone_sync && $logged_in ) {
$information = array();
$information['sync'] = MainWP_Child_Stats::get_instance()->get_site_stats( array(), false );
$information['sync']['clone_adminname'] = $just_clone_admin;
MainWP_Helper::write( $information ); // forced exit to sync clone admin.
}
}
if ( isset( $_POST['function'] ) && 'visitPermalink' === $_POST['function'] ) {
if ( empty( $auth_user ) ) {
$auth_user = isset( $_POST['user'] ) ? sanitize_text_field( wp_unslash( $_POST['user'] ) ) : '';
}
// try to login.
if ( $this->login( $auth_user, true ) ) {
return false; // authenticate failed.
} else {
exit();
}
}
// Redirect to the admin side if needed.
if ( isset( $_POST['admin'] ) && '1' === $_POST['admin'] ) {
wp_safe_redirect( get_option( 'siteurl' ) . '/wp-admin/' );
die();
}
}
// phpcs:enable
return true; // not authenticated.
}
/**
* Method auth()
*
* Connection authentication handler. Verifies that the signature is correct for the specified data using the public key associated with pub_key_id. This must be the public key corresponding to the private key used for signing.
*
* @param string $signature MainWP Dashboard signature.
* @param string $func Function to run.
* @param string $nonce Security nonce.
*
* @return int|bool $auth Returns 1 if authenticated, false if authentication fails.
*/
public function auth( $signature, $func, $nonce ) {
// phpcs:disable WordPress.Security.NonceVerification
if ( empty( $signature ) || ! isset( $func ) || ! get_option( 'mainwp_child_pubkey' ) ) {
$auth = false;
} else {
$algo = false;
if ( isset( $_REQUEST['sign_algo'] ) ) {
$algo = sanitize_text_field( wp_unslash( $_REQUEST['sign_algo'] ) );
}
$auth = static::connect_verify( $func . $nonce, base64_decode( $signature ), base64_decode( get_option( 'mainwp_child_pubkey' ) ), $algo ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions -- trust value.
if ( 1 !== $auth ) {
$auth = false;
}
}
// phpcs:enable
return $auth;
}
/**
* Method connect_verify()
*
* Verify connect.
*
* @param string $data Data sign.
* @param string $signature signature.
* @param string $pubkey Public key.
* @param mixed $alg signature algorithm.
*
* @return bool Connect valid or not.
*/
public static function connect_verify( $data, $signature, $pubkey, $alg ) {
// phpcs:disable WordPress.Security.NonceVerification
$use_seclib = isset( $_REQUEST['verifylib'] ) && ! empty( $_REQUEST['verifylib'] ) ? true : false;
// phpcs:enable
if ( $use_seclib ) {
return MainWP_Connect_Lib::verify( $data, $signature, $pubkey );
} else {
$verify = 0;
if ( false === $alg ) {
$child_sign_algo = get_option( 'mainwp_child_openssl_sign_algo', false );
if ( false === $child_sign_algo ) { // to compatible.
$verify = openssl_verify( $data, $signature, $pubkey ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions -- base64_encode function is used for http encode compatible.
}
} else {
$alg = static::get_connect_sign_algorithm( $alg );
static::check_to_requires_reconnect_for_sha1_safe( $alg );
$verify = openssl_verify( $data, $signature, $pubkey, $alg ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions -- base64_encode function is used for http encode compatible.
if ( 1 === $verify ) {
static::maybe_update_child_sign_algo( $alg );
}
}
return $verify;
}
}
/**
* Method get_connect_sign_algorithm().
*
* Get supported sign algorithms.
*
* @param mixed $alg Input value.
*
* @return mixed $alg Valid algorithm value.
*/
public static function get_connect_sign_algorithm( $alg ) {
if ( is_numeric( $alg ) ) {
$alg = intval( $alg );
}
if ( ! static::is_valid_supported_sign_alg( $alg ) ) {
$alg = false;
}
return $alg;
}
/**
* Method is_valid_supported_sign_alg().
*
* Check if valid supported Sign Algo value.
*
* @param mixed $alg Input value.
*
* @return mixed $valid Valid algorithm value.
*/
public static function is_valid_supported_sign_alg( $alg ) {
$valid = false;
if ( ( defined( 'OPENSSL_ALGO_SHA1' ) && OPENSSL_ALGO_SHA1 === $alg ) || ( defined( 'OPENSSL_ALGO_SHA224' ) && OPENSSL_ALGO_SHA224 === $alg ) || ( defined( 'OPENSSL_ALGO_SHA256' ) && OPENSSL_ALGO_SHA256 === $alg ) || ( defined( 'OPENSSL_ALGO_SHA384' ) && OPENSSL_ALGO_SHA384 === $alg ) || ( defined( 'OPENSSL_ALGO_SHA512' ) && OPENSSL_ALGO_SHA512 === $alg ) ) {
$valid = true;
}
return $valid;
}
/**
* Method check_to_requires_reconnect_for_sha1_safe()
*
* Check if need to deactive/active child plugin.
*
* @param int $alg_new Algo value.
* @throws MainWP_Exception|MainWP_Exception Error exception.
*/
public static function check_to_requires_reconnect_for_sha1_safe( $alg_new ) {
$child_sign_algo = get_option( 'mainwp_child_openssl_sign_algo', false );
if ( false === $alg_new && false === $child_sign_algo ) {
return;
}
if ( is_numeric( $alg_new ) ) {
$alg_new = intval( $alg_new );
}
if ( is_numeric( $child_sign_algo ) ) {
$child_sign_algo = intval( $child_sign_algo );
}
if ( ! empty( $child_sign_algo ) && defined( 'OPENSSL_ALGO_SHA1' ) && OPENSSL_ALGO_SHA1 !== $child_sign_algo && OPENSSL_ALGO_SHA1 === $alg_new ) {
throw new MainWP_Exception( esc_html__( 'To use OPENSSL_ALGO_SHA1 OpenSSL signature algorithm. Please deactivate & reactivate the MainWP Child plugin on the child site and try again.', 'mainwp-child' ) );
}
}
/**
* Method maybe_update_child_sign_algo()
*
* Check if need to update child sign algo settings.
*
* @param int $alg_new Algo value.
*/
public static function maybe_update_child_sign_algo( $alg_new ) {
$child_sign_algo = get_option( 'mainwp_child_openssl_sign_algo', false );
if ( is_numeric( $child_sign_algo ) ) {
$child_sign_algo = intval( $child_sign_algo );
}
$update = false;
if ( false === $child_sign_algo ) {
if ( false !== $alg_new ) {
$update = true;
}
} elseif ( $alg_new !== $child_sign_algo ) {
if ( defined( 'OPENSSL_ALGO_SHA1' ) && OPENSSL_ALGO_SHA1 !== $alg_new ) {
$update = true;
}
}
if ( $update ) {
// setting changed, need to update.
update_option( 'mainwp_child_openssl_sign_algo', $alg_new );
}
}
/**
* Method parse_login_required()
*
* Check if the login process is required.
*
* @throws MainWP_Exception|MainWP_Exception Error exception.
* @return bool Return true on success, false on failure.
*/
public function parse_login_required() { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
/**
* Current user global.
*
* @global string
*/
global $current_user;
// phpcs:disable WordPress.Security.NonceVerification
$alter_login_required = false;
$username = isset( $_REQUEST['user'] ) ? rawurldecode( wp_unslash( $_REQUEST['user'] ) ) : ''; //phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
if ( isset( $_REQUEST['alt_user'] ) ) {
$alter_login_required = ! empty( $_REQUEST['alt_user'] ) ? $this->check_login_as( wp_unslash( $_REQUEST['alt_user'] ) ) : false; //phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
if ( $alter_login_required ) {
$username = isset( $_REQUEST['alt_user'] ) ? rawurldecode( wp_unslash( $_REQUEST['alt_user'] ) ) : ''; //phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
}
}
if ( is_user_logged_in() && ! MainWP_Helper::is_admin() ) {
do_action( 'wp_logout' );
}
$signature = rawurldecode( isset( $_REQUEST['mainwpsignature'] ) ? wp_unslash( $_REQUEST['mainwpsignature'] ) : '' ); //phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$file = $this->get_request_files();
$where = ( isset( $_REQUEST['where'] ) ? wp_unslash( $_REQUEST['where'] ) : $file ); //phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$function = ! empty( $_POST['function'] ) ? sanitize_text_field( wp_unslash( $_POST['function'] ) ) : rawurldecode( $where ); //phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$nonce = isset( $_REQUEST['nonce'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['nonce'] ) ) : '';
try {
$auth = $this->auth( $signature, $function, $nonce );
} catch ( MainWP_Exception $ex ) {
$auth = false;
}
if ( ! $auth ) {
return false;
}
if ( ! is_user_logged_in() || $username !== $current_user->user_login ) {
if ( ! $this->login( $username ) ) {
return false;
}
// if is not alternative admin login.
// it is connected admin login.
if ( ! MainWP_Helper::is_admin() && ! $alter_login_required ) {
// log out if connected admin is not admin level 10.
do_action( 'wp_logout' );
return false;
}
}
// phpcs:enable
$this->check_redirects();
return true;
}
/**
* Method get_request_files()
*
* Parse HTTP request to get files.
*
* @return resource Requested file.
*/
private function get_request_files() {
// phpcs:disable WordPress.Security.NonceVerification
$file = '';
if ( isset( $_REQUEST['f'] ) ) {
$file = ! empty( $_REQUEST['f'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['f'] ) ) : '';
} elseif ( isset( $_REQUEST['file'] ) ) {
$file = ! empty( $_REQUEST['file'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['file'] ) ) : '';
} elseif ( isset( $_REQUEST['fdl'] ) ) {
$file = ! empty( $_REQUEST['fdl'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['fdl'] ) ) : '';
}
// phpcs:enable
return $file;
}
/**
* Method check_redirects()
*
* Handle redirects.
*
* @return bool Returns false if $_REQUEST['fdl'] is set.
*/
private function check_redirects() {
// phpcs:disable WordPress.Security.NonceVerification
if ( isset( $_REQUEST['fdl'] ) ) {
$fdl = isset( $_REQUEST['fdl'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['fdl'] ) ) : '';
if ( empty( $fdl ) || stristr( $fdl, '..' ) ) {
return false;
}
$foffset = isset( $_REQUEST['foffset'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['foffset'] ) ) : 0;
MainWP_Utility::instance()->upload_file_backup( $fdl, $foffset );
exit;
}
$open_location = ! empty( $_REQUEST['open_location'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['open_location'] ) ) : '';
// support for custom wp-admin slug.
if ( ! empty( $open_location ) ) {
$this->open_location_redirect( $open_location );
}
// phpcs:enable
$this->where_authed_redirect();
}
/**
* Method open_location_redirect()
*
* Jump to the wanted location (child site WP Admin page).
*
* @param string $open_location Desired location relative path.
*/
private function open_location_redirect( $open_location ) {
$_vars = static::parse_query( $open_location );
$_path = wp_parse_url( $open_location, PHP_URL_PATH );
if ( isset( $_vars['_mwpNoneName'] ) && isset( $_vars['_mwpNoneValue'] ) ) {
$_vars[ $_vars['_mwpNoneName'] ] = wp_create_nonce( $_vars['_mwpNoneValue'] );
unset( $_vars['_mwpNoneName'] );
unset( $_vars['_mwpNoneValue'] );
$open_url = '';
foreach ( $_vars as $key => $value ) {
$open_url .= $key . '=' . $value . '&';
}
$open_url = rtrim( $open_url, '&' );
$open_location = '/wp-admin/' . $_path . '?' . $open_url;
} elseif ( strpos( $open_location, 'nonce=child_temp_nonce' ) !== false ) {
$open_location = str_replace( 'nonce=child_temp_nonce', 'nonce=' . wp_create_nonce( 'wp-ajax' ), $open_location );
}
wp_safe_redirect( site_url() . $open_location );
exit();
}
/**
* Method parse_query()
*
* Parse query
*
* @param string $val Contains the parameter to prase.
*
* @return array $arr Array containing parsed arguments.
*/
public static function parse_query( $val ) {
$val = wp_parse_url( $val, PHP_URL_QUERY );
$val = html_entity_decode( $val );
$val = explode( '&', $val );
$arr = array();
foreach ( $val as $v ) {
$x = explode( '=', $v );
$arr[ $x[0] ] = $x[1];
}
unset( $v, $x, $val );
return $arr;
}
/**
* Method where_authed_redirect()
*
* Safe redirect to wanted location.
*/
private function where_authed_redirect() { //phpcs:ignore -- NOSONAR - complex.
// phpcs:disable WordPress.Security.NonceVerification,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$where = isset( $_REQUEST['where'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['where'] ) ) : '';
if ( isset( $_POST['f'] ) || isset( $_POST['file'] ) ) {
$file = '';
if ( isset( $_POST['f'] ) ) {
$file = ! empty( $_POST['f'] ) ? sanitize_text_field( wp_unslash( $_POST['f'] ) ) : '';
} elseif ( isset( $_POST['file'] ) ) {
$file = ! empty( $_POST['file'] ) ? sanitize_text_field( wp_unslash( $_POST['file'] ) ) : '';
}
$where = 'admin.php?page=mainwp_child_tab&tab=restore-clone';
if ( '' === session_id() ) {
session_start();
}
$_SESSION['file'] = $file;
$_SESSION['size'] = isset( $_POST['size'] ) ? sanitize_text_field( wp_unslash( $_POST['size'] ) ) : '';
} elseif ( isset( $_REQUEST['filedl'] ) && ! empty( $_REQUEST['filedl'] ) ) {
$auth_dl = array(
'file' => sanitize_text_field( wp_unslash( $_REQUEST['filedl'] ) ),
'dir' => isset( $_REQUEST['dirdl'] ) && ! empty( $_REQUEST['dirdl'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['dirdl'] ) ) : false,
);
$auth_dl = apply_filters( 'mainwp_child_authed_download_params', $auth_dl );
if ( ! empty( $auth_dl['file'] ) && isset( $auth_dl['dir'] ) ) {
$allow_dl = $this->validate_pre_download_file( $auth_dl['file'], $auth_dl['dir'] );
if ( $allow_dl ) {
$downloading = MainWP_Utility::instance()->upload_file( $auth_dl['file'], $auth_dl['dir'] );
if ( true === $downloading ) {
exit;
}
}
}
}
if ( ! empty( $_GET['where_params'] ) ) {
if ( false === strpos( $where, '?' ) ) {
$where .= '?';
} else {
$where .= '&';
}
$where .= sanitize_text_field( urldecode( wp_unslash( $_GET['where_params'] ) ) );
}
// phpcs:enable
wp_safe_redirect( admin_url( $where ) );
exit();
}
/**
* Method validate_pre_download_file()
*
* @param string $file File param request.
* @param string $dir Directory param request.
*
* @return bool Valid or not valid to download file.
*/
public function validate_pre_download_file( $file, $dir ) { // phpcs:ignore -- NOSONAR - multi return.
if ( empty( $dir ) ) {
$dir = dirname( $file ); // get dir of file to validate.
}
if ( false === stripos( ABSPATH, $dir ) ) {
$parent_dir = dirname( $dir );
if ( false === stripos( ABSPATH, $parent_dir ) ) { // check parent folder of download folder.
$parent_parent_dir = dirname( $parent_dir );
if ( false === stripos( ABSPATH, $parent_parent_dir ) ) { // check parent parent folder of download folder.
return false; // only allows download in related home folder.
}
}
}
if ( empty( $dir ) || '/' === $dir || '\\' === $dir || '.' === $dir || stristr( $dir, '..' ) ) {
return false; // not allow.
}
$file = str_replace( $dir . '/', '', $file );
if ( stristr( $file, '/' ) ) {
return false; // not allow to secure.
}
// file not found.
if ( ! file_exists( $dir . '/' . $file ) ) {
return false;
}
return true;
}
/**
* Method check_login()
*
* Auto-login user to the child site when the Open WP Admin feature from the MainWP Dashboard is used.
*
* @return bool Return false if $_POST['mainwpsignature'] is not set.
*
* @throws MainWP_Exception|MainWP_Exception Error exception.
* @uses MainWP_Connect::login() Handle the login process.
* @uses \MainWP\Child\MainWP_Helper::instance()->error()
*/
public function check_login() { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
// phpcs:disable WordPress.Security.NonceVerification
if ( ! isset( $_POST['mainwpsignature'] ) || empty( $_POST['mainwpsignature'] ) ) {
return false;
}
$file = $this->get_request_files();
$where = isset( $_REQUEST['where'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['where'] ) ) : $file;
$mainwpsignature = isset( $_POST['mainwpsignature'] ) ? rawurldecode( wp_unslash( $_POST['mainwpsignature'] ) ) : ''; //phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$function = ! empty( $_POST['function'] ) ? sanitize_text_field( wp_unslash( $_POST['function'] ) ) : rawurldecode( $where );
$nonce = MainWP_System::instance()->validate_params( 'nonce' );
try {
$auth = $this->auth( $mainwpsignature, $function, $nonce );
} catch ( MainWP_Exception $ex ) {
$error = $ex->getMessage();
if ( ! empty( $error ) && is_string( $error ) ) {
MainWP_Helper::instance()->error( esc_html( $error ) );
}
$auth = false;
}
if ( ! $auth ) {
MainWP_Helper::instance()->error( esc_html__( 'Authentication failed! Please deactivate and re-activate the MainWP Child plugin on this site.', 'mainwp-child' ) );
}
$auth_user = false;
if ( $auth ) {
// disable duo auth for mainwp.
remove_action( 'init', 'duo_verify_auth', 10 );
// Check if the user exists & is an administrator.
if ( isset( $_POST['function'] ) && isset( $_POST['user'] ) ) {
$user = null;
if ( isset( $_POST['alt_user'] ) && ! empty( $_POST['alt_user'] ) && $this->check_login_as( sanitize_text_field( wp_unslash( $_POST['alt_user'] ) ) ) ) {
$auth_user = isset( $_POST['alt_user'] ) ? sanitize_text_field( wp_unslash( $_POST['alt_user'] ) ) : '';
$user = get_user_by( 'login', $auth_user );
}
// if not valid alternative admin.
if ( ! $user ) {
// check connected admin existed.
$uname = isset( $_POST['user'] ) ? sanitize_text_field( wp_unslash( $_POST['user'] ) ) : '';
$user = get_user_by( 'login', $uname );
$auth_user = $uname;
}
if ( ! $user ) {
MainWP_Helper::instance()->error( esc_html__( 'Unexisting administrator user. Please verify that it is an existing administrator.', 'mainwp-child' ) );
}
if ( ! MainWP_Helper::is_admin( $user ) ) {
MainWP_Helper::instance()->error( esc_html__( 'User not administrator. Please use an administrator user to establish the connection.', 'mainwp-child' ) );
}
$this->login( $auth_user );
}
if ( isset( $_POST['function'] ) && 'visitPermalink' === $_POST['function'] ) {
if ( empty( $auth_user ) ) {
$auth_user = isset( $_POST['user'] ) ? sanitize_text_field( wp_unslash( $_POST['user'] ) ) : '';
}
if ( $this->login( $auth_user, true ) ) {
return;
} else {
exit();
}
}
// Redirect to the admin part if needed.
if ( isset( $_POST['admin'] ) && '1' === $_POST['admin'] ) {
wp_safe_redirect( get_option( 'siteurl' ) . '/wp-admin/' );
die();
}
}
// phpcs:enable
}
/**
* Method check_login_as()
*
* Auto-login alternative user to the child site when the Open WP Admin feature from the MainWP Dashboard is used.
*
* @param string $alter_login Alternative user account to log into.
*
* @used-by MainWP_Child::check_login() Auto-login user to the child site when the Open WP Admin feature from the MainWP Dashboard is used.
*
* @return bool Return false will log in as default admin user. Return true will try to login as alternative user.
*/
public function check_login_as( $alter_login ) {
if ( ! empty( $alter_login ) ) {
// check alternative admin existed.
$user = get_user_by( 'login', $alter_login );
if ( ! $user || ! MainWP_Helper::is_admin( $user ) ) {
// That administrator username was not found on this child site.
return false;
}
return true; // ok, will try to login by alternative user.
}
return false;
}
/**
* Method login()
*
* The login process handler.
*
* @param string $username Contains the account username.
* @param bool $doAction If true, run 'wp_login' action aftr the login.
*
* @used-by MainWP_Child::check_login() Auto-login user to the child site when the Open WP Admin feature from the MainWP Dashboard is used.
*
* @return bool true|false
*/
public function login( $username, $doAction = false ) { // phpcs:ignore -- NOSONAR - multi return.
/**
* Current user global.
*
* @global string
*/
global $current_user;
// Logout if required.
if ( isset( $current_user->user_login ) ) {
if ( $current_user->user_login === $username ) {
// to fix issue multi user session.
$user_id = wp_validate_auth_cookie();
if ( $user_id && $user_id === $current_user->ID ) {
$this->check_compatible_connect_info();
return true;
}
wp_set_auth_cookie( $current_user->ID );
$this->check_compatible_connect_info();
return true;
}
do_action( 'wp_logout' );
}
$user = get_user_by( 'login', $username );
if ( $user ) {
wp_set_current_user( $user->ID );
wp_set_auth_cookie( $user->ID );
if ( $doAction ) {
do_action( 'wp_login', $user->user_login );
}
$logged_in = ( is_user_logged_in() && $current_user->user_login === $username );
if ( $logged_in ) {
$this->check_compatible_connect_info();
}
$this->connect_user = $user;
return $logged_in;
}
return false;
}
/**
* Method get_connected_user()
*/
public function get_connected_user() {
return $this->connect_user;
}
/**
* Method check_other_auth()
*
* Check other authentication methods.
*
* @uses \MainWP\Child\MainWP_Helper::rand_string()
* @uses \MainWP\Child\MainWP_Helper::update_option()
*/
public function check_other_auth() {
$auths = get_option( 'mainwp_child_auth' );
if ( ! is_array( $auths ) ) {
$auths = array();
}
if ( ! isset( $auths['last'] ) || $auths['last'] < mktime( 0, 0, 0, date( 'm' ), date( 'd' ), date( 'Y' ) ) ) { // phpcs:ignore -- local time required to achieve desired results, pull request solutions appreciated.
// Generate code for today.
for ( $i = 0; $i < $this->maxHistory; $i++ ) {
if ( ! isset( $auths[ $i + 1 ] ) ) {
continue;
}
$auths[ $i ] = $auths[ $i + 1 ];
}
$newI = $this->maxHistory + 1;
while ( isset( $auths[ $newI ] ) ) {
unset( $auths[ $newI++ ] );
}
$auths[ $this->maxHistory ] = md5( MainWP_Helper::rand_string( 14 ) ); // NOSONAR - safe.
$auths['last'] = time();
MainWP_Helper::update_option( 'mainwp_child_auth', $auths, 'yes' );
}
}
/**
* Method is_valid_auth()
*
* Check if authentication is valid.
*
* @param string $key Contains the authentication key to check.
*
* @return bool true|false If valid authentication, return true, if not, return false.
*/
public function is_valid_auth( $key ) {
$auths = get_option( 'mainwp_child_auth' );
if ( ! is_array( $auths ) ) {
return false;
}
for ( $i = 0; $i <= $this->maxHistory; $i++ ) {
if ( isset( $auths[ $i ] ) && ( $auths[ $i ] === $key ) ) {
return true;
}
}
return false;
}
/**
* Method get_max_history()
*
* @return int The max history value.
*/
public function get_max_history() {
return $this->maxHistory;
}
/**
* Method check_compatible_connect_info()
*
* Check check compatible connected info.
*/
public function check_compatible_connect_info() {
global $current_user;
$con_username = isset( $_POST['user'] ) ? wp_unslash( $_POST['user'] ) : ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput,InputNotSanitized,WordPress.Security.NonceVerification
if ( ! empty( $con_username ) && $current_user->user_login === $con_username ) {
$connected_admin = get_option( 'mainwp_child_connected_admin', '' );
if ( empty( $connected_admin ) ) {
// to comparable.
MainWP_Helper::update_option( 'mainwp_child_connected_admin', $con_username, 'yes' );
}
}
}
}