Skip to content
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

Jump to bottom

Security/PluginMenuSlug: implement PHPCSUtils and support modern PHP #2168

Merged
merged 3 commits into from
Dec 21, 2022
Merged

Security/PluginMenuSlug: implement PHPCSUtils and support modern PHP #2168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ec33e9
Security/PluginMenuSlug: add support for PHP 8.0+ named parameters
jrfnl Dec 10, 2022
569c754
Security/PluginMenuSlug: minor test tweak
jrfnl Dec 10, 2022
0b9a9fa
Security/PluginMenuSlug: improve error position precision
jrfnl Dec 10, 2022
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
83 changes: 61 additions & 22 deletions WordPress/Sniffs/Security/PluginMenuSlugSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

namespace WordPressCS\WordPress\Sniffs\Security;

use PHPCSUtils\Utils\PassedParameters;
use WordPressCS\WordPress\AbstractFunctionParameterSniff;

/**
Expand Down Expand Up @@ -41,25 +42,61 @@ class PluginMenuSlugSniff extends AbstractFunctionParameterSniff {
* @since 0.3.0
* @since 0.11.0 Renamed from $add_menu_functions to $target_functions
* and changed visibility to protected.
* @since 3.0.0 The format of the value has changed from a numerically indexed
* array containing parameter positions to an array with the parameter
* position as the index and the parameter name as value.
*
* @var array <string function name> => <array target parameter positions>
* @var array<string, <int, string|array>> Key is the name of the functions being targetted.
* Value is an array with parameter positions as the
* keys and parameter names as the values
*/
protected $target_functions = array(
'add_menu_page' => array( 4 ),
'add_object_page' => array( 4 ),
'add_utility_page' => array( 4 ),
'add_submenu_page' => array( 1, 5 ),
'add_dashboard_page' => array( 4 ),
'add_posts_page' => array( 4 ),
'add_media_page' => array( 4 ),
'add_links_page' => array( 4 ),
'add_pages_page' => array( 4 ),
'add_comments_page' => array( 4 ),
'add_theme_page' => array( 4 ),
'add_plugins_page' => array( 4 ),
'add_users_page' => array( 4 ),
'add_management_page' => array( 4 ),
'add_options_page' => array( 4 ),
'add_menu_page' => array(
4 => 'menu_slug',
),
'add_object_page' => array(
4 => 'menu_slug',
),
'add_utility_page' => array(
4 => 'menu_slug',
),
'add_submenu_page' => array(
1 => 'parent_slug',
5 => 'menu_slug',
),
'add_dashboard_page' => array(
4 => 'menu_slug',
),
'add_posts_page' => array(
4 => 'menu_slug',
),
'add_media_page' => array(
4 => 'menu_slug',
),
'add_links_page' => array(
4 => 'menu_slug',
),
'add_pages_page' => array(
4 => 'menu_slug',
),
'add_comments_page' => array(
4 => 'menu_slug',
),
'add_theme_page' => array(
4 => 'menu_slug',
),
'add_plugins_page' => array(
4 => 'menu_slug',
),
'add_users_page' => array(
4 => 'menu_slug',
),
'add_management_page' => array(
4 => 'menu_slug',
),
'add_options_page' => array(
4 => 'menu_slug',
),
);

/**
Expand All @@ -75,13 +112,15 @@ class PluginMenuSlugSniff extends AbstractFunctionParameterSniff {
* @return void
*/
public function process_parameters( $stackPtr, $group_name, $matched_content, $parameters ) {
foreach ( $this->target_functions[ $matched_content ] as $position ) {
if ( isset( $parameters[ $position ] ) ) {
$file_constant = $this->phpcsFile->findNext( \T_FILE, $parameters[ $position ]['start'], ( $parameters[ $position ]['end'] + 1 ) );
foreach ( $this->target_functions[ $matched_content ] as $position => $param_name ) {
$found_param = PassedParameters::getParameterFromStack( $parameters, $position, $param_name );
if ( false === $found_param ) {
continue;
}

if ( false !== $file_constant ) {
$this->phpcsFile->addWarning( 'Using __FILE__ for menu slugs risks exposing filesystem structure.', $stackPtr, 'Using__FILE__' );
}
$file_constant = $this->phpcsFile->findNext( \T_FILE, $found_param['start'], ( $found_param['end'] + 1 ) );
if ( false !== $file_constant ) {
$this->phpcsFile->addWarning( 'Using __FILE__ for menu slugs risks exposing filesystem structure.', $file_constant, 'Using__FILE__' );
}
}
}
Expand Down
10 changes: 9 additions & 1 deletion WordPress/Tests/Security/PluginMenuSlugUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

add_menu_page( $page_title, $menu_title, $capability, __FILE__, $function, $icon_url, $position ); // Bad.

add_dashboard_page( $page_title, $menu_title, $capability, __FILE__, $function); // Bad.
add_dashboard_page( $page_title, $menu_title, $capability, __file__, $function); // Bad.

add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, 'awesome-submenu-page', $function ); // Ok.

Expand All @@ -12,3 +12,11 @@ add_submenu_page( __FILE__ . 'parent', $page_title, $menu_title, $capability, __
$my_class->add_dashboard_page( $page_title, $menu_title, $capability, __FILE__, $function); // Ok.
Some_Class::add_dashboard_page( $page_title, $menu_title, $capability, __FILE__, $function); // Ok.
\My_Namespace\add_dashboard_page( $page_title, $menu_title, $capability, __FILE__, $function); // Ok.

// Safeguard support for PHP 8.0+ named parameters.
add_submenu_page(
page_title: $page_title,
menu_title: $menu_title,
parent_slug: __FILE__, // Bad.
capability: $capability,
);
8 changes: 4 additions & 4 deletions WordPress/Tests/Security/PluginMenuSlugUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ public function getErrorList() {
*/
public function getWarningList() {
return array(
3 => 1,
5 => 1,
9 => 2,
3 => 1,
5 => 1,
9 => 2,
20 => 1,
);
}

}