Files
cacti/tests/Unit/Security/Misc/SerializationSecurityTest.php
Sean Mancini 96033267cb refactor(tests): reorganize unit tests into domain category folders (#7733)
* refactor(tests): reorganize unit tests into domain category folders

- Consolidate per-advisory GHSA regression tests into Security/ subfolders by vuln class
- Group all 186 test files into domain folders: DataCollection/, Ui/, Core/,
  Database/, Installer/, Scripts/, Security/, Plugin/
- Strip GitHub issue/GHSA numbers from filenames; keep IDs in test descriptions
- Fix all __DIR__ relative paths to match new folder nesting depth
- Update CI workflow path triggers and phpunit XML configs for new file locations
- Update .github/copilot-instructions.md with unit test organization guidelines
- Add tests/vendor/ to .gitignore

* add gaurds

* fix up guard for unit tests

* fix redeclaration of cacti_log in tests

* fix updates to unit tests

* fix test patjhs

* fix: update test __DIR__ paths for reorganized test structure

* fix: conditionally define read_user_setting to prevent redeclaration in tests

* fix: conditionally define functions to prevent redeclaration in tests

- Wrap clean_up_lines, raise_message, cacti_debug_backtrace, and get_debug_prefix
  with function_exists() checks to prevent conflicts when test stubs are loaded
  before lib/functions.php in the same PHP process

* fix: add unit test bootstrap to prevent function redeclaration errors

- Create tests/bootstrap-unit.php to load core libraries before tests
- Ensures lib/functions.php loads before test stubs define stub functions
- Test stubs use function_exists() checks, so they detect pre-loaded functions
- Update phpunit.xml to use bootstrap-unit.php for Unit testsuite
- Fixes 'Cannot redeclare read_user_setting()' errors when tests run in same process

* fix: load test stubs before global.php in unit test bootstrap

- Reorder bootstrap to load CactiStubs.php and UnitStubs.php first
- Ensures stub functions like __() are available when global.php loads
- global.php calls get_cacti_version_text() which needs __() for translations
- Fixes 'Call to undefined function __()' error during bootstrap

* fix: remove function conflicts from test stubs

- Remove stub definitions for functions already in lib/functions.php:
  cacti_sizeof, cacti_log, cacti_strtolower, read_config_option,
  read_user_setting, cacti_count
- Keep translation function stubs (__(), __esc()) needed by global.php
- Update bootstrap to load lib/functions.php after stubs
- This prevents function redeclaration errors while maintaining test isolation

* fix: prevent constant and variable redeclaration in bootstrap

- Remove explicit PHP_TESTING and CACTI_TEST_BOOTSTRAP defines from bootstrap
  (CactiStubs.php now handles this with guards)
- Add guards to CactiStubs.php to prevent redefinition of PHP_TESTING
- Only set CACTI_TEST_BOOTSTRAP env vars if not already set
- Fixes PHP warnings about 'Constant X already defined'

* fix: remove redundant lib/functions.php load from bootstrap

include/global.php already loads lib/functions.php at lines 287-288.
The bootstrap was trying to load it again after global.php, but global.php
needs format_cacti_version() to be available on lines 293-294 to define
CACTI_VERSION and CACTI_VERSION_FULL constants.

Solution: Let global.php handle loading lib/functions.php itself, and don't
load it separately in the bootstrap.

* fix: remove more conflicting function stubs from test helpers

- Remove stubs for functions also defined in lib/functions.php:
  raise_message, clean_up_lines, cacti_debug_backtrace, get_debug_prefix
- Remove POLLER_ID constant stub (defined unconditionally by global.php)
- Keep only translation functions and test-specific helpers
- This prevents function/constant redeclaration errors

* fix: minimize test stubs to only translation functions

Remove ALL helper functions and constants from UnitStubs.php that are:
- Defined in lib/functions.php (raise_message, clean_up_lines, etc.)
- Defined in lib/html_utility.php (srv, set_request_var)
- Defined in global_constants.php (POLLER_VERBOSITY_*, MESSAGE_LEVEL_*)
- Defined in global.php (POLLER_ID)

Keep ONLY translation functions (__(), __esc()) that are:
- Called by global.php during initialization
- Not defined elsewhere
- Required for proper bootstrap sequence

This eliminates all constant and function redeclaration errors.

* fix: remove __esc stub - already defined in global_languages.php

Keep only __() translation function stub, which is needed by global.php
and not defined elsewhere in Cacti core.

* fix: handle no-arg case in __() translation stub

The __() function may be called with just a string and no format arguments.
Previously, vsprintf() would fail with 'arguments array must contain 2 items'.
Now, if no args are provided, return the text as-is.
2026-08-16 19:23:31 -07:00

208 lines
6.3 KiB
PHP

<?php
/*
+-------------------------------------------------------------------------+
| Copyright (C) 2004-2026 The Cacti Group |
| |
| This program is free software; you can redistribute it and/or |
| modify it under the terms of the GNU General Public License |
| as published by the Free Software Foundation; either version 2 |
| of the License, or (at your option) any later version. |
+-------------------------------------------------------------------------+
| Cacti: The Complete RRDtool-based Graphing Solution |
+-------------------------------------------------------------------------+
*/
require_once dirname(__DIR__, 3) . '/Helpers/CactiStubs.php';
require_once dirname(__DIR__, 4) . '/include/global.php';
// =====================================================================
// sanitize_unserialize_selected_items tests
// =====================================================================
test('unserialize accepts valid serialized array of integers', function () {
$items = serialize([1, 2, 3]);
$result = sanitize_unserialize_selected_items($items);
expect($result)->toBe([1, 2, 3]);
});
test('unserialize accepts serialized array with string integers', function () {
$items = serialize(['10', '20', '30']);
$result = sanitize_unserialize_selected_items($items);
expect($result)->toBe(['10', '20', '30']);
});
test('unserialize allows empty string values in array', function () {
$items = serialize([1, '', 3]);
$result = sanitize_unserialize_selected_items($items);
expect($result)->toBe([1, '', 3]);
});
test('unserialize rejects PHP object injection attempt', function () {
$payload = 'a:1:{i:0;O:8:"stdClass":0:{}}';
expect(sanitize_unserialize_selected_items($payload))->toBeFalse();
});
test('unserialize rejects object with plus sign in length', function () {
$payload = 'a:1:{i:0;O:+8:"stdClass":0:{}}';
expect(sanitize_unserialize_selected_items($payload))->toBeFalse();
});
test('unserialize rejects empty input', function () {
expect(sanitize_unserialize_selected_items(''))->toBeFalse();
});
test('unserialize rejects null input', function () {
expect(sanitize_unserialize_selected_items(null))->toBeFalse();
});
test('unserialize rejects non-string input', function () {
expect(sanitize_unserialize_selected_items(42))->toBeFalse();
});
test('unserialize rejects array containing non-numeric strings', function () {
$items = serialize(['1', 'DROP TABLE', '3']);
expect(sanitize_unserialize_selected_items($items))->toBeFalse();
});
test('unserialize rejects nested arrays', function () {
$items = serialize([1, [2, 3], 4]);
expect(sanitize_unserialize_selected_items($items))->toBeFalse();
});
// =====================================================================
// sanitize_cdef tests
// =====================================================================
test('sanitize_cdef passes normal RPN expression through', function () {
expect(sanitize_cdef('a,b,+,8,*'))->toBe('a,b,+,8,*');
});
test('sanitize_cdef strips shell injection characters', function () {
$result = sanitize_cdef('a;`rm -rf /`$PATH');
expect($result)->not->toContain(';')
->and($result)->not->toContain('`')
->and($result)->not->toContain('$')
->and($result)->toBe('arm -rf /PATH');
});
test('sanitize_cdef strips all dangerous characters', function () {
$result = sanitize_cdef('^$<>`\'"|[]{}!;');
expect($result)->toBe('');
});
test('sanitize_cdef handles empty string', function () {
expect(sanitize_cdef(''))->toBe('');
});
// =====================================================================
// is_ipaddress tests
// =====================================================================
test('is_ipaddress accepts valid IPv4', function () {
expect(is_ipaddress('192.168.1.1'))->toBeTrue();
});
test('is_ipaddress accepts valid IPv6', function () {
expect(is_ipaddress('::1'))->toBeTrue();
});
test('is_ipaddress accepts full IPv6', function () {
expect(is_ipaddress('2001:0db8:85a3:0000:0000:8a2e:0370:7334'))->toBeTrue();
});
test('is_ipaddress rejects hostname', function () {
expect(is_ipaddress('example.com'))->toBeFalse();
});
test('is_ipaddress rejects empty string', function () {
expect(is_ipaddress(''))->toBeFalse();
});
test('is_ipaddress rejects malformed IPv4', function () {
expect(is_ipaddress('999.999.999.999'))->toBeFalse();
});
// =====================================================================
// is_mac_address tests
// =====================================================================
test('is_mac_address accepts colon-separated MAC', function () {
expect(is_mac_address('00:1A:2B:3C:4D:5E'))->toBeTruthy();
});
test('is_mac_address accepts hyphen-separated MAC', function () {
expect(is_mac_address('00-1A-2B-3C-4D-5E'))->toBeTruthy();
});
test('is_mac_address rejects invalid MAC', function () {
expect(is_mac_address('not-a-mac'))->toBeFalsy();
});
test('is_mac_address rejects empty string', function () {
expect(is_mac_address(''))->toBeFalsy();
});
// =====================================================================
// is_hex_string tests
// =====================================================================
test('is_hex_string accepts Hex- prefixed string and mutates result', function () {
$input = 'Hex-41 42 43';
$return = is_hex_string($input);
expect($return)->toBeTrue()
->and($input)->toBe('41 42 43');
});
test('is_hex_string accepts Hex-STRING: prefixed string', function () {
$input = 'Hex-STRING:41 42 43';
$return = is_hex_string($input);
expect($return)->toBeTrue()
->and($input)->toBe('41 42 43');
});
test('is_hex_string rejects string without hex prefix', function () {
$input = '41 42 43';
expect(is_hex_string($input))->toBeFalse();
});
test('is_hex_string rejects single hex pair', function () {
$input = 'Hex-41';
expect(is_hex_string($input))->toBeFalse();
});
test('is_hex_string rejects non-hex characters after prefix', function () {
$input = 'Hex-GG HH';
expect(is_hex_string($input))->toBeFalse();
});
test('is_hex_string rejects empty string', function () {
$input = '';
expect(is_hex_string($input))->toBeFalse();
});
test('is_hex_string rejects uneven-length hex parts', function () {
$input = 'Hex-4 42 43';
expect(is_hex_string($input))->toBeFalse();
});