Skip to content

SanitizationHelperTrait: stop requiring unslash for functions that strip slashes #2740

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rodrigoprimo wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

SanitizationHelperTrait: stop requiring unslash for functions that strip slashes #2740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 51 additions & 51 deletions WordPress/Helpers/SanitizationHelperTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,47 +78,34 @@ trait SanitizationHelperTrait {
* @var array<string, true>
*/
private $sanitizingFunctions = array(
'_wp_handle_upload' => true,
'esc_url_raw' => true,
'filter_input' => true,
'filter_var' => true,
'hash_equals' => true,
'is_email' => true,
'number_format' => true,
'sanitize_bookmark_field' => true,
'sanitize_bookmark' => true,
'sanitize_email' => true,
'sanitize_file_name' => true,
'sanitize_hex_color_no_hash' => true,
'sanitize_hex_color' => true,
'sanitize_html_class' => true,
'sanitize_meta' => true,
'sanitize_mime_type' => true,
'sanitize_option' => true,
'sanitize_sql_orderby' => true,
'sanitize_term_field' => true,
'sanitize_term' => true,
'sanitize_text_field' => true,
'sanitize_textarea_field' => true,
'sanitize_title_for_query' => true,
'sanitize_title_with_dashes' => true,
'sanitize_title' => true,
'sanitize_url' => true,
'sanitize_user_field' => true,
'sanitize_user' => true,
'validate_file' => true,
'wp_handle_sideload' => true,
'wp_handle_upload' => true,
'wp_kses_allowed_html' => true,
'wp_kses_data' => true,
'wp_kses_one_attr' => true,
'wp_kses_post' => true,
'wp_kses' => true,
'wp_parse_id_list' => true,
'wp_redirect' => true,
'wp_safe_redirect' => true,
'wp_sanitize_redirect' => true,
'wp_strip_all_tags' => true,
'_wp_handle_upload' => true,
'filter_input' => true,
'filter_var' => true,
'hash_equals' => true,
'is_email' => true,
'number_format' => true,
'sanitize_bookmark_field' => true,
'sanitize_bookmark' => true,
'sanitize_meta' => true,
'sanitize_option' => true,
'sanitize_term_field' => true,
'sanitize_term' => true,
'sanitize_text_field' => true,
'sanitize_textarea_field' => true,
'sanitize_user_field' => true,
'sanitize_user' => true,
'validate_file' => true,
'wp_handle_sideload' => true,
'wp_handle_upload' => true,
'wp_kses_allowed_html' => true,
'wp_kses_data' => true,
'wp_kses_one_attr' => true,
'wp_kses_post' => true,
'wp_kses' => true,
'wp_parse_id_list' => true,
'wp_redirect' => true,
'wp_safe_redirect' => true,
'wp_strip_all_tags' => true,
);

/**
Expand All @@ -137,16 +124,29 @@ trait SanitizationHelperTrait {
* @var array<string, bool>
*/
private $unslashingSanitizingFunctions = array(
'absint' => true,
'boolval' => true,
'count' => true,
'doubleval' => true,
'floatval' => true,
'intval' => true,
'rest_sanitize_boolean' => true,
'sanitize_key' => true,
'sanitize_locale_name' => true,
'sizeof' => true,
'absint' => true,
'boolval' => true,
'count' => true,
'doubleval' => true,
'esc_url_raw' => true,
'floatval' => true,
'intval' => true,
'rest_sanitize_boolean' => true,
'sanitize_email' => true,
'sanitize_file_name' => true,
'sanitize_hex_color_no_hash' => true,
'sanitize_hex_color' => true,
'sanitize_html_class' => true,
'sanitize_key' => true,
'sanitize_locale_name' => true,
'sanitize_mime_type' => true,
'sanitize_sql_orderby' => true,
'sanitize_title_for_query' => true,
'sanitize_title_with_dashes' => true,
'sanitize_title' => true,
'sanitize_url' => true,
'sizeof' => true,
'wp_sanitize_redirect' => true,
);

/**
Expand Down
40 changes: 40 additions & 0 deletions WordPress/Tests/Security/ValidatedSanitizedInputUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,3 +624,43 @@ function test_namespaced_unslashing_sanitizing_functions() {
$key = namespace\Sub\sanitize_key( $_POST['unslash_sanitize5'] ); // Bad.
}
}

/*
* Safeguard that sanitizing functions which implicitly unslash their input do not
* require an additional call to a dedicated unslashing function like wp_unslash().
*
* See https://github.com/WordPress/WordPress-Coding-Standards/issues/2516
*/
function test_sanitizing_functions_which_implicitly_unslash() {
if ( ! isset(
$_POST['esc_url_raw'],
$_POST['sanitize_email'],
$_POST['sanitize_file_name'],
$_POST['sanitize_hex_color'],
$_POST['sanitize_hex_color_no_hash'],
$_POST['sanitize_html_class'],
$_POST['sanitize_mime_type'],
$_POST['sanitize_sql_orderby'],
$_POST['sanitize_title'],
$_POST['sanitize_title_for_query'],
$_POST['sanitize_title_with_dashes'],
$_POST['sanitize_url'],
$_POST['wp_sanitize_redirect']
) ) {
return;
}

echo esc_url_raw( $_POST['esc_url_raw'] ); // OK.
echo sanitize_email( $_POST['sanitize_email'] ); // OK.
echo sanitize_file_name( $_POST['sanitize_file_name'] ); // OK.
echo sanitize_hex_color( $_POST['sanitize_hex_color'] ); // OK.
echo sanitize_hex_color_no_hash( $_POST['sanitize_hex_color_no_hash'] ); // OK.
echo sanitize_html_class( $_POST['sanitize_html_class'] ); // OK.
echo sanitize_mime_type( $_POST['sanitize_mime_type'] ); // OK.
echo sanitize_sql_orderby( $_POST['sanitize_sql_orderby'] ); // OK.
echo sanitize_title( $_POST['sanitize_title'] ); // OK.
echo sanitize_title_for_query( $_POST['sanitize_title_for_query'] ); // OK.
echo sanitize_title_with_dashes( $_POST['sanitize_title_with_dashes'] ); // OK.
echo sanitize_url( $_POST['sanitize_url'] ); // OK.
echo wp_sanitize_redirect( $_POST['wp_sanitize_redirect'] ); // OK.
}
Loading