Files
cacti/tests/Unit/Core/RemoteAgent/RemoteAgentFcrdnsTest.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

96 lines
4.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 |
+-------------------------------------------------------------------------+
*/
$root = dirname(__DIR__, 4);
if (!function_exists(__NAMESPACE__ . '\\read_config_option') && !function_exists('\\read_config_option')) {
function read_config_option($name) {
return '';
}
}
require_once $root . '/lib/auth.php';
/* remote_agent_fcrdns_confirmed is the pure forward-confirmation decision
* extracted from remote_client_authorized(). A PTR that does not forward-confirm
* must NOT authorize via source-IP fallback, since get_client_addr() honors a
* client-supplied X-Forwarded-For when proxy_headers is enabled. */
test('fcrdns confirms when a forward A record matches the source address', function () {
expect(remote_agent_fcrdns_confirmed('10.0.0.5', [
['type' => 'A', 'ip' => '10.0.0.5'],
]))->toBeTrue();
});
test('fcrdns confirms when a forward AAAA record matches the source address', function () {
expect(remote_agent_fcrdns_confirmed('2001:db8::1', [
['type' => 'AAAA', 'ipv6' => '2001:db8::1'],
]))->toBeTrue();
});
test('fcrdns compares IPv6 addresses by binary value', function () {
expect(remote_agent_fcrdns_confirmed('2001:0db8:0:0:0:0:0:1', [
['type' => 'AAAA', 'ipv6' => '2001:db8::1'],
]))->toBeTrue();
});
test('fcrdns rejects when forward records resolve to a different address', function () {
// PTR exists but forward lookup points elsewhere: the spoofing/inconsistency
// signal. The caller must reject rather than fall back to IP matching.
expect(remote_agent_fcrdns_confirmed('10.0.0.5', [
['type' => 'A', 'ip' => '10.0.0.9'],
]))->toBeFalse();
});
test('fcrdns rejects when no forward records exist', function () {
expect(remote_agent_fcrdns_confirmed('10.0.0.5', []))->toBeFalse();
});
test('fcrdns rejects an attacker spoofing a known poller address via forwarded headers', function () {
// attacker controls 203.0.113.7, sends X-Forwarded-For: 10.0.0.5 (a poller IP).
// gethostbyaddr on 10.0.0.5 yields the poller PTR, but the attacker cannot make
// that hostname forward-resolve to their own connection, so confirmation fails.
$poller_forward_records = [
['type' => 'A', 'ip' => '10.0.0.5'],
];
$spoofed_client_addr = '10.0.0.5';
// The honest poller (real source 10.0.0.5) confirms.
expect(remote_agent_fcrdns_confirmed($spoofed_client_addr, $poller_forward_records))->toBeTrue();
// The same PTR name forward-resolves to 10.0.0.5, not to the attacker's address,
// so a request whose real source differs cannot pass confirmation.
expect(remote_agent_fcrdns_confirmed('203.0.113.7', $poller_forward_records))->toBeFalse();
});
test('effective-user delegation accepts only the exact enabled user', function () {
$lookup = static fn (int $id) : array => ['id' => $id, 'enabled' => 'on'];
expect(remote_agent_validate_effective_user(7, $lookup))->toBe(7)
->and(remote_agent_validate_effective_user('7', $lookup))->toBe(7);
});
test('effective-user delegation rejects malformed missing and disabled users', function (mixed $value, callable $lookup) {
expect(remote_agent_validate_effective_user($value, $lookup))->toBeFalse();
})->with([
'zero' => [0, static fn (int $_id) : array => ['id' => 0, 'enabled' => 'on']],
'negative' => [-1, static fn (int $_id) : array => ['id' => -1, 'enabled' => 'on']],
'signed string' => ['+7', static fn (int $_id) : array => ['id' => 7, 'enabled' => 'on']],
'non-numeric' => ['admin', static fn (int $_id) : array => ['id' => 1, 'enabled' => 'on']],
'wrong row' => [7, static fn (int $_id) : array => ['id' => 8, 'enabled' => 'on']],
'disabled' => [7, static fn (int $_id) : array => ['id' => 7, 'enabled' => 'off']],
'missing' => [7, static fn (int $_id) : bool => false]
]);