get_stylesheet_directory() . '/' . $file; - if ( ! wp_verify_nonce( $args['nonce'], 'edit-theme_' . $real_file . $stylesheet ) ) { + if ( ! wp_verify_nonce( $args['nonce'], 'edit-theme_' . $stylesheet . '_' . $file ) ) { return new WP_Error( 'nonce_failure' ); } @@ -435,9 +435,9 @@ $allowed_files = array_merge( $allowed_files, $theme->get_files( 'php', -1 ) ); break; case 'css': - $style_files = $theme->get_files( 'css', -1 ); + $style_files = $theme->get_files( 'css', -1 ); $allowed_files['style.css'] = $style_files['style.css']; - $allowed_files = array_merge( $allowed_files, $style_files ); + $allowed_files = array_merge( $allowed_files, $style_files ); break; default: $allowed_files = array_merge( $allowed_files, $theme->get_files( $type, -1 ) ); @@ -450,7 +450,10 @@ return new WP_Error( 'disallowed_theme_file', __( 'Sorry, that file cannot be edited.' ) ); } + $real_file = $theme->get_stylesheet_directory() . '/' . $file; + $is_active = ( get_stylesheet() === $stylesheet || get_template() === $stylesheet ); + } else { return new WP_Error( 'missing_theme_or_plugin' ); } @@ -491,17 +494,17 @@ if ( $is_active && 'php' === $extension ) { - $scrape_key = md5( rand() ); - $transient = 'scrape_key_' . $scrape_key; + $scrape_key = md5( rand() ); + $transient = 'scrape_key_' . $scrape_key; $scrape_nonce = strval( rand() ); set_transient( $transient, $scrape_nonce, 60 ); // It shouldn't take more than 60 seconds to make the two loopback requests. - $cookies = wp_unslash( $_COOKIE ); + $cookies = wp_unslash( $_COOKIE ); $scrape_params = array( - 'wp_scrape_key' => $scrape_key, + 'wp_scrape_key' => $scrape_key, 'wp_scrape_nonce' => $scrape_nonce, ); - $headers = array( + $headers = array( 'Cache-Control' => 'no-cache', ); @@ -517,7 +520,7 @@ $timeout = 100; $needle_start = "###### wp_scraping_result_start:$scrape_key ######"; - $needle_end = "###### wp_scraping_result_end:$scrape_key ######"; + $needle_end = "###### wp_scraping_result_end:$scrape_key ######"; // Attempt loopback request to editor to see if user just whitescreened themselves. if ( $plugin ) { @@ -526,23 +529,23 @@ $url = add_query_arg( array( 'theme' => $stylesheet, - 'file' => $file, + 'file' => $file, ), admin_url( 'theme-editor.php' ) ); } else { $url = admin_url(); } - $url = add_query_arg( $scrape_params, $url ); - $r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) ); - $body = wp_remote_retrieve_body( $r ); + $url = add_query_arg( $scrape_params, $url ); + $r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) ); + $body = wp_remote_retrieve_body( $r ); $scrape_result_position = strpos( $body, $needle_start ); $loopback_request_failure = array( - 'code' => 'loopback_request_failed', + 'code' => 'loopback_request_failed', 'message' => __( 'Unable to communicate back with site to check for fatal errors, so the PHP change was reverted. You will need to upload your PHP file change by some other means, such as by using SFTP.' ), ); - $json_parse_failure = array( + $json_parse_failure = array( 'code' => 'json_parse_error', ); @@ -552,7 +555,7 @@ } else { $error_output = substr( $body, $scrape_result_position + strlen( $needle_start ) ); $error_output = substr( $error_output, 0, strpos( $error_output, $needle_end ) ); - $result = json_decode( trim( $error_output ), true ); + $result = json_decode( trim( $error_output ), true ); if ( empty( $result ) ) { $result = $json_parse_failure; } @@ -560,10 +563,10 @@ // Try making request to homepage as well to see if visitors have been whitescreened. if ( true === $result ) { - $url = home_url( '/' ); - $url = add_query_arg( $scrape_params, $url ); - $r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) ); - $body = wp_remote_retrieve_body( $r ); + $url = home_url( '/' ); + $url = add_query_arg( $scrape_params, $url ); + $r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) ); + $body = wp_remote_retrieve_body( $r ); $scrape_result_position = strpos( $body, $needle_start ); if ( false === $scrape_result_position ) { @@ -571,7 +574,7 @@ } else { $error_output = substr( $body, $scrape_result_position + strlen( $needle_start ) ); $error_output = substr( $error_output, 0, strpos( $error_output, $needle_end ) ); - $result = json_decode( trim( $error_output ), true ); + $result = json_decode( trim( $error_output ), true ); if ( empty( $result ) ) { $result = $json_parse_failure; } @@ -625,7 +628,7 @@ } if ( empty( $filename ) || '.' == $filename || '/' == $filename || '\\' == $filename ) { - $filename = time(); + $filename = uniqid(); } // Use the basename of the given file without the extension as the name for the temporary directory @@ -640,7 +643,7 @@ // Suffix some random data to avoid filename conflicts $temp_filename .= '-' . wp_generate_password( 6, false ); $temp_filename .= '.tmp'; - $temp_filename = $dir . wp_unique_filename( $dir, $temp_filename ); + $temp_filename = $dir . wp_unique_filename( $dir, $temp_filename ); $fp = @fopen( $temp_filename, 'x' ); if ( ! $fp && is_writable( $dir ) && file_exists( $temp_filename ) ) { @@ -660,24 +663,25 @@ * * @since 1.5.0 * - * @param string $file File the user is attempting to edit. - * @param array $allowed_files Optional. Array of allowed files to edit, $file must match an entry exactly. - * @return string|null + * @param string $file File the user is attempting to edit. + * @param string[] $allowed_files Optional. Array of allowed files to edit. `$file` must match an entry exactly. + * @return string|void Returns the file name on success, dies on failure. */ function validate_file_to_edit( $file, $allowed_files = array() ) { $code = validate_file( $file, $allowed_files ); - if (!$code ) + if ( ! $code ) { return $file; + } switch ( $code ) { - case 1 : + case 1: wp_die( __( 'Sorry, that file cannot be edited.' ) ); - // case 2 : - // wp_die( __('Sorry, can’t call files with their real path.' )); + // case 2 : + // wp_die( __('Sorry, can’t call files with their real path.' )); - case 3 : + case 3: wp_die( __( 'Sorry, that file cannot be edited.' ) ); } } @@ -691,12 +695,12 @@ * * @see wp_handle_upload_error * - * @param array $file Reference to a single element of $_FILES. Call the function once for each uploaded file. - * @param array|false $overrides An associative array of names => values to override default variables. Default false. - * @param string $time Time formatted in 'yyyy/mm'. - * @param string $action Expected value for $_POST['action']. - * @return array On success, returns an associative array of file attributes. On failure, returns - * $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ). + * @param string[] $file Reference to a single element of `$_FILES`. Call the function once for each uploaded file. + * @param string[]|false $overrides An associative array of names => values to override default variables. Default false. + * @param string $time Time formatted in 'yyyy/mm'. + * @param string $action Expected value for `$_POST['action']`. + * @return string[] On success, returns an associative array of file attributes. On failure, returns + * `$overrides['upload_error_handler'](&$file, $message )` or `array( 'error'=>$message )`. */ function _wp_handle_upload( &$file, $overrides, $time, $action ) { // The default error handler. @@ -714,7 +718,7 @@ * @since 2.9.0 as 'wp_handle_upload_prefilter'. * @since 4.0.0 Converted to a dynamic hook with `$action`. * - * @param array $file An array of data for a single file. + * @param string[] $file An array of data for a single file. */ $file = apply_filters( "{$action}_prefilter", $file ); @@ -754,7 +758,7 @@ '', __( 'Missing a temporary folder.' ), __( 'Failed to write file to disk.' ), - __( 'File upload stopped by extension.' ) + __( 'File upload stopped by extension.' ), ); } @@ -764,7 +768,7 @@ // If you override this, you must provide $ext and $type!! $test_type = isset( $overrides['test_type'] ) ? $overrides['test_type'] : true; - $mimes = isset( $overrides['mimes'] ) ? $overrides['mimes'] : false; + $mimes = isset( $overrides['mimes'] ) ? $overrides['mimes'] : false; // A correct form post will pass this test. if ( $test_form && ( ! isset( $_POST['action'] ) || ( $_POST['action'] != $action ) ) ) { @@ -775,6 +779,12 @@ return call_user_func_array( $upload_error_handler, array( &$file, $upload_error_strings[ $file['error'] ] ) ); } + // A properly uploaded file will pass this test. There should be no reason to override this one. + $test_uploaded_file = 'wp_handle_upload' === $action ? @ is_uploaded_file( $file['tmp_name'] ) : @ is_readable( $file['tmp_name'] ); + if ( ! $test_uploaded_file ) { + return call_user_func_array( $upload_error_handler, array( &$file, __( 'Specified file failed upload test.' ) ) ); + } + $test_file_size = 'wp_handle_upload' === $action ? $file['size'] : filesize( $file['tmp_name'] ); // A non-empty file will pass this test. if ( $test_size && ! ( $test_file_size > 0 ) ) { @@ -786,24 +796,18 @@ return call_user_func_array( $upload_error_handler, array( &$file, $error_msg ) ); } - // A properly uploaded file will pass this test. There should be no reason to override this one. - $test_uploaded_file = 'wp_handle_upload' === $action ? @ is_uploaded_file( $file['tmp_name'] ) : @ is_file( $file['tmp_name'] ); - if ( ! $test_uploaded_file ) { - return call_user_func_array( $upload_error_handler, array( &$file, __( 'Specified file failed upload test.' ) ) ); - } - // A correct MIME type will pass this test. Override $mimes or use the upload_mimes filter. if ( $test_type ) { - $wp_filetype = wp_check_filetype_and_ext( $file['tmp_name'], $file['name'], $mimes ); - $ext = empty( $wp_filetype['ext'] ) ? '' : $wp_filetype['ext']; - $type = empty( $wp_filetype['type'] ) ? '' : $wp_filetype['type']; + $wp_filetype = wp_check_filetype_and_ext( $file['tmp_name'], $file['name'], $mimes ); + $ext = empty( $wp_filetype['ext'] ) ? '' : $wp_filetype['ext']; + $type = empty( $wp_filetype['type'] ) ? '' : $wp_filetype['type']; $proper_filename = empty( $wp_filetype['proper_filename'] ) ? '' : $wp_filetype['proper_filename']; // Check to see if wp_check_filetype_and_ext() determined the filename was incorrect if ( $proper_filename ) { $file['name'] = $proper_filename; } - if ( ( ! $type || !$ext ) && ! current_user_can( 'unfiltered_upload' ) ) { + if ( ( ! $type || ! $ext ) && ! current_user_can( 'unfiltered_upload' ) ) { return call_user_func_array( $upload_error_handler, array( &$file, __( 'Sorry, this file type is not permitted for security reasons.' ) ) ); } if ( ! $type ) { @@ -826,7 +830,7 @@ // Move the file to the uploads dir. $new_file = $uploads['path'] . "/$filename"; - /** + /** * Filters whether to short-circuit moving the uploaded file after passing all checks. * * If a non-null value is passed to the filter, moving the file and any related error @@ -856,12 +860,12 @@ } else { $error_path = basename( $uploads['basedir'] ) . $uploads['subdir']; } - return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $error_path ) ); + return $upload_error_handler( $file, sprintf( __( 'The uploaded file could not be moved to %s.' ), $error_path ) ); } } // Set correct file permissions. - $stat = stat( dirname( $new_file )); + $stat = stat( dirname( $new_file ) ); $perms = $stat['mode'] & 0000666; @ chmod( $new_file, $perms ); @@ -886,11 +890,15 @@ * } * @param string $context The type of upload action. Values include 'upload' or 'sideload'. */ - return apply_filters( 'wp_handle_upload', array( - 'file' => $new_file, - 'url' => $url, - 'type' => $type - ), 'wp_handle_sideload' === $action ? 'sideload' : 'upload' ); + return apply_filters( + 'wp_handle_upload', + array( + 'file' => $new_file, + 'url' => $url, + 'type' => $type, + ), + 'wp_handle_sideload' === $action ? 'sideload' : 'upload' + ); } /** @@ -953,36 +961,71 @@ /** - * Downloads a URL to a local temporary file using the WordPress HTTP Class. - * Please note, That the calling function must unlink() the file. + * Downloads a URL to a local temporary file using the WordPress HTTP API. + * + * Please note that the calling function must unlink() the file. * * @since 2.5.0 + * @since 5.2.0 Signature Verification with SoftFail was added. * - * @param string $url the URL of the file to download - * @param int $timeout The timeout for the request to download the file default 300 seconds - * @return mixed WP_Error on failure, string Filename on success. + * @param string $url The URL of the file to download. + * @param int $timeout The timeout for the request to download the file. Default 300 seconds. + * @param bool $signature_verification Whether to perform Signature Verification. Default false. + * @return string|WP_Error Filename on success, WP_Error on failure. */ -function download_url( $url, $timeout = 300 ) { +function download_url( $url, $timeout = 300, $signature_verification = false ) { //WARNING: The file is not automatically deleted, The script must unlink() the file. - if ( ! $url ) - return new WP_Error('http_no_url', __('Invalid URL Provided.')); + if ( ! $url ) { + return new WP_Error( 'http_no_url', __( 'Invalid URL Provided.' ) ); + } $url_filename = basename( parse_url( $url, PHP_URL_PATH ) ); $tmpfname = wp_tempnam( $url_filename ); - if ( ! $tmpfname ) - return new WP_Error('http_no_file', __('Could not create Temporary file.')); + if ( ! $tmpfname ) { + return new WP_Error( 'http_no_file', __( 'Could not create Temporary file.' ) ); + } - $response = wp_safe_remote_get( $url, array( 'timeout' => $timeout, 'stream' => true, 'filename' => $tmpfname ) ); + $response = wp_safe_remote_get( + $url, + array( + 'timeout' => $timeout, + 'stream' => true, + 'filename' => $tmpfname, + ) + ); if ( is_wp_error( $response ) ) { unlink( $tmpfname ); return $response; } - if ( 200 != wp_remote_retrieve_response_code( $response ) ){ + $response_code = wp_remote_retrieve_response_code( $response ); + + if ( 200 != $response_code ) { + $data = array( + 'code' => $response_code, + ); + + // Retrieve a sample of the response body for debugging purposes. + $tmpf = fopen( $tmpfname, 'rb' ); + if ( $tmpf ) { + /** + * Filters the maximum error response body size in `download_url()`. + * + * @since 5.1.0 + * + * @see download_url() + * + * @param int $size The maximum error response body size. Default 1 KB. + */ + $response_size = apply_filters( 'download_url_error_max_body_size', KB_IN_BYTES ); + $data['body'] = fread( $tmpf, $response_size ); + fclose( $tmpf ); + } + unlink( $tmpfname ); - return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ) ); + return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ), $data ); } $content_md5 = wp_remote_retrieve_header( $response, 'content-md5' ); @@ -994,6 +1037,83 @@ } } + // If the caller expects signature verification to occur, check to see if this URL supports it. + if ( $signature_verification ) { + /** + * Filters the list of hosts which should have Signature Verification attempteds on. + * + * @since 5.2.0 + * + * @param array List of hostnames. + */ + $signed_hostnames = apply_filters( 'wp_signature_hosts', array( 'wordpress.org', 'downloads.wordpress.org', 's.w.org' ) ); + $signature_verification = in_array( parse_url( $url, PHP_URL_HOST ), $signed_hostnames, true ); + } + + // Perform signature valiation if supported. + if ( $signature_verification ) { + $signature = wp_remote_retrieve_header( $response, 'x-content-signature' ); + if ( ! $signature ) { + // Retrieve signatures from a file if the header wasn't included. + // WordPress.org stores signatures at $package_url.sig + + $signature_url = false; + $url_path = parse_url( $url, PHP_URL_PATH ); + if ( substr( $url_path, -4 ) == '.zip' || substr( $url_path, -7 ) == '.tar.gz' ) { + $signature_url = str_replace( $url_path, $url_path . '.sig', $url ); + } + + /** + * Filter the URL where the signature for a file is located. + * + * @since 5.2.0 + * + * @param false|string $signature_url The URL where signatures can be found for a file, or false if none are known. + * @param string $url The URL being verified. + */ + $signature_url = apply_filters( 'wp_signature_url', $signature_url, $url ); + + if ( $signature_url ) { + $signature_request = wp_safe_remote_get( + $signature_url, + array( + 'limit_response_size' => 10 * 1024, // 10KB should be large enough for quite a few signatures. + ) + ); + + if ( ! is_wp_error( $signature_request ) && 200 === wp_remote_retrieve_response_code( $signature_request ) ) { + $signature = explode( "\n", wp_remote_retrieve_body( $signature_request ) ); + } + } + } + + // Perform the checks. + $signature_verification = verify_file_signature( $tmpfname, $signature, basename( parse_url( $url, PHP_URL_PATH ) ) ); + } + + if ( is_wp_error( $signature_verification ) ) { + if ( + /** + * Filters whether Signature Verification failures should be allowed to soft fail. + * + * WARNING: This may be removed from a future release. + * + * @since 5.2.0 + * + * @param bool $signature_softfail If a softfail is allowed. + * @param string $url The url being accessed. + */ + apply_filters( 'wp_signature_softfail', true, $url ) + ) { + $signature_verification->add_data( $tmpfname, 'softfail-filename' ); + } else { + // Hard-fail. + unlink( $tmpfname ); + } + + return $signature_verification; + } + return $tmpfname; } @@ -1002,68 +1122,261 @@ * * @since 3.7.0 * - * @param string $filename The filename to check the MD5 of. - * @param string $expected_md5 The expected MD5 of the file, either a base64 encoded raw md5, or a hex-encoded md5 - * @return bool|object WP_Error on failure, true on success, false when the MD5 format is unknown/unexpected + * @param string $filename The filename to check the MD5 of. + * @param string $expected_md5 The expected MD5 of the file, either a base64-encoded raw md5, + * or a hex-encoded md5. + * @return bool|WP_Error True on success, false when the MD5 format is unknown/unexpected, + * WP_Error on failure. */ function verify_file_md5( $filename, $expected_md5 ) { - if ( 32 == strlen( $expected_md5 ) ) + if ( 32 == strlen( $expected_md5 ) ) { $expected_raw_md5 = pack( 'H*', $expected_md5 ); - elseif ( 24 == strlen( $expected_md5 ) ) + } elseif ( 24 == strlen( $expected_md5 ) ) { $expected_raw_md5 = base64_decode( $expected_md5 ); - else + } else { return false; // unknown format + } $file_md5 = md5_file( $filename, true ); - if ( $file_md5 === $expected_raw_md5 ) + if ( $file_md5 === $expected_raw_md5 ) { return true; + } return new WP_Error( 'md5_mismatch', sprintf( __( 'The checksum of the file (%1$s) does not match the expected checksum value (%2$s).' ), bin2hex( $file_md5 ), bin2hex( $expected_raw_md5 ) ) ); } /** - * Unzips a specified ZIP file to a location on the Filesystem via the WordPress Filesystem Abstraction. - * Assumes that WP_Filesystem() has already been called and set up. Does not extract a root-level __MACOSX directory, if present. + * Verifies the contents of a file against its ED25519 signature. + * + * @since 5.2.0 + * + * @param string $filename The file to validate. + * @param string|array $signatures A Signature provided for the file. + * @param string $filename_for_errors A friendly filename for errors. Optional. * - * Attempts to increase the PHP Memory limit to 256M before uncompressing, - * However, The most memory required shouldn't be much larger than the Archive itself. + * @return bool|WP_Error true on success, false if verificaiton not attempted, or WP_Error describing an error condition. + */ +function verify_file_signature( $filename, $signatures, $filename_for_errors = false ) { + if ( ! $filename_for_errors ) { + $filename_for_errors = wp_basename( $filename ); + } + + // Check we can process signatures. + if ( ! function_exists( 'sodium_crypto_sign_verify_detached' ) || ! in_array( 'sha384', array_map( 'strtolower', hash_algos() ) ) ) { + return new WP_Error( + 'signature_verification_unsupported', + sprintf( + /* translators: %s: The filename of the package. */ + __( 'The authenticity of %s could not be verified as signature verification is unavailable on this system.' ), + '' . esc_html( $filename_for_errors ) . '' + ), + ( ! function_exists( 'sodium_crypto_sign_verify_detached' ) ? 'sodium_crypto_sign_verify_detached' : 'sha384' ) + ); + } + + // Check for a edge-case affecting PHP Maths abilities + if ( + ! extension_loaded( 'sodium' ) && + in_array( PHP_VERSION_ID, [ 70200, 70201, 70202 ], true ) && + extension_loaded( 'opcache' ) + ) { + // Sodium_Compat isn't compatible with PHP 7.2.0~7.2.2 due to a bug in the PHP Opcache extension, bail early as it'll fail. + // https://bugs.php.net/bug.php?id=75938 + + return new WP_Error( + 'signature_verification_unsupported', + sprintf( + /* translators: %s: The filename of the package. */ + __( 'The authenticity of %s could not be verified as signature verification is unavailable on this system.' ), + '' . esc_html( $filename_for_errors ) . '' + ), + array( + 'php' => phpversion(), + 'sodium' => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ), + ) + ); + + } + + // Verify runtime speed of Sodium_Compat is acceptable. + if ( ! extension_loaded( 'sodium' ) && ! ParagonIE_Sodium_Compat::polyfill_is_fast() ) { + $sodium_compat_is_fast = false; + + // Allow for an old version of Sodium_Compat being loaded before the bundled WordPress one. + if ( method_exists( 'ParagonIE_Sodium_Compat', 'runtime_speed_test' ) ) { + // Run `ParagonIE_Sodium_Compat::runtime_speed_test()` in optimized integer mode, as that's what WordPress utilises during signing verifications. + $old_fastMult = ParagonIE_Sodium_Compat::$fastMult; + ParagonIE_Sodium_Compat::$fastMult = true; + $sodium_compat_is_fast = ParagonIE_Sodium_Compat::runtime_speed_test( 100, 10 ); + ParagonIE_Sodium_Compat::$fastMult = $old_fastMult; + } + + // This cannot be performed in a reasonable amount of time + // https://github.com/paragonie/sodium_compat#help-sodium_compat-is-slow-how-can-i-make-it-fast + if ( ! $sodium_compat_is_fast ) { + return new WP_Error( + 'signature_verification_unsupported', + sprintf( + /* translators: %s: The filename of the package. */ + __( 'The authenticity of %s could not be verified as signature verification is unavailable on this system.' ), + '' . esc_html( $filename_for_errors ) . '' + ), + array( + 'php' => phpversion(), + 'sodium' => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ), + 'polyfill_is_fast' => false, + 'max_execution_time' => ini_get( 'max_execution_time' ), + ) + ); + } + } + + if ( ! $signatures ) { + return new WP_Error( + 'signature_verification_no_signature', + sprintf( + /* translators: %s: The filename of the package. */ + __( 'The authenticity of %s could not be verified as no signature was found.' ), + '' . esc_html( $filename_for_errors ) . '' + ), + array( + 'filename' => $filename_for_errors, + ) + ); + } + + $trusted_keys = wp_trusted_keys(); + $file_hash = hash_file( 'sha384', $filename, true ); + + mbstring_binary_safe_encoding(); + + $skipped_key = $skipped_signature = 0; + + foreach ( (array) $signatures as $signature ) { + $signature_raw = base64_decode( $signature ); + + // Ensure only valid-length signatures are considered. + if ( SODIUM_CRYPTO_SIGN_BYTES !== strlen( $signature_raw ) ) { + $skipped_signature++; + continue; + } + + foreach ( (array) $trusted_keys as $key ) { + $key_raw = base64_decode( $key ); + + // Only pass valid public keys through. + if ( SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES !== strlen( $key_raw ) ) { + $skipped_key++; + continue; + } + + if ( sodium_crypto_sign_verify_detached( $signature_raw, $file_hash, $key_raw ) ) { + reset_mbstring_encoding(); + return true; + } + } + } + + reset_mbstring_encoding(); + + return new WP_Error( + 'signature_verification_failed', + sprintf( + /* translators: %s: The filename of the package. */ + __( 'The authenticity of %s could not be verified.' ), + '' . esc_html( $filename_for_errors ) . '' + ), + // Error data helpful for debugging: + array( + 'filename' => $filename_for_errors, + 'keys' => $trusted_keys, + 'signatures' => $signatures, + 'hash' => bin2hex( $file_hash ), + 'skipped_key' => $skipped_key, + 'skipped_sig' => $skipped_signature, + 'php' => phpversion(), + 'sodium' => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ), + ) + ); +} + +/** + * Retrieve the list of signing keys trusted by WordPress. + * + * @since 5.2.0 + * + * @return array List of base64-encoded Signing keys. + */ +function wp_trusted_keys() { + $trusted_keys = array(); + + if ( time() < 1617235200 ) { + // WordPress.org Key #1 - This key is only valid before April 1st, 2021. + $trusted_keys[] = 'fRPyrxb/MvVLbdsYi+OOEv4xc+Eqpsj+kkAS6gNOkI0='; + } + + // TODO: Add key #2 with longer expiration. + + /** + * Filter the valid Signing keys used to verify the contents of files. + * + * @since 5.2.0 + * + * @param array $trusted_keys The trusted keys that may sign packages. + */ + return apply_filters( 'wp_trusted_keys', $trusted_keys ); +} + +/** + * Unzips a specified ZIP file to a location on the filesystem via the WordPress + * Filesystem Abstraction. + * + * Assumes that WP_Filesystem() has already been called and set up. Does not extract + * a root-level __MACOSX directory, if present. + * + * Attempts to increase the PHP memory limit to 256M before uncompressing. However, + * the most memory required shouldn't be much larger than the archive itself. * * @since 2.5.0 * - * @global WP_Filesystem_Base $wp_filesystem Subclass + * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. * - * @param string $file Full path and filename of zip archive - * @param string $to Full path on the filesystem to extract archive to - * @return mixed WP_Error on failure, True on success + * @param string $file Full path and filename of ZIP archive. + * @param string $to Full path on the filesystem to extract archive to. + * @return true|WP_Error True on success, WP_Error on failure. */ -function unzip_file($file, $to) { +function unzip_file( $file, $to ) { global $wp_filesystem; - if ( ! $wp_filesystem || !is_object($wp_filesystem) ) - return new WP_Error('fs_unavailable', __('Could not access filesystem.')); + if ( ! $wp_filesystem || ! is_object( $wp_filesystem ) ) { + return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) ); + } // Unzip can use a lot of memory, but not this much hopefully. wp_raise_memory_limit( 'admin' ); $needed_dirs = array(); - $to = trailingslashit($to); + $to = trailingslashit( $to ); - // Determine any parent dir's needed (of the upgrade directory) - if ( ! $wp_filesystem->is_dir($to) ) { //Only do parents if no children exist - $path = preg_split('![/\\\]!', untrailingslashit($to)); - for ( $i = count($path); $i >= 0; $i-- ) { - if ( empty($path[$i]) ) + // Determine any parent directories needed (of the upgrade directory). + if ( ! $wp_filesystem->is_dir( $to ) ) { // Only do parents if no children exist. + $path = preg_split( '![/\\\]!', untrailingslashit( $to ) ); + for ( $i = count( $path ); $i >= 0; $i-- ) { + if ( empty( $path[ $i ] ) ) { continue; + } - $dir = implode('/', array_slice($path, 0, $i+1) ); - if ( preg_match('!^[a-z]:$!i', $dir) ) // Skip it if it looks like a Windows Drive letter. + $dir = implode( '/', array_slice( $path, 0, $i + 1 ) ); + if ( preg_match( '!^[a-z]:$!i', $dir ) ) { // Skip it if it looks like a Windows Drive letter. continue; + } - if ( ! $wp_filesystem->is_dir($dir) ) + if ( ! $wp_filesystem->is_dir( $dir ) ) { $needed_dirs[] = $dir; - else - break; // A folder exists, therefor, we dont need the check the levels below this + } else { + break; // A folder exists, therefore we don't need to check the levels below this. + } } } @@ -1075,50 +1388,57 @@ * @param bool $ziparchive Whether to use ZipArchive. Default true. */ if ( class_exists( 'ZipArchive', false ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) { - $result = _unzip_file_ziparchive($file, $to, $needed_dirs); + $result = _unzip_file_ziparchive( $file, $to, $needed_dirs ); if ( true === $result ) { return $result; - } elseif ( is_wp_error($result) ) { - if ( 'incompatible_archive' != $result->get_error_code() ) + } elseif ( is_wp_error( $result ) ) { + if ( 'incompatible_archive' != $result->get_error_code() ) { return $result; + } } } // Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file. - return _unzip_file_pclzip($file, $to, $needed_dirs); + return _unzip_file_pclzip( $file, $to, $needed_dirs ); } /** - * This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the ZipArchive class. + * Attempts to unzip an archive using the ZipArchive class. + * + * This function should not be called directly, use `unzip_file()` instead. + * * Assumes that WP_Filesystem() has already been called and set up. * * @since 3.0.0 - * @see unzip_file + * @see unzip_file() * @access private * - * @global WP_Filesystem_Base $wp_filesystem Subclass + * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. * - * @param string $file Full path and filename of zip archive - * @param string $to Full path on the filesystem to extract archive to + * @param string $file Full path and filename of ZIP archive. + * @param string $to Full path on the filesystem to extract archive to. * @param array $needed_dirs A partial list of required folders needed to be created. - * @return mixed WP_Error on failure, True on success + * @return true|WP_Error True on success, WP_Error on failure. */ -function _unzip_file_ziparchive($file, $to, $needed_dirs = array() ) { +function _unzip_file_ziparchive( $file, $to, $needed_dirs = array() ) { global $wp_filesystem; $z = new ZipArchive(); $zopen = $z->open( $file, ZIPARCHIVE::CHECKCONS ); - if ( true !== $zopen ) + if ( true !== $zopen ) { return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), array( 'ziparchive_error' => $zopen ) ); + } $uncompressed_size = 0; for ( $i = 0; $i < $z->numFiles; $i++ ) { - if ( ! $info = $z->statIndex($i) ) + if ( ! $info = $z->statIndex( $i ) ) { return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) ); + } - if ( '__MACOSX/' === substr($info['name'], 0, 9) ) // Skip the OS X-created __MACOSX directory + if ( '__MACOSX/' === substr( $info['name'], 0, 9 ) ) { // Skip the OS X-created __MACOSX directory continue; + } // Don't extract invalid files: if ( 0 !== validate_file( $info['name'] ) ) { @@ -1143,25 +1463,28 @@ */ if ( wp_doing_cron() ) { $available_space = @disk_free_space( WP_CONTENT_DIR ); - if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space ) + if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space ) { return new WP_Error( 'disk_full_unzip_file', __( 'Could not copy files. You may have run out of disk space.' ), compact( 'uncompressed_size', 'available_space' ) ); + } } - $needed_dirs = array_unique($needed_dirs); + $needed_dirs = array_unique( $needed_dirs ); foreach ( $needed_dirs as $dir ) { // Check the parent folders of the folders all exist within the creation array. - if ( untrailingslashit($to) == $dir ) // Skip over the working directory, We know this exists (or will exist) + if ( untrailingslashit( $to ) == $dir ) { // Skip over the working directory, We know this exists (or will exist) continue; - if ( strpos($dir, $to) === false ) // If the directory is not within the working directory, Skip it + } + if ( strpos( $dir, $to ) === false ) { // If the directory is not within the working directory, Skip it continue; + } - $parent_folder = dirname($dir); - while ( !empty($parent_folder) && untrailingslashit($to) != $parent_folder && !in_array($parent_folder, $needed_dirs) ) { + $parent_folder = dirname( $dir ); + while ( ! empty( $parent_folder ) && untrailingslashit( $to ) != $parent_folder && ! in_array( $parent_folder, $needed_dirs ) ) { $needed_dirs[] = $parent_folder; - $parent_folder = dirname($parent_folder); + $parent_folder = dirname( $parent_folder ); } } - asort($needed_dirs); + asort( $needed_dirs ); // Create those directories if need be: foreach ( $needed_dirs as $_dir ) { @@ -1170,29 +1493,34 @@ return new WP_Error( 'mkdir_failed_ziparchive', __( 'Could not create directory.' ), substr( $_dir, strlen( $to ) ) ); } } - unset($needed_dirs); + unset( $needed_dirs ); for ( $i = 0; $i < $z->numFiles; $i++ ) { - if ( ! $info = $z->statIndex($i) ) + if ( ! $info = $z->statIndex( $i ) ) { return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) ); + } - if ( '/' == substr($info['name'], -1) ) // directory + if ( '/' == substr( $info['name'], -1 ) ) { // directory continue; + } - if ( '__MACOSX/' === substr($info['name'], 0, 9) ) // Don't extract the OS X-created __MACOSX directory files + if ( '__MACOSX/' === substr( $info['name'], 0, 9 ) ) { // Don't extract the OS X-created __MACOSX directory files continue; + } // Don't extract invalid files: if ( 0 !== validate_file( $info['name'] ) ) { continue; } - $contents = $z->getFromIndex($i); - if ( false === $contents ) + $contents = $z->getFromIndex( $i ); + if ( false === $contents ) { return new WP_Error( 'extract_failed_ziparchive', __( 'Could not extract file from archive.' ), $info['name'] ); + } - if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE) ) + if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE ) ) { return new WP_Error( 'copy_failed_ziparchive', __( 'Could not copy file.' ), $info['name'] ); + } } $z->close(); @@ -1201,50 +1529,56 @@ } /** - * This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the PclZip library. + * Attempts to unzip an archive using the PclZip library. + * + * This function should not be called directly, use `unzip_file()` instead. + * * Assumes that WP_Filesystem() has already been called and set up. * * @since 3.0.0 - * @see unzip_file + * @see unzip_file() * @access private * - * @global WP_Filesystem_Base $wp_filesystem Subclass + * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. * - * @param string $file Full path and filename of zip archive - * @param string $to Full path on the filesystem to extract archive to + * @param string $file Full path and filename of ZIP archive. + * @param string $to Full path on the filesystem to extract archive to. * @param array $needed_dirs A partial list of required folders needed to be created. - * @return mixed WP_Error on failure, True on success + * @return true|WP_Error True on success, WP_Error on failure. */ -function _unzip_file_pclzip($file, $to, $needed_dirs = array()) { +function _unzip_file_pclzip( $file, $to, $needed_dirs = array() ) { global $wp_filesystem; mbstring_binary_safe_encoding(); - require_once(ABSPATH . 'wp-admin/includes/class-pclzip.php'); + require_once( ABSPATH . 'wp-admin/includes/class-pclzip.php' ); - $archive = new PclZip($file); + $archive = new PclZip( $file ); - $archive_files = $archive->extract(PCLZIP_OPT_EXTRACT_AS_STRING); + $archive_files = $archive->extract( PCLZIP_OPT_EXTRACT_AS_STRING ); reset_mbstring_encoding(); // Is the archive valid? - if ( !is_array($archive_files) ) - return new WP_Error('incompatible_archive', __('Incompatible Archive.'), $archive->errorInfo(true)); + if ( ! is_array( $archive_files ) ) { + return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), $archive->errorInfo( true ) ); + } - if ( 0 == count($archive_files) ) + if ( 0 == count( $archive_files ) ) { return new WP_Error( 'empty_archive_pclzip', __( 'Empty archive.' ) ); + } $uncompressed_size = 0; // Determine any children directories needed (From within the archive) foreach ( $archive_files as $file ) { - if ( '__MACOSX/' === substr($file['filename'], 0, 9) ) // Skip the OS X-created __MACOSX directory + if ( '__MACOSX/' === substr( $file['filename'], 0, 9 ) ) { // Skip the OS X-created __MACOSX directory continue; + } $uncompressed_size += $file['size']; - $needed_dirs[] = $to . untrailingslashit( $file['folder'] ? $file['filename'] : dirname($file['filename']) ); + $needed_dirs[] = $to . untrailingslashit( $file['folder'] ? $file['filename'] : dirname( $file['filename'] ) ); } /* @@ -1254,101 +1588,115 @@ */ if ( wp_doing_cron() ) { $available_space = @disk_free_space( WP_CONTENT_DIR ); - if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space ) + if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space ) { return new WP_Error( 'disk_full_unzip_file', __( 'Could not copy files. You may have run out of disk space.' ), compact( 'uncompressed_size', 'available_space' ) ); + } } - $needed_dirs = array_unique($needed_dirs); + $needed_dirs = array_unique( $needed_dirs ); foreach ( $needed_dirs as $dir ) { // Check the parent folders of the folders all exist within the creation array. - if ( untrailingslashit($to) == $dir ) // Skip over the working directory, We know this exists (or will exist) + if ( untrailingslashit( $to ) == $dir ) { // Skip over the working directory, We know this exists (or will exist) continue; - if ( strpos($dir, $to) === false ) // If the directory is not within the working directory, Skip it + } + if ( strpos( $dir, $to ) === false ) { // If the directory is not within the working directory, Skip it continue; + } - $parent_folder = dirname($dir); - while ( !empty($parent_folder) && untrailingslashit($to) != $parent_folder && !in_array($parent_folder, $needed_dirs) ) { + $parent_folder = dirname( $dir ); + while ( ! empty( $parent_folder ) && untrailingslashit( $to ) != $parent_folder && ! in_array( $parent_folder, $needed_dirs ) ) { $needed_dirs[] = $parent_folder; - $parent_folder = dirname($parent_folder); + $parent_folder = dirname( $parent_folder ); } } - asort($needed_dirs); + asort( $needed_dirs ); // Create those directories if need be: foreach ( $needed_dirs as $_dir ) { // Only check to see if the dir exists upon creation failure. Less I/O this way. - if ( ! $wp_filesystem->mkdir( $_dir, FS_CHMOD_DIR ) && ! $wp_filesystem->is_dir( $_dir ) ) + if ( ! $wp_filesystem->mkdir( $_dir, FS_CHMOD_DIR ) && ! $wp_filesystem->is_dir( $_dir ) ) { return new WP_Error( 'mkdir_failed_pclzip', __( 'Could not create directory.' ), substr( $_dir, strlen( $to ) ) ); + } } - unset($needed_dirs); + unset( $needed_dirs ); // Extract the files from the zip foreach ( $archive_files as $file ) { - if ( $file['folder'] ) + if ( $file['folder'] ) { continue; + } - if ( '__MACOSX/' === substr($file['filename'], 0, 9) ) // Don't extract the OS X-created __MACOSX directory files + if ( '__MACOSX/' === substr( $file['filename'], 0, 9 ) ) { // Don't extract the OS X-created __MACOSX directory files continue; + } // Don't extract invalid files: if ( 0 !== validate_file( $file['filename'] ) ) { continue; } - if ( ! $wp_filesystem->put_contents( $to . $file['filename'], $file['content'], FS_CHMOD_FILE) ) + if ( ! $wp_filesystem->put_contents( $to . $file['filename'], $file['content'], FS_CHMOD_FILE ) ) { return new WP_Error( 'copy_failed_pclzip', __( 'Could not copy file.' ), $file['filename'] ); + } } return true; } /** - * Copies a directory from one location to another via the WordPress Filesystem Abstraction. + * Copies a directory from one location to another via the WordPress Filesystem + * Abstraction. + * * Assumes that WP_Filesystem() has already been called and setup. * * @since 2.5.0 * - * @global WP_Filesystem_Base $wp_filesystem Subclass + * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. * - * @param string $from source directory - * @param string $to destination directory - * @param array $skip_list a list of files/folders to skip copying - * @return mixed WP_Error on failure, True on success. + * @param string $from Source directory. + * @param string $to Destination directory. + * @param array $skip_list A list of files/folders to skip copying. + * @return true|WP_Error True on success, WP_Error on failure. */ -function copy_dir($from, $to, $skip_list = array() ) { +function copy_dir( $from, $to, $skip_list = array() ) { global $wp_filesystem; - $dirlist = $wp_filesystem->dirlist($from); + $dirlist = $wp_filesystem->dirlist( $from ); - $from = trailingslashit($from); - $to = trailingslashit($to); + $from = trailingslashit( $from ); + $to = trailingslashit( $to ); foreach ( (array) $dirlist as $filename => $fileinfo ) { - if ( in_array( $filename, $skip_list ) ) + if ( in_array( $filename, $skip_list ) ) { continue; + } if ( 'f' == $fileinfo['type'] ) { - if ( ! $wp_filesystem->copy($from . $filename, $to . $filename, true, FS_CHMOD_FILE) ) { + if ( ! $wp_filesystem->copy( $from . $filename, $to . $filename, true, FS_CHMOD_FILE ) ) { // If copy failed, chmod file to 0644 and try again. $wp_filesystem->chmod( $to . $filename, FS_CHMOD_FILE ); - if ( ! $wp_filesystem->copy($from . $filename, $to . $filename, true, FS_CHMOD_FILE) ) + if ( ! $wp_filesystem->copy( $from . $filename, $to . $filename, true, FS_CHMOD_FILE ) ) { return new WP_Error( 'copy_failed_copy_dir', __( 'Could not copy file.' ), $to . $filename ); + } } } elseif ( 'd' == $fileinfo['type'] ) { - if ( !$wp_filesystem->is_dir($to . $filename) ) { - if ( !$wp_filesystem->mkdir($to . $filename, FS_CHMOD_DIR) ) + if ( ! $wp_filesystem->is_dir( $to . $filename ) ) { + if ( ! $wp_filesystem->mkdir( $to . $filename, FS_CHMOD_DIR ) ) { return new WP_Error( 'mkdir_failed_copy_dir', __( 'Could not create directory.' ), $to . $filename ); + } } // generate the $sub_skip_list for the subdirectory as a sub-set of the existing $skip_list $sub_skip_list = array(); foreach ( $skip_list as $skip_item ) { - if ( 0 === strpos( $skip_item, $filename . '/' ) ) + if ( 0 === strpos( $skip_item, $filename . '/' ) ) { $sub_skip_list[] = preg_replace( '!^' . preg_quote( $filename, '!' ) . '/!i', '', $skip_item ); + } } - $result = copy_dir($from . $filename, $to . $filename, $sub_skip_list); - if ( is_wp_error($result) ) + $result = copy_dir( $from . $filename, $to . $filename, $sub_skip_list ); + if ( is_wp_error( $result ) ) { return $result; + } } } return true; @@ -1356,6 +1704,7 @@ /** * Initialises and connects the WordPress Filesystem Abstraction classes. + * * This function will include the chosen transport and attempt connecting. * * Plugins may add extra transports, And force WordPress to use them by returning @@ -1363,23 +1712,24 @@ * * @since 2.5.0 * - * @global WP_Filesystem_Base $wp_filesystem Subclass + * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. * * @param array|false $args Optional. Connection args, These are passed directly to * the `WP_Filesystem_*()` classes. Default false. * @param string|false $context Optional. Context for get_filesystem_method(). Default false. * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false. - * @return null|bool false on failure, true on success. + * @return bool|null True on success, false on failure, null if the filesystem method class file does not exist. */ function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) { global $wp_filesystem; - require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php'); + require_once( ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php' ); $method = get_filesystem_method( $args, $context, $allow_relaxed_file_ownership ); - if ( ! $method ) + if ( ! $method ) { return false; + } if ( ! class_exists( "WP_Filesystem_$method" ) ) { @@ -1395,32 +1745,39 @@ */ $abstraction_file = apply_filters( 'filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method ); - if ( ! file_exists($abstraction_file) ) + if ( ! file_exists( $abstraction_file ) ) { return; + } - require_once($abstraction_file); + require_once( $abstraction_file ); } $method = "WP_Filesystem_$method"; - $wp_filesystem = new $method($args); + $wp_filesystem = new $method( $args ); //Define the timeouts for the connections. Only available after the construct is called to allow for per-transport overriding of the default. - if ( ! defined('FS_CONNECT_TIMEOUT') ) - define('FS_CONNECT_TIMEOUT', 30); - if ( ! defined('FS_TIMEOUT') ) - define('FS_TIMEOUT', 30); + if ( ! defined( 'FS_CONNECT_TIMEOUT' ) ) { + define( 'FS_CONNECT_TIMEOUT', 30 ); + } + if ( ! defined( 'FS_TIMEOUT' ) ) { + define( 'FS_TIMEOUT', 30 ); + } - if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() ) + if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) { return false; + } - if ( !$wp_filesystem->connect() ) + if ( ! $wp_filesystem->connect() ) { return false; //There was an error connecting to the server. + } // Set the permission constants if not already set. - if ( ! defined('FS_CHMOD_DIR') ) - define('FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) ); - if ( ! defined('FS_CHMOD_FILE') ) - define('FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) ); + if ( ! defined( 'FS_CHMOD_DIR' ) ) { + define( 'FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) ); + } + if ( ! defined( 'FS_CHMOD_FILE' ) ) { + define( 'FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) ); + } return true; } @@ -1452,7 +1809,7 @@ * @return string The transport to use, see description for valid return values. */ function get_filesystem_method( $args = array(), $context = '', $allow_relaxed_file_ownership = false ) { - $method = defined('FS_METHOD') ? FS_METHOD : false; // Please ensure that this is either 'direct', 'ssh2', 'ftpext' or 'ftpsockets' + $method = defined( 'FS_METHOD' ) ? FS_METHOD : false; // Please ensure that this is either 'direct', 'ssh2', 'ftpext' or 'ftpsockets' if ( ! $context ) { $context = WP_CONTENT_DIR; @@ -1467,37 +1824,43 @@ if ( ! $method ) { - $temp_file_name = $context . 'temp-write-test-' . time(); - $temp_handle = @fopen($temp_file_name, 'w'); + $temp_file_name = $context . 'temp-write-test-' . str_replace( '.', '-', uniqid( '', true ) ); + $temp_handle = @fopen( $temp_file_name, 'w' ); if ( $temp_handle ) { // Attempt to determine the file owner of the WordPress files, and that of newly created files $wp_file_owner = $temp_file_owner = false; - if ( function_exists('fileowner') ) { - $wp_file_owner = @fileowner( __FILE__ ); + if ( function_exists( 'fileowner' ) ) { + $wp_file_owner = @fileowner( __FILE__ ); $temp_file_owner = @fileowner( $temp_file_name ); } if ( $wp_file_owner !== false && $wp_file_owner === $temp_file_owner ) { // WordPress is creating files as the same owner as the WordPress files, // this means it's safe to modify & create new files via PHP. - $method = 'direct'; + $method = 'direct'; $GLOBALS['_wp_filesystem_direct_method'] = 'file_owner'; } elseif ( $allow_relaxed_file_ownership ) { // The $context directory is writable, and $allow_relaxed_file_ownership is set, this means we can modify files // safely in this directory. This mode doesn't create new files, only alter existing ones. - $method = 'direct'; + $method = 'direct'; $GLOBALS['_wp_filesystem_direct_method'] = 'relaxed_ownership'; } - @fclose($temp_handle); - @unlink($temp_file_name); + @fclose( $temp_handle ); + @unlink( $temp_file_name ); } - } + } - if ( ! $method && isset($args['connection_type']) && 'ssh' == $args['connection_type'] && extension_loaded('ssh2') && function_exists('stream_get_contents') ) $method = 'ssh2'; - if ( ! $method && extension_loaded('ftp') ) $method = 'ftpext'; - if ( ! $method && ( extension_loaded('sockets') || function_exists('fsockopen') ) ) $method = 'ftpsockets'; //Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread + if ( ! $method && isset( $args['connection_type'] ) && 'ssh' == $args['connection_type'] && extension_loaded( 'ssh2' ) && function_exists( 'stream_get_contents' ) ) { + $method = 'ssh2'; + } + if ( ! $method && extension_loaded( 'ftp' ) ) { + $method = 'ftpext'; + } + if ( ! $method && ( extension_loaded( 'sockets' ) || function_exists( 'fsockopen' ) ) ) { + $method = 'ftpsockets'; //Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread + } /** * Filters the filesystem method to use. @@ -1538,7 +1901,7 @@ * the post. Default null. * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false. * - * @return bool False on failure, true on success. + * @return bool True on success, false on failure. */ function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) { global $pagenow; @@ -1564,20 +1927,29 @@ * @param array $extra_fields Extra POST fields. */ $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership ); - if ( '' !== $req_cred ) + if ( '' !== $req_cred ) { return $req_cred; + } - if ( empty($type) ) { + if ( empty( $type ) ) { $type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership ); } - if ( 'direct' == $type ) + if ( 'direct' == $type ) { return true; + } + + if ( is_null( $extra_fields ) ) { + $extra_fields = array( 'version', 'locale' ); + } - if ( is_null( $extra_fields ) ) - $extra_fields = array( 'version', 'locale' ); - - $credentials = get_option('ftp_credentials', array( 'hostname' => '', 'username' => '')); + $credentials = get_option( + 'ftp_credentials', + array( + 'hostname' => '', + 'username' => '', + ) + ); $submitted_form = wp_unslash( $_POST ); @@ -1594,23 +1966,24 @@ } // If defined, set it to that, Else, If POST'd, set it to that, If not, Set it to whatever it previously was(saved details in option) - $credentials['hostname'] = defined('FTP_HOST') ? FTP_HOST : (!empty($submitted_form['hostname']) ? $submitted_form['hostname'] : $credentials['hostname']); - $credentials['username'] = defined('FTP_USER') ? FTP_USER : (!empty($submitted_form['username']) ? $submitted_form['username'] : $credentials['username']); - $credentials['password'] = defined('FTP_PASS') ? FTP_PASS : (!empty($submitted_form['password']) ? $submitted_form['password'] : ''); + $credentials['hostname'] = defined( 'FTP_HOST' ) ? FTP_HOST : ( ! empty( $submitted_form['hostname'] ) ? $submitted_form['hostname'] : $credentials['hostname'] ); + $credentials['username'] = defined( 'FTP_USER' ) ? FTP_USER : ( ! empty( $submitted_form['username'] ) ? $submitted_form['username'] : $credentials['username'] ); + $credentials['password'] = defined( 'FTP_PASS' ) ? FTP_PASS : ( ! empty( $submitted_form['password'] ) ? $submitted_form['password'] : '' ); // Check to see if we are setting the public/private keys for ssh - $credentials['public_key'] = defined('FTP_PUBKEY') ? FTP_PUBKEY : (!empty($submitted_form['public_key']) ? $submitted_form['public_key'] : ''); - $credentials['private_key'] = defined('FTP_PRIKEY') ? FTP_PRIKEY : (!empty($submitted_form['private_key']) ? $submitted_form['private_key'] : ''); + $credentials['public_key'] = defined( 'FTP_PUBKEY' ) ? FTP_PUBKEY : ( ! empty( $submitted_form['public_key'] ) ? $submitted_form['public_key'] : '' ); + $credentials['private_key'] = defined( 'FTP_PRIKEY' ) ? FTP_PRIKEY : ( ! empty( $submitted_form['private_key'] ) ? $submitted_form['private_key'] : '' ); // Sanitize the hostname, Some people might pass in odd-data: - $credentials['hostname'] = preg_replace('|\w+://|', '', $credentials['hostname']); //Strip any schemes off + $credentials['hostname'] = preg_replace( '|\w+://|', '', $credentials['hostname'] ); //Strip any schemes off - if ( strpos($credentials['hostname'], ':') ) { - list( $credentials['hostname'], $credentials['port'] ) = explode(':', $credentials['hostname'], 2); - if ( ! is_numeric($credentials['port']) ) - unset($credentials['port']); + if ( strpos( $credentials['hostname'], ':' ) ) { + list( $credentials['hostname'], $credentials['port'] ) = explode( ':', $credentials['hostname'], 2 ); + if ( ! is_numeric( $credentials['port'] ) ) { + unset( $credentials['port'] ); + } } else { - unset($credentials['port']); + unset( $credentials['port'] ); } if ( ( defined( 'FTP_SSH' ) && FTP_SSH ) || ( defined( 'FS_METHOD' ) && 'ssh2' == FS_METHOD ) ) { @@ -1624,40 +1997,45 @@ } if ( ! $error && ( - ( !empty($credentials['password']) && !empty($credentials['username']) && !empty($credentials['hostname']) ) || - ( 'ssh' == $credentials['connection_type'] && !empty($credentials['public_key']) && !empty($credentials['private_key']) ) + ( ! empty( $credentials['password'] ) && ! empty( $credentials['username'] ) && ! empty( $credentials['hostname'] ) ) || + ( 'ssh' == $credentials['connection_type'] && ! empty( $credentials['public_key'] ) && ! empty( $credentials['private_key'] ) ) ) ) { $stored_credentials = $credentials; - if ( !empty($stored_credentials['port']) ) //save port as part of hostname to simplify above code. + if ( ! empty( $stored_credentials['port'] ) ) { //save port as part of hostname to simplify above code. $stored_credentials['hostname'] .= ':' . $stored_credentials['port']; + } - unset($stored_credentials['password'], $stored_credentials['port'], $stored_credentials['private_key'], $stored_credentials['public_key']); + unset( $stored_credentials['password'], $stored_credentials['port'], $stored_credentials['private_key'], $stored_credentials['public_key'] ); if ( ! wp_installing() ) { update_option( 'ftp_credentials', $stored_credentials ); } return $credentials; } - $hostname = isset( $credentials['hostname'] ) ? $credentials['hostname'] : ''; - $username = isset( $credentials['username'] ) ? $credentials['username'] : ''; - $public_key = isset( $credentials['public_key'] ) ? $credentials['public_key'] : ''; - $private_key = isset( $credentials['private_key'] ) ? $credentials['private_key'] : ''; - $port = isset( $credentials['port'] ) ? $credentials['port'] : ''; + $hostname = isset( $credentials['hostname'] ) ? $credentials['hostname'] : ''; + $username = isset( $credentials['username'] ) ? $credentials['username'] : ''; + $public_key = isset( $credentials['public_key'] ) ? $credentials['public_key'] : ''; + $private_key = isset( $credentials['private_key'] ) ? $credentials['private_key'] : ''; + $port = isset( $credentials['port'] ) ? $credentials['port'] : ''; $connection_type = isset( $credentials['connection_type'] ) ? $credentials['connection_type'] : ''; if ( $error ) { - $error_string = __('ERROR: There was an error connecting to the server, Please verify the settings are correct.'); - if ( is_wp_error($error) ) + $error_string = __( 'ERROR: There was an error connecting to the server, Please verify the settings are correct.' ); + if ( is_wp_error( $error ) ) { $error_string = esc_html( $error->get_error_message() ); + } echo '
' . $error_string . '