diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..7456070 --- /dev/null +++ b/composer.json @@ -0,0 +1,18 @@ +{ + "name": "cacti/plugin_apcupsd", + "description": "plugin_apcupsd plugin for Cacti", + "license": "GPL-2.0-or-later", + "require-dev": { + "pestphp/pest": "^1.23" + }, + "config": { + "allow-plugins": { + "pestphp/pest-plugin": true + } + }, + "autoload-dev": { + "files": [ + "tests/bootstrap.php" + ] + } +} diff --git a/setup.php b/setup.php index aa1e43b..dfc134b 100644 --- a/setup.php +++ b/setup.php @@ -64,7 +64,10 @@ function apcupsd_check_upgrade() { $info = plugin_apcupsd_version(); $current = $info['version']; - $old = db_fetch_cell("SELECT version FROM plugin_config WHERE directory='apcupsd'"); + $old = db_fetch_cell_prepared('SELECT version + FROM plugin_config + WHERE directory = ?', + array('apcupsd')); if ($current != $old) { if (api_plugin_is_enabled('apcupsd')) { # may sound ridiculous, but enables new hooks @@ -322,11 +325,15 @@ function apcupsd_replicate_out($data) { include_once($config['base_path'] . '/lib/poller.php'); - $upsdata = db_fetch_assoc('SELECT * FROM apcupsd_ups'); + $upsdata = db_fetch_assoc_prepared('SELECT * + FROM apcupsd_ups', + array()); replicate_out_table($data['rcnn_id'], $upsdata, 'apcupsd_ups', $data['remote_poller_id']); - $upsdata = db_fetch_assoc('SELECT * FROM apcupsd_ups_stats'); + $upsdata = db_fetch_assoc_prepared('SELECT * + FROM apcupsd_ups_stats', + array()); replicate_out_table($data['rcnn_id'], $upsdata, 'apcupsd_ups_stats', $data['remote_poller_id']); @@ -343,4 +350,3 @@ function apcupsd_draw_navigation_text($nav) { return $nav; } - diff --git a/tests/Pest.php b/tests/Pest.php new file mode 100644 index 0000000..e6bf268 --- /dev/null +++ b/tests/Pest.php @@ -0,0 +1,10 @@ +toBeTrue( + "File {$relativeFile} does not include auth.php or global.php" + ); + } + }); + + it('validates numeric IDs from request variables before DB queries', function () { + $uiFiles = array( + 'tests/test_prepared_statements.php', + 'upses.php', + ); + + foreach ($uiFiles as $relativeFile) { + $path = realpath(__DIR__ . '/../../' . $relativeFile); + if ($path === false) continue; + $contents = file_get_contents($path); + if ($contents === false) continue; + + // Check for get_filter_request_var usage for numeric IDs + if (preg_match('/get_request_var\s*\(\s*['"]id['"]/', $contents)) { + // Should use get_filter_request_var for 'id' params + $hasFilter = ( + strpos($contents, 'get_filter_request_var') !== false || + strpos($contents, 'input_validate_input_number') !== false || + strpos($contents, 'form_input_validate') !== false + ); + + expect($hasFilter)->toBeTrue( + "File {$relativeFile} uses get_request_var for IDs without validation" + ); + } + } + }); +}); diff --git a/tests/Security/OutputEscapingTest.php b/tests/Security/OutputEscapingTest.php new file mode 100644 index 0000000..2b4c21e --- /dev/null +++ b/tests/Security/OutputEscapingTest.php @@ -0,0 +1,70 @@ +toBe(0, + "File {$relativeFile} has unescaped variables in HTML attributes" + ); + } + }); + + it('uses html_escape or __esc for user-controlled output', function () { + $uiFiles = array( + 'tests/test_prepared_statements.php', + 'upses.php', + ); + + $totalEscapeCalls = 0; + + foreach ($uiFiles as $relativeFile) { + $path = realpath(__DIR__ . '/../../' . $relativeFile); + if ($path === false) continue; + $contents = file_get_contents($path); + if ($contents === false) continue; + + $totalEscapeCalls += preg_match_all('/html_escape|__esc\(|htmlspecialchars/', $contents); + } + + // At least some escaping should be present in UI files + expect($totalEscapeCalls)->toBeGreaterThan(0, + 'UI files should contain at least one html_escape/__esc call' + ); + }); +}); diff --git a/tests/Security/Php74CompatibilityTest.php b/tests/Security/Php74CompatibilityTest.php new file mode 100644 index 0000000..72e8257 --- /dev/null +++ b/tests/Security/Php74CompatibilityTest.php @@ -0,0 +1,114 @@ +toBe(0, "{$f} uses str_contains"); + } + }); + + it('does not use str_starts_with (PHP 8.0)', function () use ($files) { + foreach ($files as $f) { + $p = realpath(__DIR__ . '/../../' . $f); + if ($p === false) continue; + $c = file_get_contents($p); + if ($c === false) continue; + expect(preg_match('/\bstr_starts_with\s*\(/', $c))->toBe(0, "{$f} uses str_starts_with"); + } + }); + + it('does not use str_ends_with (PHP 8.0)', function () use ($files) { + foreach ($files as $f) { + $p = realpath(__DIR__ . '/../../' . $f); + if ($p === false) continue; + $c = file_get_contents($p); + if ($c === false) continue; + expect(preg_match('/\bstr_ends_with\s*\(/', $c))->toBe(0, "{$f} uses str_ends_with"); + } + }); + + it('does not use nullsafe operator (PHP 8.0)', function () use ($files) { + foreach ($files as $f) { + $p = realpath(__DIR__ . '/../../' . $f); + if ($p === false) continue; + $c = file_get_contents($p); + if ($c === false) continue; + expect(preg_match('/\?->/', $c))->toBe(0, "{$f} uses nullsafe operator"); + } + }); + + it('does not use match expression (PHP 8.0)', function () use ($files) { + foreach ($files as $f) { + $p = realpath(__DIR__ . '/../../' . $f); + if ($p === false) continue; + $c = file_get_contents($p); + if ($c === false) continue; + // Avoid false positive on preg_match etc + $c2 = preg_replace('/preg_match|preg_match_all|fnmatch/', '', $c); + expect(preg_match('/\bmatch\s*\(/', $c2))->toBe(0, "{$f} uses match expression"); + } + }); + + it('does not use union type declarations (PHP 8.0)', function () use ($files) { + foreach ($files as $f) { + $p = realpath(__DIR__ . '/../../' . $f); + if ($p === false) continue; + $c = file_get_contents($p); + if ($c === false) continue; + // Match function params/return with union types like string|false + $hits = preg_match_all('/function\s+\w+\s*\([^)]*\w+\s*\|\s*\w+/', $c); + expect($hits)->toBe(0, "{$f} uses union types in function signatures"); + } + }); + + it('does not use constructor property promotion (PHP 8.0)', function () use ($files) { + foreach ($files as $f) { + $p = realpath(__DIR__ . '/../../' . $f); + if ($p === false) continue; + $c = file_get_contents($p); + if ($c === false) continue; + expect(preg_match('/function\s+__construct\s*\([^)]*\b(public|private|protected|readonly)\s/', $c))->toBe(0, + "{$f} uses constructor promotion" + ); + } + }); + + it('uses array() not short syntax for new arrays', function () use ($files) { + // This is a style preference for 1.2.x consistency, not a hard requirement + // Just verify no mixed styles in the same file + foreach ($files as $f) { + $p = realpath(__DIR__ . '/../../' . $f); + if ($p === false) continue; + $c = file_get_contents($p); + if ($c === false) continue; + + $hasArrayFunc = preg_match('/\barray\s*\(/', $c); + $hasShortArray = preg_match('/=\s*\[/', $c); + + // Flag files that mix both styles + if ($hasArrayFunc && $hasShortArray) { + // Allow mixed if the file existed before our changes + // This is informational, not a hard fail + } + } + + expect(true)->toBeTrue(); + }); +}); diff --git a/tests/Security/PreparedStatementConsistencyTest.php b/tests/Security/PreparedStatementConsistencyTest.php new file mode 100644 index 0000000..3ae0ca1 --- /dev/null +++ b/tests/Security/PreparedStatementConsistencyTest.php @@ -0,0 +1,77 @@ +toBe(0, "File {$relativeFile} contains raw DB calls"); + } + }); + + it('uses parameterized placeholders not string interpolation in SQL', function () { + $targetFiles = array( + 'setup.php', + 'tests/test_prepared_statements.php', + 'upses.php', + ); + + foreach ($targetFiles as $relativeFile) { + $path = realpath(__DIR__ . '/../../' . $relativeFile); + if ($path === false) continue; + $contents = file_get_contents($path); + if ($contents === false) continue; + + $lines = explode("\n", $contents); + $interpolatedSql = 0; + + foreach ($lines as $num => $line) { + $trimmed = ltrim($line); + if (strpos($trimmed, '//') === 0 || strpos($trimmed, '*') === 0) continue; + + // Detect _prepared calls with $ interpolation instead of ? placeholders + if (preg_match('/_prepared\s*\(/', $line) && preg_match('/\$[a-zA-Z_]/', $line)) { + // Allow array($var) param binding but flag "WHERE id = $var" + if (preg_match('/(?:SELECT|INSERT|UPDATE|DELETE|WHERE|SET|FROM|JOIN).*\$/', $line)) { + $interpolatedSql++; + } + } + } + + // This is a heuristic; some false positives expected for complex queries + expect($interpolatedSql)->toBeLessThanOrEqual(2, + "File {$relativeFile} may have SQL interpolation in prepared calls" + ); + } + }); +}); diff --git a/tests/Security/RedirectSafetyTest.php b/tests/Security/RedirectSafetyTest.php new file mode 100644 index 0000000..2e4df9e --- /dev/null +++ b/tests/Security/RedirectSafetyTest.php @@ -0,0 +1,51 @@ +toBe(0, + "File {$relativeFile} has header(Location) without exit/die" + ); + } + }); +}); diff --git a/tests/Security/SetupStructureTest.php b/tests/Security/SetupStructureTest.php new file mode 100644 index 0000000..5f4474a --- /dev/null +++ b/tests/Security/SetupStructureTest.php @@ -0,0 +1,36 @@ +toContain('function plugin_apcupsd_install'); + }); + + it('defines plugin_apcupsd_version function', function () use ($source) { + expect($source)->toContain('function plugin_apcupsd_version'); + }); + + it('defines plugin_apcupsd_uninstall function', function () use ($source) { + expect($source)->toContain('function plugin_apcupsd_uninstall'); + }); + + it('returns version array with name key', function () use ($source) { + expect($source)->toMatch('/[\'\""]name[\'\""]\s*=>/'); + }); + + it('returns version array with version key', function () use ($source) { + expect($source)->toMatch('/[\'\""]version[\'\""]\s*=>/'); + }); + + it('registers hooks in install function', function () use ($source) { + expect($source)->toContain('api_plugin_register_hook'); + }); +}); diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..3cc3724 --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,54 @@ + 'db_execute', 'sql' => $sql, 'params' => array()); + return true; + } +} +if (!function_exists('db_execute_prepared')) { + function db_execute_prepared($sql, $params = array()) { + $GLOBALS['__test_db_calls'][] = array('fn' => 'db_execute_prepared', 'sql' => $sql, 'params' => $params); + return true; + } +} +if (!function_exists('db_fetch_assoc')) { function db_fetch_assoc($sql) { return array(); } } +if (!function_exists('db_fetch_assoc_prepared')) { function db_fetch_assoc_prepared($sql, $p = array()) { return array(); } } +if (!function_exists('db_fetch_row')) { function db_fetch_row($sql) { return array(); } } +if (!function_exists('db_fetch_row_prepared')) { function db_fetch_row_prepared($sql, $p = array()) { return array(); } } +if (!function_exists('db_fetch_cell')) { function db_fetch_cell($sql) { return ''; } } +if (!function_exists('db_fetch_cell_prepared')) { function db_fetch_cell_prepared($sql, $p = array()) { return ''; } } +if (!function_exists('db_index_exists')) { function db_index_exists($t, $i) { return false; } } +if (!function_exists('db_column_exists')) { function db_column_exists($t, $c) { return false; } } +if (!function_exists('api_plugin_db_add_column')) { function api_plugin_db_add_column($p, $t, $d) { return true; } } +if (!function_exists('api_plugin_db_table_create')) { function api_plugin_db_table_create($p, $t, $d) { return true; } } +if (!function_exists('read_config_option')) { function read_config_option($n, $f = false) { return ''; } } +if (!function_exists('set_config_option')) { function set_config_option($n, $v) {} } +if (!function_exists('html_escape')) { function html_escape($s) { return htmlspecialchars($s, ENT_QUOTES | ENT_HTML5, 'UTF-8'); } } +if (!function_exists('__')) { function __($t, $d = '') { return $t; } } +if (!function_exists('__esc')) { function __esc($t, $d = '') { return htmlspecialchars($t, ENT_QUOTES | ENT_HTML5, 'UTF-8'); } } +if (!function_exists('cacti_log')) { function cacti_log($m, $p = false, $t = '', $l = 0) {} } +if (!function_exists('cacti_sizeof')) { function cacti_sizeof($a) { return is_array($a) ? count($a) : 0; } } +if (!function_exists('is_realm_allowed')) { function is_realm_allowed($r) { return true; } } +if (!function_exists('raise_message')) { function raise_message($i, $t = '', $l = 0) {} } +if (!function_exists('get_request_var')) { function get_request_var($n) { return ''; } } +if (!function_exists('get_nfilter_request_var')) { function get_nfilter_request_var($n) { return ''; } } +if (!function_exists('get_filter_request_var')) { function get_filter_request_var($n) { return ''; } } +if (!function_exists('form_input_validate')) { function form_input_validate($v, $n, $r, $o, $e) { return $v; } } +if (!function_exists('is_error_message')) { function is_error_message() { return false; } } +if (!function_exists('sql_save')) { function sql_save($a, $t, $k = 'id') { return isset($a['id']) ? $a['id'] : 1; } } +if (!defined('CACTI_PATH_BASE')) { define('CACTI_PATH_BASE', '/var/www/html/cacti'); } +if (!defined('POLLER_VERBOSITY_LOW')) { define('POLLER_VERBOSITY_LOW', 2); } +if (!defined('POLLER_VERBOSITY_MEDIUM')) { define('POLLER_VERBOSITY_MEDIUM', 3); } +if (!defined('POLLER_VERBOSITY_DEBUG')) { define('POLLER_VERBOSITY_DEBUG', 5); } +if (!defined('POLLER_VERBOSITY_NONE')) { define('POLLER_VERBOSITY_NONE', 6); } +if (!defined('MESSAGE_LEVEL_ERROR')) { define('MESSAGE_LEVEL_ERROR', 1); } diff --git a/tests/test_prepared_statements.php b/tests/test_prepared_statements.php new file mode 100644 index 0000000..f69a706 --- /dev/null +++ b/tests/test_prepared_statements.php @@ -0,0 +1,80 @@ += 2 +); + +assert_true( + 'upses.php has no raw db_fetch_assoc calls', + preg_match('/\bdb_fetch_assoc\s*\(/', $upses_contents) === 0 +); +assert_true( + 'upses.php uses prepared action updates/deletes', + preg_match_all('/\bdb_execute_prepared\s*\(/', $upses_contents, $upses_prepared_matches) >= 2 +); +assert_true( + 'upses.php no longer builds SQL with array_to_sql_or', + strpos($upses_contents, 'array_to_sql_or(') === false +); +assert_true( + 'upses.php guards bulk actions on non-empty selected items', + strpos($upses_contents, '$selected_items != false && cacti_sizeof($selected_items)') !== false +); +assert_true( + 'upses.php derives IN-clause placeholders from selected item count', + strpos($upses_contents, '$selected_placeholders = implode(\',\', array_fill(0, cacti_sizeof($selected_items), \'?\'));') !== false +); +assert_true( + 'upses.php has no remaining raw db helpers', + preg_match('/\bdb_(?:execute|fetch_row|fetch_assoc|fetch_cell)\s*\(/', $upses_contents) === 0 +); + +echo "\n"; +echo "Results: $pass passed, $fail failed\n"; + +exit($fail > 0 ? 1 : 0); diff --git a/upses.php b/upses.php index 95bde24..67ede44 100644 --- a/upses.php +++ b/upses.php @@ -417,13 +417,21 @@ function form_actions() { if (isset_request_var('selected_items')) { $selected_items = sanitize_unserialize_selected_items(get_nfilter_request_var('selected_items')); - if ($selected_items != false) { + if ($selected_items != false && cacti_sizeof($selected_items)) { + $selected_items = array_values($selected_items); + $selected_placeholders = implode(',', array_fill(0, cacti_sizeof($selected_items), '?')); + if (get_nfilter_request_var('drp_action') == '1') { /* delete */ - db_execute('DELETE FROM apcupsd_ups WHERE ' . array_to_sql_or($selected_items, 'id')); + db_execute_prepared("DELETE FROM apcupsd_ups + WHERE id IN ($selected_placeholders)", + $selected_items); } elseif (get_nfilter_request_var('drp_action') == '2') { /* Duplicate */ duplicate_ups($selected_items, get_nfilter_request_var('ups_name')); } elseif (get_nfilter_request_var('drp_action') == '3') { /* Reset Detection */ - db_execute('UPDATE apcupsd_ups SET snmp_skipped = "" WHERE ' . array_to_sql_or($selected_items, 'id')); + db_execute_prepared("UPDATE apcupsd_ups + SET snmp_skipped = '' + WHERE id IN ($selected_placeholders)", + $selected_items); } } @@ -680,11 +688,12 @@ function upses() { ':'>') . __('None', 'apcupsd');?>