mirror of
https://github.com/ntop/ntopng.git
synced 2026-10-21 22:10:23 +00:00
8ee8b740ea
Rework the `cppcheck:` recipe so it is usable in practice:
- `--enable=all` -> `--enable=warning,performance,portability`
(drops the `style`/`information`/`unusedFunction` groups, which produced
hundreds of opinion-level hits)
- drop `--force` (was re-analyzing every file once per #ifdef combination;
single files took 40+ min). Analyzes the default build config only.
- add `-j $(shell nproc)` + `--cppcheck-build-dir=.cppcheck-build` for
parallelism and incremental caching; `mkdir -p` the cache dir in the recipe
- suppress checks that are noise for this codebase:
* useInitializationList - micro perf, POD members
* duplInheritedMember - intentional non-virtual name shadowing
(operator[], swap, enqueue, incUses, lua, ...)
* noCopyConstructor / noOperatorEq - the flagged classes
(NetworkInterface, Ntop, Flow, ...) are non-copyable by design and
always held by pointer; the fix cppcheck suggests (add operator=)
is meaningless for them
- .gitignore: ignore the new .cppcheck-build/ cache directory
FlowAlertsLoader::registerRisk (src/FlowAlertsLoader.cpp)
Missing `else`: `alert_to_risk[alert_type.id] = risk` was executed even when
`alert_type.id >= MAX_DEFINED_FLOW_ALERT_TYPE` -> out-of-bounds array write.
The sibling registerAlert() already had the `else`.
Uninitialized ndpi_protocol structs (src/NetworkInterface.cpp x6,
src/LuaEngineInterface.cpp x1)
Local `ndpi_protocol` values were only partially initialized (proto.* set,
but breed/fpc/state/category/custom_category_userdata left indeterminate)
and then passed by value to get_ndpi_full_proto_name() /
get_ndpi_proto_category(). Added `memset(&x, 0, sizeof(x))` at each
declaration, matching the existing convention elsewhere in the tree.
Uninitialized locals
- src/ParserInterface.cpp: `src2dst_direction` was read on the
`flow == NULL` path (getFlow() not called). Initialize to a defined value;
the value is not otherwise observable on that path.
- include/Bitmap.h (toHexString): if `buf_len <= 0` the first loop never
runs and `strlen(buf)` reads uninitialized memory; also `strlen(buf) - 2`
underflows (unsigned) when the string is shorter than 2 bytes. Null-
terminate up front and hoist strlen into a `size_t`, iterate with
`pos + 2 < len`.
src/NetworkInterface.cpp incNumHosts()/decNumHosts()
`if (isShuttingDown() || (!host->isUnicastHost())) return;` - the second
term is always false, the function already returned on `!isUnicastHost()`
a few lines above. Dropped it.
include/NetworkInterface.h getActiveFlowsStats()
Declaration and definition disagreed on the first two parameter *names*
(`stats, status_stats` vs `ndpi_stats, stats`); types matched. Renamed the
header params to match the implementation.
No behavioural change; each argument was already non-negative.
- Interface id (`get_id()` returns int; kept int because 3 call sites test
`== -1`) formatted with %u in redis-key macros -> cast the argument
`(u_int)` at the call site:
include/AutonomousSystem.h, include/Country.h,
include/ObservationPoint.h, include/VLAN.h,
src/BroadcastDomains.cpp (x2), src/HostPools.cpp, src/LocalHost.cpp,
src/LuaEngineInterface.cpp (x3), src/NetworkInterface.cpp (x2),
src/SyslogParserInterface.cpp
- src/HTTPserver.cpp: `%d` with get_http_port()/get_https_port() (u_int)
-> `%u`; the scanf-width builder `"%%%u[^|]..."` fed `int` macros -> `%d`
- src/Flow.cpp: `"%u.%u.%u.%u"` with `int` octets from a `%d` sscanf -> `%d`;
`%u` (arg 13) with get_protocol_category() enum -> cast `(u_int)`
- src/MacManufacturers.cpp: `int _mac[3]` scanned with `%02x`
(wants `unsigned int*`) -> declare `u_int _mac[3]`
- src/StatsManager.cpp: `%lu` with `static_cast<long int>(key)` epoch values
-> `%ld` (respects the explicit signed cast)
- src/Trace.cpp: `"%s.%u"` with loop `int i` / `i + 1` -> `%d`
- src/Prefs.cpp: `%u` in usage() help text fed CONST_DEFAULT_* /
MAX_NUM_* / CLICKHOUSE_MAX_* int macros -> cast `(u_int)`
std::string / std::vector parameters taken by value, changed to `const &`
(declaration and definition kept in sync; none are virtual or overrides, so
callers are source-compatible):
- AggregatedFlowsStats::setInfoKey
- Flow::setL7JSON
- CustomFlowLuaScriptAlert::setAlertMessage
- CustomHostLuaScriptAlert::setAlertMessage, ctor (_msg)
- ScanRealtimeAlert ctor (_alerts, std::vector)
- CustomHostLuaScript::allocAlert (_msg)
- OtherAlertableEntity::getAlertCachedValue / setAlertCacheValue /
triggerAlert / releaseAlert (key, value)
- HostAlert::init and HostAlert(HostCheckID, ...) ctor (_check_name)
- Ntop::luaFlowCheckInfo / luaHostCheckInfo (check_name)
- Ntop::incBlacklisHits (listname)
- Ntop::setLuaCache (key, val)
92 lines
3.6 KiB
C++
92 lines
3.6 KiB
C++
/*
|
|
*
|
|
* (C) 2019-26 - ntop.org
|
|
*
|
|
*
|
|
* 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 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef _OTHER_ALERTABLE_ENTITY_H_
|
|
#define _OTHER_ALERTABLE_ENTITY_H_
|
|
|
|
#include "ntop_includes.h"
|
|
|
|
class NetworkInterface;
|
|
|
|
class OtherAlertableEntity : public AlertableEntity {
|
|
private:
|
|
protected:
|
|
/*
|
|
Creating multiple maps guarantees that periodic scripts at different
|
|
granularities do not interfere each other and thus that they can run
|
|
concurrently without locking.
|
|
|
|
However while alert_cache is accessed only by the alert engine and thus it
|
|
is "thread-safe" as concurrent scripts (i.e. at different granularities)
|
|
cannot call it, engaged_alerts needs to be protected as
|
|
- it can be called by the Lua GUI
|
|
- it can be called by the alert engine
|
|
|
|
In order to save memory, the std::map key is a hash 32 bit and not the
|
|
original string. Considered the number of entries this is a good
|
|
tradeoff with no false positives considered the limited value
|
|
cardinality.
|
|
*/
|
|
std::map<u_int32_t /* std::string */, std::string>
|
|
alert_cache[MAX_NUM_PERIODIC_SCRIPTS];
|
|
std::map<u_int32_t /* std::string */, Alert>
|
|
engaged_alerts[MAX_NUM_PERIODIC_SCRIPTS];
|
|
|
|
void getAlertsByPeriodicity(lua_State* vm, ScriptPeriodicity p,
|
|
AlertType type_filter, AlertLevel severity_filter,
|
|
AlertRole role_filter, u_int* idx);
|
|
|
|
public:
|
|
OtherAlertableEntity(NetworkInterface* alert_iface, AlertEntity entity);
|
|
virtual ~OtherAlertableEntity();
|
|
|
|
/*
|
|
getAlertCachedValue and setAlertCacheValue as thread safe as they are
|
|
invoked only by periodic scripts and are not accessed by the GUI lua methods
|
|
*/
|
|
inline std::string getAlertCachedValue(const std::string &key,
|
|
ScriptPeriodicity p) {
|
|
std::map<u_int32_t /* std::string */, std::string>::iterator it =
|
|
alert_cache[(u_int)p].find(ndpi_hash_string(key.c_str()));
|
|
|
|
return ((it != alert_cache[(u_int)p].end()) ? it->second : std::string(""));
|
|
}
|
|
|
|
inline void setAlertCacheValue(const std::string &key,
|
|
const std::string &value,
|
|
ScriptPeriodicity p) {
|
|
alert_cache[(u_int)p][ndpi_hash_string(key.c_str())] = value;
|
|
}
|
|
|
|
bool triggerAlert(lua_State* vm, const std::string &key, ScriptPeriodicity p,
|
|
time_t now, u_int32_t score, AlertType alert_id,
|
|
const char* subtype, const char* json, const char* ip,
|
|
const char* name, u_int16_t port);
|
|
bool releaseAlert(lua_State* vm, const std::string &key, ScriptPeriodicity p,
|
|
time_t now);
|
|
|
|
void luaAlert(lua_State* vm, const Alert* alert, ScriptPeriodicity p) const;
|
|
void countAlerts(grouped_alerts_counters* counters);
|
|
void getAlerts(lua_State* vm, ScriptPeriodicity p, AlertType type_filter,
|
|
AlertLevel severity_filter, AlertRole role_filter, u_int* idx);
|
|
};
|
|
|
|
#endif
|