* Port #8166 SNMP credential cache + procedural SNMPv3 to develop
Ports the shared SNMPv3 credential cache and procedural SNMPv3 routing from the
1.2.x feature (merged as #8166) onto develop, adapted to develop's refactored
SNMP layer. Parts of the 1.2.x change that do not apply to develop are omitted:
the cacti_exec() idle-timeout rewrite (develop has no cacti_exec()), the PHP
floor bump and composer/doc changes (develop is already 8.3+), and the cmd.php
max_oids batching (develop's cmd.php already collects SNMP in-process through
persistent sessions, so the per-item spawn the batching removed does not occur).
- lib/cache.php: new cross-process \Cacti\Cache\SharedCache (file + POSIX
shared-memory + process-local tiers, optional AES-256-GCM sealing). Loaded via
lib/snmp.php (the Cacti\Cache\ namespace is not PSR-4 autoloaded). The crypto
helpers it seals with already live in develop's lib/auth.php, loaded by
global.php, so no duplicate was added.
- lib/snmp.php: snmp_get_method() now routes SNMPv3 get/getnext to the
procedural snmp3_*() calls when the running PHP supports the configured
auth/privacy tokens and no context/engine id is set (SHA-224/384 and
AES-192/256[C] stay on the binary before PHP 8.6); the three single-get
functions gain the procedural v3 path with \Throwable handling; adds the
credential-cache subsystem, protocol-option/MD5-DES helpers,
snmp_native_protocol(), snmp_format_agent() and cacti_snmp_get_multi(); the
binary v3 auth builder consults the cache when enabled.
- poller.php / script_server.php: prime / load the shared cache.
- poller_maintenance.php: daily out-of-band cache rebuild on every collector
(per-poller lastrun marker).
- lib/api_device.php / lib/utility.php: bump snmp_cred_version only on v3
credential add/change (and propagate the token to the affected remote poller).
- include/global.php: resolve and create the private cache/ directory.
- include/global_settings.php: add 'Enable Credential Cache' and 'Enable MD5 and
DES for SNMPv3' settings (both off by default); default new-device v3
auth/privacy to SHA/AES instead of legacy MD5/DES.
- host.php / automation_snmp.php: drop MD5/DES from the pickers when disabled and
default new records to SHA/AES on upgraded installs.
- include/config.php.dist: document $config['cache_dir'].
- tests/Unit/Core/Cache/SharedCacheTest.php: SharedCache behaviour coverage.
- tests/security/baselines: baseline the two new lib/cache.php sinks.
* Incorporate #8171: binary fallback for unsupported SNMPv3 protocols
Layers PR #8171 onto the develop port so an SNMPv3 device whose auth/privacy
protocols the running PHP's ext-snmp cannot service natively (e.g. AES-256
before PHP 8.6) no longer fatals the poller or device-edit screen.
- lib/snmp.php: add CactiSnmpBinarySession, a session stand-in exposing the
get/getnext/walk/close interface the cacti_snmp_session_*() helpers use and
delegating each call to cacti_snmp_*() -> the Net-SNMP binary.
cacti_snmp_session() returns it when php-snmp is absent or the v3 protocol is
not natively serviceable, so cmd.php/host.php collect these devices via the
binary on pre-8.6 and switch to the in-process path on 8.6 with no caller
change. v1/v2 snmpget/snmp2_get now go through snmp_format_agent(). The
ERRNO_TIMEOUT check tolerates php-snmp being absent. Drop the vendored
classSNMP.php compatibility shim and its include (and the Yandex attribution).
- cmd.php: open_snmp_session() returns the down sentinel when a host is already
marked down this run, instead of returning an unset (null) []
that cacti_snmp_session_get() then dereferenced (TypeError).
- lib/ping.php: ping_snmp() runs the availability check through the procedural
cacti_snmp_get()/getnext() path so an unsupported protocol falls back to the
binary instead of raising a ValueError in SNMP::setSecurity().
* Incorporate #8172: retire include/vendor/phpsnmp, relocate into lib
Follow-up to #8171 on the develop port. After classSNMP.php was removed, the
include/vendor/phpsnmp/ directory held only Cacti-owned files; this retires it.
- lib/snmp.php: the ext-snmp subclass that carried Cacti's bulk_walk_size /
value_output_format (previously vendor/phpsnmp/extension.php) is now declared
directly as CactiSnmpNativeSession, guarded by CACTI_PHP_SNMP; the include and
the 'use phpsnmp\SNMP' alias are gone, and new SNMP(...) / SNMP::VERSION_*
now reference the native \SNMP and the new subclass.
- lib/mib_parser.php: moved from include/vendor/phpsnmp/mib_parser.php;
lib/mib_cache.php includes it via __DIR__.
- Remove include/vendor/phpsnmp/extension.php and index.php (directory retired).
- tests: SnmpCoverageTest uses \SNMP::ERRNO_TIMEOUT now that phpsnmp\SNMP is
gone; drop the stale include/vendor/phpsnmp/ entry from the vendor-policy
allowlist.
develop's sink baseline tracks constant-based includes differently than 1.2.x,
so no baseline refresh was needed here.
* Address PR #8174 review: snmp_get_method params, v3 walk, getnext agent, cache bump, CHANGELOG
- lib/snmp.php: restore $php_snmp as the 6th snmp_get_method() parameter and move
the new $auth_proto/$priv_proto after it (callers pass them by name), so the
positional $php_snmp used by SnmpCoverageTest and others keeps working.
- lib/snmp.php: keep every SNMPv3 operation except get/getnext on the Net-SNMP
binary - the native walk branch implements only v1/v2, so a v3 walk reaching
the procedural gate would have silently returned empty when path_snmpbulkwalk
is missing.
- lib/snmp.php: cacti_snmp_getnext() v1/v2 branches now use snmp_format_agent()
like get/get_raw, so an IPv6 literal / non-default port is bracketed.
- lib/api_device.php: bump snmp_cred_version only when the host's v3 membership
or one of the cached credential fields actually changed, instead of on every
save of a v3 device.
- CHANGELOG: move the #8171 entry into the issue block and the #8166 entries into
the feature block, matching the established section ordering.
* Fix CI: unbracket IPv4/DNS SNMP targets, inline auth-cache SQL columns, apply phpcsfixer standard
* Refresh sink inventory baseline after short-array normalization
* Restore lib/snmp.php 100% coverage after aligning v3 routing to 1.2.x
- update the three SnmpCoverageTest assertions that still encoded develop's
pre-port behavior: v3 snmp_get_method now returns PHP, an unsupported-
protocol v3 session returns the binary-delegating session object, and the
v3 cacti_snmp_get path runs natively
- add a v3 noAuthNoPriv user to the snmp-coverage snmpd fixture so native
snmp3_get is exercised deterministically
- add tests covering the ported subsystems to 100%: shared auth cache,
binary-delegating session, protocol pickers, v3 credential args,
cacti_snmp_get_multi, and the cacti_get_snmpv3_auth cache path
- snmp_auth_cache_load uses a resettable process guard so its enabled and
disabled branches are both coverable in a single process
* Resolve phpstan errors in the relocated SNMP MIB parser and ported snmp.php
- lib/mib_parser.php: type the MibParser properties, add parameter/return
types, guard file_get_contents()/preg_split() against false, correct the
parse_bracket_token delimiter params (string, not integer), and drop the
unreachable return after trigger_error(E_USER_ERROR) - now phpstan clean
- lib/mib_cache.php: drop the redundant isset($mp->oids) guard (the typed
property is always initialized; $mp->mib is the real check)
- lib/snmp.php: type the CactiSnmpBinarySession and CactiSnmpNativeSession
properties/methods and pass bool to snmp_set_quick_print()
- .phpstan.neon: ignore greaterOrEqual.alwaysFalse alongside the existing
greater.alwaysFalse (the PHP_VERSION_ID >= 80600 forward-compat gate)
- regenerate phpstan-baseline.neon for the irreducible ext-snmp stub
strictness (snmp3_get literal-union protocols, int<-1,max> timeouts) in
the ported procedural v3 path, the new lib/cache.php shmop stubs, and the
$config array-shape offsets in include/global.php
* Make the v3 getter catch coverage net-snmp-build-independent
The DES-rejection trick that drove the procedural snmp3_get()/snmp3_getnext()
try/catch blocks only works on net-snmp builds compiled without DES; CI's
Debian net-snmp accepts DES, so those catches went uncovered (98.3%).
- extend the existing native_get injection seam (already on cacti_snmp_get)
to cacti_snmp_get_raw, cacti_snmp_getnext, and cacti_snmp_get_multi, and
drive the catch blocks with a throwing native getter in the test
- mark the seam-less cacti_snmp_session() setSecurity catch with
@codeCoverageIgnore (it only throws for a protocol the running net-snmp
rejects, which is not portably reproducible in the fixture)
* Exclude ext-snmp/PHP-8.6-gated defensive branches from snmp coverage
Two branches in lib/snmp.php are unreachable on the PHP 8.3 + ext-snmp
coverage runner and were only "covered" locally via opcache dead-code
elimination:
- snmp_get_method()'s !function_exists('snmp3_get') fallback (ext-snmp
always provides snmp3_get)
- snmp_php_v3_protocols_supported()'s PHP_VERSION_ID >= 80600 block
(SHA-224/384 and AES-192/256 tokens are only accepted on PHP 8.6+)
Mark both with @codeCoverageIgnore so the 100% gate is deterministic
across runners regardless of opcache settings.
* Account for the #8166 SNMPv3 credential-cache gate query in the batching test
poller_update_poller_cache_from_buffer() now runs one SELECT per flush to
decide whether the flush touched SNMPv3 poller items before bumping the shared
credential-cache version (matching 1.2.x). UpdateDataQueryCacheBatchingIntegrationTest
counted 4 statements per flush; update it to 5 (and 3 per-row flushes to 15,
1 batched flush to 5). The guard's intent - batching issues fewer statements
than per-row flushes - still holds.
* Port #8175: group SNMP options under an SNMP Behavior section
Mirror the 1.2.x settings reorganization (#8175) on develop. develop already
keeps the SNMP options in a dedicated SNMP tab, so add an "SNMP Behavior"
spacer there, order the behavior options as md5/des, credential cache, max
get size, bulkwalk fetch size, and move "Disable increasing OID Check" out of
the Poller tab to sit last in that group. Display-only; no settings added or
removed and no behavior change. Adds the "SNMP Behavior" heading to cacti.pot.
* fix: complete dependabot htmx 2.0.10 to 2.0.11 bump
Dependabot bumped package.json and package-lock.json to htmx.org 2.0.11
(PR 8179) but left the vendored include/js/htmx.js, its version marker,
and the pinned SRI constant at 2.0.10. The htmx-filters CI workflow runs
npm ci, which regenerates include/js/htmx.js from the 2.0.11 package, so
HtmxTest's runtime sha384 no longer matches the HTMX_2_0_10_SRI constant
and the integrity assertion fails.
Complete the bump: regenerate the vendored include/js/htmx.js to the
2.0.11 build, bump include/js/htmx.js.version to 2.0.11, rename
HTMX_2_0_10_SRI to HTMX_2_0_11_SRI with the recomputed sha384 hash, and
update the version/integrity assertions in tests/Unit/Ui/Html/HtmxTest.php
and tests/HandOff/HtmxLoaderHandOffTest.php. package.json and
package-lock.json match the values dependabot already landed on develop.
* settings: move SNMP Agent Support under the SNMP Behavior spacer
Relocate the enable_snmp_agent setting (SNMP Agent Support Enabled) so it
is the first item under the SNMP Behavior spacer instead of sitting in the
Poller General group, grouping it with the other SNMP behavior options.
* Address PR #8174 review: keep SHA-224/384 on the binary, honor port on transport targets
Resolves the two still-valid Copilot review findings on lib/snmp.php that were
left unresolved (only marked outdated after later commits shifted their lines).
- snmp_php_v3_protocols_supported(): drop SHA224/SHA384 from the native auth
allowlist. ext-snmp's SNMP::setSecurity()/snmp3_*() only map MD5/SHA/SHA256/
SHA512 - there is no SHA-224/SHA-384 mapping on any build, including PHP 8.6
(verified against php-src ext/snmp/snmp.c), so routing those tokens to the
procedural path raised a ValueError instead of using the binary. They now
always fall back to the Net-SNMP binary. The AES-192/256 privacy tokens that
ext-snmp does add on 8.6 stay gated behind PHP_VERSION_ID >= 80600.
- snmp_format_agent(): a udp/tcp transport-qualified target that omits a port
now has the configured non-default port appended (udp6:[2001:db8::1] + 1161 ->
udp6:[2001:db8::1]:1161), matching the Net-SNMP binary path. Targets that
already carry a port, and unix: sockets (no port), are left untouched.
- SnmpCoverageTest: cover the new transport-target branches; lib/snmp.php stays
at 100%.
* Harden remote agent and basic auth identity handling
* fix(auth): gate forwarded identity headers behind trusted proxies
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
* chore: Update CHANGELOG for new feature, and reorder per rules
* chore: Add the issue number to CHANGELOG
* chore: Update hotspots
---------
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Co-authored-by: TheWitness <thewitness@cacti.net>
* Fix#6539 - Allow Standard Cacti Log Files to be Rotated on Demand from the Cacti UI
* QA: php-cs-fixer updates and documentation for lib/database.php
* QA: Update .gitignore for composer files
* QA: Update .gitignore for composer files
* QA: Back off .gitignore change its duplicated
* QA: Fix typing of db_has_permissions
* QA: Fixing typing issue in db_format_index_create
* Update lib/clog_webapi.php
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* QA: Fix additional code issues
* QA: Applying more defaults to add device
* QA: Fix at the database layer
* QA: Fixes based upon automated testing
* QA: Fix at the database layer
* QA: After new SQL checking
* QA: Skip MacTrack oui database download warnings
* QA: Fixing type issue
* QA: Recommendation from Copilot
* QA: Recommendation from Copilot
* QA: Recommendation from Copilot
* QA: Recommendation from Copilot
* QA: Some minor changes to avoid errors in testing
* QA: Unused variable
* QA: Recommendation from Copilot
* QA: Recommendation from Copilot
* QA: Recommendation from Copilot
* QA: Minor introduced code defect
* QA: Adding some unifying space around concatination
* QA: Consistent comments and new function alias'
* QA: Multi-line comment corrections
* QA: Fix SQL Style
* QA: Missed one function alias
* QA: PHPStan Level 2 and PHPDoc fixes
* QA: PHPStan Level 2 and PHPDoc Fixes
* QA: PHPStan Level 6 Fixes
* QA: Fix lib/xml.php to PHPStan Level 6
* QA: Wrong grep -v
* PHPStan Level 6 for lib/vdef.php
* PHPStan Level 8 for lib/time.php
* QA: Raise PHPStan to Level 6 for lib/database.php
* QA: Remove @deprecated tag from grv()
* QA: Switch to htmle() alias over html_escape()
* QA: More addressing PHPStan issues at Level 6
* QA: Change recommended by Copilot for Readability
* QA: More PHPStan fixes
* QA: More PHPStan fixes
* QA: More PHPStan fixes for lib/utility.php
* QA: More PHPStan fixes at Level 6
* QA: Raise PHPStan to Level 6 More Functions
* QA: Raise PHPStan to Level 6 More Functions
* QA: Raise PHPStan to Level 6 More Functions
* QA: Raise PHPStan to Level 6 More Functions
* QA: Raise PHPStan to Level 6 More Functions
* QA: More PHPStan fixes at Level 6
* QA: Raise PHPStan to Level 6 More Functions
* QA: Raise PHPStan to Level 6 More Functions
* QA: More PHPStan fixes at Level 6
* QA: More PHPStan fixes at Level 6
* QA: Raise PHPStan to Level 6 More Functions
* QA: Raise PHPStan to Level 6 More Functions
* QA: More PHPStan fixes at Level 6
* QA: Raise PHPStan to Level 6 More Functions
* QA: Raise PHPStan to Level 6 More Functions
* QA: More PHPStan fixes at Level 6
* QA: Raise PHPStan to Level 6 More Functions
* QA: Raise PHPStan to Level 6 More Functions
* QA: More PHPStan fixes at Level 6
* QA: More PHPStan fixes at Level 6
* QA: More PHPStan fixes at Level 6
* QA: Raise PHPStan to Level 6 More Functions
* QA: More PHPStan fixes at Level 6
* QA: Some phpseclib3 fixups to update to latest
* QA: More fixups for graphing for magic strings
* QA: More PHPStan fixes at Level 6
* QA: Fixing order string type on get_allowed_graphs()
* QA: Fixing improper use of print
* QA: Optimization of color_templates
* QA: Copilot recommendation
* QA: Copilot recommendation
* QA: Copilot recommendation
* QA: Copilot recommendation
* QA: Copilot recommendation
* QA: Copilot recommendation
* QA: Copilot recommendation
* QA: Copilot recommendation
* QA: Raise PHPStan to Level 6 More Functions
* QA: Issues insalling Cacti
* QA: Issues insalling Cacti
* QA: Issues insalling Cacti
* QA: Issues insalling Cacti
* QA: Issues insalling Cacti
* QA: Issues testing Cacti
* QA: Copilot recommendation
* QA: More PHPStan fixes at Level 6
* QA: More PHPStan fixes at Level 6
* QA: More PHPStan fixes at Level 6
* QA: More PHPStan fixes at Level 6
* QA: More PHPStan fixes at Level 6
* QA: Installer failing
* Undo ownership changes to remove tar errors
* QA: Updates after php-cs-fixer
* QA: Adding code checks to syntax checking
* QA Change syntax flow language
* QA: Reduce the number of cures
* QA: Use sequentional option
* Change runner to self-hosted for check job
* Fix typo in OS version in workflow file
* Add Git installation step in workflow
Added step to install Git if not already installed.
* Add '-y' flag to apt-get install and update commands
Updated apt-get commands to include '-y' for automatic confirmation.
* Change workflow OS version to 'ubuntu-latest'
Updated the workflow to use 'ubuntu-latest' instead of 'ubuntu:latest' and modified the 'runs-on' configuration.
* Remove sequential option from phpcsfixer script
* Remove PHPCS fixer step from workflow
Removed PHP coding standards check from workflow.
* Move code checks to before plugins
Moving these core checks to before the plugins are installed as we really want to check only the base Cacti here.
* Add Composer validation and caching to start of workflow
* QA: Addressing PHPStan additional
* QA: Restore composer lock file
* QA: Addressing PHPStan additional
* QA: Addressing PHPStan additional
* QA: Complete LDAP Project
* QA: php-cs-fixer doing it's thing
* QA: Syntax is already happening in PHPStan
* QA: The md5 function no longer exists
* QA: Update after ldap changes
* QA: Undo that last password hack
* QA: Attempting to switch to MariaDB 11.8
* QA: Attempting to switch to MariaDB 11.8
* QA: Resolving some issues with PHP8.4
* QA: Resolving some issues with PHP8.4
* QA: Add PHP8.5 to the matrix
* QA: Removing PHP8.5 due to dependency issues
* QA: Add the DB version to the testing output
* QA: Switch back to MySQL for the moment
* QA: More fidelity in reporting
* QA: The pipe must be mixed
* QA: Moving audit_schema.php changes from 1.2.x
* QA: Moving audit_schema.php changes from 1.2.x
* QA: Restore mysql monitoring
* QA: php-cs-fixer issues
* QA: Attempt to roll back to MariaDB 10.6
* QA: Attempt to fix check_all_pages.sh
* QA: Make installer functional again
* QA: Fix installer php-cs-fixer issues
* QA: Type to a string
* QA: Get the database version correctly
* QA: Fix issue with reports in check_all_pages.sh
* QA: Check the server version in the right place
* Feature: Support SHA256 as a new hash for passwords
* QA: Function definition and return typing audit
* QA: Refinement of form types
* QA: Refinement of form types
* QA: Consistency of comments
* QA: Issues with php-cs-fixer and more comments
* QA: More typing issues
* QA: php-cs-fixer on merge conflict resolution
---------
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* We were unable to login otherwise the way it was coded.
* Also change CactiTab, CactiTimeZone, and CactiDateTime to session Cookies to prevent clutter
* These issues are to fix an issue encountered when trying to support technologies such as MaxScale readonly and readwrite split connections from the same PHP session.
The first issue is to fix a bug where the main Cacti connection was being closed even when you were trying to close another connection. The second enhancement is to enable logging of connects, disconnects and the first SQL execution from a connection.
* issue#5783: Cacti improperly handles connection closing leading to issues with third party connections
* feature#5784: Provide a means by which a user can track Cacti connections and disconnects from the php error_log
* Make PDO::MYSQL_ATTR_SSL_CAPATH and PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT
accessible thru $database_ssl_capath and $database_ssl_verify_server_cert
configuration options.
* typo: wrong variable name
* fixing typo
---------
Co-authored-by: Jose Kahan <jose.kahan@w3.org>
* Resolving CVE-2022-46169
* Provide a restrictive option
* QA: Further restrict allowed headers to those defined in config only
Co-authored-by: TheWitness <thewitness@cacti.net>
* Allow Setting of Cookie 'Cacti' domain edition
* This also allows the Cacti administrator to extend the content security policy to include unsafe-eval for scripts.
Major mods to the CSRF library (which have been submitted upstream but as there's been no activity for a year,
may not get merged)
- Installer now correctly only checks permissions if csrf-secret is set.
- Created new csrf include to make configuration process easier to identify
- Logging can be enabled now for CSRF to debug it
Re-purpose the existing php_snmp_support config value to allow
administrators to disable the built-in SNMP extension.
It can be desirable to force use of the Net-SNMP in some configurations,
particularly when IPv6 is in use. This allows the administrator to set
$php_snmp_support = false in config.php, which will then force use of
the Net-SNMP binaries tools.
This patch adds functionality to control the debugging of low level routines
via defines within the config.php file. In order to allow flexibility, if
these are defined, variables within the $config array are primed as true,
otherwise false.
These elements within the $config array are defined in uppercase to highlight
the difference between these are other ordinary configuration optios.
Should a function or program need to enable debugging of these various
options, simply setting the value to true in the $config array will enable
logging from that point. Inversely, setting it to false will stop logging
from that point.
The only option that is of limited use is DEBUG_READ_CONFIG_OPTION_DB_OPEN
that will only work up to the database being open. Setting this to true
after the database has already been opened will not automatic turn off the
companion option DEBUG_READ_CONFIG_OPTION since the db_connect_real() will
not be called again.
The list of options and their functionality are:
- DEBUG_READ_CONFIG_OPTION : record use of read_config_option()
to cacti-option.log in the system temporary folder
- DEBUG_READ_CONFIG_OPTION_DB_OPEN : Once the database has been
successfully opened, disable DEBUG_READ_CONFIG_OPTION
- DEBUG_SQL_CMD : Always write a copy of the SQL being requested
to the cacti-sql.log file in the system temporary folder
- DEBUG_SQL_FLOW : Write flow of db_xxx calls to the cacti-sql.log
in the system temporary folder.
The system temporary folder is normally set to one of the following:
- Linux, CLI: /tmp/
- Linux, WEB: Apache/Ngix's temporary folder
- Windows, CLI: %TEMP%
- Windows, WEB: Temp folder of web user or %WINDIR%\TEMP
Correcting CVE-2009-4112. This CVE correction will provide some level
of protection to Cacti when unauthorized changes are made to a Data
Input Method.
note, the poller table is updated, see the cacti.sql, also the default
poller_id is now 1, so you need to review the file
install/0_8_8g_to_1_0_0.php for important changes.
for testers, make sure that you not only add the poller_resource_cache
table, but alter the structure of the host table, or you system will
stop working. this is the first of several commit's. taking it in
stages.
1) CSV export functional from Tree and Preview, new MRTG view functional
2) Corrected some rendering issues between tree and breadcrumbs on graph pages
3) Fixed 'Created Graphs debug messages missing'
4) Corrected spelling error in config.php.dist
5) Fixed some warning when creating graphs
git-svn-id: svn+ssh://repo.cacti.net/var/data/svnroot/cacti/cacti/branches/0.8.8@7675 860744bd-22fc-0310-8c96-e9fe5004b5ca
TheWitness